| blob | f4f2c591f57f884f2d0080d8574e8d53ae234fcc |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists in a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place. The exhaustive list
35 ;; of properties is given in "The Communication Channel" section of
36 ;; this file.
37 ;;
38 ;; - The transcoder walks the parse tree, ignores or treat as plain
39 ;; text elements and objects according to export options, and
40 ;; eventually calls back-end specific functions to do the real
41 ;; transcoding, concatenating their return value along the way.
42 ;;
43 ;; - The filter system is activated at the very beginning and the very
44 ;; end of the export process, and each time an element or an object
45 ;; has been converted. It is the entry point to fine-tune standard
46 ;; output from back-end transcoders. See "The Filter System"
47 ;; section for more information.
48 ;;
49 ;; The core function is `org-export-as'. It returns the transcoded
50 ;; buffer as a string.
51 ;;
52 ;; An export back-end is defined with `org-export-define-backend'.
53 ;; This function can also support specific buffer keywords, OPTION
54 ;; keyword's items and filters. Refer to function's documentation for
55 ;; more information.
56 ;;
57 ;; If the new back-end shares most properties with another one,
58 ;; `org-export-define-derived-backend' can be used to simplify the
59 ;; process.
60 ;;
61 ;; Any back-end can define its own variables. Among them, those
62 ;; customizable should belong to the `org-export-BACKEND' group.
63 ;;
64 ;; Tools for common tasks across back-ends are implemented in the
65 ;; following part of the file.
66 ;;
67 ;; Then, a wrapper macro for asynchronous export,
68 ;; `org-export-async-start', along with tools to display results. are
69 ;; given in the penultimate part.
70 ;;
71 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
72 ;; back-ends is provided in the last one.
74 ;;; Code:
93 \f
94 ;;; Internal Variables
95 ;;
96 ;; Among internal variables, the most important is
97 ;; `org-export-options-alist'. This variable define the global export
98 ;; options, shared between every exporter, and how they are acquired.
143 "Alist between export properties and ways to set them.
145 The CAR of the alist is the property name, and the CDR is a list
146 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
148 KEYWORD is a string representing a buffer keyword, or nil. Each
149 property defined this way can also be set, during subtree
150 export, through a headline property named after the keyword
152 property).
153 OPTION is a string that could be found in an #+OPTIONS: line.
154 DEFAULT is the default value for the property.
155 BEHAVIOR determines how Org should handle multiple keywords for
156 the same property. It is a symbol among:
157 nil Keep old value and discard the new one.
158 t Replace old value with the new one.
159 `space' Concatenate the values, separating them with a space.
160 `newline' Concatenate the values, separating them with
161 a newline.
162 `split' Split values at white spaces, and cons them to the
163 previous list.
165 Values set through KEYWORD and OPTION have precedence over
166 DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
262 "Non-nil means asynchronous export process should leave data behind.
266 located in `temporary-file-directory'.
268 When non-nil, it will also set `debug-on-error' to a non-nil
272 "Record asynchronously generated export results and processes.
273 This is an alist: its CAR is the source of the
274 result (destination file or buffer for a finished process,
275 original buffer for a running one) and its CDR is a list
276 containing the back-end used, as a symbol, and either a process
277 or the time at which it finished. It is used to build the menu
281 "List of backends currently available in the exporter.
282 This variable is set with `org-export-define-backend' and
286 "Last command called from the dispatcher.
287 The value should be a list. Its CAR is the action, as a symbol,
291 "The position where the last export command was created using the dispatcher.
292 This marker will be used with `C-u C-c C-e' to make sure export repetition
295 ;; For compatibility with Org < 8
297 "Name, if any, of the back-end used during an export process.
299 Its value is a symbol such as `html', `latex', `ascii', or nil if
300 the back-end is anonymous (see `org-export-create-backend') or if
301 there is no export process in progress.
303 It can be used to teach Babel blocks how to act differently
306 \f
307 ;;; User-configurable Variables
308 ;;
309 ;; Configuration for the masses.
310 ;;
311 ;; They should never be accessed directly, as their value is to be
312 ;; stored in a property list (cf. `org-export-options-alist').
313 ;; Back-ends will read their value from there instead.
316 "Options for exporting Org mode files."
321 "General options for export engine."
326 "Whether sub-trees with the ARCHIVE tag should be exported.
328 This can have three different values:
329 nil Do not export, pretend this tree is not present.
330 t Do export the entire tree.
331 `headline' Only export the headline, but skip the tree below it.
333 This option can also be set with the OPTIONS keyword,
342 "Non-nil means insert author name into the exported file.
343 This option can also be set with the OPTIONS keyword,
349 "Non-nil means export CLOCK keywords.
350 This option can also be set with the OPTIONS keyword,
356 "Non-nil means the postamble should contain a creator sentence.
358 The sentence can be set in `org-export-creator-string' and
361 If the value is `comment' insert it as a comment."
369 "Non-nil means insert date in the exported document.
370 This option can also be set with the OPTIONS keyword,
376 "Time-stamp format string to use for DATE keyword.
378 The format string, when specified, only applies if date consists
379 in a single time-stamp. Otherwise its value will be ignored.
381 See `format-time-string' for details on how to build this
382 string."
390 emacs-version
392 "Information about the creator of the document.
393 This option can also be set on with the CREATOR keyword."
398 "Non-nil means export contents of standard drawers.
400 When t, all drawers are exported. This may also be a list of
401 drawer names to export. If that list starts with `not', only
402 drawers with such names will be ignored.
404 This variable doesn't apply to properties drawers.
406 This option can also be set with the OPTIONS keyword,
419 :inline t
423 "Non-nil means insert author email into the exported file.
424 This option can also be set with the OPTIONS keyword,
430 "Non-nil means interpret *word*, /word/, _word_ and +word+.
432 If the export target supports emphasizing text, the word will be
433 typeset in bold, italic, with an underline or strike-through,
434 respectively.
436 This option can also be set with the OPTIONS keyword,
442 "Tags that exclude a tree from export.
444 All trees carrying any of these tags will be excluded from
445 export. This is without condition, so even subtrees inside that
446 carry one of the `org-export-select-tags' will be removed.
448 This option can also be set with the EXCLUDE_TAGS keyword."
455 This can be used to have pre-formatted text, fragments of code
456 etc. For example:
457 : ;; Some Lisp examples
458 : (while (defc cnt)
459 : (ding))
460 will be looking just like this in also HTML. See also the QUOTE
461 keyword. Not all export backends support this.
463 This option can also be set with the OPTIONS keyword,
469 "Non-nil means Org footnotes should be exported.
470 This option can also be set with the OPTIONS keyword,
476 "Non-nil means process LaTeX environments and fragments.
478 This option can also be set with the OPTIONS line,
481 nil Ignore math snippets.
482 `verbatim' Keep everything in verbatim.
483 t Allow export of math snippets."
493 "The last level which is still exported as a headline.
495 Inferior levels will usually produce itemize or enumerate lists
496 when exported, but back-end behaviour may differ.
498 This option can also be set with the OPTIONS keyword,
504 "The default language for export and clocktable translations, as a string.
505 This may have an association in
506 `org-clock-clocktable-language-setup',
507 `org-export-smart-quotes-alist' and `org-export-dictionary'.
508 This option can also be set with the LANGUAGE keyword."
513 "Non-nil means preserve all line breaks when exporting.
514 This option can also be set with the OPTIONS keyword,
520 "Non-nil means interpret entities when exporting.
523 Å.
525 For a list of supported names, see the constant `org-entities'
526 and the user option `org-entities-user'.
528 This option can also be set with the OPTIONS keyword,
534 "Non-nil means inlinetasks should be exported.
535 This option can also be set with the OPTIONS keyword,
543 "Non-nil means include planning info in export.
545 Planning info is the line containing either SCHEDULED:,
546 DEADLINE:, CLOSED: time-stamps, or a combination of them.
548 This option can also be set with the OPTIONS keyword,
556 "Non-nil means include priority cookies in export.
557 This option can also be set with the OPTIONS keyword,
563 "Non-nil means add section numbers to headlines when exporting.
565 When set to an integer n, numbering will only happen for
566 headlines whose relative level is higher or equal to n.
568 This option can also be set with the OPTIONS keyword,
574 "Tags that select a tree for export.
576 If any such tag is found in a buffer, all trees that do not carry
577 one of these tags will be ignored during export. Inside trees
578 that are selected like this, you can still deselect a subtree by
579 tagging it with one of the `org-export-exclude-tags'.
581 This option can also be set with the SELECT_TAGS keyword."
586 "Non-nil means activate smart quotes during export.
587 This option can also be set with the OPTIONS keyword,
590 When setting this to non-nil, you need to take care of
591 using the correct Babel package when exporting to LaTeX.
592 E.g., you can load Babel for french like this:
603 When this option is turned on, these strings will be exported as:
605 Org HTML LaTeX UTF-8
606 -----+----------+--------+-------
608 -- – -- –
609 --- — --- —
612 This option can also be set with the OPTIONS keyword,
618 "Non-nil means include statistics cookies in export.
619 This option can also be set with the OPTIONS keyword,
629 If you want to control how Org displays those characters, see
630 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
631 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
632 it is not anymore.
634 When this option is turned on, you can use TeX-like syntax for
635 sub- and superscripts and see them exported correctly.
637 You can also set the option with #+OPTIONS: ^:t
640 single item - so grouping with {} is normally not needed. For
641 example, the following things will be parsed as single sub- or
642 superscripts:
644 10^24 or 10^tau several digits will be considered 1 item.
645 10^-12 or 10^-tau a leading sign with digits or a word
646 x^2-y^3 will be read as x^2 - y^3, because items are
647 terminated by almost any nonword/nondigit char.
648 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
650 Still, ambiguity is possible. So when in doubt, use {} to enclose
651 the sub/superscript. If you set this variable to the symbol `{}',
652 the braces are *required* in order to trigger interpretations as
654 frequently in plain text."
664 "Non-nil means create a table of contents in exported files.
666 The TOC contains headlines with levels up
667 to`org-export-headline-levels'. When an integer, include levels
668 up to N in the toc, this may then be different from
669 `org-export-headline-levels', but it will not be allowed to be
670 larger than the number of headline levels. When nil, no table of
671 contents is made.
673 This option can also be set with the OPTIONS keyword,
683 For example:
685 | Name | Address | Birthday |
686 |-------------+----------+-----------|
687 | Arthur Dent | England | 29.2.2100 |
689 This option can also be set with the OPTIONS keyword,
695 "If nil, do not export tags, just remove them from headlines.
697 If this is the symbol `not-in-toc', tags will be removed from
698 table of contents entries, but still be shown in the headlines of
699 the document.
701 This option can also be set with the OPTIONS keyword,
710 "Non-nil means include TODO items for export.
712 This may have the following values:
713 t include tasks independent of state.
714 `todo' include only tasks that are not yet done.
715 `done' include only tasks that are already done.
716 nil ignore all tasks.
717 list of keywords include tasks with these keywords.
719 This option can also be set with the OPTIONS keyword,
731 "Non-nil means insert a time stamp into the exported file.
732 The time stamp shows when the file was created. This option can
738 "Non nil means allow timestamps in export.
740 It can be set to any of the following values:
741 t export all timestamps.
742 `active' export active timestamps only.
743 `inactive' export inactive timestamps only.
744 nil do not export timestamps
746 This only applies to timestamps isolated in a paragraph
747 containing only timestamps. Other timestamps are always
748 exported.
750 This option can also be set with the OPTIONS keyword, e.g.
760 "Non-nil means include TODO keywords in export.
761 When nil, remove all these keywords from the export. This option
767 "Non-nil means BIND keywords can define local variable values.
768 This is a potential security risk, which is why the default value
769 is nil. You can also allow them through local buffer variables."
776 "Alist between export snippets back-ends and exporter back-ends.
778 This variable allows to provide shortcuts for export snippets.
782 HTML code while every other back-end will ignore it."
791 "Coding system for the exported file."
798 "Non-nil means pushing export output to the kill ring.
799 This variable is ignored during asynchronous export."
808 "The initial scope when exporting with `org-export-dispatch'.
809 This variable can be either set to `buffer' or `subtree'."
816 "Non-nil means show buffer after exporting to temp buffer.
817 When Org exports to a file, the buffer visiting that file is ever
818 shown, but remains buried. However, when exporting to
819 a temporary buffer, that buffer is popped up in a second window.
820 When this variable is nil, the buffer remains buried also in
821 these cases."
826 "Non-nil means export and publishing commands will run in background.
827 Results from an asynchronous export are never displayed
835 "File used to initialize external export process.
836 Value must be an absolute file name. It defaults to user's
837 initialization file. Though, a specific configuration makes the
838 process faster and the export more portable."
845 "Non-nil means using a non-intrusive `org-export-dispatch'.
846 In that case, no help buffer is displayed. Though, an indicator
852 asynchronous). Also, \[?] allows to switch back to standard
853 mode."
860 \f
861 ;;; Defining Back-ends
862 ;;
863 ;; An export back-end is a structure with `org-export-backend' type
864 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
865 ;; and `menu' slots.
866 ;;
867 ;; At the lowest level, a back-end is created with
868 ;; `org-export-create-backend' function.
869 ;;
870 ;; A named back-end can be registered with
871 ;; `org-export-register-backend' function. A registered back-end can
872 ;; later be referred to by its name, with `org-export-get-backend'
873 ;; function. Also, such a back-end can become the parent of a derived
874 ;; back-end from which slot values will be inherited by default.
875 ;; `org-export-derived-backend-p' can check if a given back-end is
876 ;; derived from a list of back-end names.
877 ;;
878 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
879 ;; `org-export-get-all-filters' return the full alist of transcoders,
880 ;; options and filters, including those inherited from ancestors.
881 ;;
882 ;; At a higher level, `org-export-define-backend' is the standard way
883 ;; to define an export back-end. If the new back-end is similar to
884 ;; a registered back-end, `org-export-define-derived-backend' may be
885 ;; used instead.
886 ;;
887 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
888 ;; when a given back-end hasn't been registered yet.
892 name parent transcoders options filters blocks menu)
895 "Return export back-end named after NAME.
896 NAME is a symbol. Return nil if no such back-end is found."
903 "Register BACKEND as a known export back-end.
904 BACKEND is a structure with `org-export-backend' type."
905 ;; Refuse to register an unnamed back-end.
908 ;; Refuse to register a back-end with an unknown parent.
912 ;; Register dedicated export blocks in the parser.
916 ;; If a back-end with the same name as BACKEND is already
917 ;; registered, replace it with BACKEND. Otherwise, simply add
918 ;; BACKEND to the list of registered back-ends.
924 "Signal an error if BACKEND isn't defined."
929 "Non-nil if BACKEND is derived from one of BACKENDS.
930 BACKEND is an export back-end, as returned by, e.g.,
931 `org-export-create-backend', or a symbol referring to
932 a registered back-end. BACKENDS is constituted of symbols."
944 "Return full translation table for BACKEND.
946 BACKEND is an export back-end, as return by, e.g,,
947 `org-export-create-backend'. Return value is an alist where
948 keys are element or object types, as symbols, and values are
949 transcoders.
951 Unlike to `org-export-backend-transcoders', this function
952 also returns transcoders inherited from parent back-ends,
953 if any."
957 parent)
962 transcoders)))
965 "Return export options for BACKEND.
967 BACKEND is an export back-end, as return by, e.g,,
968 `org-export-create-backend'. See `org-export-options-alist'
969 for the shape of the return value.
971 Unlike to `org-export-backend-options', this function also
972 returns options inherited from parent back-ends, if any."
976 parent)
980 options)))
983 "Return complete list of filters for BACKEND.
985 BACKEND is an export back-end, as return by, e.g,,
986 `org-export-create-backend'. Return value is an alist where
987 keys are symbols and values lists of functions.
989 Unlike to `org-export-backend-filters', this function also
990 returns filters inherited from parent back-ends, if any."
994 parent)
998 filters)))
1001 "Define a new back-end BACKEND.
1003 TRANSCODERS is an alist between object or element types and
1004 functions handling them.
1006 These functions should return a string without any trailing
1007 space, or nil. They must accept three arguments: the object or
1008 element itself, its contents or nil when it isn't recursive and
1009 the property list used as a communication channel.
1011 Contents, when not nil, are stripped from any global indentation
1012 \(although the relative one is preserved). They also always end
1013 with a single newline character.
1015 If, for a given type, no function is found, that element or
1016 object type will simply be ignored, along with any blank line or
1017 white space at its end. The same will happen if the function
1018 returns the nil value. If that function returns the empty
1019 string, the type will be ignored, but the blank lines or white
1020 spaces will be kept.
1022 In addition to element and object types, one function can be
1023 associated to the `template' (or `inner-template') symbol and
1024 another one to the `plain-text' symbol.
1026 The former returns the final transcoded string, and can be used
1027 to add a preamble and a postamble to document's body. It must
1028 accept two arguments: the transcoded string and the property list
1029 containing export options. A function associated to `template'
1031 A function associated to `inner-template' is always applied.
1033 The latter, when defined, is to be called on every text not
1034 recognized as an element or an object. It must accept two
1035 arguments: the text string and the information channel. It is an
1036 appropriate place to protect special chars relative to the
1037 back-end.
1039 BODY can start with pre-defined keyword arguments. The following
1040 keywords are understood:
1042 :export-block
1044 String, or list of strings, representing block names that
1045 will not be parsed. This is used to specify blocks that will
1046 contain raw code specific to the back-end. These blocks
1047 still have to be handled by the relative `export-block' type
1048 translator.
1050 :filters-alist
1052 Alist between filters and function, or list of functions,
1053 specific to the back-end. See `org-export-filters-alist' for
1054 a list of all allowed filters. Filters defined here
1055 shouldn't make a back-end test, as it may prevent back-ends
1056 derived from this one to behave properly.
1058 :menu-entry
1060 Menu entry for the export dispatcher. It should be a list
1061 like:
1063 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1065 where :
1067 KEY is a free character selecting the back-end.
1069 DESCRIPTION-OR-ORDINAL is either a string or a number.
1071 If it is a string, is will be used to name the back-end in
1072 its menu entry. If it is a number, the following menu will
1073 be displayed as a sub-menu of the back-end with the same
1074 KEY. Also, the number will be used to determine in which
1075 order such sub-menus will appear (lowest first).
1077 ACTION-OR-MENU is either a function or an alist.
1079 If it is an action, it will be called with four
1080 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1081 BODY-ONLY. See `org-export-as' for further explanations on
1082 some of them.
1084 If it is an alist, associations should follow the
1085 pattern:
1087 '(KEY DESCRIPTION ACTION)
1089 where KEY, DESCRIPTION and ACTION are described above.
1091 Valid values include:
1095 or
1100 \(lambda (a s v b)
1101 \(if a (org-latex-export-to-pdf t s v b)
1102 \(org-open-file
1103 \(org-latex-export-to-pdf nil s v b)))))))
1105 or the following, which will be added to the previous
1106 sub-menu,
1108 '(?l 1
1112 :options-alist
1114 Alist between back-end specific properties introduced in
1115 communication channel and how their value are acquired. See
1116 `org-export-options-alist' for more information about
1117 structure of the values."
1131 :transcoders transcoders
1132 :options options
1133 :filters filters
1134 :blocks blocks
1138 "Create a new back-end as a variant of an existing one.
1140 CHILD is the name of the derived back-end. PARENT is the name of
1141 the parent back-end.
1143 BODY can start with pre-defined keyword arguments. The following
1144 keywords are understood:
1146 :export-block
1148 String, or list of strings, representing block names that
1149 will not be parsed. This is used to specify blocks that will
1150 contain raw code specific to the back-end. These blocks
1151 still have to be handled by the relative `export-block' type
1152 translator.
1154 :filters-alist
1156 Alist of filters that will overwrite or complete filters
1157 defined in PARENT back-end. See `org-export-filters-alist'
1158 for a list of allowed filters.
1160 :menu-entry
1162 Menu entry for the export dispatcher. See
1163 `org-export-define-backend' for more information about the
1164 expected value.
1166 :options-alist
1168 Alist of back-end specific properties that will overwrite or
1169 complete those defined in PARENT back-end. Refer to
1170 `org-export-options-alist' for more information about
1171 structure of the values.
1173 :translate-alist
1175 Alist of element and object types and transcoders that will
1176 overwrite or complete transcode table from PARENT back-end.
1177 Refer to `org-export-define-backend' for detailed information
1178 about transcoders.
1181 as a variant of `latex' back-end with a custom template function:
1183 \(org-export-define-derived-backend 'my-latex 'latex
1184 :translate-alist '((template . my-latex-template-fun)))
1186 The back-end could then be called with, for example:
1203 :parent parent
1204 :transcoders transcoders
1205 :options options
1206 :filters filters
1207 :blocks blocks
1211 \f
1212 ;;; The Communication Channel
1213 ;;
1214 ;; During export process, every function has access to a number of
1215 ;; properties. They are of two types:
1216 ;;
1217 ;; 1. Environment options are collected once at the very beginning of
1218 ;; the process, out of the original buffer and configuration.
1219 ;; Collecting them is handled by `org-export-get-environment'
1220 ;; function.
1221 ;;
1222 ;; Most environment options are defined through the
1223 ;; `org-export-options-alist' variable.
1224 ;;
1225 ;; 2. Tree properties are extracted directly from the parsed tree,
1226 ;; just before export, by `org-export-collect-tree-properties'.
1227 ;;
1228 ;; Here is the full list of properties available during transcode
1229 ;; process, with their category and their value type.
1230 ;;
1231 ;; + `:author' :: Author's name.
1232 ;; - category :: option
1233 ;; - type :: string
1234 ;;
1235 ;; + `:back-end' :: Current back-end used for transcoding.
1236 ;; - category :: tree
1237 ;; - type :: symbol
1238 ;;
1239 ;; + `:creator' :: String to write as creation information.
1240 ;; - category :: option
1241 ;; - type :: string
1242 ;;
1243 ;; + `:date' :: String to use as date.
1244 ;; - category :: option
1245 ;; - type :: string
1246 ;;
1247 ;; + `:description' :: Description text for the current data.
1248 ;; - category :: option
1249 ;; - type :: string
1250 ;;
1251 ;; + `:email' :: Author's email.
1252 ;; - category :: option
1253 ;; - type :: string
1254 ;;
1255 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1256 ;; process.
1257 ;; - category :: option
1258 ;; - type :: list of strings
1259 ;;
1260 ;; + `:export-options' :: List of export options available for current
1261 ;; process.
1262 ;; - category :: none
1263 ;; - type :: list of symbols, among `subtree', `body-only' and
1264 ;; `visible-only'.
1265 ;;
1266 ;; + `:exported-data' :: Hash table used for memoizing
1267 ;; `org-export-data'.
1268 ;; - category :: tree
1269 ;; - type :: hash table
1270 ;;
1271 ;; + `:filetags' :: List of global tags for buffer. Used by
1272 ;; `org-export-get-tags' to get tags with inheritance.
1273 ;; - category :: option
1274 ;; - type :: list of strings
1275 ;;
1276 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1277 ;; their definition, as parsed data. Only non-inlined footnotes
1278 ;; are represented in this alist. Also, every definition isn't
1279 ;; guaranteed to be referenced in the parse tree. The purpose of
1280 ;; this property is to preserve definitions from oblivion
1281 ;; (i.e. when the parse tree comes from a part of the original
1282 ;; buffer), it isn't meant for direct use in a back-end. To
1283 ;; retrieve a definition relative to a reference, use
1284 ;; `org-export-get-footnote-definition' instead.
1285 ;; - category :: option
1286 ;; - type :: alist (STRING . LIST)
1287 ;;
1288 ;; + `:headline-levels' :: Maximum level being exported as an
1289 ;; headline. Comparison is done with the relative level of
1290 ;; headlines in the parse tree, not necessarily with their
1291 ;; actual level.
1292 ;; - category :: option
1293 ;; - type :: integer
1294 ;;
1295 ;; + `:headline-offset' :: Difference between relative and real level
1296 ;; of headlines in the parse tree. For example, a value of -1
1297 ;; means a level 2 headline should be considered as level
1298 ;; 1 (cf. `org-export-get-relative-level').
1299 ;; - category :: tree
1300 ;; - type :: integer
1301 ;;
1302 ;; + `:headline-numbering' :: Alist between headlines and their
1303 ;; numbering, as a list of numbers
1304 ;; (cf. `org-export-get-headline-number').
1305 ;; - category :: tree
1306 ;; - type :: alist (INTEGER . LIST)
1307 ;;
1308 ;; + `:id-alist' :: Alist between ID strings and destination file's
1309 ;; path, relative to current directory. It is used by
1310 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1311 ;; external file.
1312 ;; - category :: option
1313 ;; - type :: alist (STRING . STRING)
1314 ;;
1315 ;; + `:ignore-list' :: List of elements and objects that should be
1316 ;; ignored during export.
1317 ;; - category :: tree
1318 ;; - type :: list of elements and objects
1319 ;;
1320 ;; + `:input-file' :: Full path to input file, if any.
1321 ;; - category :: option
1322 ;; - type :: string or nil
1323 ;;
1324 ;; + `:keywords' :: List of keywords attached to data.
1325 ;; - category :: option
1326 ;; - type :: string
1327 ;;
1328 ;; + `:language' :: Default language used for translations.
1329 ;; - category :: option
1330 ;; - type :: string
1331 ;;
1332 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1333 ;; transcoding.
1334 ;; - category :: option
1335 ;; - type :: list (as returned by `org-element-parse-buffer')
1336 ;;
1337 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1338 ;; all line breaks.
1339 ;; - category :: option
1340 ;; - type :: symbol (nil, t)
1341 ;;
1342 ;; + `:section-numbers' :: Non-nil means transcoding should add
1343 ;; section numbers to headlines.
1344 ;; - category :: option
1345 ;; - type :: symbol (nil, t)
1346 ;;
1347 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1348 ;; in transcoding. When such a tag is present, subtrees without
1349 ;; it are de facto excluded from the process. See
1350 ;; `use-select-tags'.
1351 ;; - category :: option
1352 ;; - type :: list of strings
1353 ;;
1354 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1355 ;; a time stamp in the output.
1356 ;; - category :: option
1357 ;; - type :: symbol (nil, t)
1358 ;;
1359 ;; + `:translate-alist' :: Alist between element and object types and
1360 ;; transcoding functions relative to the current back-end.
1361 ;; Special keys `inner-template', `template' and `plain-text' are
1362 ;; also possible.
1363 ;; - category :: option
1364 ;; - type :: alist (SYMBOL . FUNCTION)
1365 ;;
1366 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1367 ;; also be transcoded. If it is set to the `headline' symbol,
1368 ;; only the archived headline's name is retained.
1369 ;; - category :: option
1370 ;; - type :: symbol (nil, t, `headline')
1371 ;;
1372 ;; + `:with-author' :: Non-nil means author's name should be included
1373 ;; in the output.
1374 ;; - category :: option
1375 ;; - type :: symbol (nil, t)
1376 ;;
1377 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1378 ;; - category :: option
1379 ;; - type :: symbol (nil, t)
1380 ;;
1381 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1382 ;; inserted at the end of the transcoded string. If the value
1383 ;; is `comment', it should be commented.
1384 ;; - category :: option
1385 ;; - type :: symbol (`comment', nil, t)
1386 ;;
1387 ;; + `:with-date' :: Non-nil means output should contain a date.
1388 ;; - category :: option
1389 ;; - type :. symbol (nil, t)
1390 ;;
1391 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1392 ;; its value is a list of names, only drawers with such names
1393 ;; will be transcoded. If that list starts with `not', drawer
1394 ;; with these names will be skipped.
1395 ;; - category :: option
1396 ;; - type :: symbol (nil, t) or list of strings
1397 ;;
1398 ;; + `:with-email' :: Non-nil means output should contain author's
1399 ;; email.
1400 ;; - category :: option
1401 ;; - type :: symbol (nil, t)
1402 ;;
1403 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1404 ;; interpreted.
1405 ;; - category :: option
1406 ;; - type :: symbol (nil, t)
1407 ;;
1408 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1409 ;; strings starting with a colon as a fixed-with (verbatim) area.
1410 ;; - category :: option
1411 ;; - type :: symbol (nil, t)
1412 ;;
1413 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1414 ;; footnotes.
1415 ;; - category :: option
1416 ;; - type :: symbol (nil, t)
1417 ;;
1418 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1419 ;; `latex-fragment' objects should appear in export output. When
1420 ;; this property is set to `verbatim', they will be left as-is.
1421 ;; - category :: option
1422 ;; - type :: symbol (`verbatim', nil, t)
1423 ;;
1424 ;; + `:with-planning' :: Non-nil means transcoding should include
1425 ;; planning info.
1426 ;; - category :: option
1427 ;; - type :: symbol (nil, t)
1428 ;;
1429 ;; + `:with-priority' :: Non-nil means transcoding should include
1430 ;; priority cookies.
1431 ;; - category :: option
1432 ;; - type :: symbol (nil, t)
1433 ;;
1434 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1435 ;; plain text.
1436 ;; - category :: option
1437 ;; - type :: symbol (nil, t)
1438 ;;
1439 ;; + `:with-special-strings' :: Non-nil means transcoding should
1440 ;; interpret special strings in plain text.
1441 ;; - category :: option
1442 ;; - type :: symbol (nil, t)
1443 ;;
1444 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1445 ;; interpret subscript and superscript. With a value of "{}",
1446 ;; only interpret those using curly brackets.
1447 ;; - category :: option
1448 ;; - type :: symbol (nil, {}, t)
1449 ;;
1450 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1451 ;; tables.
1452 ;; - category :: option
1453 ;; - type :: symbol (nil, t)
1454 ;;
1455 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1456 ;; headlines. A `not-in-toc' value will remove them from the
1457 ;; table of contents, if any, nonetheless.
1458 ;; - category :: option
1459 ;; - type :: symbol (nil, t, `not-in-toc')
1460 ;;
1461 ;; + `:with-tasks' :: Non-nil means transcoding should include
1462 ;; headlines with a TODO keyword. A `todo' value will only
1463 ;; include headlines with a todo type keyword while a `done'
1464 ;; value will do the contrary. If a list of strings is provided,
1465 ;; only tasks with keywords belonging to that list will be kept.
1466 ;; - category :: option
1467 ;; - type :: symbol (t, todo, done, nil) or list of strings
1468 ;;
1469 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1470 ;; time stamps. Special value `active' (resp. `inactive') ask to
1471 ;; export only active (resp. inactive) timestamps. Otherwise,
1472 ;; completely remove them.
1473 ;; - category :: option
1474 ;; - type :: symbol: (`active', `inactive', t, nil)
1475 ;;
1476 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1477 ;; added to the output. An integer value limits its depth.
1478 ;; - category :: option
1479 ;; - type :: symbol (nil, t or integer)
1480 ;;
1481 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1482 ;; include TODO keywords.
1483 ;; - category :: option
1484 ;; - type :: symbol (nil, t)
1487 ;;;; Environment Options
1488 ;;
1489 ;; Environment options encompass all parameters defined outside the
1490 ;; scope of the parsed data. They come from five sources, in
1491 ;; increasing precedence order:
1492 ;;
1493 ;; - Global variables,
1494 ;; - Buffer's attributes,
1495 ;; - Options keyword symbols,
1496 ;; - Buffer keywords,
1497 ;; - Subtree properties.
1498 ;;
1499 ;; The central internal function with regards to environment options
1500 ;; is `org-export-get-environment'. It updates global variables with
1501 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1502 ;; the different sources.
1503 ;;
1504 ;; The internal functions doing the retrieval are:
1505 ;; `org-export--get-global-options',
1506 ;; `org-export--get-buffer-attributes',
1507 ;; `org-export--parse-option-keyword',
1508 ;; `org-export--get-subtree-options' and
1509 ;; `org-export--get-inbuffer-options'
1510 ;;
1511 ;; Also, `org-export--list-bound-variables' collects bound variables
1512 ;; along with their value in order to set them as buffer local
1513 ;; variables later in the process.
1516 "Collect export options from the current buffer.
1518 Optional argument BACKEND is an export back-end, as returned by
1519 `org-export-create-backend'.
1521 When optional argument SUBTREEP is non-nil, assume the export is
1522 done against the current sub-tree.
1524 Third optional argument EXT-PLIST is a property list with
1525 external parameters overriding Org default settings, but still
1526 inferior to file-local settings."
1527 ;; First install #+BIND variables since these must be set before
1528 ;; global options are read.
1531 ;; Get and prioritize export options...
1533 ;; ... from global variables...
1535 ;; ... from an external property list...
1536 ext-plist
1537 ;; ... from in-buffer settings...
1539 ;; ... and from subtree, when appropriate.
1541 ;; Eventually add misc. properties.
1543 :back-end
1544 backend
1546 :footnote-definition-alist
1547 ;; Footnotes definitions must be collected in the original
1548 ;; buffer, as there's no insurance that they will still be in
1549 ;; the parse tree, due to possible narrowing.
1563 alist))))
1564 alist))
1565 :id-alist
1566 ;; Collect id references.
1577 alist))))
1580 "Parse an OPTIONS line and return values as a plist.
1581 Optional argument BACKEND is an export back-end, as returned by,
1582 e.g., `org-export-create-backend'. It specifies which back-end
1583 specific items to read, if any."
1585 ;; Priority is given to back-end specific options.
1587 org-export-options-alist))
1588 plist)
1597 options))
1599 property
1602 plist))
1605 "Get export options in subtree at point.
1606 Optional argument BACKEND is an export back-end, as returned by,
1607 e.g., `org-export-create-backend'. It specifies back-end used
1608 for export. Return options as a plist."
1609 ;; For each buffer keyword, create a headline property setting the
1610 ;; same property in communication channel. The name for the property
1611 ;; is the keyword with "EXPORT_" appended to it.
1614 ;; Make sure point is at a heading.
1616 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1617 ;; title (with no todo keyword, priority cookie or tag) as its
1618 ;; fallback value.
1624 plist :title
1627 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1631 ;; Handle other keywords. TITLE keyword is excluded as it has
1632 ;; been handled already.
1640 ;; Export properties are not case-sensitive.
1647 plist
1648 property
1650 ;; Parse VALUE if required.
1654 ;; If BEHAVIOR is `split' expected value is
1655 ;; a list of strings, not a string.
1658 ;; Look for both general keywords and back-end specific
1659 ;; options, with priority given to the latter.
1661 org-export-options-alist)))
1662 ;; Return value.
1663 plist)))
1666 "Return current buffer export options, as a plist.
1668 Optional argument BACKEND, when non-nil, is an export back-end,
1669 as returned by, e.g., `org-export-create-backend'. It specifies
1670 which back-end specific options should also be read in the
1671 process.
1673 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1675 get-options ; For byte-compiler.
1678 ;; Priority is given to back-end specific options.
1680 org-export-options-alist))
1683 org-export-special-keywords))))
1686 ;; Return all properties associated to KEYWORD.
1693 ;; Recursively read keywords in buffer. FILES is a list
1694 ;; of files read so far. PLIST is the current property
1695 ;; list obtained.
1704 ;; Options in `org-export-special-keywords'.
1708 ;; Avoid circular dependencies.
1718 plist
1723 plist
1729 ;; Options in `org-export-options-alist'.
1734 plist property
1735 ;; Handle value depending on specified
1736 ;; BEHAVIOR.
1742 " "
1755 ;; Return final value.
1756 plist))))
1757 ;; Read options in the current buffer.
1760 ;; Parse keywords specified in `org-element-document-properties'
1761 ;; and return PLIST.
1772 "Return properties related to buffer attributes, as a plist."
1773 ;; Store full path of input file name, or nil. For internal use.
1781 "Return global export options as a plist.
1782 Optional argument BACKEND, if non-nil, is an export back-end, as
1783 returned by, e.g., `org-export-create-backend'. It specifies
1784 which back-end specific export options should also be read in the
1785 process."
1787 ;; Priority is given to back-end specific options.
1789 org-export-options-alist)))
1796 plist
1797 prop
1798 ;; Eval default value provided. If keyword is
1799 ;; a member of `org-element-document-properties',
1800 ;; parse it as a secondary string before storing it.
1807 value)))))))))))
1810 "Return variables bound from BIND keywords in current buffer.
1811 Also look for BIND keywords in setup files. The return value is
1812 an alist where associations are (VARIABLE-NAME VALUE)."
1817 ;; Return an alist between variable names and their
1818 ;; value. FILES is a list of setup files names read so
1819 ;; far, used to avoid circular dependencies. ALIST is
1820 ;; the alist collected so far.
1831 ;; Enter setup file.
1841 alist))))))))))
1842 alist)))))
1843 ;; Return value in appropriate order of appearance.
1846 ;; defsubst org-export-get-parent must be defined before first use,
1847 ;; was originally defined in the topology section
1850 "Return BLOB parent or nil.
1851 BLOB is the element or object considered."
1854 ;;;; Tree Properties
1855 ;;
1856 ;; Tree properties are information extracted from parse tree. They
1857 ;; are initialized at the beginning of the transcoding process by
1858 ;; `org-export-collect-tree-properties'.
1859 ;;
1860 ;; Dedicated functions focus on computing the value of specific tree
1861 ;; properties during initialization. Thus,
1862 ;; `org-export--populate-ignore-list' lists elements and objects that
1863 ;; should be skipped during export, `org-export--get-min-level' gets
1864 ;; the minimal exportable level, used as a basis to compute relative
1865 ;; level for headlines. Eventually
1866 ;; `org-export--collect-headline-numbering' builds an alist between
1867 ;; headlines and their numbering.
1870 "Extract tree properties from parse tree.
1872 DATA is the parse tree from which information is retrieved. INFO
1873 is a list holding export options.
1875 Following tree properties are set or updated:
1877 `:exported-data' Hash table used to memoize results from
1878 `org-export-data'.
1880 `:footnote-definition-alist' List of footnotes definitions in
1881 original buffer and current parse tree.
1883 `:headline-offset' Offset between true level of headlines and
1884 local level. An offset of -1 means a headline
1885 of level 2 should be considered as a level
1886 1 headline in the context.
1888 `:headline-numbering' Alist of all headlines as key an the
1889 associated numbering as value.
1891 `:ignore-list' List of elements that should be ignored during
1892 export.
1894 Return updated plist."
1895 ;; Install the parse tree in the communication channel, in order to
1896 ;; use `org-export-get-genealogy' and al.
1898 ;; Get the list of elements and objects to ignore, and put it into
1899 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1900 ;; been done during parse tree filtering.
1903 :ignore-list
1906 ;; Compute `:headline-offset' in order to be able to use
1907 ;; `org-export-get-relative-level'.
1910 :headline-offset
1912 ;; Update footnotes definitions list with definitions in parse tree.
1913 ;; This is required since buffer expansion might have modified
1914 ;; boundaries of footnote definitions contained in the parse tree.
1915 ;; This way, definitions in `footnote-definition-alist' are bound to
1916 ;; match those in the parse tree.
1922 defs)))
1924 ;; Properties order doesn't matter: get the rest of the tree
1925 ;; properties.
1929 info))
1932 "Return minimum exportable headline's level in DATA.
1933 DATA is parsed tree as returned by `org-element-parse-buffer'.
1934 OPTIONS is a plist holding export options."
1945 ;; If no headline was found, for the sake of consistency, set
1946 ;; minimum level to 1 nonetheless.
1950 "Return numbering of all exportable headlines in a parse tree.
1952 DATA is the parse tree. OPTIONS is the plist holding export
1953 options.
1955 Return an alist whose key is a headline and value is its
1956 associated numbering \(in the shape of a list of numbers\) or nil
1957 for a footnotes section."
1965 headline
1967 for idx from 0 to org-export-max-depth
1971 options)))
1974 "Return list of elements and objects to ignore during export.
1975 DATA is the parse tree to traverse. OPTIONS is the plist holding
1976 export options."
1978 walk-data
1979 ;; First find trees containing a select tag, if any.
1983 ;; Collect ignored elements or objects into IGNORE-LIST.
1989 ;; If headline is archived but tree below has
1990 ;; to be skipped, add it to ignore list.
1993 ;; Move into secondary string, if any.
1998 ;; Move into recursive objects/elements.
2000 ;; Main call.
2002 ;; Return value.
2003 ignore))
2006 "Return list of headlines and inlinetasks with a select tag in their tree.
2007 DATA is parsed data as returned by `org-element-parse-buffer'.
2008 INFO is a plist holding export options."
2010 walk-data ; For byte-compiler.
2020 ;; When a select tag is found, mark full
2021 ;; genealogy and every headline within the tree
2022 ;; as acceptable.
2025 genealogy
2028 selected-trees))
2029 ;; If at a headline, continue searching in tree,
2030 ;; recursively.
2040 selected-trees))
2043 "Non-nil when element or object BLOB should be skipped during export.
2044 OPTIONS is the plist holding export options. SELECTED, when
2045 non-nil, is a list of headlines or inlinetasks belonging to
2046 a tree with a select tag."
2053 ;; If `:with-drawers' value starts with `not', ignore
2054 ;; every drawer whose name belong to that list.
2055 ;; Otherwise, ignore drawers whose name isn't in that
2056 ;; list.
2072 ;; Ignore subtrees with an exclude tag.
2075 ;; When a select tag is present in the buffer, ignore any tree
2076 ;; without it.
2078 ;; Ignore commented sub-trees.
2080 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2082 ;; Ignore tasks, if specified by `:with-tasks' property.
2097 ;; `:with-timestamps' only applies to isolated timestamps
2098 ;; objects, i.e. timestamp objects in a paragraph containing only
2099 ;; timestamps and whitespaces.
2107 options t))))
2116 \f
2117 ;;; The Transcoder
2118 ;;
2119 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2120 ;; `org-element-parse-buffer') and transcodes it into a specified
2121 ;; back-end output. It takes care of filtering out elements or
2122 ;; objects according to export options and organizing the output blank
2123 ;; lines and white space are preserved. The function memoizes its
2124 ;; results, so it is cheap to call it within transcoders.
2125 ;;
2126 ;; It is possible to modify locally the back-end used by
2127 ;; `org-export-data' or even use a temporary back-end by using
2128 ;; `org-export-data-with-backend'.
2129 ;;
2130 ;; Internally, three functions handle the filtering of objects and
2131 ;; elements during the export. In particular,
2132 ;; `org-export-ignore-element' marks an element or object so future
2133 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2134 ;; elements or objects should be seen as real Org syntax and
2135 ;; `org-export-expand' transforms the others back into their original
2136 ;; shape
2137 ;;
2138 ;; `org-export-transcoder' is an accessor returning appropriate
2139 ;; translator function for a given element or object.
2142 "Return appropriate transcoder for BLOB.
2143 INFO is a plist containing export directives."
2145 ;; Return contents only for complete parse trees.
2151 "Convert DATA into current back-end format.
2153 DATA is a parse tree, an element or an object or a secondary
2154 string. INFO is a plist holding export options.
2156 Return a string."
2161 ;; Ignored element/object.
2163 ;; Plain text.
2169 info))
2170 ;; Uninterpreted element/object: change it back to Org
2171 ;; syntax and export again resulting raw string.
2175 data
2179 info))
2180 ;; Secondary string.
2183 ;; Element/Object without contents or, as a special
2184 ;; case, headline with archive tag and archived trees
2185 ;; restricted to title only.
2193 ;; Export snippets never return a nil value so
2194 ;; that white spaces following them are never
2195 ;; ignored.
2197 ;; Element/Object with contents.
2210 ;; Elements directly containing
2211 ;; objects must have their indentation
2212 ;; normalized first.
2214 data
2215 ;; When normalizing contents of the
2216 ;; first paragraph in an item or
2217 ;; a footnote definition, ignore
2218 ;; first line's indentation: there is
2219 ;; none and it might be misleading.
2224 data)
2231 info))))))))
2232 ;; Final result will be memoized before being returned.
2234 data
2238 ;; Append the same white space between elements or objects
2239 ;; as in the original buffer, and call appropriate filters.
2250 info)))
2251 results)))
2255 "Convert DATA into BACKEND format.
2257 DATA is an element, an object, a secondary string or a string.
2258 BACKEND is a symbol. INFO is a plist used as a communication
2259 channel.
2261 Unlike to `org-export-with-backend', this function will
2262 recursively convert DATA using BACKEND translation table."
2265 data
2266 ;; Set-up a new communication channel with translations defined in
2267 ;; BACKEND as the translate table and a new hash table for
2268 ;; memoization.
2270 info
2273 ;; Size of the hash table is reduced since this function
2274 ;; will probably be used on small trees.
2278 "Non-nil if element or object BLOB should be interpreted during export.
2279 If nil, BLOB will appear as raw Org syntax. Check is done
2280 according to export options INFO, stored as a plist."
2282 ;; ... entities...
2284 ;; ... emphasis...
2287 ;; ... fixed-width areas.
2289 ;; ... LaTeX environments and fragments...
2293 ;; ... sub/superscripts...
2299 ;; ... tables...
2304 "Expand a parsed element or object to its original state.
2306 BLOB is either an element or an object. CONTENTS is its
2307 contents, as a string or nil.
2309 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2310 keywords before output."
2315 blob contents))))
2318 "Add ELEMENT to `:ignore-list' in INFO.
2320 Any element in `:ignore-list' will be skipped when using
2321 `org-element-map'. INFO is modified by side effects."
2325 \f
2326 ;;; The Filter System
2327 ;;
2328 ;; Filters allow end-users to tweak easily the transcoded output.
2329 ;; They are the functional counterpart of hooks, as every filter in
2330 ;; a set is applied to the return value of the previous one.
2331 ;;
2332 ;; Every set is back-end agnostic. Although, a filter is always
2333 ;; called, in addition to the string it applies to, with the back-end
2334 ;; used as argument, so it's easy for the end-user to add back-end
2335 ;; specific filters in the set. The communication channel, as
2336 ;; a plist, is required as the third argument.
2337 ;;
2338 ;; From the developer side, filters sets can be installed in the
2339 ;; process with the help of `org-export-define-backend', which
2340 ;; internally stores filters as an alist. Each association has a key
2341 ;; among the following symbols and a function or a list of functions
2342 ;; as value.
2343 ;;
2344 ;; - `:filter-options' applies to the property list containing export
2345 ;; options. Unlike to other filters, functions in this list accept
2346 ;; two arguments instead of three: the property list containing
2347 ;; export options and the back-end. Users can set its value through
2348 ;; `org-export-filter-options-functions' variable.
2349 ;;
2350 ;; - `:filter-parse-tree' applies directly to the complete parsed
2351 ;; tree. Users can set it through
2352 ;; `org-export-filter-parse-tree-functions' variable.
2353 ;;
2354 ;; - `:filter-final-output' applies to the final transcoded string.
2355 ;; Users can set it with `org-export-filter-final-output-functions'
2356 ;; variable
2357 ;;
2358 ;; - `:filter-plain-text' applies to any string not recognized as Org
2359 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2360 ;; configure it.
2361 ;;
2362 ;; - `:filter-TYPE' applies on the string returned after an element or
2363 ;; object of type TYPE has been transcoded. A user can modify
2364 ;; `org-export-filter-TYPE-functions'
2365 ;;
2366 ;; All filters sets are applied with
2367 ;; `org-export-filter-apply-functions' function. Filters in a set are
2368 ;; applied in a LIFO fashion. It allows developers to be sure that
2369 ;; their filters will be applied first.
2370 ;;
2371 ;; Filters properties are installed in communication channel with
2372 ;; `org-export-install-filters' function.
2373 ;;
2374 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2375 ;; `org-export-before-parsing-hook') are run at the beginning of the
2376 ;; export process and just before parsing to allow for heavy structure
2377 ;; modifications.
2380 ;;;; Hooks
2383 "Hook run at the beginning of the export process.
2385 This is run before include keywords and macros are expanded and
2386 Babel code blocks executed, on a copy of the original buffer
2387 being exported. Visibility and narrowing are preserved. Point
2388 is at the beginning of the buffer.
2390 Every function in this hook will be called with one argument: the
2394 "Hook run before parsing an export buffer.
2396 This is run after include keywords and macros have been expanded
2397 and Babel code blocks executed, on a copy of the original buffer
2398 being exported. Visibility and narrowing are preserved. Point
2399 is at the beginning of the buffer.
2401 Every function in this hook will be called with one argument: the
2405 ;;;; Special Filters
2408 "List of functions applied to the export options.
2409 Each filter is called with two arguments: the export options, as
2410 a plist, and the back-end, as a symbol. It must return
2414 "List of functions applied to the parsed tree.
2415 Each filter is called with three arguments: the parse tree, as
2416 returned by `org-element-parse-buffer', the back-end, as
2417 a symbol, and the communication channel, as a plist. It must
2421 "List of functions applied to plain text.
2422 Each filter is called with three arguments: a string which
2423 contains no Org syntax, the back-end, as a symbol, and the
2424 communication channel, as a plist. It must return a string or
2428 "List of functions applied to the transcoded string.
2429 Each filter is called with three arguments: the full transcoded
2430 string, the back-end, as a symbol, and the communication channel,
2431 as a plist. It must return a string that will be used as the
2435 ;;;; Elements Filters
2438 "List of functions applied to a transcoded babel-call.
2439 Each filter is called with three arguments: the transcoded data,
2440 as a string, the back-end, as a symbol, and the communication
2444 "List of functions applied to a transcoded center block.
2445 Each filter is called with three arguments: the transcoded data,
2446 as a string, the back-end, as a symbol, and the communication
2450 "List of functions applied to a transcoded clock.
2451 Each filter is called with three arguments: the transcoded data,
2452 as a string, the back-end, as a symbol, and the communication
2456 "List of functions applied to a transcoded comment.
2457 Each filter is called with three arguments: the transcoded data,
2458 as a string, the back-end, as a symbol, and the communication
2462 "List of functions applied to a transcoded comment-block.
2463 Each filter is called with three arguments: the transcoded data,
2464 as a string, the back-end, as a symbol, and the communication
2468 "List of functions applied to a transcoded diary-sexp.
2469 Each filter is called with three arguments: the transcoded data,
2470 as a string, the back-end, as a symbol, and the communication
2474 "List of functions applied to a transcoded drawer.
2475 Each filter is called with three arguments: the transcoded data,
2476 as a string, the back-end, as a symbol, and the communication
2480 "List of functions applied to a transcoded dynamic-block.
2481 Each filter is called with three arguments: the transcoded data,
2482 as a string, the back-end, as a symbol, and the communication
2486 "List of functions applied to a transcoded example-block.
2487 Each filter is called with three arguments: the transcoded data,
2488 as a string, the back-end, as a symbol, and the communication
2492 "List of functions applied to a transcoded export-block.
2493 Each filter is called with three arguments: the transcoded data,
2494 as a string, the back-end, as a symbol, and the communication
2498 "List of functions applied to a transcoded fixed-width.
2499 Each filter is called with three arguments: the transcoded data,
2500 as a string, the back-end, as a symbol, and the communication
2504 "List of functions applied to a transcoded footnote-definition.
2505 Each filter is called with three arguments: the transcoded data,
2506 as a string, the back-end, as a symbol, and the communication
2510 "List of functions applied to a transcoded headline.
2511 Each filter is called with three arguments: the transcoded data,
2512 as a string, the back-end, as a symbol, and the communication
2516 "List of functions applied to a transcoded horizontal-rule.
2517 Each filter is called with three arguments: the transcoded data,
2518 as a string, the back-end, as a symbol, and the communication
2522 "List of functions applied to a transcoded inlinetask.
2523 Each filter is called with three arguments: the transcoded data,
2524 as a string, the back-end, as a symbol, and the communication
2528 "List of functions applied to a transcoded item.
2529 Each filter is called with three arguments: the transcoded data,
2530 as a string, the back-end, as a symbol, and the communication
2534 "List of functions applied to a transcoded keyword.
2535 Each filter is called with three arguments: the transcoded data,
2536 as a string, the back-end, as a symbol, and the communication
2540 "List of functions applied to a transcoded latex-environment.
2541 Each filter is called with three arguments: the transcoded data,
2542 as a string, the back-end, as a symbol, and the communication
2546 "List of functions applied to a transcoded node-property.
2547 Each filter is called with three arguments: the transcoded data,
2548 as a string, the back-end, as a symbol, and the communication
2552 "List of functions applied to a transcoded paragraph.
2553 Each filter is called with three arguments: the transcoded data,
2554 as a string, the back-end, as a symbol, and the communication
2558 "List of functions applied to a transcoded plain-list.
2559 Each filter is called with three arguments: the transcoded data,
2560 as a string, the back-end, as a symbol, and the communication
2564 "List of functions applied to a transcoded planning.
2565 Each filter is called with three arguments: the transcoded data,
2566 as a string, the back-end, as a symbol, and the communication
2570 "List of functions applied to a transcoded property-drawer.
2571 Each filter is called with three arguments: the transcoded data,
2572 as a string, the back-end, as a symbol, and the communication
2576 "List of functions applied to a transcoded quote block.
2577 Each filter is called with three arguments: the transcoded quote
2578 data, as a string, the back-end, as a symbol, and the
2579 communication channel, as a plist. It must return a string or
2583 "List of functions applied to a transcoded quote-section.
2584 Each filter is called with three arguments: the transcoded data,
2585 as a string, the back-end, as a symbol, and the communication
2589 "List of functions applied to a transcoded section.
2590 Each filter is called with three arguments: the transcoded data,
2591 as a string, the back-end, as a symbol, and the communication
2595 "List of functions applied to a transcoded special block.
2596 Each filter is called with three arguments: the transcoded data,
2597 as a string, the back-end, as a symbol, and the communication
2601 "List of functions applied to a transcoded src-block.
2602 Each filter is called with three arguments: the transcoded data,
2603 as a string, the back-end, as a symbol, and the communication
2607 "List of functions applied to a transcoded table.
2608 Each filter is called with three arguments: the transcoded data,
2609 as a string, the back-end, as a symbol, and the communication
2613 "List of functions applied to a transcoded table-cell.
2614 Each filter is called with three arguments: the transcoded data,
2615 as a string, the back-end, as a symbol, and the communication
2619 "List of functions applied to a transcoded table-row.
2620 Each filter is called with three arguments: the transcoded data,
2621 as a string, the back-end, as a symbol, and the communication
2625 "List of functions applied to a transcoded verse block.
2626 Each filter is called with three arguments: the transcoded data,
2627 as a string, the back-end, as a symbol, and the communication
2631 ;;;; Objects Filters
2634 "List of functions applied to transcoded bold text.
2635 Each filter is called with three arguments: the transcoded data,
2636 as a string, the back-end, as a symbol, and the communication
2640 "List of functions applied to transcoded code text.
2641 Each filter is called with three arguments: the transcoded data,
2642 as a string, the back-end, as a symbol, and the communication
2646 "List of functions applied to a transcoded entity.
2647 Each filter is called with three arguments: the transcoded data,
2648 as a string, the back-end, as a symbol, and the communication
2652 "List of functions applied to a transcoded export-snippet.
2653 Each filter is called with three arguments: the transcoded data,
2654 as a string, the back-end, as a symbol, and the communication
2658 "List of functions applied to a transcoded footnote-reference.
2659 Each filter is called with three arguments: the transcoded data,
2660 as a string, the back-end, as a symbol, and the communication
2664 "List of functions applied to a transcoded inline-babel-call.
2665 Each filter is called with three arguments: the transcoded data,
2666 as a string, the back-end, as a symbol, and the communication
2670 "List of functions applied to a transcoded inline-src-block.
2671 Each filter is called with three arguments: the transcoded data,
2672 as a string, the back-end, as a symbol, and the communication
2676 "List of functions applied to transcoded italic text.
2677 Each filter is called with three arguments: the transcoded data,
2678 as a string, the back-end, as a symbol, and the communication
2682 "List of functions applied to a transcoded latex-fragment.
2683 Each filter is called with three arguments: the transcoded data,
2684 as a string, the back-end, as a symbol, and the communication
2688 "List of functions applied to a transcoded line-break.
2689 Each filter is called with three arguments: the transcoded data,
2690 as a string, the back-end, as a symbol, and the communication
2694 "List of functions applied to a transcoded link.
2695 Each filter is called with three arguments: the transcoded data,
2696 as a string, the back-end, as a symbol, and the communication
2700 "List of functions applied to a transcoded radio-target.
2701 Each filter is called with three arguments: the transcoded data,
2702 as a string, the back-end, as a symbol, and the communication
2706 "List of functions applied to a transcoded statistics-cookie.
2707 Each filter is called with three arguments: the transcoded data,
2708 as a string, the back-end, as a symbol, and the communication
2712 "List of functions applied to transcoded strike-through text.
2713 Each filter is called with three arguments: the transcoded data,
2714 as a string, the back-end, as a symbol, and the communication
2718 "List of functions applied to a transcoded subscript.
2719 Each filter is called with three arguments: the transcoded data,
2720 as a string, the back-end, as a symbol, and the communication
2724 "List of functions applied to a transcoded superscript.
2725 Each filter is called with three arguments: the transcoded data,
2726 as a string, the back-end, as a symbol, and the communication
2730 "List of functions applied to a transcoded target.
2731 Each filter is called with three arguments: the transcoded data,
2732 as a string, the back-end, as a symbol, and the communication
2736 "List of functions applied to a transcoded timestamp.
2737 Each filter is called with three arguments: the transcoded data,
2738 as a string, the back-end, as a symbol, and the communication
2742 "List of functions applied to transcoded underline text.
2743 Each filter is called with three arguments: the transcoded data,
2744 as a string, the back-end, as a symbol, and the communication
2748 "List of functions applied to transcoded verbatim text.
2749 Each filter is called with three arguments: the transcoded data,
2750 as a string, the back-end, as a symbol, and the communication
2754 ;;;; Filters Tools
2755 ;;
2756 ;; Internal function `org-export-install-filters' installs filters
2757 ;; hard-coded in back-ends (developer filters) and filters from global
2758 ;; variables (user filters) in the communication channel.
2759 ;;
2760 ;; Internal function `org-export-filter-apply-functions' takes care
2761 ;; about applying each filter in order to a given data. It ignores
2762 ;; filters returning a nil value but stops whenever a filter returns
2763 ;; an empty string.
2766 "Call every function in FILTERS.
2768 Functions are called with arguments VALUE, current export
2769 back-end's name and INFO. A function returning a nil value will
2770 be skipped. If it returns the empty string, the process ends and
2771 VALUE is ignored.
2773 Call is done in a LIFO fashion, to be sure that developer
2774 specified filters, if any, are called first."
2785 "Install filters properties in communication channel.
2786 INFO is a plist containing the current communication channel.
2787 Return the updated communication channel."
2789 ;; Install user-defined filters with `org-export-filters-alist'
2790 ;; and filters already in INFO (through ext-plist mechanism).
2797 ;; Filters in INFO will be called
2798 ;; before those user provided.
2801 default-value)))))
2802 org-export-filters-alist)
2803 ;; Prepend back-end specific filters to that list.
2805 ;; Single values get consed, lists are appended.
2810 plist key
2814 ;; Return new communication channel.
2818 \f
2819 ;;; Core functions
2820 ;;
2821 ;; This is the room for the main function, `org-export-as', along with
2822 ;; its derivative, `org-export-string-as'.
2823 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2824 ;; function should be added to kill ring.
2825 ;;
2826 ;; Note that `org-export-as' doesn't really parse the current buffer,
2827 ;; but a copy of it (with the same buffer-local variables and
2828 ;; visibility), where macros and include keywords are expanded and
2829 ;; Babel blocks are executed, if appropriate.
2830 ;; `org-export-with-buffer-copy' macro prepares that copy.
2831 ;;
2832 ;; File inclusion is taken care of by
2833 ;; `org-export-expand-include-keyword' and
2834 ;; `org-export--prepare-file-contents'. Structure wise, including
2835 ;; a whole Org file in a buffer often makes little sense. For
2836 ;; example, if the file contains a headline and the include keyword
2837 ;; was within an item, the item should contain the headline. That's
2838 ;; why file inclusion should be done before any structure can be
2839 ;; associated to the file, that is before parsing.
2840 ;;
2841 ;; `org-export-insert-default-template' is a command to insert
2842 ;; a default template (or a back-end specific template) at point or in
2843 ;; current subtree.
2846 "Return a copy of the current buffer.
2847 The copy preserves Org buffer-local variables, visibility and
2848 narrowing."
2854 new-buf))
2857 "Apply BODY in a copy of the current buffer.
2858 The copy preserves local variables, visibility and contents of
2859 the original buffer. Point is at the beginning of the buffer
2860 when BODY is applied."
2869 ;; Kill copy without confirmation.
2875 "Generate a function duplicating BUFFER.
2877 The copy will preserve local variables, visibility, contents and
2878 narrowing of the original buffer. If a region was active in
2879 BUFFER, contents will be narrowed to that region instead.
2881 The resulting function can be evaluated at a later time, from
2882 another buffer, effectively cloning the original buffer there.
2884 The function assumes BUFFER's major mode is `org-mode'."
2888 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2889 ;; already in BUFFER.
2891 ;; Copy specific buffer local variables and variables set
2892 ;; through BIND keywords.
2894 vars)
2902 buffer-file-name
2903 buffer-file-coding-system))
2907 ;; Skip unreadable values, as they cannot be
2908 ;; sent to external process.
2912 vars))))))
2913 ;; Whole buffer contents.
2918 ;; Narrowing.
2922 ;; Current position of point.
2924 ;; Overlays with invisible property.
2934 ov-set))))
2936 ov-set)))))
2938 ;;;###autoload
2941 "Transcode current Org buffer into BACKEND code.
2943 BACKEND is either an export back-end, as returned by, e.g.,
2944 `org-export-create-backend', or a symbol referring to
2945 a registered back-end.
2947 If narrowing is active in the current buffer, only transcode its
2948 narrowed part.
2950 If a region is active, transcode that region.
2952 When optional argument SUBTREEP is non-nil, transcode the
2953 sub-tree at point, extracting information from the headline
2954 properties first.
2956 When optional argument VISIBLE-ONLY is non-nil, don't export
2957 contents of hidden elements.
2959 When optional argument BODY-ONLY is non-nil, only return body
2960 code, without surrounding template.
2962 Optional argument EXT-PLIST, when provided, is a property list
2963 with external parameters overriding Org default settings, but
2964 still inferior to file-local settings.
2966 Return code as a string."
2971 ;; Narrow buffer to an appropriate region or subtree for
2972 ;; parsing. If parsing subtree, be sure to remove main headline
2973 ;; too.
2981 ;; Initialize communication channel with original buffer
2982 ;; attributes, unavailable in its copy.
2991 tree)
2992 ;; Update communication channel and get parse tree. Buffer
2993 ;; isn't parsed directly. Instead, a temporary copy is
2994 ;; created, where include keywords, macros are expanded and
2995 ;; code blocks are evaluated.
2997 ;; Run first hook with current back-end's name as argument.
3001 ;; Update macro templates since #+INCLUDE keywords might have
3002 ;; added some new ones.
3006 ;; Update radio targets since keyword inclusion might have
3007 ;; added some more.
3009 ;; Run last hook with current back-end's name as argument.
3014 ;; Update communication channel with environment. Also
3015 ;; install user's and developer's filters.
3020 ;; Expand export-specific set of macros: {{{author}}},
3021 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3022 ;; once regular macros have been expanded, since document
3023 ;; keywords may contain one of them.
3029 ;; EMAIL is not a parsed keyword: store it as-is.
3033 ;; Call options filters and update export options. We do not
3034 ;; use `org-export-filter-apply-functions' here since the
3035 ;; arity of such filters is different.
3040 ;; Parse buffer and call parse-tree filter on it.
3045 ;; Now tree is complete, compute its properties and add them
3046 ;; to communication channel.
3050 ;; Eventually transcode TREE. Wrap the resulting string into
3051 ;; a template.
3060 ;; Remove all text properties since they cannot be
3061 ;; retrieved from an external process. Finally call
3062 ;; final-output filter and return result.
3068 info))))))))
3070 ;;;###autoload
3072 "Transcode STRING into BACKEND code.
3074 BACKEND is either an export back-end, as returned by, e.g.,
3075 `org-export-create-backend', or a symbol referring to
3076 a registered back-end.
3078 When optional argument BODY-ONLY is non-nil, only return body
3079 code, without preamble nor postamble.
3081 Optional argument EXT-PLIST, when provided, is a property list
3082 with external parameters overriding Org default settings, but
3083 still inferior to file-local settings.
3085 Return code as a string."
3091 ;;;###autoload
3093 "Replace the active region by its export to BACKEND.
3094 BACKEND is either an export back-end, as returned by, e.g.,
3095 `org-export-create-backend', or a symbol referring to
3096 a registered back-end."
3106 ;;;###autoload
3108 "Insert all export keywords with default values at beginning of line.
3110 BACKEND is a symbol referring to the name of a registered export
3111 back-end, for which specific export options should be added to
3112 the template, or `default' for default template. When it is nil,
3113 the user will be prompted for a category.
3115 If SUBTREEP is non-nil, export configuration will be set up
3116 locally for the subtree through node properties."
3126 "Options category: "
3130 org-export--registered-backends))))))
3131 options keywords)
3132 ;; Populate OPTIONS and KEYWORDS.
3149 ;; Move to an appropriate location in order to insert options.
3151 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3152 ;; list of available keywords.
3180 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3198 ;; And the rest of keywords.
3209 "Expand every include keyword in buffer.
3210 Optional argument INCLUDED is a list of included file names along
3211 with their line restriction, when appropriate. It is used to
3212 avoid infinite recursion. Optional argument DIR is the current
3213 working directory. It is used to properly resolve relative
3214 paths."
3221 ;; Extract arguments from keyword's value.
3229 dir)
3234 value)
3240 ;; Minimal level of included file defaults to the child
3241 ;; level of the current headline, if any, or one. It
3242 ;; only applies is the file is meant to be included as
3243 ;; an Org one.
3251 ;; Remove keyword.
3257 ;; Check if files has already been parsed. Look after
3258 ;; inclusion lines too, as different parts of the same file
3259 ;; can be included too.
3271 ind-str contents ind-str))))
3279 ind-str env contents ind-str))))
3292 "Prepare the contents of FILE for inclusion and return them as a string.
3294 When optional argument LINES is a string specifying a range of
3295 lines, include only those lines.
3297 Optional argument IND, when non-nil, is an integer specifying the
3298 global indentation of returned contents. Since its purpose is to
3299 allow an included file to stay in the same environment it was
3300 created \(i.e. a list item), it doesn't apply past the first
3301 headline encountered.
3303 Optional argument MINLEVEL, when non-nil, is an integer
3304 specifying the level that any top-level headline in the included
3305 file should have."
3321 ;; Remove blank lines at beginning and end of contents. The logic
3322 ;; behind that removal is that blank lines around include keyword
3323 ;; override blank lines in included file.
3332 ;; If IND is set, preserve indentation of include keyword until
3333 ;; the first headline encountered.
3340 ;; Do not move footnote definitions out of column 0.
3346 ;; When MINLEVEL is specified, compute minimal level for headlines
3347 ;; in the file (CUR-MIN), and remove stars to each headline so
3348 ;; that headlines with minimal level have a level of MINLEVEL.
3359 ;; Only change stars, don't bother moving whole
3360 ;; sections.
3367 "Execute every Babel code in the visible part of current buffer."
3368 ;; Get a pristine copy of current buffer so Babel references can be
3369 ;; properly resolved.
3376 "Return a non-nil value when output should be added to the kill ring.
3377 See also `org-export-copy-to-kill-ring'."
3383 \f
3384 ;;; Tools For Back-Ends
3385 ;;
3386 ;; A whole set of tools is available to help build new exporters. Any
3387 ;; function general enough to have its use across many back-ends
3388 ;; should be added here.
3390 ;;;; For Affiliated Keywords
3391 ;;
3392 ;; `org-export-read-attribute' reads a property from a given element
3393 ;; as a plist. It can be used to normalize affiliated keywords'
3394 ;; syntax.
3395 ;;
3396 ;; Since captions can span over multiple lines and accept dual values,
3397 ;; their internal representation is a bit tricky. Therefore,
3398 ;; `org-export-get-caption' transparently returns a given element's
3399 ;; caption as a secondary string.
3402 "Turn ATTRIBUTE property from ELEMENT into a plist.
3404 When optional argument PROPERTY is non-nil, return the value of
3405 that property within attributes.
3409 properties.
3411 All values will become strings except the empty string and
3414 will become the empty string."
3428 s)
3433 ;; Ignore any string before first property with `cdr'.
3438 "Return caption from ELEMENT as a secondary string.
3440 When optional argument SHORTP is non-nil, return short caption,
3441 as a secondary string, instead.
3443 Caption lines are separated by a white space."
3451 ;;;; For Derived Back-ends
3452 ;;
3453 ;; `org-export-with-backend' is a function allowing to locally use
3454 ;; another back-end to transcode some object or element. In a derived
3455 ;; back-end, it may be used as a fall-back function once all specific
3456 ;; cases have been treated.
3459 "Call a transcoder from BACKEND on DATA.
3460 BACKEND is an export back-end, as returned by, e.g.,
3461 `org-export-create-backend', or a symbol referring to
3462 a registered back-end. DATA is an Org element, object, secondary
3463 string or string. CONTENTS, when non-nil, is the transcoded
3464 contents of DATA element, as a string. INFO, when non-nil, is
3465 the communication channel used for export, as a plist."
3475 transcoder data contents
3478 :translate-alist all-transcoders
3482 ;;;; For Export Snippets
3483 ;;
3484 ;; Every export snippet is transmitted to the back-end. Though, the
3485 ;; latter will only retain one type of export-snippet, ignoring
3486 ;; others, based on the former's target back-end. The function
3487 ;; `org-export-snippet-backend' returns that back-end for a given
3488 ;; export-snippet.
3491 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3492 Translation, with `org-export-snippet-translation-alist', is
3493 applied."
3497 back-end))))
3500 ;;;; For Footnotes
3501 ;;
3502 ;; `org-export-collect-footnote-definitions' is a tool to list
3503 ;; actually used footnotes definitions in the whole parse tree, or in
3504 ;; a headline, in order to add footnote listings throughout the
3505 ;; transcoded data.
3506 ;;
3507 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3508 ;; back-ends, when they need to attach the footnote definition only to
3509 ;; the first occurrence of the corresponding label.
3510 ;;
3511 ;; `org-export-get-footnote-definition' and
3512 ;; `org-export-get-footnote-number' provide easier access to
3513 ;; additional information relative to a footnote reference.
3516 "Return an alist between footnote numbers, labels and definitions.
3518 DATA is the parse tree from which definitions are collected.
3519 INFO is the plist used as a communication channel.
3521 Definitions are sorted by order of references. They either
3522 appear as Org data or as a secondary string for inlined
3523 footnotes. Unreferenced definitions are ignored."
3525 collect-fn ; for byte-compiler.
3529 ;; Collect footnote number, label and definition in DATA.
3537 def)
3538 num-alist)
3539 ;; Also search in definition for nested footnotes.
3542 ;; Don't enter footnote definitions since it will happen
3543 ;; when their first reference is found.
3549 "Non-nil when a footnote reference is the first one for its label.
3551 FOOTNOTE-REFERENCE is the footnote reference being considered.
3552 INFO is the plist used as a communication channel."
3554 ;; Anonymous footnotes are always a first reference.
3556 ;; Otherwise, return the first footnote with the same LABEL and
3557 ;; test if it is equal to FOOTNOTE-REFERENCE.
3567 ;; If FN isn't inlined, be sure to traverse its
3568 ;; definition before resuming search. See
3569 ;; comments in `org-export-get-footnote-number'
3570 ;; for more information.
3574 ;; Don't enter footnote definitions since it will
3575 ;; happen when their first reference is found.
3578 footnote-reference)))))
3581 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3582 INFO is the plist used as a communication channel. If no such
3584 string."
3591 "Return number associated to a footnote.
3593 FOOTNOTE is either a footnote reference or a footnote definition.
3594 INFO is the plist used as a communication channel."
3596 seen-refs
3597 search-ref ; For byte-compiler.
3601 ;; Search footnote references through DATA, filling
3602 ;; SEEN-REFS along the way.
3607 ;; Anonymous footnote match: return number.
3610 ;; Labels match: return number.
3613 ;; Anonymous footnote: it's always a new one.
3614 ;; Also, be sure to return nil from the `cond' so
3615 ;; `first-match' doesn't get us out of the loop.
3617 ;; Label not seen so far: add it so SEEN-REFS.
3618 ;;
3619 ;; Also search for subsequent references in
3620 ;; footnote definition so numbering follows
3621 ;; reading logic. Note that we don't have to care
3622 ;; about inline definitions, since
3623 ;; `org-element-map' already traverses them at the
3624 ;; right time.
3625 ;;
3626 ;; Once again, return nil to stay in the loop.
3631 nil))))
3632 ;; Don't enter footnote definitions since it will
3633 ;; happen when their first reference is found.
3638 ;;;; For Headlines
3639 ;;
3640 ;; `org-export-get-relative-level' is a shortcut to get headline
3641 ;; level, relatively to the lower headline level in the parsed tree.
3642 ;;
3643 ;; `org-export-get-headline-number' returns the section number of an
3644 ;; headline, while `org-export-number-to-roman' allows to convert it
3645 ;; to roman numbers.
3646 ;;
3647 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3648 ;; `org-export-last-sibling-p' are three useful predicates when it
3649 ;; comes to fulfill the `:headline-levels' property.
3650 ;;
3651 ;; `org-export-get-tags', `org-export-get-category' and
3652 ;; `org-export-get-node-property' extract useful information from an
3653 ;; headline or a parent headline. They all handle inheritance.
3654 ;;
3655 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3656 ;; as a secondary string, suitable for table of contents. It falls
3657 ;; back onto default title.
3660 "Return HEADLINE relative level within current parsed tree.
3661 INFO is a plist holding contextual information."
3666 "Non-nil when HEADLINE is considered as low level.
3668 INFO is a plist used as a communication channel.
3670 A low level headlines has a relative level greater than
3671 `:headline-levels' property value.
3673 Return value is the difference between HEADLINE relative level
3674 and the last level being considered as high enough, or nil."
3681 "Return HEADLINE numbering as a list of numbers.
3682 INFO is a plist holding contextual information."
3686 "Return a non-nil value if HEADLINE element should be numbered.
3687 INFO is a plist used as a communication channel."
3693 "Convert integer N into a roman numeral."
3706 res)))
3709 "Return list of tags associated to ELEMENT.
3711 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3712 is a plist used as a communication channel.
3714 Select tags (see `org-export-select-tags') and exclude tags (see
3715 `org-export-exclude-tags') are removed from the list.
3717 When non-nil, optional argument TAGS should be a list of strings.
3718 Any tag belonging to this list will also be removed.
3720 When optional argument INHERITED is non-nil, tags can also be
3721 inherited from parent headlines and FILETAGS keywords."
3727 ;; Build complete list of inherited tags.
3738 ;; Add FILETAGS keywords and return results.
3742 "Return node PROPERTY value for BLOB.
3744 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3745 element or object.
3747 If optional argument INHERITED is non-nil, the value can be
3748 inherited from a parent headline.
3750 Return value is a string or nil."
3762 "Return category for element or object BLOB.
3764 INFO is a plist used as a communication channel.
3766 CATEGORY is automatically inherited from a parent headline, from
3767 #+CATEGORY: keyword or created out of original file name. If all
3771 ;; Almost like `org-export-node-property', but we cannot trust
3772 ;; `plist-member' as every headline has a `:CATEGORY'
3773 ;; property, would it be nil or equal to "???" (which has the
3774 ;; same meaning).
3792 "Return alternative title for HEADLINE, as a secondary string.
3793 INFO is a plist used as a communication channel. If no optional
3794 title is defined, fall-back to the regular title."
3799 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3800 INFO is a plist used as a communication channel."
3805 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3806 INFO is a plist used as a communication channel."
3810 ;;;; For Keywords
3811 ;;
3812 ;; `org-export-get-date' returns a date appropriate for the document
3813 ;; to about to be exported. In particular, it takes care of
3814 ;; `org-export-date-timestamp-format'.
3817 "Return date value for the current document.
3819 INFO is a plist used as a communication channel. FMT, when
3820 non-nil, is a time format string that will be applied on the date
3821 if it consists in a single timestamp object. It defaults to
3822 `org-export-date-timestamp-format' when nil.
3824 A proper date can be a secondary string, a string or nil. It is
3825 meant to be translated with `org-export-data' or alike."
3836 ;;;; For Links
3837 ;;
3838 ;; `org-export-solidify-link-text' turns a string into a safer version
3839 ;; for links, replacing most non-standard characters with hyphens.
3840 ;;
3841 ;; `org-export-get-coderef-format' returns an appropriate format
3842 ;; string for coderefs.
3843 ;;
3844 ;; `org-export-inline-image-p' returns a non-nil value when the link
3845 ;; provided should be considered as an inline image.
3846 ;;
3847 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3848 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3849 ;; returns an appropriate unique identifier when found, or nil.
3850 ;;
3851 ;; `org-export-resolve-id-link' returns the first headline with
3852 ;; specified id or custom-id in parse tree, the path to the external
3853 ;; file with the id or nil when neither was found.
3854 ;;
3855 ;; `org-export-resolve-coderef' associates a reference to a line
3856 ;; number in the element it belongs, or returns the reference itself
3857 ;; when the element isn't numbered.
3860 "Take link text S and make a safe target out of it."
3865 "Return format string for code reference link.
3866 PATH is the link path. DESC is its description."
3874 "Non-nil if LINK object points to an inline image.
3876 Optional argument is a set of RULES defining inline images. It
3877 is an alist where associations have the following shape:
3879 \(TYPE . REGEXP)
3881 Applying a rule means apply REGEXP against LINK's path when its
3882 type is TYPE. The function will return a non-nil value if any of
3883 the provided rules is non-nil. The default rule is
3884 `org-export-default-inline-image-rule'.
3886 This only applies to links without a description."
3897 rules)
3898 ;; Return nil if no rule matched.
3899 nil))))
3902 "Resolve a code reference REF.
3904 INFO is a plist used as a communication channel.
3906 Return associated line number in source code, or REF itself,
3907 depending on src-block or example element's switches."
3914 org-coderef-label-format)))
3918 ;; Element containing REF is found. Resolve it to either
3919 ;; a label or a line number, as needed.
3929 "Return LINK destination.
3931 INFO is a plist holding contextual information.
3933 Return value can be an object, an element, or nil:
3935 - If LINK path matches a target object (i.e. <<path>>) return it.
3937 - If LINK path exactly matches the name affiliated keyword
3938 \(i.e. #+NAME: path) of an element, return that element.
3940 - If LINK path exactly matches any headline name, return that
3941 element. If more than one headline share that name, priority
3942 will be given to the one with the closest common ancestor, if
3943 any, or the first one in the parse tree otherwise.
3945 - Otherwise, return nil.
3948 significant."
3951 ;; Split PATH at white spaces so matches are space
3952 ;; insensitive.
3955 ;; Cache for destinations that are not position dependent.
3963 ;; Destination is not position dependent: use cached value.
3965 ;; First try to find a matching "<<path>>" unless user specified
3966 ;; he was looking for a headline (path starts with a "*"
3967 ;; character).
3973 path)
3974 blob))
3977 ;; Then try to find an element with a matching "#+NAME: path"
3978 ;; affiliated keyword.
3981 org-element-all-elements
3986 el)))
3989 ;; Last case: link either points to a headline or to nothingness.
3990 ;; Try to find the source, with priority given to headlines with
3991 ;; the closest common ancestor. If such candidate is found,
3992 ;; return it, otherwise return nil.
3996 ;; Return first headline whose `:raw-value' property is
3997 ;; NAME in parse tree DATA, or nil. Statistics cookies
3998 ;; are ignored.
4006 name)
4007 headline))
4009 ;; Search among headlines sharing an ancestor with link, from
4010 ;; closest to farthest.
4019 ;; No destination found: return nil.
4023 "Return headline referenced as LINK destination.
4025 INFO is a plist used as a communication channel.
4027 Return value can be the headline element matched in current parse
4031 ;; First check if id is within the current parse tree.
4036 headline))
4038 ;; Otherwise, look for external files.
4042 "Return radio-target object referenced as LINK destination.
4044 INFO is a plist used as a communication channel.
4046 Return value can be a radio-target object or nil. Assume LINK
4055 nil nil path nil nil t)
4056 t)
4057 radio))
4061 ;;;; For References
4062 ;;
4063 ;; `org-export-get-ordinal' associates a sequence number to any object
4064 ;; or element.
4067 "Return ordinal number of an element or object.
4069 ELEMENT is the element or object considered. INFO is the plist
4070 used as a communication channel.
4072 Optional argument TYPES, when non-nil, is a list of element or
4073 object types, as symbols, that should also be counted in.
4074 Otherwise, only provided element's type is considered.
4076 Optional argument PREDICATE is a function returning a non-nil
4077 value if the current element or object should be counted in. It
4078 accepts two arguments: the element or object being considered and
4079 the plist used as a communication channel. This allows to count
4080 only a certain type of objects (i.e. inline images).
4082 Return value is a list of numbers if ELEMENT is a headline or an
4083 item. It is nil for keywords. It represents the footnote number
4084 for footnote definitions and footnote references. If ELEMENT is
4085 a target, return the same value as if ELEMENT was the closest
4086 table, item or headline containing the target. In any other
4087 case, return the sequence number of ELEMENT among elements or
4088 objects of the same type."
4089 ;; Ordinal of a target object refer to the ordinal of the closest
4090 ;; table, item, or headline containing the object.
4094 when
4098 table))
4099 return parent)))
4101 ;; Special case 1: A headline returns its number as a list.
4103 ;; Special case 2: An item returns its number as a list.
4107 struct
4114 ;; Increment counter until ELEMENT is found again.
4125 ;;;; For Src-Blocks
4126 ;;
4127 ;; `org-export-get-loc' counts number of code lines accumulated in
4128 ;; src-block or example-block elements with a "+n" switch until
4129 ;; a given element, excluded. Note: "-n" switches reset that count.
4130 ;;
4131 ;; `org-export-unravel-code' extracts source code (along with a code
4132 ;; references alist) from an `element-block' or `src-block' type
4133 ;; element.
4134 ;;
4135 ;; `org-export-format-code' applies a formatting function to each line
4136 ;; of code, providing relative line number and code reference when
4137 ;; appropriate. Since it doesn't access the original element from
4138 ;; which the source code is coming, it expects from the code calling
4139 ;; it to know if lines should be numbered and if code references
4140 ;; should appear.
4141 ;;
4142 ;; Eventually, `org-export-format-code-default' is a higher-level
4143 ;; function (it makes use of the two previous functions) which handles
4144 ;; line numbering and code references inclusion, and returns source
4145 ;; code in a format suitable for plain text or verbatim output.
4148 "Return accumulated lines of code up to ELEMENT.
4150 INFO is the plist used as a communication channel.
4152 ELEMENT is excluded from count."
4158 ;; ELEMENT is reached: Quit the loop.
4160 ;; Only count lines from src-block and example-block elements
4161 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4165 ;; Accumulate locs or reset them.
4169 ;; Return nil to stay in the loop.
4170 nil)))
4172 ;; Return value.
4173 loc))
4176 "Clean source code and extract references out of it.
4178 ELEMENT has either a `src-block' an `example-block' type.
4180 Return a cons cell whose CAR is the source code, cleaned from any
4181 reference and protective comma and CDR is an alist between
4182 relative line number (integer) and name of code reference on that
4183 line (string)."
4185 ;; Get code and clean it. Remove blank lines at its
4186 ;; beginning and end.
4192 ;; Get format used for references.
4195 org-coderef-label-format)))
4196 ;; Build a regexp matching a loc with a reference.
4201 ;; Return value.
4203 ;; Code with references removed.
4209 ;; Ref line: remove ref, and signal its position in REFS.
4213 ;; Reference alist.
4214 refs)))
4217 "Format CODE by applying FUN line-wise and return it.
4219 CODE is a string representing the code to format. FUN is
4220 a function. It must accept three arguments: a line of
4221 code (string), the current line number (integer) or nil and the
4222 reference associated to the current line (string) or nil.
4224 Optional argument NUM-LINES can be an integer representing the
4225 number of code lines accumulated until the current code. Line
4226 numbers passed to FUN will take it into account. If it is nil,
4227 FUN's second argument will always be nil. This number can be
4228 obtained with `org-export-get-loc' function.
4230 Optional argument REF-ALIST can be an alist between relative line
4231 number (i.e. ignoring NUM-LINES) and the name of the code
4232 reference on it. If it is nil, FUN's third argument will always
4233 be nil. It can be obtained through the use of
4234 `org-export-unravel-code' function."
4246 "Return source code from ELEMENT, formatted in a standard way.
4248 ELEMENT is either a `src-block' or `example-block' element. INFO
4249 is a plist used as a communication channel.
4251 This function takes care of line numbering and code references
4252 inclusion. Line numbers, when applicable, appear at the
4253 beginning of the line, separated from the code by two white
4254 spaces. Code references, on the other hand, appear flushed to
4255 the right, separated by six white spaces from the widest line of
4256 code."
4257 ;; Extract code and references.
4264 ;; Handle line numbering.
4273 ;; Prepare references display, if required. Any reference
4274 ;; should start six columns after the widest line of code,
4275 ;; wrapped with parenthesis.
4280 code
4284 number-str
4285 loc
4291 num-start refs)))))
4294 ;;;; For Tables
4295 ;;
4296 ;; `org-export-table-has-special-column-p' and and
4297 ;; `org-export-table-row-is-special-p' are predicates used to look for
4298 ;; meta-information about the table structure.
4299 ;;
4300 ;; `org-table-has-header-p' tells when the rows before the first rule
4301 ;; should be considered as table's header.
4302 ;;
4303 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4304 ;; and `org-export-table-cell-borders' extract information from
4305 ;; a table-cell element.
4306 ;;
4307 ;; `org-export-table-dimensions' gives the number on rows and columns
4308 ;; in the table, ignoring horizontal rules and special columns.
4309 ;; `org-export-table-cell-address', given a table-cell object, returns
4310 ;; the absolute address of a cell. On the other hand,
4311 ;; `org-export-get-table-cell-at' does the contrary.
4312 ;;
4313 ;; `org-export-table-cell-starts-colgroup-p',
4314 ;; `org-export-table-cell-ends-colgroup-p',
4315 ;; `org-export-table-row-starts-rowgroup-p',
4316 ;; `org-export-table-row-ends-rowgroup-p',
4317 ;; `org-export-table-row-starts-header-p' and
4318 ;; `org-export-table-row-ends-header-p' indicate position of current
4319 ;; row or cell within the table.
4322 "Non-nil when TABLE has a special column.
4323 All special columns will be ignored during export."
4324 ;; The table has a special column when every first cell of every row
4325 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4326 ;; "*" "_" and "^". Though, do not consider a first row containing
4327 ;; only empty cells as special.
4343 "Non-nil when TABLE has a header.
4345 INFO is a plist used as a communication channel.
4347 A table has a header when it contains at least two row groups."
4356 table
4367 cache)))))
4370 "Non-nil if TABLE-ROW is considered special.
4372 INFO is a plist used as the communication channel.
4374 All special rows will be ignored during export."
4378 ;; A row is special either when...
4380 ;; ... it starts with a field only containing "/",
4382 ;; ... the table contains a special column and the row start
4383 ;; with a marking character among, "^", "_", "$" or "!",
4387 ;; ... it contains only alignment cookies and empty cells.
4393 ;; Since VALUE is a secondary string, the following
4394 ;; checks avoid expanding it with `org-export-data'.
4406 "Return TABLE-ROW's group number, as an integer.
4408 INFO is a plist used as the communication channel.
4410 Return value is the group number, as an integer, or nil for
4411 special rows and rows separators. First group is also table's
4412 header."
4430 "Return TABLE-CELL contents width.
4432 INFO is a plist used as the communication channel.
4434 Return value is the width given by the last width cookie in the
4435 same column as TABLE-CELL, or nil."
4454 ;; In a special row, try to find a width cookie at COLUMN.
4458 ;; The following checks avoid expanding unnecessarily
4459 ;; the cell with `org-export-data'.
4469 "Return TABLE-CELL contents alignment.
4471 INFO is a plist used as the communication channel.
4473 Return alignment as specified by the last alignment cookie in the
4474 same column as TABLE-CELL. If no such cookie is found, a default
4475 alignment value will be deduced from fraction of numbers in the
4476 column (see `org-table-number-fraction' for more information).
4477 Possible values are `left', `right' and `center'."
4478 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4495 cookie-align
4496 previous-cell-number-p)
4499 ;; In a special row, try to find an alignment cookie at
4500 ;; COLUMN.
4504 ;; Since VALUE is a secondary string, the following
4505 ;; checks avoid useless expansion through
4506 ;; `org-export-data'.
4514 ;; Ignore table rules.
4516 ;; In a standard row, check if cell's contents are
4517 ;; expressing some kind of number. Increase NUMBER-CELLS
4518 ;; accordingly. Though, don't bother if an alignment
4519 ;; cookie has already defined cell's alignment.
4524 info)))
4526 ;; Treat an empty cell as a number if it follows
4527 ;; a number.
4533 ;; Return value. Alignment specified by cookies has
4534 ;; precedence over alignment deduced from cell's contents.
4536 column
4541 org-table-number-fraction)
4546 "Return TABLE-CELL borders.
4548 INFO is a plist used as a communication channel.
4550 Return value is a list of symbols, or nil. Possible values are:
4551 `top', `bottom', `above', `below', `left' and `right'. Note:
4552 `top' (resp. `bottom') only happen for a cell in the first
4553 row (resp. last row) of the table, ignoring table rules, if any.
4555 Returned borders ignore special rows."
4558 borders)
4559 ;; Top/above border? TABLE-CELL has a border above when a rule
4560 ;; used to demarcate row groups can be found above. Hence,
4561 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4562 ;; another regular row has to be found above that rule.
4571 ;; Look at every row before the current one.
4573 ;; No rule above, or rule found starts the table (ignoring any
4574 ;; special row): TABLE-CELL is at the top of the table.
4577 ;; Bottom/below border? TABLE-CELL has a border below when next
4578 ;; non-regular row below is a rule.
4587 ;; Look at every row after the current one.
4589 ;; No rule below, or rule found ends the table (modulo some
4590 ;; special row): TABLE-CELL is at the bottom of the table.
4593 ;; Right/left borders? They can only be specified by column
4594 ;; groups. Column groups are defined in a row starting with "/".
4595 ;; Also a column groups row only contains "<", "<>", ">" or blank
4596 ;; cells.
4613 ;; There's a left border when previous cell, if
4614 ;; any, ends a group, or current one starts one.
4620 ;; There's a right border when next cell, if any,
4621 ;; starts a group, or current one ends one.
4628 ;; Table rows are read in reverse order so last column groups
4629 ;; row has precedence over any previous one.
4631 ;; Return value.
4632 borders))
4635 "Non-nil when TABLE-CELL is at the beginning of a row group.
4636 INFO is a plist used as a communication channel."
4637 ;; A cell starts a column group either when it is at the beginning
4638 ;; of a row (or after the special column, if any) or when it has
4639 ;; a left border.
4642 table-cell)
4646 "Non-nil when TABLE-CELL is at the end of a row group.
4647 INFO is a plist used as a communication channel."
4648 ;; A cell ends a column group either when it is at the end of a row
4649 ;; or when it has a right border.
4652 table-cell)
4656 "Non-nil when TABLE-ROW is at the beginning of a column group.
4657 INFO is a plist used as a communication channel."
4665 "Non-nil when TABLE-ROW is at the end of a column group.
4666 INFO is a plist used as a communication channel."
4674 "Non-nil when TABLE-ROW is the first table header's row.
4675 INFO is a plist used as a communication channel."
4682 "Non-nil when TABLE-ROW is the last table header's row.
4683 INFO is a plist used as a communication channel."
4690 "Return TABLE-ROW number.
4691 INFO is a plist used as a communication channel. Return value is
4692 zero-based and ignores separators. The function returns nil for
4693 special columns and separators."
4705 "Return TABLE dimensions.
4707 INFO is a plist used as a communication channel.
4709 Return value is a CONS like (ROWS . COLUMNS) where
4710 ROWS (resp. COLUMNS) is the number of exportable
4711 rows (resp. columns)."
4713 ;; Set number of rows, and extract first one.
4719 ;; Set number of columns.
4721 ;; Return value.
4725 "Return address of a regular TABLE-CELL object.
4727 TABLE-CELL is the cell considered. INFO is a plist used as
4728 a communication channel.
4730 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4731 zero-based index. Only exportable cells are considered. The
4732 function returns nil for other cells."
4744 "Return regular table-cell object at ADDRESS in TABLE.
4746 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4747 zero-based index. TABLE is a table type element. INFO is
4748 a plist used as a communication channel.
4750 If no table-cell, among exportable cells, is found at ADDRESS,
4751 return nil."
4754 ;; Row at (car address) or nil.
4762 'table-cell
4769 ;;;; For Tables Of Contents
4770 ;;
4771 ;; `org-export-collect-headlines' builds a list of all exportable
4772 ;; headline elements, maybe limited to a certain depth. One can then
4773 ;; easily parse it and transcode it.
4774 ;;
4775 ;; Building lists of tables, figures or listings is quite similar.
4776 ;; Once the generic function `org-export-collect-elements' is defined,
4777 ;; `org-export-collect-tables', `org-export-collect-figures' and
4778 ;; `org-export-collect-listings' can be derived from it.
4781 "Collect headlines in order to build a table of contents.
4783 INFO is a plist used as a communication channel.
4785 When optional argument N is an integer, it specifies the depth of
4786 the table of contents. Otherwise, it is set to the value of the
4787 last headline level. See `org-export-headline-levels' for more
4788 information.
4790 Return a list of all exportable headlines as parsed elements.
4791 Footnote sections, if any, will be ignored."
4799 info)))
4802 "Collect referenceable elements of a determined type.
4804 TYPE can be a symbol or a list of symbols specifying element
4805 types to search. Only elements with a caption are collected.
4807 INFO is a plist used as a communication channel.
4809 When non-nil, optional argument PREDICATE is a function accepting
4810 one argument, an element of type TYPE. It returns a non-nil
4811 value when that element should be collected.
4813 Return a list of all elements found, in order of appearance."
4818 element))
4819 info))
4822 "Build a list of tables.
4823 INFO is a plist used as a communication channel.
4825 Return a list of table elements with a caption."
4829 "Build a list of figures.
4831 INFO is a plist used as a communication channel. PREDICATE is
4832 a function which accepts one argument: a paragraph element and
4833 whose return value is non-nil when that element should be
4834 collected.
4836 A figure is a paragraph type element, with a caption, verifying
4838 a vague concept that may depend on back-end.
4840 Return a list of elements recognized as figures."
4844 "Build a list of src blocks.
4846 INFO is a plist used as a communication channel.
4848 Return a list of src-block elements with a caption."
4852 ;;;; Smart Quotes
4853 ;;
4854 ;; The main function for the smart quotes sub-system is
4855 ;; `org-export-activate-smart-quotes', which replaces every quote in
4856 ;; a given string from the parse tree with its "smart" counterpart.
4857 ;;
4858 ;; Dictionary for smart quotes is stored in
4859 ;; `org-export-smart-quotes-alist'.
4860 ;;
4861 ;; Internally, regexps matching potential smart quotes (checks at
4862 ;; string boundaries are also necessary) are defined in
4863 ;; `org-export-smart-quotes-regexps'.
4867 ;; one may use: »...«, "...", ›...‹, or '...'.
4868 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4869 ;; LaTeX quotes require Babel!
4914 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4923 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4932 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4941 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4947 )
4948 "Smart quotes translations.
4950 Alist whose CAR is a language string and CDR is an alist with
4951 quote type as key and a plist associating various encodings to
4952 their translation as value.
4954 A quote type can be any symbol among `opening-double-quote',
4955 `closing-double-quote', `opening-single-quote',
4956 `closing-single-quote' and `apostrophe'.
4958 Valid encodings include `:utf-8', `:html', `:latex' and
4959 `:texinfo'.
4965 ;; Possible opening quote at beginning of string.
4967 ;; Possible closing quote at beginning of string.
4969 ;; Possible apostrophe at beginning of string.
4971 ;; Opening single and double quotes.
4973 ;; Closing single and double quotes.
4975 ;; Apostrophe.
4977 ;; Possible opening quote at end of string.
4979 ;; Possible closing quote at end of string.
4981 ;; Possible apostrophe at end of string.
4983 "List of regexps matching a quote or an apostrophe.
4989 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4990 `:utf-8'. INFO is a plist used as a communication channel.
4992 The function has to retrieve information about string
4993 surroundings in parse tree. It can only happen with an
4994 unmodified string. Thus, if S has already been through another
4995 process, a non-nil ORIGINAL optional argument will provide that
4996 original string.
4998 Return the new string."
5001 ;; Try to be flexible when computing number of blanks
5002 ;; before object. The previous object may be a string
5003 ;; introduced by the back-end and not completely parsed.
5006 ;; A string with missing `:post-blank'
5007 ;; property.
5011 ;; Fallback value.
5016 ;; Return smart quote associated to a give quote Q, as
5017 ;; a string. TYPE is a symbol among `open', `close' and
5018 ;; `apostrophe'.
5028 org-export-smart-quotes-alist))))
5029 encoding)
5030 q)))))
5032 ;; Only a quote: no regexp can match. We have to check both
5033 ;; sides and decide what to do.
5041 ;; 1. Replace quote character at the beginning of S.
5043 ;; Apostrophe?
5049 ;; Closing quote?
5055 ;; Opening quote?
5061 ;; 2. Replace quotes in the middle of the string.
5063 ;; Opening quotes.
5069 ;; Closing quotes.
5075 ;; Apostrophes.
5080 ;; 3. Replace quote character at the end of S.
5082 ;; Apostrophe?
5087 ;; Closing quote?
5093 ;; Opening quote?
5098 ;; Return string with smart quotes.
5099 s))))
5101 ;;;; Topology
5102 ;;
5103 ;; Here are various functions to retrieve information about the
5104 ;; neighborhood of a given element or object. Neighbors of interest
5105 ;; are direct parent (`org-export-get-parent'), parent headline
5106 ;; (`org-export-get-parent-headline'), first element containing an
5107 ;; object, (`org-export-get-parent-element'), parent table
5108 ;; (`org-export-get-parent-table'), previous element or object
5109 ;; (`org-export-get-previous-element') and next element or object
5110 ;; (`org-export-get-next-element').
5111 ;;
5112 ;; `org-export-get-genealogy' returns the full genealogy of a given
5113 ;; element or object, from closest parent to full parse tree.
5115 ;; defsubst org-export-get-parent must be defined before first use
5117 "Return full genealogy relative to a given element or object.
5119 BLOB is the element or object being considered.
5121 Ancestors are returned from closest to farthest, the last one
5122 being the full parse tree."
5129 "Return BLOB parent headline or nil.
5130 BLOB is the element or object being considered."
5134 parent))
5137 "Return first element containing OBJECT or nil.
5138 OBJECT is the object to consider."
5142 parent))
5145 "Return OBJECT parent table or nil.
5146 OBJECT is either a `table-cell' or `table-element' type object."
5150 parent))
5153 "Return previous element or object.
5155 BLOB is an element or object. INFO is a plist used as
5156 a communication channel. Return previous exportable element or
5157 object, a string, or nil.
5159 When optional argument N is a positive integer, return a list
5160 containing up to N siblings before BLOB, from farthest to
5161 closest. With any other non-nil value, return a list containing
5162 all of them."
5164 ;; An object can belong to the contents of its parent or
5165 ;; to a secondary string. We check the latter option
5166 ;; first.
5170 org-element-secondary-value-alist))
5171 parent)))
5174 prev)
5183 prev)))
5186 "Return next element or object.
5188 BLOB is an element or object. INFO is a plist used as
5189 a communication channel. Return next exportable element or
5190 object, a string, or nil.
5192 When optional argument N is a positive integer, return a list
5193 containing up to N siblings after BLOB, from closest to farthest.
5194 With any other non-nil value, return a list containing all of
5195 them."
5197 ;; An object can belong to the contents of its parent or to
5198 ;; a secondary string. We check the latter option first.
5202 org-element-secondary-value-alist))
5203 parent)))
5206 next)
5214 siblings)
5218 ;;;; Translation
5219 ;;
5220 ;; `org-export-translate' translates a string according to the language
5221 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5222 ;; the dictionary used for the translation.
5406 "Dictionary for export engine.
5408 Alist whose CAR is the string to translate and CDR is an alist
5409 whose CAR is the language string and CDR is a plist whose
5410 properties are possible charsets and values translated terms.
5412 It is used as a database for `org-export-translate'. Since this
5413 function returns the string as-is if no translation was found,
5414 the variable only needs to record values different from the
5418 "Translate string S according to language specification.
5420 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5421 and `:utf-8'. INFO is a plist used as a communication channel.
5423 Translation depends on `:language' property. Return the
5424 translated string. If no translation is found, try to fall back
5425 to `:default' encoding. If it fails, return S."
5431 s)))
5434 \f
5435 ;;; Asynchronous Export
5436 ;;
5437 ;; `org-export-async-start' is the entry point for asynchronous
5438 ;; export. It recreates current buffer (including visibility,
5439 ;; narrowing and visited file) in an external Emacs process, and
5440 ;; evaluates a command there. It then applies a function on the
5441 ;; returned results in the current process.
5442 ;;
5443 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5444 ;; allow to export to a buffer or a file, asynchronously or not.
5445 ;;
5446 ;; `org-export-output-file-name' is an auxiliary function meant to be
5447 ;; used with `org-export-to-file'. With a given extension, it tries
5448 ;; to provide a canonical file name to write export output to.
5449 ;;
5450 ;; Asynchronously generated results are never displayed directly.
5451 ;; Instead, they are stored in `org-export-stack-contents'. They can
5452 ;; then be retrieved by calling `org-export-stack'.
5453 ;;
5454 ;; Export Stack is viewed through a dedicated major mode
5455 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5456 ;;`org-export-stack-delete', `org-export-stack-view' and
5457 ;;`org-export-stack-clear'.
5458 ;;
5459 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5460 ;; It should be used whenever `org-export-async-start' is called.
5463 "Call function FUN on the results returned by BODY evaluation.
5465 BODY evaluation happens in an asynchronous process, from a buffer
5466 which is an exact copy of the current one.
5468 Use `org-export-add-to-stack' in FUN in order to register results
5469 in the stack.
5471 This is a low level function. See also `org-export-to-buffer'
5472 and `org-export-to-file' for more specialized functions."
5475 ;; Write the full sexp evaluating BODY in a copy of the current
5476 ;; buffer to a temporary file, as it may be too long for program
5477 ;; args in `start-process'.
5484 ;; Null characters (from variable values) are inserted
5485 ;; within the file. As a consequence, coding system for
5486 ;; buffer contents will not be recognized properly. So,
5487 ;; we make sure it is the same as the one used to display
5488 ;; the original buffer.
5490 ,coding
5493 ;; Ignore `kill-emacs-hook' and code evaluation
5494 ;; queries from Babel as we need a truly
5495 ;; non-interactive process.
5497 org-babel-confirm-evaluate-answer-no t)
5498 ;; Initialize export framework.
5500 ;; Re-create current buffer there.
5503 ;; Sexp to evaluate in the buffer.
5505 ;; Start external process.
5508 (,process
5513 "-l" org-export-async-init-file
5515 ;; Register running process in stack.
5517 ;; Set-up sentinel in order to catch results.
5520 ,process
5542 ;;;###autoload
5545 &optional async subtreep visible-only body-only ext-plist
5546 post-process)
5547 "Call `org-export-as' with output to a specified buffer.
5549 BACKEND is either an export back-end, as returned by, e.g.,
5550 `org-export-create-backend', or a symbol referring to
5551 a registered back-end.
5553 BUFFER is the name of the output buffer. If it already exists,
5554 it will be erased first, otherwise, it will be created.
5556 A non-nil optional argument ASYNC means the process should happen
5557 asynchronously. The resulting buffer should then be accessible
5558 through the `org-export-stack' interface. When ASYNC is nil, the
5559 buffer is displayed if `org-export-show-temporary-export-buffer'
5560 is non-nil.
5562 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5563 EXT-PLIST are similar to those used in `org-export-as', which
5564 see.
5566 Optional argument POST-PROCESS is a function which should accept
5567 no argument. It is always called within the current process,
5568 from BUFFER, with point at its beginning. Export back-ends can
5569 use it to set a major mode there, e.g,
5571 \(defun org-latex-export-as-latex
5572 \(&optional async subtreep visible-only body-only ext-plist)
5573 \(interactive)
5575 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5577 This function returns BUFFER."
5605 buffer)))
5607 ;;;###autoload
5610 post-process)
5611 "Call `org-export-as' with output to a specified file.
5613 BACKEND is either an export back-end, as returned by, e.g.,
5614 `org-export-create-backend', or a symbol referring to
5615 a registered back-end. FILE is the name of the output file, as
5616 a string.
5618 A non-nil optional argument ASYNC means the process should happen
5619 asynchronously. The resulting buffer will then be accessible
5620 through the `org-export-stack' interface.
5622 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5623 EXT-PLIST are similar to those used in `org-export-as', which
5624 see.
5626 Optional argument POST-PROCESS is called with FILE as its
5627 argument and happens asynchronously when ASYNC is non-nil. It
5628 has to return a file name, or nil. Export back-ends can use this
5629 to send the output file through additional processing, e.g,
5631 \(defun org-latex-export-to-latex
5632 \(&optional async subtreep visible-only body-only ext-plist)
5633 \(interactive)
5635 \(org-export-to-file 'latex outfile
5636 async subtreep visible-only body-only ext-plist
5637 \(lambda (file) (org-latex-compile file)))
5639 The function returns either a file name returned by POST-PROCESS,
5640 or FILE."
5658 backend subtreep visible-only body-only ext-plist)))
5665 ;; Get proper return value.
5667 file))))))
5670 "Return output file's name according to buffer specifications.
5672 EXTENSION is a string representing the output file extension,
5673 with the leading dot.
5675 With a non-nil optional argument SUBTREEP, try to determine
5677 of subtree at point.
5679 When optional argument PUB-DIR is set, use it as the publishing
5680 directory.
5682 When optional argument VISIBLE-ONLY is non-nil, don't export
5683 contents of hidden elements.
5685 Return file name as a string."
5688 ;; File name may come from EXPORT_FILE_NAME subtree
5689 ;; property, assuming point is at beginning of said
5690 ;; sub-tree.
5697 ;; File name may be extracted from buffer's associated
5698 ;; file, if any.
5700 ;; Can't determine file name on our own: Ask user.
5704 "Output file: " pub-dir nil nil nil
5708 ;; Build file name. Enforce EXTENSION over whatever user
5709 ;; may have come up with. PUB-DIR, if defined, always has
5710 ;; precedence over any provided path.
5715 extension))
5718 ;; If writing to OUTPUT-FILE would overwrite original file, append
5719 ;; EXTENSION another time to final name.
5722 output-file)))
5725 "Add a new result to export stack if not present already.
5727 SOURCE is a buffer or a file name containing export results.
5728 BACKEND is a symbol representing export back-end used to generate
5729 it.
5731 Entries already pointing to SOURCE and unavailable entries are
5732 removed beforehand. Return the new stack."
5738 "Menu for asynchronous export results and running processes."
5748 "Return source from export results at point in stack."
5755 source
5756 ;; SOURCE is not consistent with current line. The stack
5757 ;; view is outdated.
5761 "Remove all entries from export stack."
5766 "Refresh the asynchronous export stack.
5767 DUMMY is ignored. Unavailable sources are removed from the list.
5768 Return the new stack."
5778 ;; Back-end.
5780 ;; Age.
5783 ;; Compute age of the results.
5785 "%4h:%.2m "
5787 ;; Source.
5792 ;; Clear stack from exited processes, dead buffers or
5793 ;; non-existent files.
5805 "Remove export results at point from stack.
5806 If optional argument SOURCE is non-nil, remove it instead."
5811 org-export-stack-contents))))
5814 "View export results at point in stack.
5815 With an optional prefix argument IN-EMACS, force viewing files
5816 within Emacs."
5830 (define-key km "p" 'previous-line)
5831 (define-key km "\C-p" 'previous-line)
5832 (define-key km "\C-?" 'previous-line)
5833 (define-key km [up] 'previous-line)
5834 (define-key km "C" 'org-export-stack-clear)
5835 (define-key km "v" 'org-export-stack-view)
5836 (define-key km (kbd "RET") 'org-export-stack-view)
5837 (define-key km "d" 'org-export-stack-remove)
5838 km)
5839 "Keymap for Org Export Stack.")
5841 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5842 "Mode for displaying asynchronous export stack.
5845 stack.
5847 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5848 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5849 stack completely.
5851 Removing entries in an Org Export Stack buffer doesn't affect
5852 files or buffers, only the display.
5855 (abbrev-mode 0)
5856 (auto-fill-mode 0)
5857 (setq buffer-read-only t
5858 buffer-undo-list t
5859 truncate-lines t
5860 header-line-format
5861 '(:eval
5862 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5863 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5864 (set (make-local-variable 'revert-buffer-function)
5865 'org-export-stack-refresh))
5868 \f
5869 ;;; The Dispatcher
5870 ;;
5871 ;; `org-export-dispatch' is the standard interactive way to start an
5872 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5873 ;; for its interface, which, in turn, delegates response to key
5874 ;; pressed to `org-export--dispatch-action'.
5876 ;;;###autoload
5877 (defun org-export-dispatch (&optional arg)
5878 "Export dispatcher for Org mode.
5880 It provides an access to common export related tasks in a buffer.
5881 Its interface comes in two flavors: standard and expert.
5883 While both share the same set of bindings, only the former
5884 displays the valid keys associations in a dedicated buffer.
5885 Scrolling (resp. line-wise motion) in this buffer is done with
5886 SPC and DEL (resp. C-n and C-p) keys.
5888 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5889 flavor or the other.
5892 of options used back then, on the current buffer.
5894 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5895 (interactive "P")
5896 (let* ((input
5897 (cond ((equal arg '(16)) '(stack))
5898 ((and arg org-export-dispatch-last-action))
5899 (t (save-window-excursion
5900 (unwind-protect
5901 (progn
5902 ;; Remember where we are
5903 (move-marker org-export-dispatch-last-position
5904 (point)
5905 (org-base-buffer (current-buffer)))
5906 ;; Get and store an export command
5907 (setq org-export-dispatch-last-action
5908 (org-export--dispatch-ui
5909 (list org-export-initial-scope
5910 (and org-export-in-background 'async))
5911 nil
5912 org-export-dispatch-use-expert-ui)))
5913 (and (get-buffer "*Org Export Dispatcher*")
5914 (kill-buffer "*Org Export Dispatcher*")))))))
5915 (action (car input))
5916 (optns (cdr input)))
5917 (unless (memq 'subtree optns)
5918 (move-marker org-export-dispatch-last-position nil))
5919 (case action
5920 ;; First handle special hard-coded actions.
5921 (template (org-export-insert-default-template nil optns))
5922 (stack (org-export-stack))
5923 (publish-current-file
5924 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5925 (publish-current-project
5926 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5927 (publish-choose-project
5928 (org-publish (assoc (org-icompleting-read
5929 "Publish project: "
5930 org-publish-project-alist nil t)
5931 org-publish-project-alist)
5932 (memq 'force optns)
5933 (memq 'async optns)))
5934 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5935 (otherwise
5936 (save-excursion
5937 (when arg
5938 ;; Repeating command, maybe move cursor to restore subtree
5939 ;; context.
5940 (if (eq (marker-buffer org-export-dispatch-last-position)
5941 (org-base-buffer (current-buffer)))
5942 (goto-char org-export-dispatch-last-position)
5943 ;; We are in a different buffer, forget position.
5944 (move-marker org-export-dispatch-last-position nil)))
5945 (funcall action
5946 ;; Return a symbol instead of a list to ease
5947 ;; asynchronous export macro use.
5948 (and (memq 'async optns) t)
5949 (and (memq 'subtree optns) t)
5950 (and (memq 'visible optns) t)
5951 (and (memq 'body optns) t)))))))
5953 (defun org-export--dispatch-ui (options first-key expertp)
5954 "Handle interface for `org-export-dispatch'.
5956 OPTIONS is a list containing current interactive options set for
5957 export. It can contain any of the following symbols:
5958 `body' toggles a body-only export
5959 `subtree' restricts export to current subtree
5960 `visible' restricts export to visible part of buffer.
5961 `force' force publishing files.
5962 `async' use asynchronous export process
5964 FIRST-KEY is the key pressed to select the first level menu. It
5965 is nil when this menu hasn't been selected yet.
5967 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5968 buffer is provided, but indications about currently active
5969 options are given in the prompt. Moreover, \[?] allows to switch
5970 back to standard interface."
5971 (let* ((fontify-key
5972 (lambda (key &optional access-key)
5973 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5974 ;; non-nil is the required first-level key to activate
5975 ;; KEY. When its value is t, activate KEY independently
5976 ;; on the first key, if any. A nil value means KEY will
5977 ;; only be activated at first level.
5978 (if (or (eq access-key t) (eq access-key first-key))
5979 (org-propertize key 'face 'org-warning)
5980 key)))
5981 (fontify-value
5982 (lambda (value)
5983 ;; Fontify VALUE string.
5984 (org-propertize value 'face 'font-lock-variable-name-face)))
5985 ;; Prepare menu entries by extracting them from registered
5986 ;; back-ends and sorting them by access key and by ordinal,
5987 ;; if any.
5988 (entries
5989 (sort (sort (delq nil
5990 (mapcar 'org-export-backend-menu
5991 org-export--registered-backends))
5992 (lambda (a b)
5993 (let ((key-a (nth 1 a))
5994 (key-b (nth 1 b)))
5995 (cond ((and (numberp key-a) (numberp key-b))
5996 (< key-a key-b))
5997 ((numberp key-b) t)))))
5998 'car-less-than-car))
5999 ;; Compute a list of allowed keys based on the first key
6000 ;; pressed, if any. Some keys
6001 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6002 ;; available.
6003 (allowed-keys
6004 (nconc (list 2 22 19 6 1)
6005 (if (not first-key) (org-uniquify (mapcar 'car entries))
6006 (let (sub-menu)
6007 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6008 (when (eq (car entry) first-key)
6009 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6010 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6011 ((not first-key) (list ?P)))
6012 (list ?& ?#)
6013 (when expertp (list ??))
6014 (list ?q)))
6015 ;; Build the help menu for standard UI.
6016 (help
6017 (unless expertp
6018 (concat
6019 ;; Options are hard-coded.
6020 (format "[%s] Body only: %s [%s] Visible only: %s
6021 \[%s] Export scope: %s [%s] Force publishing: %s
6023 (funcall fontify-key "C-b" t)
6024 (funcall fontify-value
6025 (if (memq 'body options) "On " "Off"))
6026 (funcall fontify-key "C-v" t)
6027 (funcall fontify-value
6028 (if (memq 'visible options) "On " "Off"))
6029 (funcall fontify-key "C-s" t)
6030 (funcall fontify-value
6031 (if (memq 'subtree options) "Subtree" "Buffer "))
6032 (funcall fontify-key "C-f" t)
6033 (funcall fontify-value
6034 (if (memq 'force options) "On " "Off"))
6035 (funcall fontify-key "C-a" t)
6036 (funcall fontify-value
6037 (if (memq 'async options) "On " "Off")))
6038 ;; Display registered back-end entries. When a key
6039 ;; appears for the second time, do not create another
6040 ;; entry, but append its sub-menu to existing menu.
6041 (let (last-key)
6042 (mapconcat
6043 (lambda (entry)
6044 (let ((top-key (car entry)))
6045 (concat
6046 (unless (eq top-key last-key)
6047 (setq last-key top-key)
6049 (funcall fontify-key (char-to-string top-key))
6050 (nth 1 entry)))
6051 (let ((sub-menu (nth 2 entry)))
6052 (unless (functionp sub-menu)
6053 ;; Split sub-menu into two columns.
6054 (let ((index -1))
6055 (concat
6056 (mapconcat
6057 (lambda (sub-entry)
6058 (incf index)
6059 (format
6060 (if (zerop (mod index 2)) " [%s] %-26s"
6062 (funcall fontify-key
6063 (char-to-string (car sub-entry))
6064 top-key)
6065 (nth 1 sub-entry)))
6066 sub-menu "")
6068 entries ""))
6069 ;; Publishing menu is hard-coded.
6071 [%s] Current file [%s] Current project
6073 (funcall fontify-key "P")
6074 (funcall fontify-key "f" ?P)
6075 (funcall fontify-key "p" ?P)
6076 (funcall fontify-key "x" ?P)
6077 (funcall fontify-key "a" ?P))
6079 (funcall fontify-key "&" t)
6080 (funcall fontify-key "#" t))
6081 (format "[%s] %s"
6082 (funcall fontify-key "q" t)
6083 (if first-key "Main menu" "Exit")))))
6084 ;; Build prompts for both standard and expert UI.
6085 (standard-prompt (unless expertp "Export command: "))
6086 (expert-prompt
6087 (when expertp
6088 (format
6089 "Export command (C-%s%s%s%s%s) [%s]: "
6090 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6091 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6092 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6093 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6094 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6095 (mapconcat (lambda (k)
6096 ;; Strip control characters.
6097 (unless (< k 27) (char-to-string k)))
6098 allowed-keys "")))))
6099 ;; With expert UI, just read key with a fancy prompt. In standard
6100 ;; UI, display an intrusive help buffer.
6101 (if expertp
6102 (org-export--dispatch-action
6103 expert-prompt allowed-keys entries options first-key expertp)
6104 ;; At first call, create frame layout in order to display menu.
6105 (unless (get-buffer "*Org Export Dispatcher*")
6106 (delete-other-windows)
6107 (org-switch-to-buffer-other-window
6108 (get-buffer-create "*Org Export Dispatcher*"))
6109 (setq cursor-type nil
6110 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6111 ;; Make sure that invisible cursor will not highlight square
6112 ;; brackets.
6113 (set-syntax-table (copy-syntax-table))
6114 (modify-syntax-entry ?\[ "w"))
6115 ;; At this point, the buffer containing the menu exists and is
6116 ;; visible in the current window. So, refresh it.
6117 (with-current-buffer "*Org Export Dispatcher*"
6118 ;; Refresh help. Maintain display continuity by re-visiting
6119 ;; previous window position.
6120 (let ((pos (window-start)))
6121 (erase-buffer)
6122 (insert help)
6123 (set-window-start nil pos)))
6124 (org-fit-window-to-buffer)
6125 (org-export--dispatch-action
6126 standard-prompt allowed-keys entries options first-key expertp))))
6128 (defun org-export--dispatch-action
6129 (prompt allowed-keys entries options first-key expertp)
6130 "Read a character from command input and act accordingly.
6132 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6133 a list of characters available at a given step in the process.
6134 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6135 EXPERTP are the same as defined in `org-export--dispatch-ui',
6136 which see.
6138 Toggle export options when required. Otherwise, return value is
6139 a list with action as CAR and a list of interactive export
6140 options as CDR."
6141 (let (key)
6142 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6143 ;; C-p, SPC, DEL).
6144 (while (and (setq key (read-char-exclusive prompt))
6145 (not expertp)
6146 (memq key '(14 16 ?\s ?\d)))
6147 (case key
6148 (14 (if (not (pos-visible-in-window-p (point-max)))
6149 (ignore-errors (scroll-up 1))
6150 (message "End of buffer")
6151 (sit-for 1)))
6152 (16 (if (not (pos-visible-in-window-p (point-min)))
6153 (ignore-errors (scroll-down 1))
6154 (message "Beginning of buffer")
6155 (sit-for 1)))
6156 (?\s (if (not (pos-visible-in-window-p (point-max)))
6157 (scroll-up nil)
6158 (message "End of buffer")
6159 (sit-for 1)))
6160 (?\d (if (not (pos-visible-in-window-p (point-min)))
6161 (scroll-down nil)
6162 (message "Beginning of buffer")
6163 (sit-for 1)))))
6164 (cond
6165 ;; Ignore undefined associations.
6166 ((not (memq key allowed-keys))
6167 (ding)
6168 (unless expertp (message "Invalid key") (sit-for 1))
6169 (org-export--dispatch-ui options first-key expertp))
6170 ;; q key at first level aborts export. At second level, cancel
6171 ;; first key instead.
6172 ((eq key ?q) (if (not first-key) (error "Export aborted")
6173 (org-export--dispatch-ui options nil expertp)))
6174 ;; Help key: Switch back to standard interface if expert UI was
6175 ;; active.
6176 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6177 ;; Send request for template insertion along with export scope.
6178 ((eq key ?#) (cons 'template (memq 'subtree options)))
6179 ;; Switch to asynchronous export stack.
6180 ((eq key ?&) '(stack))
6181 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6182 ((memq key '(2 22 19 6 1))
6183 (org-export--dispatch-ui
6184 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6185 (6 'force) (1 'async))))
6186 (if (memq option options) (remq option options)
6187 (cons option options)))
6188 first-key expertp))
6189 ;; Action selected: Send key and options back to
6190 ;; `org-export-dispatch'.
6191 ((or first-key (functionp (nth 2 (assq key entries))))
6192 (cons (cond
6193 ((not first-key) (nth 2 (assq key entries)))
6194 ;; Publishing actions are hard-coded. Send a special
6195 ;; signal to `org-export-dispatch'.
6196 ((eq first-key ?P)
6197 (case key
6198 (?f 'publish-current-file)
6199 (?p 'publish-current-project)
6200 (?x 'publish-choose-project)
6201 (?a 'publish-all)))
6202 ;; Return first action associated to FIRST-KEY + KEY
6203 ;; path. Indeed, derived backends can share the same
6204 ;; FIRST-KEY.
6205 (t (catch 'found
6206 (mapc (lambda (entry)
6207 (let ((match (assq key (nth 2 entry))))
6208 (when match (throw 'found (nth 2 match)))))
6209 (member (assq first-key entries) entries)))))
6210 options))
6211 ;; Otherwise, enter sub-menu.
6212 (t (org-export--dispatch-ui options key expertp)))))
6216 (provide 'ox)
6218 ;; Local variables:
6219 ;; generated-autoload-file: "org-loaddefs.el"
6220 ;; End:
6222 ;;; ox.el ends here