| blob | 21cf8fbb54d24bb6d912df2666d479588bbca113 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists in a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place. The exhaustive list
35 ;; of properties is given in "The Communication Channel" section of
36 ;; this file.
37 ;;
38 ;; - The transcoder walks the parse tree, ignores or treat as plain
39 ;; text elements and objects according to export options, and
40 ;; eventually calls back-end specific functions to do the real
41 ;; transcoding, concatenating their return value along the way.
42 ;;
43 ;; - The filter system is activated at the very beginning and the very
44 ;; end of the export process, and each time an element or an object
45 ;; has been converted. It is the entry point to fine-tune standard
46 ;; output from back-end transcoders. See "The Filter System"
47 ;; section for more information.
48 ;;
49 ;; The core function is `org-export-as'. It returns the transcoded
50 ;; buffer as a string.
51 ;;
52 ;; An export back-end is defined with `org-export-define-backend'.
53 ;; This function can also support specific buffer keywords, OPTION
54 ;; keyword's items and filters. Refer to function's documentation for
55 ;; more information.
56 ;;
57 ;; If the new back-end shares most properties with another one,
58 ;; `org-export-define-derived-backend' can be used to simplify the
59 ;; process.
60 ;;
61 ;; Any back-end can define its own variables. Among them, those
62 ;; customizable should belong to the `org-export-BACKEND' group.
63 ;;
64 ;; Tools for common tasks across back-ends are implemented in the
65 ;; following part of the file.
66 ;;
67 ;; Then, a wrapper macro for asynchronous export,
68 ;; `org-export-async-start', along with tools to display results. are
69 ;; given in the penultimate part.
70 ;;
71 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
72 ;; back-ends is provided in the last one.
74 ;;; Code:
93 \f
94 ;;; Internal Variables
95 ;;
96 ;; Among internal variables, the most important is
97 ;; `org-export-options-alist'. This variable define the global export
98 ;; options, shared between every exporter, and how they are acquired.
143 "Alist between export properties and ways to set them.
145 The CAR of the alist is the property name, and the CDR is a list
146 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
148 KEYWORD is a string representing a buffer keyword, or nil. Each
149 property defined this way can also be set, during subtree
150 export, through a headline property named after the keyword
152 property).
153 OPTION is a string that could be found in an #+OPTIONS: line.
154 DEFAULT is the default value for the property.
155 BEHAVIOR determines how Org should handle multiple keywords for
156 the same property. It is a symbol among:
157 nil Keep old value and discard the new one.
158 t Replace old value with the new one.
159 `space' Concatenate the values, separating them with a space.
160 `newline' Concatenate the values, separating them with
161 a newline.
162 `split' Split values at white spaces, and cons them to the
163 previous list.
165 Values set through KEYWORD and OPTION have precedence over
166 DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
262 "Non-nil means asynchronous export process should leave data behind.
266 located in `temporary-file-directory'.
268 When non-nil, it will also set `debug-on-error' to a non-nil
272 "Record asynchronously generated export results and processes.
273 This is an alist: its CAR is the source of the
274 result (destination file or buffer for a finished process,
275 original buffer for a running one) and its CDR is a list
276 containing the back-end used, as a symbol, and either a process
277 or the time at which it finished. It is used to build the menu
281 "List of backends currently available in the exporter.
282 This variable is set with `org-export-define-backend' and
286 "Last command called from the dispatcher.
287 The value should be a list. Its CAR is the action, as a symbol,
291 "The position where the last export command was created using the dispatcher.
292 This marker will be used with `C-u C-c C-e' to make sure export repetition
295 ;; For compatibility with Org < 8
297 "Name, if any, of the back-end used during an export process.
299 Its value is a symbol such as `html', `latex', `ascii', or nil if
300 the back-end is anonymous (see `org-export-create-backend') or if
301 there is no export process in progress.
303 It can be used to teach Babel blocks how to act differently
306 \f
307 ;;; User-configurable Variables
308 ;;
309 ;; Configuration for the masses.
310 ;;
311 ;; They should never be accessed directly, as their value is to be
312 ;; stored in a property list (cf. `org-export-options-alist').
313 ;; Back-ends will read their value from there instead.
316 "Options for exporting Org mode files."
321 "General options for export engine."
326 "Whether sub-trees with the ARCHIVE tag should be exported.
328 This can have three different values:
329 nil Do not export, pretend this tree is not present.
330 t Do export the entire tree.
331 `headline' Only export the headline, but skip the tree below it.
333 This option can also be set with the OPTIONS keyword,
342 "Non-nil means insert author name into the exported file.
343 This option can also be set with the OPTIONS keyword,
349 "Non-nil means export CLOCK keywords.
350 This option can also be set with the OPTIONS keyword,
356 "Non-nil means the postamble should contain a creator sentence.
358 The sentence can be set in `org-export-creator-string' and
361 If the value is `comment' insert it as a comment."
369 "Non-nil means insert date in the exported document.
370 This option can also be set with the OPTIONS keyword,
376 "Time-stamp format string to use for DATE keyword.
378 The format string, when specified, only applies if date consists
379 in a single time-stamp. Otherwise its value will be ignored.
381 See `format-time-string' for details on how to build this
382 string."
390 emacs-version
392 "Information about the creator of the document.
393 This option can also be set on with the CREATOR keyword."
398 "Non-nil means export contents of standard drawers.
400 When t, all drawers are exported. This may also be a list of
401 drawer names to export. If that list starts with `not', only
402 drawers with such names will be ignored.
404 This variable doesn't apply to properties drawers.
406 This option can also be set with the OPTIONS keyword,
419 :inline t
423 "Non-nil means insert author email into the exported file.
424 This option can also be set with the OPTIONS keyword,
430 "Non-nil means interpret *word*, /word/, _word_ and +word+.
432 If the export target supports emphasizing text, the word will be
433 typeset in bold, italic, with an underline or strike-through,
434 respectively.
436 This option can also be set with the OPTIONS keyword,
442 "Tags that exclude a tree from export.
444 All trees carrying any of these tags will be excluded from
445 export. This is without condition, so even subtrees inside that
446 carry one of the `org-export-select-tags' will be removed.
448 This option can also be set with the EXCLUDE_TAGS keyword."
455 This can be used to have pre-formatted text, fragments of code
456 etc. For example:
457 : ;; Some Lisp examples
458 : (while (defc cnt)
459 : (ding))
460 will be looking just like this in also HTML. See also the QUOTE
461 keyword. Not all export backends support this.
463 This option can also be set with the OPTIONS keyword,
469 "Non-nil means Org footnotes should be exported.
470 This option can also be set with the OPTIONS keyword,
476 "Non-nil means process LaTeX environments and fragments.
478 This option can also be set with the OPTIONS line,
481 nil Ignore math snippets.
482 `verbatim' Keep everything in verbatim.
483 t Allow export of math snippets."
493 "The last level which is still exported as a headline.
495 Inferior levels will usually produce itemize or enumerate lists
496 when exported, but back-end behaviour may differ.
498 This option can also be set with the OPTIONS keyword,
504 "The default language for export and clocktable translations, as a string.
505 This may have an association in
506 `org-clock-clocktable-language-setup',
507 `org-export-smart-quotes-alist' and `org-export-dictionary'.
508 This option can also be set with the LANGUAGE keyword."
513 "Non-nil means preserve all line breaks when exporting.
514 This option can also be set with the OPTIONS keyword,
520 "Non-nil means interpret entities when exporting.
523 Å.
525 For a list of supported names, see the constant `org-entities'
526 and the user option `org-entities-user'.
528 This option can also be set with the OPTIONS keyword,
534 "Non-nil means inlinetasks should be exported.
535 This option can also be set with the OPTIONS keyword,
543 "Non-nil means include planning info in export.
545 Planning info is the line containing either SCHEDULED:,
546 DEADLINE:, CLOSED: time-stamps, or a combination of them.
548 This option can also be set with the OPTIONS keyword,
556 "Non-nil means include priority cookies in export.
557 This option can also be set with the OPTIONS keyword,
563 "Non-nil means add section numbers to headlines when exporting.
565 When set to an integer n, numbering will only happen for
566 headlines whose relative level is higher or equal to n.
568 This option can also be set with the OPTIONS keyword,
574 "Tags that select a tree for export.
576 If any such tag is found in a buffer, all trees that do not carry
577 one of these tags will be ignored during export. Inside trees
578 that are selected like this, you can still deselect a subtree by
579 tagging it with one of the `org-export-exclude-tags'.
581 This option can also be set with the SELECT_TAGS keyword."
586 "Non-nil means activate smart quotes during export.
587 This option can also be set with the OPTIONS keyword,
590 When setting this to non-nil, you need to take care of
591 using the correct Babel package when exporting to LaTeX.
592 E.g., you can load Babel for french like this:
603 When this option is turned on, these strings will be exported as:
605 Org HTML LaTeX UTF-8
606 -----+----------+--------+-------
608 -- – -- –
609 --- — --- —
612 This option can also be set with the OPTIONS keyword,
618 "Non-nil means include statistics cookies in export.
619 This option can also be set with the OPTIONS keyword,
629 If you want to control how Org displays those characters, see
630 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
631 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
632 it is not anymore.
634 When this option is turned on, you can use TeX-like syntax for
635 sub- and superscripts and see them exported correctly.
637 You can also set the option with #+OPTIONS: ^:t
640 single item - so grouping with {} is normally not needed. For
641 example, the following things will be parsed as single sub- or
642 superscripts:
644 10^24 or 10^tau several digits will be considered 1 item.
645 10^-12 or 10^-tau a leading sign with digits or a word
646 x^2-y^3 will be read as x^2 - y^3, because items are
647 terminated by almost any nonword/nondigit char.
648 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
650 Still, ambiguity is possible. So when in doubt, use {} to enclose
651 the sub/superscript. If you set this variable to the symbol `{}',
652 the braces are *required* in order to trigger interpretations as
654 frequently in plain text."
664 "Non-nil means create a table of contents in exported files.
666 The TOC contains headlines with levels up
667 to`org-export-headline-levels'. When an integer, include levels
668 up to N in the toc, this may then be different from
669 `org-export-headline-levels', but it will not be allowed to be
670 larger than the number of headline levels. When nil, no table of
671 contents is made.
673 This option can also be set with the OPTIONS keyword,
683 For example:
685 | Name | Address | Birthday |
686 |-------------+----------+-----------|
687 | Arthur Dent | England | 29.2.2100 |
689 This option can also be set with the OPTIONS keyword,
695 "If nil, do not export tags, just remove them from headlines.
697 If this is the symbol `not-in-toc', tags will be removed from
698 table of contents entries, but still be shown in the headlines of
699 the document.
701 This option can also be set with the OPTIONS keyword,
710 "Non-nil means include TODO items for export.
712 This may have the following values:
713 t include tasks independent of state.
714 `todo' include only tasks that are not yet done.
715 `done' include only tasks that are already done.
716 nil ignore all tasks.
717 list of keywords include tasks with these keywords.
719 This option can also be set with the OPTIONS keyword,
731 "Non-nil means insert a time stamp into the exported file.
732 The time stamp shows when the file was created. This option can
738 "Non nil means allow timestamps in export.
740 It can be set to any of the following values:
741 t export all timestamps.
742 `active' export active timestamps only.
743 `inactive' export inactive timestamps only.
744 nil do not export timestamps
746 This only applies to timestamps isolated in a paragraph
747 containing only timestamps. Other timestamps are always
748 exported.
750 This option can also be set with the OPTIONS keyword, e.g.
760 "Non-nil means include TODO keywords in export.
761 When nil, remove all these keywords from the export. This option
767 "Non-nil means BIND keywords can define local variable values.
768 This is a potential security risk, which is why the default value
769 is nil. You can also allow them through local buffer variables."
776 "Alist between export snippets back-ends and exporter back-ends.
778 This variable allows to provide shortcuts for export snippets.
782 HTML code while every other back-end will ignore it."
791 "Coding system for the exported file."
798 "Non-nil means pushing export output to the kill ring.
799 This variable is ignored during asynchronous export."
808 "The initial scope when exporting with `org-export-dispatch'.
809 This variable can be either set to `buffer' or `subtree'."
816 "Non-nil means show buffer after exporting to temp buffer.
817 When Org exports to a file, the buffer visiting that file is ever
818 shown, but remains buried. However, when exporting to
819 a temporary buffer, that buffer is popped up in a second window.
820 When this variable is nil, the buffer remains buried also in
821 these cases."
826 "Non-nil means export and publishing commands will run in background.
827 Results from an asynchronous export are never displayed
835 "File used to initialize external export process.
836 Value must be an absolute file name. It defaults to user's
837 initialization file. Though, a specific configuration makes the
838 process faster and the export more portable."
845 "Non-nil means using a non-intrusive `org-export-dispatch'.
846 In that case, no help buffer is displayed. Though, an indicator
852 asynchronous). Also, \[?] allows to switch back to standard
853 mode."
860 \f
861 ;;; Defining Back-ends
862 ;;
863 ;; An export back-end is a structure with `org-export-backend' type
864 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
865 ;; and `menu' slots.
866 ;;
867 ;; At the lowest level, a back-end is created with
868 ;; `org-export-create-backend' function.
869 ;;
870 ;; A named back-end can be registered with
871 ;; `org-export-register-backend' function. A registered back-end can
872 ;; later be referred to by its name, with `org-export-get-backend'
873 ;; function. Also, such a back-end can become the parent of a derived
874 ;; back-end from which slot values will be inherited by default.
875 ;; `org-export-derived-backend-p' can check if a given back-end is
876 ;; derived from a list of back-end names.
877 ;;
878 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
879 ;; `org-export-get-all-filters' return the full alist of transcoders,
880 ;; options and filters, including those inherited from ancestors.
881 ;;
882 ;; At a higher level, `org-export-define-backend' is the standard way
883 ;; to define an export back-end. If the new back-end is similar to
884 ;; a registered back-end, `org-export-define-derived-backend' may be
885 ;; used instead.
886 ;;
887 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
888 ;; when a given back-end hasn't been registered yet.
892 name parent transcoders options filters blocks menu)
895 "Return export back-end named after NAME.
896 NAME is a symbol. Return nil if no such back-end is found."
903 "Register BACKEND as a known export back-end.
904 BACKEND is a structure with `org-export-backend' type."
905 ;; Refuse to register an unnamed back-end.
908 ;; Refuse to register a back-end with an unknown parent.
912 ;; Register dedicated export blocks in the parser.
916 ;; If a back-end with the same name as BACKEND is already
917 ;; registered, replace it with BACKEND. Otherwise, simply add
918 ;; BACKEND to the list of registered back-ends.
924 "Signal an error if BACKEND isn't defined."
929 "Non-nil if BACKEND is derived from one of BACKENDS.
930 BACKEND is an export back-end, as returned by, e.g.,
931 `org-export-create-backend', or a symbol referring to
932 a registered back-end. BACKENDS is constituted of symbols."
944 "Return full translation table for BACKEND.
946 BACKEND is an export back-end, as return by, e.g,,
947 `org-export-create-backend'. Return value is an alist where
948 keys are element or object types, as symbols, and values are
949 transcoders.
951 Unlike to `org-export-backend-transcoders', this function
952 also returns transcoders inherited from parent back-ends,
953 if any."
957 parent)
962 transcoders)))
965 "Return export options for BACKEND.
967 BACKEND is an export back-end, as return by, e.g,,
968 `org-export-create-backend'. See `org-export-options-alist'
969 for the shape of the return value.
971 Unlike to `org-export-backend-options', this function also
972 returns options inherited from parent back-ends, if any."
976 parent)
980 options)))
983 "Return complete list of filters for BACKEND.
985 BACKEND is an export back-end, as return by, e.g,,
986 `org-export-create-backend'. Return value is an alist where
987 keys are symbols and values lists of functions.
989 Unlike to `org-export-backend-filters', this function also
990 returns filters inherited from parent back-ends, if any."
994 parent)
998 filters)))
1001 "Define a new back-end BACKEND.
1003 TRANSCODERS is an alist between object or element types and
1004 functions handling them.
1006 These functions should return a string without any trailing
1007 space, or nil. They must accept three arguments: the object or
1008 element itself, its contents or nil when it isn't recursive and
1009 the property list used as a communication channel.
1011 Contents, when not nil, are stripped from any global indentation
1012 \(although the relative one is preserved). They also always end
1013 with a single newline character.
1015 If, for a given type, no function is found, that element or
1016 object type will simply be ignored, along with any blank line or
1017 white space at its end. The same will happen if the function
1018 returns the nil value. If that function returns the empty
1019 string, the type will be ignored, but the blank lines or white
1020 spaces will be kept.
1022 In addition to element and object types, one function can be
1023 associated to the `template' (or `inner-template') symbol and
1024 another one to the `plain-text' symbol.
1026 The former returns the final transcoded string, and can be used
1027 to add a preamble and a postamble to document's body. It must
1028 accept two arguments: the transcoded string and the property list
1029 containing export options. A function associated to `template'
1031 A function associated to `inner-template' is always applied.
1033 The latter, when defined, is to be called on every text not
1034 recognized as an element or an object. It must accept two
1035 arguments: the text string and the information channel. It is an
1036 appropriate place to protect special chars relative to the
1037 back-end.
1039 BODY can start with pre-defined keyword arguments. The following
1040 keywords are understood:
1042 :export-block
1044 String, or list of strings, representing block names that
1045 will not be parsed. This is used to specify blocks that will
1046 contain raw code specific to the back-end. These blocks
1047 still have to be handled by the relative `export-block' type
1048 translator.
1050 :filters-alist
1052 Alist between filters and function, or list of functions,
1053 specific to the back-end. See `org-export-filters-alist' for
1054 a list of all allowed filters. Filters defined here
1055 shouldn't make a back-end test, as it may prevent back-ends
1056 derived from this one to behave properly.
1058 :menu-entry
1060 Menu entry for the export dispatcher. It should be a list
1061 like:
1063 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1065 where :
1067 KEY is a free character selecting the back-end.
1069 DESCRIPTION-OR-ORDINAL is either a string or a number.
1071 If it is a string, is will be used to name the back-end in
1072 its menu entry. If it is a number, the following menu will
1073 be displayed as a sub-menu of the back-end with the same
1074 KEY. Also, the number will be used to determine in which
1075 order such sub-menus will appear (lowest first).
1077 ACTION-OR-MENU is either a function or an alist.
1079 If it is an action, it will be called with four
1080 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1081 BODY-ONLY. See `org-export-as' for further explanations on
1082 some of them.
1084 If it is an alist, associations should follow the
1085 pattern:
1087 '(KEY DESCRIPTION ACTION)
1089 where KEY, DESCRIPTION and ACTION are described above.
1091 Valid values include:
1095 or
1100 \(lambda (a s v b)
1101 \(if a (org-latex-export-to-pdf t s v b)
1102 \(org-open-file
1103 \(org-latex-export-to-pdf nil s v b)))))))
1105 or the following, which will be added to the previous
1106 sub-menu,
1108 '(?l 1
1112 :options-alist
1114 Alist between back-end specific properties introduced in
1115 communication channel and how their value are acquired. See
1116 `org-export-options-alist' for more information about
1117 structure of the values."
1131 :transcoders transcoders
1132 :options options
1133 :filters filters
1134 :blocks blocks
1138 "Create a new back-end as a variant of an existing one.
1140 CHILD is the name of the derived back-end. PARENT is the name of
1141 the parent back-end.
1143 BODY can start with pre-defined keyword arguments. The following
1144 keywords are understood:
1146 :export-block
1148 String, or list of strings, representing block names that
1149 will not be parsed. This is used to specify blocks that will
1150 contain raw code specific to the back-end. These blocks
1151 still have to be handled by the relative `export-block' type
1152 translator.
1154 :filters-alist
1156 Alist of filters that will overwrite or complete filters
1157 defined in PARENT back-end. See `org-export-filters-alist'
1158 for a list of allowed filters.
1160 :menu-entry
1162 Menu entry for the export dispatcher. See
1163 `org-export-define-backend' for more information about the
1164 expected value.
1166 :options-alist
1168 Alist of back-end specific properties that will overwrite or
1169 complete those defined in PARENT back-end. Refer to
1170 `org-export-options-alist' for more information about
1171 structure of the values.
1173 :translate-alist
1175 Alist of element and object types and transcoders that will
1176 overwrite or complete transcode table from PARENT back-end.
1177 Refer to `org-export-define-backend' for detailed information
1178 about transcoders.
1181 as a variant of `latex' back-end with a custom template function:
1183 \(org-export-define-derived-backend 'my-latex 'latex
1184 :translate-alist '((template . my-latex-template-fun)))
1186 The back-end could then be called with, for example:
1203 :parent parent
1204 :transcoders transcoders
1205 :options options
1206 :filters filters
1207 :blocks blocks
1211 \f
1212 ;;; The Communication Channel
1213 ;;
1214 ;; During export process, every function has access to a number of
1215 ;; properties. They are of two types:
1216 ;;
1217 ;; 1. Environment options are collected once at the very beginning of
1218 ;; the process, out of the original buffer and configuration.
1219 ;; Collecting them is handled by `org-export-get-environment'
1220 ;; function.
1221 ;;
1222 ;; Most environment options are defined through the
1223 ;; `org-export-options-alist' variable.
1224 ;;
1225 ;; 2. Tree properties are extracted directly from the parsed tree,
1226 ;; just before export, by `org-export-collect-tree-properties'.
1227 ;;
1228 ;; Here is the full list of properties available during transcode
1229 ;; process, with their category and their value type.
1230 ;;
1231 ;; + `:author' :: Author's name.
1232 ;; - category :: option
1233 ;; - type :: string
1234 ;;
1235 ;; + `:back-end' :: Current back-end used for transcoding.
1236 ;; - category :: tree
1237 ;; - type :: symbol
1238 ;;
1239 ;; + `:creator' :: String to write as creation information.
1240 ;; - category :: option
1241 ;; - type :: string
1242 ;;
1243 ;; + `:date' :: String to use as date.
1244 ;; - category :: option
1245 ;; - type :: string
1246 ;;
1247 ;; + `:description' :: Description text for the current data.
1248 ;; - category :: option
1249 ;; - type :: string
1250 ;;
1251 ;; + `:email' :: Author's email.
1252 ;; - category :: option
1253 ;; - type :: string
1254 ;;
1255 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1256 ;; process.
1257 ;; - category :: option
1258 ;; - type :: list of strings
1259 ;;
1260 ;; + `:export-options' :: List of export options available for current
1261 ;; process.
1262 ;; - category :: none
1263 ;; - type :: list of symbols, among `subtree', `body-only' and
1264 ;; `visible-only'.
1265 ;;
1266 ;; + `:exported-data' :: Hash table used for memoizing
1267 ;; `org-export-data'.
1268 ;; - category :: tree
1269 ;; - type :: hash table
1270 ;;
1271 ;; + `:filetags' :: List of global tags for buffer. Used by
1272 ;; `org-export-get-tags' to get tags with inheritance.
1273 ;; - category :: option
1274 ;; - type :: list of strings
1275 ;;
1276 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1277 ;; their definition, as parsed data. Only non-inlined footnotes
1278 ;; are represented in this alist. Also, every definition isn't
1279 ;; guaranteed to be referenced in the parse tree. The purpose of
1280 ;; this property is to preserve definitions from oblivion
1281 ;; (i.e. when the parse tree comes from a part of the original
1282 ;; buffer), it isn't meant for direct use in a back-end. To
1283 ;; retrieve a definition relative to a reference, use
1284 ;; `org-export-get-footnote-definition' instead.
1285 ;; - category :: option
1286 ;; - type :: alist (STRING . LIST)
1287 ;;
1288 ;; + `:headline-levels' :: Maximum level being exported as an
1289 ;; headline. Comparison is done with the relative level of
1290 ;; headlines in the parse tree, not necessarily with their
1291 ;; actual level.
1292 ;; - category :: option
1293 ;; - type :: integer
1294 ;;
1295 ;; + `:headline-offset' :: Difference between relative and real level
1296 ;; of headlines in the parse tree. For example, a value of -1
1297 ;; means a level 2 headline should be considered as level
1298 ;; 1 (cf. `org-export-get-relative-level').
1299 ;; - category :: tree
1300 ;; - type :: integer
1301 ;;
1302 ;; + `:headline-numbering' :: Alist between headlines and their
1303 ;; numbering, as a list of numbers
1304 ;; (cf. `org-export-get-headline-number').
1305 ;; - category :: tree
1306 ;; - type :: alist (INTEGER . LIST)
1307 ;;
1308 ;; + `:id-alist' :: Alist between ID strings and destination file's
1309 ;; path, relative to current directory. It is used by
1310 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1311 ;; external file.
1312 ;; - category :: option
1313 ;; - type :: alist (STRING . STRING)
1314 ;;
1315 ;; + `:ignore-list' :: List of elements and objects that should be
1316 ;; ignored during export.
1317 ;; - category :: tree
1318 ;; - type :: list of elements and objects
1319 ;;
1320 ;; + `:input-buffer' :: Name of input buffer.
1321 ;; - category :: option
1322 ;; - type :: string
1323 ;;
1324 ;; + `:input-file' :: Full path to input file, if any.
1325 ;; - category :: option
1326 ;; - type :: string or nil
1327 ;;
1328 ;; + `:keywords' :: List of keywords attached to data.
1329 ;; - category :: option
1330 ;; - type :: string
1331 ;;
1332 ;; + `:language' :: Default language used for translations.
1333 ;; - category :: option
1334 ;; - type :: string
1335 ;;
1336 ;; + `:output-file' :: Full path to output file, if any.
1337 ;; - category :: option
1338 ;; - type :: string or nil
1339 ;;
1340 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1341 ;; transcoding.
1342 ;; - category :: option
1343 ;; - type :: list (as returned by `org-element-parse-buffer')
1344 ;;
1345 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1346 ;; all line breaks.
1347 ;; - category :: option
1348 ;; - type :: symbol (nil, t)
1349 ;;
1350 ;; + `:section-numbers' :: Non-nil means transcoding should add
1351 ;; section numbers to headlines.
1352 ;; - category :: option
1353 ;; - type :: symbol (nil, t)
1354 ;;
1355 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1356 ;; in transcoding. When such a tag is present, subtrees without
1357 ;; it are de facto excluded from the process. See
1358 ;; `use-select-tags'.
1359 ;; - category :: option
1360 ;; - type :: list of strings
1361 ;;
1362 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1363 ;; a time stamp in the output.
1364 ;; - category :: option
1365 ;; - type :: symbol (nil, t)
1366 ;;
1367 ;; + `:translate-alist' :: Alist between element and object types and
1368 ;; transcoding functions relative to the current back-end.
1369 ;; Special keys `inner-template', `template' and `plain-text' are
1370 ;; also possible.
1371 ;; - category :: option
1372 ;; - type :: alist (SYMBOL . FUNCTION)
1373 ;;
1374 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1375 ;; also be transcoded. If it is set to the `headline' symbol,
1376 ;; only the archived headline's name is retained.
1377 ;; - category :: option
1378 ;; - type :: symbol (nil, t, `headline')
1379 ;;
1380 ;; + `:with-author' :: Non-nil means author's name should be included
1381 ;; in the output.
1382 ;; - category :: option
1383 ;; - type :: symbol (nil, t)
1384 ;;
1385 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1386 ;; - category :: option
1387 ;; - type :: symbol (nil, t)
1388 ;;
1389 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1390 ;; inserted at the end of the transcoded string. If the value
1391 ;; is `comment', it should be commented.
1392 ;; - category :: option
1393 ;; - type :: symbol (`comment', nil, t)
1394 ;;
1395 ;; + `:with-date' :: Non-nil means output should contain a date.
1396 ;; - category :: option
1397 ;; - type :. symbol (nil, t)
1398 ;;
1399 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1400 ;; its value is a list of names, only drawers with such names
1401 ;; will be transcoded. If that list starts with `not', drawer
1402 ;; with these names will be skipped.
1403 ;; - category :: option
1404 ;; - type :: symbol (nil, t) or list of strings
1405 ;;
1406 ;; + `:with-email' :: Non-nil means output should contain author's
1407 ;; email.
1408 ;; - category :: option
1409 ;; - type :: symbol (nil, t)
1410 ;;
1411 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1412 ;; interpreted.
1413 ;; - category :: option
1414 ;; - type :: symbol (nil, t)
1415 ;;
1416 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1417 ;; strings starting with a colon as a fixed-with (verbatim) area.
1418 ;; - category :: option
1419 ;; - type :: symbol (nil, t)
1420 ;;
1421 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1422 ;; footnotes.
1423 ;; - category :: option
1424 ;; - type :: symbol (nil, t)
1425 ;;
1426 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1427 ;; `latex-fragment' objects should appear in export output. When
1428 ;; this property is set to `verbatim', they will be left as-is.
1429 ;; - category :: option
1430 ;; - type :: symbol (`verbatim', nil, t)
1431 ;;
1432 ;; + `:with-planning' :: Non-nil means transcoding should include
1433 ;; planning info.
1434 ;; - category :: option
1435 ;; - type :: symbol (nil, t)
1436 ;;
1437 ;; + `:with-priority' :: Non-nil means transcoding should include
1438 ;; priority cookies.
1439 ;; - category :: option
1440 ;; - type :: symbol (nil, t)
1441 ;;
1442 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1443 ;; plain text.
1444 ;; - category :: option
1445 ;; - type :: symbol (nil, t)
1446 ;;
1447 ;; + `:with-special-strings' :: Non-nil means transcoding should
1448 ;; interpret special strings in plain text.
1449 ;; - category :: option
1450 ;; - type :: symbol (nil, t)
1451 ;;
1452 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1453 ;; interpret subscript and superscript. With a value of "{}",
1454 ;; only interpret those using curly brackets.
1455 ;; - category :: option
1456 ;; - type :: symbol (nil, {}, t)
1457 ;;
1458 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1459 ;; tables.
1460 ;; - category :: option
1461 ;; - type :: symbol (nil, t)
1462 ;;
1463 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1464 ;; headlines. A `not-in-toc' value will remove them from the
1465 ;; table of contents, if any, nonetheless.
1466 ;; - category :: option
1467 ;; - type :: symbol (nil, t, `not-in-toc')
1468 ;;
1469 ;; + `:with-tasks' :: Non-nil means transcoding should include
1470 ;; headlines with a TODO keyword. A `todo' value will only
1471 ;; include headlines with a todo type keyword while a `done'
1472 ;; value will do the contrary. If a list of strings is provided,
1473 ;; only tasks with keywords belonging to that list will be kept.
1474 ;; - category :: option
1475 ;; - type :: symbol (t, todo, done, nil) or list of strings
1476 ;;
1477 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1478 ;; time stamps. Special value `active' (resp. `inactive') ask to
1479 ;; export only active (resp. inactive) timestamps. Otherwise,
1480 ;; completely remove them.
1481 ;; - category :: option
1482 ;; - type :: symbol: (`active', `inactive', t, nil)
1483 ;;
1484 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1485 ;; added to the output. An integer value limits its depth.
1486 ;; - category :: option
1487 ;; - type :: symbol (nil, t or integer)
1488 ;;
1489 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1490 ;; include TODO keywords.
1491 ;; - category :: option
1492 ;; - type :: symbol (nil, t)
1495 ;;;; Environment Options
1496 ;;
1497 ;; Environment options encompass all parameters defined outside the
1498 ;; scope of the parsed data. They come from five sources, in
1499 ;; increasing precedence order:
1500 ;;
1501 ;; - Global variables,
1502 ;; - Buffer's attributes,
1503 ;; - Options keyword symbols,
1504 ;; - Buffer keywords,
1505 ;; - Subtree properties.
1506 ;;
1507 ;; The central internal function with regards to environment options
1508 ;; is `org-export-get-environment'. It updates global variables with
1509 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1510 ;; the different sources.
1511 ;;
1512 ;; The internal functions doing the retrieval are:
1513 ;; `org-export--get-global-options',
1514 ;; `org-export--get-buffer-attributes',
1515 ;; `org-export--parse-option-keyword',
1516 ;; `org-export--get-subtree-options' and
1517 ;; `org-export--get-inbuffer-options'
1518 ;;
1519 ;; Also, `org-export--list-bound-variables' collects bound variables
1520 ;; along with their value in order to set them as buffer local
1521 ;; variables later in the process.
1524 "Collect export options from the current buffer.
1526 Optional argument BACKEND is an export back-end, as returned by
1527 `org-export-create-backend'.
1529 When optional argument SUBTREEP is non-nil, assume the export is
1530 done against the current sub-tree.
1532 Third optional argument EXT-PLIST is a property list with
1533 external parameters overriding Org default settings, but still
1534 inferior to file-local settings."
1535 ;; First install #+BIND variables since these must be set before
1536 ;; global options are read.
1539 ;; Get and prioritize export options...
1541 ;; ... from global variables...
1543 ;; ... from an external property list...
1544 ext-plist
1545 ;; ... from in-buffer settings...
1547 ;; ... and from subtree, when appropriate.
1549 ;; Eventually add misc. properties.
1551 :back-end
1552 backend
1554 :footnote-definition-alist
1555 ;; Footnotes definitions must be collected in the original
1556 ;; buffer, as there's no insurance that they will still be in
1557 ;; the parse tree, due to possible narrowing.
1571 alist))))
1572 alist))
1573 :id-alist
1574 ;; Collect id references.
1585 alist))))
1588 "Parse an OPTIONS line and return values as a plist.
1589 Optional argument BACKEND is an export back-end, as returned by,
1590 e.g., `org-export-create-backend'. It specifies which back-end
1591 specific items to read, if any."
1593 ;; Priority is given to back-end specific options.
1595 org-export-options-alist))
1596 plist)
1605 options))
1607 property
1610 plist))
1613 "Get export options in subtree at point.
1614 Optional argument BACKEND is an export back-end, as returned by,
1615 e.g., `org-export-create-backend'. It specifies back-end used
1616 for export. Return options as a plist."
1617 ;; For each buffer keyword, create a headline property setting the
1618 ;; same property in communication channel. The name for the property
1619 ;; is the keyword with "EXPORT_" appended to it.
1622 ;; Make sure point is at a heading.
1624 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1625 ;; title (with no todo keyword, priority cookie or tag) as its
1626 ;; fallback value.
1632 plist :title
1635 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1639 ;; Handle other keywords. TITLE keyword is excluded as it has
1640 ;; been handled already.
1648 ;; Export properties are not case-sensitive.
1655 plist
1656 property
1658 ;; Parse VALUE if required.
1662 ;; If BEHAVIOR is `split' expected value is
1663 ;; a list of strings, not a string.
1666 ;; Look for both general keywords and back-end specific
1667 ;; options, with priority given to the latter.
1669 org-export-options-alist)))
1670 ;; Return value.
1671 plist)))
1674 "Return current buffer export options, as a plist.
1676 Optional argument BACKEND, when non-nil, is an export back-end,
1677 as returned by, e.g., `org-export-create-backend'. It specifies
1678 which back-end specific options should also be read in the
1679 process.
1681 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1683 get-options ; For byte-compiler.
1686 ;; Priority is given to back-end specific options.
1688 org-export-options-alist))
1691 org-export-special-keywords))))
1694 ;; Return all properties associated to KEYWORD.
1701 ;; Recursively read keywords in buffer. FILES is a list
1702 ;; of files read so far. PLIST is the current property
1703 ;; list obtained.
1712 ;; Options in `org-export-special-keywords'.
1716 ;; Avoid circular dependencies.
1726 plist
1731 plist
1737 ;; Options in `org-export-options-alist'.
1742 plist property
1743 ;; Handle value depending on specified
1744 ;; BEHAVIOR.
1750 " "
1763 ;; Return final value.
1764 plist))))
1765 ;; Read options in the current buffer.
1768 ;; Parse keywords specified in `org-element-document-properties'
1769 ;; and return PLIST.
1778 ;; When TITLE keyword sets an empty
1779 ;; string, make sure it doesn't
1780 ;; appear as nil in the plist.
1784 "Return properties related to buffer attributes, as a plist."
1785 ;; Store full path of input file name, or nil. For internal use.
1791 "Return global export options as a plist.
1792 Optional argument BACKEND, if non-nil, is an export back-end, as
1793 returned by, e.g., `org-export-create-backend'. It specifies
1794 which back-end specific export options should also be read in the
1795 process."
1797 ;; Priority is given to back-end specific options.
1799 org-export-options-alist)))
1805 plist
1806 prop
1807 ;; Evaluate default value provided. If keyword is
1808 ;; a member of `org-element-document-properties',
1809 ;; parse it as a secondary string before storing it.
1813 org-element-document-properties))
1816 value)))))))))
1819 "Return variables bound from BIND keywords in current buffer.
1820 Also look for BIND keywords in setup files. The return value is
1821 an alist where associations are (VARIABLE-NAME VALUE)."
1826 ;; Return an alist between variable names and their
1827 ;; value. FILES is a list of setup files names read so
1828 ;; far, used to avoid circular dependencies. ALIST is
1829 ;; the alist collected so far.
1840 ;; Enter setup file.
1850 alist))))))))))
1851 alist)))))
1852 ;; Return value in appropriate order of appearance.
1855 ;; defsubst org-export-get-parent must be defined before first use,
1856 ;; was originally defined in the topology section
1859 "Return BLOB parent or nil.
1860 BLOB is the element or object considered."
1863 ;;;; Tree Properties
1864 ;;
1865 ;; Tree properties are information extracted from parse tree. They
1866 ;; are initialized at the beginning of the transcoding process by
1867 ;; `org-export-collect-tree-properties'.
1868 ;;
1869 ;; Dedicated functions focus on computing the value of specific tree
1870 ;; properties during initialization. Thus,
1871 ;; `org-export--populate-ignore-list' lists elements and objects that
1872 ;; should be skipped during export, `org-export--get-min-level' gets
1873 ;; the minimal exportable level, used as a basis to compute relative
1874 ;; level for headlines. Eventually
1875 ;; `org-export--collect-headline-numbering' builds an alist between
1876 ;; headlines and their numbering.
1879 "Extract tree properties from parse tree.
1881 DATA is the parse tree from which information is retrieved. INFO
1882 is a list holding export options.
1884 Following tree properties are set or updated:
1886 `:exported-data' Hash table used to memoize results from
1887 `org-export-data'.
1889 `:footnote-definition-alist' List of footnotes definitions in
1890 original buffer and current parse tree.
1892 `:headline-offset' Offset between true level of headlines and
1893 local level. An offset of -1 means a headline
1894 of level 2 should be considered as a level
1895 1 headline in the context.
1897 `:headline-numbering' Alist of all headlines as key an the
1898 associated numbering as value.
1900 `:ignore-list' List of elements that should be ignored during
1901 export.
1903 Return updated plist."
1904 ;; Install the parse tree in the communication channel, in order to
1905 ;; use `org-export-get-genealogy' and al.
1907 ;; Get the list of elements and objects to ignore, and put it into
1908 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1909 ;; been done during parse tree filtering.
1912 :ignore-list
1915 ;; Compute `:headline-offset' in order to be able to use
1916 ;; `org-export-get-relative-level'.
1919 :headline-offset
1921 ;; Update footnotes definitions list with definitions in parse tree.
1922 ;; This is required since buffer expansion might have modified
1923 ;; boundaries of footnote definitions contained in the parse tree.
1924 ;; This way, definitions in `footnote-definition-alist' are bound to
1925 ;; match those in the parse tree.
1931 defs)))
1933 ;; Properties order doesn't matter: get the rest of the tree
1934 ;; properties.
1938 info))
1941 "Return minimum exportable headline's level in DATA.
1942 DATA is parsed tree as returned by `org-element-parse-buffer'.
1943 OPTIONS is a plist holding export options."
1954 ;; If no headline was found, for the sake of consistency, set
1955 ;; minimum level to 1 nonetheless.
1959 "Return numbering of all exportable headlines in a parse tree.
1961 DATA is the parse tree. OPTIONS is the plist holding export
1962 options.
1964 Return an alist whose key is a headline and value is its
1965 associated numbering \(in the shape of a list of numbers\) or nil
1966 for a footnotes section."
1974 headline
1976 for idx from 0 to org-export-max-depth
1980 options)))
1983 "Return list of elements and objects to ignore during export.
1984 DATA is the parse tree to traverse. OPTIONS is the plist holding
1985 export options."
1987 walk-data
1988 ;; First find trees containing a select tag, if any.
1992 ;; Collect ignored elements or objects into IGNORE-LIST.
1998 ;; If headline is archived but tree below has
1999 ;; to be skipped, add it to ignore list.
2002 ;; Move into secondary string, if any.
2007 ;; Move into recursive objects/elements.
2009 ;; Main call.
2011 ;; Return value.
2012 ignore))
2015 "Return list of headlines and inlinetasks with a select tag in their tree.
2016 DATA is parsed data as returned by `org-element-parse-buffer'.
2017 INFO is a plist holding export options."
2019 walk-data ; For byte-compiler.
2029 ;; When a select tag is found, mark full
2030 ;; genealogy and every headline within the tree
2031 ;; as acceptable.
2034 genealogy
2037 selected-trees))
2038 ;; If at a headline, continue searching in tree,
2039 ;; recursively.
2049 selected-trees))
2052 "Non-nil when element or object BLOB should be skipped during export.
2053 OPTIONS is the plist holding export options. SELECTED, when
2054 non-nil, is a list of headlines or inlinetasks belonging to
2055 a tree with a select tag."
2062 ;; If `:with-drawers' value starts with `not', ignore
2063 ;; every drawer whose name belong to that list.
2064 ;; Otherwise, ignore drawers whose name isn't in that
2065 ;; list.
2081 ;; Ignore subtrees with an exclude tag.
2084 ;; When a select tag is present in the buffer, ignore any tree
2085 ;; without it.
2087 ;; Ignore commented sub-trees.
2089 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2091 ;; Ignore tasks, if specified by `:with-tasks' property.
2106 ;; `:with-timestamps' only applies to isolated timestamps
2107 ;; objects, i.e. timestamp objects in a paragraph containing only
2108 ;; timestamps and whitespaces.
2116 options t))))
2125 \f
2126 ;;; The Transcoder
2127 ;;
2128 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2129 ;; `org-element-parse-buffer') and transcodes it into a specified
2130 ;; back-end output. It takes care of filtering out elements or
2131 ;; objects according to export options and organizing the output blank
2132 ;; lines and white space are preserved. The function memoizes its
2133 ;; results, so it is cheap to call it within transcoders.
2134 ;;
2135 ;; It is possible to modify locally the back-end used by
2136 ;; `org-export-data' or even use a temporary back-end by using
2137 ;; `org-export-data-with-backend'.
2138 ;;
2139 ;; Internally, three functions handle the filtering of objects and
2140 ;; elements during the export. In particular,
2141 ;; `org-export-ignore-element' marks an element or object so future
2142 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2143 ;; elements or objects should be seen as real Org syntax and
2144 ;; `org-export-expand' transforms the others back into their original
2145 ;; shape
2146 ;;
2147 ;; `org-export-transcoder' is an accessor returning appropriate
2148 ;; translator function for a given element or object.
2151 "Return appropriate transcoder for BLOB.
2152 INFO is a plist containing export directives."
2154 ;; Return contents only for complete parse trees.
2160 "Convert DATA into current back-end format.
2162 DATA is a parse tree, an element or an object or a secondary
2163 string. INFO is a plist holding export options.
2165 Return a string."
2170 ;; Ignored element/object.
2172 ;; Plain text.
2178 info))
2179 ;; Uninterpreted element/object: change it back to Org
2180 ;; syntax and export again resulting raw string.
2184 data
2188 info))
2189 ;; Secondary string.
2192 ;; Element/Object without contents or, as a special
2193 ;; case, headline with archive tag and archived trees
2194 ;; restricted to title only.
2202 ;; Export snippets never return a nil value so
2203 ;; that white spaces following them are never
2204 ;; ignored.
2206 ;; Element/Object with contents.
2219 ;; Elements directly containing
2220 ;; objects must have their indentation
2221 ;; normalized first.
2223 data
2224 ;; When normalizing contents of the
2225 ;; first paragraph in an item or
2226 ;; a footnote definition, ignore
2227 ;; first line's indentation: there is
2228 ;; none and it might be misleading.
2233 data)
2240 info))))))))
2241 ;; Final result will be memoized before being returned.
2243 data
2247 ;; Append the same white space between elements or objects
2248 ;; as in the original buffer, and call appropriate filters.
2259 info)))
2260 results)))
2264 "Convert DATA into BACKEND format.
2266 DATA is an element, an object, a secondary string or a string.
2267 BACKEND is a symbol. INFO is a plist used as a communication
2268 channel.
2270 Unlike to `org-export-with-backend', this function will
2271 recursively convert DATA using BACKEND translation table."
2274 data
2275 ;; Set-up a new communication channel with translations defined in
2276 ;; BACKEND as the translate table and a new hash table for
2277 ;; memoization.
2279 info
2282 ;; Size of the hash table is reduced since this function
2283 ;; will probably be used on small trees.
2287 "Non-nil if element or object BLOB should be interpreted during export.
2288 If nil, BLOB will appear as raw Org syntax. Check is done
2289 according to export options INFO, stored as a plist."
2291 ;; ... entities...
2293 ;; ... emphasis...
2296 ;; ... fixed-width areas.
2298 ;; ... LaTeX environments and fragments...
2302 ;; ... sub/superscripts...
2308 ;; ... tables...
2313 "Expand a parsed element or object to its original state.
2315 BLOB is either an element or an object. CONTENTS is its
2316 contents, as a string or nil.
2318 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2319 keywords before output."
2324 blob contents))))
2327 "Add ELEMENT to `:ignore-list' in INFO.
2329 Any element in `:ignore-list' will be skipped when using
2330 `org-element-map'. INFO is modified by side effects."
2334 \f
2335 ;;; The Filter System
2336 ;;
2337 ;; Filters allow end-users to tweak easily the transcoded output.
2338 ;; They are the functional counterpart of hooks, as every filter in
2339 ;; a set is applied to the return value of the previous one.
2340 ;;
2341 ;; Every set is back-end agnostic. Although, a filter is always
2342 ;; called, in addition to the string it applies to, with the back-end
2343 ;; used as argument, so it's easy for the end-user to add back-end
2344 ;; specific filters in the set. The communication channel, as
2345 ;; a plist, is required as the third argument.
2346 ;;
2347 ;; From the developer side, filters sets can be installed in the
2348 ;; process with the help of `org-export-define-backend', which
2349 ;; internally stores filters as an alist. Each association has a key
2350 ;; among the following symbols and a function or a list of functions
2351 ;; as value.
2352 ;;
2353 ;; - `:filter-options' applies to the property list containing export
2354 ;; options. Unlike to other filters, functions in this list accept
2355 ;; two arguments instead of three: the property list containing
2356 ;; export options and the back-end. Users can set its value through
2357 ;; `org-export-filter-options-functions' variable.
2358 ;;
2359 ;; - `:filter-parse-tree' applies directly to the complete parsed
2360 ;; tree. Users can set it through
2361 ;; `org-export-filter-parse-tree-functions' variable.
2362 ;;
2363 ;; - `:filter-final-output' applies to the final transcoded string.
2364 ;; Users can set it with `org-export-filter-final-output-functions'
2365 ;; variable
2366 ;;
2367 ;; - `:filter-plain-text' applies to any string not recognized as Org
2368 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2369 ;; configure it.
2370 ;;
2371 ;; - `:filter-TYPE' applies on the string returned after an element or
2372 ;; object of type TYPE has been transcoded. A user can modify
2373 ;; `org-export-filter-TYPE-functions'
2374 ;;
2375 ;; All filters sets are applied with
2376 ;; `org-export-filter-apply-functions' function. Filters in a set are
2377 ;; applied in a LIFO fashion. It allows developers to be sure that
2378 ;; their filters will be applied first.
2379 ;;
2380 ;; Filters properties are installed in communication channel with
2381 ;; `org-export-install-filters' function.
2382 ;;
2383 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2384 ;; `org-export-before-parsing-hook') are run at the beginning of the
2385 ;; export process and just before parsing to allow for heavy structure
2386 ;; modifications.
2389 ;;;; Hooks
2392 "Hook run at the beginning of the export process.
2394 This is run before include keywords and macros are expanded and
2395 Babel code blocks executed, on a copy of the original buffer
2396 being exported. Visibility and narrowing are preserved. Point
2397 is at the beginning of the buffer.
2399 Every function in this hook will be called with one argument: the
2403 "Hook run before parsing an export buffer.
2405 This is run after include keywords and macros have been expanded
2406 and Babel code blocks executed, on a copy of the original buffer
2407 being exported. Visibility and narrowing are preserved. Point
2408 is at the beginning of the buffer.
2410 Every function in this hook will be called with one argument: the
2414 ;;;; Special Filters
2417 "List of functions applied to the export options.
2418 Each filter is called with two arguments: the export options, as
2419 a plist, and the back-end, as a symbol. It must return
2423 "List of functions applied to the parsed tree.
2424 Each filter is called with three arguments: the parse tree, as
2425 returned by `org-element-parse-buffer', the back-end, as
2426 a symbol, and the communication channel, as a plist. It must
2430 "List of functions applied to plain text.
2431 Each filter is called with three arguments: a string which
2432 contains no Org syntax, the back-end, as a symbol, and the
2433 communication channel, as a plist. It must return a string or
2437 "List of functions applied to the transcoded string.
2438 Each filter is called with three arguments: the full transcoded
2439 string, the back-end, as a symbol, and the communication channel,
2440 as a plist. It must return a string that will be used as the
2444 ;;;; Elements Filters
2447 "List of functions applied to a transcoded babel-call.
2448 Each filter is called with three arguments: the transcoded data,
2449 as a string, the back-end, as a symbol, and the communication
2453 "List of functions applied to a transcoded center block.
2454 Each filter is called with three arguments: the transcoded data,
2455 as a string, the back-end, as a symbol, and the communication
2459 "List of functions applied to a transcoded clock.
2460 Each filter is called with three arguments: the transcoded data,
2461 as a string, the back-end, as a symbol, and the communication
2465 "List of functions applied to a transcoded comment.
2466 Each filter is called with three arguments: the transcoded data,
2467 as a string, the back-end, as a symbol, and the communication
2471 "List of functions applied to a transcoded comment-block.
2472 Each filter is called with three arguments: the transcoded data,
2473 as a string, the back-end, as a symbol, and the communication
2477 "List of functions applied to a transcoded diary-sexp.
2478 Each filter is called with three arguments: the transcoded data,
2479 as a string, the back-end, as a symbol, and the communication
2483 "List of functions applied to a transcoded drawer.
2484 Each filter is called with three arguments: the transcoded data,
2485 as a string, the back-end, as a symbol, and the communication
2489 "List of functions applied to a transcoded dynamic-block.
2490 Each filter is called with three arguments: the transcoded data,
2491 as a string, the back-end, as a symbol, and the communication
2495 "List of functions applied to a transcoded example-block.
2496 Each filter is called with three arguments: the transcoded data,
2497 as a string, the back-end, as a symbol, and the communication
2501 "List of functions applied to a transcoded export-block.
2502 Each filter is called with three arguments: the transcoded data,
2503 as a string, the back-end, as a symbol, and the communication
2507 "List of functions applied to a transcoded fixed-width.
2508 Each filter is called with three arguments: the transcoded data,
2509 as a string, the back-end, as a symbol, and the communication
2513 "List of functions applied to a transcoded footnote-definition.
2514 Each filter is called with three arguments: the transcoded data,
2515 as a string, the back-end, as a symbol, and the communication
2519 "List of functions applied to a transcoded headline.
2520 Each filter is called with three arguments: the transcoded data,
2521 as a string, the back-end, as a symbol, and the communication
2525 "List of functions applied to a transcoded horizontal-rule.
2526 Each filter is called with three arguments: the transcoded data,
2527 as a string, the back-end, as a symbol, and the communication
2531 "List of functions applied to a transcoded inlinetask.
2532 Each filter is called with three arguments: the transcoded data,
2533 as a string, the back-end, as a symbol, and the communication
2537 "List of functions applied to a transcoded item.
2538 Each filter is called with three arguments: the transcoded data,
2539 as a string, the back-end, as a symbol, and the communication
2543 "List of functions applied to a transcoded keyword.
2544 Each filter is called with three arguments: the transcoded data,
2545 as a string, the back-end, as a symbol, and the communication
2549 "List of functions applied to a transcoded latex-environment.
2550 Each filter is called with three arguments: the transcoded data,
2551 as a string, the back-end, as a symbol, and the communication
2555 "List of functions applied to a transcoded node-property.
2556 Each filter is called with three arguments: the transcoded data,
2557 as a string, the back-end, as a symbol, and the communication
2561 "List of functions applied to a transcoded paragraph.
2562 Each filter is called with three arguments: the transcoded data,
2563 as a string, the back-end, as a symbol, and the communication
2567 "List of functions applied to a transcoded plain-list.
2568 Each filter is called with three arguments: the transcoded data,
2569 as a string, the back-end, as a symbol, and the communication
2573 "List of functions applied to a transcoded planning.
2574 Each filter is called with three arguments: the transcoded data,
2575 as a string, the back-end, as a symbol, and the communication
2579 "List of functions applied to a transcoded property-drawer.
2580 Each filter is called with three arguments: the transcoded data,
2581 as a string, the back-end, as a symbol, and the communication
2585 "List of functions applied to a transcoded quote block.
2586 Each filter is called with three arguments: the transcoded quote
2587 data, as a string, the back-end, as a symbol, and the
2588 communication channel, as a plist. It must return a string or
2592 "List of functions applied to a transcoded quote-section.
2593 Each filter is called with three arguments: the transcoded data,
2594 as a string, the back-end, as a symbol, and the communication
2598 "List of functions applied to a transcoded section.
2599 Each filter is called with three arguments: the transcoded data,
2600 as a string, the back-end, as a symbol, and the communication
2604 "List of functions applied to a transcoded special block.
2605 Each filter is called with three arguments: the transcoded data,
2606 as a string, the back-end, as a symbol, and the communication
2610 "List of functions applied to a transcoded src-block.
2611 Each filter is called with three arguments: the transcoded data,
2612 as a string, the back-end, as a symbol, and the communication
2616 "List of functions applied to a transcoded table.
2617 Each filter is called with three arguments: the transcoded data,
2618 as a string, the back-end, as a symbol, and the communication
2622 "List of functions applied to a transcoded table-cell.
2623 Each filter is called with three arguments: the transcoded data,
2624 as a string, the back-end, as a symbol, and the communication
2628 "List of functions applied to a transcoded table-row.
2629 Each filter is called with three arguments: the transcoded data,
2630 as a string, the back-end, as a symbol, and the communication
2634 "List of functions applied to a transcoded verse block.
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 ;;;; Objects Filters
2643 "List of functions applied to transcoded bold text.
2644 Each filter is called with three arguments: the transcoded data,
2645 as a string, the back-end, as a symbol, and the communication
2649 "List of functions applied to transcoded code text.
2650 Each filter is called with three arguments: the transcoded data,
2651 as a string, the back-end, as a symbol, and the communication
2655 "List of functions applied to a transcoded entity.
2656 Each filter is called with three arguments: the transcoded data,
2657 as a string, the back-end, as a symbol, and the communication
2661 "List of functions applied to a transcoded export-snippet.
2662 Each filter is called with three arguments: the transcoded data,
2663 as a string, the back-end, as a symbol, and the communication
2667 "List of functions applied to a transcoded footnote-reference.
2668 Each filter is called with three arguments: the transcoded data,
2669 as a string, the back-end, as a symbol, and the communication
2673 "List of functions applied to a transcoded inline-babel-call.
2674 Each filter is called with three arguments: the transcoded data,
2675 as a string, the back-end, as a symbol, and the communication
2679 "List of functions applied to a transcoded inline-src-block.
2680 Each filter is called with three arguments: the transcoded data,
2681 as a string, the back-end, as a symbol, and the communication
2685 "List of functions applied to transcoded italic text.
2686 Each filter is called with three arguments: the transcoded data,
2687 as a string, the back-end, as a symbol, and the communication
2691 "List of functions applied to a transcoded latex-fragment.
2692 Each filter is called with three arguments: the transcoded data,
2693 as a string, the back-end, as a symbol, and the communication
2697 "List of functions applied to a transcoded line-break.
2698 Each filter is called with three arguments: the transcoded data,
2699 as a string, the back-end, as a symbol, and the communication
2703 "List of functions applied to a transcoded link.
2704 Each filter is called with three arguments: the transcoded data,
2705 as a string, the back-end, as a symbol, and the communication
2709 "List of functions applied to a transcoded radio-target.
2710 Each filter is called with three arguments: the transcoded data,
2711 as a string, the back-end, as a symbol, and the communication
2715 "List of functions applied to a transcoded statistics-cookie.
2716 Each filter is called with three arguments: the transcoded data,
2717 as a string, the back-end, as a symbol, and the communication
2721 "List of functions applied to transcoded strike-through text.
2722 Each filter is called with three arguments: the transcoded data,
2723 as a string, the back-end, as a symbol, and the communication
2727 "List of functions applied to a transcoded subscript.
2728 Each filter is called with three arguments: the transcoded data,
2729 as a string, the back-end, as a symbol, and the communication
2733 "List of functions applied to a transcoded superscript.
2734 Each filter is called with three arguments: the transcoded data,
2735 as a string, the back-end, as a symbol, and the communication
2739 "List of functions applied to a transcoded target.
2740 Each filter is called with three arguments: the transcoded data,
2741 as a string, the back-end, as a symbol, and the communication
2745 "List of functions applied to a transcoded timestamp.
2746 Each filter is called with three arguments: the transcoded data,
2747 as a string, the back-end, as a symbol, and the communication
2751 "List of functions applied to transcoded underline text.
2752 Each filter is called with three arguments: the transcoded data,
2753 as a string, the back-end, as a symbol, and the communication
2757 "List of functions applied to transcoded verbatim text.
2758 Each filter is called with three arguments: the transcoded data,
2759 as a string, the back-end, as a symbol, and the communication
2763 ;;;; Filters Tools
2764 ;;
2765 ;; Internal function `org-export-install-filters' installs filters
2766 ;; hard-coded in back-ends (developer filters) and filters from global
2767 ;; variables (user filters) in the communication channel.
2768 ;;
2769 ;; Internal function `org-export-filter-apply-functions' takes care
2770 ;; about applying each filter in order to a given data. It ignores
2771 ;; filters returning a nil value but stops whenever a filter returns
2772 ;; an empty string.
2775 "Call every function in FILTERS.
2777 Functions are called with arguments VALUE, current export
2778 back-end's name and INFO. A function returning a nil value will
2779 be skipped. If it returns the empty string, the process ends and
2780 VALUE is ignored.
2782 Call is done in a LIFO fashion, to be sure that developer
2783 specified filters, if any, are called first."
2794 "Install filters properties in communication channel.
2795 INFO is a plist containing the current communication channel.
2796 Return the updated communication channel."
2798 ;; Install user-defined filters with `org-export-filters-alist'
2799 ;; and filters already in INFO (through ext-plist mechanism).
2806 ;; Filters in INFO will be called
2807 ;; before those user provided.
2810 default-value)))))
2811 org-export-filters-alist)
2812 ;; Prepend back-end specific filters to that list.
2814 ;; Single values get consed, lists are appended.
2819 plist key
2823 ;; Return new communication channel.
2827 \f
2828 ;;; Core functions
2829 ;;
2830 ;; This is the room for the main function, `org-export-as', along with
2831 ;; its derivative, `org-export-string-as'.
2832 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2833 ;; function should be added to kill ring.
2834 ;;
2835 ;; Note that `org-export-as' doesn't really parse the current buffer,
2836 ;; but a copy of it (with the same buffer-local variables and
2837 ;; visibility), where macros and include keywords are expanded and
2838 ;; Babel blocks are executed, if appropriate.
2839 ;; `org-export-with-buffer-copy' macro prepares that copy.
2840 ;;
2841 ;; File inclusion is taken care of by
2842 ;; `org-export-expand-include-keyword' and
2843 ;; `org-export--prepare-file-contents'. Structure wise, including
2844 ;; a whole Org file in a buffer often makes little sense. For
2845 ;; example, if the file contains a headline and the include keyword
2846 ;; was within an item, the item should contain the headline. That's
2847 ;; why file inclusion should be done before any structure can be
2848 ;; associated to the file, that is before parsing.
2849 ;;
2850 ;; `org-export-insert-default-template' is a command to insert
2851 ;; a default template (or a back-end specific template) at point or in
2852 ;; current subtree.
2855 "Return a copy of the current buffer.
2856 The copy preserves Org buffer-local variables, visibility and
2857 narrowing."
2863 new-buf))
2866 "Apply BODY in a copy of the current buffer.
2867 The copy preserves local variables, visibility and contents of
2868 the original buffer. Point is at the beginning of the buffer
2869 when BODY is applied."
2878 ;; Kill copy without confirmation.
2884 "Generate a function duplicating BUFFER.
2886 The copy will preserve local variables, visibility, contents and
2887 narrowing of the original buffer. If a region was active in
2888 BUFFER, contents will be narrowed to that region instead.
2890 The resulting function can be evaluated at a later time, from
2891 another buffer, effectively cloning the original buffer there.
2893 The function assumes BUFFER's major mode is `org-mode'."
2897 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2898 ;; already in BUFFER.
2900 ;; Copy specific buffer local variables and variables set
2901 ;; through BIND keywords.
2903 vars)
2911 buffer-file-name
2912 buffer-file-coding-system))
2916 ;; Skip unreadable values, as they cannot be
2917 ;; sent to external process.
2921 vars))))))
2922 ;; Whole buffer contents.
2927 ;; Narrowing.
2931 ;; Current position of point.
2933 ;; Overlays with invisible property.
2943 ov-set))))
2945 ov-set)))))
2947 ;;;###autoload
2950 "Transcode current Org buffer into BACKEND code.
2952 BACKEND is either an export back-end, as returned by, e.g.,
2953 `org-export-create-backend', or a symbol referring to
2954 a registered back-end.
2956 If narrowing is active in the current buffer, only transcode its
2957 narrowed part.
2959 If a region is active, transcode that region.
2961 When optional argument SUBTREEP is non-nil, transcode the
2962 sub-tree at point, extracting information from the headline
2963 properties first.
2965 When optional argument VISIBLE-ONLY is non-nil, don't export
2966 contents of hidden elements.
2968 When optional argument BODY-ONLY is non-nil, only return body
2969 code, without surrounding template.
2971 Optional argument EXT-PLIST, when provided, is a property list
2972 with external parameters overriding Org default settings, but
2973 still inferior to file-local settings.
2975 Return code as a string."
2980 ;; Narrow buffer to an appropriate region or subtree for
2981 ;; parsing. If parsing subtree, be sure to remove main headline
2982 ;; too.
2990 ;; Initialize communication channel with original buffer
2991 ;; attributes, unavailable in its copy.
3000 tree)
3001 ;; Update communication channel and get parse tree. Buffer
3002 ;; isn't parsed directly. Instead, a temporary copy is
3003 ;; created, where include keywords, macros are expanded and
3004 ;; code blocks are evaluated.
3006 ;; Run first hook with current back-end's name as argument.
3010 ;; Update macro templates since #+INCLUDE keywords might have
3011 ;; added some new ones.
3015 ;; Update radio targets since keyword inclusion might have
3016 ;; added some more.
3018 ;; Run last hook with current back-end's name as argument.
3023 ;; Update communication channel with environment. Also
3024 ;; install user's and developer's filters.
3029 ;; Special case: provide original file name or buffer name as
3030 ;; default value for :title property.
3033 info :title
3037 ;; Expand export-specific set of macros: {{{author}}},
3038 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3039 ;; once regular macros have been expanded, since document
3040 ;; keywords may contain one of them.
3046 ;; EMAIL is not a parsed keyword: store it as-is.
3050 ;; Call options filters and update export options. We do not
3051 ;; use `org-export-filter-apply-functions' here since the
3052 ;; arity of such filters is different.
3057 ;; Parse buffer and call parse-tree filter on it.
3062 ;; Now tree is complete, compute its properties and add them
3063 ;; to communication channel.
3067 ;; Eventually transcode TREE. Wrap the resulting string into
3068 ;; a template.
3077 ;; Remove all text properties since they cannot be
3078 ;; retrieved from an external process. Finally call
3079 ;; final-output filter and return result.
3085 info))))))))
3087 ;;;###autoload
3089 "Transcode STRING into BACKEND code.
3091 BACKEND is either an export back-end, as returned by, e.g.,
3092 `org-export-create-backend', or a symbol referring to
3093 a registered back-end.
3095 When optional argument BODY-ONLY is non-nil, only return body
3096 code, without preamble nor postamble.
3098 Optional argument EXT-PLIST, when provided, is a property list
3099 with external parameters overriding Org default settings, but
3100 still inferior to file-local settings.
3102 Return code as a string."
3108 ;;;###autoload
3110 "Replace the active region by its export to BACKEND.
3111 BACKEND is either an export back-end, as returned by, e.g.,
3112 `org-export-create-backend', or a symbol referring to
3113 a registered back-end."
3123 ;;;###autoload
3125 "Insert all export keywords with default values at beginning of line.
3127 BACKEND is a symbol referring to the name of a registered export
3128 back-end, for which specific export options should be added to
3129 the template, or `default' for default template. When it is nil,
3130 the user will be prompted for a category.
3132 If SUBTREEP is non-nil, export configuration will be set up
3133 locally for the subtree through node properties."
3143 "Options category: "
3147 org-export--registered-backends))))))
3148 options keywords)
3149 ;; Populate OPTIONS and KEYWORDS.
3166 ;; Move to an appropriate location in order to insert options.
3168 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3169 ;; list of available keywords.
3197 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3215 ;; And the rest of keywords.
3226 "Expand every include keyword in buffer.
3227 Optional argument INCLUDED is a list of included file names along
3228 with their line restriction, when appropriate. It is used to
3229 avoid infinite recursion. Optional argument DIR is the current
3230 working directory. It is used to properly resolve relative
3231 paths."
3238 ;; Extract arguments from keyword's value.
3246 dir)
3251 value)
3257 ;; Minimal level of included file defaults to the child
3258 ;; level of the current headline, if any, or one. It
3259 ;; only applies is the file is meant to be included as
3260 ;; an Org one.
3268 ;; Remove keyword.
3274 ;; Check if files has already been parsed. Look after
3275 ;; inclusion lines too, as different parts of the same file
3276 ;; can be included too.
3288 ind-str contents ind-str))))
3296 ind-str env contents ind-str))))
3309 "Prepare the contents of FILE for inclusion and return them as a string.
3311 When optional argument LINES is a string specifying a range of
3312 lines, include only those lines.
3314 Optional argument IND, when non-nil, is an integer specifying the
3315 global indentation of returned contents. Since its purpose is to
3316 allow an included file to stay in the same environment it was
3317 created \(i.e. a list item), it doesn't apply past the first
3318 headline encountered.
3320 Optional argument MINLEVEL, when non-nil, is an integer
3321 specifying the level that any top-level headline in the included
3322 file should have."
3338 ;; Remove blank lines at beginning and end of contents. The logic
3339 ;; behind that removal is that blank lines around include keyword
3340 ;; override blank lines in included file.
3349 ;; If IND is set, preserve indentation of include keyword until
3350 ;; the first headline encountered.
3357 ;; Do not move footnote definitions out of column 0.
3363 ;; When MINLEVEL is specified, compute minimal level for headlines
3364 ;; in the file (CUR-MIN), and remove stars to each headline so
3365 ;; that headlines with minimal level have a level of MINLEVEL.
3376 ;; Only change stars, don't bother moving whole
3377 ;; sections.
3384 "Execute every Babel code in the visible part of current buffer."
3385 ;; Get a pristine copy of current buffer so Babel references can be
3386 ;; properly resolved.
3393 "Return a non-nil value when output should be added to the kill ring.
3394 See also `org-export-copy-to-kill-ring'."
3400 \f
3401 ;;; Tools For Back-Ends
3402 ;;
3403 ;; A whole set of tools is available to help build new exporters. Any
3404 ;; function general enough to have its use across many back-ends
3405 ;; should be added here.
3407 ;;;; For Affiliated Keywords
3408 ;;
3409 ;; `org-export-read-attribute' reads a property from a given element
3410 ;; as a plist. It can be used to normalize affiliated keywords'
3411 ;; syntax.
3412 ;;
3413 ;; Since captions can span over multiple lines and accept dual values,
3414 ;; their internal representation is a bit tricky. Therefore,
3415 ;; `org-export-get-caption' transparently returns a given element's
3416 ;; caption as a secondary string.
3419 "Turn ATTRIBUTE property from ELEMENT into a plist.
3421 When optional argument PROPERTY is non-nil, return the value of
3422 that property within attributes.
3426 properties.
3428 All values will become strings except the empty string and
3431 will become the empty string."
3445 s)
3450 ;; Ignore any string before first property with `cdr'.
3455 "Return caption from ELEMENT as a secondary string.
3457 When optional argument SHORTP is non-nil, return short caption,
3458 as a secondary string, instead.
3460 Caption lines are separated by a white space."
3468 ;;;; For Derived Back-ends
3469 ;;
3470 ;; `org-export-with-backend' is a function allowing to locally use
3471 ;; another back-end to transcode some object or element. In a derived
3472 ;; back-end, it may be used as a fall-back function once all specific
3473 ;; cases have been treated.
3476 "Call a transcoder from BACKEND on DATA.
3477 BACKEND is an export back-end, as returned by, e.g.,
3478 `org-export-create-backend', or a symbol referring to
3479 a registered back-end. DATA is an Org element, object, secondary
3480 string or string. CONTENTS, when non-nil, is the transcoded
3481 contents of DATA element, as a string. INFO, when non-nil, is
3482 the communication channel used for export, as a plist."
3492 transcoder data contents
3495 :translate-alist all-transcoders
3499 ;;;; For Export Snippets
3500 ;;
3501 ;; Every export snippet is transmitted to the back-end. Though, the
3502 ;; latter will only retain one type of export-snippet, ignoring
3503 ;; others, based on the former's target back-end. The function
3504 ;; `org-export-snippet-backend' returns that back-end for a given
3505 ;; export-snippet.
3508 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3509 Translation, with `org-export-snippet-translation-alist', is
3510 applied."
3514 back-end))))
3517 ;;;; For Footnotes
3518 ;;
3519 ;; `org-export-collect-footnote-definitions' is a tool to list
3520 ;; actually used footnotes definitions in the whole parse tree, or in
3521 ;; a headline, in order to add footnote listings throughout the
3522 ;; transcoded data.
3523 ;;
3524 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3525 ;; back-ends, when they need to attach the footnote definition only to
3526 ;; the first occurrence of the corresponding label.
3527 ;;
3528 ;; `org-export-get-footnote-definition' and
3529 ;; `org-export-get-footnote-number' provide easier access to
3530 ;; additional information relative to a footnote reference.
3533 "Return an alist between footnote numbers, labels and definitions.
3535 DATA is the parse tree from which definitions are collected.
3536 INFO is the plist used as a communication channel.
3538 Definitions are sorted by order of references. They either
3539 appear as Org data or as a secondary string for inlined
3540 footnotes. Unreferenced definitions are ignored."
3542 collect-fn ; for byte-compiler.
3546 ;; Collect footnote number, label and definition in DATA.
3554 def)
3555 num-alist)
3556 ;; Also search in definition for nested footnotes.
3559 ;; Don't enter footnote definitions since it will happen
3560 ;; when their first reference is found.
3566 "Non-nil when a footnote reference is the first one for its label.
3568 FOOTNOTE-REFERENCE is the footnote reference being considered.
3569 INFO is the plist used as a communication channel."
3571 ;; Anonymous footnotes are always a first reference.
3573 ;; Otherwise, return the first footnote with the same LABEL and
3574 ;; test if it is equal to FOOTNOTE-REFERENCE.
3584 ;; If FN isn't inlined, be sure to traverse its
3585 ;; definition before resuming search. See
3586 ;; comments in `org-export-get-footnote-number'
3587 ;; for more information.
3591 ;; Don't enter footnote definitions since it will
3592 ;; happen when their first reference is found.
3595 footnote-reference)))))
3598 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3599 INFO is the plist used as a communication channel. If no such
3601 string."
3608 "Return number associated to a footnote.
3610 FOOTNOTE is either a footnote reference or a footnote definition.
3611 INFO is the plist used as a communication channel."
3613 seen-refs
3614 search-ref ; For byte-compiler.
3618 ;; Search footnote references through DATA, filling
3619 ;; SEEN-REFS along the way.
3624 ;; Anonymous footnote match: return number.
3627 ;; Labels match: return number.
3630 ;; Anonymous footnote: it's always a new one.
3631 ;; Also, be sure to return nil from the `cond' so
3632 ;; `first-match' doesn't get us out of the loop.
3634 ;; Label not seen so far: add it so SEEN-REFS.
3635 ;;
3636 ;; Also search for subsequent references in
3637 ;; footnote definition so numbering follows
3638 ;; reading logic. Note that we don't have to care
3639 ;; about inline definitions, since
3640 ;; `org-element-map' already traverses them at the
3641 ;; right time.
3642 ;;
3643 ;; Once again, return nil to stay in the loop.
3648 nil))))
3649 ;; Don't enter footnote definitions since it will
3650 ;; happen when their first reference is found.
3655 ;;;; For Headlines
3656 ;;
3657 ;; `org-export-get-relative-level' is a shortcut to get headline
3658 ;; level, relatively to the lower headline level in the parsed tree.
3659 ;;
3660 ;; `org-export-get-headline-number' returns the section number of an
3661 ;; headline, while `org-export-number-to-roman' allows to convert it
3662 ;; to roman numbers.
3663 ;;
3664 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3665 ;; `org-export-last-sibling-p' are three useful predicates when it
3666 ;; comes to fulfill the `:headline-levels' property.
3667 ;;
3668 ;; `org-export-get-tags', `org-export-get-category' and
3669 ;; `org-export-get-node-property' extract useful information from an
3670 ;; headline or a parent headline. They all handle inheritance.
3671 ;;
3672 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3673 ;; as a secondary string, suitable for table of contents. It falls
3674 ;; back onto default title.
3677 "Return HEADLINE relative level within current parsed tree.
3678 INFO is a plist holding contextual information."
3683 "Non-nil when HEADLINE is considered as low level.
3685 INFO is a plist used as a communication channel.
3687 A low level headlines has a relative level greater than
3688 `:headline-levels' property value.
3690 Return value is the difference between HEADLINE relative level
3691 and the last level being considered as high enough, or nil."
3698 "Return HEADLINE numbering as a list of numbers.
3699 INFO is a plist holding contextual information."
3703 "Return a non-nil value if HEADLINE element should be numbered.
3704 INFO is a plist used as a communication channel."
3710 "Convert integer N into a roman numeral."
3723 res)))
3726 "Return list of tags associated to ELEMENT.
3728 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3729 is a plist used as a communication channel.
3731 Select tags (see `org-export-select-tags') and exclude tags (see
3732 `org-export-exclude-tags') are removed from the list.
3734 When non-nil, optional argument TAGS should be a list of strings.
3735 Any tag belonging to this list will also be removed.
3737 When optional argument INHERITED is non-nil, tags can also be
3738 inherited from parent headlines and FILETAGS keywords."
3744 ;; Build complete list of inherited tags.
3755 ;; Add FILETAGS keywords and return results.
3759 "Return node PROPERTY value for BLOB.
3761 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3762 element or object.
3764 If optional argument INHERITED is non-nil, the value can be
3765 inherited from a parent headline.
3767 Return value is a string or nil."
3779 "Return category for element or object BLOB.
3781 INFO is a plist used as a communication channel.
3783 CATEGORY is automatically inherited from a parent headline, from
3784 #+CATEGORY: keyword or created out of original file name. If all
3788 ;; Almost like `org-export-node-property', but we cannot trust
3789 ;; `plist-member' as every headline has a `:CATEGORY'
3790 ;; property, would it be nil or equal to "???" (which has the
3791 ;; same meaning).
3809 "Return alternative title for HEADLINE, as a secondary string.
3810 INFO is a plist used as a communication channel. If no optional
3811 title is defined, fall-back to the regular title."
3816 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3817 INFO is a plist used as a communication channel."
3822 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3823 INFO is a plist used as a communication channel."
3827 ;;;; For Keywords
3828 ;;
3829 ;; `org-export-get-date' returns a date appropriate for the document
3830 ;; to about to be exported. In particular, it takes care of
3831 ;; `org-export-date-timestamp-format'.
3834 "Return date value for the current document.
3836 INFO is a plist used as a communication channel. FMT, when
3837 non-nil, is a time format string that will be applied on the date
3838 if it consists in a single timestamp object. It defaults to
3839 `org-export-date-timestamp-format' when nil.
3841 A proper date can be a secondary string, a string or nil. It is
3842 meant to be translated with `org-export-data' or alike."
3853 ;;;; For Links
3854 ;;
3855 ;; `org-export-solidify-link-text' turns a string into a safer version
3856 ;; for links, replacing most non-standard characters with hyphens.
3857 ;;
3858 ;; `org-export-get-coderef-format' returns an appropriate format
3859 ;; string for coderefs.
3860 ;;
3861 ;; `org-export-inline-image-p' returns a non-nil value when the link
3862 ;; provided should be considered as an inline image.
3863 ;;
3864 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3865 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3866 ;; returns an appropriate unique identifier when found, or nil.
3867 ;;
3868 ;; `org-export-resolve-id-link' returns the first headline with
3869 ;; specified id or custom-id in parse tree, the path to the external
3870 ;; file with the id or nil when neither was found.
3871 ;;
3872 ;; `org-export-resolve-coderef' associates a reference to a line
3873 ;; number in the element it belongs, or returns the reference itself
3874 ;; when the element isn't numbered.
3877 "Take link text S and make a safe target out of it."
3882 "Return format string for code reference link.
3883 PATH is the link path. DESC is its description."
3891 "Non-nil if LINK object points to an inline image.
3893 Optional argument is a set of RULES defining inline images. It
3894 is an alist where associations have the following shape:
3896 \(TYPE . REGEXP)
3898 Applying a rule means apply REGEXP against LINK's path when its
3899 type is TYPE. The function will return a non-nil value if any of
3900 the provided rules is non-nil. The default rule is
3901 `org-export-default-inline-image-rule'.
3903 This only applies to links without a description."
3914 rules)
3915 ;; Return nil if no rule matched.
3916 nil))))
3919 "Resolve a code reference REF.
3921 INFO is a plist used as a communication channel.
3923 Return associated line number in source code, or REF itself,
3924 depending on src-block or example element's switches."
3931 org-coderef-label-format)))
3935 ;; Element containing REF is found. Resolve it to either
3936 ;; a label or a line number, as needed.
3946 "Return LINK destination.
3948 INFO is a plist holding contextual information.
3950 Return value can be an object, an element, or nil:
3952 - If LINK path matches a target object (i.e. <<path>>) return it.
3954 - If LINK path exactly matches the name affiliated keyword
3955 \(i.e. #+NAME: path) of an element, return that element.
3957 - If LINK path exactly matches any headline name, return that
3958 element. If more than one headline share that name, priority
3959 will be given to the one with the closest common ancestor, if
3960 any, or the first one in the parse tree otherwise.
3962 - Otherwise, return nil.
3965 significant."
3968 ;; Split PATH at white spaces so matches are space
3969 ;; insensitive.
3972 ;; Cache for destinations that are not position dependent.
3980 ;; Destination is not position dependent: use cached value.
3982 ;; First try to find a matching "<<path>>" unless user specified
3983 ;; he was looking for a headline (path starts with a "*"
3984 ;; character).
3990 path)
3991 blob))
3994 ;; Then try to find an element with a matching "#+NAME: path"
3995 ;; affiliated keyword.
3998 org-element-all-elements
4003 el)))
4006 ;; Last case: link either points to a headline or to nothingness.
4007 ;; Try to find the source, with priority given to headlines with
4008 ;; the closest common ancestor. If such candidate is found,
4009 ;; return it, otherwise return nil.
4013 ;; Return first headline whose `:raw-value' property is
4014 ;; NAME in parse tree DATA, or nil. Statistics cookies
4015 ;; are ignored.
4023 name)
4024 headline))
4026 ;; Search among headlines sharing an ancestor with link, from
4027 ;; closest to farthest.
4036 ;; No destination found: return nil.
4040 "Return headline referenced as LINK destination.
4042 INFO is a plist used as a communication channel.
4044 Return value can be the headline element matched in current parse
4048 ;; First check if id is within the current parse tree.
4053 headline))
4055 ;; Otherwise, look for external files.
4059 "Return radio-target object referenced as LINK destination.
4061 INFO is a plist used as a communication channel.
4063 Return value can be a radio-target object or nil. Assume LINK
4072 nil nil path nil nil t)
4073 t)
4074 radio))
4078 ;;;; For References
4079 ;;
4080 ;; `org-export-get-ordinal' associates a sequence number to any object
4081 ;; or element.
4084 "Return ordinal number of an element or object.
4086 ELEMENT is the element or object considered. INFO is the plist
4087 used as a communication channel.
4089 Optional argument TYPES, when non-nil, is a list of element or
4090 object types, as symbols, that should also be counted in.
4091 Otherwise, only provided element's type is considered.
4093 Optional argument PREDICATE is a function returning a non-nil
4094 value if the current element or object should be counted in. It
4095 accepts two arguments: the element or object being considered and
4096 the plist used as a communication channel. This allows to count
4097 only a certain type of objects (i.e. inline images).
4099 Return value is a list of numbers if ELEMENT is a headline or an
4100 item. It is nil for keywords. It represents the footnote number
4101 for footnote definitions and footnote references. If ELEMENT is
4102 a target, return the same value as if ELEMENT was the closest
4103 table, item or headline containing the target. In any other
4104 case, return the sequence number of ELEMENT among elements or
4105 objects of the same type."
4106 ;; Ordinal of a target object refer to the ordinal of the closest
4107 ;; table, item, or headline containing the object.
4111 when
4115 table))
4116 return parent)))
4118 ;; Special case 1: A headline returns its number as a list.
4120 ;; Special case 2: An item returns its number as a list.
4124 struct
4131 ;; Increment counter until ELEMENT is found again.
4141 ;;;; For Special Blocks
4142 ;;
4143 ;; `org-export-raw-special-block-p' check if current special block is
4144 ;; an "export block", i.e., a block whose contents should be inserted
4145 ;; as-is in the output. This should generally be the first check to
4146 ;; do when handling special blocks in the export back-end.
4149 "Non-nil if ELEMENT is an export block relatively to current back-end.
4150 An export block is a special block whose contents should be
4151 included as-is in the final output. Such blocks are defined
4152 through :export-block property in `org-export-define-backend',
4153 which see."
4160 b))))
4163 ;;;; For Src Blocks
4164 ;;
4165 ;; `org-export-get-loc' counts number of code lines accumulated in
4166 ;; src-block or example-block elements with a "+n" switch until
4167 ;; a given element, excluded. Note: "-n" switches reset that count.
4168 ;;
4169 ;; `org-export-unravel-code' extracts source code (along with a code
4170 ;; references alist) from an `element-block' or `src-block' type
4171 ;; element.
4172 ;;
4173 ;; `org-export-format-code' applies a formatting function to each line
4174 ;; of code, providing relative line number and code reference when
4175 ;; appropriate. Since it doesn't access the original element from
4176 ;; which the source code is coming, it expects from the code calling
4177 ;; it to know if lines should be numbered and if code references
4178 ;; should appear.
4179 ;;
4180 ;; Eventually, `org-export-format-code-default' is a higher-level
4181 ;; function (it makes use of the two previous functions) which handles
4182 ;; line numbering and code references inclusion, and returns source
4183 ;; code in a format suitable for plain text or verbatim output.
4186 "Return accumulated lines of code up to ELEMENT.
4188 INFO is the plist used as a communication channel.
4190 ELEMENT is excluded from count."
4196 ;; ELEMENT is reached: Quit the loop.
4198 ;; Only count lines from src-block and example-block elements
4199 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4203 ;; Accumulate locs or reset them.
4207 ;; Return nil to stay in the loop.
4208 nil)))
4210 ;; Return value.
4211 loc))
4214 "Clean source code and extract references out of it.
4216 ELEMENT has either a `src-block' an `example-block' type.
4218 Return a cons cell whose CAR is the source code, cleaned from any
4219 reference and protective comma and CDR is an alist between
4220 relative line number (integer) and name of code reference on that
4221 line (string)."
4223 ;; Get code and clean it. Remove blank lines at its
4224 ;; beginning and end.
4230 ;; Get format used for references.
4233 org-coderef-label-format)))
4234 ;; Build a regexp matching a loc with a reference.
4239 ;; Return value.
4241 ;; Code with references removed.
4247 ;; Ref line: remove ref, and signal its position in REFS.
4251 ;; Reference alist.
4252 refs)))
4255 "Format CODE by applying FUN line-wise and return it.
4257 CODE is a string representing the code to format. FUN is
4258 a function. It must accept three arguments: a line of
4259 code (string), the current line number (integer) or nil and the
4260 reference associated to the current line (string) or nil.
4262 Optional argument NUM-LINES can be an integer representing the
4263 number of code lines accumulated until the current code. Line
4264 numbers passed to FUN will take it into account. If it is nil,
4265 FUN's second argument will always be nil. This number can be
4266 obtained with `org-export-get-loc' function.
4268 Optional argument REF-ALIST can be an alist between relative line
4269 number (i.e. ignoring NUM-LINES) and the name of the code
4270 reference on it. If it is nil, FUN's third argument will always
4271 be nil. It can be obtained through the use of
4272 `org-export-unravel-code' function."
4284 "Return source code from ELEMENT, formatted in a standard way.
4286 ELEMENT is either a `src-block' or `example-block' element. INFO
4287 is a plist used as a communication channel.
4289 This function takes care of line numbering and code references
4290 inclusion. Line numbers, when applicable, appear at the
4291 beginning of the line, separated from the code by two white
4292 spaces. Code references, on the other hand, appear flushed to
4293 the right, separated by six white spaces from the widest line of
4294 code."
4295 ;; Extract code and references.
4302 ;; Handle line numbering.
4311 ;; Prepare references display, if required. Any reference
4312 ;; should start six columns after the widest line of code,
4313 ;; wrapped with parenthesis.
4318 code
4322 number-str
4323 loc
4329 num-start refs)))))
4332 ;;;; For Tables
4333 ;;
4334 ;; `org-export-table-has-special-column-p' and and
4335 ;; `org-export-table-row-is-special-p' are predicates used to look for
4336 ;; meta-information about the table structure.
4337 ;;
4338 ;; `org-table-has-header-p' tells when the rows before the first rule
4339 ;; should be considered as table's header.
4340 ;;
4341 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4342 ;; and `org-export-table-cell-borders' extract information from
4343 ;; a table-cell element.
4344 ;;
4345 ;; `org-export-table-dimensions' gives the number on rows and columns
4346 ;; in the table, ignoring horizontal rules and special columns.
4347 ;; `org-export-table-cell-address', given a table-cell object, returns
4348 ;; the absolute address of a cell. On the other hand,
4349 ;; `org-export-get-table-cell-at' does the contrary.
4350 ;;
4351 ;; `org-export-table-cell-starts-colgroup-p',
4352 ;; `org-export-table-cell-ends-colgroup-p',
4353 ;; `org-export-table-row-starts-rowgroup-p',
4354 ;; `org-export-table-row-ends-rowgroup-p',
4355 ;; `org-export-table-row-starts-header-p' and
4356 ;; `org-export-table-row-ends-header-p' indicate position of current
4357 ;; row or cell within the table.
4360 "Non-nil when TABLE has a special column.
4361 All special columns will be ignored during export."
4362 ;; The table has a special column when every first cell of every row
4363 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4364 ;; "*" "_" and "^". Though, do not consider a first row containing
4365 ;; only empty cells as special.
4381 "Non-nil when TABLE has a header.
4383 INFO is a plist used as a communication channel.
4385 A table has a header when it contains at least two row groups."
4394 table
4405 cache)))))
4408 "Non-nil if TABLE-ROW is considered special.
4410 INFO is a plist used as the communication channel.
4412 All special rows will be ignored during export."
4416 ;; A row is special either when...
4418 ;; ... it starts with a field only containing "/",
4420 ;; ... the table contains a special column and the row start
4421 ;; with a marking character among, "^", "_", "$" or "!",
4425 ;; ... it contains only alignment cookies and empty cells.
4431 ;; Since VALUE is a secondary string, the following
4432 ;; checks avoid expanding it with `org-export-data'.
4444 "Return TABLE-ROW's group number, as an integer.
4446 INFO is a plist used as the communication channel.
4448 Return value is the group number, as an integer, or nil for
4449 special rows and rows separators. First group is also table's
4450 header."
4468 "Return TABLE-CELL contents width.
4470 INFO is a plist used as the communication channel.
4472 Return value is the width given by the last width cookie in the
4473 same column as TABLE-CELL, or nil."
4492 ;; In a special row, try to find a width cookie at COLUMN.
4496 ;; The following checks avoid expanding unnecessarily
4497 ;; the cell with `org-export-data'.
4507 "Return TABLE-CELL contents alignment.
4509 INFO is a plist used as the communication channel.
4511 Return alignment as specified by the last alignment cookie in the
4512 same column as TABLE-CELL. If no such cookie is found, a default
4513 alignment value will be deduced from fraction of numbers in the
4514 column (see `org-table-number-fraction' for more information).
4515 Possible values are `left', `right' and `center'."
4516 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4533 cookie-align
4534 previous-cell-number-p)
4537 ;; In a special row, try to find an alignment cookie at
4538 ;; COLUMN.
4542 ;; Since VALUE is a secondary string, the following
4543 ;; checks avoid useless expansion through
4544 ;; `org-export-data'.
4552 ;; Ignore table rules.
4554 ;; In a standard row, check if cell's contents are
4555 ;; expressing some kind of number. Increase NUMBER-CELLS
4556 ;; accordingly. Though, don't bother if an alignment
4557 ;; cookie has already defined cell's alignment.
4562 info)))
4564 ;; Treat an empty cell as a number if it follows
4565 ;; a number.
4571 ;; Return value. Alignment specified by cookies has
4572 ;; precedence over alignment deduced from cell's contents.
4574 column
4579 org-table-number-fraction)
4584 "Return TABLE-CELL borders.
4586 INFO is a plist used as a communication channel.
4588 Return value is a list of symbols, or nil. Possible values are:
4589 `top', `bottom', `above', `below', `left' and `right'. Note:
4590 `top' (resp. `bottom') only happen for a cell in the first
4591 row (resp. last row) of the table, ignoring table rules, if any.
4593 Returned borders ignore special rows."
4596 borders)
4597 ;; Top/above border? TABLE-CELL has a border above when a rule
4598 ;; used to demarcate row groups can be found above. Hence,
4599 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4600 ;; another regular row has to be found above that rule.
4609 ;; Look at every row before the current one.
4611 ;; No rule above, or rule found starts the table (ignoring any
4612 ;; special row): TABLE-CELL is at the top of the table.
4615 ;; Bottom/below border? TABLE-CELL has a border below when next
4616 ;; non-regular row below is a rule.
4625 ;; Look at every row after the current one.
4627 ;; No rule below, or rule found ends the table (modulo some
4628 ;; special row): TABLE-CELL is at the bottom of the table.
4631 ;; Right/left borders? They can only be specified by column
4632 ;; groups. Column groups are defined in a row starting with "/".
4633 ;; Also a column groups row only contains "<", "<>", ">" or blank
4634 ;; cells.
4651 ;; There's a left border when previous cell, if
4652 ;; any, ends a group, or current one starts one.
4658 ;; There's a right border when next cell, if any,
4659 ;; starts a group, or current one ends one.
4666 ;; Table rows are read in reverse order so last column groups
4667 ;; row has precedence over any previous one.
4669 ;; Return value.
4670 borders))
4673 "Non-nil when TABLE-CELL is at the beginning of a row group.
4674 INFO is a plist used as a communication channel."
4675 ;; A cell starts a column group either when it is at the beginning
4676 ;; of a row (or after the special column, if any) or when it has
4677 ;; a left border.
4680 table-cell)
4684 "Non-nil when TABLE-CELL is at the end of a row group.
4685 INFO is a plist used as a communication channel."
4686 ;; A cell ends a column group either when it is at the end of a row
4687 ;; or when it has a right border.
4690 table-cell)
4694 "Non-nil when TABLE-ROW is at the beginning of a column group.
4695 INFO is a plist used as a communication channel."
4703 "Non-nil when TABLE-ROW is at the end of a column group.
4704 INFO is a plist used as a communication channel."
4712 "Non-nil when TABLE-ROW is the first table header's row.
4713 INFO is a plist used as a communication channel."
4720 "Non-nil when TABLE-ROW is the last table header's row.
4721 INFO is a plist used as a communication channel."
4728 "Return TABLE-ROW number.
4729 INFO is a plist used as a communication channel. Return value is
4730 zero-based and ignores separators. The function returns nil for
4731 special columns and separators."
4743 "Return TABLE dimensions.
4745 INFO is a plist used as a communication channel.
4747 Return value is a CONS like (ROWS . COLUMNS) where
4748 ROWS (resp. COLUMNS) is the number of exportable
4749 rows (resp. columns)."
4751 ;; Set number of rows, and extract first one.
4757 ;; Set number of columns.
4759 ;; Return value.
4763 "Return address of a regular TABLE-CELL object.
4765 TABLE-CELL is the cell considered. INFO is a plist used as
4766 a communication channel.
4768 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4769 zero-based index. Only exportable cells are considered. The
4770 function returns nil for other cells."
4782 "Return regular table-cell object at ADDRESS in TABLE.
4784 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4785 zero-based index. TABLE is a table type element. INFO is
4786 a plist used as a communication channel.
4788 If no table-cell, among exportable cells, is found at ADDRESS,
4789 return nil."
4792 ;; Row at (car address) or nil.
4800 'table-cell
4807 ;;;; For Tables Of Contents
4808 ;;
4809 ;; `org-export-collect-headlines' builds a list of all exportable
4810 ;; headline elements, maybe limited to a certain depth. One can then
4811 ;; easily parse it and transcode it.
4812 ;;
4813 ;; Building lists of tables, figures or listings is quite similar.
4814 ;; Once the generic function `org-export-collect-elements' is defined,
4815 ;; `org-export-collect-tables', `org-export-collect-figures' and
4816 ;; `org-export-collect-listings' can be derived from it.
4819 "Collect headlines in order to build a table of contents.
4821 INFO is a plist used as a communication channel.
4823 When optional argument N is an integer, it specifies the depth of
4824 the table of contents. Otherwise, it is set to the value of the
4825 last headline level. See `org-export-headline-levels' for more
4826 information.
4828 Return a list of all exportable headlines as parsed elements.
4829 Footnote sections, if any, will be ignored."
4837 info)))
4840 "Collect referenceable elements of a determined type.
4842 TYPE can be a symbol or a list of symbols specifying element
4843 types to search. Only elements with a caption are collected.
4845 INFO is a plist used as a communication channel.
4847 When non-nil, optional argument PREDICATE is a function accepting
4848 one argument, an element of type TYPE. It returns a non-nil
4849 value when that element should be collected.
4851 Return a list of all elements found, in order of appearance."
4856 element))
4857 info))
4860 "Build a list of tables.
4861 INFO is a plist used as a communication channel.
4863 Return a list of table elements with a caption."
4867 "Build a list of figures.
4869 INFO is a plist used as a communication channel. PREDICATE is
4870 a function which accepts one argument: a paragraph element and
4871 whose return value is non-nil when that element should be
4872 collected.
4874 A figure is a paragraph type element, with a caption, verifying
4876 a vague concept that may depend on back-end.
4878 Return a list of elements recognized as figures."
4882 "Build a list of src blocks.
4884 INFO is a plist used as a communication channel.
4886 Return a list of src-block elements with a caption."
4890 ;;;; Smart Quotes
4891 ;;
4892 ;; The main function for the smart quotes sub-system is
4893 ;; `org-export-activate-smart-quotes', which replaces every quote in
4894 ;; a given string from the parse tree with its "smart" counterpart.
4895 ;;
4896 ;; Dictionary for smart quotes is stored in
4897 ;; `org-export-smart-quotes-alist'.
4898 ;;
4899 ;; Internally, regexps matching potential smart quotes (checks at
4900 ;; string boundaries are also necessary) are defined in
4901 ;; `org-export-smart-quotes-regexps'.
4905 ;; one may use: »...«, "...", ›...‹, or '...'.
4906 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4907 ;; LaTeX quotes require Babel!
4952 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4961 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4970 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4979 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4985 )
4986 "Smart quotes translations.
4988 Alist whose CAR is a language string and CDR is an alist with
4989 quote type as key and a plist associating various encodings to
4990 their translation as value.
4992 A quote type can be any symbol among `opening-double-quote',
4993 `closing-double-quote', `opening-single-quote',
4994 `closing-single-quote' and `apostrophe'.
4996 Valid encodings include `:utf-8', `:html', `:latex' and
4997 `:texinfo'.
5003 ;; Possible opening quote at beginning of string.
5005 ;; Possible closing quote at beginning of string.
5007 ;; Possible apostrophe at beginning of string.
5009 ;; Opening single and double quotes.
5011 ;; Closing single and double quotes.
5013 ;; Apostrophe.
5015 ;; Possible opening quote at end of string.
5017 ;; Possible closing quote at end of string.
5019 ;; Possible apostrophe at end of string.
5021 "List of regexps matching a quote or an apostrophe.
5027 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5028 `:utf-8'. INFO is a plist used as a communication channel.
5030 The function has to retrieve information about string
5031 surroundings in parse tree. It can only happen with an
5032 unmodified string. Thus, if S has already been through another
5033 process, a non-nil ORIGINAL optional argument will provide that
5034 original string.
5036 Return the new string."
5039 ;; Try to be flexible when computing number of blanks
5040 ;; before object. The previous object may be a string
5041 ;; introduced by the back-end and not completely parsed.
5044 ;; A string with missing `:post-blank'
5045 ;; property.
5049 ;; Fallback value.
5054 ;; Return smart quote associated to a give quote Q, as
5055 ;; a string. TYPE is a symbol among `open', `close' and
5056 ;; `apostrophe'.
5066 org-export-smart-quotes-alist))))
5067 encoding)
5068 q)))))
5070 ;; Only a quote: no regexp can match. We have to check both
5071 ;; sides and decide what to do.
5079 ;; 1. Replace quote character at the beginning of S.
5081 ;; Apostrophe?
5087 ;; Closing quote?
5093 ;; Opening quote?
5099 ;; 2. Replace quotes in the middle of the string.
5101 ;; Opening quotes.
5107 ;; Closing quotes.
5113 ;; Apostrophes.
5118 ;; 3. Replace quote character at the end of S.
5120 ;; Apostrophe?
5125 ;; Closing quote?
5131 ;; Opening quote?
5136 ;; Return string with smart quotes.
5137 s))))
5139 ;;;; Topology
5140 ;;
5141 ;; Here are various functions to retrieve information about the
5142 ;; neighborhood of a given element or object. Neighbors of interest
5143 ;; are direct parent (`org-export-get-parent'), parent headline
5144 ;; (`org-export-get-parent-headline'), first element containing an
5145 ;; object, (`org-export-get-parent-element'), parent table
5146 ;; (`org-export-get-parent-table'), previous element or object
5147 ;; (`org-export-get-previous-element') and next element or object
5148 ;; (`org-export-get-next-element').
5149 ;;
5150 ;; `org-export-get-genealogy' returns the full genealogy of a given
5151 ;; element or object, from closest parent to full parse tree.
5153 ;; defsubst org-export-get-parent must be defined before first use
5155 "Return full genealogy relative to a given element or object.
5157 BLOB is the element or object being considered.
5159 Ancestors are returned from closest to farthest, the last one
5160 being the full parse tree."
5167 "Return BLOB parent headline or nil.
5168 BLOB is the element or object being considered."
5172 parent))
5175 "Return first element containing OBJECT or nil.
5176 OBJECT is the object to consider."
5180 parent))
5183 "Return OBJECT parent table or nil.
5184 OBJECT is either a `table-cell' or `table-element' type object."
5188 parent))
5191 "Return previous element or object.
5193 BLOB is an element or object. INFO is a plist used as
5194 a communication channel. Return previous exportable element or
5195 object, a string, or nil.
5197 When optional argument N is a positive integer, return a list
5198 containing up to N siblings before BLOB, from farthest to
5199 closest. With any other non-nil value, return a list containing
5200 all of them."
5202 ;; An object can belong to the contents of its parent or
5203 ;; to a secondary string. We check the latter option
5204 ;; first.
5208 org-element-secondary-value-alist))
5209 parent)))
5212 prev)
5221 prev)))
5224 "Return next element or object.
5226 BLOB is an element or object. INFO is a plist used as
5227 a communication channel. Return next exportable element or
5228 object, a string, or nil.
5230 When optional argument N is a positive integer, return a list
5231 containing up to N siblings after BLOB, from closest to farthest.
5232 With any other non-nil value, return a list containing all of
5233 them."
5235 ;; An object can belong to the contents of its parent or to
5236 ;; a secondary string. We check the latter option first.
5240 org-element-secondary-value-alist))
5241 parent)))
5244 next)
5252 siblings)
5256 ;;;; Translation
5257 ;;
5258 ;; `org-export-translate' translates a string according to the language
5259 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5260 ;; the dictionary used for the translation.
5444 "Dictionary for export engine.
5446 Alist whose CAR is the string to translate and CDR is an alist
5447 whose CAR is the language string and CDR is a plist whose
5448 properties are possible charsets and values translated terms.
5450 It is used as a database for `org-export-translate'. Since this
5451 function returns the string as-is if no translation was found,
5452 the variable only needs to record values different from the
5456 "Translate string S according to language specification.
5458 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5459 and `:utf-8'. INFO is a plist used as a communication channel.
5461 Translation depends on `:language' property. Return the
5462 translated string. If no translation is found, try to fall back
5463 to `:default' encoding. If it fails, return S."
5469 s)))
5472 \f
5473 ;;; Asynchronous Export
5474 ;;
5475 ;; `org-export-async-start' is the entry point for asynchronous
5476 ;; export. It recreates current buffer (including visibility,
5477 ;; narrowing and visited file) in an external Emacs process, and
5478 ;; evaluates a command there. It then applies a function on the
5479 ;; returned results in the current process.
5480 ;;
5481 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5482 ;; allow to export to a buffer or a file, asynchronously or not.
5483 ;;
5484 ;; `org-export-output-file-name' is an auxiliary function meant to be
5485 ;; used with `org-export-to-file'. With a given extension, it tries
5486 ;; to provide a canonical file name to write export output to.
5487 ;;
5488 ;; Asynchronously generated results are never displayed directly.
5489 ;; Instead, they are stored in `org-export-stack-contents'. They can
5490 ;; then be retrieved by calling `org-export-stack'.
5491 ;;
5492 ;; Export Stack is viewed through a dedicated major mode
5493 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5494 ;;`org-export-stack-delete', `org-export-stack-view' and
5495 ;;`org-export-stack-clear'.
5496 ;;
5497 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5498 ;; It should be used whenever `org-export-async-start' is called.
5501 "Call function FUN on the results returned by BODY evaluation.
5503 BODY evaluation happens in an asynchronous process, from a buffer
5504 which is an exact copy of the current one.
5506 Use `org-export-add-to-stack' in FUN in order to register results
5507 in the stack.
5509 This is a low level function. See also `org-export-to-buffer'
5510 and `org-export-to-file' for more specialized functions."
5513 ;; Write the full sexp evaluating BODY in a copy of the current
5514 ;; buffer to a temporary file, as it may be too long for program
5515 ;; args in `start-process'.
5522 ;; Null characters (from variable values) are inserted
5523 ;; within the file. As a consequence, coding system for
5524 ;; buffer contents will not be recognized properly. So,
5525 ;; we make sure it is the same as the one used to display
5526 ;; the original buffer.
5528 ,coding
5531 ;; Ignore `kill-emacs-hook' and code evaluation
5532 ;; queries from Babel as we need a truly
5533 ;; non-interactive process.
5535 org-babel-confirm-evaluate-answer-no t)
5536 ;; Initialize export framework.
5538 ;; Re-create current buffer there.
5541 ;; Sexp to evaluate in the buffer.
5543 ;; Start external process.
5546 (,process
5551 "-l" org-export-async-init-file
5553 ;; Register running process in stack.
5555 ;; Set-up sentinel in order to catch results.
5558 ,process
5580 ;;;###autoload
5583 &optional async subtreep visible-only body-only ext-plist
5584 post-process)
5585 "Call `org-export-as' with output to a specified buffer.
5587 BACKEND is either an export back-end, as returned by, e.g.,
5588 `org-export-create-backend', or a symbol referring to
5589 a registered back-end.
5591 BUFFER is the name of the output buffer. If it already exists,
5592 it will be erased first, otherwise, it will be created.
5594 A non-nil optional argument ASYNC means the process should happen
5595 asynchronously. The resulting buffer should then be accessible
5596 through the `org-export-stack' interface. When ASYNC is nil, the
5597 buffer is displayed if `org-export-show-temporary-export-buffer'
5598 is non-nil.
5600 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5601 EXT-PLIST are similar to those used in `org-export-as', which
5602 see.
5604 Optional argument POST-PROCESS is a function which should accept
5605 no argument. It is always called within the current process,
5606 from BUFFER, with point at its beginning. Export back-ends can
5607 use it to set a major mode there, e.g,
5609 \(defun org-latex-export-as-latex
5610 \(&optional async subtreep visible-only body-only ext-plist)
5611 \(interactive)
5613 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5615 This function returns BUFFER."
5643 buffer)))
5645 ;;;###autoload
5648 post-process)
5649 "Call `org-export-as' with output to a specified file.
5651 BACKEND is either an export back-end, as returned by, e.g.,
5652 `org-export-create-backend', or a symbol referring to
5653 a registered back-end. FILE is the name of the output file, as
5654 a string.
5656 A non-nil optional argument ASYNC means the process should happen
5657 asynchronously. The resulting buffer will then be accessible
5658 through the `org-export-stack' interface.
5660 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5661 EXT-PLIST are similar to those used in `org-export-as', which
5662 see.
5664 Optional argument POST-PROCESS is called with FILE as its
5665 argument and happens asynchronously when ASYNC is non-nil. It
5666 has to return a file name, or nil. Export back-ends can use this
5667 to send the output file through additional processing, e.g,
5669 \(defun org-latex-export-to-latex
5670 \(&optional async subtreep visible-only body-only ext-plist)
5671 \(interactive)
5673 \(org-export-to-file 'latex outfile
5674 async subtreep visible-only body-only ext-plist
5675 \(lambda (file) (org-latex-compile file)))
5677 The function returns either a file name returned by POST-PROCESS,
5678 or FILE."
5697 backend subtreep visible-only body-only ext-plist)))
5704 ;; Get proper return value.
5706 file))))))
5709 "Return output file's name according to buffer specifications.
5711 EXTENSION is a string representing the output file extension,
5712 with the leading dot.
5714 With a non-nil optional argument SUBTREEP, try to determine
5716 of subtree at point.
5718 When optional argument PUB-DIR is set, use it as the publishing
5719 directory.
5721 When optional argument VISIBLE-ONLY is non-nil, don't export
5722 contents of hidden elements.
5724 Return file name as a string."
5727 ;; File name may come from EXPORT_FILE_NAME subtree
5728 ;; property, assuming point is at beginning of said
5729 ;; sub-tree.
5736 ;; File name may be extracted from buffer's associated
5737 ;; file, if any.
5739 ;; Can't determine file name on our own: Ask user.
5743 "Output file: " pub-dir nil nil nil
5747 ;; Build file name. Enforce EXTENSION over whatever user
5748 ;; may have come up with. PUB-DIR, if defined, always has
5749 ;; precedence over any provided path.
5754 extension))
5757 ;; If writing to OUTPUT-FILE would overwrite original file, append
5758 ;; EXTENSION another time to final name.
5761 output-file)))
5764 "Add a new result to export stack if not present already.
5766 SOURCE is a buffer or a file name containing export results.
5767 BACKEND is a symbol representing export back-end used to generate
5768 it.
5770 Entries already pointing to SOURCE and unavailable entries are
5771 removed beforehand. Return the new stack."
5777 "Menu for asynchronous export results and running processes."
5787 "Return source from export results at point in stack."
5794 source
5795 ;; SOURCE is not consistent with current line. The stack
5796 ;; view is outdated.
5800 "Remove all entries from export stack."
5805 "Refresh the asynchronous export stack.
5806 DUMMY is ignored. Unavailable sources are removed from the list.
5807 Return the new stack."
5817 ;; Back-end.
5819 ;; Age.
5822 ;; Compute age of the results.
5824 "%4h:%.2m "
5826 ;; Source.
5831 ;; Clear stack from exited processes, dead buffers or
5832 ;; non-existent files.
5844 "Remove export results at point from stack.
5845 If optional argument SOURCE is non-nil, remove it instead."
5850 org-export-stack-contents))))
5853 "View export results at point in stack.
5854 With an optional prefix argument IN-EMACS, force viewing files
5855 within Emacs."
5869 (define-key km "p" 'previous-line)
5870 (define-key km "\C-p" 'previous-line)
5871 (define-key km "\C-?" 'previous-line)
5872 (define-key km [up] 'previous-line)
5873 (define-key km "C" 'org-export-stack-clear)
5874 (define-key km "v" 'org-export-stack-view)
5875 (define-key km (kbd "RET") 'org-export-stack-view)
5876 (define-key km "d" 'org-export-stack-remove)
5877 km)
5878 "Keymap for Org Export Stack.")
5880 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5881 "Mode for displaying asynchronous export stack.
5884 stack.
5886 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5887 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5888 stack completely.
5890 Removing entries in an Org Export Stack buffer doesn't affect
5891 files or buffers, only the display.
5894 (abbrev-mode 0)
5895 (auto-fill-mode 0)
5896 (setq buffer-read-only t
5897 buffer-undo-list t
5898 truncate-lines t
5899 header-line-format
5900 '(:eval
5901 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5902 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5903 (set (make-local-variable 'revert-buffer-function)
5904 'org-export-stack-refresh))
5907 \f
5908 ;;; The Dispatcher
5909 ;;
5910 ;; `org-export-dispatch' is the standard interactive way to start an
5911 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5912 ;; for its interface, which, in turn, delegates response to key
5913 ;; pressed to `org-export--dispatch-action'.
5915 ;;;###autoload
5916 (defun org-export-dispatch (&optional arg)
5917 "Export dispatcher for Org mode.
5919 It provides an access to common export related tasks in a buffer.
5920 Its interface comes in two flavors: standard and expert.
5922 While both share the same set of bindings, only the former
5923 displays the valid keys associations in a dedicated buffer.
5924 Scrolling (resp. line-wise motion) in this buffer is done with
5925 SPC and DEL (resp. C-n and C-p) keys.
5927 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5928 flavor or the other.
5931 of options used back then, on the current buffer.
5933 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5934 (interactive "P")
5935 (let* ((input
5936 (cond ((equal arg '(16)) '(stack))
5937 ((and arg org-export-dispatch-last-action))
5938 (t (save-window-excursion
5939 (unwind-protect
5940 (progn
5941 ;; Remember where we are
5942 (move-marker org-export-dispatch-last-position
5943 (point)
5944 (org-base-buffer (current-buffer)))
5945 ;; Get and store an export command
5946 (setq org-export-dispatch-last-action
5947 (org-export--dispatch-ui
5948 (list org-export-initial-scope
5949 (and org-export-in-background 'async))
5950 nil
5951 org-export-dispatch-use-expert-ui)))
5952 (and (get-buffer "*Org Export Dispatcher*")
5953 (kill-buffer "*Org Export Dispatcher*")))))))
5954 (action (car input))
5955 (optns (cdr input)))
5956 (unless (memq 'subtree optns)
5957 (move-marker org-export-dispatch-last-position nil))
5958 (case action
5959 ;; First handle special hard-coded actions.
5960 (template (org-export-insert-default-template nil optns))
5961 (stack (org-export-stack))
5962 (publish-current-file
5963 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5964 (publish-current-project
5965 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5966 (publish-choose-project
5967 (org-publish (assoc (org-icompleting-read
5968 "Publish project: "
5969 org-publish-project-alist nil t)
5970 org-publish-project-alist)
5971 (memq 'force optns)
5972 (memq 'async optns)))
5973 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5974 (otherwise
5975 (save-excursion
5976 (when arg
5977 ;; Repeating command, maybe move cursor to restore subtree
5978 ;; context.
5979 (if (eq (marker-buffer org-export-dispatch-last-position)
5980 (org-base-buffer (current-buffer)))
5981 (goto-char org-export-dispatch-last-position)
5982 ;; We are in a different buffer, forget position.
5983 (move-marker org-export-dispatch-last-position nil)))
5984 (funcall action
5985 ;; Return a symbol instead of a list to ease
5986 ;; asynchronous export macro use.
5987 (and (memq 'async optns) t)
5988 (and (memq 'subtree optns) t)
5989 (and (memq 'visible optns) t)
5990 (and (memq 'body optns) t)))))))
5992 (defun org-export--dispatch-ui (options first-key expertp)
5993 "Handle interface for `org-export-dispatch'.
5995 OPTIONS is a list containing current interactive options set for
5996 export. It can contain any of the following symbols:
5997 `body' toggles a body-only export
5998 `subtree' restricts export to current subtree
5999 `visible' restricts export to visible part of buffer.
6000 `force' force publishing files.
6001 `async' use asynchronous export process
6003 FIRST-KEY is the key pressed to select the first level menu. It
6004 is nil when this menu hasn't been selected yet.
6006 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6007 buffer is provided, but indications about currently active
6008 options are given in the prompt. Moreover, \[?] allows to switch
6009 back to standard interface."
6010 (let* ((fontify-key
6011 (lambda (key &optional access-key)
6012 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6013 ;; non-nil is the required first-level key to activate
6014 ;; KEY. When its value is t, activate KEY independently
6015 ;; on the first key, if any. A nil value means KEY will
6016 ;; only be activated at first level.
6017 (if (or (eq access-key t) (eq access-key first-key))
6018 (org-propertize key 'face 'org-warning)
6019 key)))
6020 (fontify-value
6021 (lambda (value)
6022 ;; Fontify VALUE string.
6023 (org-propertize value 'face 'font-lock-variable-name-face)))
6024 ;; Prepare menu entries by extracting them from registered
6025 ;; back-ends and sorting them by access key and by ordinal,
6026 ;; if any.
6027 (entries
6028 (sort (sort (delq nil
6029 (mapcar 'org-export-backend-menu
6030 org-export--registered-backends))
6031 (lambda (a b)
6032 (let ((key-a (nth 1 a))
6033 (key-b (nth 1 b)))
6034 (cond ((and (numberp key-a) (numberp key-b))
6035 (< key-a key-b))
6036 ((numberp key-b) t)))))
6037 'car-less-than-car))
6038 ;; Compute a list of allowed keys based on the first key
6039 ;; pressed, if any. Some keys
6040 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6041 ;; available.
6042 (allowed-keys
6043 (nconc (list 2 22 19 6 1)
6044 (if (not first-key) (org-uniquify (mapcar 'car entries))
6045 (let (sub-menu)
6046 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6047 (when (eq (car entry) first-key)
6048 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6049 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6050 ((not first-key) (list ?P)))
6051 (list ?& ?#)
6052 (when expertp (list ??))
6053 (list ?q)))
6054 ;; Build the help menu for standard UI.
6055 (help
6056 (unless expertp
6057 (concat
6058 ;; Options are hard-coded.
6059 (format "[%s] Body only: %s [%s] Visible only: %s
6060 \[%s] Export scope: %s [%s] Force publishing: %s
6062 (funcall fontify-key "C-b" t)
6063 (funcall fontify-value
6064 (if (memq 'body options) "On " "Off"))
6065 (funcall fontify-key "C-v" t)
6066 (funcall fontify-value
6067 (if (memq 'visible options) "On " "Off"))
6068 (funcall fontify-key "C-s" t)
6069 (funcall fontify-value
6070 (if (memq 'subtree options) "Subtree" "Buffer "))
6071 (funcall fontify-key "C-f" t)
6072 (funcall fontify-value
6073 (if (memq 'force options) "On " "Off"))
6074 (funcall fontify-key "C-a" t)
6075 (funcall fontify-value
6076 (if (memq 'async options) "On " "Off")))
6077 ;; Display registered back-end entries. When a key
6078 ;; appears for the second time, do not create another
6079 ;; entry, but append its sub-menu to existing menu.
6080 (let (last-key)
6081 (mapconcat
6082 (lambda (entry)
6083 (let ((top-key (car entry)))
6084 (concat
6085 (unless (eq top-key last-key)
6086 (setq last-key top-key)
6088 (funcall fontify-key (char-to-string top-key))
6089 (nth 1 entry)))
6090 (let ((sub-menu (nth 2 entry)))
6091 (unless (functionp sub-menu)
6092 ;; Split sub-menu into two columns.
6093 (let ((index -1))
6094 (concat
6095 (mapconcat
6096 (lambda (sub-entry)
6097 (incf index)
6098 (format
6099 (if (zerop (mod index 2)) " [%s] %-26s"
6101 (funcall fontify-key
6102 (char-to-string (car sub-entry))
6103 top-key)
6104 (nth 1 sub-entry)))
6105 sub-menu "")
6107 entries ""))
6108 ;; Publishing menu is hard-coded.
6110 [%s] Current file [%s] Current project
6112 (funcall fontify-key "P")
6113 (funcall fontify-key "f" ?P)
6114 (funcall fontify-key "p" ?P)
6115 (funcall fontify-key "x" ?P)
6116 (funcall fontify-key "a" ?P))
6118 (funcall fontify-key "&" t)
6119 (funcall fontify-key "#" t))
6120 (format "[%s] %s"
6121 (funcall fontify-key "q" t)
6122 (if first-key "Main menu" "Exit")))))
6123 ;; Build prompts for both standard and expert UI.
6124 (standard-prompt (unless expertp "Export command: "))
6125 (expert-prompt
6126 (when expertp
6127 (format
6128 "Export command (C-%s%s%s%s%s) [%s]: "
6129 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6130 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6131 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6132 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6133 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6134 (mapconcat (lambda (k)
6135 ;; Strip control characters.
6136 (unless (< k 27) (char-to-string k)))
6137 allowed-keys "")))))
6138 ;; With expert UI, just read key with a fancy prompt. In standard
6139 ;; UI, display an intrusive help buffer.
6140 (if expertp
6141 (org-export--dispatch-action
6142 expert-prompt allowed-keys entries options first-key expertp)
6143 ;; At first call, create frame layout in order to display menu.
6144 (unless (get-buffer "*Org Export Dispatcher*")
6145 (delete-other-windows)
6146 (org-switch-to-buffer-other-window
6147 (get-buffer-create "*Org Export Dispatcher*"))
6148 (setq cursor-type nil
6149 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6150 ;; Make sure that invisible cursor will not highlight square
6151 ;; brackets.
6152 (set-syntax-table (copy-syntax-table))
6153 (modify-syntax-entry ?\[ "w"))
6154 ;; At this point, the buffer containing the menu exists and is
6155 ;; visible in the current window. So, refresh it.
6156 (with-current-buffer "*Org Export Dispatcher*"
6157 ;; Refresh help. Maintain display continuity by re-visiting
6158 ;; previous window position.
6159 (let ((pos (window-start)))
6160 (erase-buffer)
6161 (insert help)
6162 (set-window-start nil pos)))
6163 (org-fit-window-to-buffer)
6164 (org-export--dispatch-action
6165 standard-prompt allowed-keys entries options first-key expertp))))
6167 (defun org-export--dispatch-action
6168 (prompt allowed-keys entries options first-key expertp)
6169 "Read a character from command input and act accordingly.
6171 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6172 a list of characters available at a given step in the process.
6173 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6174 EXPERTP are the same as defined in `org-export--dispatch-ui',
6175 which see.
6177 Toggle export options when required. Otherwise, return value is
6178 a list with action as CAR and a list of interactive export
6179 options as CDR."
6180 (let (key)
6181 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6182 ;; C-p, SPC, DEL).
6183 (while (and (setq key (read-char-exclusive prompt))
6184 (not expertp)
6185 (memq key '(14 16 ?\s ?\d)))
6186 (case key
6187 (14 (if (not (pos-visible-in-window-p (point-max)))
6188 (ignore-errors (scroll-up 1))
6189 (message "End of buffer")
6190 (sit-for 1)))
6191 (16 (if (not (pos-visible-in-window-p (point-min)))
6192 (ignore-errors (scroll-down 1))
6193 (message "Beginning of buffer")
6194 (sit-for 1)))
6195 (?\s (if (not (pos-visible-in-window-p (point-max)))
6196 (scroll-up nil)
6197 (message "End of buffer")
6198 (sit-for 1)))
6199 (?\d (if (not (pos-visible-in-window-p (point-min)))
6200 (scroll-down nil)
6201 (message "Beginning of buffer")
6202 (sit-for 1)))))
6203 (cond
6204 ;; Ignore undefined associations.
6205 ((not (memq key allowed-keys))
6206 (ding)
6207 (unless expertp (message "Invalid key") (sit-for 1))
6208 (org-export--dispatch-ui options first-key expertp))
6209 ;; q key at first level aborts export. At second level, cancel
6210 ;; first key instead.
6211 ((eq key ?q) (if (not first-key) (error "Export aborted")
6212 (org-export--dispatch-ui options nil expertp)))
6213 ;; Help key: Switch back to standard interface if expert UI was
6214 ;; active.
6215 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6216 ;; Send request for template insertion along with export scope.
6217 ((eq key ?#) (cons 'template (memq 'subtree options)))
6218 ;; Switch to asynchronous export stack.
6219 ((eq key ?&) '(stack))
6220 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6221 ((memq key '(2 22 19 6 1))
6222 (org-export--dispatch-ui
6223 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6224 (6 'force) (1 'async))))
6225 (if (memq option options) (remq option options)
6226 (cons option options)))
6227 first-key expertp))
6228 ;; Action selected: Send key and options back to
6229 ;; `org-export-dispatch'.
6230 ((or first-key (functionp (nth 2 (assq key entries))))
6231 (cons (cond
6232 ((not first-key) (nth 2 (assq key entries)))
6233 ;; Publishing actions are hard-coded. Send a special
6234 ;; signal to `org-export-dispatch'.
6235 ((eq first-key ?P)
6236 (case key
6237 (?f 'publish-current-file)
6238 (?p 'publish-current-project)
6239 (?x 'publish-choose-project)
6240 (?a 'publish-all)))
6241 ;; Return first action associated to FIRST-KEY + KEY
6242 ;; path. Indeed, derived backends can share the same
6243 ;; FIRST-KEY.
6244 (t (catch 'found
6245 (mapc (lambda (entry)
6246 (let ((match (assq key (nth 2 entry))))
6247 (when match (throw 'found (nth 2 match)))))
6248 (member (assq first-key entries) entries)))))
6249 options))
6250 ;; Otherwise, enter sub-menu.
6251 (t (org-export--dispatch-ui options key expertp)))))
6255 (provide 'ox)
6257 ;; Local variables:
6258 ;; generated-autoload-file: "org-loaddefs.el"
6259 ;; End:
6261 ;;; ox.el ends here