| blob | 9b778745f07dec4f1add3d555e97c21d2bf27874 |
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 "Should we push exported content to the kill ring?"
807 "The initial scope when exporting with `org-export-dispatch'.
808 This variable can be either set to `buffer' or `subtree'."
815 "Non-nil means show buffer after exporting to temp buffer.
816 When Org exports to a file, the buffer visiting that file is ever
817 shown, but remains buried. However, when exporting to
818 a temporary buffer, that buffer is popped up in a second window.
819 When this variable is nil, the buffer remains buried also in
820 these cases."
825 "Non-nil means export and publishing commands will run in background.
826 Results from an asynchronous export are never displayed
834 "File used to initialize external export process.
835 Value must be an absolute file name. It defaults to user's
836 initialization file. Though, a specific configuration makes the
837 process faster and the export more portable."
844 "Non-nil means using a non-intrusive `org-export-dispatch'.
845 In that case, no help buffer is displayed. Though, an indicator
851 asynchronous). Also, \[?] allows to switch back to standard
852 mode."
859 \f
860 ;;; Defining Back-ends
861 ;;
862 ;; An export back-end is a structure with `org-export-backend' type
863 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
864 ;; and `menu' slots.
865 ;;
866 ;; At the lowest level, a back-end is created with
867 ;; `org-export-create-backend' function.
868 ;;
869 ;; A named back-end can be registered with
870 ;; `org-export-register-backend' function. A registered back-end can
871 ;; later be referred to by its name, with `org-export-get-backend'
872 ;; function. Also, such a back-end can become the parent of a derived
873 ;; back-end from which slot values will be inherited by default.
874 ;; `org-export-derived-backend-p' can check if a given back-end is
875 ;; derived from a list of back-end names.
876 ;;
877 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
878 ;; `org-export-get-all-filters' return the full alist of transcoders,
879 ;; options and filters, including those inherited from ancestors.
880 ;;
881 ;; At a higher level, `org-export-define-backend' is the standard way
882 ;; to define an export back-end. If the new back-end is similar to
883 ;; a registered back-end, `org-export-define-derived-backend' may be
884 ;; used instead.
885 ;;
886 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
887 ;; when a given back-end hasn't been registered yet.
891 name parent transcoders options filters blocks menu)
894 "Return export back-end named after NAME.
895 NAME is a symbol. Return nil if no such back-end is found."
902 "Register BACKEND as a known export back-end.
903 BACKEND is a structure with `org-export-backend' type."
904 ;; Refuse to register an unnamed back-end.
907 ;; Refuse to register a back-end with an unknown parent.
911 ;; Register dedicated export blocks in the parser.
915 ;; If a back-end with the same name as BACKEND is already
916 ;; registered, replace it with BACKEND. Otherwise, simply add
917 ;; BACKEND to the list of registered back-ends.
923 "Signal an error if BACKEND isn't defined."
928 "Non-nil if BACKEND is derived from one of BACKENDS.
929 BACKEND is an export back-end, as returned by, e.g.,
930 `org-export-create-backend', or a symbol referring to
931 a registered back-end. BACKENDS is constituted of symbols."
943 "Return full translation table for BACKEND.
945 BACKEND is an export back-end, as return by, e.g,,
946 `org-export-create-backend'. Return value is an alist where
947 keys are element or object types, as symbols, and values are
948 transcoders.
950 Unlike to `org-export-backend-transcoders', this function
951 also returns transcoders inherited from parent back-ends,
952 if any."
956 parent)
961 transcoders)))
964 "Return export options for BACKEND.
966 BACKEND is an export back-end, as return by, e.g,,
967 `org-export-create-backend'. See `org-export-options-alist'
968 for the shape of the return value.
970 Unlike to `org-export-backend-options', this function also
971 returns options inherited from parent back-ends, if any."
975 parent)
979 options)))
982 "Return complete list of filters for BACKEND.
984 BACKEND is an export back-end, as return by, e.g,,
985 `org-export-create-backend'. Return value is an alist where
986 keys are symbols and values lists of functions.
988 Unlike to `org-export-backend-filters', this function also
989 returns filters inherited from parent back-ends, if any."
993 parent)
997 filters)))
1000 "Define a new back-end BACKEND.
1002 TRANSCODERS is an alist between object or element types and
1003 functions handling them.
1005 These functions should return a string without any trailing
1006 space, or nil. They must accept three arguments: the object or
1007 element itself, its contents or nil when it isn't recursive and
1008 the property list used as a communication channel.
1010 Contents, when not nil, are stripped from any global indentation
1011 \(although the relative one is preserved). They also always end
1012 with a single newline character.
1014 If, for a given type, no function is found, that element or
1015 object type will simply be ignored, along with any blank line or
1016 white space at its end. The same will happen if the function
1017 returns the nil value. If that function returns the empty
1018 string, the type will be ignored, but the blank lines or white
1019 spaces will be kept.
1021 In addition to element and object types, one function can be
1022 associated to the `template' (or `inner-template') symbol and
1023 another one to the `plain-text' symbol.
1025 The former returns the final transcoded string, and can be used
1026 to add a preamble and a postamble to document's body. It must
1027 accept two arguments: the transcoded string and the property list
1028 containing export options. A function associated to `template'
1030 A function associated to `inner-template' is always applied.
1032 The latter, when defined, is to be called on every text not
1033 recognized as an element or an object. It must accept two
1034 arguments: the text string and the information channel. It is an
1035 appropriate place to protect special chars relative to the
1036 back-end.
1038 BODY can start with pre-defined keyword arguments. The following
1039 keywords are understood:
1041 :export-block
1043 String, or list of strings, representing block names that
1044 will not be parsed. This is used to specify blocks that will
1045 contain raw code specific to the back-end. These blocks
1046 still have to be handled by the relative `export-block' type
1047 translator.
1049 :filters-alist
1051 Alist between filters and function, or list of functions,
1052 specific to the back-end. See `org-export-filters-alist' for
1053 a list of all allowed filters. Filters defined here
1054 shouldn't make a back-end test, as it may prevent back-ends
1055 derived from this one to behave properly.
1057 :menu-entry
1059 Menu entry for the export dispatcher. It should be a list
1060 like:
1062 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1064 where :
1066 KEY is a free character selecting the back-end.
1068 DESCRIPTION-OR-ORDINAL is either a string or a number.
1070 If it is a string, is will be used to name the back-end in
1071 its menu entry. If it is a number, the following menu will
1072 be displayed as a sub-menu of the back-end with the same
1073 KEY. Also, the number will be used to determine in which
1074 order such sub-menus will appear (lowest first).
1076 ACTION-OR-MENU is either a function or an alist.
1078 If it is an action, it will be called with four
1079 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1080 BODY-ONLY. See `org-export-as' for further explanations on
1081 some of them.
1083 If it is an alist, associations should follow the
1084 pattern:
1086 '(KEY DESCRIPTION ACTION)
1088 where KEY, DESCRIPTION and ACTION are described above.
1090 Valid values include:
1094 or
1099 \(lambda (a s v b)
1100 \(if a (org-latex-export-to-pdf t s v b)
1101 \(org-open-file
1102 \(org-latex-export-to-pdf nil s v b)))))))
1104 or the following, which will be added to the previous
1105 sub-menu,
1107 '(?l 1
1111 :options-alist
1113 Alist between back-end specific properties introduced in
1114 communication channel and how their value are acquired. See
1115 `org-export-options-alist' for more information about
1116 structure of the values."
1130 :transcoders transcoders
1131 :options options
1132 :filters filters
1133 :blocks blocks
1137 "Create a new back-end as a variant of an existing one.
1139 CHILD is the name of the derived back-end. PARENT is the name of
1140 the parent back-end.
1142 BODY can start with pre-defined keyword arguments. The following
1143 keywords are understood:
1145 :export-block
1147 String, or list of strings, representing block names that
1148 will not be parsed. This is used to specify blocks that will
1149 contain raw code specific to the back-end. These blocks
1150 still have to be handled by the relative `export-block' type
1151 translator.
1153 :filters-alist
1155 Alist of filters that will overwrite or complete filters
1156 defined in PARENT back-end. See `org-export-filters-alist'
1157 for a list of allowed filters.
1159 :menu-entry
1161 Menu entry for the export dispatcher. See
1162 `org-export-define-backend' for more information about the
1163 expected value.
1165 :options-alist
1167 Alist of back-end specific properties that will overwrite or
1168 complete those defined in PARENT back-end. Refer to
1169 `org-export-options-alist' for more information about
1170 structure of the values.
1172 :translate-alist
1174 Alist of element and object types and transcoders that will
1175 overwrite or complete transcode table from PARENT back-end.
1176 Refer to `org-export-define-backend' for detailed information
1177 about transcoders.
1180 as a variant of `latex' back-end with a custom template function:
1182 \(org-export-define-derived-backend 'my-latex 'latex
1183 :translate-alist '((template . my-latex-template-fun)))
1185 The back-end could then be called with, for example:
1202 :parent parent
1203 :transcoders transcoders
1204 :options options
1205 :filters filters
1206 :blocks blocks
1210 \f
1211 ;;; The Communication Channel
1212 ;;
1213 ;; During export process, every function has access to a number of
1214 ;; properties. They are of two types:
1215 ;;
1216 ;; 1. Environment options are collected once at the very beginning of
1217 ;; the process, out of the original buffer and configuration.
1218 ;; Collecting them is handled by `org-export-get-environment'
1219 ;; function.
1220 ;;
1221 ;; Most environment options are defined through the
1222 ;; `org-export-options-alist' variable.
1223 ;;
1224 ;; 2. Tree properties are extracted directly from the parsed tree,
1225 ;; just before export, by `org-export-collect-tree-properties'.
1226 ;;
1227 ;; Here is the full list of properties available during transcode
1228 ;; process, with their category and their value type.
1229 ;;
1230 ;; + `:author' :: Author's name.
1231 ;; - category :: option
1232 ;; - type :: string
1233 ;;
1234 ;; + `:back-end' :: Current back-end used for transcoding.
1235 ;; - category :: tree
1236 ;; - type :: symbol
1237 ;;
1238 ;; + `:creator' :: String to write as creation information.
1239 ;; - category :: option
1240 ;; - type :: string
1241 ;;
1242 ;; + `:date' :: String to use as date.
1243 ;; - category :: option
1244 ;; - type :: string
1245 ;;
1246 ;; + `:description' :: Description text for the current data.
1247 ;; - category :: option
1248 ;; - type :: string
1249 ;;
1250 ;; + `:email' :: Author's email.
1251 ;; - category :: option
1252 ;; - type :: string
1253 ;;
1254 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1255 ;; process.
1256 ;; - category :: option
1257 ;; - type :: list of strings
1258 ;;
1259 ;; + `:export-options' :: List of export options available for current
1260 ;; process.
1261 ;; - category :: none
1262 ;; - type :: list of symbols, among `subtree', `body-only' and
1263 ;; `visible-only'.
1264 ;;
1265 ;; + `:exported-data' :: Hash table used for memoizing
1266 ;; `org-export-data'.
1267 ;; - category :: tree
1268 ;; - type :: hash table
1269 ;;
1270 ;; + `:filetags' :: List of global tags for buffer. Used by
1271 ;; `org-export-get-tags' to get tags with inheritance.
1272 ;; - category :: option
1273 ;; - type :: list of strings
1274 ;;
1275 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1276 ;; their definition, as parsed data. Only non-inlined footnotes
1277 ;; are represented in this alist. Also, every definition isn't
1278 ;; guaranteed to be referenced in the parse tree. The purpose of
1279 ;; this property is to preserve definitions from oblivion
1280 ;; (i.e. when the parse tree comes from a part of the original
1281 ;; buffer), it isn't meant for direct use in a back-end. To
1282 ;; retrieve a definition relative to a reference, use
1283 ;; `org-export-get-footnote-definition' instead.
1284 ;; - category :: option
1285 ;; - type :: alist (STRING . LIST)
1286 ;;
1287 ;; + `:headline-levels' :: Maximum level being exported as an
1288 ;; headline. Comparison is done with the relative level of
1289 ;; headlines in the parse tree, not necessarily with their
1290 ;; actual level.
1291 ;; - category :: option
1292 ;; - type :: integer
1293 ;;
1294 ;; + `:headline-offset' :: Difference between relative and real level
1295 ;; of headlines in the parse tree. For example, a value of -1
1296 ;; means a level 2 headline should be considered as level
1297 ;; 1 (cf. `org-export-get-relative-level').
1298 ;; - category :: tree
1299 ;; - type :: integer
1300 ;;
1301 ;; + `:headline-numbering' :: Alist between headlines and their
1302 ;; numbering, as a list of numbers
1303 ;; (cf. `org-export-get-headline-number').
1304 ;; - category :: tree
1305 ;; - type :: alist (INTEGER . LIST)
1306 ;;
1307 ;; + `:id-alist' :: Alist between ID strings and destination file's
1308 ;; path, relative to current directory. It is used by
1309 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1310 ;; external file.
1311 ;; - category :: option
1312 ;; - type :: alist (STRING . STRING)
1313 ;;
1314 ;; + `:ignore-list' :: List of elements and objects that should be
1315 ;; ignored during export.
1316 ;; - category :: tree
1317 ;; - type :: list of elements and objects
1318 ;;
1319 ;; + `:input-file' :: Full path to input file, if any.
1320 ;; - category :: option
1321 ;; - type :: string or nil
1322 ;;
1323 ;; + `:keywords' :: List of keywords attached to data.
1324 ;; - category :: option
1325 ;; - type :: string
1326 ;;
1327 ;; + `:language' :: Default language used for translations.
1328 ;; - category :: option
1329 ;; - type :: string
1330 ;;
1331 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1332 ;; transcoding.
1333 ;; - category :: option
1334 ;; - type :: list (as returned by `org-element-parse-buffer')
1335 ;;
1336 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1337 ;; all line breaks.
1338 ;; - category :: option
1339 ;; - type :: symbol (nil, t)
1340 ;;
1341 ;; + `:section-numbers' :: Non-nil means transcoding should add
1342 ;; section numbers to headlines.
1343 ;; - category :: option
1344 ;; - type :: symbol (nil, t)
1345 ;;
1346 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1347 ;; in transcoding. When such a tag is present, subtrees without
1348 ;; it are de facto excluded from the process. See
1349 ;; `use-select-tags'.
1350 ;; - category :: option
1351 ;; - type :: list of strings
1352 ;;
1353 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1354 ;; a time stamp in the output.
1355 ;; - category :: option
1356 ;; - type :: symbol (nil, t)
1357 ;;
1358 ;; + `:translate-alist' :: Alist between element and object types and
1359 ;; transcoding functions relative to the current back-end.
1360 ;; Special keys `inner-template', `template' and `plain-text' are
1361 ;; also possible.
1362 ;; - category :: option
1363 ;; - type :: alist (SYMBOL . FUNCTION)
1364 ;;
1365 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1366 ;; also be transcoded. If it is set to the `headline' symbol,
1367 ;; only the archived headline's name is retained.
1368 ;; - category :: option
1369 ;; - type :: symbol (nil, t, `headline')
1370 ;;
1371 ;; + `:with-author' :: Non-nil means author's name should be included
1372 ;; in the output.
1373 ;; - category :: option
1374 ;; - type :: symbol (nil, t)
1375 ;;
1376 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1377 ;; - category :: option
1378 ;; - type :: symbol (nil, t)
1379 ;;
1380 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1381 ;; inserted at the end of the transcoded string. If the value
1382 ;; is `comment', it should be commented.
1383 ;; - category :: option
1384 ;; - type :: symbol (`comment', nil, t)
1385 ;;
1386 ;; + `:with-date' :: Non-nil means output should contain a date.
1387 ;; - category :: option
1388 ;; - type :. symbol (nil, t)
1389 ;;
1390 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1391 ;; its value is a list of names, only drawers with such names
1392 ;; will be transcoded. If that list starts with `not', drawer
1393 ;; with these names will be skipped.
1394 ;; - category :: option
1395 ;; - type :: symbol (nil, t) or list of strings
1396 ;;
1397 ;; + `:with-email' :: Non-nil means output should contain author's
1398 ;; email.
1399 ;; - category :: option
1400 ;; - type :: symbol (nil, t)
1401 ;;
1402 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1403 ;; interpreted.
1404 ;; - category :: option
1405 ;; - type :: symbol (nil, t)
1406 ;;
1407 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1408 ;; strings starting with a colon as a fixed-with (verbatim) area.
1409 ;; - category :: option
1410 ;; - type :: symbol (nil, t)
1411 ;;
1412 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1413 ;; footnotes.
1414 ;; - category :: option
1415 ;; - type :: symbol (nil, t)
1416 ;;
1417 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1418 ;; `latex-fragment' objects should appear in export output. When
1419 ;; this property is set to `verbatim', they will be left as-is.
1420 ;; - category :: option
1421 ;; - type :: symbol (`verbatim', nil, t)
1422 ;;
1423 ;; + `:with-planning' :: Non-nil means transcoding should include
1424 ;; planning info.
1425 ;; - category :: option
1426 ;; - type :: symbol (nil, t)
1427 ;;
1428 ;; + `:with-priority' :: Non-nil means transcoding should include
1429 ;; priority cookies.
1430 ;; - category :: option
1431 ;; - type :: symbol (nil, t)
1432 ;;
1433 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1434 ;; plain text.
1435 ;; - category :: option
1436 ;; - type :: symbol (nil, t)
1437 ;;
1438 ;; + `:with-special-strings' :: Non-nil means transcoding should
1439 ;; interpret special strings in plain text.
1440 ;; - category :: option
1441 ;; - type :: symbol (nil, t)
1442 ;;
1443 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1444 ;; interpret subscript and superscript. With a value of "{}",
1445 ;; only interpret those using curly brackets.
1446 ;; - category :: option
1447 ;; - type :: symbol (nil, {}, t)
1448 ;;
1449 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1450 ;; tables.
1451 ;; - category :: option
1452 ;; - type :: symbol (nil, t)
1453 ;;
1454 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1455 ;; headlines. A `not-in-toc' value will remove them from the
1456 ;; table of contents, if any, nonetheless.
1457 ;; - category :: option
1458 ;; - type :: symbol (nil, t, `not-in-toc')
1459 ;;
1460 ;; + `:with-tasks' :: Non-nil means transcoding should include
1461 ;; headlines with a TODO keyword. A `todo' value will only
1462 ;; include headlines with a todo type keyword while a `done'
1463 ;; value will do the contrary. If a list of strings is provided,
1464 ;; only tasks with keywords belonging to that list will be kept.
1465 ;; - category :: option
1466 ;; - type :: symbol (t, todo, done, nil) or list of strings
1467 ;;
1468 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1469 ;; time stamps. Special value `active' (resp. `inactive') ask to
1470 ;; export only active (resp. inactive) timestamps. Otherwise,
1471 ;; completely remove them.
1472 ;; - category :: option
1473 ;; - type :: symbol: (`active', `inactive', t, nil)
1474 ;;
1475 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1476 ;; added to the output. An integer value limits its depth.
1477 ;; - category :: option
1478 ;; - type :: symbol (nil, t or integer)
1479 ;;
1480 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1481 ;; include TODO keywords.
1482 ;; - category :: option
1483 ;; - type :: symbol (nil, t)
1486 ;;;; Environment Options
1487 ;;
1488 ;; Environment options encompass all parameters defined outside the
1489 ;; scope of the parsed data. They come from five sources, in
1490 ;; increasing precedence order:
1491 ;;
1492 ;; - Global variables,
1493 ;; - Buffer's attributes,
1494 ;; - Options keyword symbols,
1495 ;; - Buffer keywords,
1496 ;; - Subtree properties.
1497 ;;
1498 ;; The central internal function with regards to environment options
1499 ;; is `org-export-get-environment'. It updates global variables with
1500 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1501 ;; the different sources.
1502 ;;
1503 ;; The internal functions doing the retrieval are:
1504 ;; `org-export--get-global-options',
1505 ;; `org-export--get-buffer-attributes',
1506 ;; `org-export--parse-option-keyword',
1507 ;; `org-export--get-subtree-options' and
1508 ;; `org-export--get-inbuffer-options'
1509 ;;
1510 ;; Also, `org-export--list-bound-variables' collects bound variables
1511 ;; along with their value in order to set them as buffer local
1512 ;; variables later in the process.
1515 "Collect export options from the current buffer.
1517 Optional argument BACKEND is an export back-end, as returned by
1518 `org-export-create-backend'.
1520 When optional argument SUBTREEP is non-nil, assume the export is
1521 done against the current sub-tree.
1523 Third optional argument EXT-PLIST is a property list with
1524 external parameters overriding Org default settings, but still
1525 inferior to file-local settings."
1526 ;; First install #+BIND variables since these must be set before
1527 ;; global options are read.
1530 ;; Get and prioritize export options...
1532 ;; ... from global variables...
1534 ;; ... from an external property list...
1535 ext-plist
1536 ;; ... from in-buffer settings...
1538 ;; ... and from subtree, when appropriate.
1540 ;; Eventually add misc. properties.
1542 :back-end
1543 backend
1545 :footnote-definition-alist
1546 ;; Footnotes definitions must be collected in the original
1547 ;; buffer, as there's no insurance that they will still be in
1548 ;; the parse tree, due to possible narrowing.
1562 alist))))
1563 alist))
1564 :id-alist
1565 ;; Collect id references.
1576 alist))))
1579 "Parse an OPTIONS line and return values as a plist.
1580 Optional argument BACKEND is an export back-end, as returned by,
1581 e.g., `org-export-create-backend'. It specifies which back-end
1582 specific items to read, if any."
1584 ;; Priority is given to back-end specific options.
1586 org-export-options-alist))
1587 plist)
1596 options))
1598 property
1601 plist))
1604 "Get export options in subtree at point.
1605 Optional argument BACKEND is an export back-end, as returned by,
1606 e.g., `org-export-create-backend'. It specifies back-end used
1607 for export. Return options as a plist."
1608 ;; For each buffer keyword, create a headline property setting the
1609 ;; same property in communication channel. The name for the property
1610 ;; is the keyword with "EXPORT_" appended to it.
1613 ;; Make sure point is at a heading.
1615 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1616 ;; title (with no todo keyword, priority cookie or tag) as its
1617 ;; fallback value.
1623 plist :title
1626 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1630 ;; Handle other keywords. TITLE keyword is excluded as it has
1631 ;; been handled already.
1639 ;; Export properties are not case-sensitive.
1646 plist
1647 property
1649 ;; Parse VALUE if required.
1653 ;; If BEHAVIOR is `split' expected value is
1654 ;; a list of strings, not a string.
1657 ;; Look for both general keywords and back-end specific
1658 ;; options, with priority given to the latter.
1660 org-export-options-alist)))
1661 ;; Return value.
1662 plist)))
1665 "Return current buffer export options, as a plist.
1667 Optional argument BACKEND, when non-nil, is an export back-end,
1668 as returned by, e.g., `org-export-create-backend'. It specifies
1669 which back-end specific options should also be read in the
1670 process.
1672 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1674 get-options ; For byte-compiler.
1677 ;; Priority is given to back-end specific options.
1679 org-export-options-alist))
1682 org-export-special-keywords))))
1685 ;; Return all properties associated to KEYWORD.
1692 ;; Recursively read keywords in buffer. FILES is a list
1693 ;; of files read so far. PLIST is the current property
1694 ;; list obtained.
1703 ;; Options in `org-export-special-keywords'.
1707 ;; Avoid circular dependencies.
1717 plist
1722 plist
1728 ;; Options in `org-export-options-alist'.
1733 plist property
1734 ;; Handle value depending on specified
1735 ;; BEHAVIOR.
1741 " "
1754 ;; Return final value.
1755 plist))))
1756 ;; Read options in the current buffer.
1759 ;; Parse keywords specified in `org-element-document-properties'
1760 ;; and return PLIST.
1771 "Return properties related to buffer attributes, as a plist."
1772 ;; Store full path of input file name, or nil. For internal use.
1780 "Return global export options as a plist.
1781 Optional argument BACKEND, if non-nil, is an export back-end, as
1782 returned by, e.g., `org-export-create-backend'. It specifies
1783 which back-end specific export options should also be read in the
1784 process."
1786 ;; Priority is given to back-end specific options.
1788 org-export-options-alist)))
1795 plist
1796 prop
1797 ;; Eval default value provided. If keyword is
1798 ;; a member of `org-element-document-properties',
1799 ;; parse it as a secondary string before storing it.
1806 value)))))))))))
1809 "Return variables bound from BIND keywords in current buffer.
1810 Also look for BIND keywords in setup files. The return value is
1811 an alist where associations are (VARIABLE-NAME VALUE)."
1816 ;; Return an alist between variable names and their
1817 ;; value. FILES is a list of setup files names read so
1818 ;; far, used to avoid circular dependencies. ALIST is
1819 ;; the alist collected so far.
1830 ;; Enter setup file.
1840 alist))))))))))
1841 alist)))))
1842 ;; Return value in appropriate order of appearance.
1846 ;;;; Tree Properties
1847 ;;
1848 ;; Tree properties are information extracted from parse tree. They
1849 ;; are initialized at the beginning of the transcoding process by
1850 ;; `org-export-collect-tree-properties'.
1851 ;;
1852 ;; Dedicated functions focus on computing the value of specific tree
1853 ;; properties during initialization. Thus,
1854 ;; `org-export--populate-ignore-list' lists elements and objects that
1855 ;; should be skipped during export, `org-export--get-min-level' gets
1856 ;; the minimal exportable level, used as a basis to compute relative
1857 ;; level for headlines. Eventually
1858 ;; `org-export--collect-headline-numbering' builds an alist between
1859 ;; headlines and their numbering.
1862 "Extract tree properties from parse tree.
1864 DATA is the parse tree from which information is retrieved. INFO
1865 is a list holding export options.
1867 Following tree properties are set or updated:
1869 `:exported-data' Hash table used to memoize results from
1870 `org-export-data'.
1872 `:footnote-definition-alist' List of footnotes definitions in
1873 original buffer and current parse tree.
1875 `:headline-offset' Offset between true level of headlines and
1876 local level. An offset of -1 means a headline
1877 of level 2 should be considered as a level
1878 1 headline in the context.
1880 `:headline-numbering' Alist of all headlines as key an the
1881 associated numbering as value.
1883 `:ignore-list' List of elements that should be ignored during
1884 export.
1886 Return updated plist."
1887 ;; Install the parse tree in the communication channel, in order to
1888 ;; use `org-export-get-genealogy' and al.
1890 ;; Get the list of elements and objects to ignore, and put it into
1891 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1892 ;; been done during parse tree filtering.
1895 :ignore-list
1898 ;; Compute `:headline-offset' in order to be able to use
1899 ;; `org-export-get-relative-level'.
1902 :headline-offset
1904 ;; Update footnotes definitions list with definitions in parse tree.
1905 ;; This is required since buffer expansion might have modified
1906 ;; boundaries of footnote definitions contained in the parse tree.
1907 ;; This way, definitions in `footnote-definition-alist' are bound to
1908 ;; match those in the parse tree.
1914 defs)))
1916 ;; Properties order doesn't matter: get the rest of the tree
1917 ;; properties.
1921 info))
1924 "Return minimum exportable headline's level in DATA.
1925 DATA is parsed tree as returned by `org-element-parse-buffer'.
1926 OPTIONS is a plist holding export options."
1937 ;; If no headline was found, for the sake of consistency, set
1938 ;; minimum level to 1 nonetheless.
1942 "Return numbering of all exportable headlines in a parse tree.
1944 DATA is the parse tree. OPTIONS is the plist holding export
1945 options.
1947 Return an alist whose key is a headline and value is its
1948 associated numbering \(in the shape of a list of numbers\) or nil
1949 for a footnotes section."
1957 headline
1959 for idx from 0 to org-export-max-depth
1963 options)))
1966 "Return list of elements and objects to ignore during export.
1967 DATA is the parse tree to traverse. OPTIONS is the plist holding
1968 export options."
1970 walk-data
1971 ;; First find trees containing a select tag, if any.
1975 ;; Collect ignored elements or objects into IGNORE-LIST.
1981 ;; If headline is archived but tree below has
1982 ;; to be skipped, add it to ignore list.
1985 ;; Move into secondary string, if any.
1990 ;; Move into recursive objects/elements.
1992 ;; Main call.
1994 ;; Return value.
1995 ignore))
1998 "Return list of headlines and inlinetasks with a select tag in their tree.
1999 DATA is parsed data as returned by `org-element-parse-buffer'.
2000 INFO is a plist holding export options."
2002 walk-data ; For byte-compiler.
2012 ;; When a select tag is found, mark full
2013 ;; genealogy and every headline within the tree
2014 ;; as acceptable.
2017 genealogy
2020 selected-trees))
2021 ;; If at a headline, continue searching in tree,
2022 ;; recursively.
2032 selected-trees))
2035 "Non-nil when element or object BLOB should be skipped during export.
2036 OPTIONS is the plist holding export options. SELECTED, when
2037 non-nil, is a list of headlines or inlinetasks belonging to
2038 a tree with a select tag."
2045 ;; If `:with-drawers' value starts with `not', ignore
2046 ;; every drawer whose name belong to that list.
2047 ;; Otherwise, ignore drawers whose name isn't in that
2048 ;; list.
2064 ;; Ignore subtrees with an exclude tag.
2067 ;; When a select tag is present in the buffer, ignore any tree
2068 ;; without it.
2070 ;; Ignore commented sub-trees.
2072 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2074 ;; Ignore tasks, if specified by `:with-tasks' property.
2089 ;; `:with-timestamps' only applies to isolated timestamps
2090 ;; objects, i.e. timestamp objects in a paragraph containing only
2091 ;; timestamps and whitespaces.
2099 options t))))
2108 \f
2109 ;;; The Transcoder
2110 ;;
2111 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2112 ;; `org-element-parse-buffer') and transcodes it into a specified
2113 ;; back-end output. It takes care of filtering out elements or
2114 ;; objects according to export options and organizing the output blank
2115 ;; lines and white space are preserved. The function memoizes its
2116 ;; results, so it is cheap to call it within transcoders.
2117 ;;
2118 ;; It is possible to modify locally the back-end used by
2119 ;; `org-export-data' or even use a temporary back-end by using
2120 ;; `org-export-data-with-backend'.
2121 ;;
2122 ;; Internally, three functions handle the filtering of objects and
2123 ;; elements during the export. In particular,
2124 ;; `org-export-ignore-element' marks an element or object so future
2125 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2126 ;; elements or objects should be seen as real Org syntax and
2127 ;; `org-export-expand' transforms the others back into their original
2128 ;; shape
2129 ;;
2130 ;; `org-export-transcoder' is an accessor returning appropriate
2131 ;; translator function for a given element or object.
2134 "Return appropriate transcoder for BLOB.
2135 INFO is a plist containing export directives."
2137 ;; Return contents only for complete parse trees.
2143 "Convert DATA into current back-end format.
2145 DATA is a parse tree, an element or an object or a secondary
2146 string. INFO is a plist holding export options.
2148 Return transcoded string."
2154 ;; Ignored element/object.
2156 ;; Plain text.
2162 info))
2163 ;; Uninterpreted element/object: change it back to Org
2164 ;; syntax and export again resulting raw string.
2168 data
2172 info))
2173 ;; Secondary string.
2176 ;; Element/Object without contents or, as a special case,
2177 ;; headline with archive tag and archived trees restricted
2178 ;; to title only.
2186 ;; Export snippets never return a nil value so
2187 ;; that white spaces following them are never
2188 ;; ignored.
2190 ;; Element/Object with contents.
2203 ;; Elements directly containing objects
2204 ;; must have their indentation normalized
2205 ;; first.
2207 data
2208 ;; When normalizing contents of the first
2209 ;; paragraph in an item or a footnote
2210 ;; definition, ignore first line's
2211 ;; indentation: there is none and it
2212 ;; might be misleading.
2217 data)
2224 info))))))))
2225 ;; Final result will be memoized before being returned.
2227 data
2231 ;; Append the same white space between elements or objects as in
2232 ;; the original buffer, and call appropriate filters.
2243 info)))
2244 results)))
2248 "Convert DATA into BACKEND format.
2250 DATA is an element, an object, a secondary string or a string.
2251 BACKEND is a symbol. INFO is a plist used as a communication
2252 channel.
2254 Unlike to `org-export-with-backend', this function will
2255 recursively convert DATA using BACKEND translation table."
2258 data
2259 ;; Set-up a new communication channel with translations defined in
2260 ;; BACKEND as the translate table and a new hash table for
2261 ;; memoization.
2263 info
2266 ;; Size of the hash table is reduced since this function
2267 ;; will probably be used on small trees.
2271 "Non-nil if element or object BLOB should be interpreted during export.
2272 If nil, BLOB will appear as raw Org syntax. Check is done
2273 according to export options INFO, stored as a plist."
2275 ;; ... entities...
2277 ;; ... emphasis...
2280 ;; ... fixed-width areas.
2282 ;; ... LaTeX environments and fragments...
2286 ;; ... sub/superscripts...
2292 ;; ... tables...
2297 "Expand a parsed element or object to its original state.
2299 BLOB is either an element or an object. CONTENTS is its
2300 contents, as a string or nil.
2302 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2303 keywords before output."
2308 blob contents))))
2311 "Add ELEMENT to `:ignore-list' in INFO.
2313 Any element in `:ignore-list' will be skipped when using
2314 `org-element-map'. INFO is modified by side effects."
2318 \f
2319 ;;; The Filter System
2320 ;;
2321 ;; Filters allow end-users to tweak easily the transcoded output.
2322 ;; They are the functional counterpart of hooks, as every filter in
2323 ;; a set is applied to the return value of the previous one.
2324 ;;
2325 ;; Every set is back-end agnostic. Although, a filter is always
2326 ;; called, in addition to the string it applies to, with the back-end
2327 ;; used as argument, so it's easy for the end-user to add back-end
2328 ;; specific filters in the set. The communication channel, as
2329 ;; a plist, is required as the third argument.
2330 ;;
2331 ;; From the developer side, filters sets can be installed in the
2332 ;; process with the help of `org-export-define-backend', which
2333 ;; internally stores filters as an alist. Each association has a key
2334 ;; among the following symbols and a function or a list of functions
2335 ;; as value.
2336 ;;
2337 ;; - `:filter-options' applies to the property list containing export
2338 ;; options. Unlike to other filters, functions in this list accept
2339 ;; two arguments instead of three: the property list containing
2340 ;; export options and the back-end. Users can set its value through
2341 ;; `org-export-filter-options-functions' variable.
2342 ;;
2343 ;; - `:filter-parse-tree' applies directly to the complete parsed
2344 ;; tree. Users can set it through
2345 ;; `org-export-filter-parse-tree-functions' variable.
2346 ;;
2347 ;; - `:filter-final-output' applies to the final transcoded string.
2348 ;; Users can set it with `org-export-filter-final-output-functions'
2349 ;; variable
2350 ;;
2351 ;; - `:filter-plain-text' applies to any string not recognized as Org
2352 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2353 ;; configure it.
2354 ;;
2355 ;; - `:filter-TYPE' applies on the string returned after an element or
2356 ;; object of type TYPE has been transcoded. A user can modify
2357 ;; `org-export-filter-TYPE-functions'
2358 ;;
2359 ;; All filters sets are applied with
2360 ;; `org-export-filter-apply-functions' function. Filters in a set are
2361 ;; applied in a LIFO fashion. It allows developers to be sure that
2362 ;; their filters will be applied first.
2363 ;;
2364 ;; Filters properties are installed in communication channel with
2365 ;; `org-export-install-filters' function.
2366 ;;
2367 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2368 ;; `org-export-before-parsing-hook') are run at the beginning of the
2369 ;; export process and just before parsing to allow for heavy structure
2370 ;; modifications.
2373 ;;;; Hooks
2376 "Hook run at the beginning of the export process.
2378 This is run before include keywords and macros are expanded and
2379 Babel code blocks executed, on a copy of the original buffer
2380 being exported. Visibility and narrowing are preserved. Point
2381 is at the beginning of the buffer.
2383 Every function in this hook will be called with one argument: the
2387 "Hook run before parsing an export buffer.
2389 This is run after include keywords and macros have been expanded
2390 and Babel code blocks executed, on a copy of the original buffer
2391 being exported. Visibility and narrowing are preserved. Point
2392 is at the beginning of the buffer.
2394 Every function in this hook will be called with one argument: the
2398 ;;;; Special Filters
2401 "List of functions applied to the export options.
2402 Each filter is called with two arguments: the export options, as
2403 a plist, and the back-end, as a symbol. It must return
2407 "List of functions applied to the parsed tree.
2408 Each filter is called with three arguments: the parse tree, as
2409 returned by `org-element-parse-buffer', the back-end, as
2410 a symbol, and the communication channel, as a plist. It must
2414 "List of functions applied to plain text.
2415 Each filter is called with three arguments: a string which
2416 contains no Org syntax, the back-end, as a symbol, and the
2417 communication channel, as a plist. It must return a string or
2421 "List of functions applied to the transcoded string.
2422 Each filter is called with three arguments: the full transcoded
2423 string, the back-end, as a symbol, and the communication channel,
2424 as a plist. It must return a string that will be used as the
2428 ;;;; Elements Filters
2431 "List of functions applied to a transcoded babel-call.
2432 Each filter is called with three arguments: the transcoded data,
2433 as a string, the back-end, as a symbol, and the communication
2437 "List of functions applied to a transcoded center block.
2438 Each filter is called with three arguments: the transcoded data,
2439 as a string, the back-end, as a symbol, and the communication
2443 "List of functions applied to a transcoded clock.
2444 Each filter is called with three arguments: the transcoded data,
2445 as a string, the back-end, as a symbol, and the communication
2449 "List of functions applied to a transcoded comment.
2450 Each filter is called with three arguments: the transcoded data,
2451 as a string, the back-end, as a symbol, and the communication
2455 "List of functions applied to a transcoded comment-block.
2456 Each filter is called with three arguments: the transcoded data,
2457 as a string, the back-end, as a symbol, and the communication
2461 "List of functions applied to a transcoded diary-sexp.
2462 Each filter is called with three arguments: the transcoded data,
2463 as a string, the back-end, as a symbol, and the communication
2467 "List of functions applied to a transcoded drawer.
2468 Each filter is called with three arguments: the transcoded data,
2469 as a string, the back-end, as a symbol, and the communication
2473 "List of functions applied to a transcoded dynamic-block.
2474 Each filter is called with three arguments: the transcoded data,
2475 as a string, the back-end, as a symbol, and the communication
2479 "List of functions applied to a transcoded example-block.
2480 Each filter is called with three arguments: the transcoded data,
2481 as a string, the back-end, as a symbol, and the communication
2485 "List of functions applied to a transcoded export-block.
2486 Each filter is called with three arguments: the transcoded data,
2487 as a string, the back-end, as a symbol, and the communication
2491 "List of functions applied to a transcoded fixed-width.
2492 Each filter is called with three arguments: the transcoded data,
2493 as a string, the back-end, as a symbol, and the communication
2497 "List of functions applied to a transcoded footnote-definition.
2498 Each filter is called with three arguments: the transcoded data,
2499 as a string, the back-end, as a symbol, and the communication
2503 "List of functions applied to a transcoded headline.
2504 Each filter is called with three arguments: the transcoded data,
2505 as a string, the back-end, as a symbol, and the communication
2509 "List of functions applied to a transcoded horizontal-rule.
2510 Each filter is called with three arguments: the transcoded data,
2511 as a string, the back-end, as a symbol, and the communication
2515 "List of functions applied to a transcoded inlinetask.
2516 Each filter is called with three arguments: the transcoded data,
2517 as a string, the back-end, as a symbol, and the communication
2521 "List of functions applied to a transcoded item.
2522 Each filter is called with three arguments: the transcoded data,
2523 as a string, the back-end, as a symbol, and the communication
2527 "List of functions applied to a transcoded keyword.
2528 Each filter is called with three arguments: the transcoded data,
2529 as a string, the back-end, as a symbol, and the communication
2533 "List of functions applied to a transcoded latex-environment.
2534 Each filter is called with three arguments: the transcoded data,
2535 as a string, the back-end, as a symbol, and the communication
2539 "List of functions applied to a transcoded node-property.
2540 Each filter is called with three arguments: the transcoded data,
2541 as a string, the back-end, as a symbol, and the communication
2545 "List of functions applied to a transcoded paragraph.
2546 Each filter is called with three arguments: the transcoded data,
2547 as a string, the back-end, as a symbol, and the communication
2551 "List of functions applied to a transcoded plain-list.
2552 Each filter is called with three arguments: the transcoded data,
2553 as a string, the back-end, as a symbol, and the communication
2557 "List of functions applied to a transcoded planning.
2558 Each filter is called with three arguments: the transcoded data,
2559 as a string, the back-end, as a symbol, and the communication
2563 "List of functions applied to a transcoded property-drawer.
2564 Each filter is called with three arguments: the transcoded data,
2565 as a string, the back-end, as a symbol, and the communication
2569 "List of functions applied to a transcoded quote block.
2570 Each filter is called with three arguments: the transcoded quote
2571 data, as a string, the back-end, as a symbol, and the
2572 communication channel, as a plist. It must return a string or
2576 "List of functions applied to a transcoded quote-section.
2577 Each filter is called with three arguments: the transcoded data,
2578 as a string, the back-end, as a symbol, and the communication
2582 "List of functions applied to a transcoded section.
2583 Each filter is called with three arguments: the transcoded data,
2584 as a string, the back-end, as a symbol, and the communication
2588 "List of functions applied to a transcoded special block.
2589 Each filter is called with three arguments: the transcoded data,
2590 as a string, the back-end, as a symbol, and the communication
2594 "List of functions applied to a transcoded src-block.
2595 Each filter is called with three arguments: the transcoded data,
2596 as a string, the back-end, as a symbol, and the communication
2600 "List of functions applied to a transcoded table.
2601 Each filter is called with three arguments: the transcoded data,
2602 as a string, the back-end, as a symbol, and the communication
2606 "List of functions applied to a transcoded table-cell.
2607 Each filter is called with three arguments: the transcoded data,
2608 as a string, the back-end, as a symbol, and the communication
2612 "List of functions applied to a transcoded table-row.
2613 Each filter is called with three arguments: the transcoded data,
2614 as a string, the back-end, as a symbol, and the communication
2618 "List of functions applied to a transcoded verse block.
2619 Each filter is called with three arguments: the transcoded data,
2620 as a string, the back-end, as a symbol, and the communication
2624 ;;;; Objects Filters
2627 "List of functions applied to transcoded bold text.
2628 Each filter is called with three arguments: the transcoded data,
2629 as a string, the back-end, as a symbol, and the communication
2633 "List of functions applied to transcoded code text.
2634 Each filter is called with three arguments: the transcoded data,
2635 as a string, the back-end, as a symbol, and the communication
2639 "List of functions applied to a transcoded entity.
2640 Each filter is called with three arguments: the transcoded data,
2641 as a string, the back-end, as a symbol, and the communication
2645 "List of functions applied to a transcoded export-snippet.
2646 Each filter is called with three arguments: the transcoded data,
2647 as a string, the back-end, as a symbol, and the communication
2651 "List of functions applied to a transcoded footnote-reference.
2652 Each filter is called with three arguments: the transcoded data,
2653 as a string, the back-end, as a symbol, and the communication
2657 "List of functions applied to a transcoded inline-babel-call.
2658 Each filter is called with three arguments: the transcoded data,
2659 as a string, the back-end, as a symbol, and the communication
2663 "List of functions applied to a transcoded inline-src-block.
2664 Each filter is called with three arguments: the transcoded data,
2665 as a string, the back-end, as a symbol, and the communication
2669 "List of functions applied to transcoded italic text.
2670 Each filter is called with three arguments: the transcoded data,
2671 as a string, the back-end, as a symbol, and the communication
2675 "List of functions applied to a transcoded latex-fragment.
2676 Each filter is called with three arguments: the transcoded data,
2677 as a string, the back-end, as a symbol, and the communication
2681 "List of functions applied to a transcoded line-break.
2682 Each filter is called with three arguments: the transcoded data,
2683 as a string, the back-end, as a symbol, and the communication
2687 "List of functions applied to a transcoded link.
2688 Each filter is called with three arguments: the transcoded data,
2689 as a string, the back-end, as a symbol, and the communication
2693 "List of functions applied to a transcoded radio-target.
2694 Each filter is called with three arguments: the transcoded data,
2695 as a string, the back-end, as a symbol, and the communication
2699 "List of functions applied to a transcoded statistics-cookie.
2700 Each filter is called with three arguments: the transcoded data,
2701 as a string, the back-end, as a symbol, and the communication
2705 "List of functions applied to transcoded strike-through text.
2706 Each filter is called with three arguments: the transcoded data,
2707 as a string, the back-end, as a symbol, and the communication
2711 "List of functions applied to a transcoded subscript.
2712 Each filter is called with three arguments: the transcoded data,
2713 as a string, the back-end, as a symbol, and the communication
2717 "List of functions applied to a transcoded superscript.
2718 Each filter is called with three arguments: the transcoded data,
2719 as a string, the back-end, as a symbol, and the communication
2723 "List of functions applied to a transcoded target.
2724 Each filter is called with three arguments: the transcoded data,
2725 as a string, the back-end, as a symbol, and the communication
2729 "List of functions applied to a transcoded timestamp.
2730 Each filter is called with three arguments: the transcoded data,
2731 as a string, the back-end, as a symbol, and the communication
2735 "List of functions applied to transcoded underline text.
2736 Each filter is called with three arguments: the transcoded data,
2737 as a string, the back-end, as a symbol, and the communication
2741 "List of functions applied to transcoded verbatim text.
2742 Each filter is called with three arguments: the transcoded data,
2743 as a string, the back-end, as a symbol, and the communication
2747 ;;;; Filters Tools
2748 ;;
2749 ;; Internal function `org-export-install-filters' installs filters
2750 ;; hard-coded in back-ends (developer filters) and filters from global
2751 ;; variables (user filters) in the communication channel.
2752 ;;
2753 ;; Internal function `org-export-filter-apply-functions' takes care
2754 ;; about applying each filter in order to a given data. It ignores
2755 ;; filters returning a nil value but stops whenever a filter returns
2756 ;; an empty string.
2759 "Call every function in FILTERS.
2761 Functions are called with arguments VALUE, current export
2762 back-end's name and INFO. A function returning a nil value will
2763 be skipped. If it returns the empty string, the process ends and
2764 VALUE is ignored.
2766 Call is done in a LIFO fashion, to be sure that developer
2767 specified filters, if any, are called first."
2778 "Install filters properties in communication channel.
2779 INFO is a plist containing the current communication channel.
2780 Return the updated communication channel."
2782 ;; Install user-defined filters with `org-export-filters-alist'
2783 ;; and filters already in INFO (through ext-plist mechanism).
2790 ;; Filters in INFO will be called
2791 ;; before those user provided.
2794 default-value)))))
2795 org-export-filters-alist)
2796 ;; Prepend back-end specific filters to that list.
2798 ;; Single values get consed, lists are appended.
2803 plist key
2807 ;; Return new communication channel.
2811 \f
2812 ;;; Core functions
2813 ;;
2814 ;; This is the room for the main function, `org-export-as', along with
2815 ;; its derivative, `org-export-string-as'.
2816 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2817 ;; function should be added to kill ring.
2818 ;;
2819 ;; Note that `org-export-as' doesn't really parse the current buffer,
2820 ;; but a copy of it (with the same buffer-local variables and
2821 ;; visibility), where macros and include keywords are expanded and
2822 ;; Babel blocks are executed, if appropriate.
2823 ;; `org-export-with-buffer-copy' macro prepares that copy.
2824 ;;
2825 ;; File inclusion is taken care of by
2826 ;; `org-export-expand-include-keyword' and
2827 ;; `org-export--prepare-file-contents'. Structure wise, including
2828 ;; a whole Org file in a buffer often makes little sense. For
2829 ;; example, if the file contains a headline and the include keyword
2830 ;; was within an item, the item should contain the headline. That's
2831 ;; why file inclusion should be done before any structure can be
2832 ;; associated to the file, that is before parsing.
2833 ;;
2834 ;; `org-export-insert-default-template' is a command to insert
2835 ;; a default template (or a back-end specific template) at point or in
2836 ;; current subtree.
2839 "Return a copy of the current buffer.
2840 The copy preserves Org buffer-local variables, visibility and
2841 narrowing."
2847 new-buf))
2850 "Apply BODY in a copy of the current buffer.
2851 The copy preserves local variables, visibility and contents of
2852 the original buffer. Point is at the beginning of the buffer
2853 when BODY is applied."
2862 ;; Kill copy without confirmation.
2868 "Generate a function duplicating BUFFER.
2870 The copy will preserve local variables, visibility, contents and
2871 narrowing of the original buffer. If a region was active in
2872 BUFFER, contents will be narrowed to that region instead.
2874 The resulting function can be evaluated at a later time, from
2875 another buffer, effectively cloning the original buffer there.
2877 The function assumes BUFFER's major mode is `org-mode'."
2881 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2882 ;; already in BUFFER.
2884 ;; Copy specific buffer local variables and variables set
2885 ;; through BIND keywords.
2887 vars)
2895 buffer-file-name
2896 buffer-file-coding-system))
2900 ;; Skip unreadable values, as they cannot be
2901 ;; sent to external process.
2905 vars))))))
2906 ;; Whole buffer contents.
2911 ;; Narrowing.
2915 ;; Current position of point.
2917 ;; Overlays with invisible property.
2927 ov-set))))
2929 ov-set)))))
2931 ;;;###autoload
2934 "Transcode current Org buffer into BACKEND code.
2936 BACKEND is either an export back-end, as returned by, e.g.,
2937 `org-export-create-backend', or a symbol referring to
2938 a registered back-end.
2940 If narrowing is active in the current buffer, only transcode its
2941 narrowed part.
2943 If a region is active, transcode that region.
2945 When optional argument SUBTREEP is non-nil, transcode the
2946 sub-tree at point, extracting information from the headline
2947 properties first.
2949 When optional argument VISIBLE-ONLY is non-nil, don't export
2950 contents of hidden elements.
2952 When optional argument BODY-ONLY is non-nil, only return body
2953 code, without surrounding template.
2955 Optional argument EXT-PLIST, when provided, is a property list
2956 with external parameters overriding Org default settings, but
2957 still inferior to file-local settings.
2959 Return code as a string."
2964 ;; Narrow buffer to an appropriate region or subtree for
2965 ;; parsing. If parsing subtree, be sure to remove main headline
2966 ;; too.
2974 ;; Initialize communication channel with original buffer
2975 ;; attributes, unavailable in its copy.
2984 tree)
2985 ;; Update communication channel and get parse tree. Buffer
2986 ;; isn't parsed directly. Instead, a temporary copy is
2987 ;; created, where include keywords, macros are expanded and
2988 ;; code blocks are evaluated.
2990 ;; Run first hook with current back-end's name as argument.
2994 ;; Update macro templates since #+INCLUDE keywords might have
2995 ;; added some new ones.
2999 ;; Update radio targets since keyword inclusion might have
3000 ;; added some more.
3002 ;; Run last hook with current back-end's name as argument.
3007 ;; Update communication channel with environment. Also
3008 ;; install user's and developer's filters.
3013 ;; Expand export-specific set of macros: {{{author}}},
3014 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3015 ;; once regular macros have been expanded, since document
3016 ;; keywords may contain one of them.
3022 ;; EMAIL is not a parsed keyword: store it as-is.
3026 ;; Call options filters and update export options. We do not
3027 ;; use `org-export-filter-apply-functions' here since the
3028 ;; arity of such filters is different.
3033 ;; Parse buffer and call parse-tree filter on it.
3038 ;; Now tree is complete, compute its properties and add them
3039 ;; to communication channel.
3043 ;; Eventually transcode TREE. Wrap the resulting string into
3044 ;; a template.
3053 ;; Remove all text properties since they cannot be
3054 ;; retrieved from an external process. Finally call
3055 ;; final-output filter and return result.
3061 info))))))))
3063 ;;;###autoload
3065 "Transcode STRING into BACKEND code.
3067 BACKEND is either an export back-end, as returned by, e.g.,
3068 `org-export-create-backend', or a symbol referring to
3069 a registered back-end.
3071 When optional argument BODY-ONLY is non-nil, only return body
3072 code, without preamble nor postamble.
3074 Optional argument EXT-PLIST, when provided, is a property list
3075 with external parameters overriding Org default settings, but
3076 still inferior to file-local settings.
3078 Return code as a string."
3084 ;;;###autoload
3086 "Replace the active region by its export to BACKEND.
3087 BACKEND is either an export back-end, as returned by, e.g.,
3088 `org-export-create-backend', or a symbol referring to
3089 a registered back-end."
3099 ;;;###autoload
3101 "Insert all export keywords with default values at beginning of line.
3103 BACKEND is a symbol referring to the name of a registered export
3104 back-end, for which specific export options should be added to
3105 the template, or `default' for default template. When it is nil,
3106 the user will be prompted for a category.
3108 If SUBTREEP is non-nil, export configuration will be set up
3109 locally for the subtree through node properties."
3119 "Options category: "
3123 org-export--registered-backends))))))
3124 options keywords)
3125 ;; Populate OPTIONS and KEYWORDS.
3142 ;; Move to an appropriate location in order to insert options.
3144 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3145 ;; list of available keywords.
3173 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3191 ;; And the rest of keywords.
3202 "Expand every include keyword in buffer.
3203 Optional argument INCLUDED is a list of included file names along
3204 with their line restriction, when appropriate. It is used to
3205 avoid infinite recursion. Optional argument DIR is the current
3206 working directory. It is used to properly resolve relative
3207 paths."
3214 ;; Extract arguments from keyword's value.
3222 dir)
3227 value)
3233 ;; Minimal level of included file defaults to the child
3234 ;; level of the current headline, if any, or one. It
3235 ;; only applies is the file is meant to be included as
3236 ;; an Org one.
3244 ;; Remove keyword.
3250 ;; Check if files has already been parsed. Look after
3251 ;; inclusion lines too, as different parts of the same file
3252 ;; can be included too.
3264 ind-str contents ind-str))))
3272 ind-str env contents ind-str))))
3285 "Prepare the contents of FILE for inclusion and return them as a string.
3287 When optional argument LINES is a string specifying a range of
3288 lines, include only those lines.
3290 Optional argument IND, when non-nil, is an integer specifying the
3291 global indentation of returned contents. Since its purpose is to
3292 allow an included file to stay in the same environment it was
3293 created \(i.e. a list item), it doesn't apply past the first
3294 headline encountered.
3296 Optional argument MINLEVEL, when non-nil, is an integer
3297 specifying the level that any top-level headline in the included
3298 file should have."
3314 ;; Remove blank lines at beginning and end of contents. The logic
3315 ;; behind that removal is that blank lines around include keyword
3316 ;; override blank lines in included file.
3325 ;; If IND is set, preserve indentation of include keyword until
3326 ;; the first headline encountered.
3333 ;; Do not move footnote definitions out of column 0.
3339 ;; When MINLEVEL is specified, compute minimal level for headlines
3340 ;; in the file (CUR-MIN), and remove stars to each headline so
3341 ;; that headlines with minimal level have a level of MINLEVEL.
3352 ;; Only change stars, don't bother moving whole
3353 ;; sections.
3360 "Execute every Babel code in the visible part of current buffer."
3361 ;; Get a pristine copy of current buffer so Babel references can be
3362 ;; properly resolved.
3369 "Return a non-nil value when output should be added to the kill ring.
3370 See also `org-export-copy-to-kill-ring'."
3376 \f
3377 ;;; Tools For Back-Ends
3378 ;;
3379 ;; A whole set of tools is available to help build new exporters. Any
3380 ;; function general enough to have its use across many back-ends
3381 ;; should be added here.
3383 ;;;; For Affiliated Keywords
3384 ;;
3385 ;; `org-export-read-attribute' reads a property from a given element
3386 ;; as a plist. It can be used to normalize affiliated keywords'
3387 ;; syntax.
3388 ;;
3389 ;; Since captions can span over multiple lines and accept dual values,
3390 ;; their internal representation is a bit tricky. Therefore,
3391 ;; `org-export-get-caption' transparently returns a given element's
3392 ;; caption as a secondary string.
3395 "Turn ATTRIBUTE property from ELEMENT into a plist.
3397 When optional argument PROPERTY is non-nil, return the value of
3398 that property within attributes.
3402 properties.
3404 All values will become strings except the empty string and
3407 will become the empty string."
3421 s)
3426 ;; Ignore any string before first property with `cdr'.
3431 "Return caption from ELEMENT as a secondary string.
3433 When optional argument SHORTP is non-nil, return short caption,
3434 as a secondary string, instead.
3436 Caption lines are separated by a white space."
3444 ;;;; For Derived Back-ends
3445 ;;
3446 ;; `org-export-with-backend' is a function allowing to locally use
3447 ;; another back-end to transcode some object or element. In a derived
3448 ;; back-end, it may be used as a fall-back function once all specific
3449 ;; cases have been treated.
3452 "Call a transcoder from BACKEND on DATA.
3453 BACKEND is an export back-end, as returned by, e.g.,
3454 `org-export-create-backend', or a symbol referring to
3455 a registered back-end. DATA is an Org element, object, secondary
3456 string or string. CONTENTS, when non-nil, is the transcoded
3457 contents of DATA element, as a string. INFO, when non-nil, is
3458 the communication channel used for export, as a plist."
3468 transcoder data contents
3471 :translate-alist all-transcoders
3475 ;;;; For Export Snippets
3476 ;;
3477 ;; Every export snippet is transmitted to the back-end. Though, the
3478 ;; latter will only retain one type of export-snippet, ignoring
3479 ;; others, based on the former's target back-end. The function
3480 ;; `org-export-snippet-backend' returns that back-end for a given
3481 ;; export-snippet.
3484 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3485 Translation, with `org-export-snippet-translation-alist', is
3486 applied."
3490 back-end))))
3493 ;;;; For Footnotes
3494 ;;
3495 ;; `org-export-collect-footnote-definitions' is a tool to list
3496 ;; actually used footnotes definitions in the whole parse tree, or in
3497 ;; a headline, in order to add footnote listings throughout the
3498 ;; transcoded data.
3499 ;;
3500 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3501 ;; back-ends, when they need to attach the footnote definition only to
3502 ;; the first occurrence of the corresponding label.
3503 ;;
3504 ;; `org-export-get-footnote-definition' and
3505 ;; `org-export-get-footnote-number' provide easier access to
3506 ;; additional information relative to a footnote reference.
3509 "Return an alist between footnote numbers, labels and definitions.
3511 DATA is the parse tree from which definitions are collected.
3512 INFO is the plist used as a communication channel.
3514 Definitions are sorted by order of references. They either
3515 appear as Org data or as a secondary string for inlined
3516 footnotes. Unreferenced definitions are ignored."
3518 collect-fn ; for byte-compiler.
3522 ;; Collect footnote number, label and definition in DATA.
3530 def)
3531 num-alist)
3532 ;; Also search in definition for nested footnotes.
3535 ;; Don't enter footnote definitions since it will happen
3536 ;; when their first reference is found.
3542 "Non-nil when a footnote reference is the first one for its label.
3544 FOOTNOTE-REFERENCE is the footnote reference being considered.
3545 INFO is the plist used as a communication channel."
3547 ;; Anonymous footnotes are always a first reference.
3549 ;; Otherwise, return the first footnote with the same LABEL and
3550 ;; test if it is equal to FOOTNOTE-REFERENCE.
3560 ;; If FN isn't inlined, be sure to traverse its
3561 ;; definition before resuming search. See
3562 ;; comments in `org-export-get-footnote-number'
3563 ;; for more information.
3567 ;; Don't enter footnote definitions since it will
3568 ;; happen when their first reference is found.
3571 footnote-reference)))))
3574 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3575 INFO is the plist used as a communication channel. If no such
3577 string."
3584 "Return number associated to a footnote.
3586 FOOTNOTE is either a footnote reference or a footnote definition.
3587 INFO is the plist used as a communication channel."
3589 seen-refs
3590 search-ref ; For byte-compiler.
3594 ;; Search footnote references through DATA, filling
3595 ;; SEEN-REFS along the way.
3600 ;; Anonymous footnote match: return number.
3603 ;; Labels match: return number.
3606 ;; Anonymous footnote: it's always a new one.
3607 ;; Also, be sure to return nil from the `cond' so
3608 ;; `first-match' doesn't get us out of the loop.
3610 ;; Label not seen so far: add it so SEEN-REFS.
3611 ;;
3612 ;; Also search for subsequent references in
3613 ;; footnote definition so numbering follows
3614 ;; reading logic. Note that we don't have to care
3615 ;; about inline definitions, since
3616 ;; `org-element-map' already traverses them at the
3617 ;; right time.
3618 ;;
3619 ;; Once again, return nil to stay in the loop.
3624 nil))))
3625 ;; Don't enter footnote definitions since it will
3626 ;; happen when their first reference is found.
3631 ;;;; For Headlines
3632 ;;
3633 ;; `org-export-get-relative-level' is a shortcut to get headline
3634 ;; level, relatively to the lower headline level in the parsed tree.
3635 ;;
3636 ;; `org-export-get-headline-number' returns the section number of an
3637 ;; headline, while `org-export-number-to-roman' allows to convert it
3638 ;; to roman numbers.
3639 ;;
3640 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3641 ;; `org-export-last-sibling-p' are three useful predicates when it
3642 ;; comes to fulfill the `:headline-levels' property.
3643 ;;
3644 ;; `org-export-get-tags', `org-export-get-category' and
3645 ;; `org-export-get-node-property' extract useful information from an
3646 ;; headline or a parent headline. They all handle inheritance.
3647 ;;
3648 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3649 ;; as a secondary string, suitable for table of contents. It falls
3650 ;; back onto default title.
3653 "Return HEADLINE relative level within current parsed tree.
3654 INFO is a plist holding contextual information."
3659 "Non-nil when HEADLINE is considered as low level.
3661 INFO is a plist used as a communication channel.
3663 A low level headlines has a relative level greater than
3664 `:headline-levels' property value.
3666 Return value is the difference between HEADLINE relative level
3667 and the last level being considered as high enough, or nil."
3674 "Return HEADLINE numbering as a list of numbers.
3675 INFO is a plist holding contextual information."
3679 "Return a non-nil value if HEADLINE element should be numbered.
3680 INFO is a plist used as a communication channel."
3686 "Convert integer N into a roman numeral."
3699 res)))
3702 "Return list of tags associated to ELEMENT.
3704 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3705 is a plist used as a communication channel.
3707 Select tags (see `org-export-select-tags') and exclude tags (see
3708 `org-export-exclude-tags') are removed from the list.
3710 When non-nil, optional argument TAGS should be a list of strings.
3711 Any tag belonging to this list will also be removed.
3713 When optional argument INHERITED is non-nil, tags can also be
3714 inherited from parent headlines and FILETAGS keywords."
3720 ;; Build complete list of inherited tags.
3731 ;; Add FILETAGS keywords and return results.
3735 "Return node PROPERTY value for BLOB.
3737 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3738 element or object.
3740 If optional argument INHERITED is non-nil, the value can be
3741 inherited from a parent headline.
3743 Return value is a string or nil."
3755 "Return category for element or object BLOB.
3757 INFO is a plist used as a communication channel.
3759 CATEGORY is automatically inherited from a parent headline, from
3760 #+CATEGORY: keyword or created out of original file name. If all
3764 ;; Almost like `org-export-node-property', but we cannot trust
3765 ;; `plist-member' as every headline has a `:CATEGORY'
3766 ;; property, would it be nil or equal to "???" (which has the
3767 ;; same meaning).
3785 "Return alternative title for HEADLINE, as a secondary string.
3786 INFO is a plist used as a communication channel. If no optional
3787 title is defined, fall-back to the regular title."
3792 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3793 INFO is a plist used as a communication channel."
3798 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3799 INFO is a plist used as a communication channel."
3803 ;;;; For Keywords
3804 ;;
3805 ;; `org-export-get-date' returns a date appropriate for the document
3806 ;; to about to be exported. In particular, it takes care of
3807 ;; `org-export-date-timestamp-format'.
3810 "Return date value for the current document.
3812 INFO is a plist used as a communication channel. FMT, when
3813 non-nil, is a time format string that will be applied on the date
3814 if it consists in a single timestamp object. It defaults to
3815 `org-export-date-timestamp-format' when nil.
3817 A proper date can be a secondary string, a string or nil. It is
3818 meant to be translated with `org-export-data' or alike."
3829 ;;;; For Links
3830 ;;
3831 ;; `org-export-solidify-link-text' turns a string into a safer version
3832 ;; for links, replacing most non-standard characters with hyphens.
3833 ;;
3834 ;; `org-export-get-coderef-format' returns an appropriate format
3835 ;; string for coderefs.
3836 ;;
3837 ;; `org-export-inline-image-p' returns a non-nil value when the link
3838 ;; provided should be considered as an inline image.
3839 ;;
3840 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3841 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3842 ;; returns an appropriate unique identifier when found, or nil.
3843 ;;
3844 ;; `org-export-resolve-id-link' returns the first headline with
3845 ;; specified id or custom-id in parse tree, the path to the external
3846 ;; file with the id or nil when neither was found.
3847 ;;
3848 ;; `org-export-resolve-coderef' associates a reference to a line
3849 ;; number in the element it belongs, or returns the reference itself
3850 ;; when the element isn't numbered.
3853 "Take link text S and make a safe target out of it."
3858 "Return format string for code reference link.
3859 PATH is the link path. DESC is its description."
3867 "Non-nil if LINK object points to an inline image.
3869 Optional argument is a set of RULES defining inline images. It
3870 is an alist where associations have the following shape:
3872 \(TYPE . REGEXP)
3874 Applying a rule means apply REGEXP against LINK's path when its
3875 type is TYPE. The function will return a non-nil value if any of
3876 the provided rules is non-nil. The default rule is
3877 `org-export-default-inline-image-rule'.
3879 This only applies to links without a description."
3890 rules)
3891 ;; Return nil if no rule matched.
3892 nil))))
3895 "Resolve a code reference REF.
3897 INFO is a plist used as a communication channel.
3899 Return associated line number in source code, or REF itself,
3900 depending on src-block or example element's switches."
3907 org-coderef-label-format)))
3911 ;; Element containing REF is found. Resolve it to either
3912 ;; a label or a line number, as needed.
3922 "Return LINK destination.
3924 INFO is a plist holding contextual information.
3926 Return value can be an object, an element, or nil:
3928 - If LINK path matches a target object (i.e. <<path>>) return it.
3930 - If LINK path exactly matches the name affiliated keyword
3931 \(i.e. #+NAME: path) of an element, return that element.
3933 - If LINK path exactly matches any headline name, return that
3934 element. If more than one headline share that name, priority
3935 will be given to the one with the closest common ancestor, if
3936 any, or the first one in the parse tree otherwise.
3938 - Otherwise, return nil.
3941 significant."
3944 ;; Split PATH at white spaces so matches are space
3945 ;; insensitive.
3948 ;; Cache for destinations that are not position dependent.
3956 ;; Destination is not position dependent: use cached value.
3958 ;; First try to find a matching "<<path>>" unless user specified
3959 ;; he was looking for a headline (path starts with a "*"
3960 ;; character).
3966 path)
3967 blob))
3970 ;; Then try to find an element with a matching "#+NAME: path"
3971 ;; affiliated keyword.
3974 org-element-all-elements
3979 el)))
3982 ;; Last case: link either points to a headline or to nothingness.
3983 ;; Try to find the source, with priority given to headlines with
3984 ;; the closest common ancestor. If such candidate is found,
3985 ;; return it, otherwise return nil.
3989 ;; Return first headline whose `:raw-value' property is
3990 ;; NAME in parse tree DATA, or nil. Statistics cookies
3991 ;; are ignored.
3999 name)
4000 headline))
4002 ;; Search among headlines sharing an ancestor with link, from
4003 ;; closest to farthest.
4012 ;; No destination found: return nil.
4016 "Return headline referenced as LINK destination.
4018 INFO is a plist used as a communication channel.
4020 Return value can be the headline element matched in current parse
4024 ;; First check if id is within the current parse tree.
4029 headline))
4031 ;; Otherwise, look for external files.
4035 "Return radio-target object referenced as LINK destination.
4037 INFO is a plist used as a communication channel.
4039 Return value can be a radio-target object or nil. Assume LINK
4048 nil nil path nil nil t)
4049 t)
4050 radio))
4054 ;;;; For References
4055 ;;
4056 ;; `org-export-get-ordinal' associates a sequence number to any object
4057 ;; or element.
4060 "Return ordinal number of an element or object.
4062 ELEMENT is the element or object considered. INFO is the plist
4063 used as a communication channel.
4065 Optional argument TYPES, when non-nil, is a list of element or
4066 object types, as symbols, that should also be counted in.
4067 Otherwise, only provided element's type is considered.
4069 Optional argument PREDICATE is a function returning a non-nil
4070 value if the current element or object should be counted in. It
4071 accepts two arguments: the element or object being considered and
4072 the plist used as a communication channel. This allows to count
4073 only a certain type of objects (i.e. inline images).
4075 Return value is a list of numbers if ELEMENT is a headline or an
4076 item. It is nil for keywords. It represents the footnote number
4077 for footnote definitions and footnote references. If ELEMENT is
4078 a target, return the same value as if ELEMENT was the closest
4079 table, item or headline containing the target. In any other
4080 case, return the sequence number of ELEMENT among elements or
4081 objects of the same type."
4082 ;; Ordinal of a target object refer to the ordinal of the closest
4083 ;; table, item, or headline containing the object.
4087 when
4091 table))
4092 return parent)))
4094 ;; Special case 1: A headline returns its number as a list.
4096 ;; Special case 2: An item returns its number as a list.
4100 struct
4107 ;; Increment counter until ELEMENT is found again.
4118 ;;;; For Src-Blocks
4119 ;;
4120 ;; `org-export-get-loc' counts number of code lines accumulated in
4121 ;; src-block or example-block elements with a "+n" switch until
4122 ;; a given element, excluded. Note: "-n" switches reset that count.
4123 ;;
4124 ;; `org-export-unravel-code' extracts source code (along with a code
4125 ;; references alist) from an `element-block' or `src-block' type
4126 ;; element.
4127 ;;
4128 ;; `org-export-format-code' applies a formatting function to each line
4129 ;; of code, providing relative line number and code reference when
4130 ;; appropriate. Since it doesn't access the original element from
4131 ;; which the source code is coming, it expects from the code calling
4132 ;; it to know if lines should be numbered and if code references
4133 ;; should appear.
4134 ;;
4135 ;; Eventually, `org-export-format-code-default' is a higher-level
4136 ;; function (it makes use of the two previous functions) which handles
4137 ;; line numbering and code references inclusion, and returns source
4138 ;; code in a format suitable for plain text or verbatim output.
4141 "Return accumulated lines of code up to ELEMENT.
4143 INFO is the plist used as a communication channel.
4145 ELEMENT is excluded from count."
4151 ;; ELEMENT is reached: Quit the loop.
4153 ;; Only count lines from src-block and example-block elements
4154 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4158 ;; Accumulate locs or reset them.
4162 ;; Return nil to stay in the loop.
4163 nil)))
4165 ;; Return value.
4166 loc))
4169 "Clean source code and extract references out of it.
4171 ELEMENT has either a `src-block' an `example-block' type.
4173 Return a cons cell whose CAR is the source code, cleaned from any
4174 reference and protective comma and CDR is an alist between
4175 relative line number (integer) and name of code reference on that
4176 line (string)."
4178 ;; Get code and clean it. Remove blank lines at its
4179 ;; beginning and end.
4185 ;; Get format used for references.
4188 org-coderef-label-format)))
4189 ;; Build a regexp matching a loc with a reference.
4194 ;; Return value.
4196 ;; Code with references removed.
4202 ;; Ref line: remove ref, and signal its position in REFS.
4206 ;; Reference alist.
4207 refs)))
4210 "Format CODE by applying FUN line-wise and return it.
4212 CODE is a string representing the code to format. FUN is
4213 a function. It must accept three arguments: a line of
4214 code (string), the current line number (integer) or nil and the
4215 reference associated to the current line (string) or nil.
4217 Optional argument NUM-LINES can be an integer representing the
4218 number of code lines accumulated until the current code. Line
4219 numbers passed to FUN will take it into account. If it is nil,
4220 FUN's second argument will always be nil. This number can be
4221 obtained with `org-export-get-loc' function.
4223 Optional argument REF-ALIST can be an alist between relative line
4224 number (i.e. ignoring NUM-LINES) and the name of the code
4225 reference on it. If it is nil, FUN's third argument will always
4226 be nil. It can be obtained through the use of
4227 `org-export-unravel-code' function."
4239 "Return source code from ELEMENT, formatted in a standard way.
4241 ELEMENT is either a `src-block' or `example-block' element. INFO
4242 is a plist used as a communication channel.
4244 This function takes care of line numbering and code references
4245 inclusion. Line numbers, when applicable, appear at the
4246 beginning of the line, separated from the code by two white
4247 spaces. Code references, on the other hand, appear flushed to
4248 the right, separated by six white spaces from the widest line of
4249 code."
4250 ;; Extract code and references.
4257 ;; Handle line numbering.
4266 ;; Prepare references display, if required. Any reference
4267 ;; should start six columns after the widest line of code,
4268 ;; wrapped with parenthesis.
4273 code
4277 number-str
4278 loc
4284 num-start refs)))))
4287 ;;;; For Tables
4288 ;;
4289 ;; `org-export-table-has-special-column-p' and and
4290 ;; `org-export-table-row-is-special-p' are predicates used to look for
4291 ;; meta-information about the table structure.
4292 ;;
4293 ;; `org-table-has-header-p' tells when the rows before the first rule
4294 ;; should be considered as table's header.
4295 ;;
4296 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4297 ;; and `org-export-table-cell-borders' extract information from
4298 ;; a table-cell element.
4299 ;;
4300 ;; `org-export-table-dimensions' gives the number on rows and columns
4301 ;; in the table, ignoring horizontal rules and special columns.
4302 ;; `org-export-table-cell-address', given a table-cell object, returns
4303 ;; the absolute address of a cell. On the other hand,
4304 ;; `org-export-get-table-cell-at' does the contrary.
4305 ;;
4306 ;; `org-export-table-cell-starts-colgroup-p',
4307 ;; `org-export-table-cell-ends-colgroup-p',
4308 ;; `org-export-table-row-starts-rowgroup-p',
4309 ;; `org-export-table-row-ends-rowgroup-p',
4310 ;; `org-export-table-row-starts-header-p' and
4311 ;; `org-export-table-row-ends-header-p' indicate position of current
4312 ;; row or cell within the table.
4315 "Non-nil when TABLE has a special column.
4316 All special columns will be ignored during export."
4317 ;; The table has a special column when every first cell of every row
4318 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4319 ;; "*" "_" and "^". Though, do not consider a first row containing
4320 ;; only empty cells as special.
4336 "Non-nil when TABLE has a header.
4338 INFO is a plist used as a communication channel.
4340 A table has a header when it contains at least two row groups."
4349 table
4360 cache)))))
4363 "Non-nil if TABLE-ROW is considered special.
4365 INFO is a plist used as the communication channel.
4367 All special rows will be ignored during export."
4371 ;; A row is special either when...
4373 ;; ... it starts with a field only containing "/",
4375 ;; ... the table contains a special column and the row start
4376 ;; with a marking character among, "^", "_", "$" or "!",
4380 ;; ... it contains only alignment cookies and empty cells.
4386 ;; Since VALUE is a secondary string, the following
4387 ;; checks avoid expanding it with `org-export-data'.
4399 "Return TABLE-ROW's group number, as an integer.
4401 INFO is a plist used as the communication channel.
4403 Return value is the group number, as an integer, or nil for
4404 special rows and rows separators. First group is also table's
4405 header."
4423 "Return TABLE-CELL contents width.
4425 INFO is a plist used as the communication channel.
4427 Return value is the width given by the last width cookie in the
4428 same column as TABLE-CELL, or nil."
4447 ;; In a special row, try to find a width cookie at COLUMN.
4451 ;; The following checks avoid expanding unnecessarily
4452 ;; the cell with `org-export-data'.
4462 "Return TABLE-CELL contents alignment.
4464 INFO is a plist used as the communication channel.
4466 Return alignment as specified by the last alignment cookie in the
4467 same column as TABLE-CELL. If no such cookie is found, a default
4468 alignment value will be deduced from fraction of numbers in the
4469 column (see `org-table-number-fraction' for more information).
4470 Possible values are `left', `right' and `center'."
4471 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4488 cookie-align
4489 previous-cell-number-p)
4492 ;; In a special row, try to find an alignment cookie at
4493 ;; COLUMN.
4497 ;; Since VALUE is a secondary string, the following
4498 ;; checks avoid useless expansion through
4499 ;; `org-export-data'.
4507 ;; Ignore table rules.
4509 ;; In a standard row, check if cell's contents are
4510 ;; expressing some kind of number. Increase NUMBER-CELLS
4511 ;; accordingly. Though, don't bother if an alignment
4512 ;; cookie has already defined cell's alignment.
4517 info)))
4519 ;; Treat an empty cell as a number if it follows
4520 ;; a number.
4526 ;; Return value. Alignment specified by cookies has
4527 ;; precedence over alignment deduced from cell's contents.
4529 column
4534 org-table-number-fraction)
4539 "Return TABLE-CELL borders.
4541 INFO is a plist used as a communication channel.
4543 Return value is a list of symbols, or nil. Possible values are:
4544 `top', `bottom', `above', `below', `left' and `right'. Note:
4545 `top' (resp. `bottom') only happen for a cell in the first
4546 row (resp. last row) of the table, ignoring table rules, if any.
4548 Returned borders ignore special rows."
4551 borders)
4552 ;; Top/above border? TABLE-CELL has a border above when a rule
4553 ;; used to demarcate row groups can be found above. Hence,
4554 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4555 ;; another regular row has to be found above that rule.
4564 ;; Look at every row before the current one.
4566 ;; No rule above, or rule found starts the table (ignoring any
4567 ;; special row): TABLE-CELL is at the top of the table.
4570 ;; Bottom/below border? TABLE-CELL has a border below when next
4571 ;; non-regular row below is a rule.
4580 ;; Look at every row after the current one.
4582 ;; No rule below, or rule found ends the table (modulo some
4583 ;; special row): TABLE-CELL is at the bottom of the table.
4586 ;; Right/left borders? They can only be specified by column
4587 ;; groups. Column groups are defined in a row starting with "/".
4588 ;; Also a column groups row only contains "<", "<>", ">" or blank
4589 ;; cells.
4606 ;; There's a left border when previous cell, if
4607 ;; any, ends a group, or current one starts one.
4613 ;; There's a right border when next cell, if any,
4614 ;; starts a group, or current one ends one.
4621 ;; Table rows are read in reverse order so last column groups
4622 ;; row has precedence over any previous one.
4624 ;; Return value.
4625 borders))
4628 "Non-nil when TABLE-CELL is at the beginning of a row group.
4629 INFO is a plist used as a communication channel."
4630 ;; A cell starts a column group either when it is at the beginning
4631 ;; of a row (or after the special column, if any) or when it has
4632 ;; a left border.
4635 table-cell)
4639 "Non-nil when TABLE-CELL is at the end of a row group.
4640 INFO is a plist used as a communication channel."
4641 ;; A cell ends a column group either when it is at the end of a row
4642 ;; or when it has a right border.
4645 table-cell)
4649 "Non-nil when TABLE-ROW is at the beginning of a column group.
4650 INFO is a plist used as a communication channel."
4658 "Non-nil when TABLE-ROW is at the end of a column group.
4659 INFO is a plist used as a communication channel."
4667 "Non-nil when TABLE-ROW is the first table header's row.
4668 INFO is a plist used as a communication channel."
4675 "Non-nil when TABLE-ROW is the last table header's row.
4676 INFO is a plist used as a communication channel."
4683 "Return TABLE-ROW number.
4684 INFO is a plist used as a communication channel. Return value is
4685 zero-based and ignores separators. The function returns nil for
4686 special columns and separators."
4698 "Return TABLE dimensions.
4700 INFO is a plist used as a communication channel.
4702 Return value is a CONS like (ROWS . COLUMNS) where
4703 ROWS (resp. COLUMNS) is the number of exportable
4704 rows (resp. columns)."
4706 ;; Set number of rows, and extract first one.
4712 ;; Set number of columns.
4714 ;; Return value.
4718 "Return address of a regular TABLE-CELL object.
4720 TABLE-CELL is the cell considered. INFO is a plist used as
4721 a communication channel.
4723 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4724 zero-based index. Only exportable cells are considered. The
4725 function returns nil for other cells."
4737 "Return regular table-cell object at ADDRESS in TABLE.
4739 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4740 zero-based index. TABLE is a table type element. INFO is
4741 a plist used as a communication channel.
4743 If no table-cell, among exportable cells, is found at ADDRESS,
4744 return nil."
4747 ;; Row at (car address) or nil.
4755 'table-cell
4762 ;;;; For Tables Of Contents
4763 ;;
4764 ;; `org-export-collect-headlines' builds a list of all exportable
4765 ;; headline elements, maybe limited to a certain depth. One can then
4766 ;; easily parse it and transcode it.
4767 ;;
4768 ;; Building lists of tables, figures or listings is quite similar.
4769 ;; Once the generic function `org-export-collect-elements' is defined,
4770 ;; `org-export-collect-tables', `org-export-collect-figures' and
4771 ;; `org-export-collect-listings' can be derived from it.
4774 "Collect headlines in order to build a table of contents.
4776 INFO is a plist used as a communication channel.
4778 When optional argument N is an integer, it specifies the depth of
4779 the table of contents. Otherwise, it is set to the value of the
4780 last headline level. See `org-export-headline-levels' for more
4781 information.
4783 Return a list of all exportable headlines as parsed elements.
4784 Footnote sections, if any, will be ignored."
4792 info)))
4795 "Collect referenceable elements of a determined type.
4797 TYPE can be a symbol or a list of symbols specifying element
4798 types to search. Only elements with a caption are collected.
4800 INFO is a plist used as a communication channel.
4802 When non-nil, optional argument PREDICATE is a function accepting
4803 one argument, an element of type TYPE. It returns a non-nil
4804 value when that element should be collected.
4806 Return a list of all elements found, in order of appearance."
4811 element))
4812 info))
4815 "Build a list of tables.
4816 INFO is a plist used as a communication channel.
4818 Return a list of table elements with a caption."
4822 "Build a list of figures.
4824 INFO is a plist used as a communication channel. PREDICATE is
4825 a function which accepts one argument: a paragraph element and
4826 whose return value is non-nil when that element should be
4827 collected.
4829 A figure is a paragraph type element, with a caption, verifying
4831 a vague concept that may depend on back-end.
4833 Return a list of elements recognized as figures."
4837 "Build a list of src blocks.
4839 INFO is a plist used as a communication channel.
4841 Return a list of src-block elements with a caption."
4845 ;;;; Smart Quotes
4846 ;;
4847 ;; The main function for the smart quotes sub-system is
4848 ;; `org-export-activate-smart-quotes', which replaces every quote in
4849 ;; a given string from the parse tree with its "smart" counterpart.
4850 ;;
4851 ;; Dictionary for smart quotes is stored in
4852 ;; `org-export-smart-quotes-alist'.
4853 ;;
4854 ;; Internally, regexps matching potential smart quotes (checks at
4855 ;; string boundaries are also necessary) are defined in
4856 ;; `org-export-smart-quotes-regexps'.
4860 ;; one may use: »...«, "...", ›...‹, or '...'.
4861 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4862 ;; LaTeX quotes require Babel!
4907 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4916 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4925 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4934 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4940 )
4941 "Smart quotes translations.
4943 Alist whose CAR is a language string and CDR is an alist with
4944 quote type as key and a plist associating various encodings to
4945 their translation as value.
4947 A quote type can be any symbol among `opening-double-quote',
4948 `closing-double-quote', `opening-single-quote',
4949 `closing-single-quote' and `apostrophe'.
4951 Valid encodings include `:utf-8', `:html', `:latex' and
4952 `:texinfo'.
4958 ;; Possible opening quote at beginning of string.
4960 ;; Possible closing quote at beginning of string.
4962 ;; Possible apostrophe at beginning of string.
4964 ;; Opening single and double quotes.
4966 ;; Closing single and double quotes.
4968 ;; Apostrophe.
4970 ;; Possible opening quote at end of string.
4972 ;; Possible closing quote at end of string.
4974 ;; Possible apostrophe at end of string.
4976 "List of regexps matching a quote or an apostrophe.
4982 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4983 `:utf-8'. INFO is a plist used as a communication channel.
4985 The function has to retrieve information about string
4986 surroundings in parse tree. It can only happen with an
4987 unmodified string. Thus, if S has already been through another
4988 process, a non-nil ORIGINAL optional argument will provide that
4989 original string.
4991 Return the new string."
4994 ;; Try to be flexible when computing number of blanks
4995 ;; before object. The previous object may be a string
4996 ;; introduced by the back-end and not completely parsed.
4999 ;; A string with missing `:post-blank'
5000 ;; property.
5004 ;; Fallback value.
5009 ;; Return smart quote associated to a give quote Q, as
5010 ;; a string. TYPE is a symbol among `open', `close' and
5011 ;; `apostrophe'.
5021 org-export-smart-quotes-alist))))
5022 encoding)
5023 q)))))
5025 ;; Only a quote: no regexp can match. We have to check both
5026 ;; sides and decide what to do.
5034 ;; 1. Replace quote character at the beginning of S.
5036 ;; Apostrophe?
5042 ;; Closing quote?
5048 ;; Opening quote?
5054 ;; 2. Replace quotes in the middle of the string.
5056 ;; Opening quotes.
5062 ;; Closing quotes.
5068 ;; Apostrophes.
5073 ;; 3. Replace quote character at the end of S.
5075 ;; Apostrophe?
5080 ;; Closing quote?
5086 ;; Opening quote?
5091 ;; Return string with smart quotes.
5092 s))))
5094 ;;;; Topology
5095 ;;
5096 ;; Here are various functions to retrieve information about the
5097 ;; neighborhood of a given element or object. Neighbors of interest
5098 ;; are direct parent (`org-export-get-parent'), parent headline
5099 ;; (`org-export-get-parent-headline'), first element containing an
5100 ;; object, (`org-export-get-parent-element'), parent table
5101 ;; (`org-export-get-parent-table'), previous element or object
5102 ;; (`org-export-get-previous-element') and next element or object
5103 ;; (`org-export-get-next-element').
5104 ;;
5105 ;; `org-export-get-genealogy' returns the full genealogy of a given
5106 ;; element or object, from closest parent to full parse tree.
5109 "Return BLOB parent or nil.
5110 BLOB is the element or object considered."
5114 "Return full genealogy relative to a given element or object.
5116 BLOB is the element or object being considered.
5118 Ancestors are returned from closest to farthest, the last one
5119 being the full parse tree."
5126 "Return BLOB parent headline or nil.
5127 BLOB is the element or object being considered."
5131 parent))
5134 "Return first element containing OBJECT or nil.
5135 OBJECT is the object to consider."
5139 parent))
5142 "Return OBJECT parent table or nil.
5143 OBJECT is either a `table-cell' or `table-element' type object."
5147 parent))
5150 "Return previous element or object.
5152 BLOB is an element or object. INFO is a plist used as
5153 a communication channel. Return previous exportable element or
5154 object, a string, or nil.
5156 When optional argument N is a positive integer, return a list
5157 containing up to N siblings before BLOB, from farthest to
5158 closest. With any other non-nil value, return a list containing
5159 all of them."
5161 ;; An object can belong to the contents of its parent or
5162 ;; to a secondary string. We check the latter option
5163 ;; first.
5167 org-element-secondary-value-alist))
5168 parent)))
5171 prev)
5180 prev)))
5183 "Return next element or object.
5185 BLOB is an element or object. INFO is a plist used as
5186 a communication channel. Return next exportable element or
5187 object, a string, or nil.
5189 When optional argument N is a positive integer, return a list
5190 containing up to N siblings after BLOB, from closest to farthest.
5191 With any other non-nil value, return a list containing all of
5192 them."
5194 ;; An object can belong to the contents of its parent or to
5195 ;; a secondary string. We check the latter option first.
5199 org-element-secondary-value-alist))
5200 parent)))
5203 next)
5211 siblings)
5215 ;;;; Translation
5216 ;;
5217 ;; `org-export-translate' translates a string according to the language
5218 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5219 ;; the dictionary used for the translation.
5403 "Dictionary for export engine.
5405 Alist whose CAR is the string to translate and CDR is an alist
5406 whose CAR is the language string and CDR is a plist whose
5407 properties are possible charsets and values translated terms.
5409 It is used as a database for `org-export-translate'. Since this
5410 function returns the string as-is if no translation was found,
5411 the variable only needs to record values different from the
5415 "Translate string S according to language specification.
5417 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5418 and `:utf-8'. INFO is a plist used as a communication channel.
5420 Translation depends on `:language' property. Return the
5421 translated string. If no translation is found, try to fall back
5422 to `:default' encoding. If it fails, return S."
5428 s)))
5431 \f
5432 ;;; Asynchronous Export
5433 ;;
5434 ;; `org-export-async-start' is the entry point for asynchronous
5435 ;; export. It recreates current buffer (including visibility,
5436 ;; narrowing and visited file) in an external Emacs process, and
5437 ;; evaluates a command there. It then applies a function on the
5438 ;; returned results in the current process.
5439 ;;
5440 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5441 ;; allow to export to a buffer or a file, asynchronously or not.
5442 ;;
5443 ;; `org-export-output-file-name' is an auxiliary function meant to be
5444 ;; used with `org-export-to-file'. With a given extension, it tries
5445 ;; to provide a canonical file name to write export output to.
5446 ;;
5447 ;; Asynchronously generated results are never displayed directly.
5448 ;; Instead, they are stored in `org-export-stack-contents'. They can
5449 ;; then be retrieved by calling `org-export-stack'.
5450 ;;
5451 ;; Export Stack is viewed through a dedicated major mode
5452 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5453 ;;`org-export-stack-delete', `org-export-stack-view' and
5454 ;;`org-export-stack-clear'.
5455 ;;
5456 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5457 ;; It should be used whenever `org-export-async-start' is called.
5460 "Call function FUN on the results returned by BODY evaluation.
5462 BODY evaluation happens in an asynchronous process, from a buffer
5463 which is an exact copy of the current one.
5465 Use `org-export-add-to-stack' in FUN in order to register results
5466 in the stack.
5468 This is a low level function. See also `org-export-to-buffer'
5469 and `org-export-to-file' for more specialized functions."
5472 ;; Write the full sexp evaluating BODY in a copy of the current
5473 ;; buffer to a temporary file, as it may be too long for program
5474 ;; args in `start-process'.
5481 ;; Null characters (from variable values) are inserted
5482 ;; within the file. As a consequence, coding system for
5483 ;; buffer contents will not be recognized properly. So,
5484 ;; we make sure it is the same as the one used to display
5485 ;; the original buffer.
5487 ,coding
5490 ;; Ignore `kill-emacs-hook' and code evaluation
5491 ;; queries from Babel as we need a truly
5492 ;; non-interactive process.
5494 org-babel-confirm-evaluate-answer-no t)
5495 ;; Initialize export framework.
5497 ;; Re-create current buffer there.
5500 ;; Sexp to evaluate in the buffer.
5502 ;; Start external process.
5505 (,process
5510 "-l" org-export-async-init-file
5512 ;; Register running process in stack.
5514 ;; Set-up sentinel in order to catch results.
5517 ,process
5539 ;;;###autoload
5542 &optional async subtreep visible-only body-only ext-plist
5543 post-process)
5544 "Call `org-export-as' with output to a specified buffer.
5546 BACKEND is either an export back-end, as returned by, e.g.,
5547 `org-export-create-backend', or a symbol referring to
5548 a registered back-end.
5550 BUFFER is the name of the output buffer. If it already exists,
5551 it will be erased first, otherwise, it will be created.
5553 A non-nil optional argument ASYNC means the process should happen
5554 asynchronously. The resulting buffer should then be accessible
5555 through the `org-export-stack' interface. When ASYNC is nil, the
5556 buffer is displayed if `org-export-show-temporary-export-buffer'
5557 is non-nil.
5559 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5560 EXT-PLIST are similar to those used in `org-export-as', which
5561 see.
5563 Optional argument POST-PROCESS is a function which should accept
5564 no argument. It is always called within the current process,
5565 from BUFFER, with point at its beginning. Export back-ends can
5566 use it to set a major mode there, e.g,
5568 \(defun org-latex-export-as-latex
5569 \(&optional async subtreep visible-only body-only ext-plist)
5570 \(interactive)
5572 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5574 This function returns BUFFER."
5602 buffer)))
5604 ;;;###autoload
5607 post-process)
5608 "Call `org-export-as' with output to a specified file.
5610 BACKEND is either an export back-end, as returned by, e.g.,
5611 `org-export-create-backend', or a symbol referring to
5612 a registered back-end. FILE is the name of the output file, as
5613 a string.
5615 A non-nil optional argument ASYNC means the process should happen
5616 asynchronously. The resulting buffer will then be accessible
5617 through the `org-export-stack' interface.
5619 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5620 EXT-PLIST are similar to those used in `org-export-as', which
5621 see.
5623 Optional argument POST-PROCESS is called with FILE as its
5624 argument and happens asynchronously when ASYNC is non-nil. It
5625 has to return a file name, or nil. Export back-ends can use this
5626 to send the output file through additional processing, e.g,
5628 \(defun org-latex-export-to-latex
5629 \(&optional async subtreep visible-only body-only ext-plist)
5630 \(interactive)
5632 \(org-export-to-file 'latex outfile
5633 async subtreep visible-only body-only ext-plist
5634 \(lambda (file) (org-latex-compile file)))
5636 The function returns either a file name returned by POST-PROCESS,
5637 or FILE."
5655 backend subtreep visible-only body-only ext-plist)))
5662 ;; Get proper return value.
5664 file))))))
5667 "Return output file's name according to buffer specifications.
5669 EXTENSION is a string representing the output file extension,
5670 with the leading dot.
5672 With a non-nil optional argument SUBTREEP, try to determine
5674 of subtree at point.
5676 When optional argument PUB-DIR is set, use it as the publishing
5677 directory.
5679 When optional argument VISIBLE-ONLY is non-nil, don't export
5680 contents of hidden elements.
5682 Return file name as a string."
5685 ;; File name may come from EXPORT_FILE_NAME subtree
5686 ;; property, assuming point is at beginning of said
5687 ;; sub-tree.
5694 ;; File name may be extracted from buffer's associated
5695 ;; file, if any.
5697 ;; Can't determine file name on our own: Ask user.
5701 "Output file: " pub-dir nil nil nil
5705 ;; Build file name. Enforce EXTENSION over whatever user
5706 ;; may have come up with. PUB-DIR, if defined, always has
5707 ;; precedence over any provided path.
5712 extension))
5715 ;; If writing to OUTPUT-FILE would overwrite original file, append
5716 ;; EXTENSION another time to final name.
5719 output-file)))
5722 "Add a new result to export stack if not present already.
5724 SOURCE is a buffer or a file name containing export results.
5725 BACKEND is a symbol representing export back-end used to generate
5726 it.
5728 Entries already pointing to SOURCE and unavailable entries are
5729 removed beforehand. Return the new stack."
5735 "Menu for asynchronous export results and running processes."
5745 "Return source from export results at point in stack."
5752 source
5753 ;; SOURCE is not consistent with current line. The stack
5754 ;; view is outdated.
5758 "Remove all entries from export stack."
5763 "Refresh the asynchronous export stack.
5764 DUMMY is ignored. Unavailable sources are removed from the list.
5765 Return the new stack."
5775 ;; Back-end.
5777 ;; Age.
5780 ;; Compute age of the results.
5782 "%4h:%.2m "
5784 ;; Source.
5789 ;; Clear stack from exited processes, dead buffers or
5790 ;; non-existent files.
5802 "Remove export results at point from stack.
5803 If optional argument SOURCE is non-nil, remove it instead."
5808 org-export-stack-contents))))
5811 "View export results at point in stack.
5812 With an optional prefix argument IN-EMACS, force viewing files
5813 within Emacs."
5827 (define-key km "p" 'previous-line)
5828 (define-key km "\C-p" 'previous-line)
5829 (define-key km "\C-?" 'previous-line)
5830 (define-key km [up] 'previous-line)
5831 (define-key km "C" 'org-export-stack-clear)
5832 (define-key km "v" 'org-export-stack-view)
5833 (define-key km (kbd "RET") 'org-export-stack-view)
5834 (define-key km "d" 'org-export-stack-remove)
5835 km)
5836 "Keymap for Org Export Stack.")
5838 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5839 "Mode for displaying asynchronous export stack.
5842 stack.
5844 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5845 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5846 stack completely.
5848 Removing entries in an Org Export Stack buffer doesn't affect
5849 files or buffers, only the display.
5852 (abbrev-mode 0)
5853 (auto-fill-mode 0)
5854 (setq buffer-read-only t
5855 buffer-undo-list t
5856 truncate-lines t
5857 header-line-format
5858 '(:eval
5859 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5860 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5861 (set (make-local-variable 'revert-buffer-function)
5862 'org-export-stack-refresh))
5865 \f
5866 ;;; The Dispatcher
5867 ;;
5868 ;; `org-export-dispatch' is the standard interactive way to start an
5869 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5870 ;; for its interface, which, in turn, delegates response to key
5871 ;; pressed to `org-export--dispatch-action'.
5873 ;;;###autoload
5874 (defun org-export-dispatch (&optional arg)
5875 "Export dispatcher for Org mode.
5877 It provides an access to common export related tasks in a buffer.
5878 Its interface comes in two flavors: standard and expert.
5880 While both share the same set of bindings, only the former
5881 displays the valid keys associations in a dedicated buffer.
5882 Scrolling (resp. line-wise motion) in this buffer is done with
5883 SPC and DEL (resp. C-n and C-p) keys.
5885 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5886 flavor or the other.
5889 of options used back then, on the current buffer.
5891 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5892 (interactive "P")
5893 (let* ((input
5894 (cond ((equal arg '(16)) '(stack))
5895 ((and arg org-export-dispatch-last-action))
5896 (t (save-window-excursion
5897 (unwind-protect
5898 (progn
5899 ;; Remember where we are
5900 (move-marker org-export-dispatch-last-position
5901 (point)
5902 (org-base-buffer (current-buffer)))
5903 ;; Get and store an export command
5904 (setq org-export-dispatch-last-action
5905 (org-export--dispatch-ui
5906 (list org-export-initial-scope
5907 (and org-export-in-background 'async))
5908 nil
5909 org-export-dispatch-use-expert-ui)))
5910 (and (get-buffer "*Org Export Dispatcher*")
5911 (kill-buffer "*Org Export Dispatcher*")))))))
5912 (action (car input))
5913 (optns (cdr input)))
5914 (unless (memq 'subtree optns)
5915 (move-marker org-export-dispatch-last-position nil))
5916 (case action
5917 ;; First handle special hard-coded actions.
5918 (template (org-export-insert-default-template nil optns))
5919 (stack (org-export-stack))
5920 (publish-current-file
5921 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5922 (publish-current-project
5923 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5924 (publish-choose-project
5925 (org-publish (assoc (org-icompleting-read
5926 "Publish project: "
5927 org-publish-project-alist nil t)
5928 org-publish-project-alist)
5929 (memq 'force optns)
5930 (memq 'async optns)))
5931 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5932 (otherwise
5933 (save-excursion
5934 (when arg
5935 ;; Repeating command, maybe move cursor to restore subtree
5936 ;; context.
5937 (if (eq (marker-buffer org-export-dispatch-last-position)
5938 (org-base-buffer (current-buffer)))
5939 (goto-char org-export-dispatch-last-position)
5940 ;; We are in a different buffer, forget position.
5941 (move-marker org-export-dispatch-last-position nil)))
5942 (funcall action
5943 ;; Return a symbol instead of a list to ease
5944 ;; asynchronous export macro use.
5945 (and (memq 'async optns) t)
5946 (and (memq 'subtree optns) t)
5947 (and (memq 'visible optns) t)
5948 (and (memq 'body optns) t)))))))
5950 (defun org-export--dispatch-ui (options first-key expertp)
5951 "Handle interface for `org-export-dispatch'.
5953 OPTIONS is a list containing current interactive options set for
5954 export. It can contain any of the following symbols:
5955 `body' toggles a body-only export
5956 `subtree' restricts export to current subtree
5957 `visible' restricts export to visible part of buffer.
5958 `force' force publishing files.
5959 `async' use asynchronous export process
5961 FIRST-KEY is the key pressed to select the first level menu. It
5962 is nil when this menu hasn't been selected yet.
5964 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5965 buffer is provided, but indications about currently active
5966 options are given in the prompt. Moreover, \[?] allows to switch
5967 back to standard interface."
5968 (let* ((fontify-key
5969 (lambda (key &optional access-key)
5970 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5971 ;; non-nil is the required first-level key to activate
5972 ;; KEY. When its value is t, activate KEY independently
5973 ;; on the first key, if any. A nil value means KEY will
5974 ;; only be activated at first level.
5975 (if (or (eq access-key t) (eq access-key first-key))
5976 (org-propertize key 'face 'org-warning)
5977 key)))
5978 (fontify-value
5979 (lambda (value)
5980 ;; Fontify VALUE string.
5981 (org-propertize value 'face 'font-lock-variable-name-face)))
5982 ;; Prepare menu entries by extracting them from registered
5983 ;; back-ends and sorting them by access key and by ordinal,
5984 ;; if any.
5985 (entries
5986 (sort (sort (delq nil
5987 (mapcar 'org-export-backend-menu
5988 org-export--registered-backends))
5989 (lambda (a b)
5990 (let ((key-a (nth 1 a))
5991 (key-b (nth 1 b)))
5992 (cond ((and (numberp key-a) (numberp key-b))
5993 (< key-a key-b))
5994 ((numberp key-b) t)))))
5995 'car-less-than-car))
5996 ;; Compute a list of allowed keys based on the first key
5997 ;; pressed, if any. Some keys
5998 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
5999 ;; available.
6000 (allowed-keys
6001 (nconc (list 2 22 19 6 1)
6002 (if (not first-key) (org-uniquify (mapcar 'car entries))
6003 (let (sub-menu)
6004 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6005 (when (eq (car entry) first-key)
6006 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6007 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6008 ((not first-key) (list ?P)))
6009 (list ?& ?#)
6010 (when expertp (list ??))
6011 (list ?q)))
6012 ;; Build the help menu for standard UI.
6013 (help
6014 (unless expertp
6015 (concat
6016 ;; Options are hard-coded.
6017 (format "[%s] Body only: %s [%s] Visible only: %s
6018 \[%s] Export scope: %s [%s] Force publishing: %s
6020 (funcall fontify-key "C-b" t)
6021 (funcall fontify-value
6022 (if (memq 'body options) "On " "Off"))
6023 (funcall fontify-key "C-v" t)
6024 (funcall fontify-value
6025 (if (memq 'visible options) "On " "Off"))
6026 (funcall fontify-key "C-s" t)
6027 (funcall fontify-value
6028 (if (memq 'subtree options) "Subtree" "Buffer "))
6029 (funcall fontify-key "C-f" t)
6030 (funcall fontify-value
6031 (if (memq 'force options) "On " "Off"))
6032 (funcall fontify-key "C-a" t)
6033 (funcall fontify-value
6034 (if (memq 'async options) "On " "Off")))
6035 ;; Display registered back-end entries. When a key
6036 ;; appears for the second time, do not create another
6037 ;; entry, but append its sub-menu to existing menu.
6038 (let (last-key)
6039 (mapconcat
6040 (lambda (entry)
6041 (let ((top-key (car entry)))
6042 (concat
6043 (unless (eq top-key last-key)
6044 (setq last-key top-key)
6046 (funcall fontify-key (char-to-string top-key))
6047 (nth 1 entry)))
6048 (let ((sub-menu (nth 2 entry)))
6049 (unless (functionp sub-menu)
6050 ;; Split sub-menu into two columns.
6051 (let ((index -1))
6052 (concat
6053 (mapconcat
6054 (lambda (sub-entry)
6055 (incf index)
6056 (format
6057 (if (zerop (mod index 2)) " [%s] %-26s"
6059 (funcall fontify-key
6060 (char-to-string (car sub-entry))
6061 top-key)
6062 (nth 1 sub-entry)))
6063 sub-menu "")
6065 entries ""))
6066 ;; Publishing menu is hard-coded.
6068 [%s] Current file [%s] Current project
6070 (funcall fontify-key "P")
6071 (funcall fontify-key "f" ?P)
6072 (funcall fontify-key "p" ?P)
6073 (funcall fontify-key "x" ?P)
6074 (funcall fontify-key "a" ?P))
6076 (funcall fontify-key "&" t)
6077 (funcall fontify-key "#" t))
6078 (format "[%s] %s"
6079 (funcall fontify-key "q" t)
6080 (if first-key "Main menu" "Exit")))))
6081 ;; Build prompts for both standard and expert UI.
6082 (standard-prompt (unless expertp "Export command: "))
6083 (expert-prompt
6084 (when expertp
6085 (format
6086 "Export command (C-%s%s%s%s%s) [%s]: "
6087 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6088 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6089 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6090 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6091 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6092 (mapconcat (lambda (k)
6093 ;; Strip control characters.
6094 (unless (< k 27) (char-to-string k)))
6095 allowed-keys "")))))
6096 ;; With expert UI, just read key with a fancy prompt. In standard
6097 ;; UI, display an intrusive help buffer.
6098 (if expertp
6099 (org-export--dispatch-action
6100 expert-prompt allowed-keys entries options first-key expertp)
6101 ;; At first call, create frame layout in order to display menu.
6102 (unless (get-buffer "*Org Export Dispatcher*")
6103 (delete-other-windows)
6104 (org-switch-to-buffer-other-window
6105 (get-buffer-create "*Org Export Dispatcher*"))
6106 (setq cursor-type nil
6107 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6108 ;; Make sure that invisible cursor will not highlight square
6109 ;; brackets.
6110 (set-syntax-table (copy-syntax-table))
6111 (modify-syntax-entry ?\[ "w"))
6112 ;; At this point, the buffer containing the menu exists and is
6113 ;; visible in the current window. So, refresh it.
6114 (with-current-buffer "*Org Export Dispatcher*"
6115 ;; Refresh help. Maintain display continuity by re-visiting
6116 ;; previous window position.
6117 (let ((pos (window-start)))
6118 (erase-buffer)
6119 (insert help)
6120 (set-window-start nil pos)))
6121 (org-fit-window-to-buffer)
6122 (org-export--dispatch-action
6123 standard-prompt allowed-keys entries options first-key expertp))))
6125 (defun org-export--dispatch-action
6126 (prompt allowed-keys entries options first-key expertp)
6127 "Read a character from command input and act accordingly.
6129 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6130 a list of characters available at a given step in the process.
6131 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6132 EXPERTP are the same as defined in `org-export--dispatch-ui',
6133 which see.
6135 Toggle export options when required. Otherwise, return value is
6136 a list with action as CAR and a list of interactive export
6137 options as CDR."
6138 (let (key)
6139 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6140 ;; C-p, SPC, DEL).
6141 (while (and (setq key (read-char-exclusive prompt))
6142 (not expertp)
6143 (memq key '(14 16 ?\s ?\d)))
6144 (case key
6145 (14 (if (not (pos-visible-in-window-p (point-max)))
6146 (ignore-errors (scroll-up 1))
6147 (message "End of buffer")
6148 (sit-for 1)))
6149 (16 (if (not (pos-visible-in-window-p (point-min)))
6150 (ignore-errors (scroll-down 1))
6151 (message "Beginning of buffer")
6152 (sit-for 1)))
6153 (?\s (if (not (pos-visible-in-window-p (point-max)))
6154 (scroll-up nil)
6155 (message "End of buffer")
6156 (sit-for 1)))
6157 (?\d (if (not (pos-visible-in-window-p (point-min)))
6158 (scroll-down nil)
6159 (message "Beginning of buffer")
6160 (sit-for 1)))))
6161 (cond
6162 ;; Ignore undefined associations.
6163 ((not (memq key allowed-keys))
6164 (ding)
6165 (unless expertp (message "Invalid key") (sit-for 1))
6166 (org-export--dispatch-ui options first-key expertp))
6167 ;; q key at first level aborts export. At second level, cancel
6168 ;; first key instead.
6169 ((eq key ?q) (if (not first-key) (error "Export aborted")
6170 (org-export--dispatch-ui options nil expertp)))
6171 ;; Help key: Switch back to standard interface if expert UI was
6172 ;; active.
6173 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6174 ;; Send request for template insertion along with export scope.
6175 ((eq key ?#) (cons 'template (memq 'subtree options)))
6176 ;; Switch to asynchronous export stack.
6177 ((eq key ?&) '(stack))
6178 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6179 ((memq key '(2 22 19 6 1))
6180 (org-export--dispatch-ui
6181 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6182 (6 'force) (1 'async))))
6183 (if (memq option options) (remq option options)
6184 (cons option options)))
6185 first-key expertp))
6186 ;; Action selected: Send key and options back to
6187 ;; `org-export-dispatch'.
6188 ((or first-key (functionp (nth 2 (assq key entries))))
6189 (cons (cond
6190 ((not first-key) (nth 2 (assq key entries)))
6191 ;; Publishing actions are hard-coded. Send a special
6192 ;; signal to `org-export-dispatch'.
6193 ((eq first-key ?P)
6194 (case key
6195 (?f 'publish-current-file)
6196 (?p 'publish-current-project)
6197 (?x 'publish-choose-project)
6198 (?a 'publish-all)))
6199 ;; Return first action associated to FIRST-KEY + KEY
6200 ;; path. Indeed, derived backends can share the same
6201 ;; FIRST-KEY.
6202 (t (catch 'found
6203 (mapc (lambda (entry)
6204 (let ((match (assq key (nth 2 entry))))
6205 (when match (throw 'found (nth 2 match)))))
6206 (member (assq first-key entries) entries)))))
6207 options))
6208 ;; Otherwise, enter sub-menu.
6209 (t (org-export--dispatch-ui options key expertp)))))
6213 (provide 'ox)
6215 ;; Local variables:
6216 ;; generated-autoload-file: "org-loaddefs.el"
6217 ;; End:
6219 ;;; ox.el ends here