| blob | be843e6ee5ffbdbe9cf0cdd25273d43a139b93c4 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists in a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place. The exhaustive list
35 ;; of properties is given in "The Communication Channel" section of
36 ;; this file.
37 ;;
38 ;; - The transcoder walks the parse tree, ignores or treat as plain
39 ;; text elements and objects according to export options, and
40 ;; eventually calls back-end specific functions to do the real
41 ;; transcoding, concatenating their return value along the way.
42 ;;
43 ;; - The filter system is activated at the very beginning and the very
44 ;; end of the export process, and each time an element or an object
45 ;; has been converted. It is the entry point to fine-tune standard
46 ;; output from back-end transcoders. See "The Filter System"
47 ;; section for more information.
48 ;;
49 ;; The core function is `org-export-as'. It returns the transcoded
50 ;; buffer as a string.
51 ;;
52 ;; An export back-end is defined with `org-export-define-backend'.
53 ;; This function can also support specific buffer keywords, OPTION
54 ;; keyword's items and filters. Refer to function's documentation for
55 ;; more information.
56 ;;
57 ;; If the new back-end shares most properties with another one,
58 ;; `org-export-define-derived-backend' can be used to simplify the
59 ;; process.
60 ;;
61 ;; Any back-end can define its own variables. Among them, those
62 ;; customizable should belong to the `org-export-BACKEND' group.
63 ;;
64 ;; Tools for common tasks across back-ends are implemented in the
65 ;; following part of the file.
66 ;;
67 ;; Then, a wrapper macro for asynchronous export,
68 ;; `org-export-async-start', along with tools to display results. are
69 ;; given in the penultimate part.
70 ;;
71 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
72 ;; back-ends is provided in the last one.
74 ;;; Code:
92 \f
93 ;;; Internal Variables
94 ;;
95 ;; Among internal variables, the most important is
96 ;; `org-export-options-alist'. This variable define the global export
97 ;; options, shared between every exporter, and how they are acquired.
143 "Alist between export properties and ways to set them.
145 The CAR of the alist is the property name, and the CDR is a list
146 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
148 KEYWORD is a string representing a buffer keyword, or nil. Each
149 property defined this way can also be set, during subtree
150 export, through a headline property named after the keyword
152 property).
153 OPTION is a string that could be found in an #+OPTIONS: line.
154 DEFAULT is the default value for the property.
155 BEHAVIOR determines how Org should handle multiple keywords for
156 the same property. It is a symbol among:
157 nil Keep old value and discard the new one.
158 t Replace old value with the new one.
159 `space' Concatenate the values, separating them with a space.
160 `newline' Concatenate the values, separating them with
161 a newline.
162 `split' Split values at white spaces, and cons them to the
163 previous list.
165 Values set through KEYWORD and OPTION have precedence over
166 DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
234 "Alist between filters properties and initial values.
236 The key of each association is a property name accessible through
237 the communication channel. Its value is a configurable global
238 variable defining initial filters.
240 This list is meant to install user specified filters. Back-end
241 developers may install their own filters using
242 `org-export-define-backend'. Filters defined there will always
243 be prepended to the current list, so they always get applied
252 "Default rule for link matching an inline image.
253 This rule applies to links with no description. By default, it
254 will be considered as an inline image if it targets a local file
257 See `org-export-inline-image-p' for more information about
262 org-element--cache org-element--cache-objects org-element--cache-sync-keys
263 org-element--cache-sync-requests org-element--cache-sync-timer)
264 "List of variables not copied through upon buffer duplication.
265 Export process takes place on a copy of the original buffer.
266 When this copy is created, all Org related local variables not in
267 this list are copied to the new buffer. Variables with an
271 "Non-nil means asynchronous export process should leave data behind.
275 located in `temporary-file-directory'.
277 When non-nil, it will also set `debug-on-error' to a non-nil
281 "Record asynchronously generated export results and processes.
282 This is an alist: its CAR is the source of the
283 result (destination file or buffer for a finished process,
284 original buffer for a running one) and its CDR is a list
285 containing the back-end used, as a symbol, and either a process
286 or the time at which it finished. It is used to build the menu
290 "List of backends currently available in the exporter.
291 This variable is set with `org-export-define-backend' and
295 "Last command called from the dispatcher.
296 The value should be a list. Its CAR is the action, as a symbol,
300 "The position where the last export command was created using the dispatcher.
301 This marker will be used with `C-u C-c C-e' to make sure export repetition
304 ;; For compatibility with Org < 8
306 "Name, if any, of the back-end used during an export process.
308 Its value is a symbol such as `html', `latex', `ascii', or nil if
309 the back-end is anonymous (see `org-export-create-backend') or if
310 there is no export process in progress.
312 It can be used to teach Babel blocks how to act differently
316 \f
317 ;;; User-configurable Variables
318 ;;
319 ;; Configuration for the masses.
320 ;;
321 ;; They should never be accessed directly, as their value is to be
322 ;; stored in a property list (cf. `org-export-options-alist').
323 ;; Back-ends will read their value from there instead.
326 "Options for exporting Org mode files."
331 "General options for export engine."
336 "Whether sub-trees with the ARCHIVE tag should be exported.
338 This can have three different values:
339 nil Do not export, pretend this tree is not present.
340 t Do export the entire tree.
341 `headline' Only export the headline, but skip the tree below it.
343 This option can also be set with the OPTIONS keyword,
352 "Non-nil means insert author name into the exported file.
353 This option can also be set with the OPTIONS keyword,
359 "Non-nil means export CLOCK keywords.
360 This option can also be set with the OPTIONS keyword,
366 "Non-nil means the postamble should contain a creator sentence.
368 The sentence can be set in `org-export-creator-string' and
371 If the value is `comment' insert it as a comment."
379 "Non-nil means insert date in the exported document.
380 This option can also be set with the OPTIONS keyword,
386 "Time-stamp format string to use for DATE keyword.
388 The format string, when specified, only applies if date consists
389 in a single time-stamp. Otherwise its value will be ignored.
391 See `format-time-string' for details on how to build this
392 string."
400 emacs-version
402 "Information about the creator of the document.
403 This option can also be set on with the CREATOR keyword."
408 "Non-nil means export contents of standard drawers.
410 When t, all drawers are exported. This may also be a list of
411 drawer names to export, as strings. If that list starts with
412 `not', only drawers with such names will be ignored.
414 This variable doesn't apply to properties drawers. See
415 `org-export-with-properties' instead.
417 This option can also be set with the OPTIONS keyword,
430 :inline t
434 "Non-nil means insert author email into the exported file.
435 This option can also be set with the OPTIONS keyword,
441 "Non-nil means interpret *word*, /word/, _word_ and +word+.
443 If the export target supports emphasizing text, the word will be
444 typeset in bold, italic, with an underline or strike-through,
445 respectively.
447 This option can also be set with the OPTIONS keyword,
453 "Tags that exclude a tree from export.
455 All trees carrying any of these tags will be excluded from
456 export. This is without condition, so even subtrees inside that
457 carry one of the `org-export-select-tags' will be removed.
459 This option can also be set with the EXCLUDE_TAGS keyword."
465 This option can also be set with the OPTIONS keyword,
473 "Non-nil means Org footnotes should be exported.
474 This option can also be set with the OPTIONS keyword,
480 "Non-nil means process LaTeX environments and fragments.
482 This option can also be set with the OPTIONS line,
485 nil Ignore math snippets.
486 `verbatim' Keep everything in verbatim.
487 t Allow export of math snippets."
497 "The last level which is still exported as a headline.
499 Inferior levels will usually produce itemize or enumerate lists
500 when exported, but back-end behaviour may differ.
502 This option can also be set with the OPTIONS keyword,
508 "The default language for export and clocktable translations, as a string.
509 This may have an association in
510 `org-clock-clocktable-language-setup',
511 `org-export-smart-quotes-alist' and `org-export-dictionary'.
512 This option can also be set with the LANGUAGE keyword."
517 "Non-nil means preserve all line breaks when exporting.
518 This option can also be set with the OPTIONS keyword,
524 "Non-nil means interpret entities when exporting.
527 Å.
529 For a list of supported names, see the constant `org-entities'
530 and the user option `org-entities-user'.
532 This option can also be set with the OPTIONS keyword,
538 "Non-nil means inlinetasks should be exported.
539 This option can also be set with the OPTIONS keyword,
547 "Non-nil means include planning info in export.
549 Planning info is the line containing either SCHEDULED:,
550 DEADLINE:, CLOSED: time-stamps, or a combination of them.
552 This option can also be set with the OPTIONS keyword,
560 "Non-nil means include priority cookies in export.
561 This option can also be set with the OPTIONS keyword,
567 "Non-nil means export contents of properties drawers.
569 When t, all properties are exported. This may also be a list of
570 properties to export, as strings.
572 This option can also be set with the OPTIONS keyword,
584 "Non-nil means add section numbers to headlines when exporting.
586 When set to an integer n, numbering will only happen for
587 headlines whose relative level is higher or equal to n.
589 This option can also be set with the OPTIONS keyword,
595 "Tags that select a tree for export.
597 If any such tag is found in a buffer, all trees that do not carry
598 one of these tags will be ignored during export. Inside trees
599 that are selected like this, you can still deselect a subtree by
600 tagging it with one of the `org-export-exclude-tags'.
602 This option can also be set with the SELECT_TAGS keyword."
607 "Non-nil means activate smart quotes during export.
608 This option can also be set with the OPTIONS keyword,
611 When setting this to non-nil, you need to take care of
612 using the correct Babel package when exporting to LaTeX.
613 E.g., you can load Babel for french like this:
624 When this option is turned on, these strings will be exported as:
626 Org HTML LaTeX UTF-8
627 -----+----------+--------+-------
629 -- – -- –
630 --- — --- —
633 This option can also be set with the OPTIONS keyword,
639 "Non-nil means include statistics cookies in export.
640 This option can also be set with the OPTIONS keyword,
650 If you want to control how Org displays those characters, see
651 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
652 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
653 it is not anymore.
655 When this option is turned on, you can use TeX-like syntax for
656 sub- and superscripts and see them exported correctly.
658 You can also set the option with #+OPTIONS: ^:t
661 single item - so grouping with {} is normally not needed. For
662 example, the following things will be parsed as single sub- or
663 superscripts:
665 10^24 or 10^tau several digits will be considered 1 item.
666 10^-12 or 10^-tau a leading sign with digits or a word
667 x^2-y^3 will be read as x^2 - y^3, because items are
668 terminated by almost any nonword/nondigit char.
669 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
671 Still, ambiguity is possible. So when in doubt, use {} to enclose
672 the sub/superscript. If you set this variable to the symbol `{}',
673 the braces are *required* in order to trigger interpretations as
675 frequently in plain text."
685 "Non-nil means create a table of contents in exported files.
687 The TOC contains headlines with levels up
688 to`org-export-headline-levels'. When an integer, include levels
689 up to N in the toc, this may then be different from
690 `org-export-headline-levels', but it will not be allowed to be
691 larger than the number of headline levels. When nil, no table of
692 contents is made.
694 This option can also be set with the OPTIONS keyword,
703 "Non-nil means export tables.
704 This option can also be set with the OPTIONS keyword,
712 "If nil, do not export tags, just remove them from headlines.
714 If this is the symbol `not-in-toc', tags will be removed from
715 table of contents entries, but still be shown in the headlines of
716 the document.
718 This option can also be set with the OPTIONS keyword,
727 "Non-nil means include TODO items for export.
729 This may have the following values:
730 t include tasks independent of state.
731 `todo' include only tasks that are not yet done.
732 `done' include only tasks that are already done.
733 nil ignore all tasks.
734 list of keywords include tasks with these keywords.
736 This option can also be set with the OPTIONS keyword,
748 "Non-nil means insert a time stamp into the exported file.
749 The time stamp shows when the file was created. This option can
755 "Non nil means allow timestamps in export.
757 It can be set to any of the following values:
758 t export all timestamps.
759 `active' export active timestamps only.
760 `inactive' export inactive timestamps only.
761 nil do not export timestamps
763 This only applies to timestamps isolated in a paragraph
764 containing only timestamps. Other timestamps are always
765 exported.
767 This option can also be set with the OPTIONS keyword, e.g.
777 "Non-nil means include TODO keywords in export.
778 When nil, remove all these keywords from the export. This option
784 "Non-nil means BIND keywords can define local variable values.
785 This is a potential security risk, which is why the default value
786 is nil. You can also allow them through local buffer variables."
793 "Alist between export snippets back-ends and exporter back-ends.
795 This variable allows to provide shortcuts for export snippets.
799 HTML code while every other back-end will ignore it."
808 "Coding system for the exported file."
815 "Non-nil means pushing export output to the kill ring.
816 This variable is ignored during asynchronous export."
826 "The initial scope when exporting with `org-export-dispatch'.
827 This variable can be either set to `buffer' or `subtree'."
834 "Non-nil means show buffer after exporting to temp buffer.
835 When Org exports to a file, the buffer visiting that file is ever
836 shown, but remains buried. However, when exporting to
837 a temporary buffer, that buffer is popped up in a second window.
838 When this variable is nil, the buffer remains buried also in
839 these cases."
844 "Non-nil means export and publishing commands will run in background.
845 Results from an asynchronous export are never displayed
853 "File used to initialize external export process.
855 Value must be either nil or an absolute file name. When nil, the
856 external process is launched like a regular Emacs session,
857 loading user's initialization file and any site specific
858 configuration. If a file is provided, it, and only it, is loaded
859 at start-up.
861 Therefore, using a specific configuration makes the process to
862 load faster and the export more portable."
871 "Non-nil means using a non-intrusive `org-export-dispatch'.
872 In that case, no help buffer is displayed. Though, an indicator
878 asynchronous). Also, \[?] allows to switch back to standard
879 mode."
886 \f
887 ;;; Defining Back-ends
888 ;;
889 ;; An export back-end is a structure with `org-export-backend' type
890 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
891 ;; and `menu' slots.
892 ;;
893 ;; At the lowest level, a back-end is created with
894 ;; `org-export-create-backend' function.
895 ;;
896 ;; A named back-end can be registered with
897 ;; `org-export-register-backend' function. A registered back-end can
898 ;; later be referred to by its name, with `org-export-get-backend'
899 ;; function. Also, such a back-end can become the parent of a derived
900 ;; back-end from which slot values will be inherited by default.
901 ;; `org-export-derived-backend-p' can check if a given back-end is
902 ;; derived from a list of back-end names.
903 ;;
904 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
905 ;; `org-export-get-all-filters' return the full alist of transcoders,
906 ;; options and filters, including those inherited from ancestors.
907 ;;
908 ;; At a higher level, `org-export-define-backend' is the standard way
909 ;; to define an export back-end. If the new back-end is similar to
910 ;; a registered back-end, `org-export-define-derived-backend' may be
911 ;; used instead.
912 ;;
913 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
914 ;; when a given back-end hasn't been registered yet.
918 name parent transcoders options filters blocks menu)
921 "Return export back-end named after NAME.
922 NAME is a symbol. Return nil if no such back-end is found."
929 "Register BACKEND as a known export back-end.
930 BACKEND is a structure with `org-export-backend' type."
931 ;; Refuse to register an unnamed back-end.
934 ;; Refuse to register a back-end with an unknown parent.
938 ;; Register dedicated export blocks in the parser.
942 ;; If a back-end with the same name as BACKEND is already
943 ;; registered, replace it with BACKEND. Otherwise, simply add
944 ;; BACKEND to the list of registered back-ends.
950 "Signal an error if BACKEND isn't defined."
955 "Non-nil if BACKEND is derived from one of BACKENDS.
956 BACKEND is an export back-end, as returned by, e.g.,
957 `org-export-create-backend', or a symbol referring to
958 a registered back-end. BACKENDS is constituted of symbols."
970 "Return full translation table for BACKEND.
972 BACKEND is an export back-end, as return by, e.g,,
973 `org-export-create-backend'. Return value is an alist where
974 keys are element or object types, as symbols, and values are
975 transcoders.
977 Unlike to `org-export-backend-transcoders', this function
978 also returns transcoders inherited from parent back-ends,
979 if any."
983 parent)
988 transcoders)))
991 "Return export options for BACKEND.
993 BACKEND is an export back-end, as return by, e.g,,
994 `org-export-create-backend'. See `org-export-options-alist'
995 for the shape of the return value.
997 Unlike to `org-export-backend-options', this function also
998 returns options inherited from parent back-ends, if any."
1002 parent)
1006 options)))
1009 "Return complete list of filters for BACKEND.
1011 BACKEND is an export back-end, as return by, e.g,,
1012 `org-export-create-backend'. Return value is an alist where
1013 keys are symbols and values lists of functions.
1015 Unlike to `org-export-backend-filters', this function also
1016 returns filters inherited from parent back-ends, if any."
1020 parent)
1024 filters)))
1027 "Define a new back-end BACKEND.
1029 TRANSCODERS is an alist between object or element types and
1030 functions handling them.
1032 These functions should return a string without any trailing
1033 space, or nil. They must accept three arguments: the object or
1034 element itself, its contents or nil when it isn't recursive and
1035 the property list used as a communication channel.
1037 Contents, when not nil, are stripped from any global indentation
1038 \(although the relative one is preserved). They also always end
1039 with a single newline character.
1041 If, for a given type, no function is found, that element or
1042 object type will simply be ignored, along with any blank line or
1043 white space at its end. The same will happen if the function
1044 returns the nil value. If that function returns the empty
1045 string, the type will be ignored, but the blank lines or white
1046 spaces will be kept.
1048 In addition to element and object types, one function can be
1049 associated to the `template' (or `inner-template') symbol and
1050 another one to the `plain-text' symbol.
1052 The former returns the final transcoded string, and can be used
1053 to add a preamble and a postamble to document's body. It must
1054 accept two arguments: the transcoded string and the property list
1055 containing export options. A function associated to `template'
1057 A function associated to `inner-template' is always applied.
1059 The latter, when defined, is to be called on every text not
1060 recognized as an element or an object. It must accept two
1061 arguments: the text string and the information channel. It is an
1062 appropriate place to protect special chars relative to the
1063 back-end.
1065 BODY can start with pre-defined keyword arguments. The following
1066 keywords are understood:
1068 :export-block
1070 String, or list of strings, representing block names that
1071 will not be parsed. This is used to specify blocks that will
1072 contain raw code specific to the back-end. These blocks
1073 still have to be handled by the relative `export-block' type
1074 translator.
1076 :filters-alist
1078 Alist between filters and function, or list of functions,
1079 specific to the back-end. See `org-export-filters-alist' for
1080 a list of all allowed filters. Filters defined here
1081 shouldn't make a back-end test, as it may prevent back-ends
1082 derived from this one to behave properly.
1084 :menu-entry
1086 Menu entry for the export dispatcher. It should be a list
1087 like:
1089 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1091 where :
1093 KEY is a free character selecting the back-end.
1095 DESCRIPTION-OR-ORDINAL is either a string or a number.
1097 If it is a string, is will be used to name the back-end in
1098 its menu entry. If it is a number, the following menu will
1099 be displayed as a sub-menu of the back-end with the same
1100 KEY. Also, the number will be used to determine in which
1101 order such sub-menus will appear (lowest first).
1103 ACTION-OR-MENU is either a function or an alist.
1105 If it is an action, it will be called with four
1106 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1107 BODY-ONLY. See `org-export-as' for further explanations on
1108 some of them.
1110 If it is an alist, associations should follow the
1111 pattern:
1113 '(KEY DESCRIPTION ACTION)
1115 where KEY, DESCRIPTION and ACTION are described above.
1117 Valid values include:
1121 or
1126 \(lambda (a s v b)
1127 \(if a (org-latex-export-to-pdf t s v b)
1128 \(org-open-file
1129 \(org-latex-export-to-pdf nil s v b)))))))
1131 or the following, which will be added to the previous
1132 sub-menu,
1134 '(?l 1
1138 :options-alist
1140 Alist between back-end specific properties introduced in
1141 communication channel and how their value are acquired. See
1142 `org-export-options-alist' for more information about
1143 structure of the values."
1157 :transcoders transcoders
1158 :options options
1159 :filters filters
1160 :blocks blocks
1164 "Create a new back-end as a variant of an existing one.
1166 CHILD is the name of the derived back-end. PARENT is the name of
1167 the parent back-end.
1169 BODY can start with pre-defined keyword arguments. The following
1170 keywords are understood:
1172 :export-block
1174 String, or list of strings, representing block names that
1175 will not be parsed. This is used to specify blocks that will
1176 contain raw code specific to the back-end. These blocks
1177 still have to be handled by the relative `export-block' type
1178 translator.
1180 :filters-alist
1182 Alist of filters that will overwrite or complete filters
1183 defined in PARENT back-end. See `org-export-filters-alist'
1184 for a list of allowed filters.
1186 :menu-entry
1188 Menu entry for the export dispatcher. See
1189 `org-export-define-backend' for more information about the
1190 expected value.
1192 :options-alist
1194 Alist of back-end specific properties that will overwrite or
1195 complete those defined in PARENT back-end. Refer to
1196 `org-export-options-alist' for more information about
1197 structure of the values.
1199 :translate-alist
1201 Alist of element and object types and transcoders that will
1202 overwrite or complete transcode table from PARENT back-end.
1203 Refer to `org-export-define-backend' for detailed information
1204 about transcoders.
1207 as a variant of `latex' back-end with a custom template function:
1209 \(org-export-define-derived-backend 'my-latex 'latex
1210 :translate-alist '((template . my-latex-template-fun)))
1212 The back-end could then be called with, for example:
1229 :parent parent
1230 :transcoders transcoders
1231 :options options
1232 :filters filters
1233 :blocks blocks
1237 \f
1238 ;;; The Communication Channel
1239 ;;
1240 ;; During export process, every function has access to a number of
1241 ;; properties. They are of two types:
1242 ;;
1243 ;; 1. Environment options are collected once at the very beginning of
1244 ;; the process, out of the original buffer and configuration.
1245 ;; Collecting them is handled by `org-export-get-environment'
1246 ;; function.
1247 ;;
1248 ;; Most environment options are defined through the
1249 ;; `org-export-options-alist' variable.
1250 ;;
1251 ;; 2. Tree properties are extracted directly from the parsed tree,
1252 ;; just before export, by `org-export-collect-tree-properties'.
1253 ;;
1254 ;; Here is the full list of properties available during transcode
1255 ;; process, with their category and their value type.
1256 ;;
1257 ;; + `:author' :: Author's name.
1258 ;; - category :: option
1259 ;; - type :: string
1260 ;;
1261 ;; + `:back-end' :: Current back-end used for transcoding.
1262 ;; - category :: tree
1263 ;; - type :: structure
1264 ;;
1265 ;; + `:creator' :: String to write as creation information.
1266 ;; - category :: option
1267 ;; - type :: string
1268 ;;
1269 ;; + `:date' :: String to use as date.
1270 ;; - category :: option
1271 ;; - type :: string
1272 ;;
1273 ;; + `:description' :: Description text for the current data.
1274 ;; - category :: option
1275 ;; - type :: string
1276 ;;
1277 ;; + `:email' :: Author's email.
1278 ;; - category :: option
1279 ;; - type :: string
1280 ;;
1281 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1282 ;; process.
1283 ;; - category :: option
1284 ;; - type :: list of strings
1285 ;;
1286 ;; + `:export-options' :: List of export options available for current
1287 ;; process.
1288 ;; - category :: none
1289 ;; - type :: list of symbols, among `subtree', `body-only' and
1290 ;; `visible-only'.
1291 ;;
1292 ;; + `:exported-data' :: Hash table used for memoizing
1293 ;; `org-export-data'.
1294 ;; - category :: tree
1295 ;; - type :: hash table
1296 ;;
1297 ;; + `:filetags' :: List of global tags for buffer. Used by
1298 ;; `org-export-get-tags' to get tags with inheritance.
1299 ;; - category :: option
1300 ;; - type :: list of strings
1301 ;;
1302 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1303 ;; their definition, as parsed data. Only non-inlined footnotes
1304 ;; are represented in this alist. Also, every definition isn't
1305 ;; guaranteed to be referenced in the parse tree. The purpose of
1306 ;; this property is to preserve definitions from oblivion
1307 ;; (i.e. when the parse tree comes from a part of the original
1308 ;; buffer), it isn't meant for direct use in a back-end. To
1309 ;; retrieve a definition relative to a reference, use
1310 ;; `org-export-get-footnote-definition' instead.
1311 ;; - category :: option
1312 ;; - type :: alist (STRING . LIST)
1313 ;;
1314 ;; + `:headline-levels' :: Maximum level being exported as an
1315 ;; headline. Comparison is done with the relative level of
1316 ;; headlines in the parse tree, not necessarily with their
1317 ;; actual level.
1318 ;; - category :: option
1319 ;; - type :: integer
1320 ;;
1321 ;; + `:headline-offset' :: Difference between relative and real level
1322 ;; of headlines in the parse tree. For example, a value of -1
1323 ;; means a level 2 headline should be considered as level
1324 ;; 1 (cf. `org-export-get-relative-level').
1325 ;; - category :: tree
1326 ;; - type :: integer
1327 ;;
1328 ;; + `:headline-numbering' :: Alist between headlines and their
1329 ;; numbering, as a list of numbers
1330 ;; (cf. `org-export-get-headline-number').
1331 ;; - category :: tree
1332 ;; - type :: alist (INTEGER . LIST)
1333 ;;
1334 ;; + `:id-alist' :: Alist between ID strings and destination file's
1335 ;; path, relative to current directory. It is used by
1336 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1337 ;; external file.
1338 ;; - category :: option
1339 ;; - type :: alist (STRING . STRING)
1340 ;;
1341 ;; + `:ignore-list' :: List of elements and objects that should be
1342 ;; ignored during export.
1343 ;; - category :: tree
1344 ;; - type :: list of elements and objects
1345 ;;
1346 ;; + `:input-buffer' :: Original buffer name.
1347 ;; - category :: option
1348 ;; - type :: string
1349 ;;
1350 ;; + `:input-file' :: Full path to input file, if any.
1351 ;; - category :: option
1352 ;; - type :: string or nil
1353 ;;
1354 ;; + `:keywords' :: List of keywords attached to data.
1355 ;; - category :: option
1356 ;; - type :: string
1357 ;;
1358 ;; + `:language' :: Default language used for translations.
1359 ;; - category :: option
1360 ;; - type :: string
1361 ;;
1362 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1363 ;; transcoding.
1364 ;; - category :: option
1365 ;; - type :: list (as returned by `org-element-parse-buffer')
1366 ;;
1367 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1368 ;; all line breaks.
1369 ;; - category :: option
1370 ;; - type :: symbol (nil, t)
1371 ;;
1372 ;; + `:section-numbers' :: Non-nil means transcoding should add
1373 ;; section numbers to headlines.
1374 ;; - category :: option
1375 ;; - type :: symbol (nil, t)
1376 ;;
1377 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1378 ;; in transcoding. When such a tag is present, subtrees without
1379 ;; it are de facto excluded from the process. See
1380 ;; `use-select-tags'.
1381 ;; - category :: option
1382 ;; - type :: list of strings
1383 ;;
1384 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1385 ;; a time stamp in the output.
1386 ;; - category :: option
1387 ;; - type :: symbol (nil, t)
1388 ;;
1389 ;; + `:translate-alist' :: Alist between element and object types and
1390 ;; transcoding functions relative to the current back-end.
1391 ;; Special keys `inner-template', `template' and `plain-text' are
1392 ;; also possible.
1393 ;; - category :: option
1394 ;; - type :: alist (SYMBOL . FUNCTION)
1395 ;;
1396 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1397 ;; also be transcoded. If it is set to the `headline' symbol,
1398 ;; only the archived headline's name is retained.
1399 ;; - category :: option
1400 ;; - type :: symbol (nil, t, `headline')
1401 ;;
1402 ;; + `:with-author' :: Non-nil means author's name should be included
1403 ;; in the output.
1404 ;; - category :: option
1405 ;; - type :: symbol (nil, t)
1406 ;;
1407 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1408 ;; - category :: option
1409 ;; - type :: symbol (nil, t)
1410 ;;
1411 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1412 ;; inserted at the end of the transcoded string. If the value
1413 ;; is `comment', it should be commented.
1414 ;; - category :: option
1415 ;; - type :: symbol (`comment', nil, t)
1416 ;;
1417 ;; + `:with-date' :: Non-nil means output should contain a date.
1418 ;; - category :: option
1419 ;; - type :. symbol (nil, t)
1420 ;;
1421 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1422 ;; its value is a list of names, only drawers with such names
1423 ;; will be transcoded. If that list starts with `not', drawer
1424 ;; with these names will be skipped.
1425 ;; - category :: option
1426 ;; - type :: symbol (nil, t) or list of strings
1427 ;;
1428 ;; + `:with-email' :: Non-nil means output should contain author's
1429 ;; email.
1430 ;; - category :: option
1431 ;; - type :: symbol (nil, t)
1432 ;;
1433 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1434 ;; interpreted.
1435 ;; - category :: option
1436 ;; - type :: symbol (nil, t)
1437 ;;
1438 ;; + `:with-fixed-width' :: Non-nil if transcoder should export
1439 ;; strings starting with a colon as a fixed-with (verbatim) area.
1440 ;; - category :: option
1441 ;; - type :: symbol (nil, t)
1442 ;;
1443 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1444 ;; footnotes.
1445 ;; - category :: option
1446 ;; - type :: symbol (nil, t)
1447 ;;
1448 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1449 ;; `latex-fragment' objects should appear in export output. When
1450 ;; this property is set to `verbatim', they will be left as-is.
1451 ;; - category :: option
1452 ;; - type :: symbol (`verbatim', nil, t)
1453 ;;
1454 ;; + `:with-planning' :: Non-nil means transcoding should include
1455 ;; planning info.
1456 ;; - category :: option
1457 ;; - type :: symbol (nil, t)
1458 ;;
1459 ;; + `:with-priority' :: Non-nil means transcoding should include
1460 ;; priority cookies.
1461 ;; - category :: option
1462 ;; - type :: symbol (nil, t)
1463 ;;
1464 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1465 ;; plain text.
1466 ;; - category :: option
1467 ;; - type :: symbol (nil, t)
1468 ;;
1469 ;; + `:with-special-strings' :: Non-nil means transcoding should
1470 ;; interpret special strings in plain text.
1471 ;; - category :: option
1472 ;; - type :: symbol (nil, t)
1473 ;;
1474 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1475 ;; interpret subscript and superscript. With a value of "{}",
1476 ;; only interpret those using curly brackets.
1477 ;; - category :: option
1478 ;; - type :: symbol (nil, {}, t)
1479 ;;
1480 ;; + `:with-tables' :: Non-nil means transcoding should export tables.
1481 ;; - category :: option
1482 ;; - type :: symbol (nil, t)
1483 ;;
1484 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1485 ;; headlines. A `not-in-toc' value will remove them from the
1486 ;; table of contents, if any, nonetheless.
1487 ;; - category :: option
1488 ;; - type :: symbol (nil, t, `not-in-toc')
1489 ;;
1490 ;; + `:with-tasks' :: Non-nil means transcoding should include
1491 ;; headlines with a TODO keyword. A `todo' value will only
1492 ;; include headlines with a todo type keyword while a `done'
1493 ;; value will do the contrary. If a list of strings is provided,
1494 ;; only tasks with keywords belonging to that list will be kept.
1495 ;; - category :: option
1496 ;; - type :: symbol (t, todo, done, nil) or list of strings
1497 ;;
1498 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1499 ;; time stamps. Special value `active' (resp. `inactive') ask to
1500 ;; export only active (resp. inactive) timestamps. Otherwise,
1501 ;; completely remove them.
1502 ;; - category :: option
1503 ;; - type :: symbol: (`active', `inactive', t, nil)
1504 ;;
1505 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1506 ;; added to the output. An integer value limits its depth.
1507 ;; - category :: option
1508 ;; - type :: symbol (nil, t or integer)
1509 ;;
1510 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1511 ;; include TODO keywords.
1512 ;; - category :: option
1513 ;; - type :: symbol (nil, t)
1516 ;;;; Environment Options
1517 ;;
1518 ;; Environment options encompass all parameters defined outside the
1519 ;; scope of the parsed data. They come from five sources, in
1520 ;; increasing precedence order:
1521 ;;
1522 ;; - Global variables,
1523 ;; - Buffer's attributes,
1524 ;; - Options keyword symbols,
1525 ;; - Buffer keywords,
1526 ;; - Subtree properties.
1527 ;;
1528 ;; The central internal function with regards to environment options
1529 ;; is `org-export-get-environment'. It updates global variables with
1530 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1531 ;; the different sources.
1532 ;;
1533 ;; The internal functions doing the retrieval are:
1534 ;; `org-export--get-global-options',
1535 ;; `org-export--get-buffer-attributes',
1536 ;; `org-export--parse-option-keyword',
1537 ;; `org-export--get-subtree-options' and
1538 ;; `org-export--get-inbuffer-options'
1539 ;;
1540 ;; Also, `org-export--list-bound-variables' collects bound variables
1541 ;; along with their value in order to set them as buffer local
1542 ;; variables later in the process.
1545 "Collect export options from the current buffer.
1547 Optional argument BACKEND is an export back-end, as returned by
1548 `org-export-create-backend'.
1550 When optional argument SUBTREEP is non-nil, assume the export is
1551 done against the current sub-tree.
1553 Third optional argument EXT-PLIST is a property list with
1554 external parameters overriding Org default settings, but still
1555 inferior to file-local settings."
1556 ;; First install #+BIND variables since these must be set before
1557 ;; global options are read.
1560 ;; Get and prioritize export options...
1562 ;; ... from global variables...
1564 ;; ... from an external property list...
1565 ext-plist
1566 ;; ... from in-buffer settings...
1568 ;; ... and from subtree, when appropriate.
1570 ;; Eventually add misc. properties.
1572 :back-end
1573 backend
1575 :footnote-definition-alist
1576 ;; Footnotes definitions must be collected in the original
1577 ;; buffer, as there's no insurance that they will still be in
1578 ;; the parse tree, due to possible narrowing.
1592 alist))))
1593 alist))
1594 :id-alist
1595 ;; Collect id references.
1606 alist))))
1609 "Parse an OPTIONS line and return values as a plist.
1610 Optional argument BACKEND is an export back-end, as returned by,
1611 e.g., `org-export-create-backend'. It specifies which back-end
1612 specific items to read, if any."
1614 ;; Priority is given to back-end specific options.
1616 org-export-options-alist))
1617 plist)
1626 options))
1628 property
1631 plist))
1634 "Get export options in subtree at point.
1635 Optional argument BACKEND is an export back-end, as returned by,
1636 e.g., `org-export-create-backend'. It specifies back-end used
1637 for export. Return options as a plist."
1638 ;; For each buffer keyword, create a headline property setting the
1639 ;; same property in communication channel. The name for the property
1640 ;; is the keyword with "EXPORT_" appended to it.
1643 ;; Make sure point is at a heading.
1645 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1646 ;; title (with no todo keyword, priority cookie or tag) as its
1647 ;; fallback value.
1653 plist :title
1656 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1660 ;; Handle other keywords. TITLE keyword is excluded as it has
1661 ;; been handled already.
1669 ;; Export properties are not case-sensitive.
1676 plist
1677 property
1679 ;; Parse VALUE if required.
1683 ;; If BEHAVIOR is `split' expected value is
1684 ;; a list of strings, not a string.
1687 ;; Look for both general keywords and back-end specific
1688 ;; options, with priority given to the latter.
1690 org-export-options-alist)))
1691 ;; Return value.
1692 plist)))
1695 "Return current buffer export options, as a plist.
1697 Optional argument BACKEND, when non-nil, is an export back-end,
1698 as returned by, e.g., `org-export-create-backend'. It specifies
1699 which back-end specific options should also be read in the
1700 process.
1702 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1704 get-options ; For byte-compiler.
1707 ;; Priority is given to back-end specific options.
1709 org-export-options-alist))
1712 org-export-special-keywords))))
1715 ;; Return all properties associated to KEYWORD.
1722 ;; Recursively read keywords in buffer. FILES is a list
1723 ;; of files read so far. PLIST is the current property
1724 ;; list obtained.
1733 ;; Options in `org-export-special-keywords'.
1737 ;; Avoid circular dependencies.
1747 plist
1752 plist
1758 ;; Options in `org-export-options-alist'.
1763 plist property
1764 ;; Handle value depending on specified
1765 ;; BEHAVIOR.
1771 " "
1784 ;; Return final value.
1785 plist))))
1786 ;; Read options in the current buffer.
1789 ;; Parse keywords specified in `org-element-document-properties'
1790 ;; and return PLIST.
1801 "Return properties related to buffer attributes, as a plist."
1802 ;; Store full path of input file name, or nil. For internal use.
1805 :input-file visited-file
1811 "Return global export options as a plist.
1812 Optional argument BACKEND, if non-nil, is an export back-end, as
1813 returned by, e.g., `org-export-create-backend'. It specifies
1814 which back-end specific export options should also be read in the
1815 process."
1817 ;; Priority is given to back-end specific options.
1819 org-export-options-alist)))
1826 plist
1827 prop
1828 ;; Eval default value provided. If keyword is
1829 ;; a member of `org-element-document-properties',
1830 ;; parse it as a secondary string before storing it.
1837 value)))))))))))
1840 "Return variables bound from BIND keywords in current buffer.
1841 Also look for BIND keywords in setup files. The return value is
1842 an alist where associations are (VARIABLE-NAME VALUE)."
1847 ;; Return an alist between variable names and their
1848 ;; value. FILES is a list of setup files names read so
1849 ;; far, used to avoid circular dependencies. ALIST is
1850 ;; the alist collected so far.
1861 ;; Enter setup file.
1871 alist))))))))))
1872 alist)))))
1873 ;; Return value in appropriate order of appearance.
1876 ;; defsubst org-export-get-parent must be defined before first use,
1877 ;; was originally defined in the topology section
1880 "Return BLOB parent or nil.
1881 BLOB is the element or object considered."
1884 ;;;; Tree Properties
1885 ;;
1886 ;; Tree properties are information extracted from parse tree. They
1887 ;; are initialized at the beginning of the transcoding process by
1888 ;; `org-export-collect-tree-properties'.
1889 ;;
1890 ;; Dedicated functions focus on computing the value of specific tree
1891 ;; properties during initialization. Thus,
1892 ;; `org-export--populate-ignore-list' lists elements and objects that
1893 ;; should be skipped during export, `org-export--get-min-level' gets
1894 ;; the minimal exportable level, used as a basis to compute relative
1895 ;; level for headlines. Eventually
1896 ;; `org-export--collect-headline-numbering' builds an alist between
1897 ;; headlines and their numbering.
1900 "Extract tree properties from parse tree.
1902 DATA is the parse tree from which information is retrieved. INFO
1903 is a list holding export options.
1905 Following tree properties are set or updated:
1907 `:exported-data' Hash table used to memoize results from
1908 `org-export-data'.
1910 `:footnote-definition-alist' List of footnotes definitions in
1911 original buffer and current parse tree.
1913 `:headline-offset' Offset between true level of headlines and
1914 local level. An offset of -1 means a headline
1915 of level 2 should be considered as a level
1916 1 headline in the context.
1918 `:headline-numbering' Alist of all headlines as key an the
1919 associated numbering as value.
1921 `:ignore-list' List of elements that should be ignored during
1922 export.
1924 Return updated plist."
1925 ;; Install the parse tree in the communication channel, in order to
1926 ;; use `org-export-get-genealogy' and al.
1928 ;; Get the list of elements and objects to ignore, and put it into
1929 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1930 ;; been done during parse tree filtering.
1933 :ignore-list
1936 ;; Compute `:headline-offset' in order to be able to use
1937 ;; `org-export-get-relative-level'.
1940 :headline-offset
1942 ;; Update footnotes definitions list with definitions in parse tree.
1943 ;; This is required since buffer expansion might have modified
1944 ;; boundaries of footnote definitions contained in the parse tree.
1945 ;; This way, definitions in `footnote-definition-alist' are bound to
1946 ;; match those in the parse tree.
1952 defs)))
1954 ;; Properties order doesn't matter: get the rest of the tree
1955 ;; properties.
1959 info))
1962 "Return minimum exportable headline's level in DATA.
1963 DATA is parsed tree as returned by `org-element-parse-buffer'.
1964 OPTIONS is a plist holding export options."
1975 ;; If no headline was found, for the sake of consistency, set
1976 ;; minimum level to 1 nonetheless.
1980 "Return numbering of all exportable headlines in a parse tree.
1982 DATA is the parse tree. OPTIONS is the plist holding export
1983 options.
1985 Return an alist whose key is a headline and value is its
1986 associated numbering \(in the shape of a list of numbers\) or nil
1987 for a footnotes section."
1995 headline
1997 for idx from 0 to org-export-max-depth
2001 options)))
2004 "Return list of elements and objects to ignore during export.
2005 DATA is the parse tree to traverse. OPTIONS is the plist holding
2006 export options."
2008 ;; First find trees containing a select tag, if any.
2010 ;; If a select tag is active, also ignore the section before
2011 ;; the first headline, if any.
2015 first-element))))
2018 ;; Collect ignored elements or objects into IGNORE-LIST.
2024 ;; If headline is archived but tree below has
2025 ;; to be skipped, add it to ignore list.
2028 ;; Move into secondary string, if any.
2033 ;; Move into recursive objects/elements.
2035 ;; Main call.
2037 ;; Return value.
2038 ignore))
2041 "Return list of headlines and inlinetasks with a select tag in their tree.
2042 DATA is parsed data as returned by `org-element-parse-buffer'.
2043 INFO is a plist holding export options."
2045 walk-data ; For byte-compiler.
2055 ;; When a select tag is found, mark full
2056 ;; genealogy and every headline within the tree
2057 ;; as acceptable.
2060 genealogy
2063 selected-trees))
2064 ;; If at a headline, continue searching in tree,
2065 ;; recursively.
2075 selected-trees))
2078 "Non-nil when element or object BLOB should be skipped during export.
2079 OPTIONS is the plist holding export options. SELECTED, when
2080 non-nil, is a list of headlines or inlinetasks belonging to
2081 a tree with a select tag."
2088 ;; If `:with-drawers' value starts with `not', ignore
2089 ;; every drawer whose name belong to that list.
2090 ;; Otherwise, ignore drawers whose name isn't in that
2091 ;; list.
2108 ;; Ignore subtrees with an exclude tag.
2111 ;; When a select tag is present in the buffer, ignore any tree
2112 ;; without it.
2114 ;; Ignore commented sub-trees.
2116 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2118 ;; Ignore tasks, if specified by `:with-tasks' property.
2130 properties-set))))))
2141 ;; `:with-timestamps' only applies to isolated timestamps
2142 ;; objects, i.e. timestamp objects in a paragraph containing only
2143 ;; timestamps and whitespaces.
2151 options t))))
2160 \f
2161 ;;; The Transcoder
2162 ;;
2163 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2164 ;; `org-element-parse-buffer') and transcodes it into a specified
2165 ;; back-end output. It takes care of filtering out elements or
2166 ;; objects according to export options and organizing the output blank
2167 ;; lines and white space are preserved. The function memoizes its
2168 ;; results, so it is cheap to call it within transcoders.
2169 ;;
2170 ;; It is possible to modify locally the back-end used by
2171 ;; `org-export-data' or even use a temporary back-end by using
2172 ;; `org-export-data-with-backend'.
2173 ;;
2174 ;; Internally, three functions handle the filtering of objects and
2175 ;; elements during the export. In particular,
2176 ;; `org-export-ignore-element' marks an element or object so future
2177 ;; parse tree traversals skip it and `org-export-expand' transforms
2178 ;; the others back into their original shape.
2179 ;;
2180 ;; `org-export-transcoder' is an accessor returning appropriate
2181 ;; translator function for a given element or object.
2184 "Return appropriate transcoder for BLOB.
2185 INFO is a plist containing export directives."
2187 ;; Return contents only for complete parse trees.
2193 "Convert DATA into current back-end format.
2195 DATA is a parse tree, an element or an object or a secondary
2196 string. INFO is a plist holding export options.
2198 Return a string."
2203 ;; Ignored element/object.
2205 ;; Plain text.
2211 info))
2212 ;; Secondary string.
2215 ;; Element/Object without contents or, as a special
2216 ;; case, headline with archive tag and archived trees
2217 ;; restricted to title only.
2225 ;; Export snippets never return a nil value so
2226 ;; that white spaces following them are never
2227 ;; ignored.
2229 ;; Element/Object with contents.
2242 ;; Elements directly containing
2243 ;; objects must have their indentation
2244 ;; normalized first.
2246 data
2247 ;; When normalizing contents of the
2248 ;; first paragraph in an item or
2249 ;; a footnote definition, ignore
2250 ;; first line's indentation: there is
2251 ;; none and it might be misleading.
2256 data)
2263 info))))))))
2264 ;; Final result will be memoized before being returned.
2266 data
2270 ;; Append the same white space between elements or objects
2271 ;; as in the original buffer, and call appropriate filters.
2282 info)))
2283 results)))
2287 "Convert DATA into BACKEND format.
2289 DATA is an element, an object, a secondary string or a string.
2290 BACKEND is a symbol. INFO is a plist used as a communication
2291 channel.
2293 Unlike to `org-export-with-backend', this function will
2294 recursively convert DATA using BACKEND translation table."
2297 data
2298 ;; Set-up a new communication channel with translations defined in
2299 ;; BACKEND as the translate table and a new hash table for
2300 ;; memoization.
2302 info
2305 ;; Size of the hash table is reduced since this function
2306 ;; will probably be used on small trees.
2310 "Change uninterpreted elements back into Org syntax.
2311 DATA is the parse tree. INFO is a plist containing export
2312 options. Each uninterpreted element or object is changed back
2313 into a string. Contents, if any, are not modified. The parse
2314 tree is modified by side effect and returned by the function."
2318 prop
2321 info))))
2324 "Change uninterpreted elements back into Org syntax.
2325 DATA is a parse tree or a secondary string. INFO is a plist
2326 containing export options. It is modified by side effect and
2327 returned by the function."
2330 subscript superscript underline)
2334 ;; ... entities...
2341 ?\s)))))
2342 ;; ... emphasis...
2354 marker
2358 ?\s)))))))
2359 ;; ... LaTeX environments and fragments...
2363 ;; ... sub/superscripts...
2372 "_"
2381 ?\s)))))))))))
2383 ;; Splice NEW at BLOB location in parse tree.
2386 info)
2387 ;; Return modified parse tree.
2388 data)
2391 "Expand a parsed element or object to its original state.
2393 BLOB is either an element or an object. CONTENTS is its
2394 contents, as a string or nil.
2396 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2397 keywords before output."
2402 blob contents))))
2405 "Add ELEMENT to `:ignore-list' in INFO.
2407 Any element in `:ignore-list' will be skipped when using
2408 `org-element-map'. INFO is modified by side effects."
2412 \f
2413 ;;; The Filter System
2414 ;;
2415 ;; Filters allow end-users to tweak easily the transcoded output.
2416 ;; They are the functional counterpart of hooks, as every filter in
2417 ;; a set is applied to the return value of the previous one.
2418 ;;
2419 ;; Every set is back-end agnostic. Although, a filter is always
2420 ;; called, in addition to the string it applies to, with the back-end
2421 ;; used as argument, so it's easy for the end-user to add back-end
2422 ;; specific filters in the set. The communication channel, as
2423 ;; a plist, is required as the third argument.
2424 ;;
2425 ;; From the developer side, filters sets can be installed in the
2426 ;; process with the help of `org-export-define-backend', which
2427 ;; internally stores filters as an alist. Each association has a key
2428 ;; among the following symbols and a function or a list of functions
2429 ;; as value.
2430 ;;
2431 ;; - `:filter-options' applies to the property list containing export
2432 ;; options. Unlike to other filters, functions in this list accept
2433 ;; two arguments instead of three: the property list containing
2434 ;; export options and the back-end. Users can set its value through
2435 ;; `org-export-filter-options-functions' variable.
2436 ;;
2437 ;; - `:filter-parse-tree' applies directly to the complete parsed
2438 ;; tree. Users can set it through
2439 ;; `org-export-filter-parse-tree-functions' variable.
2440 ;;
2441 ;; - `:filter-final-output' applies to the final transcoded string.
2442 ;; Users can set it with `org-export-filter-final-output-functions'
2443 ;; variable
2444 ;;
2445 ;; - `:filter-plain-text' applies to any string not recognized as Org
2446 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2447 ;; configure it.
2448 ;;
2449 ;; - `:filter-TYPE' applies on the string returned after an element or
2450 ;; object of type TYPE has been transcoded. A user can modify
2451 ;; `org-export-filter-TYPE-functions'
2452 ;;
2453 ;; All filters sets are applied with
2454 ;; `org-export-filter-apply-functions' function. Filters in a set are
2455 ;; applied in a LIFO fashion. It allows developers to be sure that
2456 ;; their filters will be applied first.
2457 ;;
2458 ;; Filters properties are installed in communication channel with
2459 ;; `org-export-install-filters' function.
2460 ;;
2461 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2462 ;; `org-export-before-parsing-hook') are run at the beginning of the
2463 ;; export process and just before parsing to allow for heavy structure
2464 ;; modifications.
2467 ;;;; Hooks
2470 "Hook run at the beginning of the export process.
2472 This is run before include keywords and macros are expanded and
2473 Babel code blocks executed, on a copy of the original buffer
2474 being exported. Visibility and narrowing are preserved. Point
2475 is at the beginning of the buffer.
2477 Every function in this hook will be called with one argument: the
2481 "Hook run before parsing an export buffer.
2483 This is run after include keywords and macros have been expanded
2484 and Babel code blocks executed, on a copy of the original buffer
2485 being exported. Visibility and narrowing are preserved. Point
2486 is at the beginning of the buffer.
2488 Every function in this hook will be called with one argument: the
2492 ;;;; Special Filters
2495 "List of functions applied to the export options.
2496 Each filter is called with two arguments: the export options, as
2497 a plist, and the back-end, as a symbol. It must return
2501 "List of functions applied to the parsed tree.
2502 Each filter is called with three arguments: the parse tree, as
2503 returned by `org-element-parse-buffer', the back-end, as
2504 a symbol, and the communication channel, as a plist. It must
2508 "List of functions applied to plain text.
2509 Each filter is called with three arguments: a string which
2510 contains no Org syntax, the back-end, as a symbol, and the
2511 communication channel, as a plist. It must return a string or
2515 "List of functions applied to the transcoded string.
2516 Each filter is called with three arguments: the full transcoded
2517 string, the back-end, as a symbol, and the communication channel,
2518 as a plist. It must return a string that will be used as the
2522 ;;;; Elements Filters
2525 "List of functions applied to a transcoded babel-call.
2526 Each filter is called with three arguments: the transcoded data,
2527 as a string, the back-end, as a symbol, and the communication
2531 "List of functions applied to a transcoded center block.
2532 Each filter is called with three arguments: the transcoded data,
2533 as a string, the back-end, as a symbol, and the communication
2537 "List of functions applied to a transcoded clock.
2538 Each filter is called with three arguments: the transcoded data,
2539 as a string, the back-end, as a symbol, and the communication
2543 "List of functions applied to a transcoded comment.
2544 Each filter is called with three arguments: the transcoded data,
2545 as a string, the back-end, as a symbol, and the communication
2549 "List of functions applied to a transcoded comment-block.
2550 Each filter is called with three arguments: the transcoded data,
2551 as a string, the back-end, as a symbol, and the communication
2555 "List of functions applied to a transcoded diary-sexp.
2556 Each filter is called with three arguments: the transcoded data,
2557 as a string, the back-end, as a symbol, and the communication
2561 "List of functions applied to a transcoded drawer.
2562 Each filter is called with three arguments: the transcoded data,
2563 as a string, the back-end, as a symbol, and the communication
2567 "List of functions applied to a transcoded dynamic-block.
2568 Each filter is called with three arguments: the transcoded data,
2569 as a string, the back-end, as a symbol, and the communication
2573 "List of functions applied to a transcoded example-block.
2574 Each filter is called with three arguments: the transcoded data,
2575 as a string, the back-end, as a symbol, and the communication
2579 "List of functions applied to a transcoded export-block.
2580 Each filter is called with three arguments: the transcoded data,
2581 as a string, the back-end, as a symbol, and the communication
2585 "List of functions applied to a transcoded fixed-width.
2586 Each filter is called with three arguments: the transcoded data,
2587 as a string, the back-end, as a symbol, and the communication
2591 "List of functions applied to a transcoded footnote-definition.
2592 Each filter is called with three arguments: the transcoded data,
2593 as a string, the back-end, as a symbol, and the communication
2597 "List of functions applied to a transcoded headline.
2598 Each filter is called with three arguments: the transcoded data,
2599 as a string, the back-end, as a symbol, and the communication
2603 "List of functions applied to a transcoded horizontal-rule.
2604 Each filter is called with three arguments: the transcoded data,
2605 as a string, the back-end, as a symbol, and the communication
2609 "List of functions applied to a transcoded inlinetask.
2610 Each filter is called with three arguments: the transcoded data,
2611 as a string, the back-end, as a symbol, and the communication
2615 "List of functions applied to a transcoded item.
2616 Each filter is called with three arguments: the transcoded data,
2617 as a string, the back-end, as a symbol, and the communication
2621 "List of functions applied to a transcoded keyword.
2622 Each filter is called with three arguments: the transcoded data,
2623 as a string, the back-end, as a symbol, and the communication
2627 "List of functions applied to a transcoded latex-environment.
2628 Each filter is called with three arguments: the transcoded data,
2629 as a string, the back-end, as a symbol, and the communication
2633 "List of functions applied to a transcoded node-property.
2634 Each filter is called with three arguments: the transcoded data,
2635 as a string, the back-end, as a symbol, and the communication
2639 "List of functions applied to a transcoded paragraph.
2640 Each filter is called with three arguments: the transcoded data,
2641 as a string, the back-end, as a symbol, and the communication
2645 "List of functions applied to a transcoded plain-list.
2646 Each filter is called with three arguments: the transcoded data,
2647 as a string, the back-end, as a symbol, and the communication
2651 "List of functions applied to a transcoded planning.
2652 Each filter is called with three arguments: the transcoded data,
2653 as a string, the back-end, as a symbol, and the communication
2657 "List of functions applied to a transcoded property-drawer.
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 quote block.
2664 Each filter is called with three arguments: the transcoded quote
2665 data, as a string, the back-end, as a symbol, and the
2666 communication channel, as a plist. It must return a string or
2670 "List of functions applied to a transcoded section.
2671 Each filter is called with three arguments: the transcoded data,
2672 as a string, the back-end, as a symbol, and the communication
2676 "List of functions applied to a transcoded special block.
2677 Each filter is called with three arguments: the transcoded data,
2678 as a string, the back-end, as a symbol, and the communication
2682 "List of functions applied to a transcoded src-block.
2683 Each filter is called with three arguments: the transcoded data,
2684 as a string, the back-end, as a symbol, and the communication
2688 "List of functions applied to a transcoded table.
2689 Each filter is called with three arguments: the transcoded data,
2690 as a string, the back-end, as a symbol, and the communication
2694 "List of functions applied to a transcoded table-cell.
2695 Each filter is called with three arguments: the transcoded data,
2696 as a string, the back-end, as a symbol, and the communication
2700 "List of functions applied to a transcoded table-row.
2701 Each filter is called with three arguments: the transcoded data,
2702 as a string, the back-end, as a symbol, and the communication
2706 "List of functions applied to a transcoded verse block.
2707 Each filter is called with three arguments: the transcoded data,
2708 as a string, the back-end, as a symbol, and the communication
2712 ;;;; Objects Filters
2715 "List of functions applied to transcoded bold text.
2716 Each filter is called with three arguments: the transcoded data,
2717 as a string, the back-end, as a symbol, and the communication
2721 "List of functions applied to transcoded code text.
2722 Each filter is called with three arguments: the transcoded data,
2723 as a string, the back-end, as a symbol, and the communication
2727 "List of functions applied to a transcoded entity.
2728 Each filter is called with three arguments: the transcoded data,
2729 as a string, the back-end, as a symbol, and the communication
2733 "List of functions applied to a transcoded export-snippet.
2734 Each filter is called with three arguments: the transcoded data,
2735 as a string, the back-end, as a symbol, and the communication
2739 "List of functions applied to a transcoded footnote-reference.
2740 Each filter is called with three arguments: the transcoded data,
2741 as a string, the back-end, as a symbol, and the communication
2745 "List of functions applied to a transcoded inline-babel-call.
2746 Each filter is called with three arguments: the transcoded data,
2747 as a string, the back-end, as a symbol, and the communication
2751 "List of functions applied to a transcoded inline-src-block.
2752 Each filter is called with three arguments: the transcoded data,
2753 as a string, the back-end, as a symbol, and the communication
2757 "List of functions applied to transcoded italic text.
2758 Each filter is called with three arguments: the transcoded data,
2759 as a string, the back-end, as a symbol, and the communication
2763 "List of functions applied to a transcoded latex-fragment.
2764 Each filter is called with three arguments: the transcoded data,
2765 as a string, the back-end, as a symbol, and the communication
2769 "List of functions applied to a transcoded line-break.
2770 Each filter is called with three arguments: the transcoded data,
2771 as a string, the back-end, as a symbol, and the communication
2775 "List of functions applied to a transcoded link.
2776 Each filter is called with three arguments: the transcoded data,
2777 as a string, the back-end, as a symbol, and the communication
2781 "List of functions applied to a transcoded radio-target.
2782 Each filter is called with three arguments: the transcoded data,
2783 as a string, the back-end, as a symbol, and the communication
2787 "List of functions applied to a transcoded statistics-cookie.
2788 Each filter is called with three arguments: the transcoded data,
2789 as a string, the back-end, as a symbol, and the communication
2793 "List of functions applied to transcoded strike-through text.
2794 Each filter is called with three arguments: the transcoded data,
2795 as a string, the back-end, as a symbol, and the communication
2799 "List of functions applied to a transcoded subscript.
2800 Each filter is called with three arguments: the transcoded data,
2801 as a string, the back-end, as a symbol, and the communication
2805 "List of functions applied to a transcoded superscript.
2806 Each filter is called with three arguments: the transcoded data,
2807 as a string, the back-end, as a symbol, and the communication
2811 "List of functions applied to a transcoded target.
2812 Each filter is called with three arguments: the transcoded data,
2813 as a string, the back-end, as a symbol, and the communication
2817 "List of functions applied to a transcoded timestamp.
2818 Each filter is called with three arguments: the transcoded data,
2819 as a string, the back-end, as a symbol, and the communication
2823 "List of functions applied to transcoded underline text.
2824 Each filter is called with three arguments: the transcoded data,
2825 as a string, the back-end, as a symbol, and the communication
2829 "List of functions applied to transcoded verbatim text.
2830 Each filter is called with three arguments: the transcoded data,
2831 as a string, the back-end, as a symbol, and the communication
2835 ;;;; Filters Tools
2836 ;;
2837 ;; Internal function `org-export-install-filters' installs filters
2838 ;; hard-coded in back-ends (developer filters) and filters from global
2839 ;; variables (user filters) in the communication channel.
2840 ;;
2841 ;; Internal function `org-export-filter-apply-functions' takes care
2842 ;; about applying each filter in order to a given data. It ignores
2843 ;; filters returning a nil value but stops whenever a filter returns
2844 ;; an empty string.
2847 "Call every function in FILTERS.
2849 Functions are called with arguments VALUE, current export
2850 back-end's name and INFO. A function returning a nil value will
2851 be skipped. If it returns the empty string, the process ends and
2852 VALUE is ignored.
2854 Call is done in a LIFO fashion, to be sure that developer
2855 specified filters, if any, are called first."
2866 "Install filters properties in communication channel.
2867 INFO is a plist containing the current communication channel.
2868 Return the updated communication channel."
2870 ;; Install user-defined filters with `org-export-filters-alist'
2871 ;; and filters already in INFO (through ext-plist mechanism).
2878 ;; Filters in INFO will be called
2879 ;; before those user provided.
2882 default-value)))))
2883 org-export-filters-alist)
2884 ;; Prepend back-end specific filters to that list.
2886 ;; Single values get consed, lists are appended.
2891 plist key
2895 ;; Return new communication channel.
2899 \f
2900 ;;; Core functions
2901 ;;
2902 ;; This is the room for the main function, `org-export-as', along with
2903 ;; its derivative, `org-export-string-as'.
2904 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2905 ;; function should be added to kill ring.
2906 ;;
2907 ;; Note that `org-export-as' doesn't really parse the current buffer,
2908 ;; but a copy of it (with the same buffer-local variables and
2909 ;; visibility), where macros and include keywords are expanded and
2910 ;; Babel blocks are executed, if appropriate.
2911 ;; `org-export-with-buffer-copy' macro prepares that copy.
2912 ;;
2913 ;; File inclusion is taken care of by
2914 ;; `org-export-expand-include-keyword' and
2915 ;; `org-export--prepare-file-contents'. Structure wise, including
2916 ;; a whole Org file in a buffer often makes little sense. For
2917 ;; example, if the file contains a headline and the include keyword
2918 ;; was within an item, the item should contain the headline. That's
2919 ;; why file inclusion should be done before any structure can be
2920 ;; associated to the file, that is before parsing.
2921 ;;
2922 ;; `org-export-insert-default-template' is a command to insert
2923 ;; a default template (or a back-end specific template) at point or in
2924 ;; current subtree.
2927 "Return a copy of the current buffer.
2928 The copy preserves Org buffer-local variables, visibility and
2929 narrowing."
2935 new-buf))
2938 "Apply BODY in a copy of the current buffer.
2939 The copy preserves local variables, visibility and contents of
2940 the original buffer. Point is at the beginning of the buffer
2941 when BODY is applied."
2950 ;; Kill copy without confirmation.
2956 "Generate a function duplicating BUFFER.
2958 The copy will preserve local variables, visibility, contents and
2959 narrowing of the original buffer. If a region was active in
2960 BUFFER, contents will be narrowed to that region instead.
2962 The resulting function can be evaluated at a later time, from
2963 another buffer, effectively cloning the original buffer there.
2965 The function assumes BUFFER's major mode is `org-mode'."
2969 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2970 ;; already in BUFFER.
2972 ;; Copy specific buffer local variables and variables set
2973 ;; through BIND keywords.
2975 vars)
2983 buffer-file-name
2984 buffer-file-coding-system))
2988 ;; Skip unreadable values, as they cannot be
2989 ;; sent to external process.
2993 vars))))))
2994 ;; Whole buffer contents.
2999 ;; Narrowing.
3003 ;; Current position of point.
3005 ;; Overlays with invisible property.
3015 ov-set))))
3017 ov-set)))))
3019 ;;;###autoload
3022 "Transcode current Org buffer into BACKEND code.
3024 BACKEND is either an export back-end, as returned by, e.g.,
3025 `org-export-create-backend', or a symbol referring to
3026 a registered back-end.
3028 If narrowing is active in the current buffer, only transcode its
3029 narrowed part.
3031 If a region is active, transcode that region.
3033 When optional argument SUBTREEP is non-nil, transcode the
3034 sub-tree at point, extracting information from the headline
3035 properties first.
3037 When optional argument VISIBLE-ONLY is non-nil, don't export
3038 contents of hidden elements.
3040 When optional argument BODY-ONLY is non-nil, only return body
3041 code, without surrounding template.
3043 Optional argument EXT-PLIST, when provided, is a property list
3044 with external parameters overriding Org default settings, but
3045 still inferior to file-local settings.
3047 Return code as a string."
3052 ;; Narrow buffer to an appropriate region or subtree for
3053 ;; parsing. If parsing subtree, be sure to remove main headline
3054 ;; too.
3062 ;; Initialize communication channel with original buffer
3063 ;; attributes, unavailable in its copy.
3072 tree)
3073 ;; Update communication channel and get parse tree. Buffer
3074 ;; isn't parsed directly. Instead, a temporary copy is
3075 ;; created, where include keywords, macros are expanded and
3076 ;; code blocks are evaluated.
3078 ;; Run first hook with current back-end's name as argument.
3082 ;; Update macro templates since #+INCLUDE keywords might have
3083 ;; added some new ones.
3087 ;; Update radio targets since keyword inclusion might have
3088 ;; added some more.
3090 ;; Run last hook with current back-end's name as argument.
3095 ;; Update communication channel with environment. Also
3096 ;; install user's and developer's filters.
3101 ;; Expand export-specific set of macros: {{{author}}},
3102 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3103 ;; once regular macros have been expanded, since document
3104 ;; keywords may contain one of them.
3110 ;; EMAIL is not a parsed keyword: store it as-is.
3114 ;; Parse buffer.
3116 ;; Handle left-over uninterpreted elements or objects in
3117 ;; parse tree and communication channel.
3119 ;; Call options filters and update export options. We do not
3120 ;; use `org-export-filter-apply-functions' here since the
3121 ;; arity of such filters is different.
3126 ;; Parse buffer, handle uninterpreted elements or objects,
3127 ;; then call parse-tree filters.
3131 ;; Now tree is complete, compute its properties and add them
3132 ;; to communication channel.
3136 ;; Eventually transcode TREE. Wrap the resulting string into
3137 ;; a template.
3146 ;; Remove all text properties since they cannot be
3147 ;; retrieved from an external process. Finally call
3148 ;; final-output filter and return result.
3154 info))))))))
3156 ;;;###autoload
3158 "Transcode STRING into BACKEND code.
3160 BACKEND is either an export back-end, as returned by, e.g.,
3161 `org-export-create-backend', or a symbol referring to
3162 a registered back-end.
3164 When optional argument BODY-ONLY is non-nil, only return body
3165 code, without preamble nor postamble.
3167 Optional argument EXT-PLIST, when provided, is a property list
3168 with external parameters overriding Org default settings, but
3169 still inferior to file-local settings.
3171 Return code as a string."
3177 ;;;###autoload
3179 "Replace the active region by its export to BACKEND.
3180 BACKEND is either an export back-end, as returned by, e.g.,
3181 `org-export-create-backend', or a symbol referring to
3182 a registered back-end."
3192 ;;;###autoload
3194 "Insert all export keywords with default values at beginning of line.
3196 BACKEND is a symbol referring to the name of a registered export
3197 back-end, for which specific export options should be added to
3198 the template, or `default' for default template. When it is nil,
3199 the user will be prompted for a category.
3201 If SUBTREEP is non-nil, export configuration will be set up
3202 locally for the subtree through node properties."
3212 "Options category: "
3216 org-export--registered-backends))
3217 nil t))))
3218 options keywords)
3219 ;; Populate OPTIONS and KEYWORDS.
3236 ;; Move to an appropriate location in order to insert options.
3238 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3256 ;; Then the rest of keywords, in the order specified in either
3257 ;; `org-export-options-alist' or respective export back-ends.
3278 "Expand every include keyword in buffer.
3279 Optional argument INCLUDED is a list of included file names along
3280 with their line restriction, when appropriate. It is used to
3281 avoid infinite recursion. Optional argument DIR is the current
3282 working directory. It is used to properly resolve relative
3283 paths."
3292 ;; Extract arguments from keyword's value.
3300 dir)
3305 value)
3311 ;; Minimal level of included file defaults to the child
3312 ;; level of the current headline, if any, or one. It
3313 ;; only applies is the file is meant to be included as
3314 ;; an Org one.
3322 ;; Remove keyword.
3328 ;; Check if files has already been parsed. Look after
3329 ;; inclusion lines too, as different parts of the same file
3330 ;; can be included too.
3342 ind-str contents ind-str))))
3350 ind-str env contents ind-str))))
3357 file lines ind minlevel
3366 "Prepare the contents of FILE for inclusion and return them as a string.
3368 When optional argument LINES is a string specifying a range of
3369 lines, include only those lines.
3371 Optional argument IND, when non-nil, is an integer specifying the
3372 global indentation of returned contents. Since its purpose is to
3373 allow an included file to stay in the same environment it was
3374 created \(i.e. a list item), it doesn't apply past the first
3375 headline encountered.
3377 Optional argument MINLEVEL, when non-nil, is an integer
3378 specifying the level that any top-level headline in the included
3379 file should have.
3381 Optional argument ID is an integer that will be inserted before
3382 each footnote definition and reference if FILE is an Org file.
3383 This is useful to avoid conflicts when more than one Org file
3384 with footnotes is included in a document."
3400 ;; Remove blank lines at beginning and end of contents. The logic
3401 ;; behind that removal is that blank lines around include keyword
3402 ;; override blank lines in included file.
3411 ;; If IND is set, preserve indentation of include keyword until
3412 ;; the first headline encountered.
3419 ;; Do not move footnote definitions out of column 0.
3425 ;; When MINLEVEL is specified, compute minimal level for headlines
3426 ;; in the file (CUR-MIN), and remove stars to each headline so
3427 ;; that headlines with minimal level have a level of MINLEVEL.
3438 ;; Only change stars, don't bother moving whole
3439 ;; sections.
3443 ;; Append ID to all footnote references and definitions, so they
3444 ;; become file specific and cannot collide with footnotes in other
3445 ;; included files.
3462 "Execute every Babel code in the visible part of current buffer."
3463 ;; Get a pristine copy of current buffer so Babel references can be
3464 ;; properly resolved.
3470 "Return a non-nil value when output should be added to the kill ring.
3471 See also `org-export-copy-to-kill-ring'."
3477 \f
3478 ;;; Tools For Back-Ends
3479 ;;
3480 ;; A whole set of tools is available to help build new exporters. Any
3481 ;; function general enough to have its use across many back-ends
3482 ;; should be added here.
3484 ;;;; For Affiliated Keywords
3485 ;;
3486 ;; `org-export-read-attribute' reads a property from a given element
3487 ;; as a plist. It can be used to normalize affiliated keywords'
3488 ;; syntax.
3489 ;;
3490 ;; Since captions can span over multiple lines and accept dual values,
3491 ;; their internal representation is a bit tricky. Therefore,
3492 ;; `org-export-get-caption' transparently returns a given element's
3493 ;; caption as a secondary string.
3496 "Turn ATTRIBUTE property from ELEMENT into a plist.
3498 When optional argument PROPERTY is non-nil, return the value of
3499 that property within attributes.
3503 properties.
3505 All values will become strings except the empty string and
3508 will become the empty string."
3522 s)
3527 ;; Ignore any string before first property with `cdr'.
3532 "Return caption from ELEMENT as a secondary string.
3534 When optional argument SHORTP is non-nil, return short caption,
3535 as a secondary string, instead.
3537 Caption lines are separated by a white space."
3545 ;;;; For Derived Back-ends
3546 ;;
3547 ;; `org-export-with-backend' is a function allowing to locally use
3548 ;; another back-end to transcode some object or element. In a derived
3549 ;; back-end, it may be used as a fall-back function once all specific
3550 ;; cases have been treated.
3553 "Call a transcoder from BACKEND on DATA.
3554 BACKEND is an export back-end, as returned by, e.g.,
3555 `org-export-create-backend', or a symbol referring to
3556 a registered back-end. DATA is an Org element, object, secondary
3557 string or string. CONTENTS, when non-nil, is the transcoded
3558 contents of DATA element, as a string. INFO, when non-nil, is
3559 the communication channel used for export, as a plist."
3569 transcoder data contents
3572 :translate-alist all-transcoders
3576 ;;;; For Export Snippets
3577 ;;
3578 ;; Every export snippet is transmitted to the back-end. Though, the
3579 ;; latter will only retain one type of export-snippet, ignoring
3580 ;; others, based on the former's target back-end. The function
3581 ;; `org-export-snippet-backend' returns that back-end for a given
3582 ;; export-snippet.
3585 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3586 Translation, with `org-export-snippet-translation-alist', is
3587 applied."
3591 back-end))))
3594 ;;;; For Footnotes
3595 ;;
3596 ;; `org-export-collect-footnote-definitions' is a tool to list
3597 ;; actually used footnotes definitions in the whole parse tree, or in
3598 ;; a headline, in order to add footnote listings throughout the
3599 ;; transcoded data.
3600 ;;
3601 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3602 ;; back-ends, when they need to attach the footnote definition only to
3603 ;; the first occurrence of the corresponding label.
3604 ;;
3605 ;; `org-export-get-footnote-definition' and
3606 ;; `org-export-get-footnote-number' provide easier access to
3607 ;; additional information relative to a footnote reference.
3610 "Return an alist between footnote numbers, labels and definitions.
3612 DATA is the parse tree from which definitions are collected.
3613 INFO is the plist used as a communication channel.
3615 Definitions are sorted by order of references. They either
3616 appear as Org data or as a secondary string for inlined
3617 footnotes. Unreferenced definitions are ignored."
3619 collect-fn ; for byte-compiler.
3623 ;; Collect footnote number, label and definition in DATA.
3631 def)
3632 num-alist)
3633 ;; Also search in definition for nested footnotes.
3636 ;; Don't enter footnote definitions since it will happen
3637 ;; when their first reference is found.
3643 "Non-nil when a footnote reference is the first one for its label.
3645 FOOTNOTE-REFERENCE is the footnote reference being considered.
3646 INFO is the plist used as a communication channel."
3648 ;; Anonymous footnotes are always a first reference.
3650 ;; Otherwise, return the first footnote with the same LABEL and
3651 ;; test if it is equal to FOOTNOTE-REFERENCE.
3661 ;; If FN isn't inlined, be sure to traverse its
3662 ;; definition before resuming search. See
3663 ;; comments in `org-export-get-footnote-number'
3664 ;; for more information.
3668 ;; Don't enter footnote definitions since it will
3669 ;; happen when their first reference is found.
3672 footnote-reference)))))
3675 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3676 INFO is the plist used as a communication channel. If no such
3678 string."
3685 "Return number associated to a footnote.
3687 FOOTNOTE is either a footnote reference or a footnote definition.
3688 INFO is the plist used as a communication channel."
3690 seen-refs
3691 search-ref ; For byte-compiler.
3695 ;; Search footnote references through DATA, filling
3696 ;; SEEN-REFS along the way.
3701 ;; Anonymous footnote match: return number.
3704 ;; Labels match: return number.
3707 ;; Anonymous footnote: it's always a new one.
3708 ;; Also, be sure to return nil from the `cond' so
3709 ;; `first-match' doesn't get us out of the loop.
3711 ;; Label not seen so far: add it so SEEN-REFS.
3712 ;;
3713 ;; Also search for subsequent references in
3714 ;; footnote definition so numbering follows
3715 ;; reading logic. Note that we don't have to care
3716 ;; about inline definitions, since
3717 ;; `org-element-map' already traverses them at the
3718 ;; right time.
3719 ;;
3720 ;; Once again, return nil to stay in the loop.
3725 nil))))
3726 ;; Don't enter footnote definitions since it will
3727 ;; happen when their first reference is found.
3732 ;;;; For Headlines
3733 ;;
3734 ;; `org-export-get-relative-level' is a shortcut to get headline
3735 ;; level, relatively to the lower headline level in the parsed tree.
3736 ;;
3737 ;; `org-export-get-headline-number' returns the section number of an
3738 ;; headline, while `org-export-number-to-roman' allows to convert it
3739 ;; to roman numbers.
3740 ;;
3741 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3742 ;; `org-export-last-sibling-p' are three useful predicates when it
3743 ;; comes to fulfill the `:headline-levels' property.
3744 ;;
3745 ;; `org-export-get-tags', `org-export-get-category' and
3746 ;; `org-export-get-node-property' extract useful information from an
3747 ;; headline or a parent headline. They all handle inheritance.
3748 ;;
3749 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3750 ;; as a secondary string, suitable for table of contents. It falls
3751 ;; back onto default title.
3754 "Return HEADLINE relative level within current parsed tree.
3755 INFO is a plist holding contextual information."
3760 "Non-nil when HEADLINE is considered as low level.
3762 INFO is a plist used as a communication channel.
3764 A low level headlines has a relative level greater than
3765 `:headline-levels' property value.
3767 Return value is the difference between HEADLINE relative level
3768 and the last level being considered as high enough, or nil."
3775 "Return HEADLINE numbering as a list of numbers.
3776 INFO is a plist holding contextual information."
3780 "Return a non-nil value if HEADLINE element should be numbered.
3781 INFO is a plist used as a communication channel."
3787 "Convert integer N into a roman numeral."
3800 res)))
3803 "Return list of tags associated to ELEMENT.
3805 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3806 is a plist used as a communication channel.
3808 Select tags (see `org-export-select-tags') and exclude tags (see
3809 `org-export-exclude-tags') are removed from the list.
3811 When non-nil, optional argument TAGS should be a list of strings.
3812 Any tag belonging to this list will also be removed.
3814 When optional argument INHERITED is non-nil, tags can also be
3815 inherited from parent headlines and FILETAGS keywords."
3821 ;; Build complete list of inherited tags.
3832 ;; Add FILETAGS keywords and return results.
3836 "Return node PROPERTY value for BLOB.
3838 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3839 element or object.
3841 If optional argument INHERITED is non-nil, the value can be
3842 inherited from a parent headline.
3844 Return value is a string or nil."
3856 "Return category for element or object BLOB.
3858 INFO is a plist used as a communication channel.
3860 CATEGORY is automatically inherited from a parent headline, from
3861 #+CATEGORY: keyword or created out of original file name. If all
3865 ;; Almost like `org-export-node-property', but we cannot trust
3866 ;; `plist-member' as every headline has a `:CATEGORY'
3867 ;; property, would it be nil or equal to "???" (which has the
3868 ;; same meaning).
3886 "Return alternative title for HEADLINE, as a secondary string.
3887 INFO is a plist used as a communication channel. If no optional
3888 title is defined, fall-back to the regular title."
3893 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3894 INFO is a plist used as a communication channel."
3899 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3900 INFO is a plist used as a communication channel."
3904 ;;;; For Keywords
3905 ;;
3906 ;; `org-export-get-date' returns a date appropriate for the document
3907 ;; to about to be exported. In particular, it takes care of
3908 ;; `org-export-date-timestamp-format'.
3911 "Return date value for the current document.
3913 INFO is a plist used as a communication channel. FMT, when
3914 non-nil, is a time format string that will be applied on the date
3915 if it consists in a single timestamp object. It defaults to
3916 `org-export-date-timestamp-format' when nil.
3918 A proper date can be a secondary string, a string or nil. It is
3919 meant to be translated with `org-export-data' or alike."
3930 ;;;; For Links
3931 ;;
3932 ;; `org-export-solidify-link-text' turns a string into a safer version
3933 ;; for links, replacing most non-standard characters with hyphens.
3934 ;;
3935 ;; `org-export-get-coderef-format' returns an appropriate format
3936 ;; string for coderefs.
3937 ;;
3938 ;; `org-export-inline-image-p' returns a non-nil value when the link
3939 ;; provided should be considered as an inline image.
3940 ;;
3941 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3942 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3943 ;; returns an appropriate unique identifier when found, or nil.
3944 ;;
3945 ;; `org-export-resolve-id-link' returns the first headline with
3946 ;; specified id or custom-id in parse tree, the path to the external
3947 ;; file with the id or nil when neither was found.
3948 ;;
3949 ;; `org-export-resolve-coderef' associates a reference to a line
3950 ;; number in the element it belongs, or returns the reference itself
3951 ;; when the element isn't numbered.
3954 "Take link text S and make a safe target out of it."
3959 "Return format string for code reference link.
3960 PATH is the link path. DESC is its description."
3968 "Non-nil if LINK object points to an inline image.
3970 Optional argument is a set of RULES defining inline images. It
3971 is an alist where associations have the following shape:
3973 \(TYPE . REGEXP)
3975 Applying a rule means apply REGEXP against LINK's path when its
3976 type is TYPE. The function will return a non-nil value if any of
3977 the provided rules is non-nil. The default rule is
3978 `org-export-default-inline-image-rule'.
3980 This only applies to links without a description."
3991 rules)
3992 ;; Return nil if no rule matched.
3993 nil))))
3996 "Resolve a code reference REF.
3998 INFO is a plist used as a communication channel.
4000 Return associated line number in source code, or REF itself,
4001 depending on src-block or example element's switches."
4008 org-coderef-label-format)))
4012 ;; Element containing REF is found. Resolve it to either
4013 ;; a label or a line number, as needed.
4023 "Return LINK destination.
4025 INFO is a plist holding contextual information.
4027 Return value can be an object, an element, or nil:
4029 - If LINK path matches a target object (i.e. <<path>>) return it.
4031 - If LINK path exactly matches the name affiliated keyword
4032 \(i.e. #+NAME: path) of an element, return that element.
4034 - If LINK path exactly matches any headline name, return that
4035 element. If more than one headline share that name, priority
4036 will be given to the one with the closest common ancestor, if
4037 any, or the first one in the parse tree otherwise.
4039 - Otherwise, return nil.
4042 significant."
4045 ;; Split PATH at white spaces so matches are space
4046 ;; insensitive.
4049 ;; Cache for destinations that are not position dependent.
4057 ;; Destination is not position dependent: use cached value.
4059 ;; First try to find a matching "<<path>>" unless user specified
4060 ;; he was looking for a headline (path starts with a "*"
4061 ;; character).
4067 path)
4068 blob))
4071 ;; Then try to find an element with a matching "#+NAME: path"
4072 ;; affiliated keyword.
4075 org-element-all-elements
4080 el)))
4083 ;; Last case: link either points to a headline or to nothingness.
4084 ;; Try to find the source, with priority given to headlines with
4085 ;; the closest common ancestor. If such candidate is found,
4086 ;; return it, otherwise return nil.
4090 ;; Return first headline whose `:raw-value' property is
4091 ;; NAME in parse tree DATA, or nil. Statistics cookies
4092 ;; are ignored.
4100 name)
4101 headline))
4103 ;; Search among headlines sharing an ancestor with link, from
4104 ;; closest to farthest.
4113 ;; No destination found: return nil.
4117 "Return headline referenced as LINK destination.
4119 INFO is a plist used as a communication channel.
4121 Return value can be the headline element matched in current parse
4125 ;; First check if id is within the current parse tree.
4130 headline))
4132 ;; Otherwise, look for external files.
4136 "Return radio-target object referenced as LINK destination.
4138 INFO is a plist used as a communication channel.
4140 Return value can be a radio-target object or nil. Assume LINK
4149 nil nil path nil nil t)
4150 t)
4151 radio))
4155 ;;;; For References
4156 ;;
4157 ;; `org-export-get-ordinal' associates a sequence number to any object
4158 ;; or element.
4161 "Return ordinal number of an element or object.
4163 ELEMENT is the element or object considered. INFO is the plist
4164 used as a communication channel.
4166 Optional argument TYPES, when non-nil, is a list of element or
4167 object types, as symbols, that should also be counted in.
4168 Otherwise, only provided element's type is considered.
4170 Optional argument PREDICATE is a function returning a non-nil
4171 value if the current element or object should be counted in. It
4172 accepts two arguments: the element or object being considered and
4173 the plist used as a communication channel. This allows to count
4174 only a certain type of objects (i.e. inline images).
4176 Return value is a list of numbers if ELEMENT is a headline or an
4177 item. It is nil for keywords. It represents the footnote number
4178 for footnote definitions and footnote references. If ELEMENT is
4179 a target, return the same value as if ELEMENT was the closest
4180 table, item or headline containing the target. In any other
4181 case, return the sequence number of ELEMENT among elements or
4182 objects of the same type."
4183 ;; Ordinal of a target object refer to the ordinal of the closest
4184 ;; table, item, or headline containing the object.
4188 when
4192 table))
4193 return parent)))
4195 ;; Special case 1: A headline returns its number as a list.
4197 ;; Special case 2: An item returns its number as a list.
4201 struct
4208 ;; Increment counter until ELEMENT is found again.
4219 ;;;; For Src-Blocks
4220 ;;
4221 ;; `org-export-get-loc' counts number of code lines accumulated in
4222 ;; src-block or example-block elements with a "+n" switch until
4223 ;; a given element, excluded. Note: "-n" switches reset that count.
4224 ;;
4225 ;; `org-export-unravel-code' extracts source code (along with a code
4226 ;; references alist) from an `element-block' or `src-block' type
4227 ;; element.
4228 ;;
4229 ;; `org-export-format-code' applies a formatting function to each line
4230 ;; of code, providing relative line number and code reference when
4231 ;; appropriate. Since it doesn't access the original element from
4232 ;; which the source code is coming, it expects from the code calling
4233 ;; it to know if lines should be numbered and if code references
4234 ;; should appear.
4235 ;;
4236 ;; Eventually, `org-export-format-code-default' is a higher-level
4237 ;; function (it makes use of the two previous functions) which handles
4238 ;; line numbering and code references inclusion, and returns source
4239 ;; code in a format suitable for plain text or verbatim output.
4242 "Return accumulated lines of code up to ELEMENT.
4244 INFO is the plist used as a communication channel.
4246 ELEMENT is excluded from count."
4252 ;; ELEMENT is reached: Quit the loop.
4254 ;; Only count lines from src-block and example-block elements
4255 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4259 ;; Accumulate locs or reset them.
4263 ;; Return nil to stay in the loop.
4264 nil)))
4266 ;; Return value.
4267 loc))
4270 "Clean source code and extract references out of it.
4272 ELEMENT has either a `src-block' an `example-block' type.
4274 Return a cons cell whose CAR is the source code, cleaned from any
4275 reference, protective commas and spurious indentation, and CDR is
4276 an alist between relative line number (integer) and name of code
4277 reference on that line (string)."
4280 ;; Get code and clean it. Remove blank lines at its
4281 ;; beginning and end.
4288 value
4290 ;; Get format used for references.
4293 org-coderef-label-format)))
4294 ;; Build a regexp matching a loc with a reference.
4299 ;; Return value.
4301 ;; Code with references removed.
4307 ;; Ref line: remove ref, and signal its position in REFS.
4311 ;; Reference alist.
4312 refs)))
4315 "Format CODE by applying FUN line-wise and return it.
4317 CODE is a string representing the code to format. FUN is
4318 a function. It must accept three arguments: a line of
4319 code (string), the current line number (integer) or nil and the
4320 reference associated to the current line (string) or nil.
4322 Optional argument NUM-LINES can be an integer representing the
4323 number of code lines accumulated until the current code. Line
4324 numbers passed to FUN will take it into account. If it is nil,
4325 FUN's second argument will always be nil. This number can be
4326 obtained with `org-export-get-loc' function.
4328 Optional argument REF-ALIST can be an alist between relative line
4329 number (i.e. ignoring NUM-LINES) and the name of the code
4330 reference on it. If it is nil, FUN's third argument will always
4331 be nil. It can be obtained through the use of
4332 `org-export-unravel-code' function."
4344 "Return source code from ELEMENT, formatted in a standard way.
4346 ELEMENT is either a `src-block' or `example-block' element. INFO
4347 is a plist used as a communication channel.
4349 This function takes care of line numbering and code references
4350 inclusion. Line numbers, when applicable, appear at the
4351 beginning of the line, separated from the code by two white
4352 spaces. Code references, on the other hand, appear flushed to
4353 the right, separated by six white spaces from the widest line of
4354 code."
4355 ;; Extract code and references.
4362 ;; Handle line numbering.
4371 ;; Prepare references display, if required. Any reference
4372 ;; should start six columns after the widest line of code,
4373 ;; wrapped with parenthesis.
4378 code
4382 number-str
4383 loc
4389 num-start refs)))))
4392 ;;;; For Tables
4393 ;;
4394 ;; `org-export-table-has-special-column-p' and and
4395 ;; `org-export-table-row-is-special-p' are predicates used to look for
4396 ;; meta-information about the table structure.
4397 ;;
4398 ;; `org-table-has-header-p' tells when the rows before the first rule
4399 ;; should be considered as table's header.
4400 ;;
4401 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4402 ;; and `org-export-table-cell-borders' extract information from
4403 ;; a table-cell element.
4404 ;;
4405 ;; `org-export-table-dimensions' gives the number on rows and columns
4406 ;; in the table, ignoring horizontal rules and special columns.
4407 ;; `org-export-table-cell-address', given a table-cell object, returns
4408 ;; the absolute address of a cell. On the other hand,
4409 ;; `org-export-get-table-cell-at' does the contrary.
4410 ;;
4411 ;; `org-export-table-cell-starts-colgroup-p',
4412 ;; `org-export-table-cell-ends-colgroup-p',
4413 ;; `org-export-table-row-starts-rowgroup-p',
4414 ;; `org-export-table-row-ends-rowgroup-p',
4415 ;; `org-export-table-row-starts-header-p' and
4416 ;; `org-export-table-row-ends-header-p' indicate position of current
4417 ;; row or cell within the table.
4420 "Non-nil when TABLE has a special column.
4421 All special columns will be ignored during export."
4422 ;; The table has a special column when every first cell of every row
4423 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4424 ;; "*" "_" and "^". Though, do not consider a first row containing
4425 ;; only empty cells as special.
4441 "Non-nil when TABLE has a header.
4443 INFO is a plist used as a communication channel.
4445 A table has a header when it contains at least two row groups."
4454 table
4465 cache)))))
4468 "Non-nil if TABLE-ROW is considered special.
4470 INFO is a plist used as the communication channel.
4472 All special rows will be ignored during export."
4476 ;; A row is special either when...
4478 ;; ... it starts with a field only containing "/",
4480 ;; ... the table contains a special column and the row start
4481 ;; with a marking character among, "^", "_", "$" or "!",
4485 ;; ... it contains only alignment cookies and empty cells.
4491 ;; Since VALUE is a secondary string, the following
4492 ;; checks avoid expanding it with `org-export-data'.
4504 "Return TABLE-ROW's group number, as an integer.
4506 INFO is a plist used as the communication channel.
4508 Return value is the group number, as an integer, or nil for
4509 special rows and rows separators. First group is also table's
4510 header."
4528 "Return TABLE-CELL contents width.
4530 INFO is a plist used as the communication channel.
4532 Return value is the width given by the last width cookie in the
4533 same column as TABLE-CELL, or nil."
4552 ;; In a special row, try to find a width cookie at COLUMN.
4556 ;; The following checks avoid expanding unnecessarily
4557 ;; the cell with `org-export-data'.
4567 "Return TABLE-CELL contents alignment.
4569 INFO is a plist used as the communication channel.
4571 Return alignment as specified by the last alignment cookie in the
4572 same column as TABLE-CELL. If no such cookie is found, a default
4573 alignment value will be deduced from fraction of numbers in the
4574 column (see `org-table-number-fraction' for more information).
4575 Possible values are `left', `right' and `center'."
4576 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4593 cookie-align
4594 previous-cell-number-p)
4597 ;; In a special row, try to find an alignment cookie at
4598 ;; COLUMN.
4602 ;; Since VALUE is a secondary string, the following
4603 ;; checks avoid useless expansion through
4604 ;; `org-export-data'.
4612 ;; Ignore table rules.
4614 ;; In a standard row, check if cell's contents are
4615 ;; expressing some kind of number. Increase NUMBER-CELLS
4616 ;; accordingly. Though, don't bother if an alignment
4617 ;; cookie has already defined cell's alignment.
4622 info)))
4624 ;; Treat an empty cell as a number if it follows
4625 ;; a number.
4631 ;; Return value. Alignment specified by cookies has
4632 ;; precedence over alignment deduced from cell's contents.
4634 column
4639 org-table-number-fraction)
4644 "Return TABLE-CELL borders.
4646 INFO is a plist used as a communication channel.
4648 Return value is a list of symbols, or nil. Possible values are:
4649 `top', `bottom', `above', `below', `left' and `right'. Note:
4650 `top' (resp. `bottom') only happen for a cell in the first
4651 row (resp. last row) of the table, ignoring table rules, if any.
4653 Returned borders ignore special rows."
4656 borders)
4657 ;; Top/above border? TABLE-CELL has a border above when a rule
4658 ;; used to demarcate row groups can be found above. Hence,
4659 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4660 ;; another regular row has to be found above that rule.
4669 ;; Look at every row before the current one.
4671 ;; No rule above, or rule found starts the table (ignoring any
4672 ;; special row): TABLE-CELL is at the top of the table.
4675 ;; Bottom/below border? TABLE-CELL has a border below when next
4676 ;; non-regular row below is a rule.
4685 ;; Look at every row after the current one.
4687 ;; No rule below, or rule found ends the table (modulo some
4688 ;; special row): TABLE-CELL is at the bottom of the table.
4691 ;; Right/left borders? They can only be specified by column
4692 ;; groups. Column groups are defined in a row starting with "/".
4693 ;; Also a column groups row only contains "<", "<>", ">" or blank
4694 ;; cells.
4711 ;; There's a left border when previous cell, if
4712 ;; any, ends a group, or current one starts one.
4718 ;; There's a right border when next cell, if any,
4719 ;; starts a group, or current one ends one.
4726 ;; Table rows are read in reverse order so last column groups
4727 ;; row has precedence over any previous one.
4729 ;; Return value.
4730 borders))
4733 "Non-nil when TABLE-CELL is at the beginning of a column group.
4734 INFO is a plist used as a communication channel."
4735 ;; A cell starts a column group either when it is at the beginning
4736 ;; of a row (or after the special column, if any) or when it has
4737 ;; a left border.
4740 table-cell)
4744 "Non-nil when TABLE-CELL is at the end of a column group.
4745 INFO is a plist used as a communication channel."
4746 ;; A cell ends a column group either when it is at the end of a row
4747 ;; or when it has a right border.
4750 table-cell)
4754 "Non-nil when TABLE-ROW is at the beginning of a row group.
4755 INFO is a plist used as a communication channel."
4763 "Non-nil when TABLE-ROW is at the end of a row group.
4764 INFO is a plist used as a communication channel."
4772 "Non-nil when TABLE-ROW is the first table header's row.
4773 INFO is a plist used as a communication channel."
4780 "Non-nil when TABLE-ROW is the last table header's row.
4781 INFO is a plist used as a communication channel."
4788 "Return TABLE-ROW number.
4789 INFO is a plist used as a communication channel. Return value is
4790 zero-based and ignores separators. The function returns nil for
4791 special columns and separators."
4803 "Return TABLE dimensions.
4805 INFO is a plist used as a communication channel.
4807 Return value is a CONS like (ROWS . COLUMNS) where
4808 ROWS (resp. COLUMNS) is the number of exportable
4809 rows (resp. columns)."
4811 ;; Set number of rows, and extract first one.
4817 ;; Set number of columns.
4819 ;; Return value.
4823 "Return address of a regular TABLE-CELL object.
4825 TABLE-CELL is the cell considered. INFO is a plist used as
4826 a communication channel.
4828 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4829 zero-based index. Only exportable cells are considered. The
4830 function returns nil for other cells."
4842 "Return regular table-cell object at ADDRESS in TABLE.
4844 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4845 zero-based index. TABLE is a table type element. INFO is
4846 a plist used as a communication channel.
4848 If no table-cell, among exportable cells, is found at ADDRESS,
4849 return nil."
4852 ;; Row at (car address) or nil.
4860 'table-cell
4867 ;;;; For Tables Of Contents
4868 ;;
4869 ;; `org-export-collect-headlines' builds a list of all exportable
4870 ;; headline elements, maybe limited to a certain depth. One can then
4871 ;; easily parse it and transcode it.
4872 ;;
4873 ;; Building lists of tables, figures or listings is quite similar.
4874 ;; Once the generic function `org-export-collect-elements' is defined,
4875 ;; `org-export-collect-tables', `org-export-collect-figures' and
4876 ;; `org-export-collect-listings' can be derived from it.
4879 "Collect headlines in order to build a table of contents.
4881 INFO is a plist used as a communication channel.
4883 When optional argument N is an integer, it specifies the depth of
4884 the table of contents. Otherwise, it is set to the value of the
4885 last headline level. See `org-export-headline-levels' for more
4886 information.
4888 Return a list of all exportable headlines as parsed elements.
4889 Footnote sections, if any, will be ignored."
4897 info)))
4900 "Collect referenceable elements of a determined type.
4902 TYPE can be a symbol or a list of symbols specifying element
4903 types to search. Only elements with a caption are collected.
4905 INFO is a plist used as a communication channel.
4907 When non-nil, optional argument PREDICATE is a function accepting
4908 one argument, an element of type TYPE. It returns a non-nil
4909 value when that element should be collected.
4911 Return a list of all elements found, in order of appearance."
4916 element))
4917 info))
4920 "Build a list of tables.
4921 INFO is a plist used as a communication channel.
4923 Return a list of table elements with a caption."
4927 "Build a list of figures.
4929 INFO is a plist used as a communication channel. PREDICATE is
4930 a function which accepts one argument: a paragraph element and
4931 whose return value is non-nil when that element should be
4932 collected.
4934 A figure is a paragraph type element, with a caption, verifying
4936 a vague concept that may depend on back-end.
4938 Return a list of elements recognized as figures."
4942 "Build a list of src blocks.
4944 INFO is a plist used as a communication channel.
4946 Return a list of src-block elements with a caption."
4950 ;;;; Smart Quotes
4951 ;;
4952 ;; The main function for the smart quotes sub-system is
4953 ;; `org-export-activate-smart-quotes', which replaces every quote in
4954 ;; a given string from the parse tree with its "smart" counterpart.
4955 ;;
4956 ;; Dictionary for smart quotes is stored in
4957 ;; `org-export-smart-quotes-alist'.
4958 ;;
4959 ;; Internally, regexps matching potential smart quotes (checks at
4960 ;; string boundaries are also necessary) are defined in
4961 ;; `org-export-smart-quotes-regexps'.
4965 ;; one may use: »...«, "...", ›...‹, or '...'.
4966 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4967 ;; LaTeX quotes require Babel!
5012 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5021 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5030 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5039 ;; 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
5040 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5051 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5057 )
5058 "Smart quotes translations.
5060 Alist whose CAR is a language string and CDR is an alist with
5061 quote type as key and a plist associating various encodings to
5062 their translation as value.
5064 A quote type can be any symbol among `opening-double-quote',
5065 `closing-double-quote', `opening-single-quote',
5066 `closing-single-quote' and `apostrophe'.
5068 Valid encodings include `:utf-8', `:html', `:latex' and
5069 `:texinfo'.
5075 ;; Possible opening quote at beginning of string.
5077 ;; Possible closing quote at beginning of string.
5079 ;; Possible apostrophe at beginning of string.
5081 ;; Opening single and double quotes.
5083 ;; Closing single and double quotes.
5085 ;; Apostrophe.
5087 ;; Possible opening quote at end of string.
5089 ;; Possible closing quote at end of string.
5091 ;; Possible apostrophe at end of string.
5093 "List of regexps matching a quote or an apostrophe.
5099 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5100 `:utf-8'. INFO is a plist used as a communication channel.
5102 The function has to retrieve information about string
5103 surroundings in parse tree. It can only happen with an
5104 unmodified string. Thus, if S has already been through another
5105 process, a non-nil ORIGINAL optional argument will provide that
5106 original string.
5108 Return the new string."
5111 ;; Try to be flexible when computing number of blanks
5112 ;; before object. The previous object may be a string
5113 ;; introduced by the back-end and not completely parsed.
5116 ;; A string with missing `:post-blank'
5117 ;; property.
5121 ;; Fallback value.
5126 ;; Return smart quote associated to a give quote Q, as
5127 ;; a string. TYPE is a symbol among `open', `close' and
5128 ;; `apostrophe'.
5138 org-export-smart-quotes-alist))))
5139 encoding)
5140 q)))))
5142 ;; Only a quote: no regexp can match. We have to check both
5143 ;; sides and decide what to do.
5151 ;; 1. Replace quote character at the beginning of S.
5153 ;; Apostrophe?
5159 ;; Closing quote?
5165 ;; Opening quote?
5171 ;; 2. Replace quotes in the middle of the string.
5173 ;; Opening quotes.
5179 ;; Closing quotes.
5185 ;; Apostrophes.
5190 ;; 3. Replace quote character at the end of S.
5192 ;; Apostrophe?
5197 ;; Closing quote?
5203 ;; Opening quote?
5208 ;; Return string with smart quotes.
5209 s))))
5211 ;;;; Topology
5212 ;;
5213 ;; Here are various functions to retrieve information about the
5214 ;; neighborhood of a given element or object. Neighbors of interest
5215 ;; are direct parent (`org-export-get-parent'), parent headline
5216 ;; (`org-export-get-parent-headline'), first element containing an
5217 ;; object, (`org-export-get-parent-element'), parent table
5218 ;; (`org-export-get-parent-table'), previous element or object
5219 ;; (`org-export-get-previous-element') and next element or object
5220 ;; (`org-export-get-next-element').
5221 ;;
5222 ;; `org-export-get-genealogy' returns the full genealogy of a given
5223 ;; element or object, from closest parent to full parse tree.
5225 ;; defsubst org-export-get-parent must be defined before first use
5228 "Return full genealogy relative to a given element or object.
5230 BLOB is the element or object being considered.
5232 Ancestors are returned from closest to farthest, the last one
5233 being the full parse tree."
5240 "Return BLOB parent headline or nil.
5241 BLOB is the element or object being considered."
5245 parent))
5248 "Return first element containing OBJECT or nil.
5249 OBJECT is the object to consider."
5253 parent))
5256 "Return OBJECT parent table or nil.
5257 OBJECT is either a `table-cell' or `table-element' type object."
5261 parent))
5264 "Return previous element or object.
5266 BLOB is an element or object. INFO is a plist used as
5267 a communication channel. Return previous exportable element or
5268 object, a string, or nil.
5270 When optional argument N is a positive integer, return a list
5271 containing up to N siblings before BLOB, from farthest to
5272 closest. With any other non-nil value, return a list containing
5273 all of them."
5279 prev)
5289 "Return next element or object.
5291 BLOB is an element or object. INFO is a plist used as
5292 a communication channel. Return next exportable element or
5293 object, a string, or nil.
5295 When optional argument N is a positive integer, return a list
5296 containing up to N siblings after BLOB, from closest to farthest.
5297 With any other non-nil value, return a list containing all of
5298 them."
5305 next)
5315 ;;;; Translation
5316 ;;
5317 ;; `org-export-translate' translates a string according to the language
5318 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5319 ;; the dictionary used for the translation.
5366 ("ru" :html "(Продолжение следует)"
5464 ("ru" :html "Список распечаток"
5477 ("ru" :html "Список таблиц"
5560 ("ru" :html "Неизвестная ссылка"
5563 "Dictionary for export engine.
5565 Alist whose CAR is the string to translate and CDR is an alist
5566 whose CAR is the language string and CDR is a plist whose
5567 properties are possible charsets and values translated terms.
5569 It is used as a database for `org-export-translate'. Since this
5570 function returns the string as-is if no translation was found,
5571 the variable only needs to record values different from the
5575 "Translate string S according to language specification.
5577 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5578 and `:utf-8'. INFO is a plist used as a communication channel.
5580 Translation depends on `:language' property. Return the
5581 translated string. If no translation is found, try to fall back
5582 to `:default' encoding. If it fails, return S."
5588 s)))
5591 \f
5592 ;;; Asynchronous Export
5593 ;;
5594 ;; `org-export-async-start' is the entry point for asynchronous
5595 ;; export. It recreates current buffer (including visibility,
5596 ;; narrowing and visited file) in an external Emacs process, and
5597 ;; evaluates a command there. It then applies a function on the
5598 ;; returned results in the current process.
5599 ;;
5600 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5601 ;; allow to export to a buffer or a file, asynchronously or not.
5602 ;;
5603 ;; `org-export-output-file-name' is an auxiliary function meant to be
5604 ;; used with `org-export-to-file'. With a given extension, it tries
5605 ;; to provide a canonical file name to write export output to.
5606 ;;
5607 ;; Asynchronously generated results are never displayed directly.
5608 ;; Instead, they are stored in `org-export-stack-contents'. They can
5609 ;; then be retrieved by calling `org-export-stack'.
5610 ;;
5611 ;; Export Stack is viewed through a dedicated major mode
5612 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5613 ;;`org-export-stack-delete', `org-export-stack-view' and
5614 ;;`org-export-stack-clear'.
5615 ;;
5616 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5617 ;; It should be used whenever `org-export-async-start' is called.
5620 "Call function FUN on the results returned by BODY evaluation.
5622 BODY evaluation happens in an asynchronous process, from a buffer
5623 which is an exact copy of the current one.
5625 Use `org-export-add-to-stack' in FUN in order to register results
5626 in the stack.
5628 This is a low level function. See also `org-export-to-buffer'
5629 and `org-export-to-file' for more specialized functions."
5632 ;; Write the full sexp evaluating BODY in a copy of the current
5633 ;; buffer to a temporary file, as it may be too long for program
5634 ;; args in `start-process'.
5641 ;; Null characters (from variable values) are inserted
5642 ;; within the file. As a consequence, coding system for
5643 ;; buffer contents will not be recognized properly. So,
5644 ;; we make sure it is the same as the one used to display
5645 ;; the original buffer.
5647 ,coding
5650 ;; Ignore `kill-emacs-hook' and code evaluation
5651 ;; queries from Babel as we need a truly
5652 ;; non-interactive process.
5654 org-babel-confirm-evaluate-answer-no t)
5655 ;; Initialize export framework.
5657 ;; Re-create current buffer there.
5660 ;; Sexp to evaluate in the buffer.
5662 ;; Start external process.
5665 (,process
5667 #'start-process
5670 ,proc-buffer
5677 ;; Register running process in stack.
5679 ;; Set-up sentinel in order to catch results.
5682 ,process
5704 ;;;###autoload
5707 &optional async subtreep visible-only body-only ext-plist
5708 post-process)
5709 "Call `org-export-as' with output to a specified buffer.
5711 BACKEND is either an export back-end, as returned by, e.g.,
5712 `org-export-create-backend', or a symbol referring to
5713 a registered back-end.
5715 BUFFER is the name of the output buffer. If it already exists,
5716 it will be erased first, otherwise, it will be created.
5718 A non-nil optional argument ASYNC means the process should happen
5719 asynchronously. The resulting buffer should then be accessible
5720 through the `org-export-stack' interface. When ASYNC is nil, the
5721 buffer is displayed if `org-export-show-temporary-export-buffer'
5722 is non-nil.
5724 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5725 EXT-PLIST are similar to those used in `org-export-as', which
5726 see.
5728 Optional argument POST-PROCESS is a function which should accept
5729 no argument. It is always called within the current process,
5730 from BUFFER, with point at its beginning. Export back-ends can
5731 use it to set a major mode there, e.g,
5733 \(defun org-latex-export-as-latex
5734 \(&optional async subtreep visible-only body-only ext-plist)
5735 \(interactive)
5737 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5739 This function returns BUFFER."
5767 buffer)))
5769 ;;;###autoload
5772 post-process)
5773 "Call `org-export-as' with output to a specified file.
5775 BACKEND is either an export back-end, as returned by, e.g.,
5776 `org-export-create-backend', or a symbol referring to
5777 a registered back-end. FILE is the name of the output file, as
5778 a string.
5780 A non-nil optional argument ASYNC means the process should happen
5781 asynchronously. The resulting buffer will then be accessible
5782 through the `org-export-stack' interface.
5784 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5785 EXT-PLIST are similar to those used in `org-export-as', which
5786 see.
5788 Optional argument POST-PROCESS is called with FILE as its
5789 argument and happens asynchronously when ASYNC is non-nil. It
5790 has to return a file name, or nil. Export back-ends can use this
5791 to send the output file through additional processing, e.g,
5793 \(defun org-latex-export-to-latex
5794 \(&optional async subtreep visible-only body-only ext-plist)
5795 \(interactive)
5797 \(org-export-to-file 'latex outfile
5798 async subtreep visible-only body-only ext-plist
5799 \(lambda (file) (org-latex-compile file)))
5801 The function returns either a file name returned by POST-PROCESS,
5802 or FILE."
5820 backend subtreep visible-only body-only ext-plist)))
5827 ;; Get proper return value.
5829 file))))))
5832 "Return output file's name according to buffer specifications.
5834 EXTENSION is a string representing the output file extension,
5835 with the leading dot.
5837 With a non-nil optional argument SUBTREEP, try to determine
5839 of subtree at point.
5841 When optional argument PUB-DIR is set, use it as the publishing
5842 directory.
5844 When optional argument VISIBLE-ONLY is non-nil, don't export
5845 contents of hidden elements.
5847 Return file name as a string."
5850 ;; File name may come from EXPORT_FILE_NAME subtree
5851 ;; property, assuming point is at beginning of said
5852 ;; sub-tree.
5859 ;; File name may be extracted from buffer's associated
5860 ;; file, if any.
5862 ;; Can't determine file name on our own: Ask user.
5866 "Output file: " pub-dir nil nil nil
5870 ;; Build file name. Enforce EXTENSION over whatever user
5871 ;; may have come up with. PUB-DIR, if defined, always has
5872 ;; precedence over any provided path.
5877 extension))
5880 ;; If writing to OUTPUT-FILE would overwrite original file, append
5881 ;; EXTENSION another time to final name.
5884 output-file)))
5887 "Add a new result to export stack if not present already.
5889 SOURCE is a buffer or a file name containing export results.
5890 BACKEND is a symbol representing export back-end used to generate
5891 it.
5893 Entries already pointing to SOURCE and unavailable entries are
5894 removed beforehand. Return the new stack."
5900 "Menu for asynchronous export results and running processes."
5910 "Return source from export results at point in stack."
5917 source
5918 ;; SOURCE is not consistent with current line. The stack
5919 ;; view is outdated.
5923 "Remove all entries from export stack."
5928 "Refresh the asynchronous export stack.
5929 DUMMY is ignored. Unavailable sources are removed from the list.
5930 Return the new stack."
5940 ;; Back-end.
5942 ;; Age.
5945 ;; Compute age of the results.
5947 "%4h:%.2m "
5949 ;; Source.
5954 ;; Clear stack from exited processes, dead buffers or
5955 ;; non-existent files.
5967 "Remove export results at point from stack.
5968 If optional argument SOURCE is non-nil, remove it instead."
5973 org-export-stack-contents))))
5976 "View export results at point in stack.
5977 With an optional prefix argument IN-EMACS, force viewing files
5978 within Emacs."
5992 (define-key km "p" 'previous-line)
5993 (define-key km "\C-p" 'previous-line)
5994 (define-key km "\C-?" 'previous-line)
5995 (define-key km [up] 'previous-line)
5996 (define-key km "C" 'org-export-stack-clear)
5997 (define-key km "v" 'org-export-stack-view)
5998 (define-key km (kbd "RET") 'org-export-stack-view)
5999 (define-key km "d" 'org-export-stack-remove)
6000 km)
6001 "Keymap for Org Export Stack.")
6003 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6004 "Mode for displaying asynchronous export stack.
6007 stack.
6009 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6010 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6011 stack completely.
6013 Removing entries in an Org Export Stack buffer doesn't affect
6014 files or buffers, only the display.
6017 (abbrev-mode 0)
6018 (auto-fill-mode 0)
6019 (setq buffer-read-only t
6020 buffer-undo-list t
6021 truncate-lines t
6022 header-line-format
6023 '(:eval
6024 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6025 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6026 (set (make-local-variable 'revert-buffer-function)
6027 'org-export-stack-refresh))
6030 \f
6031 ;;; The Dispatcher
6032 ;;
6033 ;; `org-export-dispatch' is the standard interactive way to start an
6034 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6035 ;; for its interface, which, in turn, delegates response to key
6036 ;; pressed to `org-export--dispatch-action'.
6038 ;;;###autoload
6039 (defun org-export-dispatch (&optional arg)
6040 "Export dispatcher for Org mode.
6042 It provides an access to common export related tasks in a buffer.
6043 Its interface comes in two flavors: standard and expert.
6045 While both share the same set of bindings, only the former
6046 displays the valid keys associations in a dedicated buffer.
6047 Scrolling (resp. line-wise motion) in this buffer is done with
6048 SPC and DEL (resp. C-n and C-p) keys.
6050 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6051 flavor or the other.
6054 of options used back then, on the current buffer.
6056 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6057 (interactive "P")
6058 (let* ((input
6059 (cond ((equal arg '(16)) '(stack))
6060 ((and arg org-export-dispatch-last-action))
6061 (t (save-window-excursion
6062 (unwind-protect
6063 (progn
6064 ;; Remember where we are
6065 (move-marker org-export-dispatch-last-position
6066 (point)
6067 (org-base-buffer (current-buffer)))
6068 ;; Get and store an export command
6069 (setq org-export-dispatch-last-action
6070 (org-export--dispatch-ui
6071 (list org-export-initial-scope
6072 (and org-export-in-background 'async))
6073 nil
6074 org-export-dispatch-use-expert-ui)))
6075 (and (get-buffer "*Org Export Dispatcher*")
6076 (kill-buffer "*Org Export Dispatcher*")))))))
6077 (action (car input))
6078 (optns (cdr input)))
6079 (unless (memq 'subtree optns)
6080 (move-marker org-export-dispatch-last-position nil))
6081 (case action
6082 ;; First handle special hard-coded actions.
6083 (template (org-export-insert-default-template nil optns))
6084 (stack (org-export-stack))
6085 (publish-current-file
6086 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6087 (publish-current-project
6088 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6089 (publish-choose-project
6090 (org-publish (assoc (org-icompleting-read
6091 "Publish project: "
6092 org-publish-project-alist nil t)
6093 org-publish-project-alist)
6094 (memq 'force optns)
6095 (memq 'async optns)))
6096 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6097 (otherwise
6098 (save-excursion
6099 (when arg
6100 ;; Repeating command, maybe move cursor to restore subtree
6101 ;; context.
6102 (if (eq (marker-buffer org-export-dispatch-last-position)
6103 (org-base-buffer (current-buffer)))
6104 (goto-char org-export-dispatch-last-position)
6105 ;; We are in a different buffer, forget position.
6106 (move-marker org-export-dispatch-last-position nil)))
6107 (funcall action
6108 ;; Return a symbol instead of a list to ease
6109 ;; asynchronous export macro use.
6110 (and (memq 'async optns) t)
6111 (and (memq 'subtree optns) t)
6112 (and (memq 'visible optns) t)
6113 (and (memq 'body optns) t)))))))
6115 (defun org-export--dispatch-ui (options first-key expertp)
6116 "Handle interface for `org-export-dispatch'.
6118 OPTIONS is a list containing current interactive options set for
6119 export. It can contain any of the following symbols:
6120 `body' toggles a body-only export
6121 `subtree' restricts export to current subtree
6122 `visible' restricts export to visible part of buffer.
6123 `force' force publishing files.
6124 `async' use asynchronous export process
6126 FIRST-KEY is the key pressed to select the first level menu. It
6127 is nil when this menu hasn't been selected yet.
6129 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6130 buffer is provided, but indications about currently active
6131 options are given in the prompt. Moreover, \[?] allows to switch
6132 back to standard interface."
6133 (let* ((fontify-key
6134 (lambda (key &optional access-key)
6135 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6136 ;; non-nil is the required first-level key to activate
6137 ;; KEY. When its value is t, activate KEY independently
6138 ;; on the first key, if any. A nil value means KEY will
6139 ;; only be activated at first level.
6140 (if (or (eq access-key t) (eq access-key first-key))
6141 (org-propertize key 'face 'org-warning)
6142 key)))
6143 (fontify-value
6144 (lambda (value)
6145 ;; Fontify VALUE string.
6146 (org-propertize value 'face 'font-lock-variable-name-face)))
6147 ;; Prepare menu entries by extracting them from registered
6148 ;; back-ends and sorting them by access key and by ordinal,
6149 ;; if any.
6150 (entries
6151 (sort (sort (delq nil
6152 (mapcar 'org-export-backend-menu
6153 org-export--registered-backends))
6154 (lambda (a b)
6155 (let ((key-a (nth 1 a))
6156 (key-b (nth 1 b)))
6157 (cond ((and (numberp key-a) (numberp key-b))
6158 (< key-a key-b))
6159 ((numberp key-b) t)))))
6160 'car-less-than-car))
6161 ;; Compute a list of allowed keys based on the first key
6162 ;; pressed, if any. Some keys
6163 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6164 ;; available.
6165 (allowed-keys
6166 (nconc (list 2 22 19 6 1)
6167 (if (not first-key) (org-uniquify (mapcar 'car entries))
6168 (let (sub-menu)
6169 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6170 (when (eq (car entry) first-key)
6171 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6172 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6173 ((not first-key) (list ?P)))
6174 (list ?& ?#)
6175 (when expertp (list ??))
6176 (list ?q)))
6177 ;; Build the help menu for standard UI.
6178 (help
6179 (unless expertp
6180 (concat
6181 ;; Options are hard-coded.
6182 (format "[%s] Body only: %s [%s] Visible only: %s
6183 \[%s] Export scope: %s [%s] Force publishing: %s
6185 (funcall fontify-key "C-b" t)
6186 (funcall fontify-value
6187 (if (memq 'body options) "On " "Off"))
6188 (funcall fontify-key "C-v" t)
6189 (funcall fontify-value
6190 (if (memq 'visible options) "On " "Off"))
6191 (funcall fontify-key "C-s" t)
6192 (funcall fontify-value
6193 (if (memq 'subtree options) "Subtree" "Buffer "))
6194 (funcall fontify-key "C-f" t)
6195 (funcall fontify-value
6196 (if (memq 'force options) "On " "Off"))
6197 (funcall fontify-key "C-a" t)
6198 (funcall fontify-value
6199 (if (memq 'async options) "On " "Off")))
6200 ;; Display registered back-end entries. When a key
6201 ;; appears for the second time, do not create another
6202 ;; entry, but append its sub-menu to existing menu.
6203 (let (last-key)
6204 (mapconcat
6205 (lambda (entry)
6206 (let ((top-key (car entry)))
6207 (concat
6208 (unless (eq top-key last-key)
6209 (setq last-key top-key)
6211 (funcall fontify-key (char-to-string top-key))
6212 (nth 1 entry)))
6213 (let ((sub-menu (nth 2 entry)))
6214 (unless (functionp sub-menu)
6215 ;; Split sub-menu into two columns.
6216 (let ((index -1))
6217 (concat
6218 (mapconcat
6219 (lambda (sub-entry)
6220 (incf index)
6221 (format
6222 (if (zerop (mod index 2)) " [%s] %-26s"
6224 (funcall fontify-key
6225 (char-to-string (car sub-entry))
6226 top-key)
6227 (nth 1 sub-entry)))
6228 sub-menu "")
6230 entries ""))
6231 ;; Publishing menu is hard-coded.
6233 [%s] Current file [%s] Current project
6235 (funcall fontify-key "P")
6236 (funcall fontify-key "f" ?P)
6237 (funcall fontify-key "p" ?P)
6238 (funcall fontify-key "x" ?P)
6239 (funcall fontify-key "a" ?P))
6241 (funcall fontify-key "&" t)
6242 (funcall fontify-key "#" t))
6243 (format "[%s] %s"
6244 (funcall fontify-key "q" t)
6245 (if first-key "Main menu" "Exit")))))
6246 ;; Build prompts for both standard and expert UI.
6247 (standard-prompt (unless expertp "Export command: "))
6248 (expert-prompt
6249 (when expertp
6250 (format
6251 "Export command (C-%s%s%s%s%s) [%s]: "
6252 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6253 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6254 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6255 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6256 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6257 (mapconcat (lambda (k)
6258 ;; Strip control characters.
6259 (unless (< k 27) (char-to-string k)))
6260 allowed-keys "")))))
6261 ;; With expert UI, just read key with a fancy prompt. In standard
6262 ;; UI, display an intrusive help buffer.
6263 (if expertp
6264 (org-export--dispatch-action
6265 expert-prompt allowed-keys entries options first-key expertp)
6266 ;; At first call, create frame layout in order to display menu.
6267 (unless (get-buffer "*Org Export Dispatcher*")
6268 (delete-other-windows)
6269 (org-switch-to-buffer-other-window
6270 (get-buffer-create "*Org Export Dispatcher*"))
6271 (setq cursor-type nil
6272 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6273 ;; Make sure that invisible cursor will not highlight square
6274 ;; brackets.
6275 (set-syntax-table (copy-syntax-table))
6276 (modify-syntax-entry ?\[ "w"))
6277 ;; At this point, the buffer containing the menu exists and is
6278 ;; visible in the current window. So, refresh it.
6279 (with-current-buffer "*Org Export Dispatcher*"
6280 ;; Refresh help. Maintain display continuity by re-visiting
6281 ;; previous window position.
6282 (let ((pos (window-start)))
6283 (erase-buffer)
6284 (insert help)
6285 (set-window-start nil pos)))
6286 (org-fit-window-to-buffer)
6287 (org-export--dispatch-action
6288 standard-prompt allowed-keys entries options first-key expertp))))
6290 (defun org-export--dispatch-action
6291 (prompt allowed-keys entries options first-key expertp)
6292 "Read a character from command input and act accordingly.
6294 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6295 a list of characters available at a given step in the process.
6296 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6297 EXPERTP are the same as defined in `org-export--dispatch-ui',
6298 which see.
6300 Toggle export options when required. Otherwise, return value is
6301 a list with action as CAR and a list of interactive export
6302 options as CDR."
6303 (let (key)
6304 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6305 ;; C-p, SPC, DEL).
6306 (while (and (setq key (read-char-exclusive prompt))
6307 (not expertp)
6308 (memq key '(14 16 ?\s ?\d)))
6309 (case key
6310 (14 (if (not (pos-visible-in-window-p (point-max)))
6311 (ignore-errors (scroll-up 1))
6312 (message "End of buffer")
6313 (sit-for 1)))
6314 (16 (if (not (pos-visible-in-window-p (point-min)))
6315 (ignore-errors (scroll-down 1))
6316 (message "Beginning of buffer")
6317 (sit-for 1)))
6318 (?\s (if (not (pos-visible-in-window-p (point-max)))
6319 (scroll-up nil)
6320 (message "End of buffer")
6321 (sit-for 1)))
6322 (?\d (if (not (pos-visible-in-window-p (point-min)))
6323 (scroll-down nil)
6324 (message "Beginning of buffer")
6325 (sit-for 1)))))
6326 (cond
6327 ;; Ignore undefined associations.
6328 ((not (memq key allowed-keys))
6329 (ding)
6330 (unless expertp (message "Invalid key") (sit-for 1))
6331 (org-export--dispatch-ui options first-key expertp))
6332 ;; q key at first level aborts export. At second level, cancel
6333 ;; first key instead.
6334 ((eq key ?q) (if (not first-key) (error "Export aborted")
6335 (org-export--dispatch-ui options nil expertp)))
6336 ;; Help key: Switch back to standard interface if expert UI was
6337 ;; active.
6338 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6339 ;; Send request for template insertion along with export scope.
6340 ((eq key ?#) (cons 'template (memq 'subtree options)))
6341 ;; Switch to asynchronous export stack.
6342 ((eq key ?&) '(stack))
6343 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6344 ((memq key '(2 22 19 6 1))
6345 (org-export--dispatch-ui
6346 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6347 (6 'force) (1 'async))))
6348 (if (memq option options) (remq option options)
6349 (cons option options)))
6350 first-key expertp))
6351 ;; Action selected: Send key and options back to
6352 ;; `org-export-dispatch'.
6353 ((or first-key (functionp (nth 2 (assq key entries))))
6354 (cons (cond
6355 ((not first-key) (nth 2 (assq key entries)))
6356 ;; Publishing actions are hard-coded. Send a special
6357 ;; signal to `org-export-dispatch'.
6358 ((eq first-key ?P)
6359 (case key
6360 (?f 'publish-current-file)
6361 (?p 'publish-current-project)
6362 (?x 'publish-choose-project)
6363 (?a 'publish-all)))
6364 ;; Return first action associated to FIRST-KEY + KEY
6365 ;; path. Indeed, derived backends can share the same
6366 ;; FIRST-KEY.
6367 (t (catch 'found
6368 (mapc (lambda (entry)
6369 (let ((match (assq key (nth 2 entry))))
6370 (when match (throw 'found (nth 2 match)))))
6371 (member (assq first-key entries) entries)))))
6372 options))
6373 ;; Otherwise, enter sub-menu.
6374 (t (org-export--dispatch-ui options key expertp)))))
6378 (provide 'ox)
6380 ;; Local variables:
6381 ;; generated-autoload-file: "org-loaddefs.el"
6382 ;; End:
6384 ;;; ox.el ends here