| blob | faa2e0541b436a3b61077fa8f5f117c3723e0e88 |
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:
93 \f
94 ;;; Internal Variables
95 ;;
96 ;; Among internal variables, the most important is
97 ;; `org-export-options-alist'. This variable define the global export
98 ;; 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
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
262 "Non-nil means asynchronous export process should leave data behind.
266 located in `temporary-file-directory'.
268 When non-nil, it will also set `debug-on-error' to a non-nil
272 "Record asynchronously generated export results and processes.
273 This is an alist: its CAR is the source of the
274 result (destination file or buffer for a finished process,
275 original buffer for a running one) and its CDR is a list
276 containing the back-end used, as a symbol, and either a process
277 or the time at which it finished. It is used to build the menu
281 "List of backends currently available in the exporter.
282 This variable is set with `org-export-define-backend' and
286 "Last command called from the dispatcher.
287 The value should be a list. Its CAR is the action, as a symbol,
291 "The position where the last export command was created using the dispatcher.
292 This marker will be used with `C-u C-c C-e' to make sure export repetition
295 ;; For compatibility with Org < 8
297 "Name, if any, of the back-end used during an export process.
299 Its value is a symbol such as `html', `latex', `ascii', or nil if
300 the back-end is anonymous (see `org-export-create-backend') or if
301 there is no export process in progress.
303 It can be used to teach Babel blocks how to act differently
306 \f
307 ;;; User-configurable Variables
308 ;;
309 ;; Configuration for the masses.
310 ;;
311 ;; They should never be accessed directly, as their value is to be
312 ;; stored in a property list (cf. `org-export-options-alist').
313 ;; Back-ends will read their value from there instead.
316 "Options for exporting Org mode files."
321 "General options for export engine."
326 "Whether sub-trees with the ARCHIVE tag should be exported.
328 This can have three different values:
329 nil Do not export, pretend this tree is not present.
330 t Do export the entire tree.
331 `headline' Only export the headline, but skip the tree below it.
333 This option can also be set with the OPTIONS keyword,
342 "Non-nil means insert author name into the exported file.
343 This option can also be set with the OPTIONS keyword,
349 "Non-nil means export CLOCK keywords.
350 This option can also be set with the OPTIONS keyword,
356 "Non-nil means the postamble should contain a creator sentence.
358 The sentence can be set in `org-export-creator-string' and
361 If the value is `comment' insert it as a comment."
369 "Non-nil means insert date in the exported document.
370 This option can also be set with the OPTIONS keyword,
376 "Time-stamp format string to use for DATE keyword.
378 The format string, when specified, only applies if date consists
379 in a single time-stamp. Otherwise its value will be ignored.
381 See `format-time-string' for details on how to build this
382 string."
390 emacs-version
392 "Information about the creator of the document.
393 This option can also be set on with the CREATOR keyword."
398 "Non-nil means export contents of standard drawers.
400 When t, all drawers are exported. This may also be a list of
401 drawer names to export. If that list starts with `not', only
402 drawers with such names will be ignored.
404 This variable doesn't apply to properties drawers.
406 This option can also be set with the OPTIONS keyword,
419 :inline t
423 "Non-nil means insert author email into the exported file.
424 This option can also be set with the OPTIONS keyword,
430 "Non-nil means interpret *word*, /word/, _word_ and +word+.
432 If the export target supports emphasizing text, the word will be
433 typeset in bold, italic, with an underline or strike-through,
434 respectively.
436 This option can also be set with the OPTIONS keyword,
442 "Tags that exclude a tree from export.
444 All trees carrying any of these tags will be excluded from
445 export. This is without condition, so even subtrees inside that
446 carry one of the `org-export-select-tags' will be removed.
448 This option can also be set with the EXCLUDE_TAGS keyword."
455 This can be used to have pre-formatted text, fragments of code
456 etc. For example:
457 : ;; Some Lisp examples
458 : (while (defc cnt)
459 : (ding))
460 will be looking just like this in also HTML. See also the QUOTE
461 keyword. Not all export backends support this.
463 This option can also be set with the OPTIONS keyword,
469 "Non-nil means Org footnotes should be exported.
470 This option can also be set with the OPTIONS keyword,
476 "Non-nil means process LaTeX environments and fragments.
478 This option can also be set with the OPTIONS line,
481 nil Ignore math snippets.
482 `verbatim' Keep everything in verbatim.
483 t Allow export of math snippets."
493 "The last level which is still exported as a headline.
495 Inferior levels will usually produce itemize or enumerate lists
496 when exported, but back-end behaviour may differ.
498 This option can also be set with the OPTIONS keyword,
504 "The default language for export and clocktable translations, as a string.
505 This may have an association in
506 `org-clock-clocktable-language-setup',
507 `org-export-smart-quotes-alist' and `org-export-dictionary'.
508 This option can also be set with the LANGUAGE keyword."
513 "Non-nil means preserve all line breaks when exporting.
514 This option can also be set with the OPTIONS keyword,
520 "Non-nil means interpret entities when exporting.
523 Å.
525 For a list of supported names, see the constant `org-entities'
526 and the user option `org-entities-user'.
528 This option can also be set with the OPTIONS keyword,
534 "Non-nil means inlinetasks should be exported.
535 This option can also be set with the OPTIONS keyword,
543 "Non-nil means include planning info in export.
545 Planning info is the line containing either SCHEDULED:,
546 DEADLINE:, CLOSED: time-stamps, or a combination of them.
548 This option can also be set with the OPTIONS keyword,
556 "Non-nil means include priority cookies in export.
557 This option can also be set with the OPTIONS keyword,
563 "Non-nil means add section numbers to headlines when exporting.
565 When set to an integer n, numbering will only happen for
566 headlines whose relative level is higher or equal to n.
568 This option can also be set with the OPTIONS keyword,
574 "Tags that select a tree for export.
576 If any such tag is found in a buffer, all trees that do not carry
577 one of these tags will be ignored during export. Inside trees
578 that are selected like this, you can still deselect a subtree by
579 tagging it with one of the `org-export-exclude-tags'.
581 This option can also be set with the SELECT_TAGS keyword."
586 "Non-nil means activate smart quotes during export.
587 This option can also be set with the OPTIONS keyword,
590 When setting this to non-nil, you need to take care of
591 using the correct Babel package when exporting to LaTeX.
592 E.g., you can load Babel for french like this:
603 When this option is turned on, these strings will be exported as:
605 Org HTML LaTeX UTF-8
606 -----+----------+--------+-------
608 -- – -- –
609 --- — --- —
612 This option can also be set with the OPTIONS keyword,
618 "Non-nil means include statistics cookies in export.
619 This option can also be set with the OPTIONS keyword,
629 If you want to control how Org displays those characters, see
630 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
631 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
632 it is not anymore.
634 When this option is turned on, you can use TeX-like syntax for
635 sub- and superscripts and see them exported correctly.
637 You can also set the option with #+OPTIONS: ^:t
640 single item - so grouping with {} is normally not needed. For
641 example, the following things will be parsed as single sub- or
642 superscripts:
644 10^24 or 10^tau several digits will be considered 1 item.
645 10^-12 or 10^-tau a leading sign with digits or a word
646 x^2-y^3 will be read as x^2 - y^3, because items are
647 terminated by almost any nonword/nondigit char.
648 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
650 Still, ambiguity is possible. So when in doubt, use {} to enclose
651 the sub/superscript. If you set this variable to the symbol `{}',
652 the braces are *required* in order to trigger interpretations as
654 frequently in plain text."
664 "Non-nil means create a table of contents in exported files.
666 The TOC contains headlines with levels up
667 to`org-export-headline-levels'. When an integer, include levels
668 up to N in the toc, this may then be different from
669 `org-export-headline-levels', but it will not be allowed to be
670 larger than the number of headline levels. When nil, no table of
671 contents is made.
673 This option can also be set with the OPTIONS keyword,
683 For example:
685 | Name | Address | Birthday |
686 |-------------+----------+-----------|
687 | Arthur Dent | England | 29.2.2100 |
689 This option can also be set with the OPTIONS keyword,
695 "If nil, do not export tags, just remove them from headlines.
697 If this is the symbol `not-in-toc', tags will be removed from
698 table of contents entries, but still be shown in the headlines of
699 the document.
701 This option can also be set with the OPTIONS keyword,
710 "Non-nil means include TODO items for export.
712 This may have the following values:
713 t include tasks independent of state.
714 `todo' include only tasks that are not yet done.
715 `done' include only tasks that are already done.
716 nil ignore all tasks.
717 list of keywords include tasks with these keywords.
719 This option can also be set with the OPTIONS keyword,
731 "Non-nil means insert a time stamp into the exported file.
732 The time stamp shows when the file was created. This option can
738 "Non nil means allow timestamps in export.
740 It can be set to any of the following values:
741 t export all timestamps.
742 `active' export active timestamps only.
743 `inactive' export inactive timestamps only.
744 nil do not export timestamps
746 This only applies to timestamps isolated in a paragraph
747 containing only timestamps. Other timestamps are always
748 exported.
750 This option can also be set with the OPTIONS keyword, e.g.
760 "Non-nil means include TODO keywords in export.
761 When nil, remove all these keywords from the export. This option
767 "Non-nil means BIND keywords can define local variable values.
768 This is a potential security risk, which is why the default value
769 is nil. You can also allow them through local buffer variables."
776 "Alist between export snippets back-ends and exporter back-ends.
778 This variable allows to provide shortcuts for export snippets.
782 HTML code while every other back-end will ignore it."
791 "Coding system for the exported file."
798 "Non-nil means pushing export output to the kill ring.
799 This variable is ignored during asynchronous export."
808 "The initial scope when exporting with `org-export-dispatch'.
809 This variable can be either set to `buffer' or `subtree'."
816 "Non-nil means show buffer after exporting to temp buffer.
817 When Org exports to a file, the buffer visiting that file is ever
818 shown, but remains buried. However, when exporting to
819 a temporary buffer, that buffer is popped up in a second window.
820 When this variable is nil, the buffer remains buried also in
821 these cases."
826 "Non-nil means export and publishing commands will run in background.
827 Results from an asynchronous export are never displayed
835 "File used to initialize external export process.
836 Value must be an absolute file name. It defaults to user's
837 initialization file. Though, a specific configuration makes the
838 process faster and the export more portable."
845 "Non-nil means using a non-intrusive `org-export-dispatch'.
846 In that case, no help buffer is displayed. Though, an indicator
852 asynchronous). Also, \[?] allows to switch back to standard
853 mode."
860 \f
861 ;;; Defining Back-ends
862 ;;
863 ;; An export back-end is a structure with `org-export-backend' type
864 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
865 ;; and `menu' slots.
866 ;;
867 ;; At the lowest level, a back-end is created with
868 ;; `org-export-create-backend' function.
869 ;;
870 ;; A named back-end can be registered with
871 ;; `org-export-register-backend' function. A registered back-end can
872 ;; later be referred to by its name, with `org-export-get-backend'
873 ;; function. Also, such a back-end can become the parent of a derived
874 ;; back-end from which slot values will be inherited by default.
875 ;; `org-export-derived-backend-p' can check if a given back-end is
876 ;; derived from a list of back-end names.
877 ;;
878 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
879 ;; `org-export-get-all-filters' return the full alist of transcoders,
880 ;; options and filters, including those inherited from ancestors.
881 ;;
882 ;; At a higher level, `org-export-define-backend' is the standard way
883 ;; to define an export back-end. If the new back-end is similar to
884 ;; a registered back-end, `org-export-define-derived-backend' may be
885 ;; used instead.
886 ;;
887 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
888 ;; when a given back-end hasn't been registered yet.
892 name parent transcoders options filters blocks menu)
895 "Return export back-end named after NAME.
896 NAME is a symbol. Return nil if no such back-end is found."
903 "Register BACKEND as a known export back-end.
904 BACKEND is a structure with `org-export-backend' type."
905 ;; Refuse to register an unnamed back-end.
908 ;; Refuse to register a back-end with an unknown parent.
912 ;; Register dedicated export blocks in the parser.
916 ;; If a back-end with the same name as BACKEND is already
917 ;; registered, replace it with BACKEND. Otherwise, simply add
918 ;; BACKEND to the list of registered back-ends.
924 "Signal an error if BACKEND isn't defined."
929 "Non-nil if BACKEND is derived from one of BACKENDS.
930 BACKEND is an export back-end, as returned by, e.g.,
931 `org-export-create-backend', or a symbol referring to
932 a registered back-end. BACKENDS is constituted of symbols."
944 "Return full translation table for BACKEND.
946 BACKEND is an export back-end, as return by, e.g,,
947 `org-export-create-backend'. Return value is an alist where
948 keys are element or object types, as symbols, and values are
949 transcoders.
951 Unlike to `org-export-backend-transcoders', this function
952 also returns transcoders inherited from parent back-ends,
953 if any."
957 parent)
962 transcoders)))
965 "Return export options for BACKEND.
967 BACKEND is an export back-end, as return by, e.g,,
968 `org-export-create-backend'. See `org-export-options-alist'
969 for the shape of the return value.
971 Unlike to `org-export-backend-options', this function also
972 returns options inherited from parent back-ends, if any."
976 parent)
980 options)))
983 "Return complete list of filters for BACKEND.
985 BACKEND is an export back-end, as return by, e.g,,
986 `org-export-create-backend'. Return value is an alist where
987 keys are symbols and values lists of functions.
989 Unlike to `org-export-backend-filters', this function also
990 returns filters inherited from parent back-ends, if any."
994 parent)
998 filters)))
1001 "Define a new back-end BACKEND.
1003 TRANSCODERS is an alist between object or element types and
1004 functions handling them.
1006 These functions should return a string without any trailing
1007 space, or nil. They must accept three arguments: the object or
1008 element itself, its contents or nil when it isn't recursive and
1009 the property list used as a communication channel.
1011 Contents, when not nil, are stripped from any global indentation
1012 \(although the relative one is preserved). They also always end
1013 with a single newline character.
1015 If, for a given type, no function is found, that element or
1016 object type will simply be ignored, along with any blank line or
1017 white space at its end. The same will happen if the function
1018 returns the nil value. If that function returns the empty
1019 string, the type will be ignored, but the blank lines or white
1020 spaces will be kept.
1022 In addition to element and object types, one function can be
1023 associated to the `template' (or `inner-template') symbol and
1024 another one to the `plain-text' symbol.
1026 The former returns the final transcoded string, and can be used
1027 to add a preamble and a postamble to document's body. It must
1028 accept two arguments: the transcoded string and the property list
1029 containing export options. A function associated to `template'
1031 A function associated to `inner-template' is always applied.
1033 The latter, when defined, is to be called on every text not
1034 recognized as an element or an object. It must accept two
1035 arguments: the text string and the information channel. It is an
1036 appropriate place to protect special chars relative to the
1037 back-end.
1039 BODY can start with pre-defined keyword arguments. The following
1040 keywords are understood:
1042 :export-block
1044 String, or list of strings, representing block names that
1045 will not be parsed. This is used to specify blocks that will
1046 contain raw code specific to the back-end. These blocks
1047 still have to be handled by the relative `export-block' type
1048 translator.
1050 :filters-alist
1052 Alist between filters and function, or list of functions,
1053 specific to the back-end. See `org-export-filters-alist' for
1054 a list of all allowed filters. Filters defined here
1055 shouldn't make a back-end test, as it may prevent back-ends
1056 derived from this one to behave properly.
1058 :menu-entry
1060 Menu entry for the export dispatcher. It should be a list
1061 like:
1063 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1065 where :
1067 KEY is a free character selecting the back-end.
1069 DESCRIPTION-OR-ORDINAL is either a string or a number.
1071 If it is a string, is will be used to name the back-end in
1072 its menu entry. If it is a number, the following menu will
1073 be displayed as a sub-menu of the back-end with the same
1074 KEY. Also, the number will be used to determine in which
1075 order such sub-menus will appear (lowest first).
1077 ACTION-OR-MENU is either a function or an alist.
1079 If it is an action, it will be called with four
1080 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1081 BODY-ONLY. See `org-export-as' for further explanations on
1082 some of them.
1084 If it is an alist, associations should follow the
1085 pattern:
1087 '(KEY DESCRIPTION ACTION)
1089 where KEY, DESCRIPTION and ACTION are described above.
1091 Valid values include:
1095 or
1100 \(lambda (a s v b)
1101 \(if a (org-latex-export-to-pdf t s v b)
1102 \(org-open-file
1103 \(org-latex-export-to-pdf nil s v b)))))))
1105 or the following, which will be added to the previous
1106 sub-menu,
1108 '(?l 1
1112 :options-alist
1114 Alist between back-end specific properties introduced in
1115 communication channel and how their value are acquired. See
1116 `org-export-options-alist' for more information about
1117 structure of the values."
1131 :transcoders transcoders
1132 :options options
1133 :filters filters
1134 :blocks blocks
1138 "Create a new back-end as a variant of an existing one.
1140 CHILD is the name of the derived back-end. PARENT is the name of
1141 the parent back-end.
1143 BODY can start with pre-defined keyword arguments. The following
1144 keywords are understood:
1146 :export-block
1148 String, or list of strings, representing block names that
1149 will not be parsed. This is used to specify blocks that will
1150 contain raw code specific to the back-end. These blocks
1151 still have to be handled by the relative `export-block' type
1152 translator.
1154 :filters-alist
1156 Alist of filters that will overwrite or complete filters
1157 defined in PARENT back-end. See `org-export-filters-alist'
1158 for a list of allowed filters.
1160 :menu-entry
1162 Menu entry for the export dispatcher. See
1163 `org-export-define-backend' for more information about the
1164 expected value.
1166 :options-alist
1168 Alist of back-end specific properties that will overwrite or
1169 complete those defined in PARENT back-end. Refer to
1170 `org-export-options-alist' for more information about
1171 structure of the values.
1173 :translate-alist
1175 Alist of element and object types and transcoders that will
1176 overwrite or complete transcode table from PARENT back-end.
1177 Refer to `org-export-define-backend' for detailed information
1178 about transcoders.
1181 as a variant of `latex' back-end with a custom template function:
1183 \(org-export-define-derived-backend 'my-latex 'latex
1184 :translate-alist '((template . my-latex-template-fun)))
1186 The back-end could then be called with, for example:
1203 :parent parent
1204 :transcoders transcoders
1205 :options options
1206 :filters filters
1207 :blocks blocks
1211 \f
1212 ;;; The Communication Channel
1213 ;;
1214 ;; During export process, every function has access to a number of
1215 ;; properties. They are of two types:
1216 ;;
1217 ;; 1. Environment options are collected once at the very beginning of
1218 ;; the process, out of the original buffer and configuration.
1219 ;; Collecting them is handled by `org-export-get-environment'
1220 ;; function.
1221 ;;
1222 ;; Most environment options are defined through the
1223 ;; `org-export-options-alist' variable.
1224 ;;
1225 ;; 2. Tree properties are extracted directly from the parsed tree,
1226 ;; just before export, by `org-export-collect-tree-properties'.
1227 ;;
1228 ;; Here is the full list of properties available during transcode
1229 ;; process, with their category and their value type.
1230 ;;
1231 ;; + `:author' :: Author's name.
1232 ;; - category :: option
1233 ;; - type :: string
1234 ;;
1235 ;; + `:back-end' :: Current back-end used for transcoding.
1236 ;; - category :: tree
1237 ;; - type :: symbol
1238 ;;
1239 ;; + `:creator' :: String to write as creation information.
1240 ;; - category :: option
1241 ;; - type :: string
1242 ;;
1243 ;; + `:date' :: String to use as date.
1244 ;; - category :: option
1245 ;; - type :: string
1246 ;;
1247 ;; + `:description' :: Description text for the current data.
1248 ;; - category :: option
1249 ;; - type :: string
1250 ;;
1251 ;; + `:email' :: Author's email.
1252 ;; - category :: option
1253 ;; - type :: string
1254 ;;
1255 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1256 ;; process.
1257 ;; - category :: option
1258 ;; - type :: list of strings
1259 ;;
1260 ;; + `:export-options' :: List of export options available for current
1261 ;; process.
1262 ;; - category :: none
1263 ;; - type :: list of symbols, among `subtree', `body-only' and
1264 ;; `visible-only'.
1265 ;;
1266 ;; + `:exported-data' :: Hash table used for memoizing
1267 ;; `org-export-data'.
1268 ;; - category :: tree
1269 ;; - type :: hash table
1270 ;;
1271 ;; + `:filetags' :: List of global tags for buffer. Used by
1272 ;; `org-export-get-tags' to get tags with inheritance.
1273 ;; - category :: option
1274 ;; - type :: list of strings
1275 ;;
1276 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1277 ;; their definition, as parsed data. Only non-inlined footnotes
1278 ;; are represented in this alist. Also, every definition isn't
1279 ;; guaranteed to be referenced in the parse tree. The purpose of
1280 ;; this property is to preserve definitions from oblivion
1281 ;; (i.e. when the parse tree comes from a part of the original
1282 ;; buffer), it isn't meant for direct use in a back-end. To
1283 ;; retrieve a definition relative to a reference, use
1284 ;; `org-export-get-footnote-definition' instead.
1285 ;; - category :: option
1286 ;; - type :: alist (STRING . LIST)
1287 ;;
1288 ;; + `:headline-levels' :: Maximum level being exported as an
1289 ;; headline. Comparison is done with the relative level of
1290 ;; headlines in the parse tree, not necessarily with their
1291 ;; actual level.
1292 ;; - category :: option
1293 ;; - type :: integer
1294 ;;
1295 ;; + `:headline-offset' :: Difference between relative and real level
1296 ;; of headlines in the parse tree. For example, a value of -1
1297 ;; means a level 2 headline should be considered as level
1298 ;; 1 (cf. `org-export-get-relative-level').
1299 ;; - category :: tree
1300 ;; - type :: integer
1301 ;;
1302 ;; + `:headline-numbering' :: Alist between headlines and their
1303 ;; numbering, as a list of numbers
1304 ;; (cf. `org-export-get-headline-number').
1305 ;; - category :: tree
1306 ;; - type :: alist (INTEGER . LIST)
1307 ;;
1308 ;; + `:id-alist' :: Alist between ID strings and destination file's
1309 ;; path, relative to current directory. It is used by
1310 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1311 ;; external file.
1312 ;; - category :: option
1313 ;; - type :: alist (STRING . STRING)
1314 ;;
1315 ;; + `:ignore-list' :: List of elements and objects that should be
1316 ;; ignored during export.
1317 ;; - category :: tree
1318 ;; - type :: list of elements and objects
1319 ;;
1320 ;; + `:input-file' :: Full path to input file, if any.
1321 ;; - category :: option
1322 ;; - type :: string or nil
1323 ;;
1324 ;; + `:keywords' :: List of keywords attached to data.
1325 ;; - category :: option
1326 ;; - type :: string
1327 ;;
1328 ;; + `:language' :: Default language used for translations.
1329 ;; - category :: option
1330 ;; - type :: string
1331 ;;
1332 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1333 ;; transcoding.
1334 ;; - category :: option
1335 ;; - type :: list (as returned by `org-element-parse-buffer')
1336 ;;
1337 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1338 ;; all line breaks.
1339 ;; - category :: option
1340 ;; - type :: symbol (nil, t)
1341 ;;
1342 ;; + `:section-numbers' :: Non-nil means transcoding should add
1343 ;; section numbers to headlines.
1344 ;; - category :: option
1345 ;; - type :: symbol (nil, t)
1346 ;;
1347 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1348 ;; in transcoding. When such a tag is present, subtrees without
1349 ;; it are de facto excluded from the process. See
1350 ;; `use-select-tags'.
1351 ;; - category :: option
1352 ;; - type :: list of strings
1353 ;;
1354 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1355 ;; a time stamp in the output.
1356 ;; - category :: option
1357 ;; - type :: symbol (nil, t)
1358 ;;
1359 ;; + `:translate-alist' :: Alist between element and object types and
1360 ;; transcoding functions relative to the current back-end.
1361 ;; Special keys `inner-template', `template' and `plain-text' are
1362 ;; also possible.
1363 ;; - category :: option
1364 ;; - type :: alist (SYMBOL . FUNCTION)
1365 ;;
1366 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1367 ;; also be transcoded. If it is set to the `headline' symbol,
1368 ;; only the archived headline's name is retained.
1369 ;; - category :: option
1370 ;; - type :: symbol (nil, t, `headline')
1371 ;;
1372 ;; + `:with-author' :: Non-nil means author's name should be included
1373 ;; in the output.
1374 ;; - category :: option
1375 ;; - type :: symbol (nil, t)
1376 ;;
1377 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1378 ;; - category :: option
1379 ;; - type :: symbol (nil, t)
1380 ;;
1381 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1382 ;; inserted at the end of the transcoded string. If the value
1383 ;; is `comment', it should be commented.
1384 ;; - category :: option
1385 ;; - type :: symbol (`comment', nil, t)
1386 ;;
1387 ;; + `:with-date' :: Non-nil means output should contain a date.
1388 ;; - category :: option
1389 ;; - type :. symbol (nil, t)
1390 ;;
1391 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1392 ;; its value is a list of names, only drawers with such names
1393 ;; will be transcoded. If that list starts with `not', drawer
1394 ;; with these names will be skipped.
1395 ;; - category :: option
1396 ;; - type :: symbol (nil, t) or list of strings
1397 ;;
1398 ;; + `:with-email' :: Non-nil means output should contain author's
1399 ;; email.
1400 ;; - category :: option
1401 ;; - type :: symbol (nil, t)
1402 ;;
1403 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1404 ;; interpreted.
1405 ;; - category :: option
1406 ;; - type :: symbol (nil, t)
1407 ;;
1408 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1409 ;; strings starting with a colon as a fixed-with (verbatim) area.
1410 ;; - category :: option
1411 ;; - type :: symbol (nil, t)
1412 ;;
1413 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1414 ;; footnotes.
1415 ;; - category :: option
1416 ;; - type :: symbol (nil, t)
1417 ;;
1418 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1419 ;; `latex-fragment' objects should appear in export output. When
1420 ;; this property is set to `verbatim', they will be left as-is.
1421 ;; - category :: option
1422 ;; - type :: symbol (`verbatim', nil, t)
1423 ;;
1424 ;; + `:with-planning' :: Non-nil means transcoding should include
1425 ;; planning info.
1426 ;; - category :: option
1427 ;; - type :: symbol (nil, t)
1428 ;;
1429 ;; + `:with-priority' :: Non-nil means transcoding should include
1430 ;; priority cookies.
1431 ;; - category :: option
1432 ;; - type :: symbol (nil, t)
1433 ;;
1434 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1435 ;; plain text.
1436 ;; - category :: option
1437 ;; - type :: symbol (nil, t)
1438 ;;
1439 ;; + `:with-special-strings' :: Non-nil means transcoding should
1440 ;; interpret special strings in plain text.
1441 ;; - category :: option
1442 ;; - type :: symbol (nil, t)
1443 ;;
1444 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1445 ;; interpret subscript and superscript. With a value of "{}",
1446 ;; only interpret those using curly brackets.
1447 ;; - category :: option
1448 ;; - type :: symbol (nil, {}, t)
1449 ;;
1450 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1451 ;; tables.
1452 ;; - category :: option
1453 ;; - type :: symbol (nil, t)
1454 ;;
1455 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1456 ;; headlines. A `not-in-toc' value will remove them from the
1457 ;; table of contents, if any, nonetheless.
1458 ;; - category :: option
1459 ;; - type :: symbol (nil, t, `not-in-toc')
1460 ;;
1461 ;; + `:with-tasks' :: Non-nil means transcoding should include
1462 ;; headlines with a TODO keyword. A `todo' value will only
1463 ;; include headlines with a todo type keyword while a `done'
1464 ;; value will do the contrary. If a list of strings is provided,
1465 ;; only tasks with keywords belonging to that list will be kept.
1466 ;; - category :: option
1467 ;; - type :: symbol (t, todo, done, nil) or list of strings
1468 ;;
1469 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1470 ;; time stamps. Special value `active' (resp. `inactive') ask to
1471 ;; export only active (resp. inactive) timestamps. Otherwise,
1472 ;; completely remove them.
1473 ;; - category :: option
1474 ;; - type :: symbol: (`active', `inactive', t, nil)
1475 ;;
1476 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1477 ;; added to the output. An integer value limits its depth.
1478 ;; - category :: option
1479 ;; - type :: symbol (nil, t or integer)
1480 ;;
1481 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1482 ;; include TODO keywords.
1483 ;; - category :: option
1484 ;; - type :: symbol (nil, t)
1487 ;;;; Environment Options
1488 ;;
1489 ;; Environment options encompass all parameters defined outside the
1490 ;; scope of the parsed data. They come from five sources, in
1491 ;; increasing precedence order:
1492 ;;
1493 ;; - Global variables,
1494 ;; - Buffer's attributes,
1495 ;; - Options keyword symbols,
1496 ;; - Buffer keywords,
1497 ;; - Subtree properties.
1498 ;;
1499 ;; The central internal function with regards to environment options
1500 ;; is `org-export-get-environment'. It updates global variables with
1501 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1502 ;; the different sources.
1503 ;;
1504 ;; The internal functions doing the retrieval are:
1505 ;; `org-export--get-global-options',
1506 ;; `org-export--get-buffer-attributes',
1507 ;; `org-export--parse-option-keyword',
1508 ;; `org-export--get-subtree-options' and
1509 ;; `org-export--get-inbuffer-options'
1510 ;;
1511 ;; Also, `org-export--list-bound-variables' collects bound variables
1512 ;; along with their value in order to set them as buffer local
1513 ;; variables later in the process.
1516 "Collect export options from the current buffer.
1518 Optional argument BACKEND is an export back-end, as returned by
1519 `org-export-create-backend'.
1521 When optional argument SUBTREEP is non-nil, assume the export is
1522 done against the current sub-tree.
1524 Third optional argument EXT-PLIST is a property list with
1525 external parameters overriding Org default settings, but still
1526 inferior to file-local settings."
1527 ;; First install #+BIND variables since these must be set before
1528 ;; global options are read.
1531 ;; Get and prioritize export options...
1533 ;; ... from global variables...
1535 ;; ... from an external property list...
1536 ext-plist
1537 ;; ... from in-buffer settings...
1539 ;; ... and from subtree, when appropriate.
1541 ;; Eventually add misc. properties.
1543 :back-end
1544 backend
1546 :footnote-definition-alist
1547 ;; Footnotes definitions must be collected in the original
1548 ;; buffer, as there's no insurance that they will still be in
1549 ;; the parse tree, due to possible narrowing.
1563 alist))))
1564 alist))
1565 :id-alist
1566 ;; Collect id references.
1577 alist))))
1580 "Parse an OPTIONS line and return values as a plist.
1581 Optional argument BACKEND is an export back-end, as returned by,
1582 e.g., `org-export-create-backend'. It specifies which back-end
1583 specific items to read, if any."
1585 ;; Priority is given to back-end specific options.
1587 org-export-options-alist))
1588 plist)
1597 options))
1599 property
1602 plist))
1605 "Get export options in subtree at point.
1606 Optional argument BACKEND is an export back-end, as returned by,
1607 e.g., `org-export-create-backend'. It specifies back-end used
1608 for export. Return options as a plist."
1609 ;; For each buffer keyword, create a headline property setting the
1610 ;; same property in communication channel. The name for the property
1611 ;; is the keyword with "EXPORT_" appended to it.
1614 ;; Make sure point is at a heading.
1616 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1617 ;; title (with no todo keyword, priority cookie or tag) as its
1618 ;; fallback value.
1624 plist :title
1627 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1631 ;; Handle other keywords. TITLE keyword is excluded as it has
1632 ;; been handled already.
1640 ;; Export properties are not case-sensitive.
1647 plist
1648 property
1650 ;; Parse VALUE if required.
1654 ;; If BEHAVIOR is `split' expected value is
1655 ;; a list of strings, not a string.
1658 ;; Look for both general keywords and back-end specific
1659 ;; options, with priority given to the latter.
1661 org-export-options-alist)))
1662 ;; Return value.
1663 plist)))
1666 "Return current buffer export options, as a plist.
1668 Optional argument BACKEND, when non-nil, is an export back-end,
1669 as returned by, e.g., `org-export-create-backend'. It specifies
1670 which back-end specific options should also be read in the
1671 process.
1673 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1675 get-options ; For byte-compiler.
1678 ;; Priority is given to back-end specific options.
1680 org-export-options-alist))
1683 org-export-special-keywords))))
1686 ;; Return all properties associated to KEYWORD.
1693 ;; Recursively read keywords in buffer. FILES is a list
1694 ;; of files read so far. PLIST is the current property
1695 ;; list obtained.
1704 ;; Options in `org-export-special-keywords'.
1708 ;; Avoid circular dependencies.
1718 plist
1723 plist
1729 ;; Options in `org-export-options-alist'.
1734 plist property
1735 ;; Handle value depending on specified
1736 ;; BEHAVIOR.
1742 " "
1755 ;; Return final value.
1756 plist))))
1757 ;; Read options in the current buffer.
1760 ;; Parse keywords specified in `org-element-document-properties'
1761 ;; and return PLIST.
1772 "Return properties related to buffer attributes, as a plist."
1773 ;; Store full path of input file name, or nil. For internal use.
1781 "Return global export options as a plist.
1782 Optional argument BACKEND, if non-nil, is an export back-end, as
1783 returned by, e.g., `org-export-create-backend'. It specifies
1784 which back-end specific export options should also be read in the
1785 process."
1787 ;; Priority is given to back-end specific options.
1789 org-export-options-alist)))
1796 plist
1797 prop
1798 ;; Eval default value provided. If keyword is
1799 ;; a member of `org-element-document-properties',
1800 ;; parse it as a secondary string before storing it.
1807 value)))))))))))
1810 "Return variables bound from BIND keywords in current buffer.
1811 Also look for BIND keywords in setup files. The return value is
1812 an alist where associations are (VARIABLE-NAME VALUE)."
1817 ;; Return an alist between variable names and their
1818 ;; value. FILES is a list of setup files names read so
1819 ;; far, used to avoid circular dependencies. ALIST is
1820 ;; the alist collected so far.
1831 ;; Enter setup file.
1841 alist))))))))))
1842 alist)))))
1843 ;; Return value in appropriate order of appearance.
1847 ;;;; Tree Properties
1848 ;;
1849 ;; Tree properties are information extracted from parse tree. They
1850 ;; are initialized at the beginning of the transcoding process by
1851 ;; `org-export-collect-tree-properties'.
1852 ;;
1853 ;; Dedicated functions focus on computing the value of specific tree
1854 ;; properties during initialization. Thus,
1855 ;; `org-export--populate-ignore-list' lists elements and objects that
1856 ;; should be skipped during export, `org-export--get-min-level' gets
1857 ;; the minimal exportable level, used as a basis to compute relative
1858 ;; level for headlines. Eventually
1859 ;; `org-export--collect-headline-numbering' builds an alist between
1860 ;; headlines and their numbering.
1863 "Extract tree properties from parse tree.
1865 DATA is the parse tree from which information is retrieved. INFO
1866 is a list holding export options.
1868 Following tree properties are set or updated:
1870 `:exported-data' Hash table used to memoize results from
1871 `org-export-data'.
1873 `:footnote-definition-alist' List of footnotes definitions in
1874 original buffer and current parse tree.
1876 `:headline-offset' Offset between true level of headlines and
1877 local level. An offset of -1 means a headline
1878 of level 2 should be considered as a level
1879 1 headline in the context.
1881 `:headline-numbering' Alist of all headlines as key an the
1882 associated numbering as value.
1884 `:ignore-list' List of elements that should be ignored during
1885 export.
1887 Return updated plist."
1888 ;; Install the parse tree in the communication channel, in order to
1889 ;; use `org-export-get-genealogy' and al.
1891 ;; Get the list of elements and objects to ignore, and put it into
1892 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1893 ;; been done during parse tree filtering.
1896 :ignore-list
1899 ;; Compute `:headline-offset' in order to be able to use
1900 ;; `org-export-get-relative-level'.
1903 :headline-offset
1905 ;; Update footnotes definitions list with definitions in parse tree.
1906 ;; This is required since buffer expansion might have modified
1907 ;; boundaries of footnote definitions contained in the parse tree.
1908 ;; This way, definitions in `footnote-definition-alist' are bound to
1909 ;; match those in the parse tree.
1915 defs)))
1917 ;; Properties order doesn't matter: get the rest of the tree
1918 ;; properties.
1922 info))
1925 "Return minimum exportable headline's level in DATA.
1926 DATA is parsed tree as returned by `org-element-parse-buffer'.
1927 OPTIONS is a plist holding export options."
1938 ;; If no headline was found, for the sake of consistency, set
1939 ;; minimum level to 1 nonetheless.
1943 "Return numbering of all exportable headlines in a parse tree.
1945 DATA is the parse tree. OPTIONS is the plist holding export
1946 options.
1948 Return an alist whose key is a headline and value is its
1949 associated numbering \(in the shape of a list of numbers\) or nil
1950 for a footnotes section."
1958 headline
1960 for idx from 0 to org-export-max-depth
1964 options)))
1967 "Return list of elements and objects to ignore during export.
1968 DATA is the parse tree to traverse. OPTIONS is the plist holding
1969 export options."
1971 walk-data
1972 ;; First find trees containing a select tag, if any.
1976 ;; Collect ignored elements or objects into IGNORE-LIST.
1982 ;; If headline is archived but tree below has
1983 ;; to be skipped, add it to ignore list.
1986 ;; Move into secondary string, if any.
1991 ;; Move into recursive objects/elements.
1993 ;; Main call.
1995 ;; Return value.
1996 ignore))
1999 "Return list of headlines and inlinetasks with a select tag in their tree.
2000 DATA is parsed data as returned by `org-element-parse-buffer'.
2001 INFO is a plist holding export options."
2003 walk-data ; For byte-compiler.
2013 ;; When a select tag is found, mark full
2014 ;; genealogy and every headline within the tree
2015 ;; as acceptable.
2018 genealogy
2021 selected-trees))
2022 ;; If at a headline, continue searching in tree,
2023 ;; recursively.
2033 selected-trees))
2036 "Non-nil when element or object BLOB should be skipped during export.
2037 OPTIONS is the plist holding export options. SELECTED, when
2038 non-nil, is a list of headlines or inlinetasks belonging to
2039 a tree with a select tag."
2046 ;; If `:with-drawers' value starts with `not', ignore
2047 ;; every drawer whose name belong to that list.
2048 ;; Otherwise, ignore drawers whose name isn't in that
2049 ;; list.
2065 ;; Ignore subtrees with an exclude tag.
2068 ;; When a select tag is present in the buffer, ignore any tree
2069 ;; without it.
2071 ;; Ignore commented sub-trees.
2073 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2075 ;; Ignore tasks, if specified by `:with-tasks' property.
2090 ;; `:with-timestamps' only applies to isolated timestamps
2091 ;; objects, i.e. timestamp objects in a paragraph containing only
2092 ;; timestamps and whitespaces.
2100 options t))))
2109 \f
2110 ;;; The Transcoder
2111 ;;
2112 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2113 ;; `org-element-parse-buffer') and transcodes it into a specified
2114 ;; back-end output. It takes care of filtering out elements or
2115 ;; objects according to export options and organizing the output blank
2116 ;; lines and white space are preserved. The function memoizes its
2117 ;; results, so it is cheap to call it within transcoders.
2118 ;;
2119 ;; It is possible to modify locally the back-end used by
2120 ;; `org-export-data' or even use a temporary back-end by using
2121 ;; `org-export-data-with-backend'.
2122 ;;
2123 ;; Internally, three functions handle the filtering of objects and
2124 ;; elements during the export. In particular,
2125 ;; `org-export-ignore-element' marks an element or object so future
2126 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2127 ;; elements or objects should be seen as real Org syntax and
2128 ;; `org-export-expand' transforms the others back into their original
2129 ;; shape
2130 ;;
2131 ;; `org-export-transcoder' is an accessor returning appropriate
2132 ;; translator function for a given element or object.
2135 "Return appropriate transcoder for BLOB.
2136 INFO is a plist containing export directives."
2138 ;; Return contents only for complete parse trees.
2144 "Convert DATA into current back-end format.
2146 DATA is a parse tree, an element or an object or a secondary
2147 string. INFO is a plist holding export options.
2149 Return transcoded string."
2155 ;; Ignored element/object.
2157 ;; Plain text.
2163 info))
2164 ;; Uninterpreted element/object: change it back to Org
2165 ;; syntax and export again resulting raw string.
2169 data
2173 info))
2174 ;; Secondary string.
2177 ;; Element/Object without contents or, as a special case,
2178 ;; headline with archive tag and archived trees restricted
2179 ;; to title only.
2187 ;; Export snippets never return a nil value so
2188 ;; that white spaces following them are never
2189 ;; ignored.
2191 ;; Element/Object with contents.
2204 ;; Elements directly containing objects
2205 ;; must have their indentation normalized
2206 ;; first.
2208 data
2209 ;; When normalizing contents of the first
2210 ;; paragraph in an item or a footnote
2211 ;; definition, ignore first line's
2212 ;; indentation: there is none and it
2213 ;; might be misleading.
2218 data)
2225 info))))))))
2226 ;; Final result will be memoized before being returned.
2228 data
2232 ;; Append the same white space between elements or objects as in
2233 ;; the original buffer, and call appropriate filters.
2244 info)))
2245 results)))
2249 "Convert DATA into BACKEND format.
2251 DATA is an element, an object, a secondary string or a string.
2252 BACKEND is a symbol. INFO is a plist used as a communication
2253 channel.
2255 Unlike to `org-export-with-backend', this function will
2256 recursively convert DATA using BACKEND translation table."
2259 data
2260 ;; Set-up a new communication channel with translations defined in
2261 ;; BACKEND as the translate table and a new hash table for
2262 ;; memoization.
2264 info
2267 ;; Size of the hash table is reduced since this function
2268 ;; will probably be used on small trees.
2272 "Non-nil if element or object BLOB should be interpreted during export.
2273 If nil, BLOB will appear as raw Org syntax. Check is done
2274 according to export options INFO, stored as a plist."
2276 ;; ... entities...
2278 ;; ... emphasis...
2281 ;; ... fixed-width areas.
2283 ;; ... LaTeX environments and fragments...
2287 ;; ... sub/superscripts...
2293 ;; ... tables...
2298 "Expand a parsed element or object to its original state.
2300 BLOB is either an element or an object. CONTENTS is its
2301 contents, as a string or nil.
2303 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2304 keywords before output."
2309 blob contents))))
2312 "Add ELEMENT to `:ignore-list' in INFO.
2314 Any element in `:ignore-list' will be skipped when using
2315 `org-element-map'. INFO is modified by side effects."
2319 \f
2320 ;;; The Filter System
2321 ;;
2322 ;; Filters allow end-users to tweak easily the transcoded output.
2323 ;; They are the functional counterpart of hooks, as every filter in
2324 ;; a set is applied to the return value of the previous one.
2325 ;;
2326 ;; Every set is back-end agnostic. Although, a filter is always
2327 ;; called, in addition to the string it applies to, with the back-end
2328 ;; used as argument, so it's easy for the end-user to add back-end
2329 ;; specific filters in the set. The communication channel, as
2330 ;; a plist, is required as the third argument.
2331 ;;
2332 ;; From the developer side, filters sets can be installed in the
2333 ;; process with the help of `org-export-define-backend', which
2334 ;; internally stores filters as an alist. Each association has a key
2335 ;; among the following symbols and a function or a list of functions
2336 ;; as value.
2337 ;;
2338 ;; - `:filter-options' applies to the property list containing export
2339 ;; options. Unlike to other filters, functions in this list accept
2340 ;; two arguments instead of three: the property list containing
2341 ;; export options and the back-end. Users can set its value through
2342 ;; `org-export-filter-options-functions' variable.
2343 ;;
2344 ;; - `:filter-parse-tree' applies directly to the complete parsed
2345 ;; tree. Users can set it through
2346 ;; `org-export-filter-parse-tree-functions' variable.
2347 ;;
2348 ;; - `:filter-final-output' applies to the final transcoded string.
2349 ;; Users can set it with `org-export-filter-final-output-functions'
2350 ;; variable
2351 ;;
2352 ;; - `:filter-plain-text' applies to any string not recognized as Org
2353 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2354 ;; configure it.
2355 ;;
2356 ;; - `:filter-TYPE' applies on the string returned after an element or
2357 ;; object of type TYPE has been transcoded. A user can modify
2358 ;; `org-export-filter-TYPE-functions'
2359 ;;
2360 ;; All filters sets are applied with
2361 ;; `org-export-filter-apply-functions' function. Filters in a set are
2362 ;; applied in a LIFO fashion. It allows developers to be sure that
2363 ;; their filters will be applied first.
2364 ;;
2365 ;; Filters properties are installed in communication channel with
2366 ;; `org-export-install-filters' function.
2367 ;;
2368 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2369 ;; `org-export-before-parsing-hook') are run at the beginning of the
2370 ;; export process and just before parsing to allow for heavy structure
2371 ;; modifications.
2374 ;;;; Hooks
2377 "Hook run at the beginning of the export process.
2379 This is run before include keywords and macros are expanded and
2380 Babel code blocks executed, on a copy of the original buffer
2381 being exported. Visibility and narrowing are preserved. Point
2382 is at the beginning of the buffer.
2384 Every function in this hook will be called with one argument: the
2388 "Hook run before parsing an export buffer.
2390 This is run after include keywords and macros have been expanded
2391 and Babel code blocks executed, on a copy of the original buffer
2392 being exported. Visibility and narrowing are preserved. Point
2393 is at the beginning of the buffer.
2395 Every function in this hook will be called with one argument: the
2399 ;;;; Special Filters
2402 "List of functions applied to the export options.
2403 Each filter is called with two arguments: the export options, as
2404 a plist, and the back-end, as a symbol. It must return
2408 "List of functions applied to the parsed tree.
2409 Each filter is called with three arguments: the parse tree, as
2410 returned by `org-element-parse-buffer', the back-end, as
2411 a symbol, and the communication channel, as a plist. It must
2415 "List of functions applied to plain text.
2416 Each filter is called with three arguments: a string which
2417 contains no Org syntax, the back-end, as a symbol, and the
2418 communication channel, as a plist. It must return a string or
2422 "List of functions applied to the transcoded string.
2423 Each filter is called with three arguments: the full transcoded
2424 string, the back-end, as a symbol, and the communication channel,
2425 as a plist. It must return a string that will be used as the
2429 ;;;; Elements Filters
2432 "List of functions applied to a transcoded babel-call.
2433 Each filter is called with three arguments: the transcoded data,
2434 as a string, the back-end, as a symbol, and the communication
2438 "List of functions applied to a transcoded center block.
2439 Each filter is called with three arguments: the transcoded data,
2440 as a string, the back-end, as a symbol, and the communication
2444 "List of functions applied to a transcoded clock.
2445 Each filter is called with three arguments: the transcoded data,
2446 as a string, the back-end, as a symbol, and the communication
2450 "List of functions applied to a transcoded comment.
2451 Each filter is called with three arguments: the transcoded data,
2452 as a string, the back-end, as a symbol, and the communication
2456 "List of functions applied to a transcoded comment-block.
2457 Each filter is called with three arguments: the transcoded data,
2458 as a string, the back-end, as a symbol, and the communication
2462 "List of functions applied to a transcoded diary-sexp.
2463 Each filter is called with three arguments: the transcoded data,
2464 as a string, the back-end, as a symbol, and the communication
2468 "List of functions applied to a transcoded drawer.
2469 Each filter is called with three arguments: the transcoded data,
2470 as a string, the back-end, as a symbol, and the communication
2474 "List of functions applied to a transcoded dynamic-block.
2475 Each filter is called with three arguments: the transcoded data,
2476 as a string, the back-end, as a symbol, and the communication
2480 "List of functions applied to a transcoded example-block.
2481 Each filter is called with three arguments: the transcoded data,
2482 as a string, the back-end, as a symbol, and the communication
2486 "List of functions applied to a transcoded export-block.
2487 Each filter is called with three arguments: the transcoded data,
2488 as a string, the back-end, as a symbol, and the communication
2492 "List of functions applied to a transcoded fixed-width.
2493 Each filter is called with three arguments: the transcoded data,
2494 as a string, the back-end, as a symbol, and the communication
2498 "List of functions applied to a transcoded footnote-definition.
2499 Each filter is called with three arguments: the transcoded data,
2500 as a string, the back-end, as a symbol, and the communication
2504 "List of functions applied to a transcoded headline.
2505 Each filter is called with three arguments: the transcoded data,
2506 as a string, the back-end, as a symbol, and the communication
2510 "List of functions applied to a transcoded horizontal-rule.
2511 Each filter is called with three arguments: the transcoded data,
2512 as a string, the back-end, as a symbol, and the communication
2516 "List of functions applied to a transcoded inlinetask.
2517 Each filter is called with three arguments: the transcoded data,
2518 as a string, the back-end, as a symbol, and the communication
2522 "List of functions applied to a transcoded item.
2523 Each filter is called with three arguments: the transcoded data,
2524 as a string, the back-end, as a symbol, and the communication
2528 "List of functions applied to a transcoded keyword.
2529 Each filter is called with three arguments: the transcoded data,
2530 as a string, the back-end, as a symbol, and the communication
2534 "List of functions applied to a transcoded latex-environment.
2535 Each filter is called with three arguments: the transcoded data,
2536 as a string, the back-end, as a symbol, and the communication
2540 "List of functions applied to a transcoded node-property.
2541 Each filter is called with three arguments: the transcoded data,
2542 as a string, the back-end, as a symbol, and the communication
2546 "List of functions applied to a transcoded paragraph.
2547 Each filter is called with three arguments: the transcoded data,
2548 as a string, the back-end, as a symbol, and the communication
2552 "List of functions applied to a transcoded plain-list.
2553 Each filter is called with three arguments: the transcoded data,
2554 as a string, the back-end, as a symbol, and the communication
2558 "List of functions applied to a transcoded planning.
2559 Each filter is called with three arguments: the transcoded data,
2560 as a string, the back-end, as a symbol, and the communication
2564 "List of functions applied to a transcoded property-drawer.
2565 Each filter is called with three arguments: the transcoded data,
2566 as a string, the back-end, as a symbol, and the communication
2570 "List of functions applied to a transcoded quote block.
2571 Each filter is called with three arguments: the transcoded quote
2572 data, as a string, the back-end, as a symbol, and the
2573 communication channel, as a plist. It must return a string or
2577 "List of functions applied to a transcoded quote-section.
2578 Each filter is called with three arguments: the transcoded data,
2579 as a string, the back-end, as a symbol, and the communication
2583 "List of functions applied to a transcoded section.
2584 Each filter is called with three arguments: the transcoded data,
2585 as a string, the back-end, as a symbol, and the communication
2589 "List of functions applied to a transcoded special block.
2590 Each filter is called with three arguments: the transcoded data,
2591 as a string, the back-end, as a symbol, and the communication
2595 "List of functions applied to a transcoded src-block.
2596 Each filter is called with three arguments: the transcoded data,
2597 as a string, the back-end, as a symbol, and the communication
2601 "List of functions applied to a transcoded table.
2602 Each filter is called with three arguments: the transcoded data,
2603 as a string, the back-end, as a symbol, and the communication
2607 "List of functions applied to a transcoded table-cell.
2608 Each filter is called with three arguments: the transcoded data,
2609 as a string, the back-end, as a symbol, and the communication
2613 "List of functions applied to a transcoded table-row.
2614 Each filter is called with three arguments: the transcoded data,
2615 as a string, the back-end, as a symbol, and the communication
2619 "List of functions applied to a transcoded verse block.
2620 Each filter is called with three arguments: the transcoded data,
2621 as a string, the back-end, as a symbol, and the communication
2625 ;;;; Objects Filters
2628 "List of functions applied to transcoded bold text.
2629 Each filter is called with three arguments: the transcoded data,
2630 as a string, the back-end, as a symbol, and the communication
2634 "List of functions applied to transcoded code text.
2635 Each filter is called with three arguments: the transcoded data,
2636 as a string, the back-end, as a symbol, and the communication
2640 "List of functions applied to a transcoded entity.
2641 Each filter is called with three arguments: the transcoded data,
2642 as a string, the back-end, as a symbol, and the communication
2646 "List of functions applied to a transcoded export-snippet.
2647 Each filter is called with three arguments: the transcoded data,
2648 as a string, the back-end, as a symbol, and the communication
2652 "List of functions applied to a transcoded footnote-reference.
2653 Each filter is called with three arguments: the transcoded data,
2654 as a string, the back-end, as a symbol, and the communication
2658 "List of functions applied to a transcoded inline-babel-call.
2659 Each filter is called with three arguments: the transcoded data,
2660 as a string, the back-end, as a symbol, and the communication
2664 "List of functions applied to a transcoded inline-src-block.
2665 Each filter is called with three arguments: the transcoded data,
2666 as a string, the back-end, as a symbol, and the communication
2670 "List of functions applied to transcoded italic text.
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 latex-fragment.
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 line-break.
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 link.
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 radio-target.
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 statistics-cookie.
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 transcoded strike-through text.
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 "List of functions applied to a transcoded subscript.
2713 Each filter is called with three arguments: the transcoded data,
2714 as a string, the back-end, as a symbol, and the communication
2718 "List of functions applied to a transcoded superscript.
2719 Each filter is called with three arguments: the transcoded data,
2720 as a string, the back-end, as a symbol, and the communication
2724 "List of functions applied to a transcoded target.
2725 Each filter is called with three arguments: the transcoded data,
2726 as a string, the back-end, as a symbol, and the communication
2730 "List of functions applied to a transcoded timestamp.
2731 Each filter is called with three arguments: the transcoded data,
2732 as a string, the back-end, as a symbol, and the communication
2736 "List of functions applied to transcoded underline text.
2737 Each filter is called with three arguments: the transcoded data,
2738 as a string, the back-end, as a symbol, and the communication
2742 "List of functions applied to transcoded verbatim text.
2743 Each filter is called with three arguments: the transcoded data,
2744 as a string, the back-end, as a symbol, and the communication
2748 ;;;; Filters Tools
2749 ;;
2750 ;; Internal function `org-export-install-filters' installs filters
2751 ;; hard-coded in back-ends (developer filters) and filters from global
2752 ;; variables (user filters) in the communication channel.
2753 ;;
2754 ;; Internal function `org-export-filter-apply-functions' takes care
2755 ;; about applying each filter in order to a given data. It ignores
2756 ;; filters returning a nil value but stops whenever a filter returns
2757 ;; an empty string.
2760 "Call every function in FILTERS.
2762 Functions are called with arguments VALUE, current export
2763 back-end's name and INFO. A function returning a nil value will
2764 be skipped. If it returns the empty string, the process ends and
2765 VALUE is ignored.
2767 Call is done in a LIFO fashion, to be sure that developer
2768 specified filters, if any, are called first."
2779 "Install filters properties in communication channel.
2780 INFO is a plist containing the current communication channel.
2781 Return the updated communication channel."
2783 ;; Install user-defined filters with `org-export-filters-alist'
2784 ;; and filters already in INFO (through ext-plist mechanism).
2791 ;; Filters in INFO will be called
2792 ;; before those user provided.
2795 default-value)))))
2796 org-export-filters-alist)
2797 ;; Prepend back-end specific filters to that list.
2799 ;; Single values get consed, lists are appended.
2804 plist key
2808 ;; Return new communication channel.
2812 \f
2813 ;;; Core functions
2814 ;;
2815 ;; This is the room for the main function, `org-export-as', along with
2816 ;; its derivative, `org-export-string-as'.
2817 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2818 ;; function should be added to kill ring.
2819 ;;
2820 ;; Note that `org-export-as' doesn't really parse the current buffer,
2821 ;; but a copy of it (with the same buffer-local variables and
2822 ;; visibility), where macros and include keywords are expanded and
2823 ;; Babel blocks are executed, if appropriate.
2824 ;; `org-export-with-buffer-copy' macro prepares that copy.
2825 ;;
2826 ;; File inclusion is taken care of by
2827 ;; `org-export-expand-include-keyword' and
2828 ;; `org-export--prepare-file-contents'. Structure wise, including
2829 ;; a whole Org file in a buffer often makes little sense. For
2830 ;; example, if the file contains a headline and the include keyword
2831 ;; was within an item, the item should contain the headline. That's
2832 ;; why file inclusion should be done before any structure can be
2833 ;; associated to the file, that is before parsing.
2834 ;;
2835 ;; `org-export-insert-default-template' is a command to insert
2836 ;; a default template (or a back-end specific template) at point or in
2837 ;; current subtree.
2840 "Return a copy of the current buffer.
2841 The copy preserves Org buffer-local variables, visibility and
2842 narrowing."
2848 new-buf))
2851 "Apply BODY in a copy of the current buffer.
2852 The copy preserves local variables, visibility and contents of
2853 the original buffer. Point is at the beginning of the buffer
2854 when BODY is applied."
2863 ;; Kill copy without confirmation.
2869 "Generate a function duplicating BUFFER.
2871 The copy will preserve local variables, visibility, contents and
2872 narrowing of the original buffer. If a region was active in
2873 BUFFER, contents will be narrowed to that region instead.
2875 The resulting function can be evaluated at a later time, from
2876 another buffer, effectively cloning the original buffer there.
2878 The function assumes BUFFER's major mode is `org-mode'."
2882 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2883 ;; already in BUFFER.
2885 ;; Copy specific buffer local variables and variables set
2886 ;; through BIND keywords.
2888 vars)
2896 buffer-file-name
2897 buffer-file-coding-system))
2901 ;; Skip unreadable values, as they cannot be
2902 ;; sent to external process.
2906 vars))))))
2907 ;; Whole buffer contents.
2912 ;; Narrowing.
2916 ;; Current position of point.
2918 ;; Overlays with invisible property.
2928 ov-set))))
2930 ov-set)))))
2932 ;;;###autoload
2935 "Transcode current Org buffer into BACKEND code.
2937 BACKEND is either an export back-end, as returned by, e.g.,
2938 `org-export-create-backend', or a symbol referring to
2939 a registered back-end.
2941 If narrowing is active in the current buffer, only transcode its
2942 narrowed part.
2944 If a region is active, transcode that region.
2946 When optional argument SUBTREEP is non-nil, transcode the
2947 sub-tree at point, extracting information from the headline
2948 properties first.
2950 When optional argument VISIBLE-ONLY is non-nil, don't export
2951 contents of hidden elements.
2953 When optional argument BODY-ONLY is non-nil, only return body
2954 code, without surrounding template.
2956 Optional argument EXT-PLIST, when provided, is a property list
2957 with external parameters overriding Org default settings, but
2958 still inferior to file-local settings.
2960 Return code as a string."
2965 ;; Narrow buffer to an appropriate region or subtree for
2966 ;; parsing. If parsing subtree, be sure to remove main headline
2967 ;; too.
2975 ;; Initialize communication channel with original buffer
2976 ;; attributes, unavailable in its copy.
2985 tree)
2986 ;; Update communication channel and get parse tree. Buffer
2987 ;; isn't parsed directly. Instead, a temporary copy is
2988 ;; created, where include keywords, macros are expanded and
2989 ;; code blocks are evaluated.
2991 ;; Run first hook with current back-end's name as argument.
2995 ;; Update macro templates since #+INCLUDE keywords might have
2996 ;; added some new ones.
3000 ;; Update radio targets since keyword inclusion might have
3001 ;; added some more.
3003 ;; Run last hook with current back-end's name as argument.
3008 ;; Update communication channel with environment. Also
3009 ;; install user's and developer's filters.
3014 ;; Expand export-specific set of macros: {{{author}}},
3015 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3016 ;; once regular macros have been expanded, since document
3017 ;; keywords may contain one of them.
3023 ;; EMAIL is not a parsed keyword: store it as-is.
3027 ;; Call options filters and update export options. We do not
3028 ;; use `org-export-filter-apply-functions' here since the
3029 ;; arity of such filters is different.
3034 ;; Parse buffer and call parse-tree filter on it.
3039 ;; Now tree is complete, compute its properties and add them
3040 ;; to communication channel.
3044 ;; Eventually transcode TREE. Wrap the resulting string into
3045 ;; a template.
3054 ;; Remove all text properties since they cannot be
3055 ;; retrieved from an external process. Finally call
3056 ;; final-output filter and return result.
3062 info))))))))
3064 ;;;###autoload
3066 "Transcode STRING into BACKEND code.
3068 BACKEND is either an export back-end, as returned by, e.g.,
3069 `org-export-create-backend', or a symbol referring to
3070 a registered back-end.
3072 When optional argument BODY-ONLY is non-nil, only return body
3073 code, without preamble nor postamble.
3075 Optional argument EXT-PLIST, when provided, is a property list
3076 with external parameters overriding Org default settings, but
3077 still inferior to file-local settings.
3079 Return code as a string."
3085 ;;;###autoload
3087 "Replace the active region by its export to BACKEND.
3088 BACKEND is either an export back-end, as returned by, e.g.,
3089 `org-export-create-backend', or a symbol referring to
3090 a registered back-end."
3100 ;;;###autoload
3102 "Insert all export keywords with default values at beginning of line.
3104 BACKEND is a symbol referring to the name of a registered export
3105 back-end, for which specific export options should be added to
3106 the template, or `default' for default template. When it is nil,
3107 the user will be prompted for a category.
3109 If SUBTREEP is non-nil, export configuration will be set up
3110 locally for the subtree through node properties."
3120 "Options category: "
3124 org-export--registered-backends))))))
3125 options keywords)
3126 ;; Populate OPTIONS and KEYWORDS.
3143 ;; Move to an appropriate location in order to insert options.
3145 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3146 ;; list of available keywords.
3174 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3192 ;; And the rest of keywords.
3203 "Expand every include keyword in buffer.
3204 Optional argument INCLUDED is a list of included file names along
3205 with their line restriction, when appropriate. It is used to
3206 avoid infinite recursion. Optional argument DIR is the current
3207 working directory. It is used to properly resolve relative
3208 paths."
3215 ;; Extract arguments from keyword's value.
3223 dir)
3228 value)
3234 ;; Minimal level of included file defaults to the child
3235 ;; level of the current headline, if any, or one. It
3236 ;; only applies is the file is meant to be included as
3237 ;; an Org one.
3245 ;; Remove keyword.
3251 ;; Check if files has already been parsed. Look after
3252 ;; inclusion lines too, as different parts of the same file
3253 ;; can be included too.
3265 ind-str contents ind-str))))
3273 ind-str env contents ind-str))))
3286 "Prepare the contents of FILE for inclusion and return them as a string.
3288 When optional argument LINES is a string specifying a range of
3289 lines, include only those lines.
3291 Optional argument IND, when non-nil, is an integer specifying the
3292 global indentation of returned contents. Since its purpose is to
3293 allow an included file to stay in the same environment it was
3294 created \(i.e. a list item), it doesn't apply past the first
3295 headline encountered.
3297 Optional argument MINLEVEL, when non-nil, is an integer
3298 specifying the level that any top-level headline in the included
3299 file should have."
3315 ;; Remove blank lines at beginning and end of contents. The logic
3316 ;; behind that removal is that blank lines around include keyword
3317 ;; override blank lines in included file.
3326 ;; If IND is set, preserve indentation of include keyword until
3327 ;; the first headline encountered.
3334 ;; Do not move footnote definitions out of column 0.
3340 ;; When MINLEVEL is specified, compute minimal level for headlines
3341 ;; in the file (CUR-MIN), and remove stars to each headline so
3342 ;; that headlines with minimal level have a level of MINLEVEL.
3353 ;; Only change stars, don't bother moving whole
3354 ;; sections.
3361 "Execute every Babel code in the visible part of current buffer."
3362 ;; Get a pristine copy of current buffer so Babel references can be
3363 ;; properly resolved.
3370 "Return a non-nil value when output should be added to the kill ring.
3371 See also `org-export-copy-to-kill-ring'."
3377 \f
3378 ;;; Tools For Back-Ends
3379 ;;
3380 ;; A whole set of tools is available to help build new exporters. Any
3381 ;; function general enough to have its use across many back-ends
3382 ;; should be added here.
3384 ;;;; For Affiliated Keywords
3385 ;;
3386 ;; `org-export-read-attribute' reads a property from a given element
3387 ;; as a plist. It can be used to normalize affiliated keywords'
3388 ;; syntax.
3389 ;;
3390 ;; Since captions can span over multiple lines and accept dual values,
3391 ;; their internal representation is a bit tricky. Therefore,
3392 ;; `org-export-get-caption' transparently returns a given element's
3393 ;; caption as a secondary string.
3396 "Turn ATTRIBUTE property from ELEMENT into a plist.
3398 When optional argument PROPERTY is non-nil, return the value of
3399 that property within attributes.
3403 properties.
3405 All values will become strings except the empty string and
3408 will become the empty string."
3422 s)
3427 ;; Ignore any string before first property with `cdr'.
3432 "Return caption from ELEMENT as a secondary string.
3434 When optional argument SHORTP is non-nil, return short caption,
3435 as a secondary string, instead.
3437 Caption lines are separated by a white space."
3445 ;;;; For Derived Back-ends
3446 ;;
3447 ;; `org-export-with-backend' is a function allowing to locally use
3448 ;; another back-end to transcode some object or element. In a derived
3449 ;; back-end, it may be used as a fall-back function once all specific
3450 ;; cases have been treated.
3453 "Call a transcoder from BACKEND on DATA.
3454 BACKEND is an export back-end, as returned by, e.g.,
3455 `org-export-create-backend', or a symbol referring to
3456 a registered back-end. DATA is an Org element, object, secondary
3457 string or string. CONTENTS, when non-nil, is the transcoded
3458 contents of DATA element, as a string. INFO, when non-nil, is
3459 the communication channel used for export, as a plist."
3469 transcoder data contents
3472 :translate-alist all-transcoders
3476 ;;;; For Export Snippets
3477 ;;
3478 ;; Every export snippet is transmitted to the back-end. Though, the
3479 ;; latter will only retain one type of export-snippet, ignoring
3480 ;; others, based on the former's target back-end. The function
3481 ;; `org-export-snippet-backend' returns that back-end for a given
3482 ;; export-snippet.
3485 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3486 Translation, with `org-export-snippet-translation-alist', is
3487 applied."
3491 back-end))))
3494 ;;;; For Footnotes
3495 ;;
3496 ;; `org-export-collect-footnote-definitions' is a tool to list
3497 ;; actually used footnotes definitions in the whole parse tree, or in
3498 ;; a headline, in order to add footnote listings throughout the
3499 ;; transcoded data.
3500 ;;
3501 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3502 ;; back-ends, when they need to attach the footnote definition only to
3503 ;; the first occurrence of the corresponding label.
3504 ;;
3505 ;; `org-export-get-footnote-definition' and
3506 ;; `org-export-get-footnote-number' provide easier access to
3507 ;; additional information relative to a footnote reference.
3510 "Return an alist between footnote numbers, labels and definitions.
3512 DATA is the parse tree from which definitions are collected.
3513 INFO is the plist used as a communication channel.
3515 Definitions are sorted by order of references. They either
3516 appear as Org data or as a secondary string for inlined
3517 footnotes. Unreferenced definitions are ignored."
3519 collect-fn ; for byte-compiler.
3523 ;; Collect footnote number, label and definition in DATA.
3531 def)
3532 num-alist)
3533 ;; Also search in definition for nested footnotes.
3536 ;; Don't enter footnote definitions since it will happen
3537 ;; when their first reference is found.
3543 "Non-nil when a footnote reference is the first one for its label.
3545 FOOTNOTE-REFERENCE is the footnote reference being considered.
3546 INFO is the plist used as a communication channel."
3548 ;; Anonymous footnotes are always a first reference.
3550 ;; Otherwise, return the first footnote with the same LABEL and
3551 ;; test if it is equal to FOOTNOTE-REFERENCE.
3561 ;; If FN isn't inlined, be sure to traverse its
3562 ;; definition before resuming search. See
3563 ;; comments in `org-export-get-footnote-number'
3564 ;; for more information.
3568 ;; Don't enter footnote definitions since it will
3569 ;; happen when their first reference is found.
3572 footnote-reference)))))
3575 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3576 INFO is the plist used as a communication channel. If no such
3578 string."
3585 "Return number associated to a footnote.
3587 FOOTNOTE is either a footnote reference or a footnote definition.
3588 INFO is the plist used as a communication channel."
3590 seen-refs
3591 search-ref ; For byte-compiler.
3595 ;; Search footnote references through DATA, filling
3596 ;; SEEN-REFS along the way.
3601 ;; Anonymous footnote match: return number.
3604 ;; Labels match: return number.
3607 ;; Anonymous footnote: it's always a new one.
3608 ;; Also, be sure to return nil from the `cond' so
3609 ;; `first-match' doesn't get us out of the loop.
3611 ;; Label not seen so far: add it so SEEN-REFS.
3612 ;;
3613 ;; Also search for subsequent references in
3614 ;; footnote definition so numbering follows
3615 ;; reading logic. Note that we don't have to care
3616 ;; about inline definitions, since
3617 ;; `org-element-map' already traverses them at the
3618 ;; right time.
3619 ;;
3620 ;; Once again, return nil to stay in the loop.
3625 nil))))
3626 ;; Don't enter footnote definitions since it will
3627 ;; happen when their first reference is found.
3632 ;;;; For Headlines
3633 ;;
3634 ;; `org-export-get-relative-level' is a shortcut to get headline
3635 ;; level, relatively to the lower headline level in the parsed tree.
3636 ;;
3637 ;; `org-export-get-headline-number' returns the section number of an
3638 ;; headline, while `org-export-number-to-roman' allows to convert it
3639 ;; to roman numbers.
3640 ;;
3641 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3642 ;; `org-export-last-sibling-p' are three useful predicates when it
3643 ;; comes to fulfill the `:headline-levels' property.
3644 ;;
3645 ;; `org-export-get-tags', `org-export-get-category' and
3646 ;; `org-export-get-node-property' extract useful information from an
3647 ;; headline or a parent headline. They all handle inheritance.
3648 ;;
3649 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3650 ;; as a secondary string, suitable for table of contents. It falls
3651 ;; back onto default title.
3654 "Return HEADLINE relative level within current parsed tree.
3655 INFO is a plist holding contextual information."
3660 "Non-nil when HEADLINE is considered as low level.
3662 INFO is a plist used as a communication channel.
3664 A low level headlines has a relative level greater than
3665 `:headline-levels' property value.
3667 Return value is the difference between HEADLINE relative level
3668 and the last level being considered as high enough, or nil."
3675 "Return HEADLINE numbering as a list of numbers.
3676 INFO is a plist holding contextual information."
3680 "Return a non-nil value if HEADLINE element should be numbered.
3681 INFO is a plist used as a communication channel."
3687 "Convert integer N into a roman numeral."
3700 res)))
3703 "Return list of tags associated to ELEMENT.
3705 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3706 is a plist used as a communication channel.
3708 Select tags (see `org-export-select-tags') and exclude tags (see
3709 `org-export-exclude-tags') are removed from the list.
3711 When non-nil, optional argument TAGS should be a list of strings.
3712 Any tag belonging to this list will also be removed.
3714 When optional argument INHERITED is non-nil, tags can also be
3715 inherited from parent headlines and FILETAGS keywords."
3721 ;; Build complete list of inherited tags.
3732 ;; Add FILETAGS keywords and return results.
3736 "Return node PROPERTY value for BLOB.
3738 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3739 element or object.
3741 If optional argument INHERITED is non-nil, the value can be
3742 inherited from a parent headline.
3744 Return value is a string or nil."
3756 "Return category for element or object BLOB.
3758 INFO is a plist used as a communication channel.
3760 CATEGORY is automatically inherited from a parent headline, from
3761 #+CATEGORY: keyword or created out of original file name. If all
3765 ;; Almost like `org-export-node-property', but we cannot trust
3766 ;; `plist-member' as every headline has a `:CATEGORY'
3767 ;; property, would it be nil or equal to "???" (which has the
3768 ;; same meaning).
3786 "Return alternative title for HEADLINE, as a secondary string.
3787 INFO is a plist used as a communication channel. If no optional
3788 title is defined, fall-back to the regular title."
3793 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3794 INFO is a plist used as a communication channel."
3799 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3800 INFO is a plist used as a communication channel."
3804 ;;;; For Keywords
3805 ;;
3806 ;; `org-export-get-date' returns a date appropriate for the document
3807 ;; to about to be exported. In particular, it takes care of
3808 ;; `org-export-date-timestamp-format'.
3811 "Return date value for the current document.
3813 INFO is a plist used as a communication channel. FMT, when
3814 non-nil, is a time format string that will be applied on the date
3815 if it consists in a single timestamp object. It defaults to
3816 `org-export-date-timestamp-format' when nil.
3818 A proper date can be a secondary string, a string or nil. It is
3819 meant to be translated with `org-export-data' or alike."
3830 ;;;; For Links
3831 ;;
3832 ;; `org-export-solidify-link-text' turns a string into a safer version
3833 ;; for links, replacing most non-standard characters with hyphens.
3834 ;;
3835 ;; `org-export-get-coderef-format' returns an appropriate format
3836 ;; string for coderefs.
3837 ;;
3838 ;; `org-export-inline-image-p' returns a non-nil value when the link
3839 ;; provided should be considered as an inline image.
3840 ;;
3841 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3842 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3843 ;; returns an appropriate unique identifier when found, or nil.
3844 ;;
3845 ;; `org-export-resolve-id-link' returns the first headline with
3846 ;; specified id or custom-id in parse tree, the path to the external
3847 ;; file with the id or nil when neither was found.
3848 ;;
3849 ;; `org-export-resolve-coderef' associates a reference to a line
3850 ;; number in the element it belongs, or returns the reference itself
3851 ;; when the element isn't numbered.
3854 "Take link text S and make a safe target out of it."
3859 "Return format string for code reference link.
3860 PATH is the link path. DESC is its description."
3868 "Non-nil if LINK object points to an inline image.
3870 Optional argument is a set of RULES defining inline images. It
3871 is an alist where associations have the following shape:
3873 \(TYPE . REGEXP)
3875 Applying a rule means apply REGEXP against LINK's path when its
3876 type is TYPE. The function will return a non-nil value if any of
3877 the provided rules is non-nil. The default rule is
3878 `org-export-default-inline-image-rule'.
3880 This only applies to links without a description."
3891 rules)
3892 ;; Return nil if no rule matched.
3893 nil))))
3896 "Resolve a code reference REF.
3898 INFO is a plist used as a communication channel.
3900 Return associated line number in source code, or REF itself,
3901 depending on src-block or example element's switches."
3908 org-coderef-label-format)))
3912 ;; Element containing REF is found. Resolve it to either
3913 ;; a label or a line number, as needed.
3923 "Return LINK destination.
3925 INFO is a plist holding contextual information.
3927 Return value can be an object, an element, or nil:
3929 - If LINK path matches a target object (i.e. <<path>>) return it.
3931 - If LINK path exactly matches the name affiliated keyword
3932 \(i.e. #+NAME: path) of an element, return that element.
3934 - If LINK path exactly matches any headline name, return that
3935 element. If more than one headline share that name, priority
3936 will be given to the one with the closest common ancestor, if
3937 any, or the first one in the parse tree otherwise.
3939 - Otherwise, return nil.
3942 significant."
3945 ;; Split PATH at white spaces so matches are space
3946 ;; insensitive.
3949 ;; Cache for destinations that are not position dependent.
3957 ;; Destination is not position dependent: use cached value.
3959 ;; First try to find a matching "<<path>>" unless user specified
3960 ;; he was looking for a headline (path starts with a "*"
3961 ;; character).
3967 path)
3968 blob))
3971 ;; Then try to find an element with a matching "#+NAME: path"
3972 ;; affiliated keyword.
3975 org-element-all-elements
3980 el)))
3983 ;; Last case: link either points to a headline or to nothingness.
3984 ;; Try to find the source, with priority given to headlines with
3985 ;; the closest common ancestor. If such candidate is found,
3986 ;; return it, otherwise return nil.
3990 ;; Return first headline whose `:raw-value' property is
3991 ;; NAME in parse tree DATA, or nil. Statistics cookies
3992 ;; are ignored.
4000 name)
4001 headline))
4003 ;; Search among headlines sharing an ancestor with link, from
4004 ;; closest to farthest.
4013 ;; No destination found: return nil.
4017 "Return headline referenced as LINK destination.
4019 INFO is a plist used as a communication channel.
4021 Return value can be the headline element matched in current parse
4025 ;; First check if id is within the current parse tree.
4030 headline))
4032 ;; Otherwise, look for external files.
4036 "Return radio-target object referenced as LINK destination.
4038 INFO is a plist used as a communication channel.
4040 Return value can be a radio-target object or nil. Assume LINK
4049 nil nil path nil nil t)
4050 t)
4051 radio))
4055 ;;;; For References
4056 ;;
4057 ;; `org-export-get-ordinal' associates a sequence number to any object
4058 ;; or element.
4061 "Return ordinal number of an element or object.
4063 ELEMENT is the element or object considered. INFO is the plist
4064 used as a communication channel.
4066 Optional argument TYPES, when non-nil, is a list of element or
4067 object types, as symbols, that should also be counted in.
4068 Otherwise, only provided element's type is considered.
4070 Optional argument PREDICATE is a function returning a non-nil
4071 value if the current element or object should be counted in. It
4072 accepts two arguments: the element or object being considered and
4073 the plist used as a communication channel. This allows to count
4074 only a certain type of objects (i.e. inline images).
4076 Return value is a list of numbers if ELEMENT is a headline or an
4077 item. It is nil for keywords. It represents the footnote number
4078 for footnote definitions and footnote references. If ELEMENT is
4079 a target, return the same value as if ELEMENT was the closest
4080 table, item or headline containing the target. In any other
4081 case, return the sequence number of ELEMENT among elements or
4082 objects of the same type."
4083 ;; Ordinal of a target object refer to the ordinal of the closest
4084 ;; table, item, or headline containing the object.
4088 when
4092 table))
4093 return parent)))
4095 ;; Special case 1: A headline returns its number as a list.
4097 ;; Special case 2: An item returns its number as a list.
4101 struct
4108 ;; Increment counter until ELEMENT is found again.
4119 ;;;; For Src-Blocks
4120 ;;
4121 ;; `org-export-get-loc' counts number of code lines accumulated in
4122 ;; src-block or example-block elements with a "+n" switch until
4123 ;; a given element, excluded. Note: "-n" switches reset that count.
4124 ;;
4125 ;; `org-export-unravel-code' extracts source code (along with a code
4126 ;; references alist) from an `element-block' or `src-block' type
4127 ;; element.
4128 ;;
4129 ;; `org-export-format-code' applies a formatting function to each line
4130 ;; of code, providing relative line number and code reference when
4131 ;; appropriate. Since it doesn't access the original element from
4132 ;; which the source code is coming, it expects from the code calling
4133 ;; it to know if lines should be numbered and if code references
4134 ;; should appear.
4135 ;;
4136 ;; Eventually, `org-export-format-code-default' is a higher-level
4137 ;; function (it makes use of the two previous functions) which handles
4138 ;; line numbering and code references inclusion, and returns source
4139 ;; code in a format suitable for plain text or verbatim output.
4142 "Return accumulated lines of code up to ELEMENT.
4144 INFO is the plist used as a communication channel.
4146 ELEMENT is excluded from count."
4152 ;; ELEMENT is reached: Quit the loop.
4154 ;; Only count lines from src-block and example-block elements
4155 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4159 ;; Accumulate locs or reset them.
4163 ;; Return nil to stay in the loop.
4164 nil)))
4166 ;; Return value.
4167 loc))
4170 "Clean source code and extract references out of it.
4172 ELEMENT has either a `src-block' an `example-block' type.
4174 Return a cons cell whose CAR is the source code, cleaned from any
4175 reference and protective comma and CDR is an alist between
4176 relative line number (integer) and name of code reference on that
4177 line (string)."
4179 ;; Get code and clean it. Remove blank lines at its
4180 ;; beginning and end.
4186 ;; Get format used for references.
4189 org-coderef-label-format)))
4190 ;; Build a regexp matching a loc with a reference.
4195 ;; Return value.
4197 ;; Code with references removed.
4203 ;; Ref line: remove ref, and signal its position in REFS.
4207 ;; Reference alist.
4208 refs)))
4211 "Format CODE by applying FUN line-wise and return it.
4213 CODE is a string representing the code to format. FUN is
4214 a function. It must accept three arguments: a line of
4215 code (string), the current line number (integer) or nil and the
4216 reference associated to the current line (string) or nil.
4218 Optional argument NUM-LINES can be an integer representing the
4219 number of code lines accumulated until the current code. Line
4220 numbers passed to FUN will take it into account. If it is nil,
4221 FUN's second argument will always be nil. This number can be
4222 obtained with `org-export-get-loc' function.
4224 Optional argument REF-ALIST can be an alist between relative line
4225 number (i.e. ignoring NUM-LINES) and the name of the code
4226 reference on it. If it is nil, FUN's third argument will always
4227 be nil. It can be obtained through the use of
4228 `org-export-unravel-code' function."
4240 "Return source code from ELEMENT, formatted in a standard way.
4242 ELEMENT is either a `src-block' or `example-block' element. INFO
4243 is a plist used as a communication channel.
4245 This function takes care of line numbering and code references
4246 inclusion. Line numbers, when applicable, appear at the
4247 beginning of the line, separated from the code by two white
4248 spaces. Code references, on the other hand, appear flushed to
4249 the right, separated by six white spaces from the widest line of
4250 code."
4251 ;; Extract code and references.
4258 ;; Handle line numbering.
4267 ;; Prepare references display, if required. Any reference
4268 ;; should start six columns after the widest line of code,
4269 ;; wrapped with parenthesis.
4274 code
4278 number-str
4279 loc
4285 num-start refs)))))
4288 ;;;; For Tables
4289 ;;
4290 ;; `org-export-table-has-special-column-p' and and
4291 ;; `org-export-table-row-is-special-p' are predicates used to look for
4292 ;; meta-information about the table structure.
4293 ;;
4294 ;; `org-table-has-header-p' tells when the rows before the first rule
4295 ;; should be considered as table's header.
4296 ;;
4297 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4298 ;; and `org-export-table-cell-borders' extract information from
4299 ;; a table-cell element.
4300 ;;
4301 ;; `org-export-table-dimensions' gives the number on rows and columns
4302 ;; in the table, ignoring horizontal rules and special columns.
4303 ;; `org-export-table-cell-address', given a table-cell object, returns
4304 ;; the absolute address of a cell. On the other hand,
4305 ;; `org-export-get-table-cell-at' does the contrary.
4306 ;;
4307 ;; `org-export-table-cell-starts-colgroup-p',
4308 ;; `org-export-table-cell-ends-colgroup-p',
4309 ;; `org-export-table-row-starts-rowgroup-p',
4310 ;; `org-export-table-row-ends-rowgroup-p',
4311 ;; `org-export-table-row-starts-header-p' and
4312 ;; `org-export-table-row-ends-header-p' indicate position of current
4313 ;; row or cell within the table.
4316 "Non-nil when TABLE has a special column.
4317 All special columns will be ignored during export."
4318 ;; The table has a special column when every first cell of every row
4319 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4320 ;; "*" "_" and "^". Though, do not consider a first row containing
4321 ;; only empty cells as special.
4337 "Non-nil when TABLE has a header.
4339 INFO is a plist used as a communication channel.
4341 A table has a header when it contains at least two row groups."
4350 table
4361 cache)))))
4364 "Non-nil if TABLE-ROW is considered special.
4366 INFO is a plist used as the communication channel.
4368 All special rows will be ignored during export."
4372 ;; A row is special either when...
4374 ;; ... it starts with a field only containing "/",
4376 ;; ... the table contains a special column and the row start
4377 ;; with a marking character among, "^", "_", "$" or "!",
4381 ;; ... it contains only alignment cookies and empty cells.
4387 ;; Since VALUE is a secondary string, the following
4388 ;; checks avoid expanding it with `org-export-data'.
4400 "Return TABLE-ROW's group number, as an integer.
4402 INFO is a plist used as the communication channel.
4404 Return value is the group number, as an integer, or nil for
4405 special rows and rows separators. First group is also table's
4406 header."
4424 "Return TABLE-CELL contents width.
4426 INFO is a plist used as the communication channel.
4428 Return value is the width given by the last width cookie in the
4429 same column as TABLE-CELL, or nil."
4448 ;; In a special row, try to find a width cookie at COLUMN.
4452 ;; The following checks avoid expanding unnecessarily
4453 ;; the cell with `org-export-data'.
4463 "Return TABLE-CELL contents alignment.
4465 INFO is a plist used as the communication channel.
4467 Return alignment as specified by the last alignment cookie in the
4468 same column as TABLE-CELL. If no such cookie is found, a default
4469 alignment value will be deduced from fraction of numbers in the
4470 column (see `org-table-number-fraction' for more information).
4471 Possible values are `left', `right' and `center'."
4472 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4489 cookie-align
4490 previous-cell-number-p)
4493 ;; In a special row, try to find an alignment cookie at
4494 ;; COLUMN.
4498 ;; Since VALUE is a secondary string, the following
4499 ;; checks avoid useless expansion through
4500 ;; `org-export-data'.
4508 ;; Ignore table rules.
4510 ;; In a standard row, check if cell's contents are
4511 ;; expressing some kind of number. Increase NUMBER-CELLS
4512 ;; accordingly. Though, don't bother if an alignment
4513 ;; cookie has already defined cell's alignment.
4518 info)))
4520 ;; Treat an empty cell as a number if it follows
4521 ;; a number.
4527 ;; Return value. Alignment specified by cookies has
4528 ;; precedence over alignment deduced from cell's contents.
4530 column
4535 org-table-number-fraction)
4540 "Return TABLE-CELL borders.
4542 INFO is a plist used as a communication channel.
4544 Return value is a list of symbols, or nil. Possible values are:
4545 `top', `bottom', `above', `below', `left' and `right'. Note:
4546 `top' (resp. `bottom') only happen for a cell in the first
4547 row (resp. last row) of the table, ignoring table rules, if any.
4549 Returned borders ignore special rows."
4552 borders)
4553 ;; Top/above border? TABLE-CELL has a border above when a rule
4554 ;; used to demarcate row groups can be found above. Hence,
4555 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4556 ;; another regular row has to be found above that rule.
4565 ;; Look at every row before the current one.
4567 ;; No rule above, or rule found starts the table (ignoring any
4568 ;; special row): TABLE-CELL is at the top of the table.
4571 ;; Bottom/below border? TABLE-CELL has a border below when next
4572 ;; non-regular row below is a rule.
4581 ;; Look at every row after the current one.
4583 ;; No rule below, or rule found ends the table (modulo some
4584 ;; special row): TABLE-CELL is at the bottom of the table.
4587 ;; Right/left borders? They can only be specified by column
4588 ;; groups. Column groups are defined in a row starting with "/".
4589 ;; Also a column groups row only contains "<", "<>", ">" or blank
4590 ;; cells.
4607 ;; There's a left border when previous cell, if
4608 ;; any, ends a group, or current one starts one.
4614 ;; There's a right border when next cell, if any,
4615 ;; starts a group, or current one ends one.
4622 ;; Table rows are read in reverse order so last column groups
4623 ;; row has precedence over any previous one.
4625 ;; Return value.
4626 borders))
4629 "Non-nil when TABLE-CELL is at the beginning of a row group.
4630 INFO is a plist used as a communication channel."
4631 ;; A cell starts a column group either when it is at the beginning
4632 ;; of a row (or after the special column, if any) or when it has
4633 ;; a left border.
4636 table-cell)
4640 "Non-nil when TABLE-CELL is at the end of a row group.
4641 INFO is a plist used as a communication channel."
4642 ;; A cell ends a column group either when it is at the end of a row
4643 ;; or when it has a right border.
4646 table-cell)
4650 "Non-nil when TABLE-ROW is at the beginning of a column group.
4651 INFO is a plist used as a communication channel."
4659 "Non-nil when TABLE-ROW is at the end of a column group.
4660 INFO is a plist used as a communication channel."
4668 "Non-nil when TABLE-ROW is the first table header's row.
4669 INFO is a plist used as a communication channel."
4676 "Non-nil when TABLE-ROW is the last table header's row.
4677 INFO is a plist used as a communication channel."
4684 "Return TABLE-ROW number.
4685 INFO is a plist used as a communication channel. Return value is
4686 zero-based and ignores separators. The function returns nil for
4687 special columns and separators."
4699 "Return TABLE dimensions.
4701 INFO is a plist used as a communication channel.
4703 Return value is a CONS like (ROWS . COLUMNS) where
4704 ROWS (resp. COLUMNS) is the number of exportable
4705 rows (resp. columns)."
4707 ;; Set number of rows, and extract first one.
4713 ;; Set number of columns.
4715 ;; Return value.
4719 "Return address of a regular TABLE-CELL object.
4721 TABLE-CELL is the cell considered. INFO is a plist used as
4722 a communication channel.
4724 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4725 zero-based index. Only exportable cells are considered. The
4726 function returns nil for other cells."
4738 "Return regular table-cell object at ADDRESS in TABLE.
4740 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4741 zero-based index. TABLE is a table type element. INFO is
4742 a plist used as a communication channel.
4744 If no table-cell, among exportable cells, is found at ADDRESS,
4745 return nil."
4748 ;; Row at (car address) or nil.
4756 'table-cell
4763 ;;;; For Tables Of Contents
4764 ;;
4765 ;; `org-export-collect-headlines' builds a list of all exportable
4766 ;; headline elements, maybe limited to a certain depth. One can then
4767 ;; easily parse it and transcode it.
4768 ;;
4769 ;; Building lists of tables, figures or listings is quite similar.
4770 ;; Once the generic function `org-export-collect-elements' is defined,
4771 ;; `org-export-collect-tables', `org-export-collect-figures' and
4772 ;; `org-export-collect-listings' can be derived from it.
4775 "Collect headlines in order to build a table of contents.
4777 INFO is a plist used as a communication channel.
4779 When optional argument N is an integer, it specifies the depth of
4780 the table of contents. Otherwise, it is set to the value of the
4781 last headline level. See `org-export-headline-levels' for more
4782 information.
4784 Return a list of all exportable headlines as parsed elements.
4785 Footnote sections, if any, will be ignored."
4793 info)))
4796 "Collect referenceable elements of a determined type.
4798 TYPE can be a symbol or a list of symbols specifying element
4799 types to search. Only elements with a caption are collected.
4801 INFO is a plist used as a communication channel.
4803 When non-nil, optional argument PREDICATE is a function accepting
4804 one argument, an element of type TYPE. It returns a non-nil
4805 value when that element should be collected.
4807 Return a list of all elements found, in order of appearance."
4812 element))
4813 info))
4816 "Build a list of tables.
4817 INFO is a plist used as a communication channel.
4819 Return a list of table elements with a caption."
4823 "Build a list of figures.
4825 INFO is a plist used as a communication channel. PREDICATE is
4826 a function which accepts one argument: a paragraph element and
4827 whose return value is non-nil when that element should be
4828 collected.
4830 A figure is a paragraph type element, with a caption, verifying
4832 a vague concept that may depend on back-end.
4834 Return a list of elements recognized as figures."
4838 "Build a list of src blocks.
4840 INFO is a plist used as a communication channel.
4842 Return a list of src-block elements with a caption."
4846 ;;;; Smart Quotes
4847 ;;
4848 ;; The main function for the smart quotes sub-system is
4849 ;; `org-export-activate-smart-quotes', which replaces every quote in
4850 ;; a given string from the parse tree with its "smart" counterpart.
4851 ;;
4852 ;; Dictionary for smart quotes is stored in
4853 ;; `org-export-smart-quotes-alist'.
4854 ;;
4855 ;; Internally, regexps matching potential smart quotes (checks at
4856 ;; string boundaries are also necessary) are defined in
4857 ;; `org-export-smart-quotes-regexps'.
4861 ;; one may use: »...«, "...", ›...‹, or '...'.
4862 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4863 ;; LaTeX quotes require Babel!
4908 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4917 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4926 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4935 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4941 )
4942 "Smart quotes translations.
4944 Alist whose CAR is a language string and CDR is an alist with
4945 quote type as key and a plist associating various encodings to
4946 their translation as value.
4948 A quote type can be any symbol among `opening-double-quote',
4949 `closing-double-quote', `opening-single-quote',
4950 `closing-single-quote' and `apostrophe'.
4952 Valid encodings include `:utf-8', `:html', `:latex' and
4953 `:texinfo'.
4959 ;; Possible opening quote at beginning of string.
4961 ;; Possible closing quote at beginning of string.
4963 ;; Possible apostrophe at beginning of string.
4965 ;; Opening single and double quotes.
4967 ;; Closing single and double quotes.
4969 ;; Apostrophe.
4971 ;; Possible opening quote at end of string.
4973 ;; Possible closing quote at end of string.
4975 ;; Possible apostrophe at end of string.
4977 "List of regexps matching a quote or an apostrophe.
4983 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4984 `:utf-8'. INFO is a plist used as a communication channel.
4986 The function has to retrieve information about string
4987 surroundings in parse tree. It can only happen with an
4988 unmodified string. Thus, if S has already been through another
4989 process, a non-nil ORIGINAL optional argument will provide that
4990 original string.
4992 Return the new string."
4995 ;; Try to be flexible when computing number of blanks
4996 ;; before object. The previous object may be a string
4997 ;; introduced by the back-end and not completely parsed.
5000 ;; A string with missing `:post-blank'
5001 ;; property.
5005 ;; Fallback value.
5010 ;; Return smart quote associated to a give quote Q, as
5011 ;; a string. TYPE is a symbol among `open', `close' and
5012 ;; `apostrophe'.
5022 org-export-smart-quotes-alist))))
5023 encoding)
5024 q)))))
5026 ;; Only a quote: no regexp can match. We have to check both
5027 ;; sides and decide what to do.
5035 ;; 1. Replace quote character at the beginning of S.
5037 ;; Apostrophe?
5043 ;; Closing quote?
5049 ;; Opening quote?
5055 ;; 2. Replace quotes in the middle of the string.
5057 ;; Opening quotes.
5063 ;; Closing quotes.
5069 ;; Apostrophes.
5074 ;; 3. Replace quote character at the end of S.
5076 ;; Apostrophe?
5081 ;; Closing quote?
5087 ;; Opening quote?
5092 ;; Return string with smart quotes.
5093 s))))
5095 ;;;; Topology
5096 ;;
5097 ;; Here are various functions to retrieve information about the
5098 ;; neighborhood of a given element or object. Neighbors of interest
5099 ;; are direct parent (`org-export-get-parent'), parent headline
5100 ;; (`org-export-get-parent-headline'), first element containing an
5101 ;; object, (`org-export-get-parent-element'), parent table
5102 ;; (`org-export-get-parent-table'), previous element or object
5103 ;; (`org-export-get-previous-element') and next element or object
5104 ;; (`org-export-get-next-element').
5105 ;;
5106 ;; `org-export-get-genealogy' returns the full genealogy of a given
5107 ;; element or object, from closest parent to full parse tree.
5110 "Return BLOB parent or nil.
5111 BLOB is the element or object considered."
5115 "Return full genealogy relative to a given element or object.
5117 BLOB is the element or object being considered.
5119 Ancestors are returned from closest to farthest, the last one
5120 being the full parse tree."
5127 "Return BLOB parent headline or nil.
5128 BLOB is the element or object being considered."
5132 parent))
5135 "Return first element containing OBJECT or nil.
5136 OBJECT is the object to consider."
5140 parent))
5143 "Return OBJECT parent table or nil.
5144 OBJECT is either a `table-cell' or `table-element' type object."
5148 parent))
5151 "Return previous element or object.
5153 BLOB is an element or object. INFO is a plist used as
5154 a communication channel. Return previous exportable element or
5155 object, a string, or nil.
5157 When optional argument N is a positive integer, return a list
5158 containing up to N siblings before BLOB, from farthest to
5159 closest. With any other non-nil value, return a list containing
5160 all of them."
5162 ;; An object can belong to the contents of its parent or
5163 ;; to a secondary string. We check the latter option
5164 ;; first.
5168 org-element-secondary-value-alist))
5169 parent)))
5172 prev)
5181 prev)))
5184 "Return next element or object.
5186 BLOB is an element or object. INFO is a plist used as
5187 a communication channel. Return next exportable element or
5188 object, a string, or nil.
5190 When optional argument N is a positive integer, return a list
5191 containing up to N siblings after BLOB, from closest to farthest.
5192 With any other non-nil value, return a list containing all of
5193 them."
5195 ;; An object can belong to the contents of its parent or to
5196 ;; a secondary string. We check the latter option first.
5200 org-element-secondary-value-alist))
5201 parent)))
5204 next)
5212 siblings)
5216 ;;;; Translation
5217 ;;
5218 ;; `org-export-translate' translates a string according to the language
5219 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5220 ;; the dictionary used for the translation.
5404 "Dictionary for export engine.
5406 Alist whose CAR is the string to translate and CDR is an alist
5407 whose CAR is the language string and CDR is a plist whose
5408 properties are possible charsets and values translated terms.
5410 It is used as a database for `org-export-translate'. Since this
5411 function returns the string as-is if no translation was found,
5412 the variable only needs to record values different from the
5416 "Translate string S according to language specification.
5418 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5419 and `:utf-8'. INFO is a plist used as a communication channel.
5421 Translation depends on `:language' property. Return the
5422 translated string. If no translation is found, try to fall back
5423 to `:default' encoding. If it fails, return S."
5429 s)))
5432 \f
5433 ;;; Asynchronous Export
5434 ;;
5435 ;; `org-export-async-start' is the entry point for asynchronous
5436 ;; export. It recreates current buffer (including visibility,
5437 ;; narrowing and visited file) in an external Emacs process, and
5438 ;; evaluates a command there. It then applies a function on the
5439 ;; returned results in the current process.
5440 ;;
5441 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5442 ;; allow to export to a buffer or a file, asynchronously or not.
5443 ;;
5444 ;; `org-export-output-file-name' is an auxiliary function meant to be
5445 ;; used with `org-export-to-file'. With a given extension, it tries
5446 ;; to provide a canonical file name to write export output to.
5447 ;;
5448 ;; Asynchronously generated results are never displayed directly.
5449 ;; Instead, they are stored in `org-export-stack-contents'. They can
5450 ;; then be retrieved by calling `org-export-stack'.
5451 ;;
5452 ;; Export Stack is viewed through a dedicated major mode
5453 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5454 ;;`org-export-stack-delete', `org-export-stack-view' and
5455 ;;`org-export-stack-clear'.
5456 ;;
5457 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5458 ;; It should be used whenever `org-export-async-start' is called.
5461 "Call function FUN on the results returned by BODY evaluation.
5463 BODY evaluation happens in an asynchronous process, from a buffer
5464 which is an exact copy of the current one.
5466 Use `org-export-add-to-stack' in FUN in order to register results
5467 in the stack.
5469 This is a low level function. See also `org-export-to-buffer'
5470 and `org-export-to-file' for more specialized functions."
5473 ;; Write the full sexp evaluating BODY in a copy of the current
5474 ;; buffer to a temporary file, as it may be too long for program
5475 ;; args in `start-process'.
5482 ;; Null characters (from variable values) are inserted
5483 ;; within the file. As a consequence, coding system for
5484 ;; buffer contents will not be recognized properly. So,
5485 ;; we make sure it is the same as the one used to display
5486 ;; the original buffer.
5488 ,coding
5491 ;; Ignore `kill-emacs-hook' and code evaluation
5492 ;; queries from Babel as we need a truly
5493 ;; non-interactive process.
5495 org-babel-confirm-evaluate-answer-no t)
5496 ;; Initialize export framework.
5498 ;; Re-create current buffer there.
5501 ;; Sexp to evaluate in the buffer.
5503 ;; Start external process.
5506 (,process
5511 "-l" org-export-async-init-file
5513 ;; Register running process in stack.
5515 ;; Set-up sentinel in order to catch results.
5518 ,process
5540 ;;;###autoload
5543 &optional async subtreep visible-only body-only ext-plist
5544 post-process)
5545 "Call `org-export-as' with output to a specified buffer.
5547 BACKEND is either an export back-end, as returned by, e.g.,
5548 `org-export-create-backend', or a symbol referring to
5549 a registered back-end.
5551 BUFFER is the name of the output buffer. If it already exists,
5552 it will be erased first, otherwise, it will be created.
5554 A non-nil optional argument ASYNC means the process should happen
5555 asynchronously. The resulting buffer should then be accessible
5556 through the `org-export-stack' interface. When ASYNC is nil, the
5557 buffer is displayed if `org-export-show-temporary-export-buffer'
5558 is non-nil.
5560 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5561 EXT-PLIST are similar to those used in `org-export-as', which
5562 see.
5564 Optional argument POST-PROCESS is a function which should accept
5565 no argument. It is always called within the current process,
5566 from BUFFER, with point at its beginning. Export back-ends can
5567 use it to set a major mode there, e.g,
5569 \(defun org-latex-export-as-latex
5570 \(&optional async subtreep visible-only body-only ext-plist)
5571 \(interactive)
5573 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5575 This function returns BUFFER."
5603 buffer)))
5605 ;;;###autoload
5608 post-process)
5609 "Call `org-export-as' with output to a specified file.
5611 BACKEND is either an export back-end, as returned by, e.g.,
5612 `org-export-create-backend', or a symbol referring to
5613 a registered back-end. FILE is the name of the output file, as
5614 a string.
5616 A non-nil optional argument ASYNC means the process should happen
5617 asynchronously. The resulting buffer will then be accessible
5618 through the `org-export-stack' interface.
5620 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5621 EXT-PLIST are similar to those used in `org-export-as', which
5622 see.
5624 Optional argument POST-PROCESS is called with FILE as its
5625 argument and happens asynchronously when ASYNC is non-nil. It
5626 has to return a file name, or nil. Export back-ends can use this
5627 to send the output file through additional processing, e.g,
5629 \(defun org-latex-export-to-latex
5630 \(&optional async subtreep visible-only body-only ext-plist)
5631 \(interactive)
5633 \(org-export-to-file 'latex outfile
5634 async subtreep visible-only body-only ext-plist
5635 \(lambda (file) (org-latex-compile file)))
5637 The function returns either a file name returned by POST-PROCESS,
5638 or FILE."
5656 backend subtreep visible-only body-only ext-plist)))
5663 ;; Get proper return value.
5665 file))))))
5668 "Return output file's name according to buffer specifications.
5670 EXTENSION is a string representing the output file extension,
5671 with the leading dot.
5673 With a non-nil optional argument SUBTREEP, try to determine
5675 of subtree at point.
5677 When optional argument PUB-DIR is set, use it as the publishing
5678 directory.
5680 When optional argument VISIBLE-ONLY is non-nil, don't export
5681 contents of hidden elements.
5683 Return file name as a string."
5686 ;; File name may come from EXPORT_FILE_NAME subtree
5687 ;; property, assuming point is at beginning of said
5688 ;; sub-tree.
5695 ;; File name may be extracted from buffer's associated
5696 ;; file, if any.
5698 ;; Can't determine file name on our own: Ask user.
5702 "Output file: " pub-dir nil nil nil
5706 ;; Build file name. Enforce EXTENSION over whatever user
5707 ;; may have come up with. PUB-DIR, if defined, always has
5708 ;; precedence over any provided path.
5713 extension))
5716 ;; If writing to OUTPUT-FILE would overwrite original file, append
5717 ;; EXTENSION another time to final name.
5720 output-file)))
5723 "Add a new result to export stack if not present already.
5725 SOURCE is a buffer or a file name containing export results.
5726 BACKEND is a symbol representing export back-end used to generate
5727 it.
5729 Entries already pointing to SOURCE and unavailable entries are
5730 removed beforehand. Return the new stack."
5736 "Menu for asynchronous export results and running processes."
5746 "Return source from export results at point in stack."
5753 source
5754 ;; SOURCE is not consistent with current line. The stack
5755 ;; view is outdated.
5759 "Remove all entries from export stack."
5764 "Refresh the asynchronous export stack.
5765 DUMMY is ignored. Unavailable sources are removed from the list.
5766 Return the new stack."
5776 ;; Back-end.
5778 ;; Age.
5781 ;; Compute age of the results.
5783 "%4h:%.2m "
5785 ;; Source.
5790 ;; Clear stack from exited processes, dead buffers or
5791 ;; non-existent files.
5803 "Remove export results at point from stack.
5804 If optional argument SOURCE is non-nil, remove it instead."
5809 org-export-stack-contents))))
5812 "View export results at point in stack.
5813 With an optional prefix argument IN-EMACS, force viewing files
5814 within Emacs."
5828 (define-key km "p" 'previous-line)
5829 (define-key km "\C-p" 'previous-line)
5830 (define-key km "\C-?" 'previous-line)
5831 (define-key km [up] 'previous-line)
5832 (define-key km "C" 'org-export-stack-clear)
5833 (define-key km "v" 'org-export-stack-view)
5834 (define-key km (kbd "RET") 'org-export-stack-view)
5835 (define-key km "d" 'org-export-stack-remove)
5836 km)
5837 "Keymap for Org Export Stack.")
5839 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5840 "Mode for displaying asynchronous export stack.
5843 stack.
5845 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5846 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5847 stack completely.
5849 Removing entries in an Org Export Stack buffer doesn't affect
5850 files or buffers, only the display.
5853 (abbrev-mode 0)
5854 (auto-fill-mode 0)
5855 (setq buffer-read-only t
5856 buffer-undo-list t
5857 truncate-lines t
5858 header-line-format
5859 '(:eval
5860 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5861 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5862 (set (make-local-variable 'revert-buffer-function)
5863 'org-export-stack-refresh))
5866 \f
5867 ;;; The Dispatcher
5868 ;;
5869 ;; `org-export-dispatch' is the standard interactive way to start an
5870 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5871 ;; for its interface, which, in turn, delegates response to key
5872 ;; pressed to `org-export--dispatch-action'.
5874 ;;;###autoload
5875 (defun org-export-dispatch (&optional arg)
5876 "Export dispatcher for Org mode.
5878 It provides an access to common export related tasks in a buffer.
5879 Its interface comes in two flavors: standard and expert.
5881 While both share the same set of bindings, only the former
5882 displays the valid keys associations in a dedicated buffer.
5883 Scrolling (resp. line-wise motion) in this buffer is done with
5884 SPC and DEL (resp. C-n and C-p) keys.
5886 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5887 flavor or the other.
5890 of options used back then, on the current buffer.
5892 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5893 (interactive "P")
5894 (let* ((input
5895 (cond ((equal arg '(16)) '(stack))
5896 ((and arg org-export-dispatch-last-action))
5897 (t (save-window-excursion
5898 (unwind-protect
5899 (progn
5900 ;; Remember where we are
5901 (move-marker org-export-dispatch-last-position
5902 (point)
5903 (org-base-buffer (current-buffer)))
5904 ;; Get and store an export command
5905 (setq org-export-dispatch-last-action
5906 (org-export--dispatch-ui
5907 (list org-export-initial-scope
5908 (and org-export-in-background 'async))
5909 nil
5910 org-export-dispatch-use-expert-ui)))
5911 (and (get-buffer "*Org Export Dispatcher*")
5912 (kill-buffer "*Org Export Dispatcher*")))))))
5913 (action (car input))
5914 (optns (cdr input)))
5915 (unless (memq 'subtree optns)
5916 (move-marker org-export-dispatch-last-position nil))
5917 (case action
5918 ;; First handle special hard-coded actions.
5919 (template (org-export-insert-default-template nil optns))
5920 (stack (org-export-stack))
5921 (publish-current-file
5922 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5923 (publish-current-project
5924 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5925 (publish-choose-project
5926 (org-publish (assoc (org-icompleting-read
5927 "Publish project: "
5928 org-publish-project-alist nil t)
5929 org-publish-project-alist)
5930 (memq 'force optns)
5931 (memq 'async optns)))
5932 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5933 (otherwise
5934 (save-excursion
5935 (when arg
5936 ;; Repeating command, maybe move cursor to restore subtree
5937 ;; context.
5938 (if (eq (marker-buffer org-export-dispatch-last-position)
5939 (org-base-buffer (current-buffer)))
5940 (goto-char org-export-dispatch-last-position)
5941 ;; We are in a different buffer, forget position.
5942 (move-marker org-export-dispatch-last-position nil)))
5943 (funcall action
5944 ;; Return a symbol instead of a list to ease
5945 ;; asynchronous export macro use.
5946 (and (memq 'async optns) t)
5947 (and (memq 'subtree optns) t)
5948 (and (memq 'visible optns) t)
5949 (and (memq 'body optns) t)))))))
5951 (defun org-export--dispatch-ui (options first-key expertp)
5952 "Handle interface for `org-export-dispatch'.
5954 OPTIONS is a list containing current interactive options set for
5955 export. It can contain any of the following symbols:
5956 `body' toggles a body-only export
5957 `subtree' restricts export to current subtree
5958 `visible' restricts export to visible part of buffer.
5959 `force' force publishing files.
5960 `async' use asynchronous export process
5962 FIRST-KEY is the key pressed to select the first level menu. It
5963 is nil when this menu hasn't been selected yet.
5965 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5966 buffer is provided, but indications about currently active
5967 options are given in the prompt. Moreover, \[?] allows to switch
5968 back to standard interface."
5969 (let* ((fontify-key
5970 (lambda (key &optional access-key)
5971 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5972 ;; non-nil is the required first-level key to activate
5973 ;; KEY. When its value is t, activate KEY independently
5974 ;; on the first key, if any. A nil value means KEY will
5975 ;; only be activated at first level.
5976 (if (or (eq access-key t) (eq access-key first-key))
5977 (org-propertize key 'face 'org-warning)
5978 key)))
5979 (fontify-value
5980 (lambda (value)
5981 ;; Fontify VALUE string.
5982 (org-propertize value 'face 'font-lock-variable-name-face)))
5983 ;; Prepare menu entries by extracting them from registered
5984 ;; back-ends and sorting them by access key and by ordinal,
5985 ;; if any.
5986 (entries
5987 (sort (sort (delq nil
5988 (mapcar 'org-export-backend-menu
5989 org-export--registered-backends))
5990 (lambda (a b)
5991 (let ((key-a (nth 1 a))
5992 (key-b (nth 1 b)))
5993 (cond ((and (numberp key-a) (numberp key-b))
5994 (< key-a key-b))
5995 ((numberp key-b) t)))))
5996 'car-less-than-car))
5997 ;; Compute a list of allowed keys based on the first key
5998 ;; pressed, if any. Some keys
5999 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6000 ;; available.
6001 (allowed-keys
6002 (nconc (list 2 22 19 6 1)
6003 (if (not first-key) (org-uniquify (mapcar 'car entries))
6004 (let (sub-menu)
6005 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6006 (when (eq (car entry) first-key)
6007 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6008 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6009 ((not first-key) (list ?P)))
6010 (list ?& ?#)
6011 (when expertp (list ??))
6012 (list ?q)))
6013 ;; Build the help menu for standard UI.
6014 (help
6015 (unless expertp
6016 (concat
6017 ;; Options are hard-coded.
6018 (format "[%s] Body only: %s [%s] Visible only: %s
6019 \[%s] Export scope: %s [%s] Force publishing: %s
6021 (funcall fontify-key "C-b" t)
6022 (funcall fontify-value
6023 (if (memq 'body options) "On " "Off"))
6024 (funcall fontify-key "C-v" t)
6025 (funcall fontify-value
6026 (if (memq 'visible options) "On " "Off"))
6027 (funcall fontify-key "C-s" t)
6028 (funcall fontify-value
6029 (if (memq 'subtree options) "Subtree" "Buffer "))
6030 (funcall fontify-key "C-f" t)
6031 (funcall fontify-value
6032 (if (memq 'force options) "On " "Off"))
6033 (funcall fontify-key "C-a" t)
6034 (funcall fontify-value
6035 (if (memq 'async options) "On " "Off")))
6036 ;; Display registered back-end entries. When a key
6037 ;; appears for the second time, do not create another
6038 ;; entry, but append its sub-menu to existing menu.
6039 (let (last-key)
6040 (mapconcat
6041 (lambda (entry)
6042 (let ((top-key (car entry)))
6043 (concat
6044 (unless (eq top-key last-key)
6045 (setq last-key top-key)
6047 (funcall fontify-key (char-to-string top-key))
6048 (nth 1 entry)))
6049 (let ((sub-menu (nth 2 entry)))
6050 (unless (functionp sub-menu)
6051 ;; Split sub-menu into two columns.
6052 (let ((index -1))
6053 (concat
6054 (mapconcat
6055 (lambda (sub-entry)
6056 (incf index)
6057 (format
6058 (if (zerop (mod index 2)) " [%s] %-26s"
6060 (funcall fontify-key
6061 (char-to-string (car sub-entry))
6062 top-key)
6063 (nth 1 sub-entry)))
6064 sub-menu "")
6066 entries ""))
6067 ;; Publishing menu is hard-coded.
6069 [%s] Current file [%s] Current project
6071 (funcall fontify-key "P")
6072 (funcall fontify-key "f" ?P)
6073 (funcall fontify-key "p" ?P)
6074 (funcall fontify-key "x" ?P)
6075 (funcall fontify-key "a" ?P))
6077 (funcall fontify-key "&" t)
6078 (funcall fontify-key "#" t))
6079 (format "[%s] %s"
6080 (funcall fontify-key "q" t)
6081 (if first-key "Main menu" "Exit")))))
6082 ;; Build prompts for both standard and expert UI.
6083 (standard-prompt (unless expertp "Export command: "))
6084 (expert-prompt
6085 (when expertp
6086 (format
6087 "Export command (C-%s%s%s%s%s) [%s]: "
6088 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6089 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6090 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6091 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6092 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6093 (mapconcat (lambda (k)
6094 ;; Strip control characters.
6095 (unless (< k 27) (char-to-string k)))
6096 allowed-keys "")))))
6097 ;; With expert UI, just read key with a fancy prompt. In standard
6098 ;; UI, display an intrusive help buffer.
6099 (if expertp
6100 (org-export--dispatch-action
6101 expert-prompt allowed-keys entries options first-key expertp)
6102 ;; At first call, create frame layout in order to display menu.
6103 (unless (get-buffer "*Org Export Dispatcher*")
6104 (delete-other-windows)
6105 (org-switch-to-buffer-other-window
6106 (get-buffer-create "*Org Export Dispatcher*"))
6107 (setq cursor-type nil
6108 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6109 ;; Make sure that invisible cursor will not highlight square
6110 ;; brackets.
6111 (set-syntax-table (copy-syntax-table))
6112 (modify-syntax-entry ?\[ "w"))
6113 ;; At this point, the buffer containing the menu exists and is
6114 ;; visible in the current window. So, refresh it.
6115 (with-current-buffer "*Org Export Dispatcher*"
6116 ;; Refresh help. Maintain display continuity by re-visiting
6117 ;; previous window position.
6118 (let ((pos (window-start)))
6119 (erase-buffer)
6120 (insert help)
6121 (set-window-start nil pos)))
6122 (org-fit-window-to-buffer)
6123 (org-export--dispatch-action
6124 standard-prompt allowed-keys entries options first-key expertp))))
6126 (defun org-export--dispatch-action
6127 (prompt allowed-keys entries options first-key expertp)
6128 "Read a character from command input and act accordingly.
6130 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6131 a list of characters available at a given step in the process.
6132 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6133 EXPERTP are the same as defined in `org-export--dispatch-ui',
6134 which see.
6136 Toggle export options when required. Otherwise, return value is
6137 a list with action as CAR and a list of interactive export
6138 options as CDR."
6139 (let (key)
6140 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6141 ;; C-p, SPC, DEL).
6142 (while (and (setq key (read-char-exclusive prompt))
6143 (not expertp)
6144 (memq key '(14 16 ?\s ?\d)))
6145 (case key
6146 (14 (if (not (pos-visible-in-window-p (point-max)))
6147 (ignore-errors (scroll-up 1))
6148 (message "End of buffer")
6149 (sit-for 1)))
6150 (16 (if (not (pos-visible-in-window-p (point-min)))
6151 (ignore-errors (scroll-down 1))
6152 (message "Beginning of buffer")
6153 (sit-for 1)))
6154 (?\s (if (not (pos-visible-in-window-p (point-max)))
6155 (scroll-up nil)
6156 (message "End of buffer")
6157 (sit-for 1)))
6158 (?\d (if (not (pos-visible-in-window-p (point-min)))
6159 (scroll-down nil)
6160 (message "Beginning of buffer")
6161 (sit-for 1)))))
6162 (cond
6163 ;; Ignore undefined associations.
6164 ((not (memq key allowed-keys))
6165 (ding)
6166 (unless expertp (message "Invalid key") (sit-for 1))
6167 (org-export--dispatch-ui options first-key expertp))
6168 ;; q key at first level aborts export. At second level, cancel
6169 ;; first key instead.
6170 ((eq key ?q) (if (not first-key) (error "Export aborted")
6171 (org-export--dispatch-ui options nil expertp)))
6172 ;; Help key: Switch back to standard interface if expert UI was
6173 ;; active.
6174 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6175 ;; Send request for template insertion along with export scope.
6176 ((eq key ?#) (cons 'template (memq 'subtree options)))
6177 ;; Switch to asynchronous export stack.
6178 ((eq key ?&) '(stack))
6179 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6180 ((memq key '(2 22 19 6 1))
6181 (org-export--dispatch-ui
6182 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6183 (6 'force) (1 'async))))
6184 (if (memq option options) (remq option options)
6185 (cons option options)))
6186 first-key expertp))
6187 ;; Action selected: Send key and options back to
6188 ;; `org-export-dispatch'.
6189 ((or first-key (functionp (nth 2 (assq key entries))))
6190 (cons (cond
6191 ((not first-key) (nth 2 (assq key entries)))
6192 ;; Publishing actions are hard-coded. Send a special
6193 ;; signal to `org-export-dispatch'.
6194 ((eq first-key ?P)
6195 (case key
6196 (?f 'publish-current-file)
6197 (?p 'publish-current-project)
6198 (?x 'publish-choose-project)
6199 (?a 'publish-all)))
6200 ;; Return first action associated to FIRST-KEY + KEY
6201 ;; path. Indeed, derived backends can share the same
6202 ;; FIRST-KEY.
6203 (t (catch 'found
6204 (mapc (lambda (entry)
6205 (let ((match (assq key (nth 2 entry))))
6206 (when match (throw 'found (nth 2 match)))))
6207 (member (assq first-key entries) entries)))))
6208 options))
6209 ;; Otherwise, enter sub-menu.
6210 (t (org-export--dispatch-ui options key expertp)))))
6214 (provide 'ox)
6216 ;; Local variables:
6217 ;; generated-autoload-file: "org-loaddefs.el"
6218 ;; End:
6220 ;;; ox.el ends here