| blob | f50dbbd77efd9a8c6819380b9c71e05c22602dd5 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012, 2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; GNU Emacs is free software: you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
22 ;;
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
25 ;;
26 ;; Besides that parser, the generic exporter is made of three distinct
27 ;; parts:
28 ;;
29 ;; - The communication channel consists in a property list, which is
30 ;; created and updated during the process. Its use is to offer
31 ;; every piece of information, would it be about initial environment
32 ;; or contextual data, all in a single place. The exhaustive list
33 ;; of properties is given in "The Communication Channel" section of
34 ;; this file.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core function is `org-export-as'. It returns the transcoded
48 ;; buffer as a string.
49 ;;
50 ;; An export back-end is defined with `org-export-define-backend',
51 ;; which defines one mandatory information: his translation table.
52 ;; Its value is an alist whose keys are elements and objects types and
53 ;; values translator functions. See function's docstring for more
54 ;; information about translators.
55 ;;
56 ;; Optionally, `org-export-define-backend' can also support specific
57 ;; buffer keywords, OPTION keyword's items and filters. Also refer to
58 ;; function documentation for more information.
59 ;;
60 ;; If the new back-end shares most properties with another one,
61 ;; `org-export-define-derived-backend' can be used to simplify the
62 ;; process.
63 ;;
64 ;; Any back-end can define its own variables. Among them, those
65 ;; customizable should belong to the `org-export-BACKEND' group.
66 ;;
67 ;; Tools for common tasks across back-ends are implemented in the
68 ;; following part of then file.
69 ;;
70 ;; Then, a wrapper macro for asynchronous export,
71 ;; `org-export-async-start', along with tools to display results. are
72 ;; given in the penultimate part.
73 ;;
74 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
75 ;; back-ends is provided in the last one.
77 ;;; Code:
97 \f
98 ;;; Internal Variables
99 ;;
100 ;; Among internal variables, the most important is
101 ;; `org-export-options-alist'. This variable define the global export
102 ;; options, shared between every exporter, and how they are acquired.
147 "Alist between export properties and ways to set them.
149 The CAR of the alist is the property name, and the CDR is a list
150 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
152 KEYWORD is a string representing a buffer keyword, or nil. Each
153 property defined this way can also be set, during subtree
154 export, through a headline property named after the keyword
156 property).
157 OPTION is a string that could be found in an #+OPTIONS: line.
158 DEFAULT is the default value for the property.
159 BEHAVIOUR determines how Org should handle multiple keywords for
160 the same property. It is a symbol among:
161 nil Keep old value and discard the new one.
162 t Replace old value with the new one.
163 `space' Concatenate the values, separating them with a space.
164 `newline' Concatenate the values, separating them with
165 a newline.
166 `split' Split values at white spaces, and cons them to the
167 previous list.
169 Values set through KEYWORD and OPTION have precedence over
170 DEFAULT.
172 All these properties should be back-end agnostic. Back-end
173 specific properties are set through `org-export-define-backend'.
177 "List of in-buffer keywords that require special treatment.
178 These keywords are not directly associated to a property. The
179 way they are handled must be hard-coded into
240 "Alist between filters properties and initial values.
242 The key of each association is a property name accessible through
243 the communication channel. Its value is a configurable global
244 variable defining initial filters.
246 This list is meant to install user specified filters. Back-end
247 developers may install their own filters using
248 `org-export-define-backend'. Filters defined there will always
249 be prepended to the current list, so they always get applied
258 "Default rule for link matching an inline image.
259 This rule applies to links with no description. By default, it
260 will be considered as an inline image if it targets a local file
263 See `org-export-inline-image-p' for more information about
267 "Non-nil means asynchronous export process should leave data behind.
271 located in `temporary-file-directory'.
273 When non-nil, it will also set `debug-on-error' to a non-nil
277 "Record asynchronously generated export results and processes.
278 This is an alist: its CAR is the source of the
279 result (destination file or buffer for a finished process,
280 original buffer for a running one) and its CDR is a list
281 containing the back-end used, as a symbol, and either a process
282 or the time at which it finished. It is used to build the menu
286 "List of backends currently available in the exporter.
288 A backend is stored as a list where CAR is its name, as a symbol,
289 and CDR is a plist with the following properties:
290 `:filters-alist', `:menu-entry', `:options-alist' and
291 `:translate-alist'.
293 This variable is set with `org-export-define-backend' and
297 "Last command called from the dispatcher.
298 The value should be a list. Its CAR is the action, as a symbol,
302 \f
303 ;;; User-configurable Variables
304 ;;
305 ;; Configuration for the masses.
306 ;;
307 ;; They should never be accessed directly, as their value is to be
308 ;; stored in a property list (cf. `org-export-options-alist').
309 ;; Back-ends will read their value from there instead.
312 "Options for exporting Org mode files."
317 "General options for export engine."
322 "Whether sub-trees with the ARCHIVE tag should be exported.
324 This can have three different values:
325 nil Do not export, pretend this tree is not present.
326 t Do export the entire tree.
327 `headline' Only export the headline, but skip the tree below it.
329 This option can also be set with the #+OPTIONS line,
338 "Non-nil means insert author name into the exported file.
339 This option can also be set with the #+OPTIONS line,
345 "Non-nil means export CLOCK keywords.
346 This option can also be set with the #+OPTIONS line,
352 "Non-nil means the postamble should contain a creator sentence.
354 The sentence can be set in `org-export-creator-string' and
357 If the value is `comment' insert it as a comment."
365 "Non-nil means insert date in the exported document.
366 This options can also be set with the OPTIONS keyword,
372 emacs-version)
373 "String to insert at the end of the generated document."
378 "Non-nil means export contents of standard drawers.
380 When t, all drawers are exported. This may also be a list of
381 drawer names to export. If that list starts with `not', only
382 drawers with such names will be ignored.
384 This variable doesn't apply to properties drawers.
386 This option can also be set with the #+OPTIONS line,
397 :inline t
401 "Non-nil means insert author email into the exported file.
402 This option can also be set with the #+OPTIONS line,
408 "Non-nil means interpret *word*, /word/, _word_ and +word+.
410 If the export target supports emphasizing text, the word will be
411 typeset in bold, italic, with an underline or strike-through,
412 respectively.
419 "Tags that exclude a tree from export.
421 All trees carrying any of these tags will be excluded from
422 export. This is without condition, so even subtrees inside that
423 carry one of the `org-export-select-tags' will be removed.
425 This option can also be set with the #+EXCLUDE_TAGS: keyword."
432 This can be used to have pre-formatted text, fragments of code
433 etc. For example:
434 : ;; Some Lisp examples
435 : (while (defc cnt)
436 : (ding))
437 will be looking just like this in also HTML. See also the QUOTE
438 keyword. Not all export backends support this.
445 "Non-nil means Org footnotes should be exported.
446 This option can also be set with the #+OPTIONS line,
452 "Non-nil means process LaTeX environments and fragments.
454 This option can also be set with the +OPTIONS line,
457 nil Ignore math snippets.
458 `verbatim' Keep everything in verbatim.
459 t Allow export of math snippets."
467 "The last level which is still exported as a headline.
469 Inferior levels will produce itemize or enumerate lists when
470 exported.
477 "The default language for export and clocktable translations, as a string.
478 This may have an association in
479 `org-clock-clocktable-language-setup'."
484 "Non-nil means preserve all line breaks when exporting.
485 This option can also be set with the #+OPTIONS line,
491 "Non-nil means interpret entities when exporting.
494 Å.
496 For a list of supported names, see the constant `org-entities'
497 and the user option `org-entities-user'.
499 This option can also be set with the #+OPTIONS line,
505 "Non-nil means inlinetasks should be exported.
506 This option can also be set with the #+OPTIONS line,
512 "Non-nil means include planning info in export.
513 This option can also be set with the #+OPTIONS: line,
519 "Non-nil means include priority cookies in export.
520 This option can also be set with the #+OPTIONS line,
526 "Non-nil means add section numbers to headlines when exporting.
528 When set to an integer n, numbering will only happen for
529 headlines whose relative level is higher or equal to n.
531 This option can also be set with the #+OPTIONS line,
537 "Tags that select a tree for export.
539 If any such tag is found in a buffer, all trees that do not carry
540 one of these tags will be ignored during export. Inside trees
541 that are selected like this, you can still deselect a subtree by
542 tagging it with one of the `org-export-exclude-tags'.
544 This option can also be set with the #+SELECT_TAGS: keyword."
549 "Non-nil means activate smart quotes during export.
550 This option can also be set with the #+OPTIONS: line,
558 When this option is turned on, these strings will be exported as:
560 Org HTML LaTeX UTF-8
561 -----+----------+--------+-------
563 -- – -- –
564 --- — --- —
567 This option can also be set with the #+OPTIONS line,
573 "Non-nil means include statistics cookies in export.
574 This option can also be set with the #+OPTIONS: line,
582 When this option is turned on, you can use TeX-like syntax for
584 will be considered as a single item - so grouping with {} is
585 normally not needed. For example, the following things will be
586 parsed as single sub- or superscripts.
588 10^24 or 10^tau several digits will be considered 1 item.
589 10^-12 or 10^-tau a leading sign with digits or a word
590 x^2-y^3 will be read as x^2 - y^3, because items are
591 terminated by almost any nonword/nondigit char.
592 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
594 Still, ambiguity is possible - so when in doubt use {} to enclose
595 the sub/superscript. If you set this variable to the symbol
596 `{}', the braces are *required* in order to trigger
597 interpretations as sub/superscript. This can be helpful in
600 This option can also be set with the #+OPTIONS line,
609 "Non-nil means create a table of contents in exported files.
611 The TOC contains headlines with levels up
612 to`org-export-headline-levels'. When an integer, include levels
613 up to N in the toc, this may then be different from
614 `org-export-headline-levels', but it will not be allowed to be
615 larger than the number of headline levels. When nil, no table of
616 contents is made.
618 This option can also be set with the #+OPTIONS line,
628 For example:
630 | Name | Address | Birthday |
631 |-------------+----------+-----------|
632 | Arthur Dent | England | 29.2.2100 |
639 "If nil, do not export tags, just remove them from headlines.
641 If this is the symbol `not-in-toc', tags will be removed from
642 table of contents entries, but still be shown in the headlines of
643 the document.
645 This option can also be set with the #+OPTIONS line,
654 "Non-nil means include TODO items for export.
656 This may have the following values:
657 t include tasks independent of state.
658 `todo' include only tasks that are not yet done.
659 `done' include only tasks that are already done.
660 nil ignore all tasks.
661 list of keywords include tasks with these keywords.
663 This option can also be set with the #+OPTIONS line,
675 "Non-nil means insert a time stamp into the exported file.
676 The time stamp shows when the file was created.
678 This option can also be set with the #+OPTIONS line,
684 "Non nil means allow timestamps in export.
686 It can be set to `active', `inactive', t or nil, in order to
687 export, respectively, only active timestamps, only inactive ones,
688 all of them or none.
690 This option can also be set with the #+OPTIONS line, e.g.
700 "Non-nil means include TODO keywords in export.
701 When nil, remove all these keywords from the export."
706 "Non-nil means BIND keywords can define local variable values.
707 This is a potential security risk, which is why the default value
708 is nil. You can also allow them through local buffer variables."
713 "Alist between export snippets back-ends and exporter back-ends.
715 This variable allows to provide shortcuts for export snippets.
719 HTML code while every other back-end will ignore it."
726 "Coding system for the exported file."
731 "Non-nil means exported stuff will also be pushed onto the kill ring."
736 "The initial scope when exporting with `org-export-dispatch'.
737 This variable can be either set to `buffer' or `subtree'."
744 "Non-nil means show buffer after exporting to temp buffer.
745 When Org exports to a file, the buffer visiting that file is ever
746 shown, but remains buried. However, when exporting to
747 a temporary buffer, that buffer is popped up in a second window.
748 When this variable is nil, the buffer remains buried also in
749 these cases."
754 "Non-nil means export and publishing commands will run in background.
755 Results from an asynchronous export are never displayed
761 "File used to initialize external export process.
762 Value must be an absolute file name. It defaults to user's
763 initialization file. Though, a specific configuration makes the
764 process faster and the export more portable."
769 "List of back-ends that shouldn't appear in the dispatcher.
771 Any back-end belonging to this list or derived from a back-end
772 belonging to it will not appear in the dispatcher menu.
774 Indeed, Org may require some export back-ends without notice. If
775 these modules are never to be used interactively, adding them
776 here will avoid cluttering the dispatcher menu."
781 "Non-nil means using a non-intrusive `org-export-dispatch'.
782 In that case, no help buffer is displayed. Though, an indicator
788 asynchronous). Also, \[?] allows to switch back to standard
789 mode."
794 \f
795 ;;; Defining Back-ends
796 ;;
797 ;; `org-export-define-backend' is the standard way to define an export
798 ;; back-end. It allows to specify translators, filters, buffer
799 ;; options and a menu entry. If the new back-end shares translators
800 ;; with another back-end, `org-export-define-derived-backend' may be
801 ;; used instead.
802 ;;
803 ;; Internally, a back-end is stored as a list, of which CAR is the
804 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
805 ;; properties of a given back-end are: `org-export-backend-filters',
806 ;; `org-export-backend-menu', `org-export-backend-options' and
807 ;; `org-export-backend-translate-table'.
808 ;;
809 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
810 ;; when a given back-end hasn't been registered yet.
813 "Define a new back-end BACKEND.
815 TRANSLATORS is an alist between object or element types and
816 functions handling them.
818 These functions should return a string without any trailing
819 space, or nil. They must accept three arguments: the object or
820 element itself, its contents or nil when it isn't recursive and
821 the property list used as a communication channel.
823 Contents, when not nil, are stripped from any global indentation
824 \(although the relative one is preserved). They also always end
825 with a single newline character.
827 If, for a given type, no function is found, that element or
828 object type will simply be ignored, along with any blank line or
829 white space at its end. The same will happen if the function
830 returns the nil value. If that function returns the empty
831 string, the type will be ignored, but the blank lines or white
832 spaces will be kept.
834 In addition to element and object types, one function can be
835 associated to the `template' (or `inner-template') symbol and
836 another one to the `plain-text' symbol.
838 The former returns the final transcoded string, and can be used
839 to add a preamble and a postamble to document's body. It must
840 accept two arguments: the transcoded string and the property list
841 containing export options. A function associated to `template'
843 A function associated to `inner-template' is always applied.
845 The latter, when defined, is to be called on every text not
846 recognized as an element or an object. It must accept two
847 arguments: the text string and the information channel. It is an
848 appropriate place to protect special chars relative to the
849 back-end.
851 BODY can start with pre-defined keyword arguments. The following
852 keywords are understood:
854 :export-block
856 String, or list of strings, representing block names that
857 will not be parsed. This is used to specify blocks that will
858 contain raw code specific to the back-end. These blocks
859 still have to be handled by the relative `export-block' type
860 translator.
862 :filters-alist
864 Alist between filters and function, or list of functions,
865 specific to the back-end. See `org-export-filters-alist' for
866 a list of all allowed filters. Filters defined here
867 shouldn't make a back-end test, as it may prevent back-ends
868 derived from this one to behave properly.
870 :menu-entry
872 Menu entry for the export dispatcher. It should be a list
873 like:
875 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
877 where :
879 KEY is a free character selecting the back-end.
881 DESCRIPTION-OR-ORDINAL is either a string or a number.
883 If it is a string, is will be used to name the back-end in
884 its menu entry. If it is a number, the following menu will
885 be displayed as a sub-menu of the back-end with the same
886 KEY. Also, the number will be used to determine in which
887 order such sub-menus will appear (lowest first).
889 ACTION-OR-MENU is either a function or an alist.
891 If it is an action, it will be called with four
892 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
893 BODY-ONLY. See `org-export-as' for further explanations on
894 some of them.
896 If it is an alist, associations should follow the
897 pattern:
899 \(KEY DESCRIPTION ACTION)
901 where KEY, DESCRIPTION and ACTION are described above.
903 Valid values include:
907 or
912 \(lambda (a s v b)
913 \(if a (org-latex-export-to-pdf t s v b)
914 \(org-open-file
915 \(org-latex-export-to-pdf nil s v b)))))))
917 or the following, which will be added to the previous
918 sub-menu,
920 \(?l 1
924 :options-alist
926 Alist between back-end specific properties introduced in
927 communication channel and how their value are acquired. See
928 `org-export-options-alist' for more information about
929 structure of the values."
948 ;; Register back-end.
952 ;; Tell parser to not parse EXPORT-BLOCK blocks.
959 ;; Splice in the body, if any.
963 "Create a new back-end as a variant of an existing one.
965 CHILD is the name of the derived back-end. PARENT is the name of
966 the parent back-end.
968 BODY can start with pre-defined keyword arguments. The following
969 keywords are understood:
971 :export-block
973 String, or list of strings, representing block names that
974 will not be parsed. This is used to specify blocks that will
975 contain raw code specific to the back-end. These blocks
976 still have to be handled by the relative `export-block' type
977 translator.
979 :filters-alist
981 Alist of filters that will overwrite or complete filters
982 defined in PARENT back-end. See `org-export-filters-alist'
983 for a list of allowed filters.
985 :menu-entry
987 Menu entry for the export dispatcher. See
988 `org-export-define-backend' for more information about the
989 expected value.
991 :options-alist
993 Alist of back-end specific properties that will overwrite or
994 complete those defined in PARENT back-end. Refer to
995 `org-export-options-alist' for more information about
996 structure of the values.
998 :translate-alist
1000 Alist of element and object types and transcoders that will
1001 overwrite or complete transcode table from PARENT back-end.
1002 Refer to `org-export-define-backend' for detailed information
1003 about transcoders.
1006 as a variant of `latex' back-end with a custom template function:
1008 \(org-export-define-derived-backend my-latex latex
1009 :translate-alist ((template . my-latex-template-fun)))
1011 The back-end could then be called with, for example:
1039 ;; Register back-end.
1043 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1050 ;; Splice in the body, if any.
1054 "Return back-end from which BACKEND is derived, or nil."
1058 "Return filters for BACKEND."
1063 "Return menu entry for BACKEND."
1068 "Return export options for BACKEND."
1073 "Return translate table for BACKEND."
1078 "Signal an error if BACKEND isn't defined."
1083 "Non-nil if BACKEND is derived from one of BACKENDS."
1087 parent))
1090 \f
1091 ;;; The Communication Channel
1092 ;;
1093 ;; During export process, every function has access to a number of
1094 ;; properties. They are of two types:
1095 ;;
1096 ;; 1. Environment options are collected once at the very beginning of
1097 ;; the process, out of the original buffer and configuration.
1098 ;; Collecting them is handled by `org-export-get-environment'
1099 ;; function.
1100 ;;
1101 ;; Most environment options are defined through the
1102 ;; `org-export-options-alist' variable.
1103 ;;
1104 ;; 2. Tree properties are extracted directly from the parsed tree,
1105 ;; just before export, by `org-export-collect-tree-properties'.
1106 ;;
1107 ;; Here is the full list of properties available during transcode
1108 ;; process, with their category and their value type.
1109 ;;
1110 ;; + `:author' :: Author's name.
1111 ;; - category :: option
1112 ;; - type :: string
1113 ;;
1114 ;; + `:back-end' :: Current back-end used for transcoding.
1115 ;; - category :: tree
1116 ;; - type :: symbol
1117 ;;
1118 ;; + `:creator' :: String to write as creation information.
1119 ;; - category :: option
1120 ;; - type :: string
1121 ;;
1122 ;; + `:date' :: String to use as date.
1123 ;; - category :: option
1124 ;; - type :: string
1125 ;;
1126 ;; + `:description' :: Description text for the current data.
1127 ;; - category :: option
1128 ;; - type :: string
1129 ;;
1130 ;; + `:email' :: Author's email.
1131 ;; - category :: option
1132 ;; - type :: string
1133 ;;
1134 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1135 ;; process.
1136 ;; - category :: option
1137 ;; - type :: list of strings
1138 ;;
1139 ;; + `:exported-data' :: Hash table used for memoizing
1140 ;; `org-export-data'.
1141 ;; - category :: tree
1142 ;; - type :: hash table
1143 ;;
1144 ;; + `:filetags' :: List of global tags for buffer. Used by
1145 ;; `org-export-get-tags' to get tags with inheritance.
1146 ;; - category :: option
1147 ;; - type :: list of strings
1148 ;;
1149 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1150 ;; their definition, as parsed data. Only non-inlined footnotes
1151 ;; are represented in this alist. Also, every definition isn't
1152 ;; guaranteed to be referenced in the parse tree. The purpose of
1153 ;; this property is to preserve definitions from oblivion
1154 ;; (i.e. when the parse tree comes from a part of the original
1155 ;; buffer), it isn't meant for direct use in a back-end. To
1156 ;; retrieve a definition relative to a reference, use
1157 ;; `org-export-get-footnote-definition' instead.
1158 ;; - category :: option
1159 ;; - type :: alist (STRING . LIST)
1160 ;;
1161 ;; + `:headline-levels' :: Maximum level being exported as an
1162 ;; headline. Comparison is done with the relative level of
1163 ;; headlines in the parse tree, not necessarily with their
1164 ;; actual level.
1165 ;; - category :: option
1166 ;; - type :: integer
1167 ;;
1168 ;; + `:headline-offset' :: Difference between relative and real level
1169 ;; of headlines in the parse tree. For example, a value of -1
1170 ;; means a level 2 headline should be considered as level
1171 ;; 1 (cf. `org-export-get-relative-level').
1172 ;; - category :: tree
1173 ;; - type :: integer
1174 ;;
1175 ;; + `:headline-numbering' :: Alist between headlines and their
1176 ;; numbering, as a list of numbers
1177 ;; (cf. `org-export-get-headline-number').
1178 ;; - category :: tree
1179 ;; - type :: alist (INTEGER . LIST)
1180 ;;
1181 ;; + `:id-alist' :: Alist between ID strings and destination file's
1182 ;; path, relative to current directory. It is used by
1183 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1184 ;; external file.
1185 ;; - category :: option
1186 ;; - type :: alist (STRING . STRING)
1187 ;;
1188 ;; + `:ignore-list' :: List of elements and objects that should be
1189 ;; ignored during export.
1190 ;; - category :: tree
1191 ;; - type :: list of elements and objects
1192 ;;
1193 ;; + `:input-file' :: Full path to input file, if any.
1194 ;; - category :: option
1195 ;; - type :: string or nil
1196 ;;
1197 ;; + `:keywords' :: List of keywords attached to data.
1198 ;; - category :: option
1199 ;; - type :: string
1200 ;;
1201 ;; + `:language' :: Default language used for translations.
1202 ;; - category :: option
1203 ;; - type :: string
1204 ;;
1205 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1206 ;; transcoding.
1207 ;; - category :: option
1208 ;; - type :: list (as returned by `org-element-parse-buffer')
1209 ;;
1210 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1211 ;; all line breaks.
1212 ;; - category :: option
1213 ;; - type :: symbol (nil, t)
1214 ;;
1215 ;; + `:section-numbers' :: Non-nil means transcoding should add
1216 ;; section numbers to headlines.
1217 ;; - category :: option
1218 ;; - type :: symbol (nil, t)
1219 ;;
1220 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1221 ;; in transcoding. When such a tag is present, subtrees without
1222 ;; it are de facto excluded from the process. See
1223 ;; `use-select-tags'.
1224 ;; - category :: option
1225 ;; - type :: list of strings
1226 ;;
1227 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1228 ;; a time stamp in the output.
1229 ;; - category :: option
1230 ;; - type :: symbol (nil, t)
1231 ;;
1232 ;; + `:translate-alist' :: Alist between element and object types and
1233 ;; transcoding functions relative to the current back-end.
1234 ;; Special keys `inner-template', `template' and `plain-text' are
1235 ;; also possible.
1236 ;; - category :: option
1237 ;; - type :: alist (SYMBOL . FUNCTION)
1238 ;;
1239 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1240 ;; also be transcoded. If it is set to the `headline' symbol,
1241 ;; only the archived headline's name is retained.
1242 ;; - category :: option
1243 ;; - type :: symbol (nil, t, `headline')
1244 ;;
1245 ;; + `:with-author' :: Non-nil means author's name should be included
1246 ;; in the output.
1247 ;; - category :: option
1248 ;; - type :: symbol (nil, t)
1249 ;;
1250 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1251 ;; - category :: option
1252 ;; - type :: symbol (nil, t)
1253 ;;
1254 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1255 ;; inserted at the end of the transcoded string. If the value
1256 ;; is `comment', it should be commented.
1257 ;; - category :: option
1258 ;; - type :: symbol (`comment', nil, t)
1259 ;;
1260 ;; + `:with-date' :: Non-nil means output should contain a date.
1261 ;; - category :: option
1262 ;; - type :. symbol (nil, t)
1263 ;;
1264 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1265 ;; its value is a list of names, only drawers with such names
1266 ;; will be transcoded. If that list starts with `not', drawer
1267 ;; with these names will be skipped.
1268 ;; - category :: option
1269 ;; - type :: symbol (nil, t) or list of strings
1270 ;;
1271 ;; + `:with-email' :: Non-nil means output should contain author's
1272 ;; email.
1273 ;; - category :: option
1274 ;; - type :: symbol (nil, t)
1275 ;;
1276 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1277 ;; interpreted.
1278 ;; - category :: option
1279 ;; - type :: symbol (nil, t)
1280 ;;
1281 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1282 ;; strings starting with a colon as a fixed-with (verbatim) area.
1283 ;; - category :: option
1284 ;; - type :: symbol (nil, t)
1285 ;;
1286 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1287 ;; footnotes.
1288 ;; - category :: option
1289 ;; - type :: symbol (nil, t)
1290 ;;
1291 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1292 ;; `latex-fragment' objects should appear in export output. When
1293 ;; this property is set to `verbatim', they will be left as-is.
1294 ;; - category :: option
1295 ;; - type :: symbol (`verbatim', nil, t)
1296 ;;
1297 ;; + `:with-plannings' :: Non-nil means transcoding should include
1298 ;; planning info.
1299 ;; - category :: option
1300 ;; - type :: symbol (nil, t)
1301 ;;
1302 ;; + `:with-priority' :: Non-nil means transcoding should include
1303 ;; priority cookies.
1304 ;; - category :: option
1305 ;; - type :: symbol (nil, t)
1306 ;;
1307 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1308 ;; plain text.
1309 ;; - category :: option
1310 ;; - type :: symbol (nil, t)
1311 ;;
1312 ;; + `:with-special-strings' :: Non-nil means transcoding should
1313 ;; interpret special strings in plain text.
1314 ;; - category :: option
1315 ;; - type :: symbol (nil, t)
1316 ;;
1317 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1318 ;; interpret subscript and superscript. With a value of "{}",
1319 ;; only interpret those using curly brackets.
1320 ;; - category :: option
1321 ;; - type :: symbol (nil, {}, t)
1322 ;;
1323 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1324 ;; tables.
1325 ;; - category :: option
1326 ;; - type :: symbol (nil, t)
1327 ;;
1328 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1329 ;; headlines. A `not-in-toc' value will remove them from the
1330 ;; table of contents, if any, nonetheless.
1331 ;; - category :: option
1332 ;; - type :: symbol (nil, t, `not-in-toc')
1333 ;;
1334 ;; + `:with-tasks' :: Non-nil means transcoding should include
1335 ;; headlines with a TODO keyword. A `todo' value will only
1336 ;; include headlines with a todo type keyword while a `done'
1337 ;; value will do the contrary. If a list of strings is provided,
1338 ;; only tasks with keywords belonging to that list will be kept.
1339 ;; - category :: option
1340 ;; - type :: symbol (t, todo, done, nil) or list of strings
1341 ;;
1342 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1343 ;; time stamps. Special value `active' (resp. `inactive') ask to
1344 ;; export only active (resp. inactive) timestamps. Otherwise,
1345 ;; completely remove them.
1346 ;; - category :: option
1347 ;; - type :: symbol: (`active', `inactive', t, nil)
1348 ;;
1349 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1350 ;; added to the output. An integer value limits its depth.
1351 ;; - category :: option
1352 ;; - type :: symbol (nil, t or integer)
1353 ;;
1354 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1355 ;; include TODO keywords.
1356 ;; - category :: option
1357 ;; - type :: symbol (nil, t)
1360 ;;;; Environment Options
1361 ;;
1362 ;; Environment options encompass all parameters defined outside the
1363 ;; scope of the parsed data. They come from five sources, in
1364 ;; increasing precedence order:
1365 ;;
1366 ;; - Global variables,
1367 ;; - Buffer's attributes,
1368 ;; - Options keyword symbols,
1369 ;; - Buffer keywords,
1370 ;; - Subtree properties.
1371 ;;
1372 ;; The central internal function with regards to environment options
1373 ;; is `org-export-get-environment'. It updates global variables with
1374 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1375 ;; the different sources.
1376 ;;
1377 ;; The internal functions doing the retrieval are:
1378 ;; `org-export--get-global-options',
1379 ;; `org-export--get-buffer-attributes',
1380 ;; `org-export--parse-option-keyword',
1381 ;; `org-export--get-subtree-options' and
1382 ;; `org-export--get-inbuffer-options'
1383 ;;
1384 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1385 ;; relative to "#+BIND:" keywords.
1388 "Collect export options from the current buffer.
1390 Optional argument BACKEND is a symbol specifying which back-end
1391 specific options to read, if any.
1393 When optional argument SUBTREEP is non-nil, assume the export is
1394 done against the current sub-tree.
1396 Third optional argument EXT-PLIST is a property list with
1397 external parameters overriding Org default settings, but still
1398 inferior to file-local settings."
1399 ;; First install #+BIND variables.
1401 ;; Get and prioritize export options...
1403 ;; ... from global variables...
1405 ;; ... from an external property list...
1406 ext-plist
1407 ;; ... from in-buffer settings...
1409 backend
1411 ;; ... and from subtree, when appropriate.
1413 ;; Eventually add misc. properties.
1415 :back-end
1416 backend
1417 :translate-alist
1419 :footnote-definition-alist
1420 ;; Footnotes definitions must be collected in the original
1421 ;; buffer, as there's no insurance that they will still be in
1422 ;; the parse tree, due to possible narrowing.
1436 alist))))
1437 alist))
1438 :id-alist
1439 ;; Collect id references.
1450 alist))))
1453 "Parse an OPTIONS line and return values as a plist.
1454 Optional argument BACKEND is a symbol specifying which back-end
1455 specific items to read, if any."
1457 ;; Priority is given to back-end specific options.
1459 org-export-options-alist))
1460 plist)
1469 options))
1471 property
1474 plist))
1477 "Get export options in subtree at point.
1478 Optional argument BACKEND is a symbol specifying back-end used
1479 for export. Return options as a plist."
1480 ;; For each buffer keyword, create a headline property setting the
1481 ;; same property in communication channel. The name for the property
1482 ;; is the keyword with "EXPORT_" appended to it.
1485 ;; Make sure point is at an heading.
1487 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1488 ;; title as its fallback value.
1494 plist :title
1497 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1501 ;; Handle other keywords. TITLE keyword is excluded as it has
1502 ;; been handled already.
1510 ;; Export properties are not case-sensitive.
1517 plist
1518 property
1520 ;; Parse VALUE if required.
1524 ;; If BEHAVIOUR is `split' expected value is
1525 ;; a list of strings, not a string.
1528 ;; Look for both general keywords and back-end specific
1529 ;; options, with priority given to the latter.
1531 org-export-options-alist)))
1532 ;; Return value.
1533 plist)))
1536 "Return current buffer export options, as a plist.
1538 Optional argument BACKEND, when non-nil, is a symbol specifying
1539 which back-end specific options should also be read in the
1540 process.
1542 Optional argument FILES is a list of setup files names read so
1543 far, used to avoid circular dependencies.
1545 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1549 ;; 1. Special keywords, as in `org-export-special-keywords'.
1563 ;; Avoid circular dependencies.
1578 ;; 2. Standard options, as in `org-export-options-alist'.
1580 ;; Priority is given to back-end specific options.
1582 org-export-options-alist)))
1597 ;; Handle value depending on specified
1598 ;; BEHAVIOUR.
1603 " "
1615 ;; Parse keywords specified in
1616 ;; `org-element-document-properties'.
1619 ;; Find the property associated to the keyword.
1624 all)))
1629 plist prop
1632 org-element-document-properties))
1633 ;; 3. Return final value.
1634 plist)))
1637 "Return properties related to buffer attributes, as a plist."
1640 ;; Store full path of input file name, or nil. For internal use.
1641 :input-file visited-file
1648 "Return global export options as a plist.
1650 Optional argument BACKEND, if non-nil, is a symbol specifying
1651 which back-end specific export options should also be read in the
1652 process."
1654 ;; Priority is given to back-end specific options.
1656 org-export-options-alist))
1657 plist)
1664 plist
1665 prop
1666 ;; Eval default value provided. If keyword is a member
1667 ;; of `org-element-document-properties', parse it as
1668 ;; a secondary string before storing it.
1673 value
1676 all)
1677 ;; Return value.
1678 plist))
1681 "Install the values from #+BIND lines as local variables.
1682 Variables must be installed before in-buffer options are
1683 retrieved."
1698 ;;;; Tree Properties
1699 ;;
1700 ;; Tree properties are information extracted from parse tree. They
1701 ;; are initialized at the beginning of the transcoding process by
1702 ;; `org-export-collect-tree-properties'.
1703 ;;
1704 ;; Dedicated functions focus on computing the value of specific tree
1705 ;; properties during initialization. Thus,
1706 ;; `org-export--populate-ignore-list' lists elements and objects that
1707 ;; should be skipped during export, `org-export--get-min-level' gets
1708 ;; the minimal exportable level, used as a basis to compute relative
1709 ;; level for headlines. Eventually
1710 ;; `org-export--collect-headline-numbering' builds an alist between
1711 ;; headlines and their numbering.
1714 "Extract tree properties from parse tree.
1716 DATA is the parse tree from which information is retrieved. INFO
1717 is a list holding export options.
1719 Following tree properties are set or updated:
1721 `:exported-data' Hash table used to memoize results from
1722 `org-export-data'.
1724 `:footnote-definition-alist' List of footnotes definitions in
1725 original buffer and current parse tree.
1727 `:headline-offset' Offset between true level of headlines and
1728 local level. An offset of -1 means a headline
1729 of level 2 should be considered as a level
1730 1 headline in the context.
1732 `:headline-numbering' Alist of all headlines as key an the
1733 associated numbering as value.
1735 `:ignore-list' List of elements that should be ignored during
1736 export.
1738 Return updated plist."
1739 ;; Install the parse tree in the communication channel, in order to
1740 ;; use `org-export-get-genealogy' and al.
1742 ;; Get the list of elements and objects to ignore, and put it into
1743 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1744 ;; been done during parse tree filtering.
1747 :ignore-list
1750 ;; Compute `:headline-offset' in order to be able to use
1751 ;; `org-export-get-relative-level'.
1754 :headline-offset
1756 ;; Update footnotes definitions list with definitions in parse tree.
1757 ;; This is required since buffer expansion might have modified
1758 ;; boundaries of footnote definitions contained in the parse tree.
1759 ;; This way, definitions in `footnote-definition-alist' are bound to
1760 ;; match those in the parse tree.
1766 defs)))
1768 ;; Properties order doesn't matter: get the rest of the tree
1769 ;; properties.
1773 info))
1776 "Return minimum exportable headline's level in DATA.
1777 DATA is parsed tree as returned by `org-element-parse-buffer'.
1778 OPTIONS is a plist holding export options."
1789 ;; If no headline was found, for the sake of consistency, set
1790 ;; minimum level to 1 nonetheless.
1794 "Return numbering of all exportable headlines in a parse tree.
1796 DATA is the parse tree. OPTIONS is the plist holding export
1797 options.
1799 Return an alist whose key is a headline and value is its
1800 associated numbering \(in the shape of a list of numbers\) or nil
1801 for a footnotes section."
1809 headline
1811 for idx from 0 to org-export-max-depth
1815 options)))
1818 "Return list of elements and objects to ignore during export.
1819 DATA is the parse tree to traverse. OPTIONS is the plist holding
1820 export options."
1822 walk-data
1823 ;; First find trees containing a select tag, if any.
1827 ;; Collect ignored elements or objects into IGNORE-LIST.
1833 ;; If headline is archived but tree below has
1834 ;; to be skipped, add it to ignore list.
1837 ;; Move into secondary string, if any.
1842 ;; Move into recursive objects/elements.
1844 ;; Main call.
1846 ;; Return value.
1847 ignore))
1850 "Return list of headlines containing a select tag in their tree.
1851 DATA is parsed data as returned by `org-element-parse-buffer'.
1852 INFO is a plist holding export options."
1854 walk-data ; for byte-compiler.
1865 ;; When a select tag is found, mark full
1866 ;; genealogy and every headline within the tree
1867 ;; as acceptable.
1870 genealogy
1872 selected-trees))
1873 ;; Else, continue searching in tree, recursively.
1880 "Non-nil when element or object BLOB should be skipped during export.
1881 OPTIONS is the plist holding export options. SELECTED, when
1882 non-nil, is a list of headlines belonging to a tree with a select
1883 tag."
1890 ;; If `:with-drawers' value starts with `not', ignore
1891 ;; every drawer whose name belong to that list.
1892 ;; Otherwise, ignore drawers whose name isn't in that
1893 ;; list.
1905 ;; Ignore subtrees with an exclude tag.
1908 ;; When a select tag is present in the buffer, ignore any tree
1909 ;; without it.
1911 ;; Ignore commented sub-trees.
1913 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1915 ;; Ignore tasks, if specified by `:with-tasks' property.
1932 ;; No timestamp allowed.
1934 ;; Only active timestamps allowed and the current one isn't
1935 ;; active.
1939 ;; Only inactive timestamps allowed and the current one isn't
1940 ;; inactive.
1946 \f
1947 ;;; The Transcoder
1948 ;;
1949 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1950 ;; `org-element-parse-buffer') and transcodes it into a specified
1951 ;; back-end output. It takes care of filtering out elements or
1952 ;; objects according to export options and organizing the output blank
1953 ;; lines and white space are preserved. The function memoizes its
1954 ;; results, so it is cheap to call it within translators.
1955 ;;
1956 ;; It is possible to modify locally the back-end used by
1957 ;; `org-export-data' or even use a temporary back-end by using
1958 ;; `org-export-data-with-translations' and
1959 ;; `org-export-data-with-backend'.
1960 ;;
1961 ;; Internally, three functions handle the filtering of objects and
1962 ;; elements during the export. In particular,
1963 ;; `org-export-ignore-element' marks an element or object so future
1964 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1965 ;; elements or objects should be seen as real Org syntax and
1966 ;; `org-export-expand' transforms the others back into their original
1967 ;; shape
1968 ;;
1969 ;; `org-export-transcoder' is an accessor returning appropriate
1970 ;; translator function for a given element or object.
1973 "Return appropriate transcoder for BLOB.
1974 INFO is a plist containing export directives."
1976 ;; Return contents only for complete parse trees.
1982 "Convert DATA into current back-end format.
1984 DATA is a parse tree, an element or an object or a secondary
1985 string. INFO is a plist holding export options.
1987 Return transcoded string."
1993 ;; Ignored element/object.
1995 ;; Plain text.
2001 info))
2002 ;; Uninterpreted element/object: change it back to Org
2003 ;; syntax and export again resulting raw string.
2007 data
2011 info))
2012 ;; Secondary string.
2015 ;; Element/Object without contents or, as a special case,
2016 ;; headline with archive tag and archived trees restricted
2017 ;; to title only.
2025 ;; Element/Object with contents.
2038 ;; Elements directly containing objects
2039 ;; must have their indentation normalized
2040 ;; first.
2042 data
2043 ;; When normalizing contents of the first
2044 ;; paragraph in an item or a footnote
2045 ;; definition, ignore first line's
2046 ;; indentation: there is none and it
2047 ;; might be misleading.
2052 data)
2059 info))))))))
2060 ;; Final result will be memoized before being returned.
2062 data
2066 ;; Append the same white space between elements or objects as in
2067 ;; the original buffer, and call appropriate filters.
2078 info)))
2079 results)))
2083 "Convert DATA into another format using a given translation table.
2084 DATA is an element, an object, a secondary string or a string.
2085 TRANSLATIONS is an alist between element or object types and
2086 a functions handling them. See `org-export-define-backend' for
2087 more information. INFO is a plist used as a communication
2088 channel."
2090 data
2091 ;; Set-up a new communication channel with TRANSLATIONS as the
2092 ;; translate table and a new hash table for memoization.
2094 info
2096 ;; Size of the hash table is reduced since this function
2097 ;; will probably be used on short trees.
2101 "Convert DATA into BACKEND format.
2103 DATA is an element, an object, a secondary string or a string.
2104 BACKEND is a symbol. INFO is a plist used as a communication
2105 channel.
2107 Unlike to `org-export-with-backend', this function will
2108 recursively convert DATA using BACKEND translation table."
2114 "Non-nil if element or object BLOB should be interpreted during export.
2115 If nil, BLOB will appear as raw Org syntax. Check is done
2116 according to export options INFO, stored as a plist."
2118 ;; ... entities...
2120 ;; ... emphasis...
2123 ;; ... fixed-width areas.
2125 ;; ... footnotes...
2128 ;; ... LaTeX environments and fragments...
2132 ;; ... sub/superscripts...
2138 ;; ... tables...
2143 "Expand a parsed element or object to its original state.
2144 BLOB is either an element or an object. CONTENTS is its
2145 contents, as a string or nil."
2148 blob contents))
2151 "Add ELEMENT to `:ignore-list' in INFO.
2153 Any element in `:ignore-list' will be skipped when using
2154 `org-element-map'. INFO is modified by side effects."
2158 \f
2159 ;;; The Filter System
2160 ;;
2161 ;; Filters allow end-users to tweak easily the transcoded output.
2162 ;; They are the functional counterpart of hooks, as every filter in
2163 ;; a set is applied to the return value of the previous one.
2164 ;;
2165 ;; Every set is back-end agnostic. Although, a filter is always
2166 ;; called, in addition to the string it applies to, with the back-end
2167 ;; used as argument, so it's easy for the end-user to add back-end
2168 ;; specific filters in the set. The communication channel, as
2169 ;; a plist, is required as the third argument.
2170 ;;
2171 ;; From the developer side, filters sets can be installed in the
2172 ;; process with the help of `org-export-define-backend', which
2173 ;; internally stores filters as an alist. Each association has a key
2174 ;; among the following symbols and a function or a list of functions
2175 ;; as value.
2176 ;;
2177 ;; - `:filter-options' applies to the property list containing export
2178 ;; options. Unlike to other filters, functions in this list accept
2179 ;; two arguments instead of three: the property list containing
2180 ;; export options and the back-end. Users can set its value through
2181 ;; `org-export-filter-options-functions' variable.
2182 ;;
2183 ;; - `:filter-parse-tree' applies directly to the complete parsed
2184 ;; tree. Users can set it through
2185 ;; `org-export-filter-parse-tree-functions' variable.
2186 ;;
2187 ;; - `:filter-final-output' applies to the final transcoded string.
2188 ;; Users can set it with `org-export-filter-final-output-functions'
2189 ;; variable
2190 ;;
2191 ;; - `:filter-plain-text' applies to any string not recognized as Org
2192 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2193 ;; configure it.
2194 ;;
2195 ;; - `:filter-TYPE' applies on the string returned after an element or
2196 ;; object of type TYPE has been transcoded. An user can modify
2197 ;; `org-export-filter-TYPE-functions'
2198 ;;
2199 ;; All filters sets are applied with
2200 ;; `org-export-filter-apply-functions' function. Filters in a set are
2201 ;; applied in a LIFO fashion. It allows developers to be sure that
2202 ;; their filters will be applied first.
2203 ;;
2204 ;; Filters properties are installed in communication channel with
2205 ;; `org-export-install-filters' function.
2206 ;;
2207 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2208 ;; `org-export-before-parsing-hook') are run at the beginning of the
2209 ;; export process and just before parsing to allow for heavy structure
2210 ;; modifications.
2213 ;;;; Hooks
2216 "Hook run at the beginning of the export process.
2218 This is run before include keywords and macros are expanded and
2219 Babel code blocks executed, on a copy of the original buffer
2220 being exported. Visibility and narrowing are preserved. Point
2221 is at the beginning of the buffer.
2223 Every function in this hook will be called with one argument: the
2227 "Hook run before parsing an export buffer.
2229 This is run after include keywords and macros have been expanded
2230 and Babel code blocks executed, on a copy of the original buffer
2231 being exported. Visibility and narrowing are preserved. Point
2232 is at the beginning of the buffer.
2234 Every function in this hook will be called with one argument: the
2238 ;;;; Special Filters
2241 "List of functions applied to the export options.
2242 Each filter is called with two arguments: the export options, as
2243 a plist, and the back-end, as a symbol. It must return
2247 "List of functions applied to the parsed tree.
2248 Each filter is called with three arguments: the parse tree, as
2249 returned by `org-element-parse-buffer', the back-end, as
2250 a symbol, and the communication channel, as a plist. It must
2254 "List of functions applied to plain text.
2255 Each filter is called with three arguments: a string which
2256 contains no Org syntax, the back-end, as a symbol, and the
2257 communication channel, as a plist. It must return a string or
2261 "List of functions applied to the transcoded string.
2262 Each filter is called with three arguments: the full transcoded
2263 string, the back-end, as a symbol, and the communication channel,
2264 as a plist. It must return a string that will be used as the
2268 ;;;; Elements Filters
2271 "List of functions applied to a transcoded babel-call.
2272 Each filter is called with three arguments: the transcoded data,
2273 as a string, the back-end, as a symbol, and the communication
2277 "List of functions applied to a transcoded center block.
2278 Each filter is called with three arguments: the transcoded data,
2279 as a string, the back-end, as a symbol, and the communication
2283 "List of functions applied to a transcoded clock.
2284 Each filter is called with three arguments: the transcoded data,
2285 as a string, the back-end, as a symbol, and the communication
2289 "List of functions applied to a transcoded comment.
2290 Each filter is called with three arguments: the transcoded data,
2291 as a string, the back-end, as a symbol, and the communication
2295 "List of functions applied to a transcoded comment-block.
2296 Each filter is called with three arguments: the transcoded data,
2297 as a string, the back-end, as a symbol, and the communication
2301 "List of functions applied to a transcoded diary-sexp.
2302 Each filter is called with three arguments: the transcoded data,
2303 as a string, the back-end, as a symbol, and the communication
2307 "List of functions applied to a transcoded drawer.
2308 Each filter is called with three arguments: the transcoded data,
2309 as a string, the back-end, as a symbol, and the communication
2313 "List of functions applied to a transcoded dynamic-block.
2314 Each filter is called with three arguments: the transcoded data,
2315 as a string, the back-end, as a symbol, and the communication
2319 "List of functions applied to a transcoded example-block.
2320 Each filter is called with three arguments: the transcoded data,
2321 as a string, the back-end, as a symbol, and the communication
2325 "List of functions applied to a transcoded export-block.
2326 Each filter is called with three arguments: the transcoded data,
2327 as a string, the back-end, as a symbol, and the communication
2331 "List of functions applied to a transcoded fixed-width.
2332 Each filter is called with three arguments: the transcoded data,
2333 as a string, the back-end, as a symbol, and the communication
2337 "List of functions applied to a transcoded footnote-definition.
2338 Each filter is called with three arguments: the transcoded data,
2339 as a string, the back-end, as a symbol, and the communication
2343 "List of functions applied to a transcoded headline.
2344 Each filter is called with three arguments: the transcoded data,
2345 as a string, the back-end, as a symbol, and the communication
2349 "List of functions applied to a transcoded horizontal-rule.
2350 Each filter is called with three arguments: the transcoded data,
2351 as a string, the back-end, as a symbol, and the communication
2355 "List of functions applied to a transcoded inlinetask.
2356 Each filter is called with three arguments: the transcoded data,
2357 as a string, the back-end, as a symbol, and the communication
2361 "List of functions applied to a transcoded item.
2362 Each filter is called with three arguments: the transcoded data,
2363 as a string, the back-end, as a symbol, and the communication
2367 "List of functions applied to a transcoded keyword.
2368 Each filter is called with three arguments: the transcoded data,
2369 as a string, the back-end, as a symbol, and the communication
2373 "List of functions applied to a transcoded latex-environment.
2374 Each filter is called with three arguments: the transcoded data,
2375 as a string, the back-end, as a symbol, and the communication
2379 "List of functions applied to a transcoded node-property.
2380 Each filter is called with three arguments: the transcoded data,
2381 as a string, the back-end, as a symbol, and the communication
2385 "List of functions applied to a transcoded paragraph.
2386 Each filter is called with three arguments: the transcoded data,
2387 as a string, the back-end, as a symbol, and the communication
2391 "List of functions applied to a transcoded plain-list.
2392 Each filter is called with three arguments: the transcoded data,
2393 as a string, the back-end, as a symbol, and the communication
2397 "List of functions applied to a transcoded planning.
2398 Each filter is called with three arguments: the transcoded data,
2399 as a string, the back-end, as a symbol, and the communication
2403 "List of functions applied to a transcoded property-drawer.
2404 Each filter is called with three arguments: the transcoded data,
2405 as a string, the back-end, as a symbol, and the communication
2409 "List of functions applied to a transcoded quote block.
2410 Each filter is called with three arguments: the transcoded quote
2411 data, as a string, the back-end, as a symbol, and the
2412 communication channel, as a plist. It must return a string or
2416 "List of functions applied to a transcoded quote-section.
2417 Each filter is called with three arguments: the transcoded data,
2418 as a string, the back-end, as a symbol, and the communication
2422 "List of functions applied to a transcoded section.
2423 Each filter is called with three arguments: the transcoded data,
2424 as a string, the back-end, as a symbol, and the communication
2428 "List of functions applied to a transcoded special block.
2429 Each filter is called with three arguments: the transcoded data,
2430 as a string, the back-end, as a symbol, and the communication
2434 "List of functions applied to a transcoded src-block.
2435 Each filter is called with three arguments: the transcoded data,
2436 as a string, the back-end, as a symbol, and the communication
2440 "List of functions applied to a transcoded table.
2441 Each filter is called with three arguments: the transcoded data,
2442 as a string, the back-end, as a symbol, and the communication
2446 "List of functions applied to a transcoded table-cell.
2447 Each filter is called with three arguments: the transcoded data,
2448 as a string, the back-end, as a symbol, and the communication
2452 "List of functions applied to a transcoded table-row.
2453 Each filter is called with three arguments: the transcoded data,
2454 as a string, the back-end, as a symbol, and the communication
2458 "List of functions applied to a transcoded verse block.
2459 Each filter is called with three arguments: the transcoded data,
2460 as a string, the back-end, as a symbol, and the communication
2464 ;;;; Objects Filters
2467 "List of functions applied to transcoded bold text.
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 transcoded code text.
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 entity.
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-snippet.
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 footnote-reference.
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 inline-babel-call.
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 inline-src-block.
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 transcoded italic text.
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 latex-fragment.
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 line-break.
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 link.
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 macro.
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 radio-target.
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 statistics-cookie.
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 transcoded strike-through text.
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 subscript.
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 superscript.
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 target.
2570 Each filter is called with three arguments: the transcoded data,
2571 as a string, the back-end, as a symbol, and the communication
2575 "List of functions applied to a transcoded timestamp.
2576 Each filter is called with three arguments: the transcoded data,
2577 as a string, the back-end, as a symbol, and the communication
2581 "List of functions applied to transcoded underline text.
2582 Each filter is called with three arguments: the transcoded data,
2583 as a string, the back-end, as a symbol, and the communication
2587 "List of functions applied to transcoded verbatim text.
2588 Each filter is called with three arguments: the transcoded data,
2589 as a string, the back-end, as a symbol, and the communication
2593 ;;;; Filters Tools
2594 ;;
2595 ;; Internal function `org-export-install-filters' installs filters
2596 ;; hard-coded in back-ends (developer filters) and filters from global
2597 ;; variables (user filters) in the communication channel.
2598 ;;
2599 ;; Internal function `org-export-filter-apply-functions' takes care
2600 ;; about applying each filter in order to a given data. It ignores
2601 ;; filters returning a nil value but stops whenever a filter returns
2602 ;; an empty string.
2605 "Call every function in FILTERS.
2607 Functions are called with arguments VALUE, current export
2608 back-end and INFO. A function returning a nil value will be
2609 skipped. If it returns the empty string, the process ends and
2610 VALUE is ignored.
2612 Call is done in a LIFO fashion, to be sure that developer
2613 specified filters, if any, are called first."
2622 "Install filters properties in communication channel.
2623 INFO is a plist containing the current communication channel.
2624 Return the updated communication channel."
2626 ;; Install user-defined filters with `org-export-filters-alist'
2627 ;; and filters already in INFO (through ext-plist mechanism).
2634 ;; Filters in INFO will be called
2635 ;; before those user provided.
2638 default-value)))))
2639 org-export-filters-alist)
2640 ;; Prepend back-end specific filters to that list.
2642 ;; Single values get consed, lists are appended.
2647 plist key
2651 ;; Return new communication channel.
2655 \f
2656 ;;; Core functions
2657 ;;
2658 ;; This is the room for the main function, `org-export-as', along with
2659 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2660 ;; `org-export-string-as'. They differ either by the way they output
2661 ;; the resulting code (for the first two) or by the input type (for
2662 ;; the latter).
2663 ;;
2664 ;; `org-export-output-file-name' is an auxiliary function meant to be
2665 ;; used with `org-export-to-file'. With a given extension, it tries
2666 ;; to provide a canonical file name to write export output to.
2667 ;;
2668 ;; Note that `org-export-as' doesn't really parse the current buffer,
2669 ;; but a copy of it (with the same buffer-local variables and
2670 ;; visibility), where macros and include keywords are expanded and
2671 ;; Babel blocks are executed, if appropriate.
2672 ;; `org-export-with-buffer-copy' macro prepares that copy.
2673 ;;
2674 ;; File inclusion is taken care of by
2675 ;; `org-export-expand-include-keyword' and
2676 ;; `org-export--prepare-file-contents'. Structure wise, including
2677 ;; a whole Org file in a buffer often makes little sense. For
2678 ;; example, if the file contains a headline and the include keyword
2679 ;; was within an item, the item should contain the headline. That's
2680 ;; why file inclusion should be done before any structure can be
2681 ;; associated to the file, that is before parsing.
2684 "Return a copy of the current buffer.
2685 The copy preserves Org buffer-local variables, visibility and
2686 narrowing."
2692 new-buf))
2695 "Apply BODY in a copy of the current buffer.
2696 The copy preserves local variables, visibility and contents of
2697 the original buffer. Point is at the beginning of the buffer
2698 when BODY is applied."
2707 ;; Kill copy without confirmation.
2713 "Generate a function duplicating BUFFER.
2715 The copy will preserve local variables, visibility, contents and
2716 narrowing of the original buffer. If a region was active in
2717 BUFFER, contents will be narrowed to that region instead.
2719 The resulting function can be eval'ed at a later time, from
2720 another buffer, effectively cloning the original buffer there."
2724 ;; Buffer local variables.
2734 default-directory
2735 buffer-file-name
2736 buffer-file-coding-system
2737 outline-level
2738 outline-regexp
2739 buffer-invisibility-spec))
2742 ;; Skip unreadable values, as they cannot be
2743 ;; sent to external process.
2747 local-vars)))))
2749 local-vars)
2750 ;; Whole buffer contents.
2755 ;; Narrowing.
2759 ;; Current position of point.
2761 ;; Overlays with invisible property.
2771 ov-set))))
2773 ov-set)))))
2775 ;;;###autoload
2778 "Transcode current Org buffer into BACKEND code.
2780 If narrowing is active in the current buffer, only transcode its
2781 narrowed part.
2783 If a region is active, transcode that region.
2785 When optional argument SUBTREEP is non-nil, transcode the
2786 sub-tree at point, extracting information from the headline
2787 properties first.
2789 When optional argument VISIBLE-ONLY is non-nil, don't export
2790 contents of hidden elements.
2792 When optional argument BODY-ONLY is non-nil, only return body
2793 code, without surrounding template.
2795 Optional argument EXT-PLIST, when provided, is a property list
2796 with external parameters overriding Org default settings, but
2797 still inferior to file-local settings.
2799 Return code as a string."
2803 ;; Narrow buffer to an appropriate region or subtree for
2804 ;; parsing. If parsing subtree, be sure to remove main headline
2805 ;; too.
2813 ;; Initialize communication channel with original buffer
2814 ;; attributes, unavailable in its copy.
2816 ;; Update communication channel and get parse tree. Buffer
2817 ;; isn't parsed directly. Instead, a temporary copy is
2818 ;; created, where include keywords, macros are expanded and
2819 ;; code blocks are evaluated.
2821 ;; Run first hook with current back-end as argument.
2824 ;; Update macro templates since #+INCLUDE keywords might have
2825 ;; added some new ones.
2829 ;; Update radio targets since keyword inclusion might have
2830 ;; added some more.
2832 ;; Run last hook with current back-end as argument.
2835 ;; Update communication channel with environment. Also
2836 ;; install user's and developer's filters.
2841 ;; Expand export-specific set of macros: {{{author}}},
2842 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2843 ;; once regular macros have been expanded, since document
2844 ;; keywords may contain one of them.
2850 ;; EMAIL is not a parsed keyword: store it as-is.
2854 ;; Call options filters and update export options. We do not
2855 ;; use `org-export-filter-apply-functions' here since the
2856 ;; arity of such filters is different.
2860 ;; Parse buffer and call parse-tree filter on it.
2865 ;; Now tree is complete, compute its properties and add them
2866 ;; to communication channel.
2870 ;; Eventually transcode TREE. Wrap the resulting string into
2871 ;; a template.
2880 ;; Remove all text properties since they cannot be
2881 ;; retrieved from an external process. Finally call
2882 ;; final-output filter and return result.
2888 info))))))))
2890 ;;;###autoload
2893 "Call `org-export-as' with output to a specified buffer.
2895 BACKEND is the back-end used for transcoding, as a symbol.
2897 BUFFER is the output buffer. If it already exists, it will be
2898 erased first, otherwise, it will be created.
2900 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2901 EXT-PLIST are similar to those used in `org-export-as', which
2902 see.
2904 If `org-export-copy-to-kill-ring' is non-nil, add buffer contents
2905 to kill ring. Return buffer."
2912 ;; Maybe add buffer contents to kill ring.
2915 ;; Return buffer.
2916 buffer))
2918 ;;;###autoload
2921 "Call `org-export-as' with output to a specified file.
2923 BACKEND is the back-end used for transcoding, as a symbol. FILE
2924 is the name of the output file, as a string.
2926 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2927 EXT-PLIST are similar to those used in `org-export-as', which
2928 see.
2930 If `org-export-copy-to-kill-ring' is non-nil, add file contents
2931 to kill ring. Return output file's name."
2932 ;; Checks for FILE permissions. `write-file' would do the same, but
2933 ;; we'd rather avoid needless transcoding of parse tree.
2935 ;; Insert contents to a temporary buffer and write it to FILE.
2941 ;; Maybe add file contents to kill ring.
2944 ;; Return full path.
2945 file)
2947 ;;;###autoload
2949 "Transcode STRING into BACKEND code.
2951 When optional argument BODY-ONLY is non-nil, only return body
2952 code, without preamble nor postamble.
2954 Optional argument EXT-PLIST, when provided, is a property list
2955 with external parameters overriding Org default settings, but
2956 still inferior to file-local settings.
2958 Return code as a string."
2965 "Return output file's name according to buffer specifications.
2967 EXTENSION is a string representing the output file extension,
2968 with the leading dot.
2970 With a non-nil optional argument SUBTREEP, try to determine
2972 of subtree at point.
2974 When optional argument PUB-DIR is set, use it as the publishing
2975 directory.
2977 When optional argument VISIBLE-ONLY is non-nil, don't export
2978 contents of hidden elements.
2980 Return file name as a string."
2983 ;; File name may come from EXPORT_FILE_NAME subtree
2984 ;; property, assuming point is at beginning of said
2985 ;; sub-tree.
2992 ;; File name may be extracted from buffer's associated
2993 ;; file, if any.
2995 ;; Can't determine file name on our own: Ask user.
2999 "Output file: " pub-dir nil nil nil
3003 ;; Build file name. Enforce EXTENSION over whatever user
3004 ;; may have come up with. PUB-DIR, if defined, always has
3005 ;; precedence over any provided path.
3010 extension))
3013 ;; If writing to OUTPUT-FILE would overwrite original file, append
3014 ;; EXTENSION another time to final name.
3017 output-file)))
3020 "Expand every include keyword in buffer.
3021 Optional argument INCLUDED is a list of included file names along
3022 with their line restriction, when appropriate. It is used to
3023 avoid infinite recursion. Optional argument DIR is the current
3024 working directory. It is used to properly resolve relative
3025 paths."
3032 ;; Extract arguments from keyword's value.
3046 ;; Minimal level of included file defaults to the child
3047 ;; level of the current headline, if any, or one. It
3048 ;; only applies is the file is meant to be included as
3049 ;; an Org one.
3057 ;; Remove keyword.
3062 ;; Check if files has already been parsed. Look after
3063 ;; inclusion lines too, as different parts of the same file
3064 ;; can be included too.
3076 ind-str contents ind-str))))
3084 ind-str env contents ind-str))))
3097 "Prepare the contents of FILE for inclusion and return them as a string.
3099 When optional argument LINES is a string specifying a range of
3100 lines, include only those lines.
3102 Optional argument IND, when non-nil, is an integer specifying the
3103 global indentation of returned contents. Since its purpose is to
3104 allow an included file to stay in the same environment it was
3105 created \(i.e. a list item), it doesn't apply past the first
3106 headline encountered.
3108 Optional argument MINLEVEL, when non-nil, is an integer
3109 specifying the level that any top-level headline in the included
3110 file should have."
3126 ;; Remove blank lines at beginning and end of contents. The logic
3127 ;; behind that removal is that blank lines around include keyword
3128 ;; override blank lines in included file.
3137 ;; If IND is set, preserve indentation of include keyword until
3138 ;; the first headline encountered.
3144 ;; Do not move footnote definitions out of column 0.
3150 ;; When MINLEVEL is specified, compute minimal level for headlines
3151 ;; in the file (CUR-MIN), and remove stars to each headline so
3152 ;; that headlines with minimal level have a level of MINLEVEL.
3162 ;; Only change stars, don't bother moving whole
3163 ;; sections.
3170 "Execute every Babel code in the visible part of current buffer."
3171 ;; Get a pristine copy of current buffer so Babel references can be
3172 ;; properly resolved.
3179 \f
3180 ;;; Tools For Back-Ends
3181 ;;
3182 ;; A whole set of tools is available to help build new exporters. Any
3183 ;; function general enough to have its use across many back-ends
3184 ;; should be added here.
3186 ;;;; For Affiliated Keywords
3187 ;;
3188 ;; `org-export-read-attribute' reads a property from a given element
3189 ;; as a plist. It can be used to normalize affiliated keywords'
3190 ;; syntax.
3191 ;;
3192 ;; Since captions can span over multiple lines and accept dual values,
3193 ;; their internal representation is a bit tricky. Therefore,
3194 ;; `org-export-get-caption' transparently returns a given element's
3195 ;; caption as a secondary string.
3198 "Turn ATTRIBUTE property from ELEMENT into a plist.
3200 When optional argument PROPERTY is non-nil, return the value of
3201 that property within attributes.
3205 properties."
3213 "Return caption from ELEMENT as a secondary string.
3215 When optional argument SHORTP is non-nil, return short caption,
3216 as a secondary string, instead.
3218 Caption lines are separated by a white space."
3226 ;;;; For Derived Back-ends
3227 ;;
3228 ;; `org-export-with-backend' is a function allowing to locally use
3229 ;; another back-end to transcode some object or element. In a derived
3230 ;; back-end, it may be used as a fall-back function once all specific
3231 ;; cases have been treated.
3234 "Call a transcoder from BACK-END on DATA.
3235 CONTENTS, when non-nil, is the transcoded contents of DATA
3236 element, as a string. INFO, when non-nil, is the communication
3237 channel used for export, as a plist.."
3247 ;;;; For Export Snippets
3248 ;;
3249 ;; Every export snippet is transmitted to the back-end. Though, the
3250 ;; latter will only retain one type of export-snippet, ignoring
3251 ;; others, based on the former's target back-end. The function
3252 ;; `org-export-snippet-backend' returns that back-end for a given
3253 ;; export-snippet.
3256 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3257 Translation, with `org-export-snippet-translation-alist', is
3258 applied."
3262 back-end))))
3265 ;;;; For Footnotes
3266 ;;
3267 ;; `org-export-collect-footnote-definitions' is a tool to list
3268 ;; actually used footnotes definitions in the whole parse tree, or in
3269 ;; a headline, in order to add footnote listings throughout the
3270 ;; transcoded data.
3271 ;;
3272 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3273 ;; back-ends, when they need to attach the footnote definition only to
3274 ;; the first occurrence of the corresponding label.
3275 ;;
3276 ;; `org-export-get-footnote-definition' and
3277 ;; `org-export-get-footnote-number' provide easier access to
3278 ;; additional information relative to a footnote reference.
3281 "Return an alist between footnote numbers, labels and definitions.
3283 DATA is the parse tree from which definitions are collected.
3284 INFO is the plist used as a communication channel.
3286 Definitions are sorted by order of references. They either
3287 appear as Org data or as a secondary string for inlined
3288 footnotes. Unreferenced definitions are ignored."
3290 collect-fn ; for byte-compiler.
3294 ;; Collect footnote number, label and definition in DATA.
3302 def)
3303 num-alist)
3304 ;; Also search in definition for nested footnotes.
3307 ;; Don't enter footnote definitions since it will happen
3308 ;; when their first reference is found.
3314 "Non-nil when a footnote reference is the first one for its label.
3316 FOOTNOTE-REFERENCE is the footnote reference being considered.
3317 INFO is the plist used as a communication channel."
3319 ;; Anonymous footnotes are always a first reference.
3321 ;; Otherwise, return the first footnote with the same LABEL and
3322 ;; test if it is equal to FOOTNOTE-REFERENCE.
3332 ;; If FN isn't inlined, be sure to traverse its
3333 ;; definition before resuming search. See
3334 ;; comments in `org-export-get-footnote-number'
3335 ;; for more information.
3339 ;; Don't enter footnote definitions since it will
3340 ;; happen when their first reference is found.
3343 footnote-reference)))))
3346 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3347 INFO is the plist used as a communication channel. If no such
3349 string."
3356 "Return number associated to a footnote.
3358 FOOTNOTE is either a footnote reference or a footnote definition.
3359 INFO is the plist used as a communication channel."
3361 seen-refs
3362 search-ref ; For byte-compiler.
3366 ;; Search footnote references through DATA, filling
3367 ;; SEEN-REFS along the way.
3372 ;; Anonymous footnote match: return number.
3375 ;; Labels match: return number.
3378 ;; Anonymous footnote: it's always a new one.
3379 ;; Also, be sure to return nil from the `cond' so
3380 ;; `first-match' doesn't get us out of the loop.
3382 ;; Label not seen so far: add it so SEEN-REFS.
3383 ;;
3384 ;; Also search for subsequent references in
3385 ;; footnote definition so numbering follows
3386 ;; reading logic. Note that we don't have to care
3387 ;; about inline definitions, since
3388 ;; `org-element-map' already traverses them at the
3389 ;; right time.
3390 ;;
3391 ;; Once again, return nil to stay in the loop.
3396 nil))))
3397 ;; Don't enter footnote definitions since it will
3398 ;; happen when their first reference is found.
3403 ;;;; For Headlines
3404 ;;
3405 ;; `org-export-get-relative-level' is a shortcut to get headline
3406 ;; level, relatively to the lower headline level in the parsed tree.
3407 ;;
3408 ;; `org-export-get-headline-number' returns the section number of an
3409 ;; headline, while `org-export-number-to-roman' allows to convert it
3410 ;; to roman numbers.
3411 ;;
3412 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3413 ;; `org-export-last-sibling-p' are three useful predicates when it
3414 ;; comes to fulfill the `:headline-levels' property.
3415 ;;
3416 ;; `org-export-get-tags', `org-export-get-category' and
3417 ;; `org-export-get-node-property' extract useful information from an
3418 ;; headline or a parent headline. They all handle inheritance.
3421 "Return HEADLINE relative level within current parsed tree.
3422 INFO is a plist holding contextual information."
3427 "Non-nil when HEADLINE is considered as low level.
3429 INFO is a plist used as a communication channel.
3431 A low level headlines has a relative level greater than
3432 `:headline-levels' property value.
3434 Return value is the difference between HEADLINE relative level
3435 and the last level being considered as high enough, or nil."
3442 "Return HEADLINE numbering as a list of numbers.
3443 INFO is a plist holding contextual information."
3447 "Return a non-nil value if HEADLINE element should be numbered.
3448 INFO is a plist used as a communication channel."
3454 "Convert integer N into a roman numeral."
3467 res)))
3470 "Return list of tags associated to ELEMENT.
3472 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3473 is a plist used as a communication channel.
3475 Select tags (see `org-export-select-tags') and exclude tags (see
3476 `org-export-exclude-tags') are removed from the list.
3478 When non-nil, optional argument TAGS should be a list of strings.
3479 Any tag belonging to this list will also be removed.
3481 When optional argument INHERITED is non-nil, tags can also be
3482 inherited from parent headlines and FILETAGS keywords."
3488 ;; Build complete list of inherited tags.
3499 ;; Add FILETAGS keywords and return results.
3503 "Return node PROPERTY value for BLOB.
3505 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3506 element or object.
3508 If optional argument INHERITED is non-nil, the value can be
3509 inherited from a parent headline.
3511 Return value is a string or nil."
3523 "Return category for element or object BLOB.
3525 INFO is a plist used as a communication channel.
3527 CATEGORY is automatically inherited from a parent headline, from
3528 #+CATEGORY: keyword or created out of original file name. If all
3532 ;; Almost like `org-export-node-property', but we cannot trust
3533 ;; `plist-member' as every headline has a `:CATEGORY'
3534 ;; property, would it be nil or equal to "???" (which has the
3535 ;; same meaning).
3553 "Return optional title for HEADLINE, as a secondary string.
3554 INFO is a plist used as a communication channel. If no optional
3555 title is defined, fall-back to the regular title."
3560 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3561 INFO is a plist used as a communication channel."
3566 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3567 INFO is a plist used as a communication channel."
3571 ;;;; For Links
3572 ;;
3573 ;; `org-export-solidify-link-text' turns a string into a safer version
3574 ;; for links, replacing most non-standard characters with hyphens.
3575 ;;
3576 ;; `org-export-get-coderef-format' returns an appropriate format
3577 ;; string for coderefs.
3578 ;;
3579 ;; `org-export-inline-image-p' returns a non-nil value when the link
3580 ;; provided should be considered as an inline image.
3581 ;;
3582 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3583 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3584 ;; returns an appropriate unique identifier when found, or nil.
3585 ;;
3586 ;; `org-export-resolve-id-link' returns the first headline with
3587 ;; specified id or custom-id in parse tree, the path to the external
3588 ;; file with the id or nil when neither was found.
3589 ;;
3590 ;; `org-export-resolve-coderef' associates a reference to a line
3591 ;; number in the element it belongs, or returns the reference itself
3592 ;; when the element isn't numbered.
3595 "Take link text S and make a safe target out of it."
3600 "Return format string for code reference link.
3601 PATH is the link path. DESC is its description."
3609 "Non-nil if LINK object points to an inline image.
3611 Optional argument is a set of RULES defining inline images. It
3612 is an alist where associations have the following shape:
3614 \(TYPE . REGEXP)
3616 Applying a rule means apply REGEXP against LINK's path when its
3617 type is TYPE. The function will return a non-nil value if any of
3618 the provided rules is non-nil. The default rule is
3619 `org-export-default-inline-image-rule'.
3621 This only applies to links without a description."
3632 rules)
3633 ;; Return nil if no rule matched.
3634 nil))))
3637 "Resolve a code reference REF.
3639 INFO is a plist used as a communication channel.
3641 Return associated line number in source code, or REF itself,
3642 depending on src-block or example element's switches."
3649 org-coderef-label-format)))
3653 ;; Element containing REF is found. Resolve it to either
3654 ;; a label or a line number, as needed.
3664 "Return LINK destination.
3666 INFO is a plist holding contextual information.
3668 Return value can be an object, an element, or nil:
3670 - If LINK path matches a target object (i.e. <<path>>) or
3673 - If LINK path exactly matches the name affiliated keyword
3674 \(i.e. #+NAME: path) of an element, return that element.
3676 - If LINK path exactly matches any headline name, return that
3677 element. If more than one headline share that name, priority
3678 will be given to the one with the closest common ancestor, if
3679 any, or the first one in the parse tree otherwise.
3681 - Otherwise, return nil.
3684 significant."
3687 ;; Split PATH at white spaces so matches are space
3688 ;; insensitive.
3692 ;; First try to find a matching "<<path>>" unless user specified
3693 ;; he was looking for a headline (path starts with a *
3694 ;; character).
3701 path)
3702 blob))
3703 info t)))
3704 ;; Then try to find an element with a matching "#+NAME: path"
3705 ;; affiliated keyword.
3708 org-element-all-elements
3713 ;; Last case: link either points to a headline or to
3714 ;; nothingness. Try to find the source, with priority given to
3715 ;; headlines with the closest common ancestor. If such candidate
3716 ;; is found, return it, otherwise return nil.
3720 ;; Return first headline whose `:raw-value' property is
3721 ;; NAME in parse tree DATA, or nil. Statistics cookies
3722 ;; are ignored.
3730 name)
3731 headline))
3733 ;; Search among headlines sharing an ancestor with link, from
3734 ;; closest to farthest.
3742 ;; No match with a common ancestor: try full parse-tree.
3746 "Return headline referenced as LINK destination.
3748 INFO is a plist used as a communication channel.
3750 Return value can be the headline element matched in current parse
3754 ;; First check if id is within the current parse tree.
3759 headline))
3761 ;; Otherwise, look for external files.
3765 "Return radio-target object referenced as LINK destination.
3767 INFO is a plist used as a communication channel.
3769 Return value can be a radio-target object or nil. Assume LINK
3776 radio))
3780 ;;;; For References
3781 ;;
3782 ;; `org-export-get-ordinal' associates a sequence number to any object
3783 ;; or element.
3786 "Return ordinal number of an element or object.
3788 ELEMENT is the element or object considered. INFO is the plist
3789 used as a communication channel.
3791 Optional argument TYPES, when non-nil, is a list of element or
3792 object types, as symbols, that should also be counted in.
3793 Otherwise, only provided element's type is considered.
3795 Optional argument PREDICATE is a function returning a non-nil
3796 value if the current element or object should be counted in. It
3797 accepts two arguments: the element or object being considered and
3798 the plist used as a communication channel. This allows to count
3799 only a certain type of objects (i.e. inline images).
3801 Return value is a list of numbers if ELEMENT is a headline or an
3802 item. It is nil for keywords. It represents the footnote number
3803 for footnote definitions and footnote references. If ELEMENT is
3804 a target, return the same value as if ELEMENT was the closest
3805 table, item or headline containing the target. In any other
3806 case, return the sequence number of ELEMENT among elements or
3807 objects of the same type."
3808 ;; A target keyword, representing an invisible target, never has
3809 ;; a sequence number.
3811 ;; Ordinal of a target object refer to the ordinal of the closest
3812 ;; table, item, or headline containing the object.
3816 when
3820 table))
3821 return parent)))
3823 ;; Special case 1: A headline returns its number as a list.
3825 ;; Special case 2: An item returns its number as a list.
3829 struct
3836 ;; Increment counter until ELEMENT is found again.
3847 ;;;; For Src-Blocks
3848 ;;
3849 ;; `org-export-get-loc' counts number of code lines accumulated in
3850 ;; src-block or example-block elements with a "+n" switch until
3851 ;; a given element, excluded. Note: "-n" switches reset that count.
3852 ;;
3853 ;; `org-export-unravel-code' extracts source code (along with a code
3854 ;; references alist) from an `element-block' or `src-block' type
3855 ;; element.
3856 ;;
3857 ;; `org-export-format-code' applies a formatting function to each line
3858 ;; of code, providing relative line number and code reference when
3859 ;; appropriate. Since it doesn't access the original element from
3860 ;; which the source code is coming, it expects from the code calling
3861 ;; it to know if lines should be numbered and if code references
3862 ;; should appear.
3863 ;;
3864 ;; Eventually, `org-export-format-code-default' is a higher-level
3865 ;; function (it makes use of the two previous functions) which handles
3866 ;; line numbering and code references inclusion, and returns source
3867 ;; code in a format suitable for plain text or verbatim output.
3870 "Return accumulated lines of code up to ELEMENT.
3872 INFO is the plist used as a communication channel.
3874 ELEMENT is excluded from count."
3880 ;; ELEMENT is reached: Quit the loop.
3882 ;; Only count lines from src-block and example-block elements
3883 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3887 ;; Accumulate locs or reset them.
3891 ;; Return nil to stay in the loop.
3892 nil)))
3894 ;; Return value.
3895 loc))
3898 "Clean source code and extract references out of it.
3900 ELEMENT has either a `src-block' an `example-block' type.
3902 Return a cons cell whose CAR is the source code, cleaned from any
3903 reference and protective comma and CDR is an alist between
3904 relative line number (integer) and name of code reference on that
3905 line (string)."
3907 ;; Get code and clean it. Remove blank lines at its
3908 ;; beginning and end.
3914 ;; If appropriate, remove global indentation.
3917 c
3919 ;; Get format used for references.
3922 org-coderef-label-format)))
3923 ;; Build a regexp matching a loc with a reference.
3928 ;; Return value.
3930 ;; Code with references removed.
3936 ;; Ref line: remove ref, and signal its position in REFS.
3940 ;; Reference alist.
3941 refs)))
3944 "Format CODE by applying FUN line-wise and return it.
3946 CODE is a string representing the code to format. FUN is
3947 a function. It must accept three arguments: a line of
3948 code (string), the current line number (integer) or nil and the
3949 reference associated to the current line (string) or nil.
3951 Optional argument NUM-LINES can be an integer representing the
3952 number of code lines accumulated until the current code. Line
3953 numbers passed to FUN will take it into account. If it is nil,
3954 FUN's second argument will always be nil. This number can be
3955 obtained with `org-export-get-loc' function.
3957 Optional argument REF-ALIST can be an alist between relative line
3958 number (i.e. ignoring NUM-LINES) and the name of the code
3959 reference on it. If it is nil, FUN's third argument will always
3960 be nil. It can be obtained through the use of
3961 `org-export-unravel-code' function."
3973 "Return source code from ELEMENT, formatted in a standard way.
3975 ELEMENT is either a `src-block' or `example-block' element. INFO
3976 is a plist used as a communication channel.
3978 This function takes care of line numbering and code references
3979 inclusion. Line numbers, when applicable, appear at the
3980 beginning of the line, separated from the code by two white
3981 spaces. Code references, on the other hand, appear flushed to
3982 the right, separated by six white spaces from the widest line of
3983 code."
3984 ;; Extract code and references.
3990 ;; Handle line numbering.
3999 ;; Prepare references display, if required. Any reference
4000 ;; should start six columns after the widest line of code,
4001 ;; wrapped with parenthesis.
4006 code
4010 number-str
4011 loc
4017 num-start refs)))
4020 ;;;; For Tables
4021 ;;
4022 ;; `org-export-table-has-special-column-p' and and
4023 ;; `org-export-table-row-is-special-p' are predicates used to look for
4024 ;; meta-information about the table structure.
4025 ;;
4026 ;; `org-table-has-header-p' tells when the rows before the first rule
4027 ;; should be considered as table's header.
4028 ;;
4029 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4030 ;; and `org-export-table-cell-borders' extract information from
4031 ;; a table-cell element.
4032 ;;
4033 ;; `org-export-table-dimensions' gives the number on rows and columns
4034 ;; in the table, ignoring horizontal rules and special columns.
4035 ;; `org-export-table-cell-address', given a table-cell object, returns
4036 ;; the absolute address of a cell. On the other hand,
4037 ;; `org-export-get-table-cell-at' does the contrary.
4038 ;;
4039 ;; `org-export-table-cell-starts-colgroup-p',
4040 ;; `org-export-table-cell-ends-colgroup-p',
4041 ;; `org-export-table-row-starts-rowgroup-p',
4042 ;; `org-export-table-row-ends-rowgroup-p',
4043 ;; `org-export-table-row-starts-header-p' and
4044 ;; `org-export-table-row-ends-header-p' indicate position of current
4045 ;; row or cell within the table.
4048 "Non-nil when TABLE has a special column.
4049 All special columns will be ignored during export."
4050 ;; The table has a special column when every first cell of every row
4051 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4052 ;; "*" "_" and "^". Though, do not consider a first row containing
4053 ;; only empty cells as special.
4069 "Non-nil when TABLE has an header.
4071 INFO is a plist used as a communication channel.
4073 A table has an header when it contains at least two row groups."
4083 info)))
4086 "Non-nil if TABLE-ROW is considered special.
4088 INFO is a plist used as the communication channel.
4090 All special rows will be ignored during export."
4094 ;; A row is special either when...
4096 ;; ... it starts with a field only containing "/",
4098 ;; ... the table contains a special column and the row start
4099 ;; with a marking character among, "^", "_", "$" or "!",
4103 ;; ... it contains only alignment cookies and empty cells.
4109 ;; Since VALUE is a secondary string, the following
4110 ;; checks avoid expanding it with `org-export-data'.
4122 "Return TABLE-ROW's group.
4124 INFO is a plist used as the communication channel.
4126 Return value is the group number, as an integer, or nil special
4127 rows and table rules. Group 1 is also table's header."
4144 "Return TABLE-CELL contents width.
4146 INFO is a plist used as the communication channel.
4148 Return value is the width given by the last width cookie in the
4149 same column as TABLE-CELL, or nil."
4154 cookie-width)
4158 ;; In a special row, try to find a width cookie at COLUMN.
4162 ;; The following checks avoid expanding unnecessarily the
4163 ;; cell with `org-export-data'
4171 ;; Ignore table rules.
4174 ;; Return value.
4175 cookie-width))
4178 "Return TABLE-CELL contents alignment.
4180 INFO is a plist used as the communication channel.
4182 Return alignment as specified by the last alignment cookie in the
4183 same column as TABLE-CELL. If no such cookie is found, a default
4184 alignment value will be deduced from fraction of numbers in the
4185 column (see `org-table-number-fraction' for more information).
4186 Possible values are `left', `right' and `center'."
4193 cookie-align)
4197 ;; In a special row, try to find an alignment cookie at
4198 ;; COLUMN.
4202 ;; Since VALUE is a secondary string, the following checks
4203 ;; avoid useless expansion through `org-export-data'.
4211 ;; Ignore table rules.
4213 ;; In a standard row, check if cell's contents are expressing
4214 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4215 ;; Though, don't bother if an alignment cookie has already
4216 ;; defined cell's alignment.
4221 info)))
4226 ;; Return value. Alignment specified by cookies has precedence
4227 ;; over alignment deduced from cells contents.
4236 "Return TABLE-CELL borders.
4238 INFO is a plist used as a communication channel.
4240 Return value is a list of symbols, or nil. Possible values are:
4241 `top', `bottom', `above', `below', `left' and `right'. Note:
4242 `top' (resp. `bottom') only happen for a cell in the first
4243 row (resp. last row) of the table, ignoring table rules, if any.
4245 Returned borders ignore special rows."
4248 borders)
4249 ;; Top/above border? TABLE-CELL has a border above when a rule
4250 ;; used to demarcate row groups can be found above. Hence,
4251 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4252 ;; another regular row has to be found above that rule.
4261 ;; Look at every row before the current one.
4263 ;; No rule above, or rule found starts the table (ignoring any
4264 ;; special row): TABLE-CELL is at the top of the table.
4267 ;; Bottom/below border? TABLE-CELL has a border below when next
4268 ;; non-regular row below is a rule.
4277 ;; Look at every row after the current one.
4279 ;; No rule below, or rule found ends the table (modulo some
4280 ;; special row): TABLE-CELL is at the bottom of the table.
4283 ;; Right/left borders? They can only be specified by column
4284 ;; groups. Column groups are defined in a row starting with "/".
4285 ;; Also a column groups row only contains "<", "<>", ">" or blank
4286 ;; cells.
4303 ;; There's a left border when previous cell, if
4304 ;; any, ends a group, or current one starts one.
4310 ;; There's a right border when next cell, if any,
4311 ;; starts a group, or current one ends one.
4318 ;; Table rows are read in reverse order so last column groups
4319 ;; row has precedence over any previous one.
4321 ;; Return value.
4322 borders))
4325 "Non-nil when TABLE-CELL is at the beginning of a row group.
4326 INFO is a plist used as a communication channel."
4327 ;; A cell starts a column group either when it is at the beginning
4328 ;; of a row (or after the special column, if any) or when it has
4329 ;; a left border.
4332 table-cell)
4336 "Non-nil when TABLE-CELL is at the end of a row group.
4337 INFO is a plist used as a communication channel."
4338 ;; A cell ends a column group either when it is at the end of a row
4339 ;; or when it has a right border.
4342 table-cell)
4346 "Non-nil when TABLE-ROW is at the beginning of a column group.
4347 INFO is a plist used as a communication channel."
4355 "Non-nil when TABLE-ROW is at the end of a column group.
4356 INFO is a plist used as a communication channel."
4364 "Non-nil when TABLE-ROW is the first table header's row.
4365 INFO is a plist used as a communication channel."
4372 "Non-nil when TABLE-ROW is the last table header's row.
4373 INFO is a plist used as a communication channel."
4380 "Return TABLE dimensions.
4382 INFO is a plist used as a communication channel.
4384 Return value is a CONS like (ROWS . COLUMNS) where
4385 ROWS (resp. COLUMNS) is the number of exportable
4386 rows (resp. columns)."
4388 ;; Set number of rows, and extract first one.
4394 ;; Set number of columns.
4396 ;; Return value.
4400 "Return address of a regular TABLE-CELL object.
4402 TABLE-CELL is the cell considered. INFO is a plist used as
4403 a communication channel.
4405 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4406 zero-based index. Only exportable cells are considered. The
4407 function returns nil for other cells."
4410 ;; Ignore cells in special rows or in special column.
4415 ;; Row number.
4423 ;; Column number.
4431 "Return regular table-cell object at ADDRESS in TABLE.
4433 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4434 zero-based index. TABLE is a table type element. INFO is
4435 a plist used as a communication channel.
4437 If no table-cell, among exportable cells, is found at ADDRESS,
4438 return nil."
4441 ;; Row at (car address) or nil.
4449 'table-cell
4456 ;;;; For Tables Of Contents
4457 ;;
4458 ;; `org-export-collect-headlines' builds a list of all exportable
4459 ;; headline elements, maybe limited to a certain depth. One can then
4460 ;; easily parse it and transcode it.
4461 ;;
4462 ;; Building lists of tables, figures or listings is quite similar.
4463 ;; Once the generic function `org-export-collect-elements' is defined,
4464 ;; `org-export-collect-tables', `org-export-collect-figures' and
4465 ;; `org-export-collect-listings' can be derived from it.
4468 "Collect headlines in order to build a table of contents.
4470 INFO is a plist used as a communication channel.
4472 When optional argument N is an integer, it specifies the depth of
4473 the table of contents. Otherwise, it is set to the value of the
4474 last headline level. See `org-export-headline-levels' for more
4475 information.
4477 Return a list of all exportable headlines as parsed elements.
4478 Footnote sections, if any, will be ignored."
4483 ;; Strip contents from HEADLINE.
4486 info))
4489 "Collect referenceable elements of a determined type.
4491 TYPE can be a symbol or a list of symbols specifying element
4492 types to search. Only elements with a caption are collected.
4494 INFO is a plist used as a communication channel.
4496 When non-nil, optional argument PREDICATE is a function accepting
4497 one argument, an element of type TYPE. It returns a non-nil
4498 value when that element should be collected.
4500 Return a list of all elements found, in order of appearance."
4505 element))
4506 info))
4509 "Build a list of tables.
4510 INFO is a plist used as a communication channel.
4512 Return a list of table elements with a caption."
4516 "Build a list of figures.
4518 INFO is a plist used as a communication channel. PREDICATE is
4519 a function which accepts one argument: a paragraph element and
4520 whose return value is non-nil when that element should be
4521 collected.
4523 A figure is a paragraph type element, with a caption, verifying
4525 a vague concept that may depend on back-end.
4527 Return a list of elements recognized as figures."
4531 "Build a list of src blocks.
4533 INFO is a plist used as a communication channel.
4535 Return a list of src-block elements with a caption."
4539 ;;;; Smart Quotes
4540 ;;
4541 ;; The main function for the smart quotes sub-system is
4542 ;; `org-export-activate-smart-quotes', which replaces every quote in
4543 ;; a given string from the parse tree with its "smart" counterpart.
4544 ;;
4545 ;; Dictionary for smart quotes is stored in
4546 ;; `org-export-smart-quotes-alist'.
4547 ;;
4548 ;; Internally, regexps matching potential smart quotes (checks at
4549 ;; string boundaries are also necessary) are defined in
4550 ;; `org-export-smart-quotes-regexps'.
4587 "Smart quotes translations.
4589 Alist whose CAR is a language string and CDR is an alist with
4590 quote type as key and a plist associating various encodings to
4591 their translation as value.
4593 A quote type can be any symbol among `opening-double-quote',
4594 `closing-double-quote', `opening-single-quote',
4595 `closing-single-quote' and `apostrophe'.
4597 Valid encodings include `:utf-8', `:html', `:latex' and
4598 `:texinfo'.
4604 ;; Possible opening quote at beginning of string.
4606 ;; Possible closing quote at beginning of string.
4608 ;; Possible apostrophe at beginning of string.
4610 ;; Opening single and double quotes.
4612 ;; Closing single and double quotes.
4614 ;; Apostrophe.
4616 ;; Possible opening quote at end of string.
4618 ;; Possible closing quote at end of string.
4620 ;; Possible apostrophe at end of string.
4622 "List of regexps matching a quote or an apostrophe.
4628 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4629 `:utf-8'. INFO is a plist used as a communication channel.
4631 The function has to retrieve information about string
4632 surroundings in parse tree. It can only happen with an
4633 unmodified string. Thus, if S has already been through another
4634 process, a non-nil ORIGINAL optional argument will provide that
4635 original string.
4637 Return the new string."
4640 ;; Try to be flexible when computing number of blanks
4641 ;; before object. The previous object may be a string
4642 ;; introduced by the back-end and not completely parsed.
4645 ;; A string with missing `:post-blank'
4646 ;; property.
4650 ;; Fallback value.
4655 ;; Return smart quote associated to a give quote Q, as
4656 ;; a string. TYPE is a symbol among `open', `close' and
4657 ;; `apostrophe'.
4667 org-export-smart-quotes-alist))))
4668 encoding)
4669 q)))))
4671 ;; Only a quote: no regexp can match. We have to check both
4672 ;; sides and decide what to do.
4680 ;; 1. Replace quote character at the beginning of S.
4682 ;; Apostrophe?
4688 ;; Closing quote?
4694 ;; Opening quote?
4700 ;; 2. Replace quotes in the middle of the string.
4702 ;; Opening quotes.
4708 ;; Closing quotes.
4714 ;; Apostrophes.
4719 ;; 3. Replace quote character at the end of S.
4721 ;; Apostrophe?
4726 ;; Closing quote?
4732 ;; Opening quote?
4737 ;; Return string with smart quotes.
4738 s))))
4740 ;;;; Topology
4741 ;;
4742 ;; Here are various functions to retrieve information about the
4743 ;; neighbourhood of a given element or object. Neighbours of interest
4744 ;; are direct parent (`org-export-get-parent'), parent headline
4745 ;; (`org-export-get-parent-headline'), first element containing an
4746 ;; object, (`org-export-get-parent-element'), parent table
4747 ;; (`org-export-get-parent-table'), previous element or object
4748 ;; (`org-export-get-previous-element') and next element or object
4749 ;; (`org-export-get-next-element').
4750 ;;
4751 ;; `org-export-get-genealogy' returns the full genealogy of a given
4752 ;; element or object, from closest parent to full parse tree.
4755 "Return BLOB parent or nil.
4756 BLOB is the element or object considered."
4760 "Return full genealogy relative to a given element or object.
4762 BLOB is the element or object being considered.
4764 Ancestors are returned from closest to farthest, the last one
4765 being the full parse tree."
4772 "Return BLOB parent headline or nil.
4773 BLOB is the element or object being considered."
4777 parent))
4780 "Return first element containing OBJECT or nil.
4781 OBJECT is the object to consider."
4785 parent))
4788 "Return OBJECT parent table or nil.
4789 OBJECT is either a `table-cell' or `table-element' type object."
4793 parent))
4796 "Return previous element or object.
4798 BLOB is an element or object. INFO is a plist used as
4799 a communication channel. Return previous exportable element or
4800 object, a string, or nil.
4802 When optional argument N is a positive integer, return a list
4803 containing up to N siblings before BLOB, from farthest to
4804 closest. With any other non-nil value, return a list containing
4805 all of them."
4807 ;; An object can belong to the contents of its parent or
4808 ;; to a secondary string. We check the latter option
4809 ;; first.
4812 org-element-all-elements))
4816 org-element-secondary-value-alist))
4817 parent)))
4820 prev)
4829 prev)))
4832 "Return next element or object.
4834 BLOB is an element or object. INFO is a plist used as
4835 a communication channel. Return next exportable element or
4836 object, a string, or nil.
4838 When optional argument N is a positive integer, return a list
4839 containing up to N siblings after BLOB, from closest to farthest.
4840 With any other non-nil value, return a list containing all of
4841 them."
4843 ;; An object can belong to the contents of its parent or to
4844 ;; a secondary string. We check the latter option first.
4847 org-element-all-objects))
4851 org-element-secondary-value-alist))
4852 parent)))
4855 next)
4863 siblings)
4867 ;;;; Translation
4868 ;;
4869 ;; `org-export-translate' translates a string according to language
4870 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4871 ;; variable and a specified charset. `org-export-dictionary' contains
4872 ;; the dictionary used for the translation.
4994 "Dictionary for export engine.
4996 Alist whose CAR is the string to translate and CDR is an alist
4997 whose CAR is the language string and CDR is a plist whose
4998 properties are possible charsets and values translated terms.
5000 It is used as a database for `org-export-translate'. Since this
5001 function returns the string as-is if no translation was found,
5002 the variable only needs to record values different from the
5006 "Translate string S according to language specification.
5008 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5009 and `:utf-8'. INFO is a plist used as a communication channel.
5011 Translation depends on `:language' property. Return the
5012 translated string. If no translation is found, try to fall back
5013 to `:default' encoding. If it fails, return S."
5019 s)))
5022 \f
5023 ;;; Asynchronous Export
5024 ;;
5025 ;; `org-export-async-start' is the entry point for asynchronous
5026 ;; export. It recreates current buffer (including visibility,
5027 ;; narrowing and visited file) in an external Emacs process, and
5028 ;; evaluates a command there. It then applies a function on the
5029 ;; returned results in the current process.
5030 ;;
5031 ;; Asynchronously generated results are never displayed directly.
5032 ;; Instead, they are stored in `org-export-stack-contents'. They can
5033 ;; then be retrieved by calling `org-export-stack'.
5034 ;;
5035 ;; Export Stack is viewed through a dedicated major mode
5036 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5037 ;;`org-export-stack-delete', `org-export-stack-view' and
5038 ;;`org-export-stack-clear'.
5039 ;;
5040 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5041 ;; It should used whenever `org-export-async-start' is called.
5044 "Call function FUN on the results returned by BODY evaluation.
5046 BODY evaluation happens in an asynchronous process, from a buffer
5047 which is an exact copy of the current one.
5049 Use `org-export-add-to-stack' in FUN in order to register results
5050 in the stack. Examples for, respectively a temporary buffer and
5051 a file are:
5053 \(org-export-async-start
5054 \(lambda (output)
5056 \(erase-buffer)
5057 \(insert output)
5058 \(goto-char (point-min))
5059 \(org-export-add-to-stack (current-buffer) 'backend)))
5060 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5062 and
5064 \(org-export-async-start
5065 \(lambda (f) (org-export-add-to-stack f 'backend))
5066 `(expand-file-name
5067 \(org-export-to-file
5068 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5071 ;; Write the full sexp evaluating BODY in a copy of the current
5072 ;; buffer to a temporary file, as it may be too long for program
5073 ;; args in `start-process'.
5080 "%S"
5083 ;; Initialize `org-mode' and export framework in the
5084 ;; external process.
5087 ;; Re-create current buffer there.
5090 ;; Sexp to evaluate in the buffer.
5092 ;; Start external process.
5095 (,process
5100 "-l" org-export-async-init-file
5102 ;; Register running process in stack.
5104 ;; Set-up sentinel in order to catch results.
5106 ,process
5130 "Add a new result to export stack if not present already.
5132 SOURCE is a buffer or a file name containing export results.
5133 BACKEND is a symbol representing export back-end used to generate
5134 it.
5136 Entries already pointing to SOURCE and unavailable entries are
5137 removed beforehand. Return the new stack."
5143 "Menu for asynchronous export results and running processes."
5153 "Remove all entries from export stack."
5158 "Refresh the asynchronous export stack."
5163 "Remove export results at point from stack.
5164 If optional argument SOURCE is non-nil, remove it instead."
5169 org-export-stack-contents))))
5172 "View export results at point in stack.
5173 With an optional prefix argument IN-EMACS, force viewing files
5174 within Emacs."
5188 (define-key km "\C-p" 'previous-line)
5189 (define-key km "\C-?" 'previous-line)
5190 (define-key km [up] 'previous-line)
5191 (define-key km "C" 'org-export-stack-clear)
5192 (define-key km "v" 'org-export-stack-view)
5193 (define-key km (kbd "RET") 'org-export-stack-view)
5194 (define-key km "d" 'org-export-stack-remove)
5195 (define-key km "r" 'org-export-stack-refresh)
5196 km)
5197 "Keymap for Org Export Stack.")
5199 (define-derived-mode org-export-stack-mode tabulated-list-mode "Org-Stack"
5200 "Mode for displaying asynchronous export stack.
5203 stack.
5205 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5206 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5207 stack completely.
5209 Removing entries in an Org Export Stack buffer doesn't affect
5210 files or buffers, only the display.
5213 (setq tabulated-list-format
5214 (vector (list "#" 4 'org-export-stack--num-predicate)
5215 (list "Back-End" 12 t)
5216 (list "Age" 6 nil)
5217 (list "Source" 0 nil)))
5218 (setq tabulated-list-sort-key (cons "#" nil))
5219 (setq tabulated-list-entries 'org-export-stack--generate)
5220 (add-hook 'tabulated-list-revert-hook 'org-export-stack--generate nil t)
5221 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5222 (tabulated-list-init-header))
5224 (defun org-export-stack--generate ()
5225 "Generate the asynchronous export stack for display.
5226 Unavailable sources are removed from the list. Return a list
5227 appropriate for `tabulated-list-print'."
5228 ;; Clear stack from exited processes, dead buffers or non-existent
5229 ;; files.
5230 (setq org-export-stack-contents
5231 (org-remove-if-not
5232 (lambda (el)
5233 (if (processp (nth 2 el))
5234 (buffer-live-p (process-buffer (nth 2 el)))
5235 (let ((source (car el)))
5236 (if (bufferp source) (buffer-live-p source)
5237 (file-exists-p source)))))
5238 org-export-stack-contents))
5239 ;; Update `tabulated-list-entries'.
5240 (let ((counter 0))
5241 (mapcar (lambda (entry)
5242 (let ((source (car entry)))
5243 (list source
5244 (vector
5245 ;; Counter.
5246 (number-to-string (incf counter))
5247 ;; Back-End.
5248 (if (nth 1 entry) (symbol-name (nth 1 entry)) "")
5249 ;; Age.
5250 (let ((info (nth 2 entry)))
5251 (if (processp info) (symbol-name (process-status info))
5252 (org-format-seconds "%h:%.2m"
5253 (float-time (time-since info)))))
5254 ;; Source.
5255 (if (stringp source) source (buffer-name source))))))
5256 org-export-stack-contents)))
5258 (defun org-export-stack--num-predicate (A B)
5259 (< (string-to-number (aref (nth 1 A) 0))
5260 (string-to-number (aref (nth 1 B) 0))))
5262 (defun org-export-stack--source-at-point ()
5263 "Return source from export results at point in stack."
5264 (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
5265 (if (not source) (error "Source unavailable, please refresh buffer")
5266 (let ((source-name (if (stringp source) source (buffer-name source))))
5267 (if (save-excursion
5268 (beginning-of-line)
5269 (looking-at (concat ".* +" (regexp-quote source-name) "$")))
5270 source
5271 ;; SOURCE is not consistent with current line. The stack
5272 ;; view is outdated.
5273 (error "Source unavailable; type `r' to refresh buffer"))))))
5276 \f
5277 ;;; The Dispatcher
5278 ;;
5279 ;; `org-export-dispatch' is the standard interactive way to start an
5280 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5281 ;; for its interface, which, in turn, delegates response to key
5282 ;; pressed to `org-export--dispatch-action'.
5284 ;;;###autoload
5285 (defun org-export-dispatch (&optional arg)
5286 "Export dispatcher for Org mode.
5288 It provides an access to common export related tasks in a buffer.
5289 Its interface comes in two flavours: standard and expert.
5291 While both share the same set of bindings, only the former
5292 displays the valid keys associations in a dedicated buffer.
5293 Scrolling (resp. line-wise motion) in this buffer is done with
5294 SPC and DEL (resp. C-n and C-p) keys.
5296 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5297 flavour or the other.
5300 of options used back then, on the current buffer.
5302 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5303 (interactive "P")
5304 (let* ((input
5305 (cond ((equal arg '(16)) '(stack))
5306 ((and arg org-export-dispatch-last-action))
5307 (t (save-window-excursion
5308 (unwind-protect
5309 ;; Store this export command.
5310 (setq org-export-dispatch-last-action
5311 (org-export--dispatch-ui
5312 (list org-export-initial-scope
5313 (and org-export-in-background 'async))
5314 nil
5315 org-export-dispatch-use-expert-ui))
5316 (and (get-buffer "*Org Export Dispatcher*")
5317 (kill-buffer "*Org Export Dispatcher*")))))))
5318 (action (car input))
5319 (optns (cdr input)))
5320 (case action
5321 ;; First handle special hard-coded actions.
5322 (stack (org-export-stack))
5323 (publish-current-file
5324 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5325 (publish-current-project
5326 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5327 (publish-choose-project
5328 (org-publish (assoc (org-icompleting-read
5329 "Publish project: "
5330 org-publish-project-alist nil t)
5331 org-publish-project-alist)
5332 (memq 'force optns)
5333 (memq 'async optns)))
5334 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5335 (otherwise (funcall action
5336 ;; Return a symbol instead of a list to ease
5337 ;; asynchronous export macro use.
5338 (and (memq 'async optns) t)
5339 (and (memq 'subtree optns) t)
5340 (and (memq 'visible optns) t)
5341 (and (memq 'body optns) t))))))
5343 (defun org-export--dispatch-ui (options first-key expertp)
5344 "Handle interface for `org-export-dispatch'.
5346 OPTIONS is a list containing current interactive options set for
5347 export. It can contain any of the following symbols:
5348 `body' toggles a body-only export
5349 `subtree' restricts export to current subtree
5350 `visible' restricts export to visible part of buffer.
5351 `force' force publishing files.
5352 `async' use asynchronous export process
5354 FIRST-KEY is the key pressed to select the first level menu. It
5355 is nil when this menu hasn't been selected yet.
5357 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5358 buffer is provided, but indications about currently active
5359 options are given in the prompt. Moreover, \[?] allows to switch
5360 back to standard interface."
5361 (let* ((fontify-key
5362 (lambda (key &optional access-key)
5363 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5364 ;; non-nil is the required first-level key to activate
5365 ;; KEY. When its value is t, activate KEY independently
5366 ;; on the first key, if any. A nil value means KEY will
5367 ;; only be activated at first level.
5368 (if (or (eq access-key t) (eq access-key first-key))
5369 (org-propertize key 'face 'org-warning)
5370 key)))
5371 (fontify-value
5372 (lambda (value)
5373 ;; Fontify VALUE string.
5374 (org-propertize value 'face 'font-lock-variable-name-face)))
5375 ;; Prepare menu entries by extracting them from
5376 ;; `org-export-registered-backends', and sorting them by
5377 ;; access key and by ordinal, if any.
5378 (backends
5379 (sort
5380 (sort
5381 (delq nil
5382 (mapcar
5383 (lambda (b)
5384 (let ((name (car b)))
5385 (catch 'ignored
5386 ;; Ignore any back-end belonging to
5387 ;; `org-export-invisible-backends' or derived
5388 ;; from one of them.
5389 (dolist (ignored org-export-invisible-backends)
5390 (when (org-export-derived-backend-p name ignored)
5391 (throw 'ignored nil)))
5392 (org-export-backend-menu name))))
5393 org-export-registered-backends))
5394 (lambda (a b)
5395 (let ((key-a (nth 1 a))
5396 (key-b (nth 1 b)))
5397 (cond ((and (numberp key-a) (numberp key-b))
5398 (< key-a key-b))
5399 ((numberp key-b) t)))))
5400 (lambda (a b) (< (car a) (car b)))))
5401 ;; Compute a list of allowed keys based on the first key
5402 ;; pressed, if any. Some keys (?^B, ?^V, ?^S, ?^F, ?^A
5403 ;; and ?q) are always available.
5404 (allowed-keys
5405 (nconc (list 2 22 19 6 1)
5406 (if (not first-key) (org-uniquify (mapcar 'car backends))
5407 (let (sub-menu)
5408 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5409 (when (eq (car backend) first-key)
5410 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5411 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5412 ((not first-key) (list ?P)))
5413 (list ?&)
5414 (when expertp (list ??))
5415 (list ?q)))
5416 ;; Build the help menu for standard UI.
5417 (help
5418 (unless expertp
5419 (concat
5420 ;; Options are hard-coded.
5421 (format "Options
5422 [%s] Body only: %s [%s] Visible only: %s
5423 [%s] Export scope: %s [%s] Force publishing: %s
5425 (funcall fontify-key "C-b" t)
5426 (funcall fontify-value
5427 (if (memq 'body options) "On " "Off"))
5428 (funcall fontify-key "C-v" t)
5429 (funcall fontify-value
5430 (if (memq 'visible options) "On " "Off"))
5431 (funcall fontify-key "C-s" t)
5432 (funcall fontify-value
5433 (if (memq 'subtree options) "Subtree" "Buffer "))
5434 (funcall fontify-key "C-f" t)
5435 (funcall fontify-value
5436 (if (memq 'force options) "On " "Off"))
5437 (funcall fontify-key "C-a" t)
5438 (funcall fontify-value
5439 (if (memq 'async options) "On " "Off")))
5440 ;; Display registered back-end entries. When a key
5441 ;; appears for the second time, do not create another
5442 ;; entry, but append its sub-menu to existing menu.
5443 (let (last-key)
5444 (mapconcat
5445 (lambda (entry)
5446 (let ((top-key (car entry)))
5447 (concat
5448 (unless (eq top-key last-key)
5449 (setq last-key top-key)
5451 (funcall fontify-key (char-to-string top-key))
5452 (nth 1 entry)))
5453 (let ((sub-menu (nth 2 entry)))
5454 (unless (functionp sub-menu)
5455 ;; Split sub-menu into two columns.
5456 (let ((index -1))
5457 (concat
5458 (mapconcat
5459 (lambda (sub-entry)
5460 (incf index)
5461 (format
5462 (if (zerop (mod index 2)) " [%s] %-26s"
5464 (funcall fontify-key
5465 (char-to-string (car sub-entry))
5466 top-key)
5467 (nth 1 sub-entry)))
5468 sub-menu "")
5470 backends ""))
5471 ;; Publishing menu is hard-coded.
5473 [%s] Current file [%s] Current project
5475 (funcall fontify-key "P")
5476 (funcall fontify-key "f" ?P)
5477 (funcall fontify-key "p" ?P)
5478 (funcall fontify-key "x" ?P)
5479 (funcall fontify-key "a" ?P))
5481 (format "\[%s] %s"
5482 (funcall fontify-key "q" t)
5483 (if first-key "Main menu" "Exit")))))
5484 ;; Build prompts for both standard and expert UI.
5485 (standard-prompt (unless expertp "Export command: "))
5486 (expert-prompt
5487 (when expertp
5488 (format
5489 "Export command (C-%s%s%s%s%s) [%s]: "
5490 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5491 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5492 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5493 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5494 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5495 (mapconcat (lambda (k)
5496 ;; Strip control characters.
5497 (unless (< k 27) (char-to-string k)))
5498 allowed-keys "")))))
5499 ;; With expert UI, just read key with a fancy prompt. In standard
5500 ;; UI, display an intrusive help buffer.
5501 (if expertp
5502 (org-export--dispatch-action
5503 expert-prompt allowed-keys backends options first-key expertp)
5504 ;; At first call, create frame layout in order to display menu.
5505 (unless (get-buffer "*Org Export Dispatcher*")
5506 (delete-other-windows)
5507 (org-switch-to-buffer-other-window
5508 (get-buffer-create "*Org Export Dispatcher*"))
5509 (setq cursor-type nil
5510 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
5511 ;; Make sure that invisible cursor will not highlight square
5512 ;; brackets.
5513 (set-syntax-table (copy-syntax-table))
5514 (modify-syntax-entry ?\[ "w"))
5515 ;; At this point, the buffer containing the menu exists and is
5516 ;; visible in the current window. So, refresh it.
5517 (with-current-buffer "*Org Export Dispatcher*"
5518 ;; Refresh help. Maintain display continuity by re-visiting
5519 ;; previous window position.
5520 (let ((pos (window-start)))
5521 (erase-buffer)
5522 (insert help)
5523 (set-window-start nil pos)))
5524 (org-fit-window-to-buffer)
5525 (org-export--dispatch-action
5526 standard-prompt allowed-keys backends options first-key expertp))))
5528 (defun org-export--dispatch-action
5529 (prompt allowed-keys backends options first-key expertp)
5530 "Read a character from command input and act accordingly.
5532 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5533 a list of characters available at a given step in the process.
5534 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5535 EXPERTP are the same as defined in `org-export--dispatch-ui',
5536 which see.
5538 Toggle export options when required. Otherwise, return value is
5539 a list with action as CAR and a list of interactive export
5540 options as CDR."
5541 (let (key)
5542 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
5543 ;; C-p, SPC, DEL).
5544 (while (and (setq key (read-char-exclusive prompt))
5545 (not expertp)
5546 (memq key '(14 16 ?\s ?\d)))
5547 (case key
5548 (14 (if (not (pos-visible-in-window-p (point-max)))
5549 (ignore-errors (scroll-up-line))
5550 (message "End of buffer")
5551 (sit-for 1)))
5552 (16 (if (not (pos-visible-in-window-p (point-min)))
5553 (ignore-errors (scroll-down-line))
5554 (message "Beginning of buffer")
5555 (sit-for 1)))
5556 (?\s (if (not (pos-visible-in-window-p (point-max)))
5557 (scroll-up nil)
5558 (message "End of buffer")
5559 (sit-for 1)))
5560 (?\d (if (not (pos-visible-in-window-p (point-min)))
5561 (scroll-down nil)
5562 (message "Beginning of buffer")
5563 (sit-for 1)))))
5564 (cond
5565 ;; Ignore undefined associations.
5566 ((not (memq key allowed-keys))
5567 (ding)
5568 (unless expertp (message "Invalid key") (sit-for 1))
5569 (org-export--dispatch-ui options first-key expertp))
5570 ;; q key at first level aborts export. At second
5571 ;; level, cancel first key instead.
5572 ((eq key ?q) (if (not first-key) (error "Export aborted")
5573 (org-export--dispatch-ui options nil expertp)))
5574 ;; Help key: Switch back to standard interface if
5575 ;; expert UI was active.
5576 ((eq key ??) (org-export--dispatch-ui options first-key nil))
5577 ;; Switch to asynchronous export stack.
5578 ((eq key ?&) '(stack))
5579 ;; Toggle export options
5580 ;; C-b (2) C-v (22) C-s (19) C-f (6) C-a (1)
5581 ((memq key '(2 22 19 6 1))
5582 (org-export--dispatch-ui
5583 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
5584 (6 'force) (1 'async))))
5585 (if (memq option options) (remq option options)
5586 (cons option options)))
5587 first-key expertp))
5588 ;; Action selected: Send key and options back to
5589 ;; `org-export-dispatch'.
5590 ((or first-key (functionp (nth 2 (assq key backends))))
5591 (cons (cond
5592 ((not first-key) (nth 2 (assq key backends)))
5593 ;; Publishing actions are hard-coded. Send a special
5594 ;; signal to `org-export-dispatch'.
5595 ((eq first-key ?P)
5596 (case key
5597 (?f 'publish-current-file)
5598 (?p 'publish-current-project)
5599 (?x 'publish-choose-project)
5600 (?a 'publish-all)))
5601 ;; Return first action associated to FIRST-KEY + KEY
5602 ;; path. Indeed, derived backends can share the same
5603 ;; FIRST-KEY.
5604 (t (catch 'found
5605 (mapc (lambda (backend)
5606 (let ((match (assq key (nth 2 backend))))
5607 (when match (throw 'found (nth 2 match)))))
5608 (member (assq first-key backends) backends)))))
5609 options))
5610 ;; Otherwise, enter sub-menu.
5611 (t (org-export--dispatch-ui options key expertp)))))
5615 (provide 'ox)
5617 ;; Local variables:
5618 ;; generated-autoload-file: "org-loaddefs.el"
5619 ;; End:
5621 ;;; ox.el ends here