| blob | 3a0764d58f2b87d7f4b807519fb2e49588449b17 |
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:
96 \f
97 ;;; Internal Variables
98 ;;
99 ;; Among internal variables, the most important is
100 ;; `org-export-options-alist'. This variable define the global export
101 ;; options, shared between every exporter, and how they are acquired.
146 "Alist between export properties and ways to set them.
148 The CAR of the alist is the property name, and the CDR is a list
149 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
151 KEYWORD is a string representing a buffer keyword, or nil. Each
152 property defined this way can also be set, during subtree
153 export, through a headline property named after the keyword
155 property).
156 OPTION is a string that could be found in an #+OPTIONS: line.
157 DEFAULT is the default value for the property.
158 BEHAVIOUR determines how Org should handle multiple keywords for
159 the same property. It is a symbol among:
160 nil Keep old value and discard the new one.
161 t Replace old value with the new one.
162 `space' Concatenate the values, separating them with a space.
163 `newline' Concatenate the values, separating them with
164 a newline.
165 `split' Split values at white spaces, and cons them to the
166 previous list.
168 Values set through KEYWORD and OPTION have precedence over
169 DEFAULT.
171 All these properties should be back-end agnostic. Back-end
172 specific properties are set through `org-export-define-backend'.
176 "List of in-buffer keywords that require special treatment.
177 These keywords are not directly associated to a property. The
178 way they are handled must be hard-coded into
239 "Alist between filters properties and initial values.
241 The key of each association is a property name accessible through
242 the communication channel. Its value is a configurable global
243 variable defining initial filters.
245 This list is meant to install user specified filters. Back-end
246 developers may install their own filters using
247 `org-export-define-backend'. Filters defined there will always
248 be prepended to the current list, so they always get applied
257 "Default rule for link matching an inline image.
258 This rule applies to links with no description. By default, it
259 will be considered as an inline image if it targets a local file
262 See `org-export-inline-image-p' for more information about
266 "Non-nil means asynchronous export process should leave data behind.
270 located in `temporary-file-directory'.
272 When non-nil, it will also set `debug-on-error' to a non-nil
276 "Record asynchronously generated export results and processes.
277 This is an alist: its CAR is the source of the
278 result (destination file or buffer for a finished process,
279 original buffer for a running one) and its CDR is a list
280 containing the back-end used, as a symbol, and either a process
281 or the time at which it finished. It is used to build the menu
285 "List of backends currently available in the exporter.
287 A backend is stored as a list where CAR is its name, as a symbol,
288 and CDR is a plist with the following properties:
289 `:filters-alist', `:menu-entry', `:options-alist' and
290 `:translate-alist'.
292 This variable is set with `org-export-define-backend' and
296 "Last command called from the dispatcher.
297 The value should be a list. Its CAR is the action, as a symbol,
301 "The position where the last export command was created using the dispatcher.
302 This marker will be used with `C-u C-c C-e' to make sure export repetition
305 \f
306 ;;; User-configurable Variables
307 ;;
308 ;; Configuration for the masses.
309 ;;
310 ;; They should never be accessed directly, as their value is to be
311 ;; stored in a property list (cf. `org-export-options-alist').
312 ;; Back-ends will read their value from there instead.
315 "Options for exporting Org mode files."
320 "General options for export engine."
325 "Whether sub-trees with the ARCHIVE tag should be exported.
327 This can have three different values:
328 nil Do not export, pretend this tree is not present.
329 t Do export the entire tree.
330 `headline' Only export the headline, but skip the tree below it.
332 This option can also be set with the #+OPTIONS line,
341 "Non-nil means insert author name into the exported file.
342 This option can also be set with the #+OPTIONS line,
348 "Non-nil means export CLOCK keywords.
349 This option can also be set with the #+OPTIONS line,
355 "Non-nil means the postamble should contain a creator sentence.
357 The sentence can be set in `org-export-creator-string' and
360 If the value is `comment' insert it as a comment."
368 "Non-nil means insert date in the exported document.
369 This options can also be set with the OPTIONS keyword,
375 emacs-version)
376 "String to insert at the end of the generated document."
381 "Non-nil means export contents of standard drawers.
383 When t, all drawers are exported. This may also be a list of
384 drawer names to export. If that list starts with `not', only
385 drawers with such names will be ignored.
387 This variable doesn't apply to properties drawers.
389 This option can also be set with the #+OPTIONS line,
400 :inline t
404 "Non-nil means insert author email into the exported file.
405 This option can also be set with the #+OPTIONS line,
411 "Non-nil means interpret *word*, /word/, _word_ and +word+.
413 If the export target supports emphasizing text, the word will be
414 typeset in bold, italic, with an underline or strike-through,
415 respectively.
422 "Tags that exclude a tree from export.
424 All trees carrying any of these tags will be excluded from
425 export. This is without condition, so even subtrees inside that
426 carry one of the `org-export-select-tags' will be removed.
428 This option can also be set with the #+EXCLUDE_TAGS: keyword."
435 This can be used to have pre-formatted text, fragments of code
436 etc. For example:
437 : ;; Some Lisp examples
438 : (while (defc cnt)
439 : (ding))
440 will be looking just like this in also HTML. See also the QUOTE
441 keyword. Not all export backends support this.
448 "Non-nil means Org footnotes should be exported.
449 This option can also be set with the #+OPTIONS line,
455 "Non-nil means process LaTeX environments and fragments.
457 This option can also be set with the +OPTIONS line,
460 nil Ignore math snippets.
461 `verbatim' Keep everything in verbatim.
462 t Allow export of math snippets."
470 "The last level which is still exported as a headline.
472 Inferior levels will produce itemize or enumerate lists when
473 exported.
480 "The default language for export and clocktable translations, as a string.
481 This may have an association in
482 `org-clock-clocktable-language-setup'."
487 "Non-nil means preserve all line breaks when exporting.
488 This option can also be set with the #+OPTIONS line,
494 "Non-nil means interpret entities when exporting.
497 Å.
499 For a list of supported names, see the constant `org-entities'
500 and the user option `org-entities-user'.
502 This option can also be set with the #+OPTIONS line,
508 "Non-nil means inlinetasks should be exported.
509 This option can also be set with the #+OPTIONS line,
515 "Non-nil means include planning info in export.
516 This option can also be set with the #+OPTIONS: line,
522 "Non-nil means include priority cookies in export.
523 This option can also be set with the #+OPTIONS line,
529 "Non-nil means add section numbers to headlines when exporting.
531 When set to an integer n, numbering will only happen for
532 headlines whose relative level is higher or equal to n.
534 This option can also be set with the #+OPTIONS line,
540 "Tags that select a tree for export.
542 If any such tag is found in a buffer, all trees that do not carry
543 one of these tags will be ignored during export. Inside trees
544 that are selected like this, you can still deselect a subtree by
545 tagging it with one of the `org-export-exclude-tags'.
547 This option can also be set with the #+SELECT_TAGS: keyword."
552 "Non-nil means activate smart quotes during export.
553 This option can also be set with the #+OPTIONS: line,
561 When this option is turned on, these strings will be exported as:
563 Org HTML LaTeX UTF-8
564 -----+----------+--------+-------
566 -- – -- –
567 --- — --- —
570 This option can also be set with the #+OPTIONS line,
576 "Non-nil means include statistics cookies in export.
577 This option can also be set with the #+OPTIONS: line,
585 When this option is turned on, you can use TeX-like syntax for
587 will be considered as a single item - so grouping with {} is
588 normally not needed. For example, the following things will be
589 parsed as single sub- or superscripts.
591 10^24 or 10^tau several digits will be considered 1 item.
592 10^-12 or 10^-tau a leading sign with digits or a word
593 x^2-y^3 will be read as x^2 - y^3, because items are
594 terminated by almost any nonword/nondigit char.
595 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
597 Still, ambiguity is possible - so when in doubt use {} to enclose
598 the sub/superscript. If you set this variable to the symbol
599 `{}', the braces are *required* in order to trigger
600 interpretations as sub/superscript. This can be helpful in
603 This option can also be set with the #+OPTIONS line,
612 "Non-nil means create a table of contents in exported files.
614 The TOC contains headlines with levels up
615 to`org-export-headline-levels'. When an integer, include levels
616 up to N in the toc, this may then be different from
617 `org-export-headline-levels', but it will not be allowed to be
618 larger than the number of headline levels. When nil, no table of
619 contents is made.
621 This option can also be set with the #+OPTIONS line,
631 For example:
633 | Name | Address | Birthday |
634 |-------------+----------+-----------|
635 | Arthur Dent | England | 29.2.2100 |
642 "If nil, do not export tags, just remove them from headlines.
644 If this is the symbol `not-in-toc', tags will be removed from
645 table of contents entries, but still be shown in the headlines of
646 the document.
648 This option can also be set with the #+OPTIONS line,
657 "Non-nil means include TODO items for export.
659 This may have the following values:
660 t include tasks independent of state.
661 `todo' include only tasks that are not yet done.
662 `done' include only tasks that are already done.
663 nil ignore all tasks.
664 list of keywords include tasks with these keywords.
666 This option can also be set with the #+OPTIONS line,
678 "Non-nil means insert a time stamp into the exported file.
679 The time stamp shows when the file was created.
681 This option can also be set with the #+OPTIONS line,
687 "Non nil means allow timestamps in export.
689 It can be set to `active', `inactive', t or nil, in order to
690 export, respectively, only active timestamps, only inactive ones,
691 all of them or none.
693 This option can also be set with the #+OPTIONS line, e.g.
703 "Non-nil means include TODO keywords in export.
704 When nil, remove all these keywords from the export."
709 "Non-nil means BIND keywords can define local variable values.
710 This is a potential security risk, which is why the default value
711 is nil. You can also allow them through local buffer variables."
716 "Alist between export snippets back-ends and exporter back-ends.
718 This variable allows to provide shortcuts for export snippets.
722 HTML code while every other back-end will ignore it."
731 "Coding system for the exported file."
738 "Non-nil means exported stuff will also be pushed onto the kill ring."
743 "The initial scope when exporting with `org-export-dispatch'.
744 This variable can be either set to `buffer' or `subtree'."
751 "Non-nil means show buffer after exporting to temp buffer.
752 When Org exports to a file, the buffer visiting that file is ever
753 shown, but remains buried. However, when exporting to
754 a temporary buffer, that buffer is popped up in a second window.
755 When this variable is nil, the buffer remains buried also in
756 these cases."
761 "Non-nil means export and publishing commands will run in background.
762 Results from an asynchronous export are never displayed
770 "File used to initialize external export process.
771 Value must be an absolute file name. It defaults to user's
772 initialization file. Though, a specific configuration makes the
773 process faster and the export more portable."
780 "List of back-ends that shouldn't appear in the dispatcher.
782 Any back-end belonging to this list or derived from a back-end
783 belonging to it will not appear in the dispatcher menu.
785 Indeed, Org may require some export back-ends without notice. If
786 these modules are never to be used interactively, adding them
787 here will avoid cluttering the dispatcher menu."
794 "Non-nil means using a non-intrusive `org-export-dispatch'.
795 In that case, no help buffer is displayed. Though, an indicator
801 asynchronous). Also, \[?] allows to switch back to standard
802 mode."
809 \f
810 ;;; Defining Back-ends
811 ;;
812 ;; `org-export-define-backend' is the standard way to define an export
813 ;; back-end. It allows to specify translators, filters, buffer
814 ;; options and a menu entry. If the new back-end shares translators
815 ;; with another back-end, `org-export-define-derived-backend' may be
816 ;; used instead.
817 ;;
818 ;; Internally, a back-end is stored as a list, of which CAR is the
819 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
820 ;; properties of a given back-end are: `org-export-backend-filters',
821 ;; `org-export-backend-menu', `org-export-backend-options' and
822 ;; `org-export-backend-translate-table'.
823 ;;
824 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
825 ;; when a given back-end hasn't been registered yet.
828 "Define a new back-end BACKEND.
830 TRANSLATORS is an alist between object or element types and
831 functions handling them.
833 These functions should return a string without any trailing
834 space, or nil. They must accept three arguments: the object or
835 element itself, its contents or nil when it isn't recursive and
836 the property list used as a communication channel.
838 Contents, when not nil, are stripped from any global indentation
839 \(although the relative one is preserved). They also always end
840 with a single newline character.
842 If, for a given type, no function is found, that element or
843 object type will simply be ignored, along with any blank line or
844 white space at its end. The same will happen if the function
845 returns the nil value. If that function returns the empty
846 string, the type will be ignored, but the blank lines or white
847 spaces will be kept.
849 In addition to element and object types, one function can be
850 associated to the `template' (or `inner-template') symbol and
851 another one to the `plain-text' symbol.
853 The former returns the final transcoded string, and can be used
854 to add a preamble and a postamble to document's body. It must
855 accept two arguments: the transcoded string and the property list
856 containing export options. A function associated to `template'
858 A function associated to `inner-template' is always applied.
860 The latter, when defined, is to be called on every text not
861 recognized as an element or an object. It must accept two
862 arguments: the text string and the information channel. It is an
863 appropriate place to protect special chars relative to the
864 back-end.
866 BODY can start with pre-defined keyword arguments. The following
867 keywords are understood:
869 :export-block
871 String, or list of strings, representing block names that
872 will not be parsed. This is used to specify blocks that will
873 contain raw code specific to the back-end. These blocks
874 still have to be handled by the relative `export-block' type
875 translator.
877 :filters-alist
879 Alist between filters and function, or list of functions,
880 specific to the back-end. See `org-export-filters-alist' for
881 a list of all allowed filters. Filters defined here
882 shouldn't make a back-end test, as it may prevent back-ends
883 derived from this one to behave properly.
885 :menu-entry
887 Menu entry for the export dispatcher. It should be a list
888 like:
890 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
892 where :
894 KEY is a free character selecting the back-end.
896 DESCRIPTION-OR-ORDINAL is either a string or a number.
898 If it is a string, is will be used to name the back-end in
899 its menu entry. If it is a number, the following menu will
900 be displayed as a sub-menu of the back-end with the same
901 KEY. Also, the number will be used to determine in which
902 order such sub-menus will appear (lowest first).
904 ACTION-OR-MENU is either a function or an alist.
906 If it is an action, it will be called with four
907 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
908 BODY-ONLY. See `org-export-as' for further explanations on
909 some of them.
911 If it is an alist, associations should follow the
912 pattern:
914 \(KEY DESCRIPTION ACTION)
916 where KEY, DESCRIPTION and ACTION are described above.
918 Valid values include:
922 or
927 \(lambda (a s v b)
928 \(if a (org-latex-export-to-pdf t s v b)
929 \(org-open-file
930 \(org-latex-export-to-pdf nil s v b)))))))
932 or the following, which will be added to the previous
933 sub-menu,
935 \(?l 1
939 :options-alist
941 Alist between back-end specific properties introduced in
942 communication channel and how their value are acquired. See
943 `org-export-options-alist' for more information about
944 structure of the values."
963 ;; Register back-end.
967 ;; Tell parser to not parse EXPORT-BLOCK blocks.
974 ;; Splice in the body, if any.
978 "Create a new back-end as a variant of an existing one.
980 CHILD is the name of the derived back-end. PARENT is the name of
981 the parent back-end.
983 BODY can start with pre-defined keyword arguments. The following
984 keywords are understood:
986 :export-block
988 String, or list of strings, representing block names that
989 will not be parsed. This is used to specify blocks that will
990 contain raw code specific to the back-end. These blocks
991 still have to be handled by the relative `export-block' type
992 translator.
994 :filters-alist
996 Alist of filters that will overwrite or complete filters
997 defined in PARENT back-end. See `org-export-filters-alist'
998 for a list of allowed filters.
1000 :menu-entry
1002 Menu entry for the export dispatcher. See
1003 `org-export-define-backend' for more information about the
1004 expected value.
1006 :options-alist
1008 Alist of back-end specific properties that will overwrite or
1009 complete those defined in PARENT back-end. Refer to
1010 `org-export-options-alist' for more information about
1011 structure of the values.
1013 :translate-alist
1015 Alist of element and object types and transcoders that will
1016 overwrite or complete transcode table from PARENT back-end.
1017 Refer to `org-export-define-backend' for detailed information
1018 about transcoders.
1021 as a variant of `latex' back-end with a custom template function:
1023 \(org-export-define-derived-backend my-latex latex
1024 :translate-alist ((template . my-latex-template-fun)))
1026 The back-end could then be called with, for example:
1054 ;; Register back-end.
1058 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1065 ;; Splice in the body, if any.
1069 "Return back-end from which BACKEND is derived, or nil."
1073 "Return filters for BACKEND."
1078 "Return menu entry for BACKEND."
1083 "Return export options for BACKEND."
1088 "Return translate table for BACKEND."
1093 "Signal an error if BACKEND isn't defined."
1098 "Non-nil if BACKEND is derived from one of BACKENDS."
1102 parent))
1105 \f
1106 ;;; The Communication Channel
1107 ;;
1108 ;; During export process, every function has access to a number of
1109 ;; properties. They are of two types:
1110 ;;
1111 ;; 1. Environment options are collected once at the very beginning of
1112 ;; the process, out of the original buffer and configuration.
1113 ;; Collecting them is handled by `org-export-get-environment'
1114 ;; function.
1115 ;;
1116 ;; Most environment options are defined through the
1117 ;; `org-export-options-alist' variable.
1118 ;;
1119 ;; 2. Tree properties are extracted directly from the parsed tree,
1120 ;; just before export, by `org-export-collect-tree-properties'.
1121 ;;
1122 ;; Here is the full list of properties available during transcode
1123 ;; process, with their category and their value type.
1124 ;;
1125 ;; + `:author' :: Author's name.
1126 ;; - category :: option
1127 ;; - type :: string
1128 ;;
1129 ;; + `:back-end' :: Current back-end used for transcoding.
1130 ;; - category :: tree
1131 ;; - type :: symbol
1132 ;;
1133 ;; + `:creator' :: String to write as creation information.
1134 ;; - category :: option
1135 ;; - type :: string
1136 ;;
1137 ;; + `:date' :: String to use as date.
1138 ;; - category :: option
1139 ;; - type :: string
1140 ;;
1141 ;; + `:description' :: Description text for the current data.
1142 ;; - category :: option
1143 ;; - type :: string
1144 ;;
1145 ;; + `:email' :: Author's email.
1146 ;; - category :: option
1147 ;; - type :: string
1148 ;;
1149 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1150 ;; process.
1151 ;; - category :: option
1152 ;; - type :: list of strings
1153 ;;
1154 ;; + `:export-options' :: List of export options available for current
1155 ;; process.
1156 ;; - category :: none
1157 ;; - type :: list of symbols, among `subtree', `body-only' and
1158 ;; `visible-only'.
1159 ;;
1160 ;; + `:exported-data' :: Hash table used for memoizing
1161 ;; `org-export-data'.
1162 ;; - category :: tree
1163 ;; - type :: hash table
1164 ;;
1165 ;; + `:filetags' :: List of global tags for buffer. Used by
1166 ;; `org-export-get-tags' to get tags with inheritance.
1167 ;; - category :: option
1168 ;; - type :: list of strings
1169 ;;
1170 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1171 ;; their definition, as parsed data. Only non-inlined footnotes
1172 ;; are represented in this alist. Also, every definition isn't
1173 ;; guaranteed to be referenced in the parse tree. The purpose of
1174 ;; this property is to preserve definitions from oblivion
1175 ;; (i.e. when the parse tree comes from a part of the original
1176 ;; buffer), it isn't meant for direct use in a back-end. To
1177 ;; retrieve a definition relative to a reference, use
1178 ;; `org-export-get-footnote-definition' instead.
1179 ;; - category :: option
1180 ;; - type :: alist (STRING . LIST)
1181 ;;
1182 ;; + `:headline-levels' :: Maximum level being exported as an
1183 ;; headline. Comparison is done with the relative level of
1184 ;; headlines in the parse tree, not necessarily with their
1185 ;; actual level.
1186 ;; - category :: option
1187 ;; - type :: integer
1188 ;;
1189 ;; + `:headline-offset' :: Difference between relative and real level
1190 ;; of headlines in the parse tree. For example, a value of -1
1191 ;; means a level 2 headline should be considered as level
1192 ;; 1 (cf. `org-export-get-relative-level').
1193 ;; - category :: tree
1194 ;; - type :: integer
1195 ;;
1196 ;; + `:headline-numbering' :: Alist between headlines and their
1197 ;; numbering, as a list of numbers
1198 ;; (cf. `org-export-get-headline-number').
1199 ;; - category :: tree
1200 ;; - type :: alist (INTEGER . LIST)
1201 ;;
1202 ;; + `:id-alist' :: Alist between ID strings and destination file's
1203 ;; path, relative to current directory. It is used by
1204 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1205 ;; external file.
1206 ;; - category :: option
1207 ;; - type :: alist (STRING . STRING)
1208 ;;
1209 ;; + `:ignore-list' :: List of elements and objects that should be
1210 ;; ignored during export.
1211 ;; - category :: tree
1212 ;; - type :: list of elements and objects
1213 ;;
1214 ;; + `:input-file' :: Full path to input file, if any.
1215 ;; - category :: option
1216 ;; - type :: string or nil
1217 ;;
1218 ;; + `:keywords' :: List of keywords attached to data.
1219 ;; - category :: option
1220 ;; - type :: string
1221 ;;
1222 ;; + `:language' :: Default language used for translations.
1223 ;; - category :: option
1224 ;; - type :: string
1225 ;;
1226 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1227 ;; transcoding.
1228 ;; - category :: option
1229 ;; - type :: list (as returned by `org-element-parse-buffer')
1230 ;;
1231 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1232 ;; all line breaks.
1233 ;; - category :: option
1234 ;; - type :: symbol (nil, t)
1235 ;;
1236 ;; + `:section-numbers' :: Non-nil means transcoding should add
1237 ;; section numbers to headlines.
1238 ;; - category :: option
1239 ;; - type :: symbol (nil, t)
1240 ;;
1241 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1242 ;; in transcoding. When such a tag is present, subtrees without
1243 ;; it are de facto excluded from the process. See
1244 ;; `use-select-tags'.
1245 ;; - category :: option
1246 ;; - type :: list of strings
1247 ;;
1248 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1249 ;; a time stamp in the output.
1250 ;; - category :: option
1251 ;; - type :: symbol (nil, t)
1252 ;;
1253 ;; + `:translate-alist' :: Alist between element and object types and
1254 ;; transcoding functions relative to the current back-end.
1255 ;; Special keys `inner-template', `template' and `plain-text' are
1256 ;; also possible.
1257 ;; - category :: option
1258 ;; - type :: alist (SYMBOL . FUNCTION)
1259 ;;
1260 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1261 ;; also be transcoded. If it is set to the `headline' symbol,
1262 ;; only the archived headline's name is retained.
1263 ;; - category :: option
1264 ;; - type :: symbol (nil, t, `headline')
1265 ;;
1266 ;; + `:with-author' :: Non-nil means author's name should be included
1267 ;; in the output.
1268 ;; - category :: option
1269 ;; - type :: symbol (nil, t)
1270 ;;
1271 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1272 ;; - category :: option
1273 ;; - type :: symbol (nil, t)
1274 ;;
1275 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1276 ;; inserted at the end of the transcoded string. If the value
1277 ;; is `comment', it should be commented.
1278 ;; - category :: option
1279 ;; - type :: symbol (`comment', nil, t)
1280 ;;
1281 ;; + `:with-date' :: Non-nil means output should contain a date.
1282 ;; - category :: option
1283 ;; - type :. symbol (nil, t)
1284 ;;
1285 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1286 ;; its value is a list of names, only drawers with such names
1287 ;; will be transcoded. If that list starts with `not', drawer
1288 ;; with these names will be skipped.
1289 ;; - category :: option
1290 ;; - type :: symbol (nil, t) or list of strings
1291 ;;
1292 ;; + `:with-email' :: Non-nil means output should contain author's
1293 ;; email.
1294 ;; - category :: option
1295 ;; - type :: symbol (nil, t)
1296 ;;
1297 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1298 ;; interpreted.
1299 ;; - category :: option
1300 ;; - type :: symbol (nil, t)
1301 ;;
1302 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1303 ;; strings starting with a colon as a fixed-with (verbatim) area.
1304 ;; - category :: option
1305 ;; - type :: symbol (nil, t)
1306 ;;
1307 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1308 ;; footnotes.
1309 ;; - category :: option
1310 ;; - type :: symbol (nil, t)
1311 ;;
1312 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1313 ;; `latex-fragment' objects should appear in export output. When
1314 ;; this property is set to `verbatim', they will be left as-is.
1315 ;; - category :: option
1316 ;; - type :: symbol (`verbatim', nil, t)
1317 ;;
1318 ;; + `:with-plannings' :: Non-nil means transcoding should include
1319 ;; planning info.
1320 ;; - category :: option
1321 ;; - type :: symbol (nil, t)
1322 ;;
1323 ;; + `:with-priority' :: Non-nil means transcoding should include
1324 ;; priority cookies.
1325 ;; - category :: option
1326 ;; - type :: symbol (nil, t)
1327 ;;
1328 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1329 ;; plain text.
1330 ;; - category :: option
1331 ;; - type :: symbol (nil, t)
1332 ;;
1333 ;; + `:with-special-strings' :: Non-nil means transcoding should
1334 ;; interpret special strings in plain text.
1335 ;; - category :: option
1336 ;; - type :: symbol (nil, t)
1337 ;;
1338 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1339 ;; interpret subscript and superscript. With a value of "{}",
1340 ;; only interpret those using curly brackets.
1341 ;; - category :: option
1342 ;; - type :: symbol (nil, {}, t)
1343 ;;
1344 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1345 ;; tables.
1346 ;; - category :: option
1347 ;; - type :: symbol (nil, t)
1348 ;;
1349 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1350 ;; headlines. A `not-in-toc' value will remove them from the
1351 ;; table of contents, if any, nonetheless.
1352 ;; - category :: option
1353 ;; - type :: symbol (nil, t, `not-in-toc')
1354 ;;
1355 ;; + `:with-tasks' :: Non-nil means transcoding should include
1356 ;; headlines with a TODO keyword. A `todo' value will only
1357 ;; include headlines with a todo type keyword while a `done'
1358 ;; value will do the contrary. If a list of strings is provided,
1359 ;; only tasks with keywords belonging to that list will be kept.
1360 ;; - category :: option
1361 ;; - type :: symbol (t, todo, done, nil) or list of strings
1362 ;;
1363 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1364 ;; time stamps. Special value `active' (resp. `inactive') ask to
1365 ;; export only active (resp. inactive) timestamps. Otherwise,
1366 ;; completely remove them.
1367 ;; - category :: option
1368 ;; - type :: symbol: (`active', `inactive', t, nil)
1369 ;;
1370 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1371 ;; added to the output. An integer value limits its depth.
1372 ;; - category :: option
1373 ;; - type :: symbol (nil, t or integer)
1374 ;;
1375 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1376 ;; include TODO keywords.
1377 ;; - category :: option
1378 ;; - type :: symbol (nil, t)
1381 ;;;; Environment Options
1382 ;;
1383 ;; Environment options encompass all parameters defined outside the
1384 ;; scope of the parsed data. They come from five sources, in
1385 ;; increasing precedence order:
1386 ;;
1387 ;; - Global variables,
1388 ;; - Buffer's attributes,
1389 ;; - Options keyword symbols,
1390 ;; - Buffer keywords,
1391 ;; - Subtree properties.
1392 ;;
1393 ;; The central internal function with regards to environment options
1394 ;; is `org-export-get-environment'. It updates global variables with
1395 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1396 ;; the different sources.
1397 ;;
1398 ;; The internal functions doing the retrieval are:
1399 ;; `org-export--get-global-options',
1400 ;; `org-export--get-buffer-attributes',
1401 ;; `org-export--parse-option-keyword',
1402 ;; `org-export--get-subtree-options' and
1403 ;; `org-export--get-inbuffer-options'
1404 ;;
1405 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1406 ;; relative to "#+BIND:" keywords.
1409 "Collect export options from the current buffer.
1411 Optional argument BACKEND is a symbol specifying which back-end
1412 specific options to read, if any.
1414 When optional argument SUBTREEP is non-nil, assume the export is
1415 done against the current sub-tree.
1417 Third optional argument EXT-PLIST is a property list with
1418 external parameters overriding Org default settings, but still
1419 inferior to file-local settings."
1420 ;; First install #+BIND variables.
1422 ;; Get and prioritize export options...
1424 ;; ... from global variables...
1426 ;; ... from an external property list...
1427 ext-plist
1428 ;; ... from in-buffer settings...
1430 ;; ... and from subtree, when appropriate.
1432 ;; Eventually add misc. properties.
1434 :back-end
1435 backend
1436 :translate-alist
1438 :footnote-definition-alist
1439 ;; Footnotes definitions must be collected in the original
1440 ;; buffer, as there's no insurance that they will still be in
1441 ;; the parse tree, due to possible narrowing.
1455 alist))))
1456 alist))
1457 :id-alist
1458 ;; Collect id references.
1469 alist))))
1472 "Parse an OPTIONS line and return values as a plist.
1473 Optional argument BACKEND is a symbol specifying which back-end
1474 specific items to read, if any."
1476 ;; Priority is given to back-end specific options.
1478 org-export-options-alist))
1479 plist)
1488 options))
1490 property
1493 plist))
1496 "Get export options in subtree at point.
1497 Optional argument BACKEND is a symbol specifying back-end used
1498 for export. Return options as a plist."
1499 ;; For each buffer keyword, create a headline property setting the
1500 ;; same property in communication channel. The name for the property
1501 ;; is the keyword with "EXPORT_" appended to it.
1504 ;; Make sure point is at an heading.
1506 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1507 ;; title as its fallback value.
1513 plist :title
1516 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1520 ;; Handle other keywords. TITLE keyword is excluded as it has
1521 ;; been handled already.
1529 ;; Export properties are not case-sensitive.
1536 plist
1537 property
1539 ;; Parse VALUE if required.
1543 ;; If BEHAVIOUR is `split' expected value is
1544 ;; a list of strings, not a string.
1547 ;; Look for both general keywords and back-end specific
1548 ;; options, with priority given to the latter.
1550 org-export-options-alist)))
1551 ;; Return value.
1552 plist)))
1555 "Return current buffer export options, as a plist.
1557 Optional argument BACKEND, when non-nil, is a symbol specifying
1558 which back-end specific options should also be read in the
1559 process.
1561 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1563 get-options ; For byte-compiler.
1566 ;; Priority is given to back-end specific options.
1568 org-export-options-alist))
1571 org-export-special-keywords))))
1574 ;; Return property name associated to KEYWORD.
1579 options))))
1582 ;; Recursively read keywords in buffer. FILES is a list
1583 ;; of files read so far. PLIST is the current property
1584 ;; list obtained.
1593 ;; Options in `org-export-special-keywords'.
1597 ;; Avoid circular dependencies.
1607 plist
1612 plist
1618 ;; Options in `org-export-options-alist'.
1623 plist prop
1624 ;; Handle value depending on specified
1625 ;; BEHAVIOUR.
1631 " "
1643 ;; Return final value.
1644 plist))))
1645 ;; Read options in the current buffer.
1647 ;; Parse keywords specified in `org-element-document-properties'.
1649 ;; Find the property associated to the keyword.
1657 org-element-document-properties)
1658 ;; Return value.
1659 plist))
1662 "Return properties related to buffer attributes, as a plist."
1665 ;; Store full path of input file name, or nil. For internal use.
1666 :input-file visited-file
1673 "Return global export options as a plist.
1675 Optional argument BACKEND, if non-nil, is a symbol specifying
1676 which back-end specific export options should also be read in the
1677 process."
1679 ;; Priority is given to back-end specific options.
1681 org-export-options-alist))
1682 plist)
1689 plist
1690 prop
1691 ;; Eval default value provided. If keyword is a member
1692 ;; of `org-element-document-properties', parse it as
1693 ;; a secondary string before storing it.
1698 value
1701 all)
1702 ;; Return value.
1703 plist))
1706 "Install the values from #+BIND lines as local variables.
1707 Variables must be installed before in-buffer options are
1708 retrieved."
1723 ;;;; Tree Properties
1724 ;;
1725 ;; Tree properties are information extracted from parse tree. They
1726 ;; are initialized at the beginning of the transcoding process by
1727 ;; `org-export-collect-tree-properties'.
1728 ;;
1729 ;; Dedicated functions focus on computing the value of specific tree
1730 ;; properties during initialization. Thus,
1731 ;; `org-export--populate-ignore-list' lists elements and objects that
1732 ;; should be skipped during export, `org-export--get-min-level' gets
1733 ;; the minimal exportable level, used as a basis to compute relative
1734 ;; level for headlines. Eventually
1735 ;; `org-export--collect-headline-numbering' builds an alist between
1736 ;; headlines and their numbering.
1739 "Extract tree properties from parse tree.
1741 DATA is the parse tree from which information is retrieved. INFO
1742 is a list holding export options.
1744 Following tree properties are set or updated:
1746 `:exported-data' Hash table used to memoize results from
1747 `org-export-data'.
1749 `:footnote-definition-alist' List of footnotes definitions in
1750 original buffer and current parse tree.
1752 `:headline-offset' Offset between true level of headlines and
1753 local level. An offset of -1 means a headline
1754 of level 2 should be considered as a level
1755 1 headline in the context.
1757 `:headline-numbering' Alist of all headlines as key an the
1758 associated numbering as value.
1760 `:ignore-list' List of elements that should be ignored during
1761 export.
1763 Return updated plist."
1764 ;; Install the parse tree in the communication channel, in order to
1765 ;; use `org-export-get-genealogy' and al.
1767 ;; Get the list of elements and objects to ignore, and put it into
1768 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1769 ;; been done during parse tree filtering.
1772 :ignore-list
1775 ;; Compute `:headline-offset' in order to be able to use
1776 ;; `org-export-get-relative-level'.
1779 :headline-offset
1781 ;; Update footnotes definitions list with definitions in parse tree.
1782 ;; This is required since buffer expansion might have modified
1783 ;; boundaries of footnote definitions contained in the parse tree.
1784 ;; This way, definitions in `footnote-definition-alist' are bound to
1785 ;; match those in the parse tree.
1791 defs)))
1793 ;; Properties order doesn't matter: get the rest of the tree
1794 ;; properties.
1798 info))
1801 "Return minimum exportable headline's level in DATA.
1802 DATA is parsed tree as returned by `org-element-parse-buffer'.
1803 OPTIONS is a plist holding export options."
1814 ;; If no headline was found, for the sake of consistency, set
1815 ;; minimum level to 1 nonetheless.
1819 "Return numbering of all exportable headlines in a parse tree.
1821 DATA is the parse tree. OPTIONS is the plist holding export
1822 options.
1824 Return an alist whose key is a headline and value is its
1825 associated numbering \(in the shape of a list of numbers\) or nil
1826 for a footnotes section."
1834 headline
1836 for idx from 0 to org-export-max-depth
1840 options)))
1843 "Return list of elements and objects to ignore during export.
1844 DATA is the parse tree to traverse. OPTIONS is the plist holding
1845 export options."
1847 walk-data
1848 ;; First find trees containing a select tag, if any.
1852 ;; Collect ignored elements or objects into IGNORE-LIST.
1858 ;; If headline is archived but tree below has
1859 ;; to be skipped, add it to ignore list.
1862 ;; Move into secondary string, if any.
1867 ;; Move into recursive objects/elements.
1869 ;; Main call.
1871 ;; Return value.
1872 ignore))
1875 "Return list of headlines and inlinetasks with a select tag in their tree.
1876 DATA is parsed data as returned by `org-element-parse-buffer'.
1877 INFO is a plist holding export options."
1879 walk-data ; For byte-compiler.
1889 ;; When a select tag is found, mark full
1890 ;; genealogy and every headline within the tree
1891 ;; as acceptable.
1894 genealogy
1897 selected-trees))
1898 ;; If at a headline, continue searching in tree,
1899 ;; recursively.
1909 selected-trees))
1912 "Non-nil when element or object BLOB should be skipped during export.
1913 OPTIONS is the plist holding export options. SELECTED, when
1914 non-nil, is a list of headlines or inlinetasks belonging to
1915 a tree with a select tag."
1922 ;; If `:with-drawers' value starts with `not', ignore
1923 ;; every drawer whose name belong to that list.
1924 ;; Otherwise, ignore drawers whose name isn't in that
1925 ;; list.
1939 ;; Ignore subtrees with an exclude tag.
1942 ;; When a select tag is present in the buffer, ignore any tree
1943 ;; without it.
1945 ;; Ignore commented sub-trees.
1947 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1949 ;; Ignore tasks, if specified by `:with-tasks' property.
1965 ;; No timestamp allowed.
1967 ;; Only active timestamps allowed and the current one isn't
1968 ;; active.
1972 ;; Only inactive timestamps allowed and the current one isn't
1973 ;; inactive.
1979 \f
1980 ;;; The Transcoder
1981 ;;
1982 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1983 ;; `org-element-parse-buffer') and transcodes it into a specified
1984 ;; back-end output. It takes care of filtering out elements or
1985 ;; objects according to export options and organizing the output blank
1986 ;; lines and white space are preserved. The function memoizes its
1987 ;; results, so it is cheap to call it within translators.
1988 ;;
1989 ;; It is possible to modify locally the back-end used by
1990 ;; `org-export-data' or even use a temporary back-end by using
1991 ;; `org-export-data-with-translations' and
1992 ;; `org-export-data-with-backend'.
1993 ;;
1994 ;; Internally, three functions handle the filtering of objects and
1995 ;; elements during the export. In particular,
1996 ;; `org-export-ignore-element' marks an element or object so future
1997 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1998 ;; elements or objects should be seen as real Org syntax and
1999 ;; `org-export-expand' transforms the others back into their original
2000 ;; shape
2001 ;;
2002 ;; `org-export-transcoder' is an accessor returning appropriate
2003 ;; translator function for a given element or object.
2006 "Return appropriate transcoder for BLOB.
2007 INFO is a plist containing export directives."
2009 ;; Return contents only for complete parse trees.
2015 "Convert DATA into current back-end format.
2017 DATA is a parse tree, an element or an object or a secondary
2018 string. INFO is a plist holding export options.
2020 Return transcoded string."
2026 ;; Ignored element/object.
2028 ;; Plain text.
2034 info))
2035 ;; Uninterpreted element/object: change it back to Org
2036 ;; syntax and export again resulting raw string.
2040 data
2044 info))
2045 ;; Secondary string.
2048 ;; Element/Object without contents or, as a special case,
2049 ;; headline with archive tag and archived trees restricted
2050 ;; to title only.
2058 ;; Element/Object with contents.
2071 ;; Elements directly containing objects
2072 ;; must have their indentation normalized
2073 ;; first.
2075 data
2076 ;; When normalizing contents of the first
2077 ;; paragraph in an item or a footnote
2078 ;; definition, ignore first line's
2079 ;; indentation: there is none and it
2080 ;; might be misleading.
2085 data)
2092 info))))))))
2093 ;; Final result will be memoized before being returned.
2095 data
2099 ;; Append the same white space between elements or objects as in
2100 ;; the original buffer, and call appropriate filters.
2111 info)))
2112 results)))
2116 "Convert DATA into another format using a given translation table.
2117 DATA is an element, an object, a secondary string or a string.
2118 TRANSLATIONS is an alist between element or object types and
2119 a functions handling them. See `org-export-define-backend' for
2120 more information. INFO is a plist used as a communication
2121 channel."
2123 data
2124 ;; Set-up a new communication channel with TRANSLATIONS as the
2125 ;; translate table and a new hash table for memoization.
2127 info
2129 ;; Size of the hash table is reduced since this function
2130 ;; will probably be used on short trees.
2134 "Convert DATA into BACKEND format.
2136 DATA is an element, an object, a secondary string or a string.
2137 BACKEND is a symbol. INFO is a plist used as a communication
2138 channel.
2140 Unlike to `org-export-with-backend', this function will
2141 recursively convert DATA using BACKEND translation table."
2147 "Non-nil if element or object BLOB should be interpreted during export.
2148 If nil, BLOB will appear as raw Org syntax. Check is done
2149 according to export options INFO, stored as a plist."
2151 ;; ... entities...
2153 ;; ... emphasis...
2156 ;; ... fixed-width areas.
2158 ;; ... footnotes...
2161 ;; ... LaTeX environments and fragments...
2165 ;; ... sub/superscripts...
2171 ;; ... tables...
2176 "Expand a parsed element or object to its original state.
2177 BLOB is either an element or an object. CONTENTS is its
2178 contents, as a string or nil."
2181 blob contents))
2184 "Add ELEMENT to `:ignore-list' in INFO.
2186 Any element in `:ignore-list' will be skipped when using
2187 `org-element-map'. INFO is modified by side effects."
2191 \f
2192 ;;; The Filter System
2193 ;;
2194 ;; Filters allow end-users to tweak easily the transcoded output.
2195 ;; They are the functional counterpart of hooks, as every filter in
2196 ;; a set is applied to the return value of the previous one.
2197 ;;
2198 ;; Every set is back-end agnostic. Although, a filter is always
2199 ;; called, in addition to the string it applies to, with the back-end
2200 ;; used as argument, so it's easy for the end-user to add back-end
2201 ;; specific filters in the set. The communication channel, as
2202 ;; a plist, is required as the third argument.
2203 ;;
2204 ;; From the developer side, filters sets can be installed in the
2205 ;; process with the help of `org-export-define-backend', which
2206 ;; internally stores filters as an alist. Each association has a key
2207 ;; among the following symbols and a function or a list of functions
2208 ;; as value.
2209 ;;
2210 ;; - `:filter-options' applies to the property list containing export
2211 ;; options. Unlike to other filters, functions in this list accept
2212 ;; two arguments instead of three: the property list containing
2213 ;; export options and the back-end. Users can set its value through
2214 ;; `org-export-filter-options-functions' variable.
2215 ;;
2216 ;; - `:filter-parse-tree' applies directly to the complete parsed
2217 ;; tree. Users can set it through
2218 ;; `org-export-filter-parse-tree-functions' variable.
2219 ;;
2220 ;; - `:filter-final-output' applies to the final transcoded string.
2221 ;; Users can set it with `org-export-filter-final-output-functions'
2222 ;; variable
2223 ;;
2224 ;; - `:filter-plain-text' applies to any string not recognized as Org
2225 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2226 ;; configure it.
2227 ;;
2228 ;; - `:filter-TYPE' applies on the string returned after an element or
2229 ;; object of type TYPE has been transcoded. An user can modify
2230 ;; `org-export-filter-TYPE-functions'
2231 ;;
2232 ;; All filters sets are applied with
2233 ;; `org-export-filter-apply-functions' function. Filters in a set are
2234 ;; applied in a LIFO fashion. It allows developers to be sure that
2235 ;; their filters will be applied first.
2236 ;;
2237 ;; Filters properties are installed in communication channel with
2238 ;; `org-export-install-filters' function.
2239 ;;
2240 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2241 ;; `org-export-before-parsing-hook') are run at the beginning of the
2242 ;; export process and just before parsing to allow for heavy structure
2243 ;; modifications.
2246 ;;;; Hooks
2249 "Hook run at the beginning of the export process.
2251 This is run before include keywords and macros are expanded and
2252 Babel code blocks executed, on a copy of the original buffer
2253 being exported. Visibility and narrowing are preserved. Point
2254 is at the beginning of the buffer.
2256 Every function in this hook will be called with one argument: the
2260 "Hook run before parsing an export buffer.
2262 This is run after include keywords and macros have been expanded
2263 and Babel code blocks executed, on a copy of the original buffer
2264 being exported. Visibility and narrowing are preserved. Point
2265 is at the beginning of the buffer.
2267 Every function in this hook will be called with one argument: the
2271 ;;;; Special Filters
2274 "List of functions applied to the export options.
2275 Each filter is called with two arguments: the export options, as
2276 a plist, and the back-end, as a symbol. It must return
2280 "List of functions applied to the parsed tree.
2281 Each filter is called with three arguments: the parse tree, as
2282 returned by `org-element-parse-buffer', the back-end, as
2283 a symbol, and the communication channel, as a plist. It must
2287 "List of functions applied to plain text.
2288 Each filter is called with three arguments: a string which
2289 contains no Org syntax, the back-end, as a symbol, and the
2290 communication channel, as a plist. It must return a string or
2294 "List of functions applied to the transcoded string.
2295 Each filter is called with three arguments: the full transcoded
2296 string, the back-end, as a symbol, and the communication channel,
2297 as a plist. It must return a string that will be used as the
2301 ;;;; Elements Filters
2304 "List of functions applied to a transcoded babel-call.
2305 Each filter is called with three arguments: the transcoded data,
2306 as a string, the back-end, as a symbol, and the communication
2310 "List of functions applied to a transcoded center block.
2311 Each filter is called with three arguments: the transcoded data,
2312 as a string, the back-end, as a symbol, and the communication
2316 "List of functions applied to a transcoded clock.
2317 Each filter is called with three arguments: the transcoded data,
2318 as a string, the back-end, as a symbol, and the communication
2322 "List of functions applied to a transcoded comment.
2323 Each filter is called with three arguments: the transcoded data,
2324 as a string, the back-end, as a symbol, and the communication
2328 "List of functions applied to a transcoded comment-block.
2329 Each filter is called with three arguments: the transcoded data,
2330 as a string, the back-end, as a symbol, and the communication
2334 "List of functions applied to a transcoded diary-sexp.
2335 Each filter is called with three arguments: the transcoded data,
2336 as a string, the back-end, as a symbol, and the communication
2340 "List of functions applied to a transcoded drawer.
2341 Each filter is called with three arguments: the transcoded data,
2342 as a string, the back-end, as a symbol, and the communication
2346 "List of functions applied to a transcoded dynamic-block.
2347 Each filter is called with three arguments: the transcoded data,
2348 as a string, the back-end, as a symbol, and the communication
2352 "List of functions applied to a transcoded example-block.
2353 Each filter is called with three arguments: the transcoded data,
2354 as a string, the back-end, as a symbol, and the communication
2358 "List of functions applied to a transcoded export-block.
2359 Each filter is called with three arguments: the transcoded data,
2360 as a string, the back-end, as a symbol, and the communication
2364 "List of functions applied to a transcoded fixed-width.
2365 Each filter is called with three arguments: the transcoded data,
2366 as a string, the back-end, as a symbol, and the communication
2370 "List of functions applied to a transcoded footnote-definition.
2371 Each filter is called with three arguments: the transcoded data,
2372 as a string, the back-end, as a symbol, and the communication
2376 "List of functions applied to a transcoded headline.
2377 Each filter is called with three arguments: the transcoded data,
2378 as a string, the back-end, as a symbol, and the communication
2382 "List of functions applied to a transcoded horizontal-rule.
2383 Each filter is called with three arguments: the transcoded data,
2384 as a string, the back-end, as a symbol, and the communication
2388 "List of functions applied to a transcoded inlinetask.
2389 Each filter is called with three arguments: the transcoded data,
2390 as a string, the back-end, as a symbol, and the communication
2394 "List of functions applied to a transcoded item.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2400 "List of functions applied to a transcoded keyword.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2406 "List of functions applied to a transcoded latex-environment.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2412 "List of functions applied to a transcoded node-property.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2418 "List of functions applied to a transcoded paragraph.
2419 Each filter is called with three arguments: the transcoded data,
2420 as a string, the back-end, as a symbol, and the communication
2424 "List of functions applied to a transcoded plain-list.
2425 Each filter is called with three arguments: the transcoded data,
2426 as a string, the back-end, as a symbol, and the communication
2430 "List of functions applied to a transcoded planning.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2436 "List of functions applied to a transcoded property-drawer.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2442 "List of functions applied to a transcoded quote block.
2443 Each filter is called with three arguments: the transcoded quote
2444 data, as a string, the back-end, as a symbol, and the
2445 communication channel, as a plist. It must return a string or
2449 "List of functions applied to a transcoded quote-section.
2450 Each filter is called with three arguments: the transcoded data,
2451 as a string, the back-end, as a symbol, and the communication
2455 "List of functions applied to a transcoded section.
2456 Each filter is called with three arguments: the transcoded data,
2457 as a string, the back-end, as a symbol, and the communication
2461 "List of functions applied to a transcoded special block.
2462 Each filter is called with three arguments: the transcoded data,
2463 as a string, the back-end, as a symbol, and the communication
2467 "List of functions applied to a transcoded src-block.
2468 Each filter is called with three arguments: the transcoded data,
2469 as a string, the back-end, as a symbol, and the communication
2473 "List of functions applied to a transcoded table.
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 table-cell.
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 table-row.
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 verse block.
2492 Each filter is called with three arguments: the transcoded data,
2493 as a string, the back-end, as a symbol, and the communication
2497 ;;;; Objects Filters
2500 "List of functions applied to transcoded bold text.
2501 Each filter is called with three arguments: the transcoded data,
2502 as a string, the back-end, as a symbol, and the communication
2506 "List of functions applied to transcoded code text.
2507 Each filter is called with three arguments: the transcoded data,
2508 as a string, the back-end, as a symbol, and the communication
2512 "List of functions applied to a transcoded entity.
2513 Each filter is called with three arguments: the transcoded data,
2514 as a string, the back-end, as a symbol, and the communication
2518 "List of functions applied to a transcoded export-snippet.
2519 Each filter is called with three arguments: the transcoded data,
2520 as a string, the back-end, as a symbol, and the communication
2524 "List of functions applied to a transcoded footnote-reference.
2525 Each filter is called with three arguments: the transcoded data,
2526 as a string, the back-end, as a symbol, and the communication
2530 "List of functions applied to a transcoded inline-babel-call.
2531 Each filter is called with three arguments: the transcoded data,
2532 as a string, the back-end, as a symbol, and the communication
2536 "List of functions applied to a transcoded inline-src-block.
2537 Each filter is called with three arguments: the transcoded data,
2538 as a string, the back-end, as a symbol, and the communication
2542 "List of functions applied to transcoded italic text.
2543 Each filter is called with three arguments: the transcoded data,
2544 as a string, the back-end, as a symbol, and the communication
2548 "List of functions applied to a transcoded latex-fragment.
2549 Each filter is called with three arguments: the transcoded data,
2550 as a string, the back-end, as a symbol, and the communication
2554 "List of functions applied to a transcoded line-break.
2555 Each filter is called with three arguments: the transcoded data,
2556 as a string, the back-end, as a symbol, and the communication
2560 "List of functions applied to a transcoded link.
2561 Each filter is called with three arguments: the transcoded data,
2562 as a string, the back-end, as a symbol, and the communication
2566 "List of functions applied to a transcoded macro.
2567 Each filter is called with three arguments: the transcoded data,
2568 as a string, the back-end, as a symbol, and the communication
2572 "List of functions applied to a transcoded radio-target.
2573 Each filter is called with three arguments: the transcoded data,
2574 as a string, the back-end, as a symbol, and the communication
2578 "List of functions applied to a transcoded statistics-cookie.
2579 Each filter is called with three arguments: the transcoded data,
2580 as a string, the back-end, as a symbol, and the communication
2584 "List of functions applied to transcoded strike-through text.
2585 Each filter is called with three arguments: the transcoded data,
2586 as a string, the back-end, as a symbol, and the communication
2590 "List of functions applied to a transcoded subscript.
2591 Each filter is called with three arguments: the transcoded data,
2592 as a string, the back-end, as a symbol, and the communication
2596 "List of functions applied to a transcoded superscript.
2597 Each filter is called with three arguments: the transcoded data,
2598 as a string, the back-end, as a symbol, and the communication
2602 "List of functions applied to a transcoded target.
2603 Each filter is called with three arguments: the transcoded data,
2604 as a string, the back-end, as a symbol, and the communication
2608 "List of functions applied to a transcoded timestamp.
2609 Each filter is called with three arguments: the transcoded data,
2610 as a string, the back-end, as a symbol, and the communication
2614 "List of functions applied to transcoded underline text.
2615 Each filter is called with three arguments: the transcoded data,
2616 as a string, the back-end, as a symbol, and the communication
2620 "List of functions applied to transcoded verbatim text.
2621 Each filter is called with three arguments: the transcoded data,
2622 as a string, the back-end, as a symbol, and the communication
2626 ;;;; Filters Tools
2627 ;;
2628 ;; Internal function `org-export-install-filters' installs filters
2629 ;; hard-coded in back-ends (developer filters) and filters from global
2630 ;; variables (user filters) in the communication channel.
2631 ;;
2632 ;; Internal function `org-export-filter-apply-functions' takes care
2633 ;; about applying each filter in order to a given data. It ignores
2634 ;; filters returning a nil value but stops whenever a filter returns
2635 ;; an empty string.
2638 "Call every function in FILTERS.
2640 Functions are called with arguments VALUE, current export
2641 back-end and INFO. A function returning a nil value will be
2642 skipped. If it returns the empty string, the process ends and
2643 VALUE is ignored.
2645 Call is done in a LIFO fashion, to be sure that developer
2646 specified filters, if any, are called first."
2655 "Install filters properties in communication channel.
2656 INFO is a plist containing the current communication channel.
2657 Return the updated communication channel."
2659 ;; Install user-defined filters with `org-export-filters-alist'
2660 ;; and filters already in INFO (through ext-plist mechanism).
2667 ;; Filters in INFO will be called
2668 ;; before those user provided.
2671 default-value)))))
2672 org-export-filters-alist)
2673 ;; Prepend back-end specific filters to that list.
2675 ;; Single values get consed, lists are appended.
2680 plist key
2684 ;; Return new communication channel.
2688 \f
2689 ;;; Core functions
2690 ;;
2691 ;; This is the room for the main function, `org-export-as', along with
2692 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2693 ;; `org-export-string-as'. They differ either by the way they output
2694 ;; the resulting code (for the first two) or by the input type (for
2695 ;; the latter).
2696 ;;
2697 ;; `org-export-output-file-name' is an auxiliary function meant to be
2698 ;; used with `org-export-to-file'. With a given extension, it tries
2699 ;; to provide a canonical file name to write export output to.
2700 ;;
2701 ;; Note that `org-export-as' doesn't really parse the current buffer,
2702 ;; but a copy of it (with the same buffer-local variables and
2703 ;; visibility), where macros and include keywords are expanded and
2704 ;; Babel blocks are executed, if appropriate.
2705 ;; `org-export-with-buffer-copy' macro prepares that copy.
2706 ;;
2707 ;; File inclusion is taken care of by
2708 ;; `org-export-expand-include-keyword' and
2709 ;; `org-export--prepare-file-contents'. Structure wise, including
2710 ;; a whole Org file in a buffer often makes little sense. For
2711 ;; example, if the file contains a headline and the include keyword
2712 ;; was within an item, the item should contain the headline. That's
2713 ;; why file inclusion should be done before any structure can be
2714 ;; associated to the file, that is before parsing.
2717 "Return a copy of the current buffer.
2718 The copy preserves Org buffer-local variables, visibility and
2719 narrowing."
2725 new-buf))
2728 "Apply BODY in a copy of the current buffer.
2729 The copy preserves local variables, visibility and contents of
2730 the original buffer. Point is at the beginning of the buffer
2731 when BODY is applied."
2740 ;; Kill copy without confirmation.
2746 "Generate a function duplicating BUFFER.
2748 The copy will preserve local variables, visibility, contents and
2749 narrowing of the original buffer. If a region was active in
2750 BUFFER, contents will be narrowed to that region instead.
2752 The resulting function can be eval'ed at a later time, from
2753 another buffer, effectively cloning the original buffer there."
2757 ;; Buffer local variables.
2767 default-directory
2768 buffer-file-name
2769 buffer-file-coding-system
2770 outline-level
2771 outline-regexp
2772 buffer-invisibility-spec))
2775 ;; Skip unreadable values, as they cannot be
2776 ;; sent to external process.
2780 local-vars)))))
2782 local-vars)
2783 ;; Whole buffer contents.
2788 ;; Narrowing.
2792 ;; Current position of point.
2794 ;; Overlays with invisible property.
2804 ov-set))))
2806 ov-set)))))
2808 ;;;###autoload
2811 "Transcode current Org buffer into BACKEND code.
2813 If narrowing is active in the current buffer, only transcode its
2814 narrowed part.
2816 If a region is active, transcode that region.
2818 When optional argument SUBTREEP is non-nil, transcode the
2819 sub-tree at point, extracting information from the headline
2820 properties first.
2822 When optional argument VISIBLE-ONLY is non-nil, don't export
2823 contents of hidden elements.
2825 When optional argument BODY-ONLY is non-nil, only return body
2826 code, without surrounding template.
2828 Optional argument EXT-PLIST, when provided, is a property list
2829 with external parameters overriding Org default settings, but
2830 still inferior to file-local settings.
2832 Return code as a string."
2836 ;; Narrow buffer to an appropriate region or subtree for
2837 ;; parsing. If parsing subtree, be sure to remove main headline
2838 ;; too.
2846 ;; Initialize communication channel with original buffer
2847 ;; attributes, unavailable in its copy.
2855 tree)
2856 ;; Update communication channel and get parse tree. Buffer
2857 ;; isn't parsed directly. Instead, a temporary copy is
2858 ;; created, where include keywords, macros are expanded and
2859 ;; code blocks are evaluated.
2861 ;; Run first hook with current back-end as argument.
2864 ;; Update macro templates since #+INCLUDE keywords might have
2865 ;; added some new ones.
2869 ;; Update radio targets since keyword inclusion might have
2870 ;; added some more.
2872 ;; Run last hook with current back-end as argument.
2875 ;; Update communication channel with environment. Also
2876 ;; install user's and developer's filters.
2881 ;; Expand export-specific set of macros: {{{author}}},
2882 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2883 ;; once regular macros have been expanded, since document
2884 ;; keywords may contain one of them.
2890 ;; EMAIL is not a parsed keyword: store it as-is.
2894 ;; Call options filters and update export options. We do not
2895 ;; use `org-export-filter-apply-functions' here since the
2896 ;; arity of such filters is different.
2900 ;; Parse buffer and call parse-tree filter on it.
2905 ;; Now tree is complete, compute its properties and add them
2906 ;; to communication channel.
2910 ;; Eventually transcode TREE. Wrap the resulting string into
2911 ;; a template.
2920 ;; Remove all text properties since they cannot be
2921 ;; retrieved from an external process. Finally call
2922 ;; final-output filter and return result.
2928 info))))))))
2930 ;;;###autoload
2933 "Call `org-export-as' with output to a specified buffer.
2935 BACKEND is the back-end used for transcoding, as a symbol.
2937 BUFFER is the output buffer. If it already exists, it will be
2938 erased first, otherwise, it will be created.
2940 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2941 EXT-PLIST are similar to those used in `org-export-as', which
2942 see.
2944 If `org-export-copy-to-kill-ring' is non-nil, add buffer contents
2945 to kill ring. Return buffer."
2952 ;; Maybe add buffer contents to kill ring.
2955 ;; Return buffer.
2956 buffer))
2958 ;;;###autoload
2961 "Call `org-export-as' with output to a specified file.
2963 BACKEND is the back-end used for transcoding, as a symbol. FILE
2964 is the name of the output file, as a string.
2966 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2967 EXT-PLIST are similar to those used in `org-export-as', which
2968 see.
2970 If `org-export-copy-to-kill-ring' is non-nil, add file contents
2971 to kill ring. Return output file's name."
2972 ;; Checks for FILE permissions. `write-file' would do the same, but
2973 ;; we'd rather avoid needless transcoding of parse tree.
2975 ;; Insert contents to a temporary buffer and write it to FILE.
2981 ;; Maybe add file contents to kill ring.
2984 ;; Return full path.
2985 file)
2987 ;;;###autoload
2989 "Transcode STRING into BACKEND code.
2991 When optional argument BODY-ONLY is non-nil, only return body
2992 code, without preamble nor postamble.
2994 Optional argument EXT-PLIST, when provided, is a property list
2995 with external parameters overriding Org default settings, but
2996 still inferior to file-local settings.
2998 Return code as a string."
3005 "Return output file's name according to buffer specifications.
3007 EXTENSION is a string representing the output file extension,
3008 with the leading dot.
3010 With a non-nil optional argument SUBTREEP, try to determine
3012 of subtree at point.
3014 When optional argument PUB-DIR is set, use it as the publishing
3015 directory.
3017 When optional argument VISIBLE-ONLY is non-nil, don't export
3018 contents of hidden elements.
3020 Return file name as a string."
3023 ;; File name may come from EXPORT_FILE_NAME subtree
3024 ;; property, assuming point is at beginning of said
3025 ;; sub-tree.
3032 ;; File name may be extracted from buffer's associated
3033 ;; file, if any.
3035 ;; Can't determine file name on our own: Ask user.
3039 "Output file: " pub-dir nil nil nil
3043 ;; Build file name. Enforce EXTENSION over whatever user
3044 ;; may have come up with. PUB-DIR, if defined, always has
3045 ;; precedence over any provided path.
3050 extension))
3053 ;; If writing to OUTPUT-FILE would overwrite original file, append
3054 ;; EXTENSION another time to final name.
3057 output-file)))
3060 "Expand every include keyword in buffer.
3061 Optional argument INCLUDED is a list of included file names along
3062 with their line restriction, when appropriate. It is used to
3063 avoid infinite recursion. Optional argument DIR is the current
3064 working directory. It is used to properly resolve relative
3065 paths."
3072 ;; Extract arguments from keyword's value.
3086 ;; Minimal level of included file defaults to the child
3087 ;; level of the current headline, if any, or one. It
3088 ;; only applies is the file is meant to be included as
3089 ;; an Org one.
3097 ;; Remove keyword.
3102 ;; Check if files has already been parsed. Look after
3103 ;; inclusion lines too, as different parts of the same file
3104 ;; can be included too.
3116 ind-str contents ind-str))))
3124 ind-str env contents ind-str))))
3137 "Prepare the contents of FILE for inclusion and return them as a string.
3139 When optional argument LINES is a string specifying a range of
3140 lines, include only those lines.
3142 Optional argument IND, when non-nil, is an integer specifying the
3143 global indentation of returned contents. Since its purpose is to
3144 allow an included file to stay in the same environment it was
3145 created \(i.e. a list item), it doesn't apply past the first
3146 headline encountered.
3148 Optional argument MINLEVEL, when non-nil, is an integer
3149 specifying the level that any top-level headline in the included
3150 file should have."
3166 ;; Remove blank lines at beginning and end of contents. The logic
3167 ;; behind that removal is that blank lines around include keyword
3168 ;; override blank lines in included file.
3177 ;; If IND is set, preserve indentation of include keyword until
3178 ;; the first headline encountered.
3184 ;; Do not move footnote definitions out of column 0.
3190 ;; When MINLEVEL is specified, compute minimal level for headlines
3191 ;; in the file (CUR-MIN), and remove stars to each headline so
3192 ;; that headlines with minimal level have a level of MINLEVEL.
3202 ;; Only change stars, don't bother moving whole
3203 ;; sections.
3210 "Execute every Babel code in the visible part of current buffer."
3211 ;; Get a pristine copy of current buffer so Babel references can be
3212 ;; properly resolved.
3219 \f
3220 ;;; Tools For Back-Ends
3221 ;;
3222 ;; A whole set of tools is available to help build new exporters. Any
3223 ;; function general enough to have its use across many back-ends
3224 ;; should be added here.
3226 ;;;; For Affiliated Keywords
3227 ;;
3228 ;; `org-export-read-attribute' reads a property from a given element
3229 ;; as a plist. It can be used to normalize affiliated keywords'
3230 ;; syntax.
3231 ;;
3232 ;; Since captions can span over multiple lines and accept dual values,
3233 ;; their internal representation is a bit tricky. Therefore,
3234 ;; `org-export-get-caption' transparently returns a given element's
3235 ;; caption as a secondary string.
3238 "Turn ATTRIBUTE property from ELEMENT into a plist.
3240 When optional argument PROPERTY is non-nil, return the value of
3241 that property within attributes.
3245 properties."
3253 "Return caption from ELEMENT as a secondary string.
3255 When optional argument SHORTP is non-nil, return short caption,
3256 as a secondary string, instead.
3258 Caption lines are separated by a white space."
3266 ;;;; For Derived Back-ends
3267 ;;
3268 ;; `org-export-with-backend' is a function allowing to locally use
3269 ;; another back-end to transcode some object or element. In a derived
3270 ;; back-end, it may be used as a fall-back function once all specific
3271 ;; cases have been treated.
3274 "Call a transcoder from BACK-END on DATA.
3275 CONTENTS, when non-nil, is the transcoded contents of DATA
3276 element, as a string. INFO, when non-nil, is the communication
3277 channel used for export, as a plist.."
3287 ;;;; For Export Snippets
3288 ;;
3289 ;; Every export snippet is transmitted to the back-end. Though, the
3290 ;; latter will only retain one type of export-snippet, ignoring
3291 ;; others, based on the former's target back-end. The function
3292 ;; `org-export-snippet-backend' returns that back-end for a given
3293 ;; export-snippet.
3296 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3297 Translation, with `org-export-snippet-translation-alist', is
3298 applied."
3302 back-end))))
3305 ;;;; For Footnotes
3306 ;;
3307 ;; `org-export-collect-footnote-definitions' is a tool to list
3308 ;; actually used footnotes definitions in the whole parse tree, or in
3309 ;; a headline, in order to add footnote listings throughout the
3310 ;; transcoded data.
3311 ;;
3312 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3313 ;; back-ends, when they need to attach the footnote definition only to
3314 ;; the first occurrence of the corresponding label.
3315 ;;
3316 ;; `org-export-get-footnote-definition' and
3317 ;; `org-export-get-footnote-number' provide easier access to
3318 ;; additional information relative to a footnote reference.
3321 "Return an alist between footnote numbers, labels and definitions.
3323 DATA is the parse tree from which definitions are collected.
3324 INFO is the plist used as a communication channel.
3326 Definitions are sorted by order of references. They either
3327 appear as Org data or as a secondary string for inlined
3328 footnotes. Unreferenced definitions are ignored."
3330 collect-fn ; for byte-compiler.
3334 ;; Collect footnote number, label and definition in DATA.
3342 def)
3343 num-alist)
3344 ;; Also search in definition for nested footnotes.
3347 ;; Don't enter footnote definitions since it will happen
3348 ;; when their first reference is found.
3354 "Non-nil when a footnote reference is the first one for its label.
3356 FOOTNOTE-REFERENCE is the footnote reference being considered.
3357 INFO is the plist used as a communication channel."
3359 ;; Anonymous footnotes are always a first reference.
3361 ;; Otherwise, return the first footnote with the same LABEL and
3362 ;; test if it is equal to FOOTNOTE-REFERENCE.
3372 ;; If FN isn't inlined, be sure to traverse its
3373 ;; definition before resuming search. See
3374 ;; comments in `org-export-get-footnote-number'
3375 ;; for more information.
3379 ;; Don't enter footnote definitions since it will
3380 ;; happen when their first reference is found.
3383 footnote-reference)))))
3386 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3387 INFO is the plist used as a communication channel. If no such
3389 string."
3396 "Return number associated to a footnote.
3398 FOOTNOTE is either a footnote reference or a footnote definition.
3399 INFO is the plist used as a communication channel."
3401 seen-refs
3402 search-ref ; For byte-compiler.
3406 ;; Search footnote references through DATA, filling
3407 ;; SEEN-REFS along the way.
3412 ;; Anonymous footnote match: return number.
3415 ;; Labels match: return number.
3418 ;; Anonymous footnote: it's always a new one.
3419 ;; Also, be sure to return nil from the `cond' so
3420 ;; `first-match' doesn't get us out of the loop.
3422 ;; Label not seen so far: add it so SEEN-REFS.
3423 ;;
3424 ;; Also search for subsequent references in
3425 ;; footnote definition so numbering follows
3426 ;; reading logic. Note that we don't have to care
3427 ;; about inline definitions, since
3428 ;; `org-element-map' already traverses them at the
3429 ;; right time.
3430 ;;
3431 ;; Once again, return nil to stay in the loop.
3436 nil))))
3437 ;; Don't enter footnote definitions since it will
3438 ;; happen when their first reference is found.
3443 ;;;; For Headlines
3444 ;;
3445 ;; `org-export-get-relative-level' is a shortcut to get headline
3446 ;; level, relatively to the lower headline level in the parsed tree.
3447 ;;
3448 ;; `org-export-get-headline-number' returns the section number of an
3449 ;; headline, while `org-export-number-to-roman' allows to convert it
3450 ;; to roman numbers.
3451 ;;
3452 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3453 ;; `org-export-last-sibling-p' are three useful predicates when it
3454 ;; comes to fulfill the `:headline-levels' property.
3455 ;;
3456 ;; `org-export-get-tags', `org-export-get-category' and
3457 ;; `org-export-get-node-property' extract useful information from an
3458 ;; headline or a parent headline. They all handle inheritance.
3459 ;;
3460 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3461 ;; as a secondary string, suitable for table of contents. It falls
3462 ;; back onto default title.
3465 "Return HEADLINE relative level within current parsed tree.
3466 INFO is a plist holding contextual information."
3471 "Non-nil when HEADLINE is considered as low level.
3473 INFO is a plist used as a communication channel.
3475 A low level headlines has a relative level greater than
3476 `:headline-levels' property value.
3478 Return value is the difference between HEADLINE relative level
3479 and the last level being considered as high enough, or nil."
3486 "Return HEADLINE numbering as a list of numbers.
3487 INFO is a plist holding contextual information."
3491 "Return a non-nil value if HEADLINE element should be numbered.
3492 INFO is a plist used as a communication channel."
3498 "Convert integer N into a roman numeral."
3511 res)))
3514 "Return list of tags associated to ELEMENT.
3516 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3517 is a plist used as a communication channel.
3519 Select tags (see `org-export-select-tags') and exclude tags (see
3520 `org-export-exclude-tags') are removed from the list.
3522 When non-nil, optional argument TAGS should be a list of strings.
3523 Any tag belonging to this list will also be removed.
3525 When optional argument INHERITED is non-nil, tags can also be
3526 inherited from parent headlines and FILETAGS keywords."
3532 ;; Build complete list of inherited tags.
3543 ;; Add FILETAGS keywords and return results.
3547 "Return node PROPERTY value for BLOB.
3549 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3550 element or object.
3552 If optional argument INHERITED is non-nil, the value can be
3553 inherited from a parent headline.
3555 Return value is a string or nil."
3567 "Return category for element or object BLOB.
3569 INFO is a plist used as a communication channel.
3571 CATEGORY is automatically inherited from a parent headline, from
3572 #+CATEGORY: keyword or created out of original file name. If all
3576 ;; Almost like `org-export-node-property', but we cannot trust
3577 ;; `plist-member' as every headline has a `:CATEGORY'
3578 ;; property, would it be nil or equal to "???" (which has the
3579 ;; same meaning).
3597 "Return alternative title for HEADLINE, as a secondary string.
3598 INFO is a plist used as a communication channel. If no optional
3599 title is defined, fall-back to the regular title."
3604 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3605 INFO is a plist used as a communication channel."
3610 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3611 INFO is a plist used as a communication channel."
3615 ;;;; For Links
3616 ;;
3617 ;; `org-export-solidify-link-text' turns a string into a safer version
3618 ;; for links, replacing most non-standard characters with hyphens.
3619 ;;
3620 ;; `org-export-get-coderef-format' returns an appropriate format
3621 ;; string for coderefs.
3622 ;;
3623 ;; `org-export-inline-image-p' returns a non-nil value when the link
3624 ;; provided should be considered as an inline image.
3625 ;;
3626 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3627 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3628 ;; returns an appropriate unique identifier when found, or nil.
3629 ;;
3630 ;; `org-export-resolve-id-link' returns the first headline with
3631 ;; specified id or custom-id in parse tree, the path to the external
3632 ;; file with the id or nil when neither was found.
3633 ;;
3634 ;; `org-export-resolve-coderef' associates a reference to a line
3635 ;; number in the element it belongs, or returns the reference itself
3636 ;; when the element isn't numbered.
3639 "Take link text S and make a safe target out of it."
3644 "Return format string for code reference link.
3645 PATH is the link path. DESC is its description."
3653 "Non-nil if LINK object points to an inline image.
3655 Optional argument is a set of RULES defining inline images. It
3656 is an alist where associations have the following shape:
3658 \(TYPE . REGEXP)
3660 Applying a rule means apply REGEXP against LINK's path when its
3661 type is TYPE. The function will return a non-nil value if any of
3662 the provided rules is non-nil. The default rule is
3663 `org-export-default-inline-image-rule'.
3665 This only applies to links without a description."
3676 rules)
3677 ;; Return nil if no rule matched.
3678 nil))))
3681 "Resolve a code reference REF.
3683 INFO is a plist used as a communication channel.
3685 Return associated line number in source code, or REF itself,
3686 depending on src-block or example element's switches."
3693 org-coderef-label-format)))
3697 ;; Element containing REF is found. Resolve it to either
3698 ;; a label or a line number, as needed.
3708 "Return LINK destination.
3710 INFO is a plist holding contextual information.
3712 Return value can be an object, an element, or nil:
3714 - If LINK path matches a target object (i.e. <<path>>) or
3717 - If LINK path exactly matches the name affiliated keyword
3718 \(i.e. #+NAME: path) of an element, return that element.
3720 - If LINK path exactly matches any headline name, return that
3721 element. If more than one headline share that name, priority
3722 will be given to the one with the closest common ancestor, if
3723 any, or the first one in the parse tree otherwise.
3725 - Otherwise, return nil.
3728 significant."
3731 ;; Split PATH at white spaces so matches are space
3732 ;; insensitive.
3736 ;; First try to find a matching "<<path>>" unless user specified
3737 ;; he was looking for a headline (path starts with a *
3738 ;; character).
3745 path)
3746 blob))
3747 info t)))
3748 ;; Then try to find an element with a matching "#+NAME: path"
3749 ;; affiliated keyword.
3752 org-element-all-elements
3757 ;; Last case: link either points to a headline or to
3758 ;; nothingness. Try to find the source, with priority given to
3759 ;; headlines with the closest common ancestor. If such candidate
3760 ;; is found, return it, otherwise return nil.
3764 ;; Return first headline whose `:raw-value' property is
3765 ;; NAME in parse tree DATA, or nil. Statistics cookies
3766 ;; are ignored.
3774 name)
3775 headline))
3777 ;; Search among headlines sharing an ancestor with link, from
3778 ;; closest to farthest.
3786 ;; No match with a common ancestor: try full parse-tree.
3790 "Return headline referenced as LINK destination.
3792 INFO is a plist used as a communication channel.
3794 Return value can be the headline element matched in current parse
3798 ;; First check if id is within the current parse tree.
3803 headline))
3805 ;; Otherwise, look for external files.
3809 "Return radio-target object referenced as LINK destination.
3811 INFO is a plist used as a communication channel.
3813 Return value can be a radio-target object or nil. Assume LINK
3820 radio))
3824 ;;;; For References
3825 ;;
3826 ;; `org-export-get-ordinal' associates a sequence number to any object
3827 ;; or element.
3830 "Return ordinal number of an element or object.
3832 ELEMENT is the element or object considered. INFO is the plist
3833 used as a communication channel.
3835 Optional argument TYPES, when non-nil, is a list of element or
3836 object types, as symbols, that should also be counted in.
3837 Otherwise, only provided element's type is considered.
3839 Optional argument PREDICATE is a function returning a non-nil
3840 value if the current element or object should be counted in. It
3841 accepts two arguments: the element or object being considered and
3842 the plist used as a communication channel. This allows to count
3843 only a certain type of objects (i.e. inline images).
3845 Return value is a list of numbers if ELEMENT is a headline or an
3846 item. It is nil for keywords. It represents the footnote number
3847 for footnote definitions and footnote references. If ELEMENT is
3848 a target, return the same value as if ELEMENT was the closest
3849 table, item or headline containing the target. In any other
3850 case, return the sequence number of ELEMENT among elements or
3851 objects of the same type."
3852 ;; A target keyword, representing an invisible target, never has
3853 ;; a sequence number.
3855 ;; Ordinal of a target object refer to the ordinal of the closest
3856 ;; table, item, or headline containing the object.
3860 when
3864 table))
3865 return parent)))
3867 ;; Special case 1: A headline returns its number as a list.
3869 ;; Special case 2: An item returns its number as a list.
3873 struct
3880 ;; Increment counter until ELEMENT is found again.
3891 ;;;; For Src-Blocks
3892 ;;
3893 ;; `org-export-get-loc' counts number of code lines accumulated in
3894 ;; src-block or example-block elements with a "+n" switch until
3895 ;; a given element, excluded. Note: "-n" switches reset that count.
3896 ;;
3897 ;; `org-export-unravel-code' extracts source code (along with a code
3898 ;; references alist) from an `element-block' or `src-block' type
3899 ;; element.
3900 ;;
3901 ;; `org-export-format-code' applies a formatting function to each line
3902 ;; of code, providing relative line number and code reference when
3903 ;; appropriate. Since it doesn't access the original element from
3904 ;; which the source code is coming, it expects from the code calling
3905 ;; it to know if lines should be numbered and if code references
3906 ;; should appear.
3907 ;;
3908 ;; Eventually, `org-export-format-code-default' is a higher-level
3909 ;; function (it makes use of the two previous functions) which handles
3910 ;; line numbering and code references inclusion, and returns source
3911 ;; code in a format suitable for plain text or verbatim output.
3914 "Return accumulated lines of code up to ELEMENT.
3916 INFO is the plist used as a communication channel.
3918 ELEMENT is excluded from count."
3924 ;; ELEMENT is reached: Quit the loop.
3926 ;; Only count lines from src-block and example-block elements
3927 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3931 ;; Accumulate locs or reset them.
3935 ;; Return nil to stay in the loop.
3936 nil)))
3938 ;; Return value.
3939 loc))
3942 "Clean source code and extract references out of it.
3944 ELEMENT has either a `src-block' an `example-block' type.
3946 Return a cons cell whose CAR is the source code, cleaned from any
3947 reference and protective comma and CDR is an alist between
3948 relative line number (integer) and name of code reference on that
3949 line (string)."
3951 ;; Get code and clean it. Remove blank lines at its
3952 ;; beginning and end.
3958 ;; If appropriate, remove global indentation.
3961 c
3963 ;; Get format used for references.
3966 org-coderef-label-format)))
3967 ;; Build a regexp matching a loc with a reference.
3972 ;; Return value.
3974 ;; Code with references removed.
3980 ;; Ref line: remove ref, and signal its position in REFS.
3984 ;; Reference alist.
3985 refs)))
3988 "Format CODE by applying FUN line-wise and return it.
3990 CODE is a string representing the code to format. FUN is
3991 a function. It must accept three arguments: a line of
3992 code (string), the current line number (integer) or nil and the
3993 reference associated to the current line (string) or nil.
3995 Optional argument NUM-LINES can be an integer representing the
3996 number of code lines accumulated until the current code. Line
3997 numbers passed to FUN will take it into account. If it is nil,
3998 FUN's second argument will always be nil. This number can be
3999 obtained with `org-export-get-loc' function.
4001 Optional argument REF-ALIST can be an alist between relative line
4002 number (i.e. ignoring NUM-LINES) and the name of the code
4003 reference on it. If it is nil, FUN's third argument will always
4004 be nil. It can be obtained through the use of
4005 `org-export-unravel-code' function."
4017 "Return source code from ELEMENT, formatted in a standard way.
4019 ELEMENT is either a `src-block' or `example-block' element. INFO
4020 is a plist used as a communication channel.
4022 This function takes care of line numbering and code references
4023 inclusion. Line numbers, when applicable, appear at the
4024 beginning of the line, separated from the code by two white
4025 spaces. Code references, on the other hand, appear flushed to
4026 the right, separated by six white spaces from the widest line of
4027 code."
4028 ;; Extract code and references.
4035 ;; Handle line numbering.
4044 ;; Prepare references display, if required. Any reference
4045 ;; should start six columns after the widest line of code,
4046 ;; wrapped with parenthesis.
4051 code
4055 number-str
4056 loc
4062 num-start refs)))))
4065 ;;;; For Tables
4066 ;;
4067 ;; `org-export-table-has-special-column-p' and and
4068 ;; `org-export-table-row-is-special-p' are predicates used to look for
4069 ;; meta-information about the table structure.
4070 ;;
4071 ;; `org-table-has-header-p' tells when the rows before the first rule
4072 ;; should be considered as table's header.
4073 ;;
4074 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4075 ;; and `org-export-table-cell-borders' extract information from
4076 ;; a table-cell element.
4077 ;;
4078 ;; `org-export-table-dimensions' gives the number on rows and columns
4079 ;; in the table, ignoring horizontal rules and special columns.
4080 ;; `org-export-table-cell-address', given a table-cell object, returns
4081 ;; the absolute address of a cell. On the other hand,
4082 ;; `org-export-get-table-cell-at' does the contrary.
4083 ;;
4084 ;; `org-export-table-cell-starts-colgroup-p',
4085 ;; `org-export-table-cell-ends-colgroup-p',
4086 ;; `org-export-table-row-starts-rowgroup-p',
4087 ;; `org-export-table-row-ends-rowgroup-p',
4088 ;; `org-export-table-row-starts-header-p' and
4089 ;; `org-export-table-row-ends-header-p' indicate position of current
4090 ;; row or cell within the table.
4093 "Non-nil when TABLE has a special column.
4094 All special columns will be ignored during export."
4095 ;; The table has a special column when every first cell of every row
4096 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4097 ;; "*" "_" and "^". Though, do not consider a first row containing
4098 ;; only empty cells as special.
4114 "Non-nil when TABLE has an header.
4116 INFO is a plist used as a communication channel.
4118 A table has an header when it contains at least two row groups."
4128 info)))
4131 "Non-nil if TABLE-ROW is considered special.
4133 INFO is a plist used as the communication channel.
4135 All special rows will be ignored during export."
4139 ;; A row is special either when...
4141 ;; ... it starts with a field only containing "/",
4143 ;; ... the table contains a special column and the row start
4144 ;; with a marking character among, "^", "_", "$" or "!",
4148 ;; ... it contains only alignment cookies and empty cells.
4154 ;; Since VALUE is a secondary string, the following
4155 ;; checks avoid expanding it with `org-export-data'.
4167 "Return TABLE-ROW's group.
4169 INFO is a plist used as the communication channel.
4171 Return value is the group number, as an integer, or nil special
4172 rows and table rules. Group 1 is also table's header."
4189 "Return TABLE-CELL contents width.
4191 INFO is a plist used as the communication channel.
4193 Return value is the width given by the last width cookie in the
4194 same column as TABLE-CELL, or nil."
4199 cookie-width)
4203 ;; In a special row, try to find a width cookie at COLUMN.
4207 ;; The following checks avoid expanding unnecessarily the
4208 ;; cell with `org-export-data'
4216 ;; Ignore table rules.
4219 ;; Return value.
4220 cookie-width))
4223 "Return TABLE-CELL contents alignment.
4225 INFO is a plist used as the communication channel.
4227 Return alignment as specified by the last alignment cookie in the
4228 same column as TABLE-CELL. If no such cookie is found, a default
4229 alignment value will be deduced from fraction of numbers in the
4230 column (see `org-table-number-fraction' for more information).
4231 Possible values are `left', `right' and `center'."
4238 cookie-align)
4242 ;; In a special row, try to find an alignment cookie at
4243 ;; COLUMN.
4247 ;; Since VALUE is a secondary string, the following checks
4248 ;; avoid useless expansion through `org-export-data'.
4256 ;; Ignore table rules.
4258 ;; In a standard row, check if cell's contents are expressing
4259 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4260 ;; Though, don't bother if an alignment cookie has already
4261 ;; defined cell's alignment.
4266 info)))
4271 ;; Return value. Alignment specified by cookies has precedence
4272 ;; over alignment deduced from cells contents.
4281 "Return TABLE-CELL borders.
4283 INFO is a plist used as a communication channel.
4285 Return value is a list of symbols, or nil. Possible values are:
4286 `top', `bottom', `above', `below', `left' and `right'. Note:
4287 `top' (resp. `bottom') only happen for a cell in the first
4288 row (resp. last row) of the table, ignoring table rules, if any.
4290 Returned borders ignore special rows."
4293 borders)
4294 ;; Top/above border? TABLE-CELL has a border above when a rule
4295 ;; used to demarcate row groups can be found above. Hence,
4296 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4297 ;; another regular row has to be found above that rule.
4306 ;; Look at every row before the current one.
4308 ;; No rule above, or rule found starts the table (ignoring any
4309 ;; special row): TABLE-CELL is at the top of the table.
4312 ;; Bottom/below border? TABLE-CELL has a border below when next
4313 ;; non-regular row below is a rule.
4322 ;; Look at every row after the current one.
4324 ;; No rule below, or rule found ends the table (modulo some
4325 ;; special row): TABLE-CELL is at the bottom of the table.
4328 ;; Right/left borders? They can only be specified by column
4329 ;; groups. Column groups are defined in a row starting with "/".
4330 ;; Also a column groups row only contains "<", "<>", ">" or blank
4331 ;; cells.
4348 ;; There's a left border when previous cell, if
4349 ;; any, ends a group, or current one starts one.
4355 ;; There's a right border when next cell, if any,
4356 ;; starts a group, or current one ends one.
4363 ;; Table rows are read in reverse order so last column groups
4364 ;; row has precedence over any previous one.
4366 ;; Return value.
4367 borders))
4370 "Non-nil when TABLE-CELL is at the beginning of a row group.
4371 INFO is a plist used as a communication channel."
4372 ;; A cell starts a column group either when it is at the beginning
4373 ;; of a row (or after the special column, if any) or when it has
4374 ;; a left border.
4377 table-cell)
4381 "Non-nil when TABLE-CELL is at the end of a row group.
4382 INFO is a plist used as a communication channel."
4383 ;; A cell ends a column group either when it is at the end of a row
4384 ;; or when it has a right border.
4387 table-cell)
4391 "Non-nil when TABLE-ROW is at the beginning of a column group.
4392 INFO is a plist used as a communication channel."
4400 "Non-nil when TABLE-ROW is at the end of a column group.
4401 INFO is a plist used as a communication channel."
4409 "Non-nil when TABLE-ROW is the first table header's row.
4410 INFO is a plist used as a communication channel."
4417 "Non-nil when TABLE-ROW is the last table header's row.
4418 INFO is a plist used as a communication channel."
4425 "Return TABLE dimensions.
4427 INFO is a plist used as a communication channel.
4429 Return value is a CONS like (ROWS . COLUMNS) where
4430 ROWS (resp. COLUMNS) is the number of exportable
4431 rows (resp. columns)."
4433 ;; Set number of rows, and extract first one.
4439 ;; Set number of columns.
4441 ;; Return value.
4445 "Return address of a regular TABLE-CELL object.
4447 TABLE-CELL is the cell considered. INFO is a plist used as
4448 a communication channel.
4450 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4451 zero-based index. Only exportable cells are considered. The
4452 function returns nil for other cells."
4455 ;; Ignore cells in special rows or in special column.
4460 ;; Row number.
4468 ;; Column number.
4476 "Return regular table-cell object at ADDRESS in TABLE.
4478 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4479 zero-based index. TABLE is a table type element. INFO is
4480 a plist used as a communication channel.
4482 If no table-cell, among exportable cells, is found at ADDRESS,
4483 return nil."
4486 ;; Row at (car address) or nil.
4494 'table-cell
4501 ;;;; For Tables Of Contents
4502 ;;
4503 ;; `org-export-collect-headlines' builds a list of all exportable
4504 ;; headline elements, maybe limited to a certain depth. One can then
4505 ;; easily parse it and transcode it.
4506 ;;
4507 ;; Building lists of tables, figures or listings is quite similar.
4508 ;; Once the generic function `org-export-collect-elements' is defined,
4509 ;; `org-export-collect-tables', `org-export-collect-figures' and
4510 ;; `org-export-collect-listings' can be derived from it.
4513 "Collect headlines in order to build a table of contents.
4515 INFO is a plist used as a communication channel.
4517 When optional argument N is an integer, it specifies the depth of
4518 the table of contents. Otherwise, it is set to the value of the
4519 last headline level. See `org-export-headline-levels' for more
4520 information.
4522 Return a list of all exportable headlines as parsed elements.
4523 Footnote sections, if any, will be ignored."
4528 ;; Strip contents from HEADLINE.
4531 info))
4534 "Collect referenceable elements of a determined type.
4536 TYPE can be a symbol or a list of symbols specifying element
4537 types to search. Only elements with a caption are collected.
4539 INFO is a plist used as a communication channel.
4541 When non-nil, optional argument PREDICATE is a function accepting
4542 one argument, an element of type TYPE. It returns a non-nil
4543 value when that element should be collected.
4545 Return a list of all elements found, in order of appearance."
4550 element))
4551 info))
4554 "Build a list of tables.
4555 INFO is a plist used as a communication channel.
4557 Return a list of table elements with a caption."
4561 "Build a list of figures.
4563 INFO is a plist used as a communication channel. PREDICATE is
4564 a function which accepts one argument: a paragraph element and
4565 whose return value is non-nil when that element should be
4566 collected.
4568 A figure is a paragraph type element, with a caption, verifying
4570 a vague concept that may depend on back-end.
4572 Return a list of elements recognized as figures."
4576 "Build a list of src blocks.
4578 INFO is a plist used as a communication channel.
4580 Return a list of src-block elements with a caption."
4584 ;;;; Smart Quotes
4585 ;;
4586 ;; The main function for the smart quotes sub-system is
4587 ;; `org-export-activate-smart-quotes', which replaces every quote in
4588 ;; a given string from the parse tree with its "smart" counterpart.
4589 ;;
4590 ;; Dictionary for smart quotes is stored in
4591 ;; `org-export-smart-quotes-alist'.
4592 ;;
4593 ;; Internally, regexps matching potential smart quotes (checks at
4594 ;; string boundaries are also necessary) are defined in
4595 ;; `org-export-smart-quotes-regexps'.
4632 "Smart quotes translations.
4634 Alist whose CAR is a language string and CDR is an alist with
4635 quote type as key and a plist associating various encodings to
4636 their translation as value.
4638 A quote type can be any symbol among `opening-double-quote',
4639 `closing-double-quote', `opening-single-quote',
4640 `closing-single-quote' and `apostrophe'.
4642 Valid encodings include `:utf-8', `:html', `:latex' and
4643 `:texinfo'.
4649 ;; Possible opening quote at beginning of string.
4651 ;; Possible closing quote at beginning of string.
4653 ;; Possible apostrophe at beginning of string.
4655 ;; Opening single and double quotes.
4657 ;; Closing single and double quotes.
4659 ;; Apostrophe.
4661 ;; Possible opening quote at end of string.
4663 ;; Possible closing quote at end of string.
4665 ;; Possible apostrophe at end of string.
4667 "List of regexps matching a quote or an apostrophe.
4673 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4674 `:utf-8'. INFO is a plist used as a communication channel.
4676 The function has to retrieve information about string
4677 surroundings in parse tree. It can only happen with an
4678 unmodified string. Thus, if S has already been through another
4679 process, a non-nil ORIGINAL optional argument will provide that
4680 original string.
4682 Return the new string."
4685 ;; Try to be flexible when computing number of blanks
4686 ;; before object. The previous object may be a string
4687 ;; introduced by the back-end and not completely parsed.
4690 ;; A string with missing `:post-blank'
4691 ;; property.
4695 ;; Fallback value.
4700 ;; Return smart quote associated to a give quote Q, as
4701 ;; a string. TYPE is a symbol among `open', `close' and
4702 ;; `apostrophe'.
4712 org-export-smart-quotes-alist))))
4713 encoding)
4714 q)))))
4716 ;; Only a quote: no regexp can match. We have to check both
4717 ;; sides and decide what to do.
4725 ;; 1. Replace quote character at the beginning of S.
4727 ;; Apostrophe?
4733 ;; Closing quote?
4739 ;; Opening quote?
4745 ;; 2. Replace quotes in the middle of the string.
4747 ;; Opening quotes.
4753 ;; Closing quotes.
4759 ;; Apostrophes.
4764 ;; 3. Replace quote character at the end of S.
4766 ;; Apostrophe?
4771 ;; Closing quote?
4777 ;; Opening quote?
4782 ;; Return string with smart quotes.
4783 s))))
4785 ;;;; Topology
4786 ;;
4787 ;; Here are various functions to retrieve information about the
4788 ;; neighbourhood of a given element or object. Neighbours of interest
4789 ;; are direct parent (`org-export-get-parent'), parent headline
4790 ;; (`org-export-get-parent-headline'), first element containing an
4791 ;; object, (`org-export-get-parent-element'), parent table
4792 ;; (`org-export-get-parent-table'), previous element or object
4793 ;; (`org-export-get-previous-element') and next element or object
4794 ;; (`org-export-get-next-element').
4795 ;;
4796 ;; `org-export-get-genealogy' returns the full genealogy of a given
4797 ;; element or object, from closest parent to full parse tree.
4800 "Return BLOB parent or nil.
4801 BLOB is the element or object considered."
4805 "Return full genealogy relative to a given element or object.
4807 BLOB is the element or object being considered.
4809 Ancestors are returned from closest to farthest, the last one
4810 being the full parse tree."
4817 "Return BLOB parent headline or nil.
4818 BLOB is the element or object being considered."
4822 parent))
4825 "Return first element containing OBJECT or nil.
4826 OBJECT is the object to consider."
4830 parent))
4833 "Return OBJECT parent table or nil.
4834 OBJECT is either a `table-cell' or `table-element' type object."
4838 parent))
4841 "Return previous element or object.
4843 BLOB is an element or object. INFO is a plist used as
4844 a communication channel. Return previous exportable element or
4845 object, a string, or nil.
4847 When optional argument N is a positive integer, return a list
4848 containing up to N siblings before BLOB, from farthest to
4849 closest. With any other non-nil value, return a list containing
4850 all of them."
4852 ;; An object can belong to the contents of its parent or
4853 ;; to a secondary string. We check the latter option
4854 ;; first.
4857 org-element-all-elements))
4861 org-element-secondary-value-alist))
4862 parent)))
4865 prev)
4874 prev)))
4877 "Return next element or object.
4879 BLOB is an element or object. INFO is a plist used as
4880 a communication channel. Return next exportable element or
4881 object, a string, or nil.
4883 When optional argument N is a positive integer, return a list
4884 containing up to N siblings after BLOB, from closest to farthest.
4885 With any other non-nil value, return a list containing all of
4886 them."
4888 ;; An object can belong to the contents of its parent or to
4889 ;; a secondary string. We check the latter option first.
4892 org-element-all-objects))
4896 org-element-secondary-value-alist))
4897 parent)))
4900 next)
4908 siblings)
4912 ;;;; Translation
4913 ;;
4914 ;; `org-export-translate' translates a string according to language
4915 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4916 ;; variable and a specified charset. `org-export-dictionary' contains
4917 ;; the dictionary used for the translation.
5039 "Dictionary for export engine.
5041 Alist whose CAR is the string to translate and CDR is an alist
5042 whose CAR is the language string and CDR is a plist whose
5043 properties are possible charsets and values translated terms.
5045 It is used as a database for `org-export-translate'. Since this
5046 function returns the string as-is if no translation was found,
5047 the variable only needs to record values different from the
5051 "Translate string S according to language specification.
5053 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5054 and `:utf-8'. INFO is a plist used as a communication channel.
5056 Translation depends on `:language' property. Return the
5057 translated string. If no translation is found, try to fall back
5058 to `:default' encoding. If it fails, return S."
5064 s)))
5067 \f
5068 ;;; Asynchronous Export
5069 ;;
5070 ;; `org-export-async-start' is the entry point for asynchronous
5071 ;; export. It recreates current buffer (including visibility,
5072 ;; narrowing and visited file) in an external Emacs process, and
5073 ;; evaluates a command there. It then applies a function on the
5074 ;; returned results in the current process.
5075 ;;
5076 ;; Asynchronously generated results are never displayed directly.
5077 ;; Instead, they are stored in `org-export-stack-contents'. They can
5078 ;; then be retrieved by calling `org-export-stack'.
5079 ;;
5080 ;; Export Stack is viewed through a dedicated major mode
5081 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5082 ;;`org-export-stack-delete', `org-export-stack-view' and
5083 ;;`org-export-stack-clear'.
5084 ;;
5085 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5086 ;; It should used whenever `org-export-async-start' is called.
5089 "Call function FUN on the results returned by BODY evaluation.
5091 BODY evaluation happens in an asynchronous process, from a buffer
5092 which is an exact copy of the current one.
5094 Use `org-export-add-to-stack' in FUN in order to register results
5095 in the stack. Examples for, respectively a temporary buffer and
5096 a file are:
5098 \(org-export-async-start
5099 \(lambda (output)
5101 \(erase-buffer)
5102 \(insert output)
5103 \(goto-char (point-min))
5104 \(org-export-add-to-stack (current-buffer) 'backend)))
5105 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5107 and
5109 \(org-export-async-start
5110 \(lambda (f) (org-export-add-to-stack f 'backend))
5111 `(expand-file-name
5112 \(org-export-to-file
5113 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5116 ;; Write the full sexp evaluating BODY in a copy of the current
5117 ;; buffer to a temporary file, as it may be too long for program
5118 ;; args in `start-process'.
5125 "%S"
5128 ;; Ignore `org-mode-hook' as it has been run already
5129 ;; in the original buffer. Ignore `kill-emacs-hook'
5130 ;; as we need a truly non-interactive process.
5132 ;; Initialize `org-mode' and export framework in the
5133 ;; external process.
5136 ;; Re-create current buffer there.
5139 ;; Sexp to evaluate in the buffer.
5141 ;; Start external process.
5144 (,process
5149 "-l" org-export-async-init-file
5151 ;; Register running process in stack.
5153 ;; Set-up sentinel in order to catch results.
5155 ,process
5179 "Add a new result to export stack if not present already.
5181 SOURCE is a buffer or a file name containing export results.
5182 BACKEND is a symbol representing export back-end used to generate
5183 it.
5185 Entries already pointing to SOURCE and unavailable entries are
5186 removed beforehand. Return the new stack."
5192 "Menu for asynchronous export results and running processes."
5202 "Return source from export results at point in stack."
5209 source
5210 ;; SOURCE is not consistent with current line. The stack
5211 ;; view is outdated.
5215 "Remove all entries from export stack."
5220 "Refresh the asynchronous export stack.
5221 DUMMY is ignored. Unavailable sources are removed from the list.
5222 Return the new stack."
5232 ;; Back-end.
5234 ;; Age.
5237 ;; Compute age of the results.
5239 "%4h:%.2m "
5241 ;; Source.
5246 ;; Clear stack from exited processes, dead buffers or
5247 ;; non-existent files.
5259 "Remove export results at point from stack.
5260 If optional argument SOURCE is non-nil, remove it instead."
5265 org-export-stack-contents))))
5268 "View export results at point in stack.
5269 With an optional prefix argument IN-EMACS, force viewing files
5270 within Emacs."
5284 (define-key km "p" 'previous-line)
5285 (define-key km "\C-p" 'previous-line)
5286 (define-key km "\C-?" 'previous-line)
5287 (define-key km [up] 'previous-line)
5288 (define-key km "C" 'org-export-stack-clear)
5289 (define-key km "v" 'org-export-stack-view)
5290 (define-key km (kbd "RET") 'org-export-stack-view)
5291 (define-key km "d" 'org-export-stack-remove)
5292 km)
5293 "Keymap for Org Export Stack.")
5295 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5296 "Mode for displaying asynchronous export stack.
5299 stack.
5301 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5302 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5303 stack completely.
5305 Removing entries in an Org Export Stack buffer doesn't affect
5306 files or buffers, only the display.
5309 (abbrev-mode 0)
5310 (auto-fill-mode 0)
5311 (setq buffer-read-only t
5312 buffer-undo-list t
5313 truncate-lines t
5314 header-line-format
5315 '(:eval
5316 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5317 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5318 (set (make-local-variable 'revert-buffer-function)
5319 'org-export-stack-refresh))
5322 \f
5323 ;;; The Dispatcher
5324 ;;
5325 ;; `org-export-dispatch' is the standard interactive way to start an
5326 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5327 ;; for its interface, which, in turn, delegates response to key
5328 ;; pressed to `org-export--dispatch-action'.
5330 ;;;###autoload
5331 (defun org-export-dispatch (&optional arg)
5332 "Export dispatcher for Org mode.
5334 It provides an access to common export related tasks in a buffer.
5335 Its interface comes in two flavours: standard and expert.
5337 While both share the same set of bindings, only the former
5338 displays the valid keys associations in a dedicated buffer.
5339 Scrolling (resp. line-wise motion) in this buffer is done with
5340 SPC and DEL (resp. C-n and C-p) keys.
5342 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5343 flavour or the other.
5346 of options used back then, on the current buffer.
5348 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5349 (interactive "P")
5350 (let* ((input
5351 (cond ((equal arg '(16)) '(stack))
5352 ((and arg org-export-dispatch-last-action))
5353 (t (save-window-excursion
5354 (unwind-protect
5355 (progn
5356 ;; Remember where we are
5357 (move-marker org-export-dispatch-last-position
5358 (point)
5359 (org-base-buffer (current-buffer)))
5360 ;; Get and store an export command
5361 (setq org-export-dispatch-last-action
5362 (org-export--dispatch-ui
5363 (list org-export-initial-scope
5364 (and org-export-in-background 'async))
5365 nil
5366 org-export-dispatch-use-expert-ui)))
5367 (and (get-buffer "*Org Export Dispatcher*")
5368 (kill-buffer "*Org Export Dispatcher*")))))))
5369 (action (car input))
5370 (optns (cdr input)))
5371 (unless (memq 'subtree optns)
5372 (move-marker org-export-dispatch-last-position nil))
5373 (case action
5374 ;; First handle special hard-coded actions.
5375 (stack (org-export-stack))
5376 (publish-current-file
5377 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5378 (publish-current-project
5379 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5380 (publish-choose-project
5381 (org-publish (assoc (org-icompleting-read
5382 "Publish project: "
5383 org-publish-project-alist nil t)
5384 org-publish-project-alist)
5385 (memq 'force optns)
5386 (memq 'async optns)))
5387 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5388 (otherwise
5389 (save-excursion
5390 (when arg
5391 ;; Repeating command, maybe move cursor
5392 ;; to restore subtree context
5393 (if (eq (marker-buffer org-export-dispatch-last-position)
5394 (org-base-buffer (current-buffer)))
5395 (goto-char org-export-dispatch-last-position)
5396 ;; We are in a differnet buffer, forget position
5397 (move-marker org-export-dispatch-last-position nil)))
5398 (funcall action
5399 ;; Return a symbol instead of a list to ease
5400 ;; asynchronous export macro use.
5401 (and (memq 'async optns) t)
5402 (and (memq 'subtree optns) t)
5403 (and (memq 'visible optns) t)
5404 (and (memq 'body optns) t)))))))
5406 (defun org-export--dispatch-ui (options first-key expertp)
5407 "Handle interface for `org-export-dispatch'.
5409 OPTIONS is a list containing current interactive options set for
5410 export. It can contain any of the following symbols:
5411 `body' toggles a body-only export
5412 `subtree' restricts export to current subtree
5413 `visible' restricts export to visible part of buffer.
5414 `force' force publishing files.
5415 `async' use asynchronous export process
5417 FIRST-KEY is the key pressed to select the first level menu. It
5418 is nil when this menu hasn't been selected yet.
5420 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5421 buffer is provided, but indications about currently active
5422 options are given in the prompt. Moreover, \[?] allows to switch
5423 back to standard interface."
5424 (let* ((fontify-key
5425 (lambda (key &optional access-key)
5426 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5427 ;; non-nil is the required first-level key to activate
5428 ;; KEY. When its value is t, activate KEY independently
5429 ;; on the first key, if any. A nil value means KEY will
5430 ;; only be activated at first level.
5431 (if (or (eq access-key t) (eq access-key first-key))
5432 (org-propertize key 'face 'org-warning)
5433 key)))
5434 (fontify-value
5435 (lambda (value)
5436 ;; Fontify VALUE string.
5437 (org-propertize value 'face 'font-lock-variable-name-face)))
5438 ;; Prepare menu entries by extracting them from
5439 ;; `org-export-registered-backends', and sorting them by
5440 ;; access key and by ordinal, if any.
5441 (backends
5442 (sort
5443 (sort
5444 (delq nil
5445 (mapcar
5446 (lambda (b)
5447 (let ((name (car b)))
5448 (catch 'ignored
5449 ;; Ignore any back-end belonging to
5450 ;; `org-export-invisible-backends' or derived
5451 ;; from one of them.
5452 (dolist (ignored org-export-invisible-backends)
5453 (when (org-export-derived-backend-p name ignored)
5454 (throw 'ignored nil)))
5455 (org-export-backend-menu name))))
5456 org-export-registered-backends))
5457 (lambda (a b)
5458 (let ((key-a (nth 1 a))
5459 (key-b (nth 1 b)))
5460 (cond ((and (numberp key-a) (numberp key-b))
5461 (< key-a key-b))
5462 ((numberp key-b) t)))))
5463 (lambda (a b) (< (car a) (car b)))))
5464 ;; Compute a list of allowed keys based on the first key
5465 ;; pressed, if any. Some keys (?^B, ?^V, ?^S, ?^F, ?^A
5466 ;; and ?q) are always available.
5467 (allowed-keys
5468 (nconc (list 2 22 19 6 1)
5469 (if (not first-key) (org-uniquify (mapcar 'car backends))
5470 (let (sub-menu)
5471 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5472 (when (eq (car backend) first-key)
5473 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5474 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5475 ((not first-key) (list ?P)))
5476 (list ?&)
5477 (when expertp (list ??))
5478 (list ?q)))
5479 ;; Build the help menu for standard UI.
5480 (help
5481 (unless expertp
5482 (concat
5483 ;; Options are hard-coded.
5484 (format "Options
5485 [%s] Body only: %s [%s] Visible only: %s
5486 [%s] Export scope: %s [%s] Force publishing: %s
5488 (funcall fontify-key "C-b" t)
5489 (funcall fontify-value
5490 (if (memq 'body options) "On " "Off"))
5491 (funcall fontify-key "C-v" t)
5492 (funcall fontify-value
5493 (if (memq 'visible options) "On " "Off"))
5494 (funcall fontify-key "C-s" t)
5495 (funcall fontify-value
5496 (if (memq 'subtree options) "Subtree" "Buffer "))
5497 (funcall fontify-key "C-f" t)
5498 (funcall fontify-value
5499 (if (memq 'force options) "On " "Off"))
5500 (funcall fontify-key "C-a" t)
5501 (funcall fontify-value
5502 (if (memq 'async options) "On " "Off")))
5503 ;; Display registered back-end entries. When a key
5504 ;; appears for the second time, do not create another
5505 ;; entry, but append its sub-menu to existing menu.
5506 (let (last-key)
5507 (mapconcat
5508 (lambda (entry)
5509 (let ((top-key (car entry)))
5510 (concat
5511 (unless (eq top-key last-key)
5512 (setq last-key top-key)
5514 (funcall fontify-key (char-to-string top-key))
5515 (nth 1 entry)))
5516 (let ((sub-menu (nth 2 entry)))
5517 (unless (functionp sub-menu)
5518 ;; Split sub-menu into two columns.
5519 (let ((index -1))
5520 (concat
5521 (mapconcat
5522 (lambda (sub-entry)
5523 (incf index)
5524 (format
5525 (if (zerop (mod index 2)) " [%s] %-26s"
5527 (funcall fontify-key
5528 (char-to-string (car sub-entry))
5529 top-key)
5530 (nth 1 sub-entry)))
5531 sub-menu "")
5533 backends ""))
5534 ;; Publishing menu is hard-coded.
5536 [%s] Current file [%s] Current project
5538 (funcall fontify-key "P")
5539 (funcall fontify-key "f" ?P)
5540 (funcall fontify-key "p" ?P)
5541 (funcall fontify-key "x" ?P)
5542 (funcall fontify-key "a" ?P))
5544 (format "\[%s] %s"
5545 (funcall fontify-key "q" t)
5546 (if first-key "Main menu" "Exit")))))
5547 ;; Build prompts for both standard and expert UI.
5548 (standard-prompt (unless expertp "Export command: "))
5549 (expert-prompt
5550 (when expertp
5551 (format
5552 "Export command (C-%s%s%s%s%s) [%s]: "
5553 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5554 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5555 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5556 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5557 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5558 (mapconcat (lambda (k)
5559 ;; Strip control characters.
5560 (unless (< k 27) (char-to-string k)))
5561 allowed-keys "")))))
5562 ;; With expert UI, just read key with a fancy prompt. In standard
5563 ;; UI, display an intrusive help buffer.
5564 (if expertp
5565 (org-export--dispatch-action
5566 expert-prompt allowed-keys backends options first-key expertp)
5567 ;; At first call, create frame layout in order to display menu.
5568 (unless (get-buffer "*Org Export Dispatcher*")
5569 (delete-other-windows)
5570 (org-switch-to-buffer-other-window
5571 (get-buffer-create "*Org Export Dispatcher*"))
5572 (setq cursor-type nil
5573 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
5574 ;; Make sure that invisible cursor will not highlight square
5575 ;; brackets.
5576 (set-syntax-table (copy-syntax-table))
5577 (modify-syntax-entry ?\[ "w"))
5578 ;; At this point, the buffer containing the menu exists and is
5579 ;; visible in the current window. So, refresh it.
5580 (with-current-buffer "*Org Export Dispatcher*"
5581 ;; Refresh help. Maintain display continuity by re-visiting
5582 ;; previous window position.
5583 (let ((pos (window-start)))
5584 (erase-buffer)
5585 (insert help)
5586 (set-window-start nil pos)))
5587 (org-fit-window-to-buffer)
5588 (org-export--dispatch-action
5589 standard-prompt allowed-keys backends options first-key expertp))))
5591 (defun org-export--dispatch-action
5592 (prompt allowed-keys backends options first-key expertp)
5593 "Read a character from command input and act accordingly.
5595 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5596 a list of characters available at a given step in the process.
5597 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5598 EXPERTP are the same as defined in `org-export--dispatch-ui',
5599 which see.
5601 Toggle export options when required. Otherwise, return value is
5602 a list with action as CAR and a list of interactive export
5603 options as CDR."
5604 (let (key)
5605 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
5606 ;; C-p, SPC, DEL).
5607 (while (and (setq key (read-char-exclusive prompt))
5608 (not expertp)
5609 (memq key '(14 16 ?\s ?\d)))
5610 (case key
5611 (14 (if (not (pos-visible-in-window-p (point-max)))
5612 (ignore-errors (scroll-up-line))
5613 (message "End of buffer")
5614 (sit-for 1)))
5615 (16 (if (not (pos-visible-in-window-p (point-min)))
5616 (ignore-errors (scroll-down-line))
5617 (message "Beginning of buffer")
5618 (sit-for 1)))
5619 (?\s (if (not (pos-visible-in-window-p (point-max)))
5620 (scroll-up nil)
5621 (message "End of buffer")
5622 (sit-for 1)))
5623 (?\d (if (not (pos-visible-in-window-p (point-min)))
5624 (scroll-down nil)
5625 (message "Beginning of buffer")
5626 (sit-for 1)))))
5627 (cond
5628 ;; Ignore undefined associations.
5629 ((not (memq key allowed-keys))
5630 (ding)
5631 (unless expertp (message "Invalid key") (sit-for 1))
5632 (org-export--dispatch-ui options first-key expertp))
5633 ;; q key at first level aborts export. At second
5634 ;; level, cancel first key instead.
5635 ((eq key ?q) (if (not first-key) (error "Export aborted")
5636 (org-export--dispatch-ui options nil expertp)))
5637 ;; Help key: Switch back to standard interface if
5638 ;; expert UI was active.
5639 ((eq key ??) (org-export--dispatch-ui options first-key nil))
5640 ;; Switch to asynchronous export stack.
5641 ((eq key ?&) '(stack))
5642 ;; Toggle export options
5643 ;; C-b (2) C-v (22) C-s (19) C-f (6) C-a (1)
5644 ((memq key '(2 22 19 6 1))
5645 (org-export--dispatch-ui
5646 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
5647 (6 'force) (1 'async))))
5648 (if (memq option options) (remq option options)
5649 (cons option options)))
5650 first-key expertp))
5651 ;; Action selected: Send key and options back to
5652 ;; `org-export-dispatch'.
5653 ((or first-key (functionp (nth 2 (assq key backends))))
5654 (cons (cond
5655 ((not first-key) (nth 2 (assq key backends)))
5656 ;; Publishing actions are hard-coded. Send a special
5657 ;; signal to `org-export-dispatch'.
5658 ((eq first-key ?P)
5659 (case key
5660 (?f 'publish-current-file)
5661 (?p 'publish-current-project)
5662 (?x 'publish-choose-project)
5663 (?a 'publish-all)))
5664 ;; Return first action associated to FIRST-KEY + KEY
5665 ;; path. Indeed, derived backends can share the same
5666 ;; FIRST-KEY.
5667 (t (catch 'found
5668 (mapc (lambda (backend)
5669 (let ((match (assq key (nth 2 backend))))
5670 (when match (throw 'found (nth 2 match)))))
5671 (member (assq first-key backends) backends)))))
5672 options))
5673 ;; Otherwise, enter sub-menu.
5674 (t (org-export--dispatch-ui options key expertp)))))
5678 (provide 'ox)
5680 ;; Local variables:
5681 ;; generated-autoload-file: "org-loaddefs.el"
5682 ;; End:
5684 ;;; ox.el ends here