| blob | 60f61e0c0171f85e8f57cb6926ba586be3800763 |
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,
402 :inline t
406 "Non-nil means insert author email into the exported file.
407 This option can also be set with the #+OPTIONS line,
413 "Non-nil means interpret *word*, /word/, _word_ and +word+.
415 If the export target supports emphasizing text, the word will be
416 typeset in bold, italic, with an underline or strike-through,
417 respectively.
424 "Tags that exclude a tree from export.
426 All trees carrying any of these tags will be excluded from
427 export. This is without condition, so even subtrees inside that
428 carry one of the `org-export-select-tags' will be removed.
430 This option can also be set with the #+EXCLUDE_TAGS: keyword."
437 This can be used to have pre-formatted text, fragments of code
438 etc. For example:
439 : ;; Some Lisp examples
440 : (while (defc cnt)
441 : (ding))
442 will be looking just like this in also HTML. See also the QUOTE
443 keyword. Not all export backends support this.
450 "Non-nil means Org footnotes should be exported.
451 This option can also be set with the #+OPTIONS line,
457 "Non-nil means process LaTeX environments and fragments.
459 This option can also be set with the +OPTIONS line,
462 nil Ignore math snippets.
463 `verbatim' Keep everything in verbatim.
464 t Allow export of math snippets."
474 "The last level which is still exported as a headline.
476 Inferior levels will produce itemize or enumerate lists when
477 exported.
484 "The default language for export and clocktable translations, as a string.
485 This may have an association in
486 `org-clock-clocktable-language-setup'."
491 "Non-nil means preserve all line breaks when exporting.
492 This option can also be set with the #+OPTIONS line,
498 "Non-nil means interpret entities when exporting.
501 Å.
503 For a list of supported names, see the constant `org-entities'
504 and the user option `org-entities-user'.
506 This option can also be set with the #+OPTIONS line,
512 "Non-nil means inlinetasks should be exported.
513 This option can also be set with the #+OPTIONS line,
521 "Non-nil means include planning info in export.
522 This option can also be set with the #+OPTIONS: line,
530 "Non-nil means include priority cookies in export.
531 This option can also be set with the #+OPTIONS line,
537 "Non-nil means add section numbers to headlines when exporting.
539 When set to an integer n, numbering will only happen for
540 headlines whose relative level is higher or equal to n.
542 This option can also be set with the #+OPTIONS line,
548 "Tags that select a tree for export.
550 If any such tag is found in a buffer, all trees that do not carry
551 one of these tags will be ignored during export. Inside trees
552 that are selected like this, you can still deselect a subtree by
553 tagging it with one of the `org-export-exclude-tags'.
555 This option can also be set with the #+SELECT_TAGS: keyword."
560 "Non-nil means activate smart quotes during export.
561 This option can also be set with the #+OPTIONS: line,
571 When this option is turned on, these strings will be exported as:
573 Org HTML LaTeX UTF-8
574 -----+----------+--------+-------
576 -- – -- –
577 --- — --- —
580 This option can also be set with the #+OPTIONS line,
586 "Non-nil means include statistics cookies in export.
587 This option can also be set with the #+OPTIONS: line,
597 When this option is turned on, you can use TeX-like syntax for
599 will be considered as a single item - so grouping with {} is
600 normally not needed. For example, the following things will be
601 parsed as single sub- or superscripts.
603 10^24 or 10^tau several digits will be considered 1 item.
604 10^-12 or 10^-tau a leading sign with digits or a word
605 x^2-y^3 will be read as x^2 - y^3, because items are
606 terminated by almost any nonword/nondigit char.
607 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
609 Still, ambiguity is possible - so when in doubt use {} to enclose
610 the sub/superscript. If you set this variable to the symbol
611 `{}', the braces are *required* in order to trigger
612 interpretations as sub/superscript. This can be helpful in
615 This option can also be set with the #+OPTIONS line,
624 "Non-nil means create a table of contents in exported files.
626 The TOC contains headlines with levels up
627 to`org-export-headline-levels'. When an integer, include levels
628 up to N in the toc, this may then be different from
629 `org-export-headline-levels', but it will not be allowed to be
630 larger than the number of headline levels. When nil, no table of
631 contents is made.
633 This option can also be set with the #+OPTIONS line,
643 For example:
645 | Name | Address | Birthday |
646 |-------------+----------+-----------|
647 | Arthur Dent | England | 29.2.2100 |
654 "If nil, do not export tags, just remove them from headlines.
656 If this is the symbol `not-in-toc', tags will be removed from
657 table of contents entries, but still be shown in the headlines of
658 the document.
660 This option can also be set with the #+OPTIONS line,
669 "Non-nil means include TODO items for export.
671 This may have the following values:
672 t include tasks independent of state.
673 `todo' include only tasks that are not yet done.
674 `done' include only tasks that are already done.
675 nil ignore all tasks.
676 list of keywords include tasks with these keywords.
678 This option can also be set with the #+OPTIONS line,
690 "Non-nil means insert a time stamp into the exported file.
691 The time stamp shows when the file was created.
693 This option can also be set with the #+OPTIONS line,
699 "Non nil means allow timestamps in export.
701 It can be set to `active', `inactive', t or nil, in order to
702 export, respectively, only active timestamps, only inactive ones,
703 all of them or none.
705 This option can also be set with the #+OPTIONS line, e.g.
715 "Non-nil means include TODO keywords in export.
716 When nil, remove all these keywords from the export."
721 "Non-nil means BIND keywords can define local variable values.
722 This is a potential security risk, which is why the default value
723 is nil. You can also allow them through local buffer variables."
730 "Alist between export snippets back-ends and exporter back-ends.
732 This variable allows to provide shortcuts for export snippets.
736 HTML code while every other back-end will ignore it."
745 "Coding system for the exported file."
752 "Should we push exported content to the kill ring?"
761 "The initial scope when exporting with `org-export-dispatch'.
762 This variable can be either set to `buffer' or `subtree'."
769 "Non-nil means show buffer after exporting to temp buffer.
770 When Org exports to a file, the buffer visiting that file is ever
771 shown, but remains buried. However, when exporting to
772 a temporary buffer, that buffer is popped up in a second window.
773 When this variable is nil, the buffer remains buried also in
774 these cases."
779 "Non-nil means export and publishing commands will run in background.
780 Results from an asynchronous export are never displayed
788 "File used to initialize external export process.
789 Value must be an absolute file name. It defaults to user's
790 initialization file. Though, a specific configuration makes the
791 process faster and the export more portable."
798 "List of back-ends that shouldn't appear in the dispatcher.
800 Any back-end belonging to this list or derived from a back-end
801 belonging to it will not appear in the dispatcher menu.
803 Indeed, Org may require some export back-ends without notice. If
804 these modules are never to be used interactively, adding them
805 here will avoid cluttering the dispatcher menu."
812 "Non-nil means using a non-intrusive `org-export-dispatch'.
813 In that case, no help buffer is displayed. Though, an indicator
819 asynchronous). Also, \[?] allows to switch back to standard
820 mode."
827 \f
828 ;;; Defining Back-ends
829 ;;
830 ;; `org-export-define-backend' is the standard way to define an export
831 ;; back-end. It allows to specify translators, filters, buffer
832 ;; options and a menu entry. If the new back-end shares translators
833 ;; with another back-end, `org-export-define-derived-backend' may be
834 ;; used instead.
835 ;;
836 ;; Internally, a back-end is stored as a list, of which CAR is the
837 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
838 ;; properties of a given back-end are: `org-export-backend-filters',
839 ;; `org-export-backend-menu', `org-export-backend-options' and
840 ;; `org-export-backend-translate-table'.
841 ;;
842 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
843 ;; when a given back-end hasn't been registered yet.
846 "Define a new back-end BACKEND.
848 TRANSLATORS is an alist between object or element types and
849 functions handling them.
851 These functions should return a string without any trailing
852 space, or nil. They must accept three arguments: the object or
853 element itself, its contents or nil when it isn't recursive and
854 the property list used as a communication channel.
856 Contents, when not nil, are stripped from any global indentation
857 \(although the relative one is preserved). They also always end
858 with a single newline character.
860 If, for a given type, no function is found, that element or
861 object type will simply be ignored, along with any blank line or
862 white space at its end. The same will happen if the function
863 returns the nil value. If that function returns the empty
864 string, the type will be ignored, but the blank lines or white
865 spaces will be kept.
867 In addition to element and object types, one function can be
868 associated to the `template' (or `inner-template') symbol and
869 another one to the `plain-text' symbol.
871 The former returns the final transcoded string, and can be used
872 to add a preamble and a postamble to document's body. It must
873 accept two arguments: the transcoded string and the property list
874 containing export options. A function associated to `template'
876 A function associated to `inner-template' is always applied.
878 The latter, when defined, is to be called on every text not
879 recognized as an element or an object. It must accept two
880 arguments: the text string and the information channel. It is an
881 appropriate place to protect special chars relative to the
882 back-end.
884 BODY can start with pre-defined keyword arguments. The following
885 keywords are understood:
887 :export-block
889 String, or list of strings, representing block names that
890 will not be parsed. This is used to specify blocks that will
891 contain raw code specific to the back-end. These blocks
892 still have to be handled by the relative `export-block' type
893 translator.
895 :filters-alist
897 Alist between filters and function, or list of functions,
898 specific to the back-end. See `org-export-filters-alist' for
899 a list of all allowed filters. Filters defined here
900 shouldn't make a back-end test, as it may prevent back-ends
901 derived from this one to behave properly.
903 :menu-entry
905 Menu entry for the export dispatcher. It should be a list
906 like:
908 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
910 where :
912 KEY is a free character selecting the back-end.
914 DESCRIPTION-OR-ORDINAL is either a string or a number.
916 If it is a string, is will be used to name the back-end in
917 its menu entry. If it is a number, the following menu will
918 be displayed as a sub-menu of the back-end with the same
919 KEY. Also, the number will be used to determine in which
920 order such sub-menus will appear (lowest first).
922 ACTION-OR-MENU is either a function or an alist.
924 If it is an action, it will be called with four
925 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
926 BODY-ONLY. See `org-export-as' for further explanations on
927 some of them.
929 If it is an alist, associations should follow the
930 pattern:
932 \(KEY DESCRIPTION ACTION)
934 where KEY, DESCRIPTION and ACTION are described above.
936 Valid values include:
940 or
945 \(lambda (a s v b)
946 \(if a (org-latex-export-to-pdf t s v b)
947 \(org-open-file
948 \(org-latex-export-to-pdf nil s v b)))))))
950 or the following, which will be added to the previous
951 sub-menu,
953 \(?l 1
957 :options-alist
959 Alist between back-end specific properties introduced in
960 communication channel and how their value are acquired. See
961 `org-export-options-alist' for more information about
962 structure of the values."
981 ;; Register back-end.
985 ;; Tell parser to not parse EXPORT-BLOCK blocks.
992 ;; Splice in the body, if any.
996 "Create a new back-end as a variant of an existing one.
998 CHILD is the name of the derived back-end. PARENT is the name of
999 the parent back-end.
1001 BODY can start with pre-defined keyword arguments. The following
1002 keywords are understood:
1004 :export-block
1006 String, or list of strings, representing block names that
1007 will not be parsed. This is used to specify blocks that will
1008 contain raw code specific to the back-end. These blocks
1009 still have to be handled by the relative `export-block' type
1010 translator.
1012 :filters-alist
1014 Alist of filters that will overwrite or complete filters
1015 defined in PARENT back-end. See `org-export-filters-alist'
1016 for a list of allowed filters.
1018 :menu-entry
1020 Menu entry for the export dispatcher. See
1021 `org-export-define-backend' for more information about the
1022 expected value.
1024 :options-alist
1026 Alist of back-end specific properties that will overwrite or
1027 complete those defined in PARENT back-end. Refer to
1028 `org-export-options-alist' for more information about
1029 structure of the values.
1031 :translate-alist
1033 Alist of element and object types and transcoders that will
1034 overwrite or complete transcode table from PARENT back-end.
1035 Refer to `org-export-define-backend' for detailed information
1036 about transcoders.
1039 as a variant of `latex' back-end with a custom template function:
1041 \(org-export-define-derived-backend my-latex latex
1042 :translate-alist ((template . my-latex-template-fun)))
1044 The back-end could then be called with, for example:
1072 ;; Register back-end.
1076 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1083 ;; Splice in the body, if any.
1087 "Return back-end from which BACKEND is derived, or nil."
1091 "Return filters for BACKEND."
1096 "Return menu entry for BACKEND."
1101 "Return export options for BACKEND."
1106 "Return translate table for BACKEND."
1111 "Signal an error if BACKEND isn't defined."
1116 "Non-nil if BACKEND is derived from one of BACKENDS."
1120 parent))
1123 \f
1124 ;;; The Communication Channel
1125 ;;
1126 ;; During export process, every function has access to a number of
1127 ;; properties. They are of two types:
1128 ;;
1129 ;; 1. Environment options are collected once at the very beginning of
1130 ;; the process, out of the original buffer and configuration.
1131 ;; Collecting them is handled by `org-export-get-environment'
1132 ;; function.
1133 ;;
1134 ;; Most environment options are defined through the
1135 ;; `org-export-options-alist' variable.
1136 ;;
1137 ;; 2. Tree properties are extracted directly from the parsed tree,
1138 ;; just before export, by `org-export-collect-tree-properties'.
1139 ;;
1140 ;; Here is the full list of properties available during transcode
1141 ;; process, with their category and their value type.
1142 ;;
1143 ;; + `:author' :: Author's name.
1144 ;; - category :: option
1145 ;; - type :: string
1146 ;;
1147 ;; + `:back-end' :: Current back-end used for transcoding.
1148 ;; - category :: tree
1149 ;; - type :: symbol
1150 ;;
1151 ;; + `:creator' :: String to write as creation information.
1152 ;; - category :: option
1153 ;; - type :: string
1154 ;;
1155 ;; + `:date' :: String to use as date.
1156 ;; - category :: option
1157 ;; - type :: string
1158 ;;
1159 ;; + `:description' :: Description text for the current data.
1160 ;; - category :: option
1161 ;; - type :: string
1162 ;;
1163 ;; + `:email' :: Author's email.
1164 ;; - category :: option
1165 ;; - type :: string
1166 ;;
1167 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1168 ;; process.
1169 ;; - category :: option
1170 ;; - type :: list of strings
1171 ;;
1172 ;; + `:export-options' :: List of export options available for current
1173 ;; process.
1174 ;; - category :: none
1175 ;; - type :: list of symbols, among `subtree', `body-only' and
1176 ;; `visible-only'.
1177 ;;
1178 ;; + `:exported-data' :: Hash table used for memoizing
1179 ;; `org-export-data'.
1180 ;; - category :: tree
1181 ;; - type :: hash table
1182 ;;
1183 ;; + `:filetags' :: List of global tags for buffer. Used by
1184 ;; `org-export-get-tags' to get tags with inheritance.
1185 ;; - category :: option
1186 ;; - type :: list of strings
1187 ;;
1188 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1189 ;; their definition, as parsed data. Only non-inlined footnotes
1190 ;; are represented in this alist. Also, every definition isn't
1191 ;; guaranteed to be referenced in the parse tree. The purpose of
1192 ;; this property is to preserve definitions from oblivion
1193 ;; (i.e. when the parse tree comes from a part of the original
1194 ;; buffer), it isn't meant for direct use in a back-end. To
1195 ;; retrieve a definition relative to a reference, use
1196 ;; `org-export-get-footnote-definition' instead.
1197 ;; - category :: option
1198 ;; - type :: alist (STRING . LIST)
1199 ;;
1200 ;; + `:headline-levels' :: Maximum level being exported as an
1201 ;; headline. Comparison is done with the relative level of
1202 ;; headlines in the parse tree, not necessarily with their
1203 ;; actual level.
1204 ;; - category :: option
1205 ;; - type :: integer
1206 ;;
1207 ;; + `:headline-offset' :: Difference between relative and real level
1208 ;; of headlines in the parse tree. For example, a value of -1
1209 ;; means a level 2 headline should be considered as level
1210 ;; 1 (cf. `org-export-get-relative-level').
1211 ;; - category :: tree
1212 ;; - type :: integer
1213 ;;
1214 ;; + `:headline-numbering' :: Alist between headlines and their
1215 ;; numbering, as a list of numbers
1216 ;; (cf. `org-export-get-headline-number').
1217 ;; - category :: tree
1218 ;; - type :: alist (INTEGER . LIST)
1219 ;;
1220 ;; + `:id-alist' :: Alist between ID strings and destination file's
1221 ;; path, relative to current directory. It is used by
1222 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1223 ;; external file.
1224 ;; - category :: option
1225 ;; - type :: alist (STRING . STRING)
1226 ;;
1227 ;; + `:ignore-list' :: List of elements and objects that should be
1228 ;; ignored during export.
1229 ;; - category :: tree
1230 ;; - type :: list of elements and objects
1231 ;;
1232 ;; + `:input-file' :: Full path to input file, if any.
1233 ;; - category :: option
1234 ;; - type :: string or nil
1235 ;;
1236 ;; + `:keywords' :: List of keywords attached to data.
1237 ;; - category :: option
1238 ;; - type :: string
1239 ;;
1240 ;; + `:language' :: Default language used for translations.
1241 ;; - category :: option
1242 ;; - type :: string
1243 ;;
1244 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1245 ;; transcoding.
1246 ;; - category :: option
1247 ;; - type :: list (as returned by `org-element-parse-buffer')
1248 ;;
1249 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1250 ;; all line breaks.
1251 ;; - category :: option
1252 ;; - type :: symbol (nil, t)
1253 ;;
1254 ;; + `:section-numbers' :: Non-nil means transcoding should add
1255 ;; section numbers to headlines.
1256 ;; - category :: option
1257 ;; - type :: symbol (nil, t)
1258 ;;
1259 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1260 ;; in transcoding. When such a tag is present, subtrees without
1261 ;; it are de facto excluded from the process. See
1262 ;; `use-select-tags'.
1263 ;; - category :: option
1264 ;; - type :: list of strings
1265 ;;
1266 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1267 ;; a time stamp in the output.
1268 ;; - category :: option
1269 ;; - type :: symbol (nil, t)
1270 ;;
1271 ;; + `:translate-alist' :: Alist between element and object types and
1272 ;; transcoding functions relative to the current back-end.
1273 ;; Special keys `inner-template', `template' and `plain-text' are
1274 ;; also possible.
1275 ;; - category :: option
1276 ;; - type :: alist (SYMBOL . FUNCTION)
1277 ;;
1278 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1279 ;; also be transcoded. If it is set to the `headline' symbol,
1280 ;; only the archived headline's name is retained.
1281 ;; - category :: option
1282 ;; - type :: symbol (nil, t, `headline')
1283 ;;
1284 ;; + `:with-author' :: Non-nil means author's name should be included
1285 ;; in the output.
1286 ;; - category :: option
1287 ;; - type :: symbol (nil, t)
1288 ;;
1289 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1290 ;; - category :: option
1291 ;; - type :: symbol (nil, t)
1292 ;;
1293 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1294 ;; inserted at the end of the transcoded string. If the value
1295 ;; is `comment', it should be commented.
1296 ;; - category :: option
1297 ;; - type :: symbol (`comment', nil, t)
1298 ;;
1299 ;; + `:with-date' :: Non-nil means output should contain a date.
1300 ;; - category :: option
1301 ;; - type :. symbol (nil, t)
1302 ;;
1303 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1304 ;; its value is a list of names, only drawers with such names
1305 ;; will be transcoded. If that list starts with `not', drawer
1306 ;; with these names will be skipped.
1307 ;; - category :: option
1308 ;; - type :: symbol (nil, t) or list of strings
1309 ;;
1310 ;; + `:with-email' :: Non-nil means output should contain author's
1311 ;; email.
1312 ;; - category :: option
1313 ;; - type :: symbol (nil, t)
1314 ;;
1315 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1316 ;; interpreted.
1317 ;; - category :: option
1318 ;; - type :: symbol (nil, t)
1319 ;;
1320 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1321 ;; strings starting with a colon as a fixed-with (verbatim) area.
1322 ;; - category :: option
1323 ;; - type :: symbol (nil, t)
1324 ;;
1325 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1326 ;; footnotes.
1327 ;; - category :: option
1328 ;; - type :: symbol (nil, t)
1329 ;;
1330 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1331 ;; `latex-fragment' objects should appear in export output. When
1332 ;; this property is set to `verbatim', they will be left as-is.
1333 ;; - category :: option
1334 ;; - type :: symbol (`verbatim', nil, t)
1335 ;;
1336 ;; + `:with-plannings' :: Non-nil means transcoding should include
1337 ;; planning info.
1338 ;; - category :: option
1339 ;; - type :: symbol (nil, t)
1340 ;;
1341 ;; + `:with-priority' :: Non-nil means transcoding should include
1342 ;; priority cookies.
1343 ;; - category :: option
1344 ;; - type :: symbol (nil, t)
1345 ;;
1346 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1347 ;; plain text.
1348 ;; - category :: option
1349 ;; - type :: symbol (nil, t)
1350 ;;
1351 ;; + `:with-special-strings' :: Non-nil means transcoding should
1352 ;; interpret special strings in plain text.
1353 ;; - category :: option
1354 ;; - type :: symbol (nil, t)
1355 ;;
1356 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1357 ;; interpret subscript and superscript. With a value of "{}",
1358 ;; only interpret those using curly brackets.
1359 ;; - category :: option
1360 ;; - type :: symbol (nil, {}, t)
1361 ;;
1362 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1363 ;; tables.
1364 ;; - category :: option
1365 ;; - type :: symbol (nil, t)
1366 ;;
1367 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1368 ;; headlines. A `not-in-toc' value will remove them from the
1369 ;; table of contents, if any, nonetheless.
1370 ;; - category :: option
1371 ;; - type :: symbol (nil, t, `not-in-toc')
1372 ;;
1373 ;; + `:with-tasks' :: Non-nil means transcoding should include
1374 ;; headlines with a TODO keyword. A `todo' value will only
1375 ;; include headlines with a todo type keyword while a `done'
1376 ;; value will do the contrary. If a list of strings is provided,
1377 ;; only tasks with keywords belonging to that list will be kept.
1378 ;; - category :: option
1379 ;; - type :: symbol (t, todo, done, nil) or list of strings
1380 ;;
1381 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1382 ;; time stamps. Special value `active' (resp. `inactive') ask to
1383 ;; export only active (resp. inactive) timestamps. Otherwise,
1384 ;; completely remove them.
1385 ;; - category :: option
1386 ;; - type :: symbol: (`active', `inactive', t, nil)
1387 ;;
1388 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1389 ;; added to the output. An integer value limits its depth.
1390 ;; - category :: option
1391 ;; - type :: symbol (nil, t or integer)
1392 ;;
1393 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1394 ;; include TODO keywords.
1395 ;; - category :: option
1396 ;; - type :: symbol (nil, t)
1399 ;;;; Environment Options
1400 ;;
1401 ;; Environment options encompass all parameters defined outside the
1402 ;; scope of the parsed data. They come from five sources, in
1403 ;; increasing precedence order:
1404 ;;
1405 ;; - Global variables,
1406 ;; - Buffer's attributes,
1407 ;; - Options keyword symbols,
1408 ;; - Buffer keywords,
1409 ;; - Subtree properties.
1410 ;;
1411 ;; The central internal function with regards to environment options
1412 ;; is `org-export-get-environment'. It updates global variables with
1413 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1414 ;; the different sources.
1415 ;;
1416 ;; The internal functions doing the retrieval are:
1417 ;; `org-export--get-global-options',
1418 ;; `org-export--get-buffer-attributes',
1419 ;; `org-export--parse-option-keyword',
1420 ;; `org-export--get-subtree-options' and
1421 ;; `org-export--get-inbuffer-options'
1422 ;;
1423 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1424 ;; relative to "#+BIND:" keywords.
1427 "Collect export options from the current buffer.
1429 Optional argument BACKEND is a symbol specifying which back-end
1430 specific options to read, if any.
1432 When optional argument SUBTREEP is non-nil, assume the export is
1433 done against the current sub-tree.
1435 Third optional argument EXT-PLIST is a property list with
1436 external parameters overriding Org default settings, but still
1437 inferior to file-local settings."
1438 ;; First install #+BIND variables.
1440 ;; Get and prioritize export options...
1442 ;; ... from global variables...
1444 ;; ... from an external property list...
1445 ext-plist
1446 ;; ... from in-buffer settings...
1448 ;; ... and from subtree, when appropriate.
1450 ;; Eventually add misc. properties.
1452 :back-end
1453 backend
1454 :translate-alist
1456 :footnote-definition-alist
1457 ;; Footnotes definitions must be collected in the original
1458 ;; buffer, as there's no insurance that they will still be in
1459 ;; the parse tree, due to possible narrowing.
1473 alist))))
1474 alist))
1475 :id-alist
1476 ;; Collect id references.
1487 alist))))
1490 "Parse an OPTIONS line and return values as a plist.
1491 Optional argument BACKEND is a symbol specifying which back-end
1492 specific items to read, if any."
1494 ;; Priority is given to back-end specific options.
1496 org-export-options-alist))
1497 plist)
1506 options))
1508 property
1511 plist))
1514 "Get export options in subtree at point.
1515 Optional argument BACKEND is a symbol specifying back-end used
1516 for export. Return options as a plist."
1517 ;; For each buffer keyword, create a headline property setting the
1518 ;; same property in communication channel. The name for the property
1519 ;; is the keyword with "EXPORT_" appended to it.
1522 ;; Make sure point is at an heading.
1524 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1525 ;; title as its fallback value.
1531 plist :title
1534 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1538 ;; Handle other keywords. TITLE keyword is excluded as it has
1539 ;; been handled already.
1547 ;; Export properties are not case-sensitive.
1554 plist
1555 property
1557 ;; Parse VALUE if required.
1561 ;; If BEHAVIOUR is `split' expected value is
1562 ;; a list of strings, not a string.
1565 ;; Look for both general keywords and back-end specific
1566 ;; options, with priority given to the latter.
1568 org-export-options-alist)))
1569 ;; Return value.
1570 plist)))
1573 "Return current buffer export options, as a plist.
1575 Optional argument BACKEND, when non-nil, is a symbol specifying
1576 which back-end specific options should also be read in the
1577 process.
1579 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1581 get-options ; For byte-compiler.
1584 ;; Priority is given to back-end specific options.
1586 org-export-options-alist))
1589 org-export-special-keywords))))
1592 ;; Return property name associated to KEYWORD.
1597 options))))
1600 ;; Recursively read keywords in buffer. FILES is a list
1601 ;; of files read so far. PLIST is the current property
1602 ;; list obtained.
1611 ;; Options in `org-export-special-keywords'.
1615 ;; Avoid circular dependencies.
1625 plist
1630 plist
1636 ;; Options in `org-export-options-alist'.
1641 plist prop
1642 ;; Handle value depending on specified
1643 ;; BEHAVIOUR.
1649 " "
1661 ;; Return final value.
1662 plist))))
1663 ;; Read options in the current buffer.
1665 ;; Parse keywords specified in `org-element-document-properties'.
1667 ;; Find the property associated to the keyword.
1675 org-element-document-properties)
1676 ;; Return value.
1677 plist))
1680 "Return properties related to buffer attributes, as a plist."
1683 ;; Store full path of input file name, or nil. For internal use.
1684 :input-file visited-file
1691 "Return global export options as a plist.
1693 Optional argument BACKEND, if non-nil, is a symbol specifying
1694 which back-end specific export options should also be read in the
1695 process."
1697 ;; Priority is given to back-end specific options.
1699 org-export-options-alist))
1700 plist)
1707 plist
1708 prop
1709 ;; Eval default value provided. If keyword is a member
1710 ;; of `org-element-document-properties', parse it as
1711 ;; a secondary string before storing it.
1716 value
1719 all)
1720 ;; Return value.
1721 plist))
1724 "Install the values from #+BIND lines as local variables.
1725 Variables must be installed before in-buffer options are
1726 retrieved."
1741 ;;;; Tree Properties
1742 ;;
1743 ;; Tree properties are information extracted from parse tree. They
1744 ;; are initialized at the beginning of the transcoding process by
1745 ;; `org-export-collect-tree-properties'.
1746 ;;
1747 ;; Dedicated functions focus on computing the value of specific tree
1748 ;; properties during initialization. Thus,
1749 ;; `org-export--populate-ignore-list' lists elements and objects that
1750 ;; should be skipped during export, `org-export--get-min-level' gets
1751 ;; the minimal exportable level, used as a basis to compute relative
1752 ;; level for headlines. Eventually
1753 ;; `org-export--collect-headline-numbering' builds an alist between
1754 ;; headlines and their numbering.
1757 "Extract tree properties from parse tree.
1759 DATA is the parse tree from which information is retrieved. INFO
1760 is a list holding export options.
1762 Following tree properties are set or updated:
1764 `:exported-data' Hash table used to memoize results from
1765 `org-export-data'.
1767 `:footnote-definition-alist' List of footnotes definitions in
1768 original buffer and current parse tree.
1770 `:headline-offset' Offset between true level of headlines and
1771 local level. An offset of -1 means a headline
1772 of level 2 should be considered as a level
1773 1 headline in the context.
1775 `:headline-numbering' Alist of all headlines as key an the
1776 associated numbering as value.
1778 `:ignore-list' List of elements that should be ignored during
1779 export.
1781 Return updated plist."
1782 ;; Install the parse tree in the communication channel, in order to
1783 ;; use `org-export-get-genealogy' and al.
1785 ;; Get the list of elements and objects to ignore, and put it into
1786 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1787 ;; been done during parse tree filtering.
1790 :ignore-list
1793 ;; Compute `:headline-offset' in order to be able to use
1794 ;; `org-export-get-relative-level'.
1797 :headline-offset
1799 ;; Update footnotes definitions list with definitions in parse tree.
1800 ;; This is required since buffer expansion might have modified
1801 ;; boundaries of footnote definitions contained in the parse tree.
1802 ;; This way, definitions in `footnote-definition-alist' are bound to
1803 ;; match those in the parse tree.
1809 defs)))
1811 ;; Properties order doesn't matter: get the rest of the tree
1812 ;; properties.
1816 info))
1819 "Return minimum exportable headline's level in DATA.
1820 DATA is parsed tree as returned by `org-element-parse-buffer'.
1821 OPTIONS is a plist holding export options."
1832 ;; If no headline was found, for the sake of consistency, set
1833 ;; minimum level to 1 nonetheless.
1837 "Return numbering of all exportable headlines in a parse tree.
1839 DATA is the parse tree. OPTIONS is the plist holding export
1840 options.
1842 Return an alist whose key is a headline and value is its
1843 associated numbering \(in the shape of a list of numbers\) or nil
1844 for a footnotes section."
1852 headline
1854 for idx from 0 to org-export-max-depth
1858 options)))
1861 "Return list of elements and objects to ignore during export.
1862 DATA is the parse tree to traverse. OPTIONS is the plist holding
1863 export options."
1865 walk-data
1866 ;; First find trees containing a select tag, if any.
1870 ;; Collect ignored elements or objects into IGNORE-LIST.
1876 ;; If headline is archived but tree below has
1877 ;; to be skipped, add it to ignore list.
1880 ;; Move into secondary string, if any.
1885 ;; Move into recursive objects/elements.
1887 ;; Main call.
1889 ;; Return value.
1890 ignore))
1893 "Return list of headlines and inlinetasks with a select tag in their tree.
1894 DATA is parsed data as returned by `org-element-parse-buffer'.
1895 INFO is a plist holding export options."
1897 walk-data ; For byte-compiler.
1907 ;; When a select tag is found, mark full
1908 ;; genealogy and every headline within the tree
1909 ;; as acceptable.
1912 genealogy
1915 selected-trees))
1916 ;; If at a headline, continue searching in tree,
1917 ;; recursively.
1927 selected-trees))
1930 "Non-nil when element or object BLOB should be skipped during export.
1931 OPTIONS is the plist holding export options. SELECTED, when
1932 non-nil, is a list of headlines or inlinetasks belonging to
1933 a tree with a select tag."
1940 ;; If `:with-drawers' value starts with `not', ignore
1941 ;; every drawer whose name belong to that list.
1942 ;; Otherwise, ignore drawers whose name isn't in that
1943 ;; list.
1957 ;; Ignore subtrees with an exclude tag.
1960 ;; When a select tag is present in the buffer, ignore any tree
1961 ;; without it.
1963 ;; Ignore commented sub-trees.
1965 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1967 ;; Ignore tasks, if specified by `:with-tasks' property.
1983 ;; No timestamp allowed.
1985 ;; Only active timestamps allowed and the current one isn't
1986 ;; active.
1990 ;; Only inactive timestamps allowed and the current one isn't
1991 ;; inactive.
1996 \f
1997 ;;; The Transcoder
1998 ;;
1999 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2000 ;; `org-element-parse-buffer') and transcodes it into a specified
2001 ;; back-end output. It takes care of filtering out elements or
2002 ;; objects according to export options and organizing the output blank
2003 ;; lines and white space are preserved. The function memoizes its
2004 ;; results, so it is cheap to call it within translators.
2005 ;;
2006 ;; It is possible to modify locally the back-end used by
2007 ;; `org-export-data' or even use a temporary back-end by using
2008 ;; `org-export-data-with-translations' and
2009 ;; `org-export-data-with-backend'.
2010 ;;
2011 ;; Internally, three functions handle the filtering of objects and
2012 ;; elements during the export. In particular,
2013 ;; `org-export-ignore-element' marks an element or object so future
2014 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2015 ;; elements or objects should be seen as real Org syntax and
2016 ;; `org-export-expand' transforms the others back into their original
2017 ;; shape
2018 ;;
2019 ;; `org-export-transcoder' is an accessor returning appropriate
2020 ;; translator function for a given element or object.
2023 "Return appropriate transcoder for BLOB.
2024 INFO is a plist containing export directives."
2026 ;; Return contents only for complete parse trees.
2032 "Convert DATA into current back-end format.
2034 DATA is a parse tree, an element or an object or a secondary
2035 string. INFO is a plist holding export options.
2037 Return transcoded string."
2043 ;; Ignored element/object.
2045 ;; Plain text.
2051 info))
2052 ;; Uninterpreted element/object: change it back to Org
2053 ;; syntax and export again resulting raw string.
2057 data
2061 info))
2062 ;; Secondary string.
2065 ;; Element/Object without contents or, as a special case,
2066 ;; headline with archive tag and archived trees restricted
2067 ;; to title only.
2075 ;; Element/Object with contents.
2088 ;; Elements directly containing objects
2089 ;; must have their indentation normalized
2090 ;; first.
2092 data
2093 ;; When normalizing contents of the first
2094 ;; paragraph in an item or a footnote
2095 ;; definition, ignore first line's
2096 ;; indentation: there is none and it
2097 ;; might be misleading.
2102 data)
2109 info))))))))
2110 ;; Final result will be memoized before being returned.
2112 data
2116 ;; Append the same white space between elements or objects as in
2117 ;; the original buffer, and call appropriate filters.
2128 info)))
2129 results)))
2133 "Convert DATA into another format using a given translation table.
2134 DATA is an element, an object, a secondary string or a string.
2135 TRANSLATIONS is an alist between element or object types and
2136 a functions handling them. See `org-export-define-backend' for
2137 more information. INFO is a plist used as a communication
2138 channel."
2140 data
2141 ;; Set-up a new communication channel with TRANSLATIONS as the
2142 ;; translate table and a new hash table for memoization.
2144 info
2146 ;; Size of the hash table is reduced since this function
2147 ;; will probably be used on short trees.
2151 "Convert DATA into BACKEND format.
2153 DATA is an element, an object, a secondary string or a string.
2154 BACKEND is a symbol. INFO is a plist used as a communication
2155 channel.
2157 Unlike to `org-export-with-backend', this function will
2158 recursively convert DATA using BACKEND translation table."
2164 "Non-nil if element or object BLOB should be interpreted during export.
2165 If nil, BLOB will appear as raw Org syntax. Check is done
2166 according to export options INFO, stored as a plist."
2168 ;; ... entities...
2170 ;; ... emphasis...
2173 ;; ... fixed-width areas.
2175 ;; ... footnotes...
2178 ;; ... LaTeX environments and fragments...
2182 ;; ... sub/superscripts...
2188 ;; ... tables...
2193 "Expand a parsed element or object to its original state.
2194 BLOB is either an element or an object. CONTENTS is its
2195 contents, as a string or nil."
2198 blob contents))
2201 "Add ELEMENT to `:ignore-list' in INFO.
2203 Any element in `:ignore-list' will be skipped when using
2204 `org-element-map'. INFO is modified by side effects."
2208 \f
2209 ;;; The Filter System
2210 ;;
2211 ;; Filters allow end-users to tweak easily the transcoded output.
2212 ;; They are the functional counterpart of hooks, as every filter in
2213 ;; a set is applied to the return value of the previous one.
2214 ;;
2215 ;; Every set is back-end agnostic. Although, a filter is always
2216 ;; called, in addition to the string it applies to, with the back-end
2217 ;; used as argument, so it's easy for the end-user to add back-end
2218 ;; specific filters in the set. The communication channel, as
2219 ;; a plist, is required as the third argument.
2220 ;;
2221 ;; From the developer side, filters sets can be installed in the
2222 ;; process with the help of `org-export-define-backend', which
2223 ;; internally stores filters as an alist. Each association has a key
2224 ;; among the following symbols and a function or a list of functions
2225 ;; as value.
2226 ;;
2227 ;; - `:filter-options' applies to the property list containing export
2228 ;; options. Unlike to other filters, functions in this list accept
2229 ;; two arguments instead of three: the property list containing
2230 ;; export options and the back-end. Users can set its value through
2231 ;; `org-export-filter-options-functions' variable.
2232 ;;
2233 ;; - `:filter-parse-tree' applies directly to the complete parsed
2234 ;; tree. Users can set it through
2235 ;; `org-export-filter-parse-tree-functions' variable.
2236 ;;
2237 ;; - `:filter-final-output' applies to the final transcoded string.
2238 ;; Users can set it with `org-export-filter-final-output-functions'
2239 ;; variable
2240 ;;
2241 ;; - `:filter-plain-text' applies to any string not recognized as Org
2242 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2243 ;; configure it.
2244 ;;
2245 ;; - `:filter-TYPE' applies on the string returned after an element or
2246 ;; object of type TYPE has been transcoded. An user can modify
2247 ;; `org-export-filter-TYPE-functions'
2248 ;;
2249 ;; All filters sets are applied with
2250 ;; `org-export-filter-apply-functions' function. Filters in a set are
2251 ;; applied in a LIFO fashion. It allows developers to be sure that
2252 ;; their filters will be applied first.
2253 ;;
2254 ;; Filters properties are installed in communication channel with
2255 ;; `org-export-install-filters' function.
2256 ;;
2257 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2258 ;; `org-export-before-parsing-hook') are run at the beginning of the
2259 ;; export process and just before parsing to allow for heavy structure
2260 ;; modifications.
2263 ;;;; Hooks
2266 "Hook run at the beginning of the export process.
2268 This is run before include keywords and macros are expanded and
2269 Babel code blocks executed, on a copy of the original buffer
2270 being exported. Visibility and narrowing are preserved. Point
2271 is at the beginning of the buffer.
2273 Every function in this hook will be called with one argument: the
2277 "Hook run before parsing an export buffer.
2279 This is run after include keywords and macros have been expanded
2280 and Babel code blocks executed, on a copy of the original buffer
2281 being exported. Visibility and narrowing are preserved. Point
2282 is at the beginning of the buffer.
2284 Every function in this hook will be called with one argument: the
2288 ;;;; Special Filters
2291 "List of functions applied to the export options.
2292 Each filter is called with two arguments: the export options, as
2293 a plist, and the back-end, as a symbol. It must return
2297 "List of functions applied to the parsed tree.
2298 Each filter is called with three arguments: the parse tree, as
2299 returned by `org-element-parse-buffer', the back-end, as
2300 a symbol, and the communication channel, as a plist. It must
2304 "List of functions applied to plain text.
2305 Each filter is called with three arguments: a string which
2306 contains no Org syntax, the back-end, as a symbol, and the
2307 communication channel, as a plist. It must return a string or
2311 "List of functions applied to the transcoded string.
2312 Each filter is called with three arguments: the full transcoded
2313 string, the back-end, as a symbol, and the communication channel,
2314 as a plist. It must return a string that will be used as the
2318 ;;;; Elements Filters
2321 "List of functions applied to a transcoded babel-call.
2322 Each filter is called with three arguments: the transcoded data,
2323 as a string, the back-end, as a symbol, and the communication
2327 "List of functions applied to a transcoded center block.
2328 Each filter is called with three arguments: the transcoded data,
2329 as a string, the back-end, as a symbol, and the communication
2333 "List of functions applied to a transcoded clock.
2334 Each filter is called with three arguments: the transcoded data,
2335 as a string, the back-end, as a symbol, and the communication
2339 "List of functions applied to a transcoded comment.
2340 Each filter is called with three arguments: the transcoded data,
2341 as a string, the back-end, as a symbol, and the communication
2345 "List of functions applied to a transcoded comment-block.
2346 Each filter is called with three arguments: the transcoded data,
2347 as a string, the back-end, as a symbol, and the communication
2351 "List of functions applied to a transcoded diary-sexp.
2352 Each filter is called with three arguments: the transcoded data,
2353 as a string, the back-end, as a symbol, and the communication
2357 "List of functions applied to a transcoded drawer.
2358 Each filter is called with three arguments: the transcoded data,
2359 as a string, the back-end, as a symbol, and the communication
2363 "List of functions applied to a transcoded dynamic-block.
2364 Each filter is called with three arguments: the transcoded data,
2365 as a string, the back-end, as a symbol, and the communication
2369 "List of functions applied to a transcoded example-block.
2370 Each filter is called with three arguments: the transcoded data,
2371 as a string, the back-end, as a symbol, and the communication
2375 "List of functions applied to a transcoded export-block.
2376 Each filter is called with three arguments: the transcoded data,
2377 as a string, the back-end, as a symbol, and the communication
2381 "List of functions applied to a transcoded fixed-width.
2382 Each filter is called with three arguments: the transcoded data,
2383 as a string, the back-end, as a symbol, and the communication
2387 "List of functions applied to a transcoded footnote-definition.
2388 Each filter is called with three arguments: the transcoded data,
2389 as a string, the back-end, as a symbol, and the communication
2393 "List of functions applied to a transcoded headline.
2394 Each filter is called with three arguments: the transcoded data,
2395 as a string, the back-end, as a symbol, and the communication
2399 "List of functions applied to a transcoded horizontal-rule.
2400 Each filter is called with three arguments: the transcoded data,
2401 as a string, the back-end, as a symbol, and the communication
2405 "List of functions applied to a transcoded inlinetask.
2406 Each filter is called with three arguments: the transcoded data,
2407 as a string, the back-end, as a symbol, and the communication
2411 "List of functions applied to a transcoded item.
2412 Each filter is called with three arguments: the transcoded data,
2413 as a string, the back-end, as a symbol, and the communication
2417 "List of functions applied to a transcoded keyword.
2418 Each filter is called with three arguments: the transcoded data,
2419 as a string, the back-end, as a symbol, and the communication
2423 "List of functions applied to a transcoded latex-environment.
2424 Each filter is called with three arguments: the transcoded data,
2425 as a string, the back-end, as a symbol, and the communication
2429 "List of functions applied to a transcoded node-property.
2430 Each filter is called with three arguments: the transcoded data,
2431 as a string, the back-end, as a symbol, and the communication
2435 "List of functions applied to a transcoded paragraph.
2436 Each filter is called with three arguments: the transcoded data,
2437 as a string, the back-end, as a symbol, and the communication
2441 "List of functions applied to a transcoded plain-list.
2442 Each filter is called with three arguments: the transcoded data,
2443 as a string, the back-end, as a symbol, and the communication
2447 "List of functions applied to a transcoded planning.
2448 Each filter is called with three arguments: the transcoded data,
2449 as a string, the back-end, as a symbol, and the communication
2453 "List of functions applied to a transcoded property-drawer.
2454 Each filter is called with three arguments: the transcoded data,
2455 as a string, the back-end, as a symbol, and the communication
2459 "List of functions applied to a transcoded quote block.
2460 Each filter is called with three arguments: the transcoded quote
2461 data, as a string, the back-end, as a symbol, and the
2462 communication channel, as a plist. It must return a string or
2466 "List of functions applied to a transcoded quote-section.
2467 Each filter is called with three arguments: the transcoded data,
2468 as a string, the back-end, as a symbol, and the communication
2472 "List of functions applied to a transcoded section.
2473 Each filter is called with three arguments: the transcoded data,
2474 as a string, the back-end, as a symbol, and the communication
2478 "List of functions applied to a transcoded special block.
2479 Each filter is called with three arguments: the transcoded data,
2480 as a string, the back-end, as a symbol, and the communication
2484 "List of functions applied to a transcoded src-block.
2485 Each filter is called with three arguments: the transcoded data,
2486 as a string, the back-end, as a symbol, and the communication
2490 "List of functions applied to a transcoded table.
2491 Each filter is called with three arguments: the transcoded data,
2492 as a string, the back-end, as a symbol, and the communication
2496 "List of functions applied to a transcoded table-cell.
2497 Each filter is called with three arguments: the transcoded data,
2498 as a string, the back-end, as a symbol, and the communication
2502 "List of functions applied to a transcoded table-row.
2503 Each filter is called with three arguments: the transcoded data,
2504 as a string, the back-end, as a symbol, and the communication
2508 "List of functions applied to a transcoded verse block.
2509 Each filter is called with three arguments: the transcoded data,
2510 as a string, the back-end, as a symbol, and the communication
2514 ;;;; Objects Filters
2517 "List of functions applied to transcoded bold text.
2518 Each filter is called with three arguments: the transcoded data,
2519 as a string, the back-end, as a symbol, and the communication
2523 "List of functions applied to transcoded code text.
2524 Each filter is called with three arguments: the transcoded data,
2525 as a string, the back-end, as a symbol, and the communication
2529 "List of functions applied to a transcoded entity.
2530 Each filter is called with three arguments: the transcoded data,
2531 as a string, the back-end, as a symbol, and the communication
2535 "List of functions applied to a transcoded export-snippet.
2536 Each filter is called with three arguments: the transcoded data,
2537 as a string, the back-end, as a symbol, and the communication
2541 "List of functions applied to a transcoded footnote-reference.
2542 Each filter is called with three arguments: the transcoded data,
2543 as a string, the back-end, as a symbol, and the communication
2547 "List of functions applied to a transcoded inline-babel-call.
2548 Each filter is called with three arguments: the transcoded data,
2549 as a string, the back-end, as a symbol, and the communication
2553 "List of functions applied to a transcoded inline-src-block.
2554 Each filter is called with three arguments: the transcoded data,
2555 as a string, the back-end, as a symbol, and the communication
2559 "List of functions applied to transcoded italic text.
2560 Each filter is called with three arguments: the transcoded data,
2561 as a string, the back-end, as a symbol, and the communication
2565 "List of functions applied to a transcoded latex-fragment.
2566 Each filter is called with three arguments: the transcoded data,
2567 as a string, the back-end, as a symbol, and the communication
2571 "List of functions applied to a transcoded line-break.
2572 Each filter is called with three arguments: the transcoded data,
2573 as a string, the back-end, as a symbol, and the communication
2577 "List of functions applied to a transcoded link.
2578 Each filter is called with three arguments: the transcoded data,
2579 as a string, the back-end, as a symbol, and the communication
2583 "List of functions applied to a transcoded macro.
2584 Each filter is called with three arguments: the transcoded data,
2585 as a string, the back-end, as a symbol, and the communication
2589 "List of functions applied to a transcoded radio-target.
2590 Each filter is called with three arguments: the transcoded data,
2591 as a string, the back-end, as a symbol, and the communication
2595 "List of functions applied to a transcoded statistics-cookie.
2596 Each filter is called with three arguments: the transcoded data,
2597 as a string, the back-end, as a symbol, and the communication
2601 "List of functions applied to transcoded strike-through text.
2602 Each filter is called with three arguments: the transcoded data,
2603 as a string, the back-end, as a symbol, and the communication
2607 "List of functions applied to a transcoded subscript.
2608 Each filter is called with three arguments: the transcoded data,
2609 as a string, the back-end, as a symbol, and the communication
2613 "List of functions applied to a transcoded superscript.
2614 Each filter is called with three arguments: the transcoded data,
2615 as a string, the back-end, as a symbol, and the communication
2619 "List of functions applied to a transcoded target.
2620 Each filter is called with three arguments: the transcoded data,
2621 as a string, the back-end, as a symbol, and the communication
2625 "List of functions applied to a transcoded timestamp.
2626 Each filter is called with three arguments: the transcoded data,
2627 as a string, the back-end, as a symbol, and the communication
2631 "List of functions applied to transcoded underline text.
2632 Each filter is called with three arguments: the transcoded data,
2633 as a string, the back-end, as a symbol, and the communication
2637 "List of functions applied to transcoded verbatim text.
2638 Each filter is called with three arguments: the transcoded data,
2639 as a string, the back-end, as a symbol, and the communication
2643 ;;;; Filters Tools
2644 ;;
2645 ;; Internal function `org-export-install-filters' installs filters
2646 ;; hard-coded in back-ends (developer filters) and filters from global
2647 ;; variables (user filters) in the communication channel.
2648 ;;
2649 ;; Internal function `org-export-filter-apply-functions' takes care
2650 ;; about applying each filter in order to a given data. It ignores
2651 ;; filters returning a nil value but stops whenever a filter returns
2652 ;; an empty string.
2655 "Call every function in FILTERS.
2657 Functions are called with arguments VALUE, current export
2658 back-end and INFO. A function returning a nil value will be
2659 skipped. If it returns the empty string, the process ends and
2660 VALUE is ignored.
2662 Call is done in a LIFO fashion, to be sure that developer
2663 specified filters, if any, are called first."
2672 "Install filters properties in communication channel.
2673 INFO is a plist containing the current communication channel.
2674 Return the updated communication channel."
2676 ;; Install user-defined filters with `org-export-filters-alist'
2677 ;; and filters already in INFO (through ext-plist mechanism).
2684 ;; Filters in INFO will be called
2685 ;; before those user provided.
2688 default-value)))))
2689 org-export-filters-alist)
2690 ;; Prepend back-end specific filters to that list.
2692 ;; Single values get consed, lists are appended.
2697 plist key
2701 ;; Return new communication channel.
2705 \f
2706 ;;; Core functions
2707 ;;
2708 ;; This is the room for the main function, `org-export-as', along with
2709 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2710 ;; `org-export-string-as'. They differ either by the way they output
2711 ;; the resulting code (for the first two) or by the input type (for
2712 ;; the latter).
2713 ;;
2714 ;; `org-export-output-file-name' is an auxiliary function meant to be
2715 ;; used with `org-export-to-file'. With a given extension, it tries
2716 ;; to provide a canonical file name to write export output to.
2717 ;;
2718 ;; Note that `org-export-as' doesn't really parse the current buffer,
2719 ;; but a copy of it (with the same buffer-local variables and
2720 ;; visibility), where macros and include keywords are expanded and
2721 ;; Babel blocks are executed, if appropriate.
2722 ;; `org-export-with-buffer-copy' macro prepares that copy.
2723 ;;
2724 ;; File inclusion is taken care of by
2725 ;; `org-export-expand-include-keyword' and
2726 ;; `org-export--prepare-file-contents'. Structure wise, including
2727 ;; a whole Org file in a buffer often makes little sense. For
2728 ;; example, if the file contains a headline and the include keyword
2729 ;; was within an item, the item should contain the headline. That's
2730 ;; why file inclusion should be done before any structure can be
2731 ;; associated to the file, that is before parsing.
2734 "Return a copy of the current buffer.
2735 The copy preserves Org buffer-local variables, visibility and
2736 narrowing."
2742 new-buf))
2745 "Apply BODY in a copy of the current buffer.
2746 The copy preserves local variables, visibility and contents of
2747 the original buffer. Point is at the beginning of the buffer
2748 when BODY is applied."
2757 ;; Kill copy without confirmation.
2763 "Generate a function duplicating BUFFER.
2765 The copy will preserve local variables, visibility, contents and
2766 narrowing of the original buffer. If a region was active in
2767 BUFFER, contents will be narrowed to that region instead.
2769 The resulting function can be evaled at a later time, from
2770 another buffer, effectively cloning the original buffer there.
2772 The function assumes BUFFER's major mode is `org-mode'."
2776 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2777 ;; already in BUFFER.
2779 ;; Buffer local variables.
2789 buffer-file-name
2790 buffer-file-coding-system))
2793 ;; Skip unreadable values, as they cannot be
2794 ;; sent to external process.
2798 local-vars)))))
2800 local-vars)
2801 ;; Whole buffer contents.
2806 ;; Narrowing.
2810 ;; Current position of point.
2812 ;; Overlays with invisible property.
2822 ov-set))))
2824 ov-set)))))
2826 ;;;###autoload
2829 "Transcode current Org buffer into BACKEND code.
2831 If narrowing is active in the current buffer, only transcode its
2832 narrowed part.
2834 If a region is active, transcode that region.
2836 When optional argument SUBTREEP is non-nil, transcode the
2837 sub-tree at point, extracting information from the headline
2838 properties first.
2840 When optional argument VISIBLE-ONLY is non-nil, don't export
2841 contents of hidden elements.
2843 When optional argument BODY-ONLY is non-nil, only return body
2844 code, without surrounding template.
2846 Optional argument EXT-PLIST, when provided, is a property list
2847 with external parameters overriding Org default settings, but
2848 still inferior to file-local settings.
2850 Return code as a string."
2854 ;; Narrow buffer to an appropriate region or subtree for
2855 ;; parsing. If parsing subtree, be sure to remove main headline
2856 ;; too.
2864 ;; Initialize communication channel with original buffer
2865 ;; attributes, unavailable in its copy.
2873 tree)
2874 ;; Update communication channel and get parse tree. Buffer
2875 ;; isn't parsed directly. Instead, a temporary copy is
2876 ;; created, where include keywords, macros are expanded and
2877 ;; code blocks are evaluated.
2879 ;; Run first hook with current back-end as argument.
2882 ;; Update macro templates since #+INCLUDE keywords might have
2883 ;; added some new ones.
2887 ;; Update radio targets since keyword inclusion might have
2888 ;; added some more.
2890 ;; Run last hook with current back-end as argument.
2893 ;; Update communication channel with environment. Also
2894 ;; install user's and developer's filters.
2899 ;; Expand export-specific set of macros: {{{author}}},
2900 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2901 ;; once regular macros have been expanded, since document
2902 ;; keywords may contain one of them.
2908 ;; EMAIL is not a parsed keyword: store it as-is.
2912 ;; Call options filters and update export options. We do not
2913 ;; use `org-export-filter-apply-functions' here since the
2914 ;; arity of such filters is different.
2918 ;; Parse buffer and call parse-tree filter on it.
2923 ;; Now tree is complete, compute its properties and add them
2924 ;; to communication channel.
2928 ;; Eventually transcode TREE. Wrap the resulting string into
2929 ;; a template.
2938 ;; Remove all text properties since they cannot be
2939 ;; retrieved from an external process. Finally call
2940 ;; final-output filter and return result.
2946 info))))))))
2948 ;;;###autoload
2951 "Call `org-export-as' with output to a specified buffer.
2953 BACKEND is the back-end used for transcoding, as a symbol.
2955 BUFFER is the output buffer. If it already exists, it will be
2956 erased first, otherwise, it will be created.
2958 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2959 EXT-PLIST are similar to those used in `org-export-as', which
2960 see.
2962 Depending on `org-export-copy-to-kill-ring', add buffer contents
2963 to kill ring. Return buffer."
2970 ;; Maybe add buffer contents to kill ring.
2973 ;; Return buffer.
2974 buffer))
2976 ;;;###autoload
2979 "Call `org-export-as' with output to a specified file.
2981 BACKEND is the back-end used for transcoding, as a symbol. FILE
2982 is the name of the output file, as a string.
2984 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2985 EXT-PLIST are similar to those used in `org-export-as', which
2986 see.
2988 Depending on `org-export-copy-to-kill-ring', add file contents
2989 to kill ring. Return output file's name."
2990 ;; Checks for FILE permissions. `write-file' would do the same, but
2991 ;; we'd rather avoid needless transcoding of parse tree.
2993 ;; Insert contents to a temporary buffer and write it to FILE.
2999 ;; Maybe add file contents to kill ring.
3002 ;; Return full path.
3003 file)
3005 ;;;###autoload
3007 "Transcode STRING into BACKEND code.
3009 When optional argument BODY-ONLY is non-nil, only return body
3010 code, without preamble nor postamble.
3012 Optional argument EXT-PLIST, when provided, is a property list
3013 with external parameters overriding Org default settings, but
3014 still inferior to file-local settings.
3016 Return code as a string."
3023 "Return output file's name according to buffer specifications.
3025 EXTENSION is a string representing the output file extension,
3026 with the leading dot.
3028 With a non-nil optional argument SUBTREEP, try to determine
3030 of subtree at point.
3032 When optional argument PUB-DIR is set, use it as the publishing
3033 directory.
3035 When optional argument VISIBLE-ONLY is non-nil, don't export
3036 contents of hidden elements.
3038 Return file name as a string."
3041 ;; File name may come from EXPORT_FILE_NAME subtree
3042 ;; property, assuming point is at beginning of said
3043 ;; sub-tree.
3050 ;; File name may be extracted from buffer's associated
3051 ;; file, if any.
3053 ;; Can't determine file name on our own: Ask user.
3057 "Output file: " pub-dir nil nil nil
3061 ;; Build file name. Enforce EXTENSION over whatever user
3062 ;; may have come up with. PUB-DIR, if defined, always has
3063 ;; precedence over any provided path.
3068 extension))
3071 ;; If writing to OUTPUT-FILE would overwrite original file, append
3072 ;; EXTENSION another time to final name.
3075 output-file)))
3078 "Expand every include keyword in buffer.
3079 Optional argument INCLUDED is a list of included file names along
3080 with their line restriction, when appropriate. It is used to
3081 avoid infinite recursion. Optional argument DIR is the current
3082 working directory. It is used to properly resolve relative
3083 paths."
3090 ;; Extract arguments from keyword's value.
3104 ;; Minimal level of included file defaults to the child
3105 ;; level of the current headline, if any, or one. It
3106 ;; only applies is the file is meant to be included as
3107 ;; an Org one.
3115 ;; Remove keyword.
3120 ;; Check if files has already been parsed. Look after
3121 ;; inclusion lines too, as different parts of the same file
3122 ;; can be included too.
3134 ind-str contents ind-str))))
3142 ind-str env contents ind-str))))
3155 "Prepare the contents of FILE for inclusion and return them as a string.
3157 When optional argument LINES is a string specifying a range of
3158 lines, include only those lines.
3160 Optional argument IND, when non-nil, is an integer specifying the
3161 global indentation of returned contents. Since its purpose is to
3162 allow an included file to stay in the same environment it was
3163 created \(i.e. a list item), it doesn't apply past the first
3164 headline encountered.
3166 Optional argument MINLEVEL, when non-nil, is an integer
3167 specifying the level that any top-level headline in the included
3168 file should have."
3184 ;; Remove blank lines at beginning and end of contents. The logic
3185 ;; behind that removal is that blank lines around include keyword
3186 ;; override blank lines in included file.
3195 ;; If IND is set, preserve indentation of include keyword until
3196 ;; the first headline encountered.
3202 ;; Do not move footnote definitions out of column 0.
3208 ;; When MINLEVEL is specified, compute minimal level for headlines
3209 ;; in the file (CUR-MIN), and remove stars to each headline so
3210 ;; that headlines with minimal level have a level of MINLEVEL.
3220 ;; Only change stars, don't bother moving whole
3221 ;; sections.
3228 "Execute every Babel code in the visible part of current buffer."
3229 ;; Get a pristine copy of current buffer so Babel references can be
3230 ;; properly resolved.
3237 \f
3238 ;;; Tools For Back-Ends
3239 ;;
3240 ;; A whole set of tools is available to help build new exporters. Any
3241 ;; function general enough to have its use across many back-ends
3242 ;; should be added here.
3244 ;;;; For Affiliated Keywords
3245 ;;
3246 ;; `org-export-read-attribute' reads a property from a given element
3247 ;; as a plist. It can be used to normalize affiliated keywords'
3248 ;; syntax.
3249 ;;
3250 ;; Since captions can span over multiple lines and accept dual values,
3251 ;; their internal representation is a bit tricky. Therefore,
3252 ;; `org-export-get-caption' transparently returns a given element's
3253 ;; caption as a secondary string.
3256 "Turn ATTRIBUTE property from ELEMENT into a plist.
3258 When optional argument PROPERTY is non-nil, return the value of
3259 that property within attributes.
3263 properties. All values will become strings except the empty
3271 s)
3276 ;; Ignore any string before the first property with `cdr'.
3279 s)
3280 result))))))))
3284 "Return caption from ELEMENT as a secondary string.
3286 When optional argument SHORTP is non-nil, return short caption,
3287 as a secondary string, instead.
3289 Caption lines are separated by a white space."
3297 ;;;; For Derived Back-ends
3298 ;;
3299 ;; `org-export-with-backend' is a function allowing to locally use
3300 ;; another back-end to transcode some object or element. In a derived
3301 ;; back-end, it may be used as a fall-back function once all specific
3302 ;; cases have been treated.
3305 "Call a transcoder from BACK-END on DATA.
3306 CONTENTS, when non-nil, is the transcoded contents of DATA
3307 element, as a string. INFO, when non-nil, is the communication
3308 channel used for export, as a plist.."
3318 ;;;; For Export Snippets
3319 ;;
3320 ;; Every export snippet is transmitted to the back-end. Though, the
3321 ;; latter will only retain one type of export-snippet, ignoring
3322 ;; others, based on the former's target back-end. The function
3323 ;; `org-export-snippet-backend' returns that back-end for a given
3324 ;; export-snippet.
3327 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3328 Translation, with `org-export-snippet-translation-alist', is
3329 applied."
3333 back-end))))
3336 ;;;; For Footnotes
3337 ;;
3338 ;; `org-export-collect-footnote-definitions' is a tool to list
3339 ;; actually used footnotes definitions in the whole parse tree, or in
3340 ;; a headline, in order to add footnote listings throughout the
3341 ;; transcoded data.
3342 ;;
3343 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3344 ;; back-ends, when they need to attach the footnote definition only to
3345 ;; the first occurrence of the corresponding label.
3346 ;;
3347 ;; `org-export-get-footnote-definition' and
3348 ;; `org-export-get-footnote-number' provide easier access to
3349 ;; additional information relative to a footnote reference.
3352 "Return an alist between footnote numbers, labels and definitions.
3354 DATA is the parse tree from which definitions are collected.
3355 INFO is the plist used as a communication channel.
3357 Definitions are sorted by order of references. They either
3358 appear as Org data or as a secondary string for inlined
3359 footnotes. Unreferenced definitions are ignored."
3361 collect-fn ; for byte-compiler.
3365 ;; Collect footnote number, label and definition in DATA.
3373 def)
3374 num-alist)
3375 ;; Also search in definition for nested footnotes.
3378 ;; Don't enter footnote definitions since it will happen
3379 ;; when their first reference is found.
3385 "Non-nil when a footnote reference is the first one for its label.
3387 FOOTNOTE-REFERENCE is the footnote reference being considered.
3388 INFO is the plist used as a communication channel."
3390 ;; Anonymous footnotes are always a first reference.
3392 ;; Otherwise, return the first footnote with the same LABEL and
3393 ;; test if it is equal to FOOTNOTE-REFERENCE.
3403 ;; If FN isn't inlined, be sure to traverse its
3404 ;; definition before resuming search. See
3405 ;; comments in `org-export-get-footnote-number'
3406 ;; for more information.
3410 ;; Don't enter footnote definitions since it will
3411 ;; happen when their first reference is found.
3414 footnote-reference)))))
3417 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3418 INFO is the plist used as a communication channel. If no such
3420 string."
3427 "Return number associated to a footnote.
3429 FOOTNOTE is either a footnote reference or a footnote definition.
3430 INFO is the plist used as a communication channel."
3432 seen-refs
3433 search-ref ; For byte-compiler.
3437 ;; Search footnote references through DATA, filling
3438 ;; SEEN-REFS along the way.
3443 ;; Anonymous footnote match: return number.
3446 ;; Labels match: return number.
3449 ;; Anonymous footnote: it's always a new one.
3450 ;; Also, be sure to return nil from the `cond' so
3451 ;; `first-match' doesn't get us out of the loop.
3453 ;; Label not seen so far: add it so SEEN-REFS.
3454 ;;
3455 ;; Also search for subsequent references in
3456 ;; footnote definition so numbering follows
3457 ;; reading logic. Note that we don't have to care
3458 ;; about inline definitions, since
3459 ;; `org-element-map' already traverses them at the
3460 ;; right time.
3461 ;;
3462 ;; Once again, return nil to stay in the loop.
3467 nil))))
3468 ;; Don't enter footnote definitions since it will
3469 ;; happen when their first reference is found.
3474 ;;;; For Headlines
3475 ;;
3476 ;; `org-export-get-relative-level' is a shortcut to get headline
3477 ;; level, relatively to the lower headline level in the parsed tree.
3478 ;;
3479 ;; `org-export-get-headline-number' returns the section number of an
3480 ;; headline, while `org-export-number-to-roman' allows to convert it
3481 ;; to roman numbers.
3482 ;;
3483 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3484 ;; `org-export-last-sibling-p' are three useful predicates when it
3485 ;; comes to fulfill the `:headline-levels' property.
3486 ;;
3487 ;; `org-export-get-tags', `org-export-get-category' and
3488 ;; `org-export-get-node-property' extract useful information from an
3489 ;; headline or a parent headline. They all handle inheritance.
3490 ;;
3491 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3492 ;; as a secondary string, suitable for table of contents. It falls
3493 ;; back onto default title.
3496 "Return HEADLINE relative level within current parsed tree.
3497 INFO is a plist holding contextual information."
3502 "Non-nil when HEADLINE is considered as low level.
3504 INFO is a plist used as a communication channel.
3506 A low level headlines has a relative level greater than
3507 `:headline-levels' property value.
3509 Return value is the difference between HEADLINE relative level
3510 and the last level being considered as high enough, or nil."
3517 "Return HEADLINE numbering as a list of numbers.
3518 INFO is a plist holding contextual information."
3522 "Return a non-nil value if HEADLINE element should be numbered.
3523 INFO is a plist used as a communication channel."
3529 "Convert integer N into a roman numeral."
3542 res)))
3545 "Return list of tags associated to ELEMENT.
3547 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3548 is a plist used as a communication channel.
3550 Select tags (see `org-export-select-tags') and exclude tags (see
3551 `org-export-exclude-tags') are removed from the list.
3553 When non-nil, optional argument TAGS should be a list of strings.
3554 Any tag belonging to this list will also be removed.
3556 When optional argument INHERITED is non-nil, tags can also be
3557 inherited from parent headlines and FILETAGS keywords."
3563 ;; Build complete list of inherited tags.
3574 ;; Add FILETAGS keywords and return results.
3578 "Return node PROPERTY value for BLOB.
3580 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3581 element or object.
3583 If optional argument INHERITED is non-nil, the value can be
3584 inherited from a parent headline.
3586 Return value is a string or nil."
3598 "Return category for element or object BLOB.
3600 INFO is a plist used as a communication channel.
3602 CATEGORY is automatically inherited from a parent headline, from
3603 #+CATEGORY: keyword or created out of original file name. If all
3607 ;; Almost like `org-export-node-property', but we cannot trust
3608 ;; `plist-member' as every headline has a `:CATEGORY'
3609 ;; property, would it be nil or equal to "???" (which has the
3610 ;; same meaning).
3628 "Return alternative title for HEADLINE, as a secondary string.
3629 INFO is a plist used as a communication channel. If no optional
3630 title is defined, fall-back to the regular title."
3635 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3636 INFO is a plist used as a communication channel."
3641 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3642 INFO is a plist used as a communication channel."
3646 ;;;; For Links
3647 ;;
3648 ;; `org-export-solidify-link-text' turns a string into a safer version
3649 ;; for links, replacing most non-standard characters with hyphens.
3650 ;;
3651 ;; `org-export-get-coderef-format' returns an appropriate format
3652 ;; string for coderefs.
3653 ;;
3654 ;; `org-export-inline-image-p' returns a non-nil value when the link
3655 ;; provided should be considered as an inline image.
3656 ;;
3657 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3658 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3659 ;; returns an appropriate unique identifier when found, or nil.
3660 ;;
3661 ;; `org-export-resolve-id-link' returns the first headline with
3662 ;; specified id or custom-id in parse tree, the path to the external
3663 ;; file with the id or nil when neither was found.
3664 ;;
3665 ;; `org-export-resolve-coderef' associates a reference to a line
3666 ;; number in the element it belongs, or returns the reference itself
3667 ;; when the element isn't numbered.
3670 "Take link text S and make a safe target out of it."
3675 "Return format string for code reference link.
3676 PATH is the link path. DESC is its description."
3684 "Non-nil if LINK object points to an inline image.
3686 Optional argument is a set of RULES defining inline images. It
3687 is an alist where associations have the following shape:
3689 \(TYPE . REGEXP)
3691 Applying a rule means apply REGEXP against LINK's path when its
3692 type is TYPE. The function will return a non-nil value if any of
3693 the provided rules is non-nil. The default rule is
3694 `org-export-default-inline-image-rule'.
3696 This only applies to links without a description."
3707 rules)
3708 ;; Return nil if no rule matched.
3709 nil))))
3712 "Resolve a code reference REF.
3714 INFO is a plist used as a communication channel.
3716 Return associated line number in source code, or REF itself,
3717 depending on src-block or example element's switches."
3724 org-coderef-label-format)))
3728 ;; Element containing REF is found. Resolve it to either
3729 ;; a label or a line number, as needed.
3739 "Return LINK destination.
3741 INFO is a plist holding contextual information.
3743 Return value can be an object, an element, or nil:
3745 - If LINK path matches a target object (i.e. <<path>>) or
3748 - If LINK path exactly matches the name affiliated keyword
3749 \(i.e. #+NAME: path) of an element, return that element.
3751 - If LINK path exactly matches any headline name, return that
3752 element. If more than one headline share that name, priority
3753 will be given to the one with the closest common ancestor, if
3754 any, or the first one in the parse tree otherwise.
3756 - Otherwise, return nil.
3759 significant."
3762 ;; Split PATH at white spaces so matches are space
3763 ;; insensitive.
3767 ;; First try to find a matching "<<path>>" unless user specified
3768 ;; he was looking for a headline (path starts with a *
3769 ;; character).
3776 path)
3777 blob))
3778 info t)))
3779 ;; Then try to find an element with a matching "#+NAME: path"
3780 ;; affiliated keyword.
3783 org-element-all-elements
3788 ;; Last case: link either points to a headline or to
3789 ;; nothingness. Try to find the source, with priority given to
3790 ;; headlines with the closest common ancestor. If such candidate
3791 ;; is found, return it, otherwise return nil.
3795 ;; Return first headline whose `:raw-value' property is
3796 ;; NAME in parse tree DATA, or nil. Statistics cookies
3797 ;; are ignored.
3805 name)
3806 headline))
3808 ;; Search among headlines sharing an ancestor with link, from
3809 ;; closest to farthest.
3817 ;; No match with a common ancestor: try full parse-tree.
3821 "Return headline referenced as LINK destination.
3823 INFO is a plist used as a communication channel.
3825 Return value can be the headline element matched in current parse
3829 ;; First check if id is within the current parse tree.
3834 headline))
3836 ;; Otherwise, look for external files.
3840 "Return radio-target object referenced as LINK destination.
3842 INFO is a plist used as a communication channel.
3844 Return value can be a radio-target object or nil. Assume LINK
3851 radio))
3855 ;;;; For References
3856 ;;
3857 ;; `org-export-get-ordinal' associates a sequence number to any object
3858 ;; or element.
3861 "Return ordinal number of an element or object.
3863 ELEMENT is the element or object considered. INFO is the plist
3864 used as a communication channel.
3866 Optional argument TYPES, when non-nil, is a list of element or
3867 object types, as symbols, that should also be counted in.
3868 Otherwise, only provided element's type is considered.
3870 Optional argument PREDICATE is a function returning a non-nil
3871 value if the current element or object should be counted in. It
3872 accepts two arguments: the element or object being considered and
3873 the plist used as a communication channel. This allows to count
3874 only a certain type of objects (i.e. inline images).
3876 Return value is a list of numbers if ELEMENT is a headline or an
3877 item. It is nil for keywords. It represents the footnote number
3878 for footnote definitions and footnote references. If ELEMENT is
3879 a target, return the same value as if ELEMENT was the closest
3880 table, item or headline containing the target. In any other
3881 case, return the sequence number of ELEMENT among elements or
3882 objects of the same type."
3883 ;; A target keyword, representing an invisible target, never has
3884 ;; a sequence number.
3886 ;; Ordinal of a target object refer to the ordinal of the closest
3887 ;; table, item, or headline containing the object.
3891 when
3895 table))
3896 return parent)))
3898 ;; Special case 1: A headline returns its number as a list.
3900 ;; Special case 2: An item returns its number as a list.
3904 struct
3911 ;; Increment counter until ELEMENT is found again.
3922 ;;;; For Src-Blocks
3923 ;;
3924 ;; `org-export-get-loc' counts number of code lines accumulated in
3925 ;; src-block or example-block elements with a "+n" switch until
3926 ;; a given element, excluded. Note: "-n" switches reset that count.
3927 ;;
3928 ;; `org-export-unravel-code' extracts source code (along with a code
3929 ;; references alist) from an `element-block' or `src-block' type
3930 ;; element.
3931 ;;
3932 ;; `org-export-format-code' applies a formatting function to each line
3933 ;; of code, providing relative line number and code reference when
3934 ;; appropriate. Since it doesn't access the original element from
3935 ;; which the source code is coming, it expects from the code calling
3936 ;; it to know if lines should be numbered and if code references
3937 ;; should appear.
3938 ;;
3939 ;; Eventually, `org-export-format-code-default' is a higher-level
3940 ;; function (it makes use of the two previous functions) which handles
3941 ;; line numbering and code references inclusion, and returns source
3942 ;; code in a format suitable for plain text or verbatim output.
3945 "Return accumulated lines of code up to ELEMENT.
3947 INFO is the plist used as a communication channel.
3949 ELEMENT is excluded from count."
3955 ;; ELEMENT is reached: Quit the loop.
3957 ;; Only count lines from src-block and example-block elements
3958 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3962 ;; Accumulate locs or reset them.
3966 ;; Return nil to stay in the loop.
3967 nil)))
3969 ;; Return value.
3970 loc))
3973 "Clean source code and extract references out of it.
3975 ELEMENT has either a `src-block' an `example-block' type.
3977 Return a cons cell whose CAR is the source code, cleaned from any
3978 reference and protective comma and CDR is an alist between
3979 relative line number (integer) and name of code reference on that
3980 line (string)."
3982 ;; Get code and clean it. Remove blank lines at its
3983 ;; beginning and end.
3989 ;; If appropriate, remove global indentation.
3992 c
3994 ;; Get format used for references.
3997 org-coderef-label-format)))
3998 ;; Build a regexp matching a loc with a reference.
4003 ;; Return value.
4005 ;; Code with references removed.
4011 ;; Ref line: remove ref, and signal its position in REFS.
4015 ;; Reference alist.
4016 refs)))
4019 "Format CODE by applying FUN line-wise and return it.
4021 CODE is a string representing the code to format. FUN is
4022 a function. It must accept three arguments: a line of
4023 code (string), the current line number (integer) or nil and the
4024 reference associated to the current line (string) or nil.
4026 Optional argument NUM-LINES can be an integer representing the
4027 number of code lines accumulated until the current code. Line
4028 numbers passed to FUN will take it into account. If it is nil,
4029 FUN's second argument will always be nil. This number can be
4030 obtained with `org-export-get-loc' function.
4032 Optional argument REF-ALIST can be an alist between relative line
4033 number (i.e. ignoring NUM-LINES) and the name of the code
4034 reference on it. If it is nil, FUN's third argument will always
4035 be nil. It can be obtained through the use of
4036 `org-export-unravel-code' function."
4048 "Return source code from ELEMENT, formatted in a standard way.
4050 ELEMENT is either a `src-block' or `example-block' element. INFO
4051 is a plist used as a communication channel.
4053 This function takes care of line numbering and code references
4054 inclusion. Line numbers, when applicable, appear at the
4055 beginning of the line, separated from the code by two white
4056 spaces. Code references, on the other hand, appear flushed to
4057 the right, separated by six white spaces from the widest line of
4058 code."
4059 ;; Extract code and references.
4066 ;; Handle line numbering.
4075 ;; Prepare references display, if required. Any reference
4076 ;; should start six columns after the widest line of code,
4077 ;; wrapped with parenthesis.
4082 code
4086 number-str
4087 loc
4093 num-start refs)))))
4096 ;;;; For Tables
4097 ;;
4098 ;; `org-export-table-has-special-column-p' and and
4099 ;; `org-export-table-row-is-special-p' are predicates used to look for
4100 ;; meta-information about the table structure.
4101 ;;
4102 ;; `org-table-has-header-p' tells when the rows before the first rule
4103 ;; should be considered as table's header.
4104 ;;
4105 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4106 ;; and `org-export-table-cell-borders' extract information from
4107 ;; a table-cell element.
4108 ;;
4109 ;; `org-export-table-dimensions' gives the number on rows and columns
4110 ;; in the table, ignoring horizontal rules and special columns.
4111 ;; `org-export-table-cell-address', given a table-cell object, returns
4112 ;; the absolute address of a cell. On the other hand,
4113 ;; `org-export-get-table-cell-at' does the contrary.
4114 ;;
4115 ;; `org-export-table-cell-starts-colgroup-p',
4116 ;; `org-export-table-cell-ends-colgroup-p',
4117 ;; `org-export-table-row-starts-rowgroup-p',
4118 ;; `org-export-table-row-ends-rowgroup-p',
4119 ;; `org-export-table-row-starts-header-p' and
4120 ;; `org-export-table-row-ends-header-p' indicate position of current
4121 ;; row or cell within the table.
4124 "Non-nil when TABLE has a special column.
4125 All special columns will be ignored during export."
4126 ;; The table has a special column when every first cell of every row
4127 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4128 ;; "*" "_" and "^". Though, do not consider a first row containing
4129 ;; only empty cells as special.
4145 "Non-nil when TABLE has an header.
4147 INFO is a plist used as a communication channel.
4149 A table has an header when it contains at least two row groups."
4159 info)))
4162 "Non-nil if TABLE-ROW is considered special.
4164 INFO is a plist used as the communication channel.
4166 All special rows will be ignored during export."
4170 ;; A row is special either when...
4172 ;; ... it starts with a field only containing "/",
4174 ;; ... the table contains a special column and the row start
4175 ;; with a marking character among, "^", "_", "$" or "!",
4179 ;; ... it contains only alignment cookies and empty cells.
4185 ;; Since VALUE is a secondary string, the following
4186 ;; checks avoid expanding it with `org-export-data'.
4198 "Return TABLE-ROW's group.
4200 INFO is a plist used as the communication channel.
4202 Return value is the group number, as an integer, or nil special
4203 rows and table rules. Group 1 is also table's header."
4220 "Return TABLE-CELL contents width.
4222 INFO is a plist used as the communication channel.
4224 Return value is the width given by the last width cookie in the
4225 same column as TABLE-CELL, or nil."
4230 cookie-width)
4234 ;; In a special row, try to find a width cookie at COLUMN.
4238 ;; The following checks avoid expanding unnecessarily the
4239 ;; cell with `org-export-data'
4247 ;; Ignore table rules.
4250 ;; Return value.
4251 cookie-width))
4254 "Return TABLE-CELL contents alignment.
4256 INFO is a plist used as the communication channel.
4258 Return alignment as specified by the last alignment cookie in the
4259 same column as TABLE-CELL. If no such cookie is found, a default
4260 alignment value will be deduced from fraction of numbers in the
4261 column (see `org-table-number-fraction' for more information).
4262 Possible values are `left', `right' and `center'."
4269 cookie-align)
4273 ;; In a special row, try to find an alignment cookie at
4274 ;; COLUMN.
4278 ;; Since VALUE is a secondary string, the following checks
4279 ;; avoid useless expansion through `org-export-data'.
4287 ;; Ignore table rules.
4289 ;; In a standard row, check if cell's contents are expressing
4290 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4291 ;; Though, don't bother if an alignment cookie has already
4292 ;; defined cell's alignment.
4297 info)))
4302 ;; Return value. Alignment specified by cookies has precedence
4303 ;; over alignment deduced from cells contents.
4312 "Return TABLE-CELL borders.
4314 INFO is a plist used as a communication channel.
4316 Return value is a list of symbols, or nil. Possible values are:
4317 `top', `bottom', `above', `below', `left' and `right'. Note:
4318 `top' (resp. `bottom') only happen for a cell in the first
4319 row (resp. last row) of the table, ignoring table rules, if any.
4321 Returned borders ignore special rows."
4324 borders)
4325 ;; Top/above border? TABLE-CELL has a border above when a rule
4326 ;; used to demarcate row groups can be found above. Hence,
4327 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4328 ;; another regular row has to be found above that rule.
4337 ;; Look at every row before the current one.
4339 ;; No rule above, or rule found starts the table (ignoring any
4340 ;; special row): TABLE-CELL is at the top of the table.
4343 ;; Bottom/below border? TABLE-CELL has a border below when next
4344 ;; non-regular row below is a rule.
4353 ;; Look at every row after the current one.
4355 ;; No rule below, or rule found ends the table (modulo some
4356 ;; special row): TABLE-CELL is at the bottom of the table.
4359 ;; Right/left borders? They can only be specified by column
4360 ;; groups. Column groups are defined in a row starting with "/".
4361 ;; Also a column groups row only contains "<", "<>", ">" or blank
4362 ;; cells.
4379 ;; There's a left border when previous cell, if
4380 ;; any, ends a group, or current one starts one.
4386 ;; There's a right border when next cell, if any,
4387 ;; starts a group, or current one ends one.
4394 ;; Table rows are read in reverse order so last column groups
4395 ;; row has precedence over any previous one.
4397 ;; Return value.
4398 borders))
4401 "Non-nil when TABLE-CELL is at the beginning of a row group.
4402 INFO is a plist used as a communication channel."
4403 ;; A cell starts a column group either when it is at the beginning
4404 ;; of a row (or after the special column, if any) or when it has
4405 ;; a left border.
4408 table-cell)
4412 "Non-nil when TABLE-CELL is at the end of a row group.
4413 INFO is a plist used as a communication channel."
4414 ;; A cell ends a column group either when it is at the end of a row
4415 ;; or when it has a right border.
4418 table-cell)
4422 "Non-nil when TABLE-ROW is at the beginning of a column group.
4423 INFO is a plist used as a communication channel."
4431 "Non-nil when TABLE-ROW is at the end of a column group.
4432 INFO is a plist used as a communication channel."
4440 "Non-nil when TABLE-ROW is the first table header's row.
4441 INFO is a plist used as a communication channel."
4448 "Non-nil when TABLE-ROW is the last table header's row.
4449 INFO is a plist used as a communication channel."
4456 "Return TABLE dimensions.
4458 INFO is a plist used as a communication channel.
4460 Return value is a CONS like (ROWS . COLUMNS) where
4461 ROWS (resp. COLUMNS) is the number of exportable
4462 rows (resp. columns)."
4464 ;; Set number of rows, and extract first one.
4470 ;; Set number of columns.
4472 ;; Return value.
4476 "Return address of a regular TABLE-CELL object.
4478 TABLE-CELL is the cell considered. INFO is a plist used as
4479 a communication channel.
4481 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4482 zero-based index. Only exportable cells are considered. The
4483 function returns nil for other cells."
4486 ;; Ignore cells in special rows or in special column.
4491 ;; Row number.
4499 ;; Column number.
4507 "Return regular table-cell object at ADDRESS in TABLE.
4509 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4510 zero-based index. TABLE is a table type element. INFO is
4511 a plist used as a communication channel.
4513 If no table-cell, among exportable cells, is found at ADDRESS,
4514 return nil."
4517 ;; Row at (car address) or nil.
4525 'table-cell
4532 ;;;; For Tables Of Contents
4533 ;;
4534 ;; `org-export-collect-headlines' builds a list of all exportable
4535 ;; headline elements, maybe limited to a certain depth. One can then
4536 ;; easily parse it and transcode it.
4537 ;;
4538 ;; Building lists of tables, figures or listings is quite similar.
4539 ;; Once the generic function `org-export-collect-elements' is defined,
4540 ;; `org-export-collect-tables', `org-export-collect-figures' and
4541 ;; `org-export-collect-listings' can be derived from it.
4544 "Collect headlines in order to build a table of contents.
4546 INFO is a plist used as a communication channel.
4548 When optional argument N is an integer, it specifies the depth of
4549 the table of contents. Otherwise, it is set to the value of the
4550 last headline level. See `org-export-headline-levels' for more
4551 information.
4553 Return a list of all exportable headlines as parsed elements.
4554 Footnote sections, if any, will be ignored."
4559 ;; Strip contents from HEADLINE.
4562 info))
4565 "Collect referenceable elements of a determined type.
4567 TYPE can be a symbol or a list of symbols specifying element
4568 types to search. Only elements with a caption are collected.
4570 INFO is a plist used as a communication channel.
4572 When non-nil, optional argument PREDICATE is a function accepting
4573 one argument, an element of type TYPE. It returns a non-nil
4574 value when that element should be collected.
4576 Return a list of all elements found, in order of appearance."
4581 element))
4582 info))
4585 "Build a list of tables.
4586 INFO is a plist used as a communication channel.
4588 Return a list of table elements with a caption."
4592 "Build a list of figures.
4594 INFO is a plist used as a communication channel. PREDICATE is
4595 a function which accepts one argument: a paragraph element and
4596 whose return value is non-nil when that element should be
4597 collected.
4599 A figure is a paragraph type element, with a caption, verifying
4601 a vague concept that may depend on back-end.
4603 Return a list of elements recognized as figures."
4607 "Build a list of src blocks.
4609 INFO is a plist used as a communication channel.
4611 Return a list of src-block elements with a caption."
4615 ;;;; Smart Quotes
4616 ;;
4617 ;; The main function for the smart quotes sub-system is
4618 ;; `org-export-activate-smart-quotes', which replaces every quote in
4619 ;; a given string from the parse tree with its "smart" counterpart.
4620 ;;
4621 ;; Dictionary for smart quotes is stored in
4622 ;; `org-export-smart-quotes-alist'.
4623 ;;
4624 ;; Internally, regexps matching potential smart quotes (checks at
4625 ;; string boundaries are also necessary) are defined in
4626 ;; `org-export-smart-quotes-regexps'.
4663 "Smart quotes translations.
4665 Alist whose CAR is a language string and CDR is an alist with
4666 quote type as key and a plist associating various encodings to
4667 their translation as value.
4669 A quote type can be any symbol among `opening-double-quote',
4670 `closing-double-quote', `opening-single-quote',
4671 `closing-single-quote' and `apostrophe'.
4673 Valid encodings include `:utf-8', `:html', `:latex' and
4674 `:texinfo'.
4680 ;; Possible opening quote at beginning of string.
4682 ;; Possible closing quote at beginning of string.
4684 ;; Possible apostrophe at beginning of string.
4686 ;; Opening single and double quotes.
4688 ;; Closing single and double quotes.
4690 ;; Apostrophe.
4692 ;; Possible opening quote at end of string.
4694 ;; Possible closing quote at end of string.
4696 ;; Possible apostrophe at end of string.
4698 "List of regexps matching a quote or an apostrophe.
4704 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4705 `:utf-8'. INFO is a plist used as a communication channel.
4707 The function has to retrieve information about string
4708 surroundings in parse tree. It can only happen with an
4709 unmodified string. Thus, if S has already been through another
4710 process, a non-nil ORIGINAL optional argument will provide that
4711 original string.
4713 Return the new string."
4716 ;; Try to be flexible when computing number of blanks
4717 ;; before object. The previous object may be a string
4718 ;; introduced by the back-end and not completely parsed.
4721 ;; A string with missing `:post-blank'
4722 ;; property.
4726 ;; Fallback value.
4731 ;; Return smart quote associated to a give quote Q, as
4732 ;; a string. TYPE is a symbol among `open', `close' and
4733 ;; `apostrophe'.
4743 org-export-smart-quotes-alist))))
4744 encoding)
4745 q)))))
4747 ;; Only a quote: no regexp can match. We have to check both
4748 ;; sides and decide what to do.
4756 ;; 1. Replace quote character at the beginning of S.
4758 ;; Apostrophe?
4764 ;; Closing quote?
4770 ;; Opening quote?
4776 ;; 2. Replace quotes in the middle of the string.
4778 ;; Opening quotes.
4784 ;; Closing quotes.
4790 ;; Apostrophes.
4795 ;; 3. Replace quote character at the end of S.
4797 ;; Apostrophe?
4802 ;; Closing quote?
4808 ;; Opening quote?
4813 ;; Return string with smart quotes.
4814 s))))
4816 ;;;; Topology
4817 ;;
4818 ;; Here are various functions to retrieve information about the
4819 ;; neighbourhood of a given element or object. Neighbours of interest
4820 ;; are direct parent (`org-export-get-parent'), parent headline
4821 ;; (`org-export-get-parent-headline'), first element containing an
4822 ;; object, (`org-export-get-parent-element'), parent table
4823 ;; (`org-export-get-parent-table'), previous element or object
4824 ;; (`org-export-get-previous-element') and next element or object
4825 ;; (`org-export-get-next-element').
4826 ;;
4827 ;; `org-export-get-genealogy' returns the full genealogy of a given
4828 ;; element or object, from closest parent to full parse tree.
4831 "Return BLOB parent or nil.
4832 BLOB is the element or object considered."
4836 "Return full genealogy relative to a given element or object.
4838 BLOB is the element or object being considered.
4840 Ancestors are returned from closest to farthest, the last one
4841 being the full parse tree."
4848 "Return BLOB parent headline or nil.
4849 BLOB is the element or object being considered."
4853 parent))
4856 "Return first element containing OBJECT or nil.
4857 OBJECT is the object to consider."
4861 parent))
4864 "Return OBJECT parent table or nil.
4865 OBJECT is either a `table-cell' or `table-element' type object."
4869 parent))
4872 "Return previous element or object.
4874 BLOB is an element or object. INFO is a plist used as
4875 a communication channel. Return previous exportable element or
4876 object, a string, or nil.
4878 When optional argument N is a positive integer, return a list
4879 containing up to N siblings before BLOB, from farthest to
4880 closest. With any other non-nil value, return a list containing
4881 all of them."
4883 ;; An object can belong to the contents of its parent or
4884 ;; to a secondary string. We check the latter option
4885 ;; first.
4888 org-element-all-elements))
4892 org-element-secondary-value-alist))
4893 parent)))
4896 prev)
4905 prev)))
4908 "Return next element or object.
4910 BLOB is an element or object. INFO is a plist used as
4911 a communication channel. Return next exportable element or
4912 object, a string, or nil.
4914 When optional argument N is a positive integer, return a list
4915 containing up to N siblings after BLOB, from closest to farthest.
4916 With any other non-nil value, return a list containing all of
4917 them."
4919 ;; An object can belong to the contents of its parent or to
4920 ;; a secondary string. We check the latter option first.
4923 org-element-all-objects))
4927 org-element-secondary-value-alist))
4928 parent)))
4931 next)
4939 siblings)
4943 ;;;; Translation
4944 ;;
4945 ;; `org-export-translate' translates a string according to language
4946 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4947 ;; variable and a specified charset. `org-export-dictionary' contains
4948 ;; the dictionary used for the translation.
5070 "Dictionary for export engine.
5072 Alist whose CAR is the string to translate and CDR is an alist
5073 whose CAR is the language string and CDR is a plist whose
5074 properties are possible charsets and values translated terms.
5076 It is used as a database for `org-export-translate'. Since this
5077 function returns the string as-is if no translation was found,
5078 the variable only needs to record values different from the
5082 "Translate string S according to language specification.
5084 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5085 and `:utf-8'. INFO is a plist used as a communication channel.
5087 Translation depends on `:language' property. Return the
5088 translated string. If no translation is found, try to fall back
5089 to `:default' encoding. If it fails, return S."
5095 s)))
5098 \f
5099 ;;; Asynchronous Export
5100 ;;
5101 ;; `org-export-async-start' is the entry point for asynchronous
5102 ;; export. It recreates current buffer (including visibility,
5103 ;; narrowing and visited file) in an external Emacs process, and
5104 ;; evaluates a command there. It then applies a function on the
5105 ;; returned results in the current process.
5106 ;;
5107 ;; Asynchronously generated results are never displayed directly.
5108 ;; Instead, they are stored in `org-export-stack-contents'. They can
5109 ;; then be retrieved by calling `org-export-stack'.
5110 ;;
5111 ;; Export Stack is viewed through a dedicated major mode
5112 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5113 ;;`org-export-stack-delete', `org-export-stack-view' and
5114 ;;`org-export-stack-clear'.
5115 ;;
5116 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5117 ;; It should used whenever `org-export-async-start' is called.
5120 "Call function FUN on the results returned by BODY evaluation.
5122 BODY evaluation happens in an asynchronous process, from a buffer
5123 which is an exact copy of the current one.
5125 Use `org-export-add-to-stack' in FUN in order to register results
5126 in the stack. Examples for, respectively a temporary buffer and
5127 a file are:
5129 \(org-export-async-start
5130 \(lambda (output)
5132 \(erase-buffer)
5133 \(insert output)
5134 \(goto-char (point-min))
5135 \(org-export-add-to-stack (current-buffer) 'backend)))
5136 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5138 and
5140 \(org-export-async-start
5141 \(lambda (f) (org-export-add-to-stack f 'backend))
5142 `(expand-file-name
5143 \(org-export-to-file
5144 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5147 ;; Write the full sexp evaluating BODY in a copy of the current
5148 ;; buffer to a temporary file, as it may be too long for program
5149 ;; args in `start-process'.
5156 "%S"
5159 ;; Ignore `kill-emacs-hook' and code evaluation
5160 ;; queries from Babel as we need a truly
5161 ;; non-interactive process.
5163 org-babel-confirm-evaluate-answer-no t)
5164 ;; Initialize export framework in external process.
5166 ;; Re-create current buffer there.
5169 ;; Sexp to evaluate in the buffer.
5171 ;; Start external process.
5174 (,process
5179 "-l" org-export-async-init-file
5181 ;; Register running process in stack.
5183 ;; Set-up sentinel in order to catch results.
5185 ,process
5209 "Add a new result to export stack if not present already.
5211 SOURCE is a buffer or a file name containing export results.
5212 BACKEND is a symbol representing export back-end used to generate
5213 it.
5215 Entries already pointing to SOURCE and unavailable entries are
5216 removed beforehand. Return the new stack."
5222 "Menu for asynchronous export results and running processes."
5232 "Return source from export results at point in stack."
5239 source
5240 ;; SOURCE is not consistent with current line. The stack
5241 ;; view is outdated.
5245 "Remove all entries from export stack."
5250 "Refresh the asynchronous export stack.
5251 DUMMY is ignored. Unavailable sources are removed from the list.
5252 Return the new stack."
5262 ;; Back-end.
5264 ;; Age.
5267 ;; Compute age of the results.
5269 "%4h:%.2m "
5271 ;; Source.
5276 ;; Clear stack from exited processes, dead buffers or
5277 ;; non-existent files.
5289 "Remove export results at point from stack.
5290 If optional argument SOURCE is non-nil, remove it instead."
5295 org-export-stack-contents))))
5298 "View export results at point in stack.
5299 With an optional prefix argument IN-EMACS, force viewing files
5300 within Emacs."
5314 (define-key km "p" 'previous-line)
5315 (define-key km "\C-p" 'previous-line)
5316 (define-key km "\C-?" 'previous-line)
5317 (define-key km [up] 'previous-line)
5318 (define-key km "C" 'org-export-stack-clear)
5319 (define-key km "v" 'org-export-stack-view)
5320 (define-key km (kbd "RET") 'org-export-stack-view)
5321 (define-key km "d" 'org-export-stack-remove)
5322 km)
5323 "Keymap for Org Export Stack.")
5325 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5326 "Mode for displaying asynchronous export stack.
5329 stack.
5331 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5332 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5333 stack completely.
5335 Removing entries in an Org Export Stack buffer doesn't affect
5336 files or buffers, only the display.
5339 (abbrev-mode 0)
5340 (auto-fill-mode 0)
5341 (setq buffer-read-only t
5342 buffer-undo-list t
5343 truncate-lines t
5344 header-line-format
5345 '(:eval
5346 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5347 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5348 (set (make-local-variable 'revert-buffer-function)
5349 'org-export-stack-refresh))
5352 \f
5353 ;;; The Dispatcher
5354 ;;
5355 ;; `org-export-dispatch' is the standard interactive way to start an
5356 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5357 ;; for its interface, which, in turn, delegates response to key
5358 ;; pressed to `org-export--dispatch-action'.
5360 ;;;###autoload
5361 (defun org-export-dispatch (&optional arg)
5362 "Export dispatcher for Org mode.
5364 It provides an access to common export related tasks in a buffer.
5365 Its interface comes in two flavours: standard and expert.
5367 While both share the same set of bindings, only the former
5368 displays the valid keys associations in a dedicated buffer.
5369 Scrolling (resp. line-wise motion) in this buffer is done with
5370 SPC and DEL (resp. C-n and C-p) keys.
5372 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5373 flavour or the other.
5376 of options used back then, on the current buffer.
5378 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5379 (interactive "P")
5380 (let* ((input
5381 (cond ((equal arg '(16)) '(stack))
5382 ((and arg org-export-dispatch-last-action))
5383 (t (save-window-excursion
5384 (unwind-protect
5385 (progn
5386 ;; Remember where we are
5387 (move-marker org-export-dispatch-last-position
5388 (point)
5389 (org-base-buffer (current-buffer)))
5390 ;; Get and store an export command
5391 (setq org-export-dispatch-last-action
5392 (org-export--dispatch-ui
5393 (list org-export-initial-scope
5394 (and org-export-in-background 'async))
5395 nil
5396 org-export-dispatch-use-expert-ui)))
5397 (and (get-buffer "*Org Export Dispatcher*")
5398 (kill-buffer "*Org Export Dispatcher*")))))))
5399 (action (car input))
5400 (optns (cdr input)))
5401 (unless (memq 'subtree optns)
5402 (move-marker org-export-dispatch-last-position nil))
5403 (case action
5404 ;; First handle special hard-coded actions.
5405 (stack (org-export-stack))
5406 (publish-current-file
5407 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5408 (publish-current-project
5409 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5410 (publish-choose-project
5411 (org-publish (assoc (org-icompleting-read
5412 "Publish project: "
5413 org-publish-project-alist nil t)
5414 org-publish-project-alist)
5415 (memq 'force optns)
5416 (memq 'async optns)))
5417 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5418 (otherwise
5419 (save-excursion
5420 (when arg
5421 ;; Repeating command, maybe move cursor
5422 ;; to restore subtree context
5423 (if (eq (marker-buffer org-export-dispatch-last-position)
5424 (org-base-buffer (current-buffer)))
5425 (goto-char org-export-dispatch-last-position)
5426 ;; We are in a differnet buffer, forget position
5427 (move-marker org-export-dispatch-last-position nil)))
5428 (funcall action
5429 ;; Return a symbol instead of a list to ease
5430 ;; asynchronous export macro use.
5431 (and (memq 'async optns) t)
5432 (and (memq 'subtree optns) t)
5433 (and (memq 'visible optns) t)
5434 (and (memq 'body optns) t)))))))
5436 (defun org-export--dispatch-ui (options first-key expertp)
5437 "Handle interface for `org-export-dispatch'.
5439 OPTIONS is a list containing current interactive options set for
5440 export. It can contain any of the following symbols:
5441 `body' toggles a body-only export
5442 `subtree' restricts export to current subtree
5443 `visible' restricts export to visible part of buffer.
5444 `force' force publishing files.
5445 `async' use asynchronous export process
5447 FIRST-KEY is the key pressed to select the first level menu. It
5448 is nil when this menu hasn't been selected yet.
5450 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5451 buffer is provided, but indications about currently active
5452 options are given in the prompt. Moreover, \[?] allows to switch
5453 back to standard interface."
5454 (let* ((fontify-key
5455 (lambda (key &optional access-key)
5456 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5457 ;; non-nil is the required first-level key to activate
5458 ;; KEY. When its value is t, activate KEY independently
5459 ;; on the first key, if any. A nil value means KEY will
5460 ;; only be activated at first level.
5461 (if (or (eq access-key t) (eq access-key first-key))
5462 (org-propertize key 'face 'org-warning)
5463 key)))
5464 (fontify-value
5465 (lambda (value)
5466 ;; Fontify VALUE string.
5467 (org-propertize value 'face 'font-lock-variable-name-face)))
5468 ;; Prepare menu entries by extracting them from
5469 ;; `org-export-registered-backends', and sorting them by
5470 ;; access key and by ordinal, if any.
5471 (backends
5472 (sort
5473 (sort
5474 (delq nil
5475 (mapcar
5476 (lambda (b)
5477 (let ((name (car b)))
5478 (catch 'ignored
5479 ;; Ignore any back-end belonging to
5480 ;; `org-export-invisible-backends' or derived
5481 ;; from one of them.
5482 (dolist (ignored org-export-invisible-backends)
5483 (when (org-export-derived-backend-p name ignored)
5484 (throw 'ignored nil)))
5485 (org-export-backend-menu name))))
5486 org-export-registered-backends))
5487 (lambda (a b)
5488 (let ((key-a (nth 1 a))
5489 (key-b (nth 1 b)))
5490 (cond ((and (numberp key-a) (numberp key-b))
5491 (< key-a key-b))
5492 ((numberp key-b) t)))))
5493 (lambda (a b) (< (car a) (car b)))))
5494 ;; Compute a list of allowed keys based on the first key
5495 ;; pressed, if any. Some keys (?^B, ?^V, ?^S, ?^F, ?^A
5496 ;; and ?q) are always available.
5497 (allowed-keys
5498 (nconc (list 2 22 19 6 1)
5499 (if (not first-key) (org-uniquify (mapcar 'car backends))
5500 (let (sub-menu)
5501 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5502 (when (eq (car backend) first-key)
5503 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5504 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5505 ((not first-key) (list ?P)))
5506 (list ?&)
5507 (when expertp (list ??))
5508 (list ?q)))
5509 ;; Build the help menu for standard UI.
5510 (help
5511 (unless expertp
5512 (concat
5513 ;; Options are hard-coded.
5514 (format "Options
5515 [%s] Body only: %s [%s] Visible only: %s
5516 [%s] Export scope: %s [%s] Force publishing: %s
5518 (funcall fontify-key "C-b" t)
5519 (funcall fontify-value
5520 (if (memq 'body options) "On " "Off"))
5521 (funcall fontify-key "C-v" t)
5522 (funcall fontify-value
5523 (if (memq 'visible options) "On " "Off"))
5524 (funcall fontify-key "C-s" t)
5525 (funcall fontify-value
5526 (if (memq 'subtree options) "Subtree" "Buffer "))
5527 (funcall fontify-key "C-f" t)
5528 (funcall fontify-value
5529 (if (memq 'force options) "On " "Off"))
5530 (funcall fontify-key "C-a" t)
5531 (funcall fontify-value
5532 (if (memq 'async options) "On " "Off")))
5533 ;; Display registered back-end entries. When a key
5534 ;; appears for the second time, do not create another
5535 ;; entry, but append its sub-menu to existing menu.
5536 (let (last-key)
5537 (mapconcat
5538 (lambda (entry)
5539 (let ((top-key (car entry)))
5540 (concat
5541 (unless (eq top-key last-key)
5542 (setq last-key top-key)
5544 (funcall fontify-key (char-to-string top-key))
5545 (nth 1 entry)))
5546 (let ((sub-menu (nth 2 entry)))
5547 (unless (functionp sub-menu)
5548 ;; Split sub-menu into two columns.
5549 (let ((index -1))
5550 (concat
5551 (mapconcat
5552 (lambda (sub-entry)
5553 (incf index)
5554 (format
5555 (if (zerop (mod index 2)) " [%s] %-26s"
5557 (funcall fontify-key
5558 (char-to-string (car sub-entry))
5559 top-key)
5560 (nth 1 sub-entry)))
5561 sub-menu "")
5563 backends ""))
5564 ;; Publishing menu is hard-coded.
5566 [%s] Current file [%s] Current project
5568 (funcall fontify-key "P")
5569 (funcall fontify-key "f" ?P)
5570 (funcall fontify-key "p" ?P)
5571 (funcall fontify-key "x" ?P)
5572 (funcall fontify-key "a" ?P))
5574 (format "\[%s] %s"
5575 (funcall fontify-key "q" t)
5576 (if first-key "Main menu" "Exit")))))
5577 ;; Build prompts for both standard and expert UI.
5578 (standard-prompt (unless expertp "Export command: "))
5579 (expert-prompt
5580 (when expertp
5581 (format
5582 "Export command (C-%s%s%s%s%s) [%s]: "
5583 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5584 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5585 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5586 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5587 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5588 (mapconcat (lambda (k)
5589 ;; Strip control characters.
5590 (unless (< k 27) (char-to-string k)))
5591 allowed-keys "")))))
5592 ;; With expert UI, just read key with a fancy prompt. In standard
5593 ;; UI, display an intrusive help buffer.
5594 (if expertp
5595 (org-export--dispatch-action
5596 expert-prompt allowed-keys backends options first-key expertp)
5597 ;; At first call, create frame layout in order to display menu.
5598 (unless (get-buffer "*Org Export Dispatcher*")
5599 (delete-other-windows)
5600 (org-switch-to-buffer-other-window
5601 (get-buffer-create "*Org Export Dispatcher*"))
5602 (setq cursor-type nil
5603 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
5604 ;; Make sure that invisible cursor will not highlight square
5605 ;; brackets.
5606 (set-syntax-table (copy-syntax-table))
5607 (modify-syntax-entry ?\[ "w"))
5608 ;; At this point, the buffer containing the menu exists and is
5609 ;; visible in the current window. So, refresh it.
5610 (with-current-buffer "*Org Export Dispatcher*"
5611 ;; Refresh help. Maintain display continuity by re-visiting
5612 ;; previous window position.
5613 (let ((pos (window-start)))
5614 (erase-buffer)
5615 (insert help)
5616 (set-window-start nil pos)))
5617 (org-fit-window-to-buffer)
5618 (org-export--dispatch-action
5619 standard-prompt allowed-keys backends options first-key expertp))))
5621 (defun org-export--dispatch-action
5622 (prompt allowed-keys backends options first-key expertp)
5623 "Read a character from command input and act accordingly.
5625 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5626 a list of characters available at a given step in the process.
5627 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5628 EXPERTP are the same as defined in `org-export--dispatch-ui',
5629 which see.
5631 Toggle export options when required. Otherwise, return value is
5632 a list with action as CAR and a list of interactive export
5633 options as CDR."
5634 (let (key)
5635 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
5636 ;; C-p, SPC, DEL).
5637 (while (and (setq key (read-char-exclusive prompt))
5638 (not expertp)
5639 (memq key '(14 16 ?\s ?\d)))
5640 (case key
5641 (14 (if (not (pos-visible-in-window-p (point-max)))
5642 (ignore-errors (scroll-up-line))
5643 (message "End of buffer")
5644 (sit-for 1)))
5645 (16 (if (not (pos-visible-in-window-p (point-min)))
5646 (ignore-errors (scroll-down-line))
5647 (message "Beginning of buffer")
5648 (sit-for 1)))
5649 (?\s (if (not (pos-visible-in-window-p (point-max)))
5650 (scroll-up nil)
5651 (message "End of buffer")
5652 (sit-for 1)))
5653 (?\d (if (not (pos-visible-in-window-p (point-min)))
5654 (scroll-down nil)
5655 (message "Beginning of buffer")
5656 (sit-for 1)))))
5657 (cond
5658 ;; Ignore undefined associations.
5659 ((not (memq key allowed-keys))
5660 (ding)
5661 (unless expertp (message "Invalid key") (sit-for 1))
5662 (org-export--dispatch-ui options first-key expertp))
5663 ;; q key at first level aborts export. At second
5664 ;; level, cancel first key instead.
5665 ((eq key ?q) (if (not first-key) (error "Export aborted")
5666 (org-export--dispatch-ui options nil expertp)))
5667 ;; Help key: Switch back to standard interface if
5668 ;; expert UI was active.
5669 ((eq key ??) (org-export--dispatch-ui options first-key nil))
5670 ;; Switch to asynchronous export stack.
5671 ((eq key ?&) '(stack))
5672 ;; Toggle export options
5673 ;; C-b (2) C-v (22) C-s (19) C-f (6) C-a (1)
5674 ((memq key '(2 22 19 6 1))
5675 (org-export--dispatch-ui
5676 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
5677 (6 'force) (1 'async))))
5678 (if (memq option options) (remq option options)
5679 (cons option options)))
5680 first-key expertp))
5681 ;; Action selected: Send key and options back to
5682 ;; `org-export-dispatch'.
5683 ((or first-key (functionp (nth 2 (assq key backends))))
5684 (cons (cond
5685 ((not first-key) (nth 2 (assq key backends)))
5686 ;; Publishing actions are hard-coded. Send a special
5687 ;; signal to `org-export-dispatch'.
5688 ((eq first-key ?P)
5689 (case key
5690 (?f 'publish-current-file)
5691 (?p 'publish-current-project)
5692 (?x 'publish-choose-project)
5693 (?a 'publish-all)))
5694 ;; Return first action associated to FIRST-KEY + KEY
5695 ;; path. Indeed, derived backends can share the same
5696 ;; FIRST-KEY.
5697 (t (catch 'found
5698 (mapc (lambda (backend)
5699 (let ((match (assq key (nth 2 backend))))
5700 (when match (throw 'found (nth 2 match)))))
5701 (member (assq first-key backends) backends)))))
5702 options))
5703 ;; Otherwise, enter sub-menu.
5704 (t (org-export--dispatch-ui options key expertp)))))
5706 ;;; Miscellaneous
5708 (defun org-export--copy-to-kill-ring-p ()
5709 "Should we copy the export buffer to the kill ring?
5710 See also `org-export-copy-to-kill-ring'."
5711 (if (eq org-export-copy-to-kill-ring 'if-interactive)
5712 (not (or executing-kbd-macro noninteractive))
5713 (eq org-export-copy-to-kill-ring t)))
5715 (provide 'ox)
5717 ;; Local variables:
5718 ;; generated-autoload-file: "org-loaddefs.el"
5719 ;; End:
5721 ;;; ox.el ends here