| blob | 03bd8bb729d77066a46c2ab828f076b5e01ddbab |
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-buffer' :: Name of input buffer.
1321 ;; - category :: option
1322 ;; - type :: string
1323 ;;
1324 ;; + `:input-file' :: Full path to input file, if any.
1325 ;; - category :: option
1326 ;; - type :: string or nil
1327 ;;
1328 ;; + `:keywords' :: List of keywords attached to data.
1329 ;; - category :: option
1330 ;; - type :: string
1331 ;;
1332 ;; + `:language' :: Default language used for translations.
1333 ;; - category :: option
1334 ;; - type :: string
1335 ;;
1336 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1337 ;; transcoding.
1338 ;; - category :: option
1339 ;; - type :: list (as returned by `org-element-parse-buffer')
1340 ;;
1341 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1342 ;; all line breaks.
1343 ;; - category :: option
1344 ;; - type :: symbol (nil, t)
1345 ;;
1346 ;; + `:section-numbers' :: Non-nil means transcoding should add
1347 ;; section numbers to headlines.
1348 ;; - category :: option
1349 ;; - type :: symbol (nil, t)
1350 ;;
1351 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1352 ;; in transcoding. When such a tag is present, subtrees without
1353 ;; it are de facto excluded from the process. See
1354 ;; `use-select-tags'.
1355 ;; - category :: option
1356 ;; - type :: list of strings
1357 ;;
1358 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1359 ;; a time stamp in the output.
1360 ;; - category :: option
1361 ;; - type :: symbol (nil, t)
1362 ;;
1363 ;; + `:translate-alist' :: Alist between element and object types and
1364 ;; transcoding functions relative to the current back-end.
1365 ;; Special keys `inner-template', `template' and `plain-text' are
1366 ;; also possible.
1367 ;; - category :: option
1368 ;; - type :: alist (SYMBOL . FUNCTION)
1369 ;;
1370 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1371 ;; also be transcoded. If it is set to the `headline' symbol,
1372 ;; only the archived headline's name is retained.
1373 ;; - category :: option
1374 ;; - type :: symbol (nil, t, `headline')
1375 ;;
1376 ;; + `:with-author' :: Non-nil means author's name should be included
1377 ;; in the output.
1378 ;; - category :: option
1379 ;; - type :: symbol (nil, t)
1380 ;;
1381 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1382 ;; - category :: option
1383 ;; - type :: symbol (nil, t)
1384 ;;
1385 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1386 ;; inserted at the end of the transcoded string. If the value
1387 ;; is `comment', it should be commented.
1388 ;; - category :: option
1389 ;; - type :: symbol (`comment', nil, t)
1390 ;;
1391 ;; + `:with-date' :: Non-nil means output should contain a date.
1392 ;; - category :: option
1393 ;; - type :. symbol (nil, t)
1394 ;;
1395 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1396 ;; its value is a list of names, only drawers with such names
1397 ;; will be transcoded. If that list starts with `not', drawer
1398 ;; with these names will be skipped.
1399 ;; - category :: option
1400 ;; - type :: symbol (nil, t) or list of strings
1401 ;;
1402 ;; + `:with-email' :: Non-nil means output should contain author's
1403 ;; email.
1404 ;; - category :: option
1405 ;; - type :: symbol (nil, t)
1406 ;;
1407 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1408 ;; interpreted.
1409 ;; - category :: option
1410 ;; - type :: symbol (nil, t)
1411 ;;
1412 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1413 ;; strings starting with a colon as a fixed-with (verbatim) area.
1414 ;; - category :: option
1415 ;; - type :: symbol (nil, t)
1416 ;;
1417 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1418 ;; footnotes.
1419 ;; - category :: option
1420 ;; - type :: symbol (nil, t)
1421 ;;
1422 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1423 ;; `latex-fragment' objects should appear in export output. When
1424 ;; this property is set to `verbatim', they will be left as-is.
1425 ;; - category :: option
1426 ;; - type :: symbol (`verbatim', nil, t)
1427 ;;
1428 ;; + `:with-planning' :: Non-nil means transcoding should include
1429 ;; planning info.
1430 ;; - category :: option
1431 ;; - type :: symbol (nil, t)
1432 ;;
1433 ;; + `:with-priority' :: Non-nil means transcoding should include
1434 ;; priority cookies.
1435 ;; - category :: option
1436 ;; - type :: symbol (nil, t)
1437 ;;
1438 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1439 ;; plain text.
1440 ;; - category :: option
1441 ;; - type :: symbol (nil, t)
1442 ;;
1443 ;; + `:with-special-strings' :: Non-nil means transcoding should
1444 ;; interpret special strings in plain text.
1445 ;; - category :: option
1446 ;; - type :: symbol (nil, t)
1447 ;;
1448 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1449 ;; interpret subscript and superscript. With a value of "{}",
1450 ;; only interpret those using curly brackets.
1451 ;; - category :: option
1452 ;; - type :: symbol (nil, {}, t)
1453 ;;
1454 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1455 ;; tables.
1456 ;; - category :: option
1457 ;; - type :: symbol (nil, t)
1458 ;;
1459 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1460 ;; headlines. A `not-in-toc' value will remove them from the
1461 ;; table of contents, if any, nonetheless.
1462 ;; - category :: option
1463 ;; - type :: symbol (nil, t, `not-in-toc')
1464 ;;
1465 ;; + `:with-tasks' :: Non-nil means transcoding should include
1466 ;; headlines with a TODO keyword. A `todo' value will only
1467 ;; include headlines with a todo type keyword while a `done'
1468 ;; value will do the contrary. If a list of strings is provided,
1469 ;; only tasks with keywords belonging to that list will be kept.
1470 ;; - category :: option
1471 ;; - type :: symbol (t, todo, done, nil) or list of strings
1472 ;;
1473 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1474 ;; time stamps. Special value `active' (resp. `inactive') ask to
1475 ;; export only active (resp. inactive) timestamps. Otherwise,
1476 ;; completely remove them.
1477 ;; - category :: option
1478 ;; - type :: symbol: (`active', `inactive', t, nil)
1479 ;;
1480 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1481 ;; added to the output. An integer value limits its depth.
1482 ;; - category :: option
1483 ;; - type :: symbol (nil, t or integer)
1484 ;;
1485 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1486 ;; include TODO keywords.
1487 ;; - category :: option
1488 ;; - type :: symbol (nil, t)
1491 ;;;; Environment Options
1492 ;;
1493 ;; Environment options encompass all parameters defined outside the
1494 ;; scope of the parsed data. They come from five sources, in
1495 ;; increasing precedence order:
1496 ;;
1497 ;; - Global variables,
1498 ;; - Buffer's attributes,
1499 ;; - Options keyword symbols,
1500 ;; - Buffer keywords,
1501 ;; - Subtree properties.
1502 ;;
1503 ;; The central internal function with regards to environment options
1504 ;; is `org-export-get-environment'. It updates global variables with
1505 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1506 ;; the different sources.
1507 ;;
1508 ;; The internal functions doing the retrieval are:
1509 ;; `org-export--get-global-options',
1510 ;; `org-export--get-buffer-attributes',
1511 ;; `org-export--parse-option-keyword',
1512 ;; `org-export--get-subtree-options' and
1513 ;; `org-export--get-inbuffer-options'
1514 ;;
1515 ;; Also, `org-export--list-bound-variables' collects bound variables
1516 ;; along with their value in order to set them as buffer local
1517 ;; variables later in the process.
1520 "Collect export options from the current buffer.
1522 Optional argument BACKEND is an export back-end, as returned by
1523 `org-export-create-backend'.
1525 When optional argument SUBTREEP is non-nil, assume the export is
1526 done against the current sub-tree.
1528 Third optional argument EXT-PLIST is a property list with
1529 external parameters overriding Org default settings, but still
1530 inferior to file-local settings."
1531 ;; First install #+BIND variables since these must be set before
1532 ;; global options are read.
1535 ;; Get and prioritize export options...
1537 ;; ... from global variables...
1539 ;; ... from an external property list...
1540 ext-plist
1541 ;; ... from in-buffer settings...
1543 ;; ... and from subtree, when appropriate.
1545 ;; Eventually add misc. properties.
1547 :back-end
1548 backend
1550 :footnote-definition-alist
1551 ;; Footnotes definitions must be collected in the original
1552 ;; buffer, as there's no insurance that they will still be in
1553 ;; the parse tree, due to possible narrowing.
1567 alist))))
1568 alist))
1569 :id-alist
1570 ;; Collect id references.
1581 alist))))
1584 "Parse an OPTIONS line and return values as a plist.
1585 Optional argument BACKEND is an export back-end, as returned by,
1586 e.g., `org-export-create-backend'. It specifies which back-end
1587 specific items to read, if any."
1589 ;; Priority is given to back-end specific options.
1591 org-export-options-alist))
1592 plist)
1601 options))
1603 property
1606 plist))
1609 "Get export options in subtree at point.
1610 Optional argument BACKEND is an export back-end, as returned by,
1611 e.g., `org-export-create-backend'. It specifies back-end used
1612 for export. Return options as a plist."
1613 ;; For each buffer keyword, create a headline property setting the
1614 ;; same property in communication channel. The name for the property
1615 ;; is the keyword with "EXPORT_" appended to it.
1618 ;; Make sure point is at a heading.
1620 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1621 ;; title (with no todo keyword, priority cookie or tag) as its
1622 ;; fallback value.
1628 plist :title
1631 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1635 ;; Handle other keywords. TITLE keyword is excluded as it has
1636 ;; been handled already.
1644 ;; Export properties are not case-sensitive.
1651 plist
1652 property
1654 ;; Parse VALUE if required.
1658 ;; If BEHAVIOR is `split' expected value is
1659 ;; a list of strings, not a string.
1662 ;; Look for both general keywords and back-end specific
1663 ;; options, with priority given to the latter.
1665 org-export-options-alist)))
1666 ;; Return value.
1667 plist)))
1670 "Return current buffer export options, as a plist.
1672 Optional argument BACKEND, when non-nil, is an export back-end,
1673 as returned by, e.g., `org-export-create-backend'. It specifies
1674 which back-end specific options should also be read in the
1675 process.
1677 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1679 get-options ; For byte-compiler.
1682 ;; Priority is given to back-end specific options.
1684 org-export-options-alist))
1687 org-export-special-keywords))))
1690 ;; Return all properties associated to KEYWORD.
1697 ;; Recursively read keywords in buffer. FILES is a list
1698 ;; of files read so far. PLIST is the current property
1699 ;; list obtained.
1708 ;; Options in `org-export-special-keywords'.
1712 ;; Avoid circular dependencies.
1722 plist
1727 plist
1733 ;; Options in `org-export-options-alist'.
1738 plist property
1739 ;; Handle value depending on specified
1740 ;; BEHAVIOR.
1746 " "
1759 ;; Return final value.
1760 plist))))
1761 ;; Read options in the current buffer.
1764 ;; Parse keywords specified in `org-element-document-properties'
1765 ;; and return PLIST.
1774 ;; When TITLE keyword sets an empty
1775 ;; string, make sure it doesn't
1776 ;; appear as nil in the plist.
1780 "Return properties related to buffer attributes, as a plist."
1781 ;; Store full path of input file name, or nil. For internal use.
1787 "Return global export options as a plist.
1788 Optional argument BACKEND, if non-nil, is an export back-end, as
1789 returned by, e.g., `org-export-create-backend'. It specifies
1790 which back-end specific export options should also be read in the
1791 process."
1793 ;; Priority is given to back-end specific options.
1795 org-export-options-alist)))
1801 plist
1802 prop
1803 ;; Evaluate default value provided. If keyword is
1804 ;; a member of `org-element-document-properties',
1805 ;; parse it as a secondary string before storing it.
1809 org-element-document-properties))
1812 value)))))))))
1815 "Return variables bound from BIND keywords in current buffer.
1816 Also look for BIND keywords in setup files. The return value is
1817 an alist where associations are (VARIABLE-NAME VALUE)."
1822 ;; Return an alist between variable names and their
1823 ;; value. FILES is a list of setup files names read so
1824 ;; far, used to avoid circular dependencies. ALIST is
1825 ;; the alist collected so far.
1836 ;; Enter setup file.
1846 alist))))))))))
1847 alist)))))
1848 ;; Return value in appropriate order of appearance.
1851 ;; defsubst org-export-get-parent must be defined before first use,
1852 ;; was originally defined in the topology section
1855 "Return BLOB parent or nil.
1856 BLOB is the element or object considered."
1859 ;;;; Tree Properties
1860 ;;
1861 ;; Tree properties are information extracted from parse tree. They
1862 ;; are initialized at the beginning of the transcoding process by
1863 ;; `org-export-collect-tree-properties'.
1864 ;;
1865 ;; Dedicated functions focus on computing the value of specific tree
1866 ;; properties during initialization. Thus,
1867 ;; `org-export--populate-ignore-list' lists elements and objects that
1868 ;; should be skipped during export, `org-export--get-min-level' gets
1869 ;; the minimal exportable level, used as a basis to compute relative
1870 ;; level for headlines. Eventually
1871 ;; `org-export--collect-headline-numbering' builds an alist between
1872 ;; headlines and their numbering.
1875 "Extract tree properties from parse tree.
1877 DATA is the parse tree from which information is retrieved. INFO
1878 is a list holding export options.
1880 Following tree properties are set or updated:
1882 `:exported-data' Hash table used to memoize results from
1883 `org-export-data'.
1885 `:footnote-definition-alist' List of footnotes definitions in
1886 original buffer and current parse tree.
1888 `:headline-offset' Offset between true level of headlines and
1889 local level. An offset of -1 means a headline
1890 of level 2 should be considered as a level
1891 1 headline in the context.
1893 `:headline-numbering' Alist of all headlines as key an the
1894 associated numbering as value.
1896 `:ignore-list' List of elements that should be ignored during
1897 export.
1899 Return updated plist."
1900 ;; Install the parse tree in the communication channel, in order to
1901 ;; use `org-export-get-genealogy' and al.
1903 ;; Get the list of elements and objects to ignore, and put it into
1904 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1905 ;; been done during parse tree filtering.
1908 :ignore-list
1911 ;; Compute `:headline-offset' in order to be able to use
1912 ;; `org-export-get-relative-level'.
1915 :headline-offset
1917 ;; Update footnotes definitions list with definitions in parse tree.
1918 ;; This is required since buffer expansion might have modified
1919 ;; boundaries of footnote definitions contained in the parse tree.
1920 ;; This way, definitions in `footnote-definition-alist' are bound to
1921 ;; match those in the parse tree.
1927 defs)))
1929 ;; Properties order doesn't matter: get the rest of the tree
1930 ;; properties.
1934 info))
1937 "Return minimum exportable headline's level in DATA.
1938 DATA is parsed tree as returned by `org-element-parse-buffer'.
1939 OPTIONS is a plist holding export options."
1950 ;; If no headline was found, for the sake of consistency, set
1951 ;; minimum level to 1 nonetheless.
1955 "Return numbering of all exportable headlines in a parse tree.
1957 DATA is the parse tree. OPTIONS is the plist holding export
1958 options.
1960 Return an alist whose key is a headline and value is its
1961 associated numbering \(in the shape of a list of numbers\) or nil
1962 for a footnotes section."
1970 headline
1972 for idx from 0 to org-export-max-depth
1976 options)))
1979 "Return list of elements and objects to ignore during export.
1980 DATA is the parse tree to traverse. OPTIONS is the plist holding
1981 export options."
1983 walk-data
1984 ;; First find trees containing a select tag, if any.
1988 ;; Collect ignored elements or objects into IGNORE-LIST.
1994 ;; If headline is archived but tree below has
1995 ;; to be skipped, add it to ignore list.
1998 ;; Move into secondary string, if any.
2003 ;; Move into recursive objects/elements.
2005 ;; Main call.
2007 ;; Return value.
2008 ignore))
2011 "Return list of headlines and inlinetasks with a select tag in their tree.
2012 DATA is parsed data as returned by `org-element-parse-buffer'.
2013 INFO is a plist holding export options."
2015 walk-data ; For byte-compiler.
2025 ;; When a select tag is found, mark full
2026 ;; genealogy and every headline within the tree
2027 ;; as acceptable.
2030 genealogy
2033 selected-trees))
2034 ;; If at a headline, continue searching in tree,
2035 ;; recursively.
2045 selected-trees))
2048 "Non-nil when element or object BLOB should be skipped during export.
2049 OPTIONS is the plist holding export options. SELECTED, when
2050 non-nil, is a list of headlines or inlinetasks belonging to
2051 a tree with a select tag."
2058 ;; If `:with-drawers' value starts with `not', ignore
2059 ;; every drawer whose name belong to that list.
2060 ;; Otherwise, ignore drawers whose name isn't in that
2061 ;; list.
2077 ;; Ignore subtrees with an exclude tag.
2080 ;; When a select tag is present in the buffer, ignore any tree
2081 ;; without it.
2083 ;; Ignore commented sub-trees.
2085 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2087 ;; Ignore tasks, if specified by `:with-tasks' property.
2102 ;; `:with-timestamps' only applies to isolated timestamps
2103 ;; objects, i.e. timestamp objects in a paragraph containing only
2104 ;; timestamps and whitespaces.
2112 options t))))
2121 \f
2122 ;;; The Transcoder
2123 ;;
2124 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2125 ;; `org-element-parse-buffer') and transcodes it into a specified
2126 ;; back-end output. It takes care of filtering out elements or
2127 ;; objects according to export options and organizing the output blank
2128 ;; lines and white space are preserved. The function memoizes its
2129 ;; results, so it is cheap to call it within transcoders.
2130 ;;
2131 ;; It is possible to modify locally the back-end used by
2132 ;; `org-export-data' or even use a temporary back-end by using
2133 ;; `org-export-data-with-backend'.
2134 ;;
2135 ;; Internally, three functions handle the filtering of objects and
2136 ;; elements during the export. In particular,
2137 ;; `org-export-ignore-element' marks an element or object so future
2138 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2139 ;; elements or objects should be seen as real Org syntax and
2140 ;; `org-export-expand' transforms the others back into their original
2141 ;; shape
2142 ;;
2143 ;; `org-export-transcoder' is an accessor returning appropriate
2144 ;; translator function for a given element or object.
2147 "Return appropriate transcoder for BLOB.
2148 INFO is a plist containing export directives."
2150 ;; Return contents only for complete parse trees.
2156 "Convert DATA into current back-end format.
2158 DATA is a parse tree, an element or an object or a secondary
2159 string. INFO is a plist holding export options.
2161 Return a string."
2166 ;; Ignored element/object.
2168 ;; Plain text.
2174 info))
2175 ;; Uninterpreted element/object: change it back to Org
2176 ;; syntax and export again resulting raw string.
2180 data
2184 info))
2185 ;; Secondary string.
2188 ;; Element/Object without contents or, as a special
2189 ;; case, headline with archive tag and archived trees
2190 ;; restricted to title only.
2198 ;; Export snippets never return a nil value so
2199 ;; that white spaces following them are never
2200 ;; ignored.
2202 ;; Element/Object with contents.
2215 ;; Elements directly containing
2216 ;; objects must have their indentation
2217 ;; normalized first.
2219 data
2220 ;; When normalizing contents of the
2221 ;; first paragraph in an item or
2222 ;; a footnote definition, ignore
2223 ;; first line's indentation: there is
2224 ;; none and it might be misleading.
2229 data)
2236 info))))))))
2237 ;; Final result will be memoized before being returned.
2239 data
2243 ;; Append the same white space between elements or objects
2244 ;; as in the original buffer, and call appropriate filters.
2255 info)))
2256 results)))
2260 "Convert DATA into BACKEND format.
2262 DATA is an element, an object, a secondary string or a string.
2263 BACKEND is a symbol. INFO is a plist used as a communication
2264 channel.
2266 Unlike to `org-export-with-backend', this function will
2267 recursively convert DATA using BACKEND translation table."
2270 data
2271 ;; Set-up a new communication channel with translations defined in
2272 ;; BACKEND as the translate table and a new hash table for
2273 ;; memoization.
2275 info
2278 ;; Size of the hash table is reduced since this function
2279 ;; will probably be used on small trees.
2283 "Non-nil if element or object BLOB should be interpreted during export.
2284 If nil, BLOB will appear as raw Org syntax. Check is done
2285 according to export options INFO, stored as a plist."
2287 ;; ... entities...
2289 ;; ... emphasis...
2292 ;; ... fixed-width areas.
2294 ;; ... LaTeX environments and fragments...
2298 ;; ... sub/superscripts...
2304 ;; ... tables...
2309 "Expand a parsed element or object to its original state.
2311 BLOB is either an element or an object. CONTENTS is its
2312 contents, as a string or nil.
2314 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2315 keywords before output."
2320 blob contents))))
2323 "Add ELEMENT to `:ignore-list' in INFO.
2325 Any element in `:ignore-list' will be skipped when using
2326 `org-element-map'. INFO is modified by side effects."
2330 \f
2331 ;;; The Filter System
2332 ;;
2333 ;; Filters allow end-users to tweak easily the transcoded output.
2334 ;; They are the functional counterpart of hooks, as every filter in
2335 ;; a set is applied to the return value of the previous one.
2336 ;;
2337 ;; Every set is back-end agnostic. Although, a filter is always
2338 ;; called, in addition to the string it applies to, with the back-end
2339 ;; used as argument, so it's easy for the end-user to add back-end
2340 ;; specific filters in the set. The communication channel, as
2341 ;; a plist, is required as the third argument.
2342 ;;
2343 ;; From the developer side, filters sets can be installed in the
2344 ;; process with the help of `org-export-define-backend', which
2345 ;; internally stores filters as an alist. Each association has a key
2346 ;; among the following symbols and a function or a list of functions
2347 ;; as value.
2348 ;;
2349 ;; - `:filter-options' applies to the property list containing export
2350 ;; options. Unlike to other filters, functions in this list accept
2351 ;; two arguments instead of three: the property list containing
2352 ;; export options and the back-end. Users can set its value through
2353 ;; `org-export-filter-options-functions' variable.
2354 ;;
2355 ;; - `:filter-parse-tree' applies directly to the complete parsed
2356 ;; tree. Users can set it through
2357 ;; `org-export-filter-parse-tree-functions' variable.
2358 ;;
2359 ;; - `:filter-final-output' applies to the final transcoded string.
2360 ;; Users can set it with `org-export-filter-final-output-functions'
2361 ;; variable
2362 ;;
2363 ;; - `:filter-plain-text' applies to any string not recognized as Org
2364 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2365 ;; configure it.
2366 ;;
2367 ;; - `:filter-TYPE' applies on the string returned after an element or
2368 ;; object of type TYPE has been transcoded. A user can modify
2369 ;; `org-export-filter-TYPE-functions'
2370 ;;
2371 ;; All filters sets are applied with
2372 ;; `org-export-filter-apply-functions' function. Filters in a set are
2373 ;; applied in a LIFO fashion. It allows developers to be sure that
2374 ;; their filters will be applied first.
2375 ;;
2376 ;; Filters properties are installed in communication channel with
2377 ;; `org-export-install-filters' function.
2378 ;;
2379 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2380 ;; `org-export-before-parsing-hook') are run at the beginning of the
2381 ;; export process and just before parsing to allow for heavy structure
2382 ;; modifications.
2385 ;;;; Hooks
2388 "Hook run at the beginning of the export process.
2390 This is run before include keywords and macros are expanded and
2391 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 "Hook run before parsing an export buffer.
2401 This is run after include keywords and macros have been expanded
2402 and Babel code blocks executed, on a copy of the original buffer
2403 being exported. Visibility and narrowing are preserved. Point
2404 is at the beginning of the buffer.
2406 Every function in this hook will be called with one argument: the
2410 ;;;; Special Filters
2413 "List of functions applied to the export options.
2414 Each filter is called with two arguments: the export options, as
2415 a plist, and the back-end, as a symbol. It must return
2419 "List of functions applied to the parsed tree.
2420 Each filter is called with three arguments: the parse tree, as
2421 returned by `org-element-parse-buffer', the back-end, as
2422 a symbol, and the communication channel, as a plist. It must
2426 "List of functions applied to plain text.
2427 Each filter is called with three arguments: a string which
2428 contains no Org syntax, the back-end, as a symbol, and the
2429 communication channel, as a plist. It must return a string or
2433 "List of functions applied to the transcoded string.
2434 Each filter is called with three arguments: the full transcoded
2435 string, the back-end, as a symbol, and the communication channel,
2436 as a plist. It must return a string that will be used as the
2440 ;;;; Elements Filters
2443 "List of functions applied to a transcoded babel-call.
2444 Each filter is called with three arguments: the transcoded data,
2445 as a string, the back-end, as a symbol, and the communication
2449 "List of functions applied to a transcoded center block.
2450 Each filter is called with three arguments: the transcoded data,
2451 as a string, the back-end, as a symbol, and the communication
2455 "List of functions applied to a transcoded clock.
2456 Each filter is called with three arguments: the transcoded data,
2457 as a string, the back-end, as a symbol, and the communication
2461 "List of functions applied to a transcoded comment.
2462 Each filter is called with three arguments: the transcoded data,
2463 as a string, the back-end, as a symbol, and the communication
2467 "List of functions applied to a transcoded comment-block.
2468 Each filter is called with three arguments: the transcoded data,
2469 as a string, the back-end, as a symbol, and the communication
2473 "List of functions applied to a transcoded diary-sexp.
2474 Each filter is called with three arguments: the transcoded data,
2475 as a string, the back-end, as a symbol, and the communication
2479 "List of functions applied to a transcoded drawer.
2480 Each filter is called with three arguments: the transcoded data,
2481 as a string, the back-end, as a symbol, and the communication
2485 "List of functions applied to a transcoded dynamic-block.
2486 Each filter is called with three arguments: the transcoded data,
2487 as a string, the back-end, as a symbol, and the communication
2491 "List of functions applied to a transcoded example-block.
2492 Each filter is called with three arguments: the transcoded data,
2493 as a string, the back-end, as a symbol, and the communication
2497 "List of functions applied to a transcoded export-block.
2498 Each filter is called with three arguments: the transcoded data,
2499 as a string, the back-end, as a symbol, and the communication
2503 "List of functions applied to a transcoded fixed-width.
2504 Each filter is called with three arguments: the transcoded data,
2505 as a string, the back-end, as a symbol, and the communication
2509 "List of functions applied to a transcoded footnote-definition.
2510 Each filter is called with three arguments: the transcoded data,
2511 as a string, the back-end, as a symbol, and the communication
2515 "List of functions applied to a transcoded headline.
2516 Each filter is called with three arguments: the transcoded data,
2517 as a string, the back-end, as a symbol, and the communication
2521 "List of functions applied to a transcoded horizontal-rule.
2522 Each filter is called with three arguments: the transcoded data,
2523 as a string, the back-end, as a symbol, and the communication
2527 "List of functions applied to a transcoded inlinetask.
2528 Each filter is called with three arguments: the transcoded data,
2529 as a string, the back-end, as a symbol, and the communication
2533 "List of functions applied to a transcoded item.
2534 Each filter is called with three arguments: the transcoded data,
2535 as a string, the back-end, as a symbol, and the communication
2539 "List of functions applied to a transcoded keyword.
2540 Each filter is called with three arguments: the transcoded data,
2541 as a string, the back-end, as a symbol, and the communication
2545 "List of functions applied to a transcoded latex-environment.
2546 Each filter is called with three arguments: the transcoded data,
2547 as a string, the back-end, as a symbol, and the communication
2551 "List of functions applied to a transcoded node-property.
2552 Each filter is called with three arguments: the transcoded data,
2553 as a string, the back-end, as a symbol, and the communication
2557 "List of functions applied to a transcoded paragraph.
2558 Each filter is called with three arguments: the transcoded data,
2559 as a string, the back-end, as a symbol, and the communication
2563 "List of functions applied to a transcoded plain-list.
2564 Each filter is called with three arguments: the transcoded data,
2565 as a string, the back-end, as a symbol, and the communication
2569 "List of functions applied to a transcoded planning.
2570 Each filter is called with three arguments: the transcoded data,
2571 as a string, the back-end, as a symbol, and the communication
2575 "List of functions applied to a transcoded property-drawer.
2576 Each filter is called with three arguments: the transcoded data,
2577 as a string, the back-end, as a symbol, and the communication
2581 "List of functions applied to a transcoded quote block.
2582 Each filter is called with three arguments: the transcoded quote
2583 data, as a string, the back-end, as a symbol, and the
2584 communication channel, as a plist. It must return a string or
2588 "List of functions applied to a transcoded quote-section.
2589 Each filter is called with three arguments: the transcoded data,
2590 as a string, the back-end, as a symbol, and the communication
2594 "List of functions applied to a transcoded section.
2595 Each filter is called with three arguments: the transcoded data,
2596 as a string, the back-end, as a symbol, and the communication
2600 "List of functions applied to a transcoded special block.
2601 Each filter is called with three arguments: the transcoded data,
2602 as a string, the back-end, as a symbol, and the communication
2606 "List of functions applied to a transcoded src-block.
2607 Each filter is called with three arguments: the transcoded data,
2608 as a string, the back-end, as a symbol, and the communication
2612 "List of functions applied to a transcoded table.
2613 Each filter is called with three arguments: the transcoded data,
2614 as a string, the back-end, as a symbol, and the communication
2618 "List of functions applied to a transcoded table-cell.
2619 Each filter is called with three arguments: the transcoded data,
2620 as a string, the back-end, as a symbol, and the communication
2624 "List of functions applied to a transcoded table-row.
2625 Each filter is called with three arguments: the transcoded data,
2626 as a string, the back-end, as a symbol, and the communication
2630 "List of functions applied to a transcoded verse block.
2631 Each filter is called with three arguments: the transcoded data,
2632 as a string, the back-end, as a symbol, and the communication
2636 ;;;; Objects Filters
2639 "List of functions applied to transcoded bold text.
2640 Each filter is called with three arguments: the transcoded data,
2641 as a string, the back-end, as a symbol, and the communication
2645 "List of functions applied to transcoded code text.
2646 Each filter is called with three arguments: the transcoded data,
2647 as a string, the back-end, as a symbol, and the communication
2651 "List of functions applied to a transcoded entity.
2652 Each filter is called with three arguments: the transcoded data,
2653 as a string, the back-end, as a symbol, and the communication
2657 "List of functions applied to a transcoded export-snippet.
2658 Each filter is called with three arguments: the transcoded data,
2659 as a string, the back-end, as a symbol, and the communication
2663 "List of functions applied to a transcoded footnote-reference.
2664 Each filter is called with three arguments: the transcoded data,
2665 as a string, the back-end, as a symbol, and the communication
2669 "List of functions applied to a transcoded inline-babel-call.
2670 Each filter is called with three arguments: the transcoded data,
2671 as a string, the back-end, as a symbol, and the communication
2675 "List of functions applied to a transcoded inline-src-block.
2676 Each filter is called with three arguments: the transcoded data,
2677 as a string, the back-end, as a symbol, and the communication
2681 "List of functions applied to transcoded italic text.
2682 Each filter is called with three arguments: the transcoded data,
2683 as a string, the back-end, as a symbol, and the communication
2687 "List of functions applied to a transcoded latex-fragment.
2688 Each filter is called with three arguments: the transcoded data,
2689 as a string, the back-end, as a symbol, and the communication
2693 "List of functions applied to a transcoded line-break.
2694 Each filter is called with three arguments: the transcoded data,
2695 as a string, the back-end, as a symbol, and the communication
2699 "List of functions applied to a transcoded link.
2700 Each filter is called with three arguments: the transcoded data,
2701 as a string, the back-end, as a symbol, and the communication
2705 "List of functions applied to a transcoded radio-target.
2706 Each filter is called with three arguments: the transcoded data,
2707 as a string, the back-end, as a symbol, and the communication
2711 "List of functions applied to a transcoded statistics-cookie.
2712 Each filter is called with three arguments: the transcoded data,
2713 as a string, the back-end, as a symbol, and the communication
2717 "List of functions applied to transcoded strike-through text.
2718 Each filter is called with three arguments: the transcoded data,
2719 as a string, the back-end, as a symbol, and the communication
2723 "List of functions applied to a transcoded subscript.
2724 Each filter is called with three arguments: the transcoded data,
2725 as a string, the back-end, as a symbol, and the communication
2729 "List of functions applied to a transcoded superscript.
2730 Each filter is called with three arguments: the transcoded data,
2731 as a string, the back-end, as a symbol, and the communication
2735 "List of functions applied to a transcoded target.
2736 Each filter is called with three arguments: the transcoded data,
2737 as a string, the back-end, as a symbol, and the communication
2741 "List of functions applied to a transcoded timestamp.
2742 Each filter is called with three arguments: the transcoded data,
2743 as a string, the back-end, as a symbol, and the communication
2747 "List of functions applied to transcoded underline text.
2748 Each filter is called with three arguments: the transcoded data,
2749 as a string, the back-end, as a symbol, and the communication
2753 "List of functions applied to transcoded verbatim text.
2754 Each filter is called with three arguments: the transcoded data,
2755 as a string, the back-end, as a symbol, and the communication
2759 ;;;; Filters Tools
2760 ;;
2761 ;; Internal function `org-export-install-filters' installs filters
2762 ;; hard-coded in back-ends (developer filters) and filters from global
2763 ;; variables (user filters) in the communication channel.
2764 ;;
2765 ;; Internal function `org-export-filter-apply-functions' takes care
2766 ;; about applying each filter in order to a given data. It ignores
2767 ;; filters returning a nil value but stops whenever a filter returns
2768 ;; an empty string.
2771 "Call every function in FILTERS.
2773 Functions are called with arguments VALUE, current export
2774 back-end's name and INFO. A function returning a nil value will
2775 be skipped. If it returns the empty string, the process ends and
2776 VALUE is ignored.
2778 Call is done in a LIFO fashion, to be sure that developer
2779 specified filters, if any, are called first."
2790 "Install filters properties in communication channel.
2791 INFO is a plist containing the current communication channel.
2792 Return the updated communication channel."
2794 ;; Install user-defined filters with `org-export-filters-alist'
2795 ;; and filters already in INFO (through ext-plist mechanism).
2802 ;; Filters in INFO will be called
2803 ;; before those user provided.
2806 default-value)))))
2807 org-export-filters-alist)
2808 ;; Prepend back-end specific filters to that list.
2810 ;; Single values get consed, lists are appended.
2815 plist key
2819 ;; Return new communication channel.
2823 \f
2824 ;;; Core functions
2825 ;;
2826 ;; This is the room for the main function, `org-export-as', along with
2827 ;; its derivative, `org-export-string-as'.
2828 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2829 ;; function should be added to kill ring.
2830 ;;
2831 ;; Note that `org-export-as' doesn't really parse the current buffer,
2832 ;; but a copy of it (with the same buffer-local variables and
2833 ;; visibility), where macros and include keywords are expanded and
2834 ;; Babel blocks are executed, if appropriate.
2835 ;; `org-export-with-buffer-copy' macro prepares that copy.
2836 ;;
2837 ;; File inclusion is taken care of by
2838 ;; `org-export-expand-include-keyword' and
2839 ;; `org-export--prepare-file-contents'. Structure wise, including
2840 ;; a whole Org file in a buffer often makes little sense. For
2841 ;; example, if the file contains a headline and the include keyword
2842 ;; was within an item, the item should contain the headline. That's
2843 ;; why file inclusion should be done before any structure can be
2844 ;; associated to the file, that is before parsing.
2845 ;;
2846 ;; `org-export-insert-default-template' is a command to insert
2847 ;; a default template (or a back-end specific template) at point or in
2848 ;; current subtree.
2851 "Return a copy of the current buffer.
2852 The copy preserves Org buffer-local variables, visibility and
2853 narrowing."
2859 new-buf))
2862 "Apply BODY in a copy of the current buffer.
2863 The copy preserves local variables, visibility and contents of
2864 the original buffer. Point is at the beginning of the buffer
2865 when BODY is applied."
2874 ;; Kill copy without confirmation.
2880 "Generate a function duplicating BUFFER.
2882 The copy will preserve local variables, visibility, contents and
2883 narrowing of the original buffer. If a region was active in
2884 BUFFER, contents will be narrowed to that region instead.
2886 The resulting function can be evaluated at a later time, from
2887 another buffer, effectively cloning the original buffer there.
2889 The function assumes BUFFER's major mode is `org-mode'."
2893 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2894 ;; already in BUFFER.
2896 ;; Copy specific buffer local variables and variables set
2897 ;; through BIND keywords.
2899 vars)
2907 buffer-file-name
2908 buffer-file-coding-system))
2912 ;; Skip unreadable values, as they cannot be
2913 ;; sent to external process.
2917 vars))))))
2918 ;; Whole buffer contents.
2923 ;; Narrowing.
2927 ;; Current position of point.
2929 ;; Overlays with invisible property.
2939 ov-set))))
2941 ov-set)))))
2943 ;;;###autoload
2946 "Transcode current Org buffer into BACKEND code.
2948 BACKEND is either an export back-end, as returned by, e.g.,
2949 `org-export-create-backend', or a symbol referring to
2950 a registered back-end.
2952 If narrowing is active in the current buffer, only transcode its
2953 narrowed part.
2955 If a region is active, transcode that region.
2957 When optional argument SUBTREEP is non-nil, transcode the
2958 sub-tree at point, extracting information from the headline
2959 properties first.
2961 When optional argument VISIBLE-ONLY is non-nil, don't export
2962 contents of hidden elements.
2964 When optional argument BODY-ONLY is non-nil, only return body
2965 code, without surrounding template.
2967 Optional argument EXT-PLIST, when provided, is a property list
2968 with external parameters overriding Org default settings, but
2969 still inferior to file-local settings.
2971 Return code as a string."
2976 ;; Narrow buffer to an appropriate region or subtree for
2977 ;; parsing. If parsing subtree, be sure to remove main headline
2978 ;; too.
2986 ;; Initialize communication channel with original buffer
2987 ;; attributes, unavailable in its copy.
2996 tree)
2997 ;; Update communication channel and get parse tree. Buffer
2998 ;; isn't parsed directly. Instead, a temporary copy is
2999 ;; created, where include keywords, macros are expanded and
3000 ;; code blocks are evaluated.
3002 ;; Run first hook with current back-end's name as argument.
3006 ;; Update macro templates since #+INCLUDE keywords might have
3007 ;; added some new ones.
3011 ;; Update radio targets since keyword inclusion might have
3012 ;; added some more.
3014 ;; Run last hook with current back-end's name as argument.
3019 ;; Update communication channel with environment. Also
3020 ;; install user's and developer's filters.
3025 ;; Special case: provide original file name or buffer name as
3026 ;; default value for :title property.
3029 info :title
3033 ;; Expand export-specific set of macros: {{{author}}},
3034 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3035 ;; once regular macros have been expanded, since document
3036 ;; keywords may contain one of them.
3042 ;; EMAIL is not a parsed keyword: store it as-is.
3046 ;; Call options filters and update export options. We do not
3047 ;; use `org-export-filter-apply-functions' here since the
3048 ;; arity of such filters is different.
3053 ;; Parse buffer and call parse-tree filter on it.
3058 ;; Now tree is complete, compute its properties and add them
3059 ;; to communication channel.
3063 ;; Eventually transcode TREE. Wrap the resulting string into
3064 ;; a template.
3073 ;; Remove all text properties since they cannot be
3074 ;; retrieved from an external process. Finally call
3075 ;; final-output filter and return result.
3081 info))))))))
3083 ;;;###autoload
3085 "Transcode STRING into BACKEND code.
3087 BACKEND is either an export back-end, as returned by, e.g.,
3088 `org-export-create-backend', or a symbol referring to
3089 a registered back-end.
3091 When optional argument BODY-ONLY is non-nil, only return body
3092 code, without preamble nor postamble.
3094 Optional argument EXT-PLIST, when provided, is a property list
3095 with external parameters overriding Org default settings, but
3096 still inferior to file-local settings.
3098 Return code as a string."
3104 ;;;###autoload
3106 "Replace the active region by its export to BACKEND.
3107 BACKEND is either an export back-end, as returned by, e.g.,
3108 `org-export-create-backend', or a symbol referring to
3109 a registered back-end."
3119 ;;;###autoload
3121 "Insert all export keywords with default values at beginning of line.
3123 BACKEND is a symbol referring to the name of a registered export
3124 back-end, for which specific export options should be added to
3125 the template, or `default' for default template. When it is nil,
3126 the user will be prompted for a category.
3128 If SUBTREEP is non-nil, export configuration will be set up
3129 locally for the subtree through node properties."
3139 "Options category: "
3143 org-export--registered-backends))))))
3144 options keywords)
3145 ;; Populate OPTIONS and KEYWORDS.
3162 ;; Move to an appropriate location in order to insert options.
3164 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3165 ;; list of available keywords.
3193 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3211 ;; And the rest of keywords.
3222 "Expand every include keyword in buffer.
3223 Optional argument INCLUDED is a list of included file names along
3224 with their line restriction, when appropriate. It is used to
3225 avoid infinite recursion. Optional argument DIR is the current
3226 working directory. It is used to properly resolve relative
3227 paths."
3234 ;; Extract arguments from keyword's value.
3242 dir)
3247 value)
3253 ;; Minimal level of included file defaults to the child
3254 ;; level of the current headline, if any, or one. It
3255 ;; only applies is the file is meant to be included as
3256 ;; an Org one.
3264 ;; Remove keyword.
3270 ;; Check if files has already been parsed. Look after
3271 ;; inclusion lines too, as different parts of the same file
3272 ;; can be included too.
3284 ind-str contents ind-str))))
3292 ind-str env contents ind-str))))
3305 "Prepare the contents of FILE for inclusion and return them as a string.
3307 When optional argument LINES is a string specifying a range of
3308 lines, include only those lines.
3310 Optional argument IND, when non-nil, is an integer specifying the
3311 global indentation of returned contents. Since its purpose is to
3312 allow an included file to stay in the same environment it was
3313 created \(i.e. a list item), it doesn't apply past the first
3314 headline encountered.
3316 Optional argument MINLEVEL, when non-nil, is an integer
3317 specifying the level that any top-level headline in the included
3318 file should have."
3334 ;; Remove blank lines at beginning and end of contents. The logic
3335 ;; behind that removal is that blank lines around include keyword
3336 ;; override blank lines in included file.
3345 ;; If IND is set, preserve indentation of include keyword until
3346 ;; the first headline encountered.
3353 ;; Do not move footnote definitions out of column 0.
3359 ;; When MINLEVEL is specified, compute minimal level for headlines
3360 ;; in the file (CUR-MIN), and remove stars to each headline so
3361 ;; that headlines with minimal level have a level of MINLEVEL.
3372 ;; Only change stars, don't bother moving whole
3373 ;; sections.
3380 "Execute every Babel code in the visible part of current buffer."
3381 ;; Get a pristine copy of current buffer so Babel references can be
3382 ;; properly resolved.
3389 "Return a non-nil value when output should be added to the kill ring.
3390 See also `org-export-copy-to-kill-ring'."
3396 \f
3397 ;;; Tools For Back-Ends
3398 ;;
3399 ;; A whole set of tools is available to help build new exporters. Any
3400 ;; function general enough to have its use across many back-ends
3401 ;; should be added here.
3403 ;;;; For Affiliated Keywords
3404 ;;
3405 ;; `org-export-read-attribute' reads a property from a given element
3406 ;; as a plist. It can be used to normalize affiliated keywords'
3407 ;; syntax.
3408 ;;
3409 ;; Since captions can span over multiple lines and accept dual values,
3410 ;; their internal representation is a bit tricky. Therefore,
3411 ;; `org-export-get-caption' transparently returns a given element's
3412 ;; caption as a secondary string.
3415 "Turn ATTRIBUTE property from ELEMENT into a plist.
3417 When optional argument PROPERTY is non-nil, return the value of
3418 that property within attributes.
3422 properties.
3424 All values will become strings except the empty string and
3427 will become the empty string."
3441 s)
3446 ;; Ignore any string before first property with `cdr'.
3451 "Return caption from ELEMENT as a secondary string.
3453 When optional argument SHORTP is non-nil, return short caption,
3454 as a secondary string, instead.
3456 Caption lines are separated by a white space."
3464 ;;;; For Derived Back-ends
3465 ;;
3466 ;; `org-export-with-backend' is a function allowing to locally use
3467 ;; another back-end to transcode some object or element. In a derived
3468 ;; back-end, it may be used as a fall-back function once all specific
3469 ;; cases have been treated.
3472 "Call a transcoder from BACKEND on DATA.
3473 BACKEND is an export back-end, as returned by, e.g.,
3474 `org-export-create-backend', or a symbol referring to
3475 a registered back-end. DATA is an Org element, object, secondary
3476 string or string. CONTENTS, when non-nil, is the transcoded
3477 contents of DATA element, as a string. INFO, when non-nil, is
3478 the communication channel used for export, as a plist."
3488 transcoder data contents
3491 :translate-alist all-transcoders
3495 ;;;; For Export Snippets
3496 ;;
3497 ;; Every export snippet is transmitted to the back-end. Though, the
3498 ;; latter will only retain one type of export-snippet, ignoring
3499 ;; others, based on the former's target back-end. The function
3500 ;; `org-export-snippet-backend' returns that back-end for a given
3501 ;; export-snippet.
3504 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3505 Translation, with `org-export-snippet-translation-alist', is
3506 applied."
3510 back-end))))
3513 ;;;; For Footnotes
3514 ;;
3515 ;; `org-export-collect-footnote-definitions' is a tool to list
3516 ;; actually used footnotes definitions in the whole parse tree, or in
3517 ;; a headline, in order to add footnote listings throughout the
3518 ;; transcoded data.
3519 ;;
3520 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3521 ;; back-ends, when they need to attach the footnote definition only to
3522 ;; the first occurrence of the corresponding label.
3523 ;;
3524 ;; `org-export-get-footnote-definition' and
3525 ;; `org-export-get-footnote-number' provide easier access to
3526 ;; additional information relative to a footnote reference.
3529 "Return an alist between footnote numbers, labels and definitions.
3531 DATA is the parse tree from which definitions are collected.
3532 INFO is the plist used as a communication channel.
3534 Definitions are sorted by order of references. They either
3535 appear as Org data or as a secondary string for inlined
3536 footnotes. Unreferenced definitions are ignored."
3538 collect-fn ; for byte-compiler.
3542 ;; Collect footnote number, label and definition in DATA.
3550 def)
3551 num-alist)
3552 ;; Also search in definition for nested footnotes.
3555 ;; Don't enter footnote definitions since it will happen
3556 ;; when their first reference is found.
3562 "Non-nil when a footnote reference is the first one for its label.
3564 FOOTNOTE-REFERENCE is the footnote reference being considered.
3565 INFO is the plist used as a communication channel."
3567 ;; Anonymous footnotes are always a first reference.
3569 ;; Otherwise, return the first footnote with the same LABEL and
3570 ;; test if it is equal to FOOTNOTE-REFERENCE.
3580 ;; If FN isn't inlined, be sure to traverse its
3581 ;; definition before resuming search. See
3582 ;; comments in `org-export-get-footnote-number'
3583 ;; for more information.
3587 ;; Don't enter footnote definitions since it will
3588 ;; happen when their first reference is found.
3591 footnote-reference)))))
3594 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3595 INFO is the plist used as a communication channel. If no such
3597 string."
3604 "Return number associated to a footnote.
3606 FOOTNOTE is either a footnote reference or a footnote definition.
3607 INFO is the plist used as a communication channel."
3609 seen-refs
3610 search-ref ; For byte-compiler.
3614 ;; Search footnote references through DATA, filling
3615 ;; SEEN-REFS along the way.
3620 ;; Anonymous footnote match: return number.
3623 ;; Labels match: return number.
3626 ;; Anonymous footnote: it's always a new one.
3627 ;; Also, be sure to return nil from the `cond' so
3628 ;; `first-match' doesn't get us out of the loop.
3630 ;; Label not seen so far: add it so SEEN-REFS.
3631 ;;
3632 ;; Also search for subsequent references in
3633 ;; footnote definition so numbering follows
3634 ;; reading logic. Note that we don't have to care
3635 ;; about inline definitions, since
3636 ;; `org-element-map' already traverses them at the
3637 ;; right time.
3638 ;;
3639 ;; Once again, return nil to stay in the loop.
3644 nil))))
3645 ;; Don't enter footnote definitions since it will
3646 ;; happen when their first reference is found.
3651 ;;;; For Headlines
3652 ;;
3653 ;; `org-export-get-relative-level' is a shortcut to get headline
3654 ;; level, relatively to the lower headline level in the parsed tree.
3655 ;;
3656 ;; `org-export-get-headline-number' returns the section number of an
3657 ;; headline, while `org-export-number-to-roman' allows to convert it
3658 ;; to roman numbers.
3659 ;;
3660 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3661 ;; `org-export-last-sibling-p' are three useful predicates when it
3662 ;; comes to fulfill the `:headline-levels' property.
3663 ;;
3664 ;; `org-export-get-tags', `org-export-get-category' and
3665 ;; `org-export-get-node-property' extract useful information from an
3666 ;; headline or a parent headline. They all handle inheritance.
3667 ;;
3668 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3669 ;; as a secondary string, suitable for table of contents. It falls
3670 ;; back onto default title.
3673 "Return HEADLINE relative level within current parsed tree.
3674 INFO is a plist holding contextual information."
3679 "Non-nil when HEADLINE is considered as low level.
3681 INFO is a plist used as a communication channel.
3683 A low level headlines has a relative level greater than
3684 `:headline-levels' property value.
3686 Return value is the difference between HEADLINE relative level
3687 and the last level being considered as high enough, or nil."
3694 "Return HEADLINE numbering as a list of numbers.
3695 INFO is a plist holding contextual information."
3699 "Return a non-nil value if HEADLINE element should be numbered.
3700 INFO is a plist used as a communication channel."
3706 "Convert integer N into a roman numeral."
3719 res)))
3722 "Return list of tags associated to ELEMENT.
3724 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3725 is a plist used as a communication channel.
3727 Select tags (see `org-export-select-tags') and exclude tags (see
3728 `org-export-exclude-tags') are removed from the list.
3730 When non-nil, optional argument TAGS should be a list of strings.
3731 Any tag belonging to this list will also be removed.
3733 When optional argument INHERITED is non-nil, tags can also be
3734 inherited from parent headlines and FILETAGS keywords."
3740 ;; Build complete list of inherited tags.
3751 ;; Add FILETAGS keywords and return results.
3755 "Return node PROPERTY value for BLOB.
3757 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3758 element or object.
3760 If optional argument INHERITED is non-nil, the value can be
3761 inherited from a parent headline.
3763 Return value is a string or nil."
3775 "Return category for element or object BLOB.
3777 INFO is a plist used as a communication channel.
3779 CATEGORY is automatically inherited from a parent headline, from
3780 #+CATEGORY: keyword or created out of original file name. If all
3784 ;; Almost like `org-export-node-property', but we cannot trust
3785 ;; `plist-member' as every headline has a `:CATEGORY'
3786 ;; property, would it be nil or equal to "???" (which has the
3787 ;; same meaning).
3805 "Return alternative title for HEADLINE, as a secondary string.
3806 INFO is a plist used as a communication channel. If no optional
3807 title is defined, fall-back to the regular title."
3812 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3813 INFO is a plist used as a communication channel."
3818 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3819 INFO is a plist used as a communication channel."
3823 ;;;; For Keywords
3824 ;;
3825 ;; `org-export-get-date' returns a date appropriate for the document
3826 ;; to about to be exported. In particular, it takes care of
3827 ;; `org-export-date-timestamp-format'.
3830 "Return date value for the current document.
3832 INFO is a plist used as a communication channel. FMT, when
3833 non-nil, is a time format string that will be applied on the date
3834 if it consists in a single timestamp object. It defaults to
3835 `org-export-date-timestamp-format' when nil.
3837 A proper date can be a secondary string, a string or nil. It is
3838 meant to be translated with `org-export-data' or alike."
3849 ;;;; For Links
3850 ;;
3851 ;; `org-export-solidify-link-text' turns a string into a safer version
3852 ;; for links, replacing most non-standard characters with hyphens.
3853 ;;
3854 ;; `org-export-get-coderef-format' returns an appropriate format
3855 ;; string for coderefs.
3856 ;;
3857 ;; `org-export-inline-image-p' returns a non-nil value when the link
3858 ;; provided should be considered as an inline image.
3859 ;;
3860 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3861 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3862 ;; returns an appropriate unique identifier when found, or nil.
3863 ;;
3864 ;; `org-export-resolve-id-link' returns the first headline with
3865 ;; specified id or custom-id in parse tree, the path to the external
3866 ;; file with the id or nil when neither was found.
3867 ;;
3868 ;; `org-export-resolve-coderef' associates a reference to a line
3869 ;; number in the element it belongs, or returns the reference itself
3870 ;; when the element isn't numbered.
3873 "Take link text S and make a safe target out of it."
3878 "Return format string for code reference link.
3879 PATH is the link path. DESC is its description."
3887 "Non-nil if LINK object points to an inline image.
3889 Optional argument is a set of RULES defining inline images. It
3890 is an alist where associations have the following shape:
3892 \(TYPE . REGEXP)
3894 Applying a rule means apply REGEXP against LINK's path when its
3895 type is TYPE. The function will return a non-nil value if any of
3896 the provided rules is non-nil. The default rule is
3897 `org-export-default-inline-image-rule'.
3899 This only applies to links without a description."
3910 rules)
3911 ;; Return nil if no rule matched.
3912 nil))))
3915 "Resolve a code reference REF.
3917 INFO is a plist used as a communication channel.
3919 Return associated line number in source code, or REF itself,
3920 depending on src-block or example element's switches."
3927 org-coderef-label-format)))
3931 ;; Element containing REF is found. Resolve it to either
3932 ;; a label or a line number, as needed.
3942 "Return LINK destination.
3944 INFO is a plist holding contextual information.
3946 Return value can be an object, an element, or nil:
3948 - If LINK path matches a target object (i.e. <<path>>) return it.
3950 - If LINK path exactly matches the name affiliated keyword
3951 \(i.e. #+NAME: path) of an element, return that element.
3953 - If LINK path exactly matches any headline name, return that
3954 element. If more than one headline share that name, priority
3955 will be given to the one with the closest common ancestor, if
3956 any, or the first one in the parse tree otherwise.
3958 - Otherwise, return nil.
3961 significant."
3964 ;; Split PATH at white spaces so matches are space
3965 ;; insensitive.
3968 ;; Cache for destinations that are not position dependent.
3976 ;; Destination is not position dependent: use cached value.
3978 ;; First try to find a matching "<<path>>" unless user specified
3979 ;; he was looking for a headline (path starts with a "*"
3980 ;; character).
3986 path)
3987 blob))
3990 ;; Then try to find an element with a matching "#+NAME: path"
3991 ;; affiliated keyword.
3994 org-element-all-elements
3999 el)))
4002 ;; Last case: link either points to a headline or to nothingness.
4003 ;; Try to find the source, with priority given to headlines with
4004 ;; the closest common ancestor. If such candidate is found,
4005 ;; return it, otherwise return nil.
4009 ;; Return first headline whose `:raw-value' property is
4010 ;; NAME in parse tree DATA, or nil. Statistics cookies
4011 ;; are ignored.
4019 name)
4020 headline))
4022 ;; Search among headlines sharing an ancestor with link, from
4023 ;; closest to farthest.
4032 ;; No destination found: return nil.
4036 "Return headline referenced as LINK destination.
4038 INFO is a plist used as a communication channel.
4040 Return value can be the headline element matched in current parse
4044 ;; First check if id is within the current parse tree.
4049 headline))
4051 ;; Otherwise, look for external files.
4055 "Return radio-target object referenced as LINK destination.
4057 INFO is a plist used as a communication channel.
4059 Return value can be a radio-target object or nil. Assume LINK
4068 nil nil path nil nil t)
4069 t)
4070 radio))
4074 ;;;; For References
4075 ;;
4076 ;; `org-export-get-ordinal' associates a sequence number to any object
4077 ;; or element.
4080 "Return ordinal number of an element or object.
4082 ELEMENT is the element or object considered. INFO is the plist
4083 used as a communication channel.
4085 Optional argument TYPES, when non-nil, is a list of element or
4086 object types, as symbols, that should also be counted in.
4087 Otherwise, only provided element's type is considered.
4089 Optional argument PREDICATE is a function returning a non-nil
4090 value if the current element or object should be counted in. It
4091 accepts two arguments: the element or object being considered and
4092 the plist used as a communication channel. This allows to count
4093 only a certain type of objects (i.e. inline images).
4095 Return value is a list of numbers if ELEMENT is a headline or an
4096 item. It is nil for keywords. It represents the footnote number
4097 for footnote definitions and footnote references. If ELEMENT is
4098 a target, return the same value as if ELEMENT was the closest
4099 table, item or headline containing the target. In any other
4100 case, return the sequence number of ELEMENT among elements or
4101 objects of the same type."
4102 ;; Ordinal of a target object refer to the ordinal of the closest
4103 ;; table, item, or headline containing the object.
4107 when
4111 table))
4112 return parent)))
4114 ;; Special case 1: A headline returns its number as a list.
4116 ;; Special case 2: An item returns its number as a list.
4120 struct
4127 ;; Increment counter until ELEMENT is found again.
4138 ;;;; For Src-Blocks
4139 ;;
4140 ;; `org-export-get-loc' counts number of code lines accumulated in
4141 ;; src-block or example-block elements with a "+n" switch until
4142 ;; a given element, excluded. Note: "-n" switches reset that count.
4143 ;;
4144 ;; `org-export-unravel-code' extracts source code (along with a code
4145 ;; references alist) from an `element-block' or `src-block' type
4146 ;; element.
4147 ;;
4148 ;; `org-export-format-code' applies a formatting function to each line
4149 ;; of code, providing relative line number and code reference when
4150 ;; appropriate. Since it doesn't access the original element from
4151 ;; which the source code is coming, it expects from the code calling
4152 ;; it to know if lines should be numbered and if code references
4153 ;; should appear.
4154 ;;
4155 ;; Eventually, `org-export-format-code-default' is a higher-level
4156 ;; function (it makes use of the two previous functions) which handles
4157 ;; line numbering and code references inclusion, and returns source
4158 ;; code in a format suitable for plain text or verbatim output.
4161 "Return accumulated lines of code up to ELEMENT.
4163 INFO is the plist used as a communication channel.
4165 ELEMENT is excluded from count."
4171 ;; ELEMENT is reached: Quit the loop.
4173 ;; Only count lines from src-block and example-block elements
4174 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4178 ;; Accumulate locs or reset them.
4182 ;; Return nil to stay in the loop.
4183 nil)))
4185 ;; Return value.
4186 loc))
4189 "Clean source code and extract references out of it.
4191 ELEMENT has either a `src-block' an `example-block' type.
4193 Return a cons cell whose CAR is the source code, cleaned from any
4194 reference and protective comma and CDR is an alist between
4195 relative line number (integer) and name of code reference on that
4196 line (string)."
4198 ;; Get code and clean it. Remove blank lines at its
4199 ;; beginning and end.
4205 ;; Get format used for references.
4208 org-coderef-label-format)))
4209 ;; Build a regexp matching a loc with a reference.
4214 ;; Return value.
4216 ;; Code with references removed.
4222 ;; Ref line: remove ref, and signal its position in REFS.
4226 ;; Reference alist.
4227 refs)))
4230 "Format CODE by applying FUN line-wise and return it.
4232 CODE is a string representing the code to format. FUN is
4233 a function. It must accept three arguments: a line of
4234 code (string), the current line number (integer) or nil and the
4235 reference associated to the current line (string) or nil.
4237 Optional argument NUM-LINES can be an integer representing the
4238 number of code lines accumulated until the current code. Line
4239 numbers passed to FUN will take it into account. If it is nil,
4240 FUN's second argument will always be nil. This number can be
4241 obtained with `org-export-get-loc' function.
4243 Optional argument REF-ALIST can be an alist between relative line
4244 number (i.e. ignoring NUM-LINES) and the name of the code
4245 reference on it. If it is nil, FUN's third argument will always
4246 be nil. It can be obtained through the use of
4247 `org-export-unravel-code' function."
4259 "Return source code from ELEMENT, formatted in a standard way.
4261 ELEMENT is either a `src-block' or `example-block' element. INFO
4262 is a plist used as a communication channel.
4264 This function takes care of line numbering and code references
4265 inclusion. Line numbers, when applicable, appear at the
4266 beginning of the line, separated from the code by two white
4267 spaces. Code references, on the other hand, appear flushed to
4268 the right, separated by six white spaces from the widest line of
4269 code."
4270 ;; Extract code and references.
4277 ;; Handle line numbering.
4286 ;; Prepare references display, if required. Any reference
4287 ;; should start six columns after the widest line of code,
4288 ;; wrapped with parenthesis.
4293 code
4297 number-str
4298 loc
4304 num-start refs)))))
4307 ;;;; For Tables
4308 ;;
4309 ;; `org-export-table-has-special-column-p' and and
4310 ;; `org-export-table-row-is-special-p' are predicates used to look for
4311 ;; meta-information about the table structure.
4312 ;;
4313 ;; `org-table-has-header-p' tells when the rows before the first rule
4314 ;; should be considered as table's header.
4315 ;;
4316 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4317 ;; and `org-export-table-cell-borders' extract information from
4318 ;; a table-cell element.
4319 ;;
4320 ;; `org-export-table-dimensions' gives the number on rows and columns
4321 ;; in the table, ignoring horizontal rules and special columns.
4322 ;; `org-export-table-cell-address', given a table-cell object, returns
4323 ;; the absolute address of a cell. On the other hand,
4324 ;; `org-export-get-table-cell-at' does the contrary.
4325 ;;
4326 ;; `org-export-table-cell-starts-colgroup-p',
4327 ;; `org-export-table-cell-ends-colgroup-p',
4328 ;; `org-export-table-row-starts-rowgroup-p',
4329 ;; `org-export-table-row-ends-rowgroup-p',
4330 ;; `org-export-table-row-starts-header-p' and
4331 ;; `org-export-table-row-ends-header-p' indicate position of current
4332 ;; row or cell within the table.
4335 "Non-nil when TABLE has a special column.
4336 All special columns will be ignored during export."
4337 ;; The table has a special column when every first cell of every row
4338 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4339 ;; "*" "_" and "^". Though, do not consider a first row containing
4340 ;; only empty cells as special.
4356 "Non-nil when TABLE has a header.
4358 INFO is a plist used as a communication channel.
4360 A table has a header when it contains at least two row groups."
4369 table
4380 cache)))))
4383 "Non-nil if TABLE-ROW is considered special.
4385 INFO is a plist used as the communication channel.
4387 All special rows will be ignored during export."
4391 ;; A row is special either when...
4393 ;; ... it starts with a field only containing "/",
4395 ;; ... the table contains a special column and the row start
4396 ;; with a marking character among, "^", "_", "$" or "!",
4400 ;; ... it contains only alignment cookies and empty cells.
4406 ;; Since VALUE is a secondary string, the following
4407 ;; checks avoid expanding it with `org-export-data'.
4419 "Return TABLE-ROW's group number, as an integer.
4421 INFO is a plist used as the communication channel.
4423 Return value is the group number, as an integer, or nil for
4424 special rows and rows separators. First group is also table's
4425 header."
4443 "Return TABLE-CELL contents width.
4445 INFO is a plist used as the communication channel.
4447 Return value is the width given by the last width cookie in the
4448 same column as TABLE-CELL, or nil."
4467 ;; In a special row, try to find a width cookie at COLUMN.
4471 ;; The following checks avoid expanding unnecessarily
4472 ;; the cell with `org-export-data'.
4482 "Return TABLE-CELL contents alignment.
4484 INFO is a plist used as the communication channel.
4486 Return alignment as specified by the last alignment cookie in the
4487 same column as TABLE-CELL. If no such cookie is found, a default
4488 alignment value will be deduced from fraction of numbers in the
4489 column (see `org-table-number-fraction' for more information).
4490 Possible values are `left', `right' and `center'."
4491 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4508 cookie-align
4509 previous-cell-number-p)
4512 ;; In a special row, try to find an alignment cookie at
4513 ;; COLUMN.
4517 ;; Since VALUE is a secondary string, the following
4518 ;; checks avoid useless expansion through
4519 ;; `org-export-data'.
4527 ;; Ignore table rules.
4529 ;; In a standard row, check if cell's contents are
4530 ;; expressing some kind of number. Increase NUMBER-CELLS
4531 ;; accordingly. Though, don't bother if an alignment
4532 ;; cookie has already defined cell's alignment.
4537 info)))
4539 ;; Treat an empty cell as a number if it follows
4540 ;; a number.
4546 ;; Return value. Alignment specified by cookies has
4547 ;; precedence over alignment deduced from cell's contents.
4549 column
4554 org-table-number-fraction)
4559 "Return TABLE-CELL borders.
4561 INFO is a plist used as a communication channel.
4563 Return value is a list of symbols, or nil. Possible values are:
4564 `top', `bottom', `above', `below', `left' and `right'. Note:
4565 `top' (resp. `bottom') only happen for a cell in the first
4566 row (resp. last row) of the table, ignoring table rules, if any.
4568 Returned borders ignore special rows."
4571 borders)
4572 ;; Top/above border? TABLE-CELL has a border above when a rule
4573 ;; used to demarcate row groups can be found above. Hence,
4574 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4575 ;; another regular row has to be found above that rule.
4584 ;; Look at every row before the current one.
4586 ;; No rule above, or rule found starts the table (ignoring any
4587 ;; special row): TABLE-CELL is at the top of the table.
4590 ;; Bottom/below border? TABLE-CELL has a border below when next
4591 ;; non-regular row below is a rule.
4600 ;; Look at every row after the current one.
4602 ;; No rule below, or rule found ends the table (modulo some
4603 ;; special row): TABLE-CELL is at the bottom of the table.
4606 ;; Right/left borders? They can only be specified by column
4607 ;; groups. Column groups are defined in a row starting with "/".
4608 ;; Also a column groups row only contains "<", "<>", ">" or blank
4609 ;; cells.
4626 ;; There's a left border when previous cell, if
4627 ;; any, ends a group, or current one starts one.
4633 ;; There's a right border when next cell, if any,
4634 ;; starts a group, or current one ends one.
4641 ;; Table rows are read in reverse order so last column groups
4642 ;; row has precedence over any previous one.
4644 ;; Return value.
4645 borders))
4648 "Non-nil when TABLE-CELL is at the beginning of a row group.
4649 INFO is a plist used as a communication channel."
4650 ;; A cell starts a column group either when it is at the beginning
4651 ;; of a row (or after the special column, if any) or when it has
4652 ;; a left border.
4655 table-cell)
4659 "Non-nil when TABLE-CELL is at the end of a row group.
4660 INFO is a plist used as a communication channel."
4661 ;; A cell ends a column group either when it is at the end of a row
4662 ;; or when it has a right border.
4665 table-cell)
4669 "Non-nil when TABLE-ROW is at the beginning of a column group.
4670 INFO is a plist used as a communication channel."
4678 "Non-nil when TABLE-ROW is at the end of a column group.
4679 INFO is a plist used as a communication channel."
4687 "Non-nil when TABLE-ROW is the first table header's row.
4688 INFO is a plist used as a communication channel."
4695 "Non-nil when TABLE-ROW is the last table header's row.
4696 INFO is a plist used as a communication channel."
4703 "Return TABLE-ROW number.
4704 INFO is a plist used as a communication channel. Return value is
4705 zero-based and ignores separators. The function returns nil for
4706 special columns and separators."
4718 "Return TABLE dimensions.
4720 INFO is a plist used as a communication channel.
4722 Return value is a CONS like (ROWS . COLUMNS) where
4723 ROWS (resp. COLUMNS) is the number of exportable
4724 rows (resp. columns)."
4726 ;; Set number of rows, and extract first one.
4732 ;; Set number of columns.
4734 ;; Return value.
4738 "Return address of a regular TABLE-CELL object.
4740 TABLE-CELL is the cell considered. INFO is a plist used as
4741 a communication channel.
4743 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4744 zero-based index. Only exportable cells are considered. The
4745 function returns nil for other cells."
4757 "Return regular table-cell object at ADDRESS in TABLE.
4759 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4760 zero-based index. TABLE is a table type element. INFO is
4761 a plist used as a communication channel.
4763 If no table-cell, among exportable cells, is found at ADDRESS,
4764 return nil."
4767 ;; Row at (car address) or nil.
4775 'table-cell
4782 ;;;; For Tables Of Contents
4783 ;;
4784 ;; `org-export-collect-headlines' builds a list of all exportable
4785 ;; headline elements, maybe limited to a certain depth. One can then
4786 ;; easily parse it and transcode it.
4787 ;;
4788 ;; Building lists of tables, figures or listings is quite similar.
4789 ;; Once the generic function `org-export-collect-elements' is defined,
4790 ;; `org-export-collect-tables', `org-export-collect-figures' and
4791 ;; `org-export-collect-listings' can be derived from it.
4794 "Collect headlines in order to build a table of contents.
4796 INFO is a plist used as a communication channel.
4798 When optional argument N is an integer, it specifies the depth of
4799 the table of contents. Otherwise, it is set to the value of the
4800 last headline level. See `org-export-headline-levels' for more
4801 information.
4803 Return a list of all exportable headlines as parsed elements.
4804 Footnote sections, if any, will be ignored."
4812 info)))
4815 "Collect referenceable elements of a determined type.
4817 TYPE can be a symbol or a list of symbols specifying element
4818 types to search. Only elements with a caption are collected.
4820 INFO is a plist used as a communication channel.
4822 When non-nil, optional argument PREDICATE is a function accepting
4823 one argument, an element of type TYPE. It returns a non-nil
4824 value when that element should be collected.
4826 Return a list of all elements found, in order of appearance."
4831 element))
4832 info))
4835 "Build a list of tables.
4836 INFO is a plist used as a communication channel.
4838 Return a list of table elements with a caption."
4842 "Build a list of figures.
4844 INFO is a plist used as a communication channel. PREDICATE is
4845 a function which accepts one argument: a paragraph element and
4846 whose return value is non-nil when that element should be
4847 collected.
4849 A figure is a paragraph type element, with a caption, verifying
4851 a vague concept that may depend on back-end.
4853 Return a list of elements recognized as figures."
4857 "Build a list of src blocks.
4859 INFO is a plist used as a communication channel.
4861 Return a list of src-block elements with a caption."
4865 ;;;; Smart Quotes
4866 ;;
4867 ;; The main function for the smart quotes sub-system is
4868 ;; `org-export-activate-smart-quotes', which replaces every quote in
4869 ;; a given string from the parse tree with its "smart" counterpart.
4870 ;;
4871 ;; Dictionary for smart quotes is stored in
4872 ;; `org-export-smart-quotes-alist'.
4873 ;;
4874 ;; Internally, regexps matching potential smart quotes (checks at
4875 ;; string boundaries are also necessary) are defined in
4876 ;; `org-export-smart-quotes-regexps'.
4880 ;; one may use: »...«, "...", ›...‹, or '...'.
4881 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4882 ;; LaTeX quotes require Babel!
4927 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4936 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4945 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4954 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4960 )
4961 "Smart quotes translations.
4963 Alist whose CAR is a language string and CDR is an alist with
4964 quote type as key and a plist associating various encodings to
4965 their translation as value.
4967 A quote type can be any symbol among `opening-double-quote',
4968 `closing-double-quote', `opening-single-quote',
4969 `closing-single-quote' and `apostrophe'.
4971 Valid encodings include `:utf-8', `:html', `:latex' and
4972 `:texinfo'.
4978 ;; Possible opening quote at beginning of string.
4980 ;; Possible closing quote at beginning of string.
4982 ;; Possible apostrophe at beginning of string.
4984 ;; Opening single and double quotes.
4986 ;; Closing single and double quotes.
4988 ;; Apostrophe.
4990 ;; Possible opening quote at end of string.
4992 ;; Possible closing quote at end of string.
4994 ;; Possible apostrophe at end of string.
4996 "List of regexps matching a quote or an apostrophe.
5002 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5003 `:utf-8'. INFO is a plist used as a communication channel.
5005 The function has to retrieve information about string
5006 surroundings in parse tree. It can only happen with an
5007 unmodified string. Thus, if S has already been through another
5008 process, a non-nil ORIGINAL optional argument will provide that
5009 original string.
5011 Return the new string."
5014 ;; Try to be flexible when computing number of blanks
5015 ;; before object. The previous object may be a string
5016 ;; introduced by the back-end and not completely parsed.
5019 ;; A string with missing `:post-blank'
5020 ;; property.
5024 ;; Fallback value.
5029 ;; Return smart quote associated to a give quote Q, as
5030 ;; a string. TYPE is a symbol among `open', `close' and
5031 ;; `apostrophe'.
5041 org-export-smart-quotes-alist))))
5042 encoding)
5043 q)))))
5045 ;; Only a quote: no regexp can match. We have to check both
5046 ;; sides and decide what to do.
5054 ;; 1. Replace quote character at the beginning of S.
5056 ;; Apostrophe?
5062 ;; Closing quote?
5068 ;; Opening quote?
5074 ;; 2. Replace quotes in the middle of the string.
5076 ;; Opening quotes.
5082 ;; Closing quotes.
5088 ;; Apostrophes.
5093 ;; 3. Replace quote character at the end of S.
5095 ;; Apostrophe?
5100 ;; Closing quote?
5106 ;; Opening quote?
5111 ;; Return string with smart quotes.
5112 s))))
5114 ;;;; Topology
5115 ;;
5116 ;; Here are various functions to retrieve information about the
5117 ;; neighborhood of a given element or object. Neighbors of interest
5118 ;; are direct parent (`org-export-get-parent'), parent headline
5119 ;; (`org-export-get-parent-headline'), first element containing an
5120 ;; object, (`org-export-get-parent-element'), parent table
5121 ;; (`org-export-get-parent-table'), previous element or object
5122 ;; (`org-export-get-previous-element') and next element or object
5123 ;; (`org-export-get-next-element').
5124 ;;
5125 ;; `org-export-get-genealogy' returns the full genealogy of a given
5126 ;; element or object, from closest parent to full parse tree.
5128 ;; defsubst org-export-get-parent must be defined before first use
5130 "Return full genealogy relative to a given element or object.
5132 BLOB is the element or object being considered.
5134 Ancestors are returned from closest to farthest, the last one
5135 being the full parse tree."
5142 "Return BLOB parent headline or nil.
5143 BLOB is the element or object being considered."
5147 parent))
5150 "Return first element containing OBJECT or nil.
5151 OBJECT is the object to consider."
5155 parent))
5158 "Return OBJECT parent table or nil.
5159 OBJECT is either a `table-cell' or `table-element' type object."
5163 parent))
5166 "Return previous element or object.
5168 BLOB is an element or object. INFO is a plist used as
5169 a communication channel. Return previous exportable element or
5170 object, a string, or nil.
5172 When optional argument N is a positive integer, return a list
5173 containing up to N siblings before BLOB, from farthest to
5174 closest. With any other non-nil value, return a list containing
5175 all of them."
5177 ;; An object can belong to the contents of its parent or
5178 ;; to a secondary string. We check the latter option
5179 ;; first.
5183 org-element-secondary-value-alist))
5184 parent)))
5187 prev)
5196 prev)))
5199 "Return next element or object.
5201 BLOB is an element or object. INFO is a plist used as
5202 a communication channel. Return next exportable element or
5203 object, a string, or nil.
5205 When optional argument N is a positive integer, return a list
5206 containing up to N siblings after BLOB, from closest to farthest.
5207 With any other non-nil value, return a list containing all of
5208 them."
5210 ;; An object can belong to the contents of its parent or to
5211 ;; a secondary string. We check the latter option first.
5215 org-element-secondary-value-alist))
5216 parent)))
5219 next)
5227 siblings)
5231 ;;;; Translation
5232 ;;
5233 ;; `org-export-translate' translates a string according to the language
5234 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5235 ;; the dictionary used for the translation.
5419 "Dictionary for export engine.
5421 Alist whose CAR is the string to translate and CDR is an alist
5422 whose CAR is the language string and CDR is a plist whose
5423 properties are possible charsets and values translated terms.
5425 It is used as a database for `org-export-translate'. Since this
5426 function returns the string as-is if no translation was found,
5427 the variable only needs to record values different from the
5431 "Translate string S according to language specification.
5433 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5434 and `:utf-8'. INFO is a plist used as a communication channel.
5436 Translation depends on `:language' property. Return the
5437 translated string. If no translation is found, try to fall back
5438 to `:default' encoding. If it fails, return S."
5444 s)))
5447 \f
5448 ;;; Asynchronous Export
5449 ;;
5450 ;; `org-export-async-start' is the entry point for asynchronous
5451 ;; export. It recreates current buffer (including visibility,
5452 ;; narrowing and visited file) in an external Emacs process, and
5453 ;; evaluates a command there. It then applies a function on the
5454 ;; returned results in the current process.
5455 ;;
5456 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5457 ;; allow to export to a buffer or a file, asynchronously or not.
5458 ;;
5459 ;; `org-export-output-file-name' is an auxiliary function meant to be
5460 ;; used with `org-export-to-file'. With a given extension, it tries
5461 ;; to provide a canonical file name to write export output to.
5462 ;;
5463 ;; Asynchronously generated results are never displayed directly.
5464 ;; Instead, they are stored in `org-export-stack-contents'. They can
5465 ;; then be retrieved by calling `org-export-stack'.
5466 ;;
5467 ;; Export Stack is viewed through a dedicated major mode
5468 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5469 ;;`org-export-stack-delete', `org-export-stack-view' and
5470 ;;`org-export-stack-clear'.
5471 ;;
5472 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5473 ;; It should be used whenever `org-export-async-start' is called.
5476 "Call function FUN on the results returned by BODY evaluation.
5478 BODY evaluation happens in an asynchronous process, from a buffer
5479 which is an exact copy of the current one.
5481 Use `org-export-add-to-stack' in FUN in order to register results
5482 in the stack.
5484 This is a low level function. See also `org-export-to-buffer'
5485 and `org-export-to-file' for more specialized functions."
5488 ;; Write the full sexp evaluating BODY in a copy of the current
5489 ;; buffer to a temporary file, as it may be too long for program
5490 ;; args in `start-process'.
5497 ;; Null characters (from variable values) are inserted
5498 ;; within the file. As a consequence, coding system for
5499 ;; buffer contents will not be recognized properly. So,
5500 ;; we make sure it is the same as the one used to display
5501 ;; the original buffer.
5503 ,coding
5506 ;; Ignore `kill-emacs-hook' and code evaluation
5507 ;; queries from Babel as we need a truly
5508 ;; non-interactive process.
5510 org-babel-confirm-evaluate-answer-no t)
5511 ;; Initialize export framework.
5513 ;; Re-create current buffer there.
5516 ;; Sexp to evaluate in the buffer.
5518 ;; Start external process.
5521 (,process
5526 "-l" org-export-async-init-file
5528 ;; Register running process in stack.
5530 ;; Set-up sentinel in order to catch results.
5533 ,process
5555 ;;;###autoload
5558 &optional async subtreep visible-only body-only ext-plist
5559 post-process)
5560 "Call `org-export-as' with output to a specified buffer.
5562 BACKEND is either an export back-end, as returned by, e.g.,
5563 `org-export-create-backend', or a symbol referring to
5564 a registered back-end.
5566 BUFFER is the name of the output buffer. If it already exists,
5567 it will be erased first, otherwise, it will be created.
5569 A non-nil optional argument ASYNC means the process should happen
5570 asynchronously. The resulting buffer should then be accessible
5571 through the `org-export-stack' interface. When ASYNC is nil, the
5572 buffer is displayed if `org-export-show-temporary-export-buffer'
5573 is non-nil.
5575 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5576 EXT-PLIST are similar to those used in `org-export-as', which
5577 see.
5579 Optional argument POST-PROCESS is a function which should accept
5580 no argument. It is always called within the current process,
5581 from BUFFER, with point at its beginning. Export back-ends can
5582 use it to set a major mode there, e.g,
5584 \(defun org-latex-export-as-latex
5585 \(&optional async subtreep visible-only body-only ext-plist)
5586 \(interactive)
5588 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5590 This function returns BUFFER."
5618 buffer)))
5620 ;;;###autoload
5623 post-process)
5624 "Call `org-export-as' with output to a specified file.
5626 BACKEND is either an export back-end, as returned by, e.g.,
5627 `org-export-create-backend', or a symbol referring to
5628 a registered back-end. FILE is the name of the output file, as
5629 a string.
5631 A non-nil optional argument ASYNC means the process should happen
5632 asynchronously. The resulting buffer will then be accessible
5633 through the `org-export-stack' interface.
5635 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5636 EXT-PLIST are similar to those used in `org-export-as', which
5637 see.
5639 Optional argument POST-PROCESS is called with FILE as its
5640 argument and happens asynchronously when ASYNC is non-nil. It
5641 has to return a file name, or nil. Export back-ends can use this
5642 to send the output file through additional processing, e.g,
5644 \(defun org-latex-export-to-latex
5645 \(&optional async subtreep visible-only body-only ext-plist)
5646 \(interactive)
5648 \(org-export-to-file 'latex outfile
5649 async subtreep visible-only body-only ext-plist
5650 \(lambda (file) (org-latex-compile file)))
5652 The function returns either a file name returned by POST-PROCESS,
5653 or FILE."
5671 backend subtreep visible-only body-only ext-plist)))
5678 ;; Get proper return value.
5680 file))))))
5683 "Return output file's name according to buffer specifications.
5685 EXTENSION is a string representing the output file extension,
5686 with the leading dot.
5688 With a non-nil optional argument SUBTREEP, try to determine
5690 of subtree at point.
5692 When optional argument PUB-DIR is set, use it as the publishing
5693 directory.
5695 When optional argument VISIBLE-ONLY is non-nil, don't export
5696 contents of hidden elements.
5698 Return file name as a string."
5701 ;; File name may come from EXPORT_FILE_NAME subtree
5702 ;; property, assuming point is at beginning of said
5703 ;; sub-tree.
5710 ;; File name may be extracted from buffer's associated
5711 ;; file, if any.
5713 ;; Can't determine file name on our own: Ask user.
5717 "Output file: " pub-dir nil nil nil
5721 ;; Build file name. Enforce EXTENSION over whatever user
5722 ;; may have come up with. PUB-DIR, if defined, always has
5723 ;; precedence over any provided path.
5728 extension))
5731 ;; If writing to OUTPUT-FILE would overwrite original file, append
5732 ;; EXTENSION another time to final name.
5735 output-file)))
5738 "Add a new result to export stack if not present already.
5740 SOURCE is a buffer or a file name containing export results.
5741 BACKEND is a symbol representing export back-end used to generate
5742 it.
5744 Entries already pointing to SOURCE and unavailable entries are
5745 removed beforehand. Return the new stack."
5751 "Menu for asynchronous export results and running processes."
5761 "Return source from export results at point in stack."
5768 source
5769 ;; SOURCE is not consistent with current line. The stack
5770 ;; view is outdated.
5774 "Remove all entries from export stack."
5779 "Refresh the asynchronous export stack.
5780 DUMMY is ignored. Unavailable sources are removed from the list.
5781 Return the new stack."
5791 ;; Back-end.
5793 ;; Age.
5796 ;; Compute age of the results.
5798 "%4h:%.2m "
5800 ;; Source.
5805 ;; Clear stack from exited processes, dead buffers or
5806 ;; non-existent files.
5818 "Remove export results at point from stack.
5819 If optional argument SOURCE is non-nil, remove it instead."
5824 org-export-stack-contents))))
5827 "View export results at point in stack.
5828 With an optional prefix argument IN-EMACS, force viewing files
5829 within Emacs."
5843 (define-key km "p" 'previous-line)
5844 (define-key km "\C-p" 'previous-line)
5845 (define-key km "\C-?" 'previous-line)
5846 (define-key km [up] 'previous-line)
5847 (define-key km "C" 'org-export-stack-clear)
5848 (define-key km "v" 'org-export-stack-view)
5849 (define-key km (kbd "RET") 'org-export-stack-view)
5850 (define-key km "d" 'org-export-stack-remove)
5851 km)
5852 "Keymap for Org Export Stack.")
5854 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5855 "Mode for displaying asynchronous export stack.
5858 stack.
5860 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5861 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5862 stack completely.
5864 Removing entries in an Org Export Stack buffer doesn't affect
5865 files or buffers, only the display.
5868 (abbrev-mode 0)
5869 (auto-fill-mode 0)
5870 (setq buffer-read-only t
5871 buffer-undo-list t
5872 truncate-lines t
5873 header-line-format
5874 '(:eval
5875 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5876 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5877 (set (make-local-variable 'revert-buffer-function)
5878 'org-export-stack-refresh))
5881 \f
5882 ;;; The Dispatcher
5883 ;;
5884 ;; `org-export-dispatch' is the standard interactive way to start an
5885 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5886 ;; for its interface, which, in turn, delegates response to key
5887 ;; pressed to `org-export--dispatch-action'.
5889 ;;;###autoload
5890 (defun org-export-dispatch (&optional arg)
5891 "Export dispatcher for Org mode.
5893 It provides an access to common export related tasks in a buffer.
5894 Its interface comes in two flavors: standard and expert.
5896 While both share the same set of bindings, only the former
5897 displays the valid keys associations in a dedicated buffer.
5898 Scrolling (resp. line-wise motion) in this buffer is done with
5899 SPC and DEL (resp. C-n and C-p) keys.
5901 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5902 flavor or the other.
5905 of options used back then, on the current buffer.
5907 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5908 (interactive "P")
5909 (let* ((input
5910 (cond ((equal arg '(16)) '(stack))
5911 ((and arg org-export-dispatch-last-action))
5912 (t (save-window-excursion
5913 (unwind-protect
5914 (progn
5915 ;; Remember where we are
5916 (move-marker org-export-dispatch-last-position
5917 (point)
5918 (org-base-buffer (current-buffer)))
5919 ;; Get and store an export command
5920 (setq org-export-dispatch-last-action
5921 (org-export--dispatch-ui
5922 (list org-export-initial-scope
5923 (and org-export-in-background 'async))
5924 nil
5925 org-export-dispatch-use-expert-ui)))
5926 (and (get-buffer "*Org Export Dispatcher*")
5927 (kill-buffer "*Org Export Dispatcher*")))))))
5928 (action (car input))
5929 (optns (cdr input)))
5930 (unless (memq 'subtree optns)
5931 (move-marker org-export-dispatch-last-position nil))
5932 (case action
5933 ;; First handle special hard-coded actions.
5934 (template (org-export-insert-default-template nil optns))
5935 (stack (org-export-stack))
5936 (publish-current-file
5937 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5938 (publish-current-project
5939 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5940 (publish-choose-project
5941 (org-publish (assoc (org-icompleting-read
5942 "Publish project: "
5943 org-publish-project-alist nil t)
5944 org-publish-project-alist)
5945 (memq 'force optns)
5946 (memq 'async optns)))
5947 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5948 (otherwise
5949 (save-excursion
5950 (when arg
5951 ;; Repeating command, maybe move cursor to restore subtree
5952 ;; context.
5953 (if (eq (marker-buffer org-export-dispatch-last-position)
5954 (org-base-buffer (current-buffer)))
5955 (goto-char org-export-dispatch-last-position)
5956 ;; We are in a different buffer, forget position.
5957 (move-marker org-export-dispatch-last-position nil)))
5958 (funcall action
5959 ;; Return a symbol instead of a list to ease
5960 ;; asynchronous export macro use.
5961 (and (memq 'async optns) t)
5962 (and (memq 'subtree optns) t)
5963 (and (memq 'visible optns) t)
5964 (and (memq 'body optns) t)))))))
5966 (defun org-export--dispatch-ui (options first-key expertp)
5967 "Handle interface for `org-export-dispatch'.
5969 OPTIONS is a list containing current interactive options set for
5970 export. It can contain any of the following symbols:
5971 `body' toggles a body-only export
5972 `subtree' restricts export to current subtree
5973 `visible' restricts export to visible part of buffer.
5974 `force' force publishing files.
5975 `async' use asynchronous export process
5977 FIRST-KEY is the key pressed to select the first level menu. It
5978 is nil when this menu hasn't been selected yet.
5980 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5981 buffer is provided, but indications about currently active
5982 options are given in the prompt. Moreover, \[?] allows to switch
5983 back to standard interface."
5984 (let* ((fontify-key
5985 (lambda (key &optional access-key)
5986 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5987 ;; non-nil is the required first-level key to activate
5988 ;; KEY. When its value is t, activate KEY independently
5989 ;; on the first key, if any. A nil value means KEY will
5990 ;; only be activated at first level.
5991 (if (or (eq access-key t) (eq access-key first-key))
5992 (org-propertize key 'face 'org-warning)
5993 key)))
5994 (fontify-value
5995 (lambda (value)
5996 ;; Fontify VALUE string.
5997 (org-propertize value 'face 'font-lock-variable-name-face)))
5998 ;; Prepare menu entries by extracting them from registered
5999 ;; back-ends and sorting them by access key and by ordinal,
6000 ;; if any.
6001 (entries
6002 (sort (sort (delq nil
6003 (mapcar 'org-export-backend-menu
6004 org-export--registered-backends))
6005 (lambda (a b)
6006 (let ((key-a (nth 1 a))
6007 (key-b (nth 1 b)))
6008 (cond ((and (numberp key-a) (numberp key-b))
6009 (< key-a key-b))
6010 ((numberp key-b) t)))))
6011 'car-less-than-car))
6012 ;; Compute a list of allowed keys based on the first key
6013 ;; pressed, if any. Some keys
6014 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6015 ;; available.
6016 (allowed-keys
6017 (nconc (list 2 22 19 6 1)
6018 (if (not first-key) (org-uniquify (mapcar 'car entries))
6019 (let (sub-menu)
6020 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6021 (when (eq (car entry) first-key)
6022 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6023 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6024 ((not first-key) (list ?P)))
6025 (list ?& ?#)
6026 (when expertp (list ??))
6027 (list ?q)))
6028 ;; Build the help menu for standard UI.
6029 (help
6030 (unless expertp
6031 (concat
6032 ;; Options are hard-coded.
6033 (format "[%s] Body only: %s [%s] Visible only: %s
6034 \[%s] Export scope: %s [%s] Force publishing: %s
6036 (funcall fontify-key "C-b" t)
6037 (funcall fontify-value
6038 (if (memq 'body options) "On " "Off"))
6039 (funcall fontify-key "C-v" t)
6040 (funcall fontify-value
6041 (if (memq 'visible options) "On " "Off"))
6042 (funcall fontify-key "C-s" t)
6043 (funcall fontify-value
6044 (if (memq 'subtree options) "Subtree" "Buffer "))
6045 (funcall fontify-key "C-f" t)
6046 (funcall fontify-value
6047 (if (memq 'force options) "On " "Off"))
6048 (funcall fontify-key "C-a" t)
6049 (funcall fontify-value
6050 (if (memq 'async options) "On " "Off")))
6051 ;; Display registered back-end entries. When a key
6052 ;; appears for the second time, do not create another
6053 ;; entry, but append its sub-menu to existing menu.
6054 (let (last-key)
6055 (mapconcat
6056 (lambda (entry)
6057 (let ((top-key (car entry)))
6058 (concat
6059 (unless (eq top-key last-key)
6060 (setq last-key top-key)
6062 (funcall fontify-key (char-to-string top-key))
6063 (nth 1 entry)))
6064 (let ((sub-menu (nth 2 entry)))
6065 (unless (functionp sub-menu)
6066 ;; Split sub-menu into two columns.
6067 (let ((index -1))
6068 (concat
6069 (mapconcat
6070 (lambda (sub-entry)
6071 (incf index)
6072 (format
6073 (if (zerop (mod index 2)) " [%s] %-26s"
6075 (funcall fontify-key
6076 (char-to-string (car sub-entry))
6077 top-key)
6078 (nth 1 sub-entry)))
6079 sub-menu "")
6081 entries ""))
6082 ;; Publishing menu is hard-coded.
6084 [%s] Current file [%s] Current project
6086 (funcall fontify-key "P")
6087 (funcall fontify-key "f" ?P)
6088 (funcall fontify-key "p" ?P)
6089 (funcall fontify-key "x" ?P)
6090 (funcall fontify-key "a" ?P))
6092 (funcall fontify-key "&" t)
6093 (funcall fontify-key "#" t))
6094 (format "[%s] %s"
6095 (funcall fontify-key "q" t)
6096 (if first-key "Main menu" "Exit")))))
6097 ;; Build prompts for both standard and expert UI.
6098 (standard-prompt (unless expertp "Export command: "))
6099 (expert-prompt
6100 (when expertp
6101 (format
6102 "Export command (C-%s%s%s%s%s) [%s]: "
6103 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6104 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6105 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6106 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6107 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6108 (mapconcat (lambda (k)
6109 ;; Strip control characters.
6110 (unless (< k 27) (char-to-string k)))
6111 allowed-keys "")))))
6112 ;; With expert UI, just read key with a fancy prompt. In standard
6113 ;; UI, display an intrusive help buffer.
6114 (if expertp
6115 (org-export--dispatch-action
6116 expert-prompt allowed-keys entries options first-key expertp)
6117 ;; At first call, create frame layout in order to display menu.
6118 (unless (get-buffer "*Org Export Dispatcher*")
6119 (delete-other-windows)
6120 (org-switch-to-buffer-other-window
6121 (get-buffer-create "*Org Export Dispatcher*"))
6122 (setq cursor-type nil
6123 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6124 ;; Make sure that invisible cursor will not highlight square
6125 ;; brackets.
6126 (set-syntax-table (copy-syntax-table))
6127 (modify-syntax-entry ?\[ "w"))
6128 ;; At this point, the buffer containing the menu exists and is
6129 ;; visible in the current window. So, refresh it.
6130 (with-current-buffer "*Org Export Dispatcher*"
6131 ;; Refresh help. Maintain display continuity by re-visiting
6132 ;; previous window position.
6133 (let ((pos (window-start)))
6134 (erase-buffer)
6135 (insert help)
6136 (set-window-start nil pos)))
6137 (org-fit-window-to-buffer)
6138 (org-export--dispatch-action
6139 standard-prompt allowed-keys entries options first-key expertp))))
6141 (defun org-export--dispatch-action
6142 (prompt allowed-keys entries options first-key expertp)
6143 "Read a character from command input and act accordingly.
6145 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6146 a list of characters available at a given step in the process.
6147 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6148 EXPERTP are the same as defined in `org-export--dispatch-ui',
6149 which see.
6151 Toggle export options when required. Otherwise, return value is
6152 a list with action as CAR and a list of interactive export
6153 options as CDR."
6154 (let (key)
6155 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6156 ;; C-p, SPC, DEL).
6157 (while (and (setq key (read-char-exclusive prompt))
6158 (not expertp)
6159 (memq key '(14 16 ?\s ?\d)))
6160 (case key
6161 (14 (if (not (pos-visible-in-window-p (point-max)))
6162 (ignore-errors (scroll-up 1))
6163 (message "End of buffer")
6164 (sit-for 1)))
6165 (16 (if (not (pos-visible-in-window-p (point-min)))
6166 (ignore-errors (scroll-down 1))
6167 (message "Beginning of buffer")
6168 (sit-for 1)))
6169 (?\s (if (not (pos-visible-in-window-p (point-max)))
6170 (scroll-up nil)
6171 (message "End of buffer")
6172 (sit-for 1)))
6173 (?\d (if (not (pos-visible-in-window-p (point-min)))
6174 (scroll-down nil)
6175 (message "Beginning of buffer")
6176 (sit-for 1)))))
6177 (cond
6178 ;; Ignore undefined associations.
6179 ((not (memq key allowed-keys))
6180 (ding)
6181 (unless expertp (message "Invalid key") (sit-for 1))
6182 (org-export--dispatch-ui options first-key expertp))
6183 ;; q key at first level aborts export. At second level, cancel
6184 ;; first key instead.
6185 ((eq key ?q) (if (not first-key) (error "Export aborted")
6186 (org-export--dispatch-ui options nil expertp)))
6187 ;; Help key: Switch back to standard interface if expert UI was
6188 ;; active.
6189 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6190 ;; Send request for template insertion along with export scope.
6191 ((eq key ?#) (cons 'template (memq 'subtree options)))
6192 ;; Switch to asynchronous export stack.
6193 ((eq key ?&) '(stack))
6194 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6195 ((memq key '(2 22 19 6 1))
6196 (org-export--dispatch-ui
6197 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6198 (6 'force) (1 'async))))
6199 (if (memq option options) (remq option options)
6200 (cons option options)))
6201 first-key expertp))
6202 ;; Action selected: Send key and options back to
6203 ;; `org-export-dispatch'.
6204 ((or first-key (functionp (nth 2 (assq key entries))))
6205 (cons (cond
6206 ((not first-key) (nth 2 (assq key entries)))
6207 ;; Publishing actions are hard-coded. Send a special
6208 ;; signal to `org-export-dispatch'.
6209 ((eq first-key ?P)
6210 (case key
6211 (?f 'publish-current-file)
6212 (?p 'publish-current-project)
6213 (?x 'publish-choose-project)
6214 (?a 'publish-all)))
6215 ;; Return first action associated to FIRST-KEY + KEY
6216 ;; path. Indeed, derived backends can share the same
6217 ;; FIRST-KEY.
6218 (t (catch 'found
6219 (mapc (lambda (entry)
6220 (let ((match (assq key (nth 2 entry))))
6221 (when match (throw 'found (nth 2 match)))))
6222 (member (assq first-key entries) entries)))))
6223 options))
6224 ;; Otherwise, enter sub-menu.
6225 (t (org-export--dispatch-ui options key expertp)))))
6229 (provide 'ox)
6231 ;; Local variables:
6232 ;; generated-autoload-file: "org-loaddefs.el"
6233 ;; End:
6235 ;;; ox.el ends here