| blob | 31b1907c0393a7cd6ea07bf4248882603e9272e8 |
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 the 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
238 "Alist between filters properties and initial values.
240 The key of each association is a property name accessible through
241 the communication channel. Its value is a configurable global
242 variable defining initial filters.
244 This list is meant to install user specified filters. Back-end
245 developers may install their own filters using
246 `org-export-define-backend'. Filters defined there will always
247 be prepended to the current list, so they always get applied
256 "Default rule for link matching an inline image.
257 This rule applies to links with no description. By default, it
258 will be considered as an inline image if it targets a local file
261 See `org-export-inline-image-p' for more information about
265 "Non-nil means asynchronous export process should leave data behind.
269 located in `temporary-file-directory'.
271 When non-nil, it will also set `debug-on-error' to a non-nil
275 "Record asynchronously generated export results and processes.
276 This is an alist: its CAR is the source of the
277 result (destination file or buffer for a finished process,
278 original buffer for a running one) and its CDR is a list
279 containing the back-end used, as a symbol, and either a process
280 or the time at which it finished. It is used to build the menu
284 "List of backends currently available in the exporter.
286 A backend is stored as a list where CAR is its name, as a symbol,
287 and CDR is a plist with the following properties:
288 `:filters-alist', `:menu-entry', `:options-alist' and
289 `:translate-alist'.
291 This variable is set with `org-export-define-backend' and
295 "Last command called from the dispatcher.
296 The value should be a list. Its CAR is the action, as a symbol,
300 "The position where the last export command was created using the dispatcher.
301 This marker will be used with `C-u C-c C-e' to make sure export repetition
304 \f
305 ;;; User-configurable Variables
306 ;;
307 ;; Configuration for the masses.
308 ;;
309 ;; They should never be accessed directly, as their value is to be
310 ;; stored in a property list (cf. `org-export-options-alist').
311 ;; Back-ends will read their value from there instead.
314 "Options for exporting Org mode files."
319 "General options for export engine."
324 "Whether sub-trees with the ARCHIVE tag should be exported.
326 This can have three different values:
327 nil Do not export, pretend this tree is not present.
328 t Do export the entire tree.
329 `headline' Only export the headline, but skip the tree below it.
331 This option can also be set with the OPTIONS keyword,
340 "Non-nil means insert author name into the exported file.
341 This option can also be set with the OPTIONS keyword,
347 "Non-nil means export CLOCK keywords.
348 This option can also be set with the OPTIONS keyword,
354 "Non-nil means the postamble should contain a creator sentence.
356 The sentence can be set in `org-export-creator-string' and
359 If the value is `comment' insert it as a comment."
367 "Non-nil means insert date in the exported document.
368 This option can also be set with the OPTIONS keyword,
374 "Time-stamp format string to use for DATE keyword.
376 The format string, when specified, only applies if date consists
377 in a single time-stamp. Otherwise its value will be ignored.
379 See `format-time-string' for details on how to build this
380 string."
388 emacs-version
390 "Information about the creator of the document.
391 This option can also be set on with the CREATOR keyword."
396 "Non-nil means export contents of standard drawers.
398 When t, all drawers are exported. This may also be a list of
399 drawer names to export. If that list starts with `not', only
400 drawers with such names will be ignored.
402 This variable doesn't apply to properties drawers.
404 This option can also be set with the OPTIONS keyword,
417 :inline t
421 "Non-nil means insert author email into the exported file.
422 This option can also be set with the OPTIONS keyword,
428 "Non-nil means interpret *word*, /word/, _word_ and +word+.
430 If the export target supports emphasizing text, the word will be
431 typeset in bold, italic, with an underline or strike-through,
432 respectively.
434 This option can also be set with the OPTIONS keyword,
440 "Tags that exclude a tree from export.
442 All trees carrying any of these tags will be excluded from
443 export. This is without condition, so even subtrees inside that
444 carry one of the `org-export-select-tags' will be removed.
446 This option can also be set with the EXCLUDE_TAGS keyword."
453 This can be used to have pre-formatted text, fragments of code
454 etc. For example:
455 : ;; Some Lisp examples
456 : (while (defc cnt)
457 : (ding))
458 will be looking just like this in also HTML. See also the QUOTE
459 keyword. Not all export backends support this.
461 This option can also be set with the OPTIONS keyword,
467 "Non-nil means Org footnotes should be exported.
468 This option can also be set with the OPTIONS keyword,
474 "Non-nil means process LaTeX environments and fragments.
476 This option can also be set with the OPTIONS line,
479 nil Ignore math snippets.
480 `verbatim' Keep everything in verbatim.
481 t Allow export of math snippets."
491 "The last level which is still exported as a headline.
493 Inferior levels will usually produce itemize or enumerate lists
494 when exported, but back-end behaviour may differ.
496 This option can also be set with the OPTIONS keyword,
502 "The default language for export and clocktable translations, as a string.
503 This may have an association in
504 `org-clock-clocktable-language-setup'. This option can also be
505 set with the LANGUAGE keyword."
510 "Non-nil means preserve all line breaks when exporting.
511 This option can also be set with the OPTIONS keyword,
517 "Non-nil means interpret entities when exporting.
520 Å.
522 For a list of supported names, see the constant `org-entities'
523 and the user option `org-entities-user'.
525 This option can also be set with the OPTIONS keyword,
531 "Non-nil means inlinetasks should be exported.
532 This option can also be set with the OPTIONS keyword,
540 "Non-nil means include planning info in export.
542 Planning info is the line containing either SCHEDULED:,
543 DEADLINE:, CLOSED: time-stamps, or a combination of them.
545 This option can also be set with the OPTIONS keyword,
553 "Non-nil means include priority cookies in export.
554 This option can also be set with the OPTIONS keyword,
560 "Non-nil means add section numbers to headlines when exporting.
562 When set to an integer n, numbering will only happen for
563 headlines whose relative level is higher or equal to n.
565 This option can also be set with the OPTIONS keyword,
571 "Tags that select a tree for export.
573 If any such tag is found in a buffer, all trees that do not carry
574 one of these tags will be ignored during export. Inside trees
575 that are selected like this, you can still deselect a subtree by
576 tagging it with one of the `org-export-exclude-tags'.
578 This option can also be set with the SELECT_TAGS keyword."
583 "Non-nil means activate smart quotes during export.
584 This option can also be set with the OPTIONS keyword,
587 When setting this to non-nil, you need to take care of
588 using the correct Babel package when exporting to LaTeX.
589 E.g., you can load Babel for french like this:
600 When this option is turned on, these strings will be exported as:
602 Org HTML LaTeX UTF-8
603 -----+----------+--------+-------
605 -- – -- –
606 --- — --- —
609 This option can also be set with the OPTIONS keyword,
615 "Non-nil means include statistics cookies in export.
616 This option can also be set with the OPTIONS keyword,
626 When this option is turned on, you can use TeX-like syntax for
628 will be considered as a single item - so grouping with {} is
629 normally not needed. For example, the following things will be
630 parsed as single sub- or superscripts.
632 10^24 or 10^tau several digits will be considered 1 item.
633 10^-12 or 10^-tau a leading sign with digits or a word
634 x^2-y^3 will be read as x^2 - y^3, because items are
635 terminated by almost any nonword/nondigit char.
636 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
638 Still, ambiguity is possible - so when in doubt use {} to enclose
639 the sub/superscript. If you set this variable to the symbol
640 `{}', the braces are *required* in order to trigger
641 interpretations as sub/superscript. This can be helpful in
644 This option can also be set with the OPTIONS keyword,
653 "Non-nil means create a table of contents in exported files.
655 The TOC contains headlines with levels up
656 to`org-export-headline-levels'. When an integer, include levels
657 up to N in the toc, this may then be different from
658 `org-export-headline-levels', but it will not be allowed to be
659 larger than the number of headline levels. When nil, no table of
660 contents is made.
662 This option can also be set with the OPTIONS keyword,
672 For example:
674 | Name | Address | Birthday |
675 |-------------+----------+-----------|
676 | Arthur Dent | England | 29.2.2100 |
678 This option can also be set with the OPTIONS keyword,
684 "If nil, do not export tags, just remove them from headlines.
686 If this is the symbol `not-in-toc', tags will be removed from
687 table of contents entries, but still be shown in the headlines of
688 the document.
690 This option can also be set with the OPTIONS keyword,
699 "Non-nil means include TODO items for export.
701 This may have the following values:
702 t include tasks independent of state.
703 `todo' include only tasks that are not yet done.
704 `done' include only tasks that are already done.
705 nil ignore all tasks.
706 list of keywords include tasks with these keywords.
708 This option can also be set with the OPTIONS keyword,
720 "Non-nil means insert a time stamp into the exported file.
721 The time stamp shows when the file was created. This option can
727 "Non nil means allow timestamps in export.
729 It can be set to `active', `inactive', t or nil, in order to
730 export, respectively, only active timestamps, only inactive ones,
731 all of them or none.
733 This option can also be set with the OPTIONS keyword, e.g.
743 "Non-nil means include TODO keywords in export.
744 When nil, remove all these keywords from the export. This option
750 "Non-nil means BIND keywords can define local variable values.
751 This is a potential security risk, which is why the default value
752 is nil. You can also allow them through local buffer variables."
759 "Alist between export snippets back-ends and exporter back-ends.
761 This variable allows to provide shortcuts for export snippets.
765 HTML code while every other back-end will ignore it."
774 "Coding system for the exported file."
781 "Should we push exported content to the kill ring?"
790 "The initial scope when exporting with `org-export-dispatch'.
791 This variable can be either set to `buffer' or `subtree'."
798 "Non-nil means show buffer after exporting to temp buffer.
799 When Org exports to a file, the buffer visiting that file is ever
800 shown, but remains buried. However, when exporting to
801 a temporary buffer, that buffer is popped up in a second window.
802 When this variable is nil, the buffer remains buried also in
803 these cases."
808 "Non-nil means export and publishing commands will run in background.
809 Results from an asynchronous export are never displayed
817 "File used to initialize external export process.
818 Value must be an absolute file name. It defaults to user's
819 initialization file. Though, a specific configuration makes the
820 process faster and the export more portable."
827 "List of back-ends that shouldn't appear in the dispatcher.
829 Any back-end belonging to this list or derived from a back-end
830 belonging to it will not appear in the dispatcher menu.
832 Indeed, Org may require some export back-ends without notice. If
833 these modules are never to be used interactively, adding them
834 here will avoid cluttering the dispatcher menu."
841 "Non-nil means using a non-intrusive `org-export-dispatch'.
842 In that case, no help buffer is displayed. Though, an indicator
848 asynchronous). Also, \[?] allows to switch back to standard
849 mode."
856 \f
857 ;;; Defining Back-ends
858 ;;
859 ;; `org-export-define-backend' is the standard way to define an export
860 ;; back-end. It allows to specify translators, filters, buffer
861 ;; options and a menu entry. If the new back-end shares translators
862 ;; with another back-end, `org-export-define-derived-backend' may be
863 ;; used instead.
864 ;;
865 ;; Internally, a back-end is stored as a list, of which CAR is the
866 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
867 ;; properties of a given back-end are: `org-export-backend-filters',
868 ;; `org-export-backend-menu', `org-export-backend-options' and
869 ;; `org-export-backend-translate-table'.
870 ;;
871 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
872 ;; when a given back-end hasn't been registered yet.
875 "Define a new back-end BACKEND.
877 TRANSLATORS is an alist between object or element types and
878 functions handling them.
880 These functions should return a string without any trailing
881 space, or nil. They must accept three arguments: the object or
882 element itself, its contents or nil when it isn't recursive and
883 the property list used as a communication channel.
885 Contents, when not nil, are stripped from any global indentation
886 \(although the relative one is preserved). They also always end
887 with a single newline character.
889 If, for a given type, no function is found, that element or
890 object type will simply be ignored, along with any blank line or
891 white space at its end. The same will happen if the function
892 returns the nil value. If that function returns the empty
893 string, the type will be ignored, but the blank lines or white
894 spaces will be kept.
896 In addition to element and object types, one function can be
897 associated to the `template' (or `inner-template') symbol and
898 another one to the `plain-text' symbol.
900 The former returns the final transcoded string, and can be used
901 to add a preamble and a postamble to document's body. It must
902 accept two arguments: the transcoded string and the property list
903 containing export options. A function associated to `template'
905 A function associated to `inner-template' is always applied.
907 The latter, when defined, is to be called on every text not
908 recognized as an element or an object. It must accept two
909 arguments: the text string and the information channel. It is an
910 appropriate place to protect special chars relative to the
911 back-end.
913 BODY can start with pre-defined keyword arguments. The following
914 keywords are understood:
916 :export-block
918 String, or list of strings, representing block names that
919 will not be parsed. This is used to specify blocks that will
920 contain raw code specific to the back-end. These blocks
921 still have to be handled by the relative `export-block' type
922 translator.
924 :filters-alist
926 Alist between filters and function, or list of functions,
927 specific to the back-end. See `org-export-filters-alist' for
928 a list of all allowed filters. Filters defined here
929 shouldn't make a back-end test, as it may prevent back-ends
930 derived from this one to behave properly.
932 :menu-entry
934 Menu entry for the export dispatcher. It should be a list
935 like:
937 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
939 where :
941 KEY is a free character selecting the back-end.
943 DESCRIPTION-OR-ORDINAL is either a string or a number.
945 If it is a string, is will be used to name the back-end in
946 its menu entry. If it is a number, the following menu will
947 be displayed as a sub-menu of the back-end with the same
948 KEY. Also, the number will be used to determine in which
949 order such sub-menus will appear (lowest first).
951 ACTION-OR-MENU is either a function or an alist.
953 If it is an action, it will be called with four
954 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
955 BODY-ONLY. See `org-export-as' for further explanations on
956 some of them.
958 If it is an alist, associations should follow the
959 pattern:
961 '(KEY DESCRIPTION ACTION)
963 where KEY, DESCRIPTION and ACTION are described above.
965 Valid values include:
969 or
974 \(lambda (a s v b)
975 \(if a (org-latex-export-to-pdf t s v b)
976 \(org-open-file
977 \(org-latex-export-to-pdf nil s v b)))))))
979 or the following, which will be added to the previous
980 sub-menu,
982 '(?l 1
986 :options-alist
988 Alist between back-end specific properties introduced in
989 communication channel and how their value are acquired. See
990 `org-export-options-alist' for more information about
991 structure of the values."
1008 ;; Register back-end.
1012 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1018 export-block))))
1021 "Create a new back-end as a variant of an existing one.
1023 CHILD is the name of the derived back-end. PARENT is the name of
1024 the parent back-end.
1026 BODY can start with pre-defined keyword arguments. The following
1027 keywords are understood:
1029 :export-block
1031 String, or list of strings, representing block names that
1032 will not be parsed. This is used to specify blocks that will
1033 contain raw code specific to the back-end. These blocks
1034 still have to be handled by the relative `export-block' type
1035 translator.
1037 :filters-alist
1039 Alist of filters that will overwrite or complete filters
1040 defined in PARENT back-end. See `org-export-filters-alist'
1041 for a list of allowed filters.
1043 :menu-entry
1045 Menu entry for the export dispatcher. See
1046 `org-export-define-backend' for more information about the
1047 expected value.
1049 :options-alist
1051 Alist of back-end specific properties that will overwrite or
1052 complete those defined in PARENT back-end. Refer to
1053 `org-export-options-alist' for more information about
1054 structure of the values.
1056 :translate-alist
1058 Alist of element and object types and transcoders that will
1059 overwrite or complete transcode table from PARENT back-end.
1060 Refer to `org-export-define-backend' for detailed information
1061 about transcoders.
1064 as a variant of `latex' back-end with a custom template function:
1066 \(org-export-define-derived-backend 'my-latex 'latex
1067 :translate-alist '((template . my-latex-template-fun)))
1069 The back-end could then be called with, for example:
1095 ;; Register back-end.
1099 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1105 export-block))))
1108 "Return back-end from which BACKEND is derived, or nil."
1112 "Return filters for BACKEND."
1117 "Return menu entry for BACKEND."
1122 "Return export options for BACKEND."
1127 "Return translate table for BACKEND."
1132 "Signal an error if BACKEND isn't defined."
1137 "Non-nil if BACKEND is derived from one of BACKENDS."
1141 parent))
1144 \f
1145 ;;; The Communication Channel
1146 ;;
1147 ;; During export process, every function has access to a number of
1148 ;; properties. They are of two types:
1149 ;;
1150 ;; 1. Environment options are collected once at the very beginning of
1151 ;; the process, out of the original buffer and configuration.
1152 ;; Collecting them is handled by `org-export-get-environment'
1153 ;; function.
1154 ;;
1155 ;; Most environment options are defined through the
1156 ;; `org-export-options-alist' variable.
1157 ;;
1158 ;; 2. Tree properties are extracted directly from the parsed tree,
1159 ;; just before export, by `org-export-collect-tree-properties'.
1160 ;;
1161 ;; Here is the full list of properties available during transcode
1162 ;; process, with their category and their value type.
1163 ;;
1164 ;; + `:author' :: Author's name.
1165 ;; - category :: option
1166 ;; - type :: string
1167 ;;
1168 ;; + `:back-end' :: Current back-end used for transcoding.
1169 ;; - category :: tree
1170 ;; - type :: symbol
1171 ;;
1172 ;; + `:creator' :: String to write as creation information.
1173 ;; - category :: option
1174 ;; - type :: string
1175 ;;
1176 ;; + `:date' :: String to use as date.
1177 ;; - category :: option
1178 ;; - type :: string
1179 ;;
1180 ;; + `:description' :: Description text for the current data.
1181 ;; - category :: option
1182 ;; - type :: string
1183 ;;
1184 ;; + `:email' :: Author's email.
1185 ;; - category :: option
1186 ;; - type :: string
1187 ;;
1188 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1189 ;; process.
1190 ;; - category :: option
1191 ;; - type :: list of strings
1192 ;;
1193 ;; + `:export-options' :: List of export options available for current
1194 ;; process.
1195 ;; - category :: none
1196 ;; - type :: list of symbols, among `subtree', `body-only' and
1197 ;; `visible-only'.
1198 ;;
1199 ;; + `:exported-data' :: Hash table used for memoizing
1200 ;; `org-export-data'.
1201 ;; - category :: tree
1202 ;; - type :: hash table
1203 ;;
1204 ;; + `:filetags' :: List of global tags for buffer. Used by
1205 ;; `org-export-get-tags' to get tags with inheritance.
1206 ;; - category :: option
1207 ;; - type :: list of strings
1208 ;;
1209 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1210 ;; their definition, as parsed data. Only non-inlined footnotes
1211 ;; are represented in this alist. Also, every definition isn't
1212 ;; guaranteed to be referenced in the parse tree. The purpose of
1213 ;; this property is to preserve definitions from oblivion
1214 ;; (i.e. when the parse tree comes from a part of the original
1215 ;; buffer), it isn't meant for direct use in a back-end. To
1216 ;; retrieve a definition relative to a reference, use
1217 ;; `org-export-get-footnote-definition' instead.
1218 ;; - category :: option
1219 ;; - type :: alist (STRING . LIST)
1220 ;;
1221 ;; + `:headline-levels' :: Maximum level being exported as an
1222 ;; headline. Comparison is done with the relative level of
1223 ;; headlines in the parse tree, not necessarily with their
1224 ;; actual level.
1225 ;; - category :: option
1226 ;; - type :: integer
1227 ;;
1228 ;; + `:headline-offset' :: Difference between relative and real level
1229 ;; of headlines in the parse tree. For example, a value of -1
1230 ;; means a level 2 headline should be considered as level
1231 ;; 1 (cf. `org-export-get-relative-level').
1232 ;; - category :: tree
1233 ;; - type :: integer
1234 ;;
1235 ;; + `:headline-numbering' :: Alist between headlines and their
1236 ;; numbering, as a list of numbers
1237 ;; (cf. `org-export-get-headline-number').
1238 ;; - category :: tree
1239 ;; - type :: alist (INTEGER . LIST)
1240 ;;
1241 ;; + `:id-alist' :: Alist between ID strings and destination file's
1242 ;; path, relative to current directory. It is used by
1243 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1244 ;; external file.
1245 ;; - category :: option
1246 ;; - type :: alist (STRING . STRING)
1247 ;;
1248 ;; + `:ignore-list' :: List of elements and objects that should be
1249 ;; ignored during export.
1250 ;; - category :: tree
1251 ;; - type :: list of elements and objects
1252 ;;
1253 ;; + `:input-file' :: Full path to input file, if any.
1254 ;; - category :: option
1255 ;; - type :: string or nil
1256 ;;
1257 ;; + `:keywords' :: List of keywords attached to data.
1258 ;; - category :: option
1259 ;; - type :: string
1260 ;;
1261 ;; + `:language' :: Default language used for translations.
1262 ;; - category :: option
1263 ;; - type :: string
1264 ;;
1265 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1266 ;; transcoding.
1267 ;; - category :: option
1268 ;; - type :: list (as returned by `org-element-parse-buffer')
1269 ;;
1270 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1271 ;; all line breaks.
1272 ;; - category :: option
1273 ;; - type :: symbol (nil, t)
1274 ;;
1275 ;; + `:section-numbers' :: Non-nil means transcoding should add
1276 ;; section numbers to headlines.
1277 ;; - category :: option
1278 ;; - type :: symbol (nil, t)
1279 ;;
1280 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1281 ;; in transcoding. When such a tag is present, subtrees without
1282 ;; it are de facto excluded from the process. See
1283 ;; `use-select-tags'.
1284 ;; - category :: option
1285 ;; - type :: list of strings
1286 ;;
1287 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1288 ;; a time stamp in the output.
1289 ;; - category :: option
1290 ;; - type :: symbol (nil, t)
1291 ;;
1292 ;; + `:translate-alist' :: Alist between element and object types and
1293 ;; transcoding functions relative to the current back-end.
1294 ;; Special keys `inner-template', `template' and `plain-text' are
1295 ;; also possible.
1296 ;; - category :: option
1297 ;; - type :: alist (SYMBOL . FUNCTION)
1298 ;;
1299 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1300 ;; also be transcoded. If it is set to the `headline' symbol,
1301 ;; only the archived headline's name is retained.
1302 ;; - category :: option
1303 ;; - type :: symbol (nil, t, `headline')
1304 ;;
1305 ;; + `:with-author' :: Non-nil means author's name should be included
1306 ;; in the output.
1307 ;; - category :: option
1308 ;; - type :: symbol (nil, t)
1309 ;;
1310 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1311 ;; - category :: option
1312 ;; - type :: symbol (nil, t)
1313 ;;
1314 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1315 ;; inserted at the end of the transcoded string. If the value
1316 ;; is `comment', it should be commented.
1317 ;; - category :: option
1318 ;; - type :: symbol (`comment', nil, t)
1319 ;;
1320 ;; + `:with-date' :: Non-nil means output should contain a date.
1321 ;; - category :: option
1322 ;; - type :. symbol (nil, t)
1323 ;;
1324 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1325 ;; its value is a list of names, only drawers with such names
1326 ;; will be transcoded. If that list starts with `not', drawer
1327 ;; with these names will be skipped.
1328 ;; - category :: option
1329 ;; - type :: symbol (nil, t) or list of strings
1330 ;;
1331 ;; + `:with-email' :: Non-nil means output should contain author's
1332 ;; email.
1333 ;; - category :: option
1334 ;; - type :: symbol (nil, t)
1335 ;;
1336 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1337 ;; interpreted.
1338 ;; - category :: option
1339 ;; - type :: symbol (nil, t)
1340 ;;
1341 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1342 ;; strings starting with a colon as a fixed-with (verbatim) area.
1343 ;; - category :: option
1344 ;; - type :: symbol (nil, t)
1345 ;;
1346 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1347 ;; footnotes.
1348 ;; - category :: option
1349 ;; - type :: symbol (nil, t)
1350 ;;
1351 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1352 ;; `latex-fragment' objects should appear in export output. When
1353 ;; this property is set to `verbatim', they will be left as-is.
1354 ;; - category :: option
1355 ;; - type :: symbol (`verbatim', nil, t)
1356 ;;
1357 ;; + `:with-planning' :: Non-nil means transcoding should include
1358 ;; planning info.
1359 ;; - category :: option
1360 ;; - type :: symbol (nil, t)
1361 ;;
1362 ;; + `:with-priority' :: Non-nil means transcoding should include
1363 ;; priority cookies.
1364 ;; - category :: option
1365 ;; - type :: symbol (nil, t)
1366 ;;
1367 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1368 ;; plain text.
1369 ;; - category :: option
1370 ;; - type :: symbol (nil, t)
1371 ;;
1372 ;; + `:with-special-strings' :: Non-nil means transcoding should
1373 ;; interpret special strings in plain text.
1374 ;; - category :: option
1375 ;; - type :: symbol (nil, t)
1376 ;;
1377 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1378 ;; interpret subscript and superscript. With a value of "{}",
1379 ;; only interpret those using curly brackets.
1380 ;; - category :: option
1381 ;; - type :: symbol (nil, {}, t)
1382 ;;
1383 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1384 ;; tables.
1385 ;; - category :: option
1386 ;; - type :: symbol (nil, t)
1387 ;;
1388 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1389 ;; headlines. A `not-in-toc' value will remove them from the
1390 ;; table of contents, if any, nonetheless.
1391 ;; - category :: option
1392 ;; - type :: symbol (nil, t, `not-in-toc')
1393 ;;
1394 ;; + `:with-tasks' :: Non-nil means transcoding should include
1395 ;; headlines with a TODO keyword. A `todo' value will only
1396 ;; include headlines with a todo type keyword while a `done'
1397 ;; value will do the contrary. If a list of strings is provided,
1398 ;; only tasks with keywords belonging to that list will be kept.
1399 ;; - category :: option
1400 ;; - type :: symbol (t, todo, done, nil) or list of strings
1401 ;;
1402 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1403 ;; time stamps. Special value `active' (resp. `inactive') ask to
1404 ;; export only active (resp. inactive) timestamps. Otherwise,
1405 ;; completely remove them.
1406 ;; - category :: option
1407 ;; - type :: symbol: (`active', `inactive', t, nil)
1408 ;;
1409 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1410 ;; added to the output. An integer value limits its depth.
1411 ;; - category :: option
1412 ;; - type :: symbol (nil, t or integer)
1413 ;;
1414 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1415 ;; include TODO keywords.
1416 ;; - category :: option
1417 ;; - type :: symbol (nil, t)
1420 ;;;; Environment Options
1421 ;;
1422 ;; Environment options encompass all parameters defined outside the
1423 ;; scope of the parsed data. They come from five sources, in
1424 ;; increasing precedence order:
1425 ;;
1426 ;; - Global variables,
1427 ;; - Buffer's attributes,
1428 ;; - Options keyword symbols,
1429 ;; - Buffer keywords,
1430 ;; - Subtree properties.
1431 ;;
1432 ;; The central internal function with regards to environment options
1433 ;; is `org-export-get-environment'. It updates global variables with
1434 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1435 ;; the different sources.
1436 ;;
1437 ;; The internal functions doing the retrieval are:
1438 ;; `org-export--get-global-options',
1439 ;; `org-export--get-buffer-attributes',
1440 ;; `org-export--parse-option-keyword',
1441 ;; `org-export--get-subtree-options' and
1442 ;; `org-export--get-inbuffer-options'
1443 ;;
1444 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1445 ;; relative to "#+BIND:" keywords.
1448 "Collect export options from the current buffer.
1450 Optional argument BACKEND is a symbol specifying which back-end
1451 specific options to read, if any.
1453 When optional argument SUBTREEP is non-nil, assume the export is
1454 done against the current sub-tree.
1456 Third optional argument EXT-PLIST is a property list with
1457 external parameters overriding Org default settings, but still
1458 inferior to file-local settings."
1459 ;; First install #+BIND variables since these must be set before
1460 ;; global options are read.
1463 ;; Get and prioritize export options...
1465 ;; ... from global variables...
1467 ;; ... from an external property list...
1468 ext-plist
1469 ;; ... from in-buffer settings...
1471 ;; ... and from subtree, when appropriate.
1473 ;; Eventually add misc. properties.
1475 :back-end
1476 backend
1477 :translate-alist
1479 :footnote-definition-alist
1480 ;; Footnotes definitions must be collected in the original
1481 ;; buffer, as there's no insurance that they will still be in
1482 ;; the parse tree, due to possible narrowing.
1496 alist))))
1497 alist))
1498 :id-alist
1499 ;; Collect id references.
1510 alist))))
1513 "Parse an OPTIONS line and return values as a plist.
1514 Optional argument BACKEND is a symbol specifying which back-end
1515 specific items to read, if any."
1517 ;; Priority is given to back-end specific options.
1519 org-export-options-alist))
1520 plist)
1529 options))
1531 property
1534 plist))
1537 "Get export options in subtree at point.
1538 Optional argument BACKEND is a symbol specifying back-end used
1539 for export. Return options as a plist."
1540 ;; For each buffer keyword, create a headline property setting the
1541 ;; same property in communication channel. The name for the property
1542 ;; is the keyword with "EXPORT_" appended to it.
1545 ;; Make sure point is at a heading.
1547 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1548 ;; title as its fallback value.
1554 plist :title
1557 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1561 ;; Handle other keywords. TITLE keyword is excluded as it has
1562 ;; been handled already.
1570 ;; Export properties are not case-sensitive.
1577 plist
1578 property
1580 ;; Parse VALUE if required.
1584 ;; If BEHAVIOUR is `split' expected value is
1585 ;; a list of strings, not a string.
1588 ;; Look for both general keywords and back-end specific
1589 ;; options, with priority given to the latter.
1591 org-export-options-alist)))
1592 ;; Return value.
1593 plist)))
1596 "Return current buffer export options, as a plist.
1598 Optional argument BACKEND, when non-nil, is a symbol specifying
1599 which back-end specific options should also be read in the
1600 process.
1602 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1604 get-options ; For byte-compiler.
1607 ;; Priority is given to back-end specific options.
1609 org-export-options-alist))
1612 org-export-special-keywords))))
1615 ;; Return property name associated to KEYWORD.
1620 options))))
1623 ;; Recursively read keywords in buffer. FILES is a list
1624 ;; of files read so far. PLIST is the current property
1625 ;; list obtained.
1634 ;; Options in `org-export-special-keywords'.
1638 ;; Avoid circular dependencies.
1648 plist
1653 plist
1659 ;; Options in `org-export-options-alist'.
1664 plist prop
1665 ;; Handle value depending on specified
1666 ;; BEHAVIOUR.
1672 " "
1684 ;; Return final value.
1685 plist))))
1686 ;; Read options in the current buffer.
1688 ;; Parse keywords specified in `org-element-document-properties'.
1690 ;; Find the property associated to the keyword.
1698 org-element-document-properties)
1699 ;; Return value.
1700 plist))
1703 "Return properties related to buffer attributes, as a plist."
1706 ;; Store full path of input file name, or nil. For internal use.
1707 :input-file visited-file
1714 "Return global export options as a plist.
1716 Optional argument BACKEND, if non-nil, is a symbol specifying
1717 which back-end specific export options should also be read in the
1718 process."
1720 ;; Priority is given to back-end specific options.
1722 org-export-options-alist))
1723 plist)
1730 plist
1731 prop
1732 ;; Eval default value provided. If keyword is a member
1733 ;; of `org-element-document-properties', parse it as
1734 ;; a secondary string before storing it.
1739 value
1742 all)
1743 ;; Return value.
1744 plist))
1747 "Return variables bound from BIND keywords in current buffer.
1748 Also look for BIND keywords in setup files. The return value is
1749 an alist where associations are (VARIABLE-NAME VALUE)."
1754 ;; Return an alist between variable names and their
1755 ;; value. FILES is a list of setup files names read so
1756 ;; far, used to avoid circular dependencies. ALIST is
1757 ;; the alist collected so far.
1768 ;; Enter setup file.
1778 alist))))))))))
1779 alist)))))
1780 ;; Return value in appropriate order of appearance.
1784 ;;;; Tree Properties
1785 ;;
1786 ;; Tree properties are information extracted from parse tree. They
1787 ;; are initialized at the beginning of the transcoding process by
1788 ;; `org-export-collect-tree-properties'.
1789 ;;
1790 ;; Dedicated functions focus on computing the value of specific tree
1791 ;; properties during initialization. Thus,
1792 ;; `org-export--populate-ignore-list' lists elements and objects that
1793 ;; should be skipped during export, `org-export--get-min-level' gets
1794 ;; the minimal exportable level, used as a basis to compute relative
1795 ;; level for headlines. Eventually
1796 ;; `org-export--collect-headline-numbering' builds an alist between
1797 ;; headlines and their numbering.
1800 "Extract tree properties from parse tree.
1802 DATA is the parse tree from which information is retrieved. INFO
1803 is a list holding export options.
1805 Following tree properties are set or updated:
1807 `:exported-data' Hash table used to memoize results from
1808 `org-export-data'.
1810 `:footnote-definition-alist' List of footnotes definitions in
1811 original buffer and current parse tree.
1813 `:headline-offset' Offset between true level of headlines and
1814 local level. An offset of -1 means a headline
1815 of level 2 should be considered as a level
1816 1 headline in the context.
1818 `:headline-numbering' Alist of all headlines as key an the
1819 associated numbering as value.
1821 `:ignore-list' List of elements that should be ignored during
1822 export.
1824 Return updated plist."
1825 ;; Install the parse tree in the communication channel, in order to
1826 ;; use `org-export-get-genealogy' and al.
1828 ;; Get the list of elements and objects to ignore, and put it into
1829 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1830 ;; been done during parse tree filtering.
1833 :ignore-list
1836 ;; Compute `:headline-offset' in order to be able to use
1837 ;; `org-export-get-relative-level'.
1840 :headline-offset
1842 ;; Update footnotes definitions list with definitions in parse tree.
1843 ;; This is required since buffer expansion might have modified
1844 ;; boundaries of footnote definitions contained in the parse tree.
1845 ;; This way, definitions in `footnote-definition-alist' are bound to
1846 ;; match those in the parse tree.
1852 defs)))
1854 ;; Properties order doesn't matter: get the rest of the tree
1855 ;; properties.
1859 info))
1862 "Return minimum exportable headline's level in DATA.
1863 DATA is parsed tree as returned by `org-element-parse-buffer'.
1864 OPTIONS is a plist holding export options."
1875 ;; If no headline was found, for the sake of consistency, set
1876 ;; minimum level to 1 nonetheless.
1880 "Return numbering of all exportable headlines in a parse tree.
1882 DATA is the parse tree. OPTIONS is the plist holding export
1883 options.
1885 Return an alist whose key is a headline and value is its
1886 associated numbering \(in the shape of a list of numbers\) or nil
1887 for a footnotes section."
1895 headline
1897 for idx from 0 to org-export-max-depth
1901 options)))
1904 "Return list of elements and objects to ignore during export.
1905 DATA is the parse tree to traverse. OPTIONS is the plist holding
1906 export options."
1908 walk-data
1909 ;; First find trees containing a select tag, if any.
1913 ;; Collect ignored elements or objects into IGNORE-LIST.
1919 ;; If headline is archived but tree below has
1920 ;; to be skipped, add it to ignore list.
1923 ;; Move into secondary string, if any.
1928 ;; Move into recursive objects/elements.
1930 ;; Main call.
1932 ;; Return value.
1933 ignore))
1936 "Return list of headlines and inlinetasks with a select tag in their tree.
1937 DATA is parsed data as returned by `org-element-parse-buffer'.
1938 INFO is a plist holding export options."
1940 walk-data ; For byte-compiler.
1950 ;; When a select tag is found, mark full
1951 ;; genealogy and every headline within the tree
1952 ;; as acceptable.
1955 genealogy
1958 selected-trees))
1959 ;; If at a headline, continue searching in tree,
1960 ;; recursively.
1970 selected-trees))
1973 "Non-nil when element or object BLOB should be skipped during export.
1974 OPTIONS is the plist holding export options. SELECTED, when
1975 non-nil, is a list of headlines or inlinetasks belonging to
1976 a tree with a select tag."
1983 ;; If `:with-drawers' value starts with `not', ignore
1984 ;; every drawer whose name belong to that list.
1985 ;; Otherwise, ignore drawers whose name isn't in that
1986 ;; list.
2000 ;; Ignore subtrees with an exclude tag.
2003 ;; When a select tag is present in the buffer, ignore any tree
2004 ;; without it.
2006 ;; Ignore commented sub-trees.
2008 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2010 ;; Ignore tasks, if specified by `:with-tasks' property.
2026 ;; No timestamp allowed.
2028 ;; Only active timestamps allowed and the current one isn't
2029 ;; active.
2033 ;; Only inactive timestamps allowed and the current one isn't
2034 ;; inactive.
2039 \f
2040 ;;; The Transcoder
2041 ;;
2042 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2043 ;; `org-element-parse-buffer') and transcodes it into a specified
2044 ;; back-end output. It takes care of filtering out elements or
2045 ;; objects according to export options and organizing the output blank
2046 ;; lines and white space are preserved. The function memoizes its
2047 ;; results, so it is cheap to call it within translators.
2048 ;;
2049 ;; It is possible to modify locally the back-end used by
2050 ;; `org-export-data' or even use a temporary back-end by using
2051 ;; `org-export-data-with-translations' and
2052 ;; `org-export-data-with-backend'.
2053 ;;
2054 ;; Internally, three functions handle the filtering of objects and
2055 ;; elements during the export. In particular,
2056 ;; `org-export-ignore-element' marks an element or object so future
2057 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2058 ;; elements or objects should be seen as real Org syntax and
2059 ;; `org-export-expand' transforms the others back into their original
2060 ;; shape
2061 ;;
2062 ;; `org-export-transcoder' is an accessor returning appropriate
2063 ;; translator function for a given element or object.
2066 "Return appropriate transcoder for BLOB.
2067 INFO is a plist containing export directives."
2069 ;; Return contents only for complete parse trees.
2075 "Convert DATA into current back-end format.
2077 DATA is a parse tree, an element or an object or a secondary
2078 string. INFO is a plist holding export options.
2080 Return transcoded string."
2086 ;; Ignored element/object.
2088 ;; Plain text.
2094 info))
2095 ;; Uninterpreted element/object: change it back to Org
2096 ;; syntax and export again resulting raw string.
2100 data
2104 info))
2105 ;; Secondary string.
2108 ;; Element/Object without contents or, as a special case,
2109 ;; headline with archive tag and archived trees restricted
2110 ;; to title only.
2118 ;; Export snippets never return a nil value so
2119 ;; that white spaces following them are never
2120 ;; ignored.
2122 ;; Element/Object with contents.
2135 ;; Elements directly containing objects
2136 ;; must have their indentation normalized
2137 ;; first.
2139 data
2140 ;; When normalizing contents of the first
2141 ;; paragraph in an item or a footnote
2142 ;; definition, ignore first line's
2143 ;; indentation: there is none and it
2144 ;; might be misleading.
2149 data)
2156 info))))))))
2157 ;; Final result will be memoized before being returned.
2159 data
2163 ;; Append the same white space between elements or objects as in
2164 ;; the original buffer, and call appropriate filters.
2175 info)))
2176 results)))
2180 "Convert DATA into another format using a given translation table.
2181 DATA is an element, an object, a secondary string or a string.
2182 TRANSLATIONS is an alist between element or object types and
2183 a functions handling them. See `org-export-define-backend' for
2184 more information. INFO is a plist used as a communication
2185 channel."
2187 data
2188 ;; Set-up a new communication channel with TRANSLATIONS as the
2189 ;; translate table and a new hash table for memoization.
2191 info
2193 ;; Size of the hash table is reduced since this function
2194 ;; will probably be used on short trees.
2198 "Convert DATA into BACKEND format.
2200 DATA is an element, an object, a secondary string or a string.
2201 BACKEND is a symbol. INFO is a plist used as a communication
2202 channel.
2204 Unlike to `org-export-with-backend', this function will
2205 recursively convert DATA using BACKEND translation table."
2211 "Non-nil if element or object BLOB should be interpreted during export.
2212 If nil, BLOB will appear as raw Org syntax. Check is done
2213 according to export options INFO, stored as a plist."
2215 ;; ... entities...
2217 ;; ... emphasis...
2220 ;; ... fixed-width areas.
2222 ;; ... footnotes...
2225 ;; ... LaTeX environments and fragments...
2229 ;; ... sub/superscripts...
2235 ;; ... tables...
2240 "Expand a parsed element or object to its original state.
2241 BLOB is either an element or an object. CONTENTS is its
2242 contents, as a string or nil."
2245 blob contents))
2248 "Add ELEMENT to `:ignore-list' in INFO.
2250 Any element in `:ignore-list' will be skipped when using
2251 `org-element-map'. INFO is modified by side effects."
2255 \f
2256 ;;; The Filter System
2257 ;;
2258 ;; Filters allow end-users to tweak easily the transcoded output.
2259 ;; They are the functional counterpart of hooks, as every filter in
2260 ;; a set is applied to the return value of the previous one.
2261 ;;
2262 ;; Every set is back-end agnostic. Although, a filter is always
2263 ;; called, in addition to the string it applies to, with the back-end
2264 ;; used as argument, so it's easy for the end-user to add back-end
2265 ;; specific filters in the set. The communication channel, as
2266 ;; a plist, is required as the third argument.
2267 ;;
2268 ;; From the developer side, filters sets can be installed in the
2269 ;; process with the help of `org-export-define-backend', which
2270 ;; internally stores filters as an alist. Each association has a key
2271 ;; among the following symbols and a function or a list of functions
2272 ;; as value.
2273 ;;
2274 ;; - `:filter-options' applies to the property list containing export
2275 ;; options. Unlike to other filters, functions in this list accept
2276 ;; two arguments instead of three: the property list containing
2277 ;; export options and the back-end. Users can set its value through
2278 ;; `org-export-filter-options-functions' variable.
2279 ;;
2280 ;; - `:filter-parse-tree' applies directly to the complete parsed
2281 ;; tree. Users can set it through
2282 ;; `org-export-filter-parse-tree-functions' variable.
2283 ;;
2284 ;; - `:filter-final-output' applies to the final transcoded string.
2285 ;; Users can set it with `org-export-filter-final-output-functions'
2286 ;; variable
2287 ;;
2288 ;; - `:filter-plain-text' applies to any string not recognized as Org
2289 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2290 ;; configure it.
2291 ;;
2292 ;; - `:filter-TYPE' applies on the string returned after an element or
2293 ;; object of type TYPE has been transcoded. A user can modify
2294 ;; `org-export-filter-TYPE-functions'
2295 ;;
2296 ;; All filters sets are applied with
2297 ;; `org-export-filter-apply-functions' function. Filters in a set are
2298 ;; applied in a LIFO fashion. It allows developers to be sure that
2299 ;; their filters will be applied first.
2300 ;;
2301 ;; Filters properties are installed in communication channel with
2302 ;; `org-export-install-filters' function.
2303 ;;
2304 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2305 ;; `org-export-before-parsing-hook') are run at the beginning of the
2306 ;; export process and just before parsing to allow for heavy structure
2307 ;; modifications.
2310 ;;;; Hooks
2313 "Hook run at the beginning of the export process.
2315 This is run before include keywords and macros are expanded and
2316 Babel code blocks executed, on a copy of the original buffer
2317 being exported. Visibility and narrowing are preserved. Point
2318 is at the beginning of the buffer.
2320 Every function in this hook will be called with one argument: the
2324 "Hook run before parsing an export buffer.
2326 This is run after include keywords and macros have been expanded
2327 and Babel code blocks executed, on a copy of the original buffer
2328 being exported. Visibility and narrowing are preserved. Point
2329 is at the beginning of the buffer.
2331 Every function in this hook will be called with one argument: the
2335 ;;;; Special Filters
2338 "List of functions applied to the export options.
2339 Each filter is called with two arguments: the export options, as
2340 a plist, and the back-end, as a symbol. It must return
2344 "List of functions applied to the parsed tree.
2345 Each filter is called with three arguments: the parse tree, as
2346 returned by `org-element-parse-buffer', the back-end, as
2347 a symbol, and the communication channel, as a plist. It must
2351 "List of functions applied to plain text.
2352 Each filter is called with three arguments: a string which
2353 contains no Org syntax, the back-end, as a symbol, and the
2354 communication channel, as a plist. It must return a string or
2358 "List of functions applied to the transcoded string.
2359 Each filter is called with three arguments: the full transcoded
2360 string, the back-end, as a symbol, and the communication channel,
2361 as a plist. It must return a string that will be used as the
2365 ;;;; Elements Filters
2368 "List of functions applied to a transcoded babel-call.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded center block.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 "List of functions applied to a transcoded clock.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to a transcoded comment.
2387 Each filter is called with three arguments: the transcoded data,
2388 as a string, the back-end, as a symbol, and the communication
2392 "List of functions applied to a transcoded comment-block.
2393 Each filter is called with three arguments: the transcoded data,
2394 as a string, the back-end, as a symbol, and the communication
2398 "List of functions applied to a transcoded diary-sexp.
2399 Each filter is called with three arguments: the transcoded data,
2400 as a string, the back-end, as a symbol, and the communication
2404 "List of functions applied to a transcoded drawer.
2405 Each filter is called with three arguments: the transcoded data,
2406 as a string, the back-end, as a symbol, and the communication
2410 "List of functions applied to a transcoded dynamic-block.
2411 Each filter is called with three arguments: the transcoded data,
2412 as a string, the back-end, as a symbol, and the communication
2416 "List of functions applied to a transcoded example-block.
2417 Each filter is called with three arguments: the transcoded data,
2418 as a string, the back-end, as a symbol, and the communication
2422 "List of functions applied to a transcoded export-block.
2423 Each filter is called with three arguments: the transcoded data,
2424 as a string, the back-end, as a symbol, and the communication
2428 "List of functions applied to a transcoded fixed-width.
2429 Each filter is called with three arguments: the transcoded data,
2430 as a string, the back-end, as a symbol, and the communication
2434 "List of functions applied to a transcoded footnote-definition.
2435 Each filter is called with three arguments: the transcoded data,
2436 as a string, the back-end, as a symbol, and the communication
2440 "List of functions applied to a transcoded headline.
2441 Each filter is called with three arguments: the transcoded data,
2442 as a string, the back-end, as a symbol, and the communication
2446 "List of functions applied to a transcoded horizontal-rule.
2447 Each filter is called with three arguments: the transcoded data,
2448 as a string, the back-end, as a symbol, and the communication
2452 "List of functions applied to a transcoded inlinetask.
2453 Each filter is called with three arguments: the transcoded data,
2454 as a string, the back-end, as a symbol, and the communication
2458 "List of functions applied to a transcoded item.
2459 Each filter is called with three arguments: the transcoded data,
2460 as a string, the back-end, as a symbol, and the communication
2464 "List of functions applied to a transcoded keyword.
2465 Each filter is called with three arguments: the transcoded data,
2466 as a string, the back-end, as a symbol, and the communication
2470 "List of functions applied to a transcoded latex-environment.
2471 Each filter is called with three arguments: the transcoded data,
2472 as a string, the back-end, as a symbol, and the communication
2476 "List of functions applied to a transcoded node-property.
2477 Each filter is called with three arguments: the transcoded data,
2478 as a string, the back-end, as a symbol, and the communication
2482 "List of functions applied to a transcoded paragraph.
2483 Each filter is called with three arguments: the transcoded data,
2484 as a string, the back-end, as a symbol, and the communication
2488 "List of functions applied to a transcoded plain-list.
2489 Each filter is called with three arguments: the transcoded data,
2490 as a string, the back-end, as a symbol, and the communication
2494 "List of functions applied to a transcoded planning.
2495 Each filter is called with three arguments: the transcoded data,
2496 as a string, the back-end, as a symbol, and the communication
2500 "List of functions applied to a transcoded property-drawer.
2501 Each filter is called with three arguments: the transcoded data,
2502 as a string, the back-end, as a symbol, and the communication
2506 "List of functions applied to a transcoded quote block.
2507 Each filter is called with three arguments: the transcoded quote
2508 data, as a string, the back-end, as a symbol, and the
2509 communication channel, as a plist. It must return a string or
2513 "List of functions applied to a transcoded quote-section.
2514 Each filter is called with three arguments: the transcoded data,
2515 as a string, the back-end, as a symbol, and the communication
2519 "List of functions applied to a transcoded section.
2520 Each filter is called with three arguments: the transcoded data,
2521 as a string, the back-end, as a symbol, and the communication
2525 "List of functions applied to a transcoded special block.
2526 Each filter is called with three arguments: the transcoded data,
2527 as a string, the back-end, as a symbol, and the communication
2531 "List of functions applied to a transcoded src-block.
2532 Each filter is called with three arguments: the transcoded data,
2533 as a string, the back-end, as a symbol, and the communication
2537 "List of functions applied to a transcoded table.
2538 Each filter is called with three arguments: the transcoded data,
2539 as a string, the back-end, as a symbol, and the communication
2543 "List of functions applied to a transcoded table-cell.
2544 Each filter is called with three arguments: the transcoded data,
2545 as a string, the back-end, as a symbol, and the communication
2549 "List of functions applied to a transcoded table-row.
2550 Each filter is called with three arguments: the transcoded data,
2551 as a string, the back-end, as a symbol, and the communication
2555 "List of functions applied to a transcoded verse block.
2556 Each filter is called with three arguments: the transcoded data,
2557 as a string, the back-end, as a symbol, and the communication
2561 ;;;; Objects Filters
2564 "List of functions applied to transcoded bold text.
2565 Each filter is called with three arguments: the transcoded data,
2566 as a string, the back-end, as a symbol, and the communication
2570 "List of functions applied to transcoded code text.
2571 Each filter is called with three arguments: the transcoded data,
2572 as a string, the back-end, as a symbol, and the communication
2576 "List of functions applied to a transcoded entity.
2577 Each filter is called with three arguments: the transcoded data,
2578 as a string, the back-end, as a symbol, and the communication
2582 "List of functions applied to a transcoded export-snippet.
2583 Each filter is called with three arguments: the transcoded data,
2584 as a string, the back-end, as a symbol, and the communication
2588 "List of functions applied to a transcoded footnote-reference.
2589 Each filter is called with three arguments: the transcoded data,
2590 as a string, the back-end, as a symbol, and the communication
2594 "List of functions applied to a transcoded inline-babel-call.
2595 Each filter is called with three arguments: the transcoded data,
2596 as a string, the back-end, as a symbol, and the communication
2600 "List of functions applied to a transcoded inline-src-block.
2601 Each filter is called with three arguments: the transcoded data,
2602 as a string, the back-end, as a symbol, and the communication
2606 "List of functions applied to transcoded italic text.
2607 Each filter is called with three arguments: the transcoded data,
2608 as a string, the back-end, as a symbol, and the communication
2612 "List of functions applied to a transcoded latex-fragment.
2613 Each filter is called with three arguments: the transcoded data,
2614 as a string, the back-end, as a symbol, and the communication
2618 "List of functions applied to a transcoded line-break.
2619 Each filter is called with three arguments: the transcoded data,
2620 as a string, the back-end, as a symbol, and the communication
2624 "List of functions applied to a transcoded link.
2625 Each filter is called with three arguments: the transcoded data,
2626 as a string, the back-end, as a symbol, and the communication
2630 "List of functions applied to a transcoded radio-target.
2631 Each filter is called with three arguments: the transcoded data,
2632 as a string, the back-end, as a symbol, and the communication
2636 "List of functions applied to a transcoded statistics-cookie.
2637 Each filter is called with three arguments: the transcoded data,
2638 as a string, the back-end, as a symbol, and the communication
2642 "List of functions applied to transcoded strike-through text.
2643 Each filter is called with three arguments: the transcoded data,
2644 as a string, the back-end, as a symbol, and the communication
2648 "List of functions applied to a transcoded subscript.
2649 Each filter is called with three arguments: the transcoded data,
2650 as a string, the back-end, as a symbol, and the communication
2654 "List of functions applied to a transcoded superscript.
2655 Each filter is called with three arguments: the transcoded data,
2656 as a string, the back-end, as a symbol, and the communication
2660 "List of functions applied to a transcoded target.
2661 Each filter is called with three arguments: the transcoded data,
2662 as a string, the back-end, as a symbol, and the communication
2666 "List of functions applied to a transcoded timestamp.
2667 Each filter is called with three arguments: the transcoded data,
2668 as a string, the back-end, as a symbol, and the communication
2672 "List of functions applied to transcoded underline text.
2673 Each filter is called with three arguments: the transcoded data,
2674 as a string, the back-end, as a symbol, and the communication
2678 "List of functions applied to transcoded verbatim text.
2679 Each filter is called with three arguments: the transcoded data,
2680 as a string, the back-end, as a symbol, and the communication
2684 ;;;; Filters Tools
2685 ;;
2686 ;; Internal function `org-export-install-filters' installs filters
2687 ;; hard-coded in back-ends (developer filters) and filters from global
2688 ;; variables (user filters) in the communication channel.
2689 ;;
2690 ;; Internal function `org-export-filter-apply-functions' takes care
2691 ;; about applying each filter in order to a given data. It ignores
2692 ;; filters returning a nil value but stops whenever a filter returns
2693 ;; an empty string.
2696 "Call every function in FILTERS.
2698 Functions are called with arguments VALUE, current export
2699 back-end and INFO. A function returning a nil value will be
2700 skipped. If it returns the empty string, the process ends and
2701 VALUE is ignored.
2703 Call is done in a LIFO fashion, to be sure that developer
2704 specified filters, if any, are called first."
2713 "Install filters properties in communication channel.
2714 INFO is a plist containing the current communication channel.
2715 Return the updated communication channel."
2717 ;; Install user-defined filters with `org-export-filters-alist'
2718 ;; and filters already in INFO (through ext-plist mechanism).
2725 ;; Filters in INFO will be called
2726 ;; before those user provided.
2729 default-value)))))
2730 org-export-filters-alist)
2731 ;; Prepend back-end specific filters to that list.
2733 ;; Single values get consed, lists are appended.
2738 plist key
2742 ;; Return new communication channel.
2746 \f
2747 ;;; Core functions
2748 ;;
2749 ;; This is the room for the main function, `org-export-as', along with
2750 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2751 ;; `org-export-string-as'. They differ either by the way they output
2752 ;; the resulting code (for the first two) or by the input type (for
2753 ;; the latter). `org-export--copy-to-kill-ring-p' determines if
2754 ;; output of these function should be added to kill ring.
2755 ;;
2756 ;; `org-export-output-file-name' is an auxiliary function meant to be
2757 ;; used with `org-export-to-file'. With a given extension, it tries
2758 ;; to provide a canonical file name to write export output to.
2759 ;;
2760 ;; Note that `org-export-as' doesn't really parse the current buffer,
2761 ;; but a copy of it (with the same buffer-local variables and
2762 ;; visibility), where macros and include keywords are expanded and
2763 ;; Babel blocks are executed, if appropriate.
2764 ;; `org-export-with-buffer-copy' macro prepares that copy.
2765 ;;
2766 ;; File inclusion is taken care of by
2767 ;; `org-export-expand-include-keyword' and
2768 ;; `org-export--prepare-file-contents'. Structure wise, including
2769 ;; a whole Org file in a buffer often makes little sense. For
2770 ;; example, if the file contains a headline and the include keyword
2771 ;; was within an item, the item should contain the headline. That's
2772 ;; why file inclusion should be done before any structure can be
2773 ;; associated to the file, that is before parsing.
2774 ;;
2775 ;; `org-export-insert-default-template' is a command to insert
2776 ;; a default template (or a back-end specific template) at point or in
2777 ;; current subtree.
2780 "Return a copy of the current buffer.
2781 The copy preserves Org buffer-local variables, visibility and
2782 narrowing."
2788 new-buf))
2791 "Apply BODY in a copy of the current buffer.
2792 The copy preserves local variables, visibility and contents of
2793 the original buffer. Point is at the beginning of the buffer
2794 when BODY is applied."
2803 ;; Kill copy without confirmation.
2809 "Generate a function duplicating BUFFER.
2811 The copy will preserve local variables, visibility, contents and
2812 narrowing of the original buffer. If a region was active in
2813 BUFFER, contents will be narrowed to that region instead.
2815 The resulting function can be evaled at a later time, from
2816 another buffer, effectively cloning the original buffer there.
2818 The function assumes BUFFER's major mode is `org-mode'."
2822 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2823 ;; already in BUFFER.
2825 ;; Copy specific buffer local variables and variables set
2826 ;; through BIND keywords.
2828 vars)
2836 buffer-file-name
2837 buffer-file-coding-system))
2841 ;; Skip unreadable values, as they cannot be
2842 ;; sent to external process.
2846 vars))))))
2847 ;; Whole buffer contents.
2852 ;; Narrowing.
2856 ;; Current position of point.
2858 ;; Overlays with invisible property.
2868 ov-set))))
2870 ov-set)))))
2872 ;;;###autoload
2875 "Transcode current Org buffer into BACKEND code.
2877 If narrowing is active in the current buffer, only transcode its
2878 narrowed part.
2880 If a region is active, transcode that region.
2882 When optional argument SUBTREEP is non-nil, transcode the
2883 sub-tree at point, extracting information from the headline
2884 properties first.
2886 When optional argument VISIBLE-ONLY is non-nil, don't export
2887 contents of hidden elements.
2889 When optional argument BODY-ONLY is non-nil, only return body
2890 code, without surrounding template.
2892 Optional argument EXT-PLIST, when provided, is a property list
2893 with external parameters overriding Org default settings, but
2894 still inferior to file-local settings.
2896 Return code as a string."
2900 ;; Narrow buffer to an appropriate region or subtree for
2901 ;; parsing. If parsing subtree, be sure to remove main headline
2902 ;; too.
2910 ;; Initialize communication channel with original buffer
2911 ;; attributes, unavailable in its copy.
2919 tree)
2920 ;; Update communication channel and get parse tree. Buffer
2921 ;; isn't parsed directly. Instead, a temporary copy is
2922 ;; created, where include keywords, macros are expanded and
2923 ;; code blocks are evaluated.
2925 ;; Run first hook with current back-end as argument.
2928 ;; Update macro templates since #+INCLUDE keywords might have
2929 ;; added some new ones.
2933 ;; Update radio targets since keyword inclusion might have
2934 ;; added some more.
2936 ;; Run last hook with current back-end as argument.
2940 ;; Update communication channel with environment. Also
2941 ;; install user's and developer's filters.
2946 ;; Expand export-specific set of macros: {{{author}}},
2947 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2948 ;; once regular macros have been expanded, since document
2949 ;; keywords may contain one of them.
2955 ;; EMAIL is not a parsed keyword: store it as-is.
2959 ;; Call options filters and update export options. We do not
2960 ;; use `org-export-filter-apply-functions' here since the
2961 ;; arity of such filters is different.
2965 ;; Parse buffer and call parse-tree filter on it.
2970 ;; Now tree is complete, compute its properties and add them
2971 ;; to communication channel.
2975 ;; Eventually transcode TREE. Wrap the resulting string into
2976 ;; a template.
2985 ;; Remove all text properties since they cannot be
2986 ;; retrieved from an external process. Finally call
2987 ;; final-output filter and return result.
2993 info))))))))
2995 ;;;###autoload
2998 "Call `org-export-as' with output to a specified buffer.
3000 BACKEND is the back-end used for transcoding, as a symbol.
3002 BUFFER is the output buffer. If it already exists, it will be
3003 erased first, otherwise, it will be created.
3005 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3006 EXT-PLIST are similar to those used in `org-export-as', which
3007 see.
3009 Depending on `org-export-copy-to-kill-ring', add buffer contents
3010 to kill ring. Return buffer."
3017 ;; Maybe add buffer contents to kill ring.
3020 ;; Return buffer.
3021 buffer))
3023 ;;;###autoload
3026 "Call `org-export-as' with output to a specified file.
3028 BACKEND is the back-end used for transcoding, as a symbol. FILE
3029 is the name of the output file, as a string.
3031 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3032 EXT-PLIST are similar to those used in `org-export-as', which
3033 see.
3035 Depending on `org-export-copy-to-kill-ring', add file contents
3036 to kill ring. Return output file's name."
3037 ;; Checks for FILE permissions. `write-file' would do the same, but
3038 ;; we'd rather avoid needless transcoding of parse tree.
3040 ;; Insert contents to a temporary buffer and write it to FILE.
3046 ;; Maybe add file contents to kill ring.
3049 ;; Return full path.
3050 file)
3052 ;;;###autoload
3054 "Transcode STRING into BACKEND code.
3056 When optional argument BODY-ONLY is non-nil, only return body
3057 code, without preamble nor postamble.
3059 Optional argument EXT-PLIST, when provided, is a property list
3060 with external parameters overriding Org default settings, but
3061 still inferior to file-local settings.
3063 Return code as a string."
3069 ;;;###autoload
3071 "Replace the active region by its export to BACKEND."
3081 ;;;###autoload
3083 "Insert all export keywords with default values at beginning of line.
3085 BACKEND is a symbol representing the export back-end for which
3086 specific export options should be added to the template, or
3087 `default' for default template. When it is nil, the user will be
3088 prompted for a category.
3090 If SUBTREEP is non-nil, export configuration will be set up
3091 locally for the subtree through node properties."
3100 "Options category: "
3103 org-export-registered-backends))))))
3104 options keywords)
3105 ;; Populate OPTIONS and KEYWORDS.
3119 ;; Move to an appropriate location in order to insert options.
3121 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3122 ;; list of available keywords.
3150 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3169 ;; And the rest of keywords.
3180 "Return output file's name according to buffer specifications.
3182 EXTENSION is a string representing the output file extension,
3183 with the leading dot.
3185 With a non-nil optional argument SUBTREEP, try to determine
3187 of subtree at point.
3189 When optional argument PUB-DIR is set, use it as the publishing
3190 directory.
3192 When optional argument VISIBLE-ONLY is non-nil, don't export
3193 contents of hidden elements.
3195 Return file name as a string."
3198 ;; File name may come from EXPORT_FILE_NAME subtree
3199 ;; property, assuming point is at beginning of said
3200 ;; sub-tree.
3207 ;; File name may be extracted from buffer's associated
3208 ;; file, if any.
3210 ;; Can't determine file name on our own: Ask user.
3214 "Output file: " pub-dir nil nil nil
3218 ;; Build file name. Enforce EXTENSION over whatever user
3219 ;; may have come up with. PUB-DIR, if defined, always has
3220 ;; precedence over any provided path.
3225 extension))
3228 ;; If writing to OUTPUT-FILE would overwrite original file, append
3229 ;; EXTENSION another time to final name.
3232 output-file)))
3235 "Expand every include keyword in buffer.
3236 Optional argument INCLUDED is a list of included file names along
3237 with their line restriction, when appropriate. It is used to
3238 avoid infinite recursion. Optional argument DIR is the current
3239 working directory. It is used to properly resolve relative
3240 paths."
3247 ;; Extract arguments from keyword's value.
3261 ;; Minimal level of included file defaults to the child
3262 ;; level of the current headline, if any, or one. It
3263 ;; only applies is the file is meant to be included as
3264 ;; an Org one.
3272 ;; Remove keyword.
3277 ;; Check if files has already been parsed. Look after
3278 ;; inclusion lines too, as different parts of the same file
3279 ;; can be included too.
3291 ind-str contents ind-str))))
3299 ind-str env contents ind-str))))
3312 "Prepare the contents of FILE for inclusion and return them as a string.
3314 When optional argument LINES is a string specifying a range of
3315 lines, include only those lines.
3317 Optional argument IND, when non-nil, is an integer specifying the
3318 global indentation of returned contents. Since its purpose is to
3319 allow an included file to stay in the same environment it was
3320 created \(i.e. a list item), it doesn't apply past the first
3321 headline encountered.
3323 Optional argument MINLEVEL, when non-nil, is an integer
3324 specifying the level that any top-level headline in the included
3325 file should have."
3341 ;; Remove blank lines at beginning and end of contents. The logic
3342 ;; behind that removal is that blank lines around include keyword
3343 ;; override blank lines in included file.
3352 ;; If IND is set, preserve indentation of include keyword until
3353 ;; the first headline encountered.
3360 ;; Do not move footnote definitions out of column 0.
3366 ;; When MINLEVEL is specified, compute minimal level for headlines
3367 ;; in the file (CUR-MIN), and remove stars to each headline so
3368 ;; that headlines with minimal level have a level of MINLEVEL.
3379 ;; Only change stars, don't bother moving whole
3380 ;; sections.
3387 "Execute every Babel code in the visible part of current buffer."
3388 ;; Get a pristine copy of current buffer so Babel references can be
3389 ;; properly resolved.
3396 "Return a non-nil value when output should be added to the kill ring.
3397 See also `org-export-copy-to-kill-ring'."
3403 \f
3404 ;;; Tools For Back-Ends
3405 ;;
3406 ;; A whole set of tools is available to help build new exporters. Any
3407 ;; function general enough to have its use across many back-ends
3408 ;; should be added here.
3410 ;;;; For Affiliated Keywords
3411 ;;
3412 ;; `org-export-read-attribute' reads a property from a given element
3413 ;; as a plist. It can be used to normalize affiliated keywords'
3414 ;; syntax.
3415 ;;
3416 ;; Since captions can span over multiple lines and accept dual values,
3417 ;; their internal representation is a bit tricky. Therefore,
3418 ;; `org-export-get-caption' transparently returns a given element's
3419 ;; caption as a secondary string.
3422 "Turn ATTRIBUTE property from ELEMENT into a plist.
3424 When optional argument PROPERTY is non-nil, return the value of
3425 that property within attributes.
3429 properties.
3431 All values will become strings except the empty string and
3434 will become the empty string."
3447 s)
3452 ;; Ignore any string before first property with `cdr'.
3457 "Return caption from ELEMENT as a secondary string.
3459 When optional argument SHORTP is non-nil, return short caption,
3460 as a secondary string, instead.
3462 Caption lines are separated by a white space."
3470 ;;;; For Derived Back-ends
3471 ;;
3472 ;; `org-export-with-backend' is a function allowing to locally use
3473 ;; another back-end to transcode some object or element. In a derived
3474 ;; back-end, it may be used as a fall-back function once all specific
3475 ;; cases have been treated.
3478 "Call a transcoder from BACK-END on DATA.
3479 CONTENTS, when non-nil, is the transcoded contents of DATA
3480 element, as a string. INFO, when non-nil, is the communication
3481 channel used for export, as a plist.."
3491 ;;;; For Export Snippets
3492 ;;
3493 ;; Every export snippet is transmitted to the back-end. Though, the
3494 ;; latter will only retain one type of export-snippet, ignoring
3495 ;; others, based on the former's target back-end. The function
3496 ;; `org-export-snippet-backend' returns that back-end for a given
3497 ;; export-snippet.
3500 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3501 Translation, with `org-export-snippet-translation-alist', is
3502 applied."
3506 back-end))))
3509 ;;;; For Footnotes
3510 ;;
3511 ;; `org-export-collect-footnote-definitions' is a tool to list
3512 ;; actually used footnotes definitions in the whole parse tree, or in
3513 ;; a headline, in order to add footnote listings throughout the
3514 ;; transcoded data.
3515 ;;
3516 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3517 ;; back-ends, when they need to attach the footnote definition only to
3518 ;; the first occurrence of the corresponding label.
3519 ;;
3520 ;; `org-export-get-footnote-definition' and
3521 ;; `org-export-get-footnote-number' provide easier access to
3522 ;; additional information relative to a footnote reference.
3525 "Return an alist between footnote numbers, labels and definitions.
3527 DATA is the parse tree from which definitions are collected.
3528 INFO is the plist used as a communication channel.
3530 Definitions are sorted by order of references. They either
3531 appear as Org data or as a secondary string for inlined
3532 footnotes. Unreferenced definitions are ignored."
3534 collect-fn ; for byte-compiler.
3538 ;; Collect footnote number, label and definition in DATA.
3546 def)
3547 num-alist)
3548 ;; Also search in definition for nested footnotes.
3551 ;; Don't enter footnote definitions since it will happen
3552 ;; when their first reference is found.
3558 "Non-nil when a footnote reference is the first one for its label.
3560 FOOTNOTE-REFERENCE is the footnote reference being considered.
3561 INFO is the plist used as a communication channel."
3563 ;; Anonymous footnotes are always a first reference.
3565 ;; Otherwise, return the first footnote with the same LABEL and
3566 ;; test if it is equal to FOOTNOTE-REFERENCE.
3576 ;; If FN isn't inlined, be sure to traverse its
3577 ;; definition before resuming search. See
3578 ;; comments in `org-export-get-footnote-number'
3579 ;; for more information.
3583 ;; Don't enter footnote definitions since it will
3584 ;; happen when their first reference is found.
3587 footnote-reference)))))
3590 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3591 INFO is the plist used as a communication channel. If no such
3593 string."
3600 "Return number associated to a footnote.
3602 FOOTNOTE is either a footnote reference or a footnote definition.
3603 INFO is the plist used as a communication channel."
3605 seen-refs
3606 search-ref ; For byte-compiler.
3610 ;; Search footnote references through DATA, filling
3611 ;; SEEN-REFS along the way.
3616 ;; Anonymous footnote match: return number.
3619 ;; Labels match: return number.
3622 ;; Anonymous footnote: it's always a new one.
3623 ;; Also, be sure to return nil from the `cond' so
3624 ;; `first-match' doesn't get us out of the loop.
3626 ;; Label not seen so far: add it so SEEN-REFS.
3627 ;;
3628 ;; Also search for subsequent references in
3629 ;; footnote definition so numbering follows
3630 ;; reading logic. Note that we don't have to care
3631 ;; about inline definitions, since
3632 ;; `org-element-map' already traverses them at the
3633 ;; right time.
3634 ;;
3635 ;; Once again, return nil to stay in the loop.
3640 nil))))
3641 ;; Don't enter footnote definitions since it will
3642 ;; happen when their first reference is found.
3647 ;;;; For Headlines
3648 ;;
3649 ;; `org-export-get-relative-level' is a shortcut to get headline
3650 ;; level, relatively to the lower headline level in the parsed tree.
3651 ;;
3652 ;; `org-export-get-headline-number' returns the section number of an
3653 ;; headline, while `org-export-number-to-roman' allows to convert it
3654 ;; to roman numbers.
3655 ;;
3656 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3657 ;; `org-export-last-sibling-p' are three useful predicates when it
3658 ;; comes to fulfill the `:headline-levels' property.
3659 ;;
3660 ;; `org-export-get-tags', `org-export-get-category' and
3661 ;; `org-export-get-node-property' extract useful information from an
3662 ;; headline or a parent headline. They all handle inheritance.
3663 ;;
3664 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3665 ;; as a secondary string, suitable for table of contents. It falls
3666 ;; back onto default title.
3669 "Return HEADLINE relative level within current parsed tree.
3670 INFO is a plist holding contextual information."
3675 "Non-nil when HEADLINE is considered as low level.
3677 INFO is a plist used as a communication channel.
3679 A low level headlines has a relative level greater than
3680 `:headline-levels' property value.
3682 Return value is the difference between HEADLINE relative level
3683 and the last level being considered as high enough, or nil."
3690 "Return HEADLINE numbering as a list of numbers.
3691 INFO is a plist holding contextual information."
3695 "Return a non-nil value if HEADLINE element should be numbered.
3696 INFO is a plist used as a communication channel."
3702 "Convert integer N into a roman numeral."
3715 res)))
3718 "Return list of tags associated to ELEMENT.
3720 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3721 is a plist used as a communication channel.
3723 Select tags (see `org-export-select-tags') and exclude tags (see
3724 `org-export-exclude-tags') are removed from the list.
3726 When non-nil, optional argument TAGS should be a list of strings.
3727 Any tag belonging to this list will also be removed.
3729 When optional argument INHERITED is non-nil, tags can also be
3730 inherited from parent headlines and FILETAGS keywords."
3736 ;; Build complete list of inherited tags.
3747 ;; Add FILETAGS keywords and return results.
3751 "Return node PROPERTY value for BLOB.
3753 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3754 element or object.
3756 If optional argument INHERITED is non-nil, the value can be
3757 inherited from a parent headline.
3759 Return value is a string or nil."
3771 "Return category for element or object BLOB.
3773 INFO is a plist used as a communication channel.
3775 CATEGORY is automatically inherited from a parent headline, from
3776 #+CATEGORY: keyword or created out of original file name. If all
3780 ;; Almost like `org-export-node-property', but we cannot trust
3781 ;; `plist-member' as every headline has a `:CATEGORY'
3782 ;; property, would it be nil or equal to "???" (which has the
3783 ;; same meaning).
3801 "Return alternative title for HEADLINE, as a secondary string.
3802 INFO is a plist used as a communication channel. If no optional
3803 title is defined, fall-back to the regular title."
3808 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3809 INFO is a plist used as a communication channel."
3814 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3815 INFO is a plist used as a communication channel."
3819 ;;;; For Keywords
3820 ;;
3821 ;; `org-export-get-date' returns a date appropriate for the document
3822 ;; to about to be exported. In particular, it takes care of
3823 ;; `org-export-date-timestamp-format'.
3826 "Return date value for the current document.
3828 INFO is a plist used as a communication channel. FMT, when
3829 non-nil, is a time format string that will be applied on the date
3830 if it consists in a single timestamp object. It defaults to
3831 `org-export-date-timestamp-format' when nil.
3833 A proper date can be a secondary string, a string or nil. It is
3834 meant to be translated with `org-export-data' or alike."
3845 ;;;; For Links
3846 ;;
3847 ;; `org-export-solidify-link-text' turns a string into a safer version
3848 ;; for links, replacing most non-standard characters with hyphens.
3849 ;;
3850 ;; `org-export-get-coderef-format' returns an appropriate format
3851 ;; string for coderefs.
3852 ;;
3853 ;; `org-export-inline-image-p' returns a non-nil value when the link
3854 ;; provided should be considered as an inline image.
3855 ;;
3856 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3857 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3858 ;; returns an appropriate unique identifier when found, or nil.
3859 ;;
3860 ;; `org-export-resolve-id-link' returns the first headline with
3861 ;; specified id or custom-id in parse tree, the path to the external
3862 ;; file with the id or nil when neither was found.
3863 ;;
3864 ;; `org-export-resolve-coderef' associates a reference to a line
3865 ;; number in the element it belongs, or returns the reference itself
3866 ;; when the element isn't numbered.
3869 "Take link text S and make a safe target out of it."
3874 "Return format string for code reference link.
3875 PATH is the link path. DESC is its description."
3883 "Non-nil if LINK object points to an inline image.
3885 Optional argument is a set of RULES defining inline images. It
3886 is an alist where associations have the following shape:
3888 \(TYPE . REGEXP)
3890 Applying a rule means apply REGEXP against LINK's path when its
3891 type is TYPE. The function will return a non-nil value if any of
3892 the provided rules is non-nil. The default rule is
3893 `org-export-default-inline-image-rule'.
3895 This only applies to links without a description."
3906 rules)
3907 ;; Return nil if no rule matched.
3908 nil))))
3911 "Resolve a code reference REF.
3913 INFO is a plist used as a communication channel.
3915 Return associated line number in source code, or REF itself,
3916 depending on src-block or example element's switches."
3923 org-coderef-label-format)))
3927 ;; Element containing REF is found. Resolve it to either
3928 ;; a label or a line number, as needed.
3938 "Return LINK destination.
3940 INFO is a plist holding contextual information.
3942 Return value can be an object, an element, or nil:
3944 - If LINK path matches a target object (i.e. <<path>>) return it.
3946 - If LINK path exactly matches the name affiliated keyword
3947 \(i.e. #+NAME: path) of an element, return that element.
3949 - If LINK path exactly matches any headline name, return that
3950 element. If more than one headline share that name, priority
3951 will be given to the one with the closest common ancestor, if
3952 any, or the first one in the parse tree otherwise.
3954 - Otherwise, return nil.
3957 significant."
3960 ;; Split PATH at white spaces so matches are space
3961 ;; insensitive.
3965 ;; First try to find a matching "<<path>>" unless user specified
3966 ;; he was looking for a headline (path starts with a "*"
3967 ;; character).
3972 path)
3973 blob))
3974 info t)))
3975 ;; Then try to find an element with a matching "#+NAME: path"
3976 ;; affiliated keyword.
3979 org-element-all-elements
3984 ;; Last case: link either points to a headline or to nothingness.
3985 ;; Try to find the source, with priority given to headlines with
3986 ;; the closest common ancestor. If such candidate is found,
3987 ;; return it, otherwise return nil.
3991 ;; Return first headline whose `:raw-value' property is
3992 ;; NAME in parse tree DATA, or nil. Statistics cookies
3993 ;; are ignored.
4001 name)
4002 headline))
4004 ;; Search among headlines sharing an ancestor with link, from
4005 ;; closest to farthest.
4013 ;; No match with a common ancestor: try full parse-tree.
4017 "Return headline referenced as LINK destination.
4019 INFO is a plist used as a communication channel.
4021 Return value can be the headline element matched in current parse
4025 ;; First check if id is within the current parse tree.
4030 headline))
4032 ;; Otherwise, look for external files.
4036 "Return radio-target object referenced as LINK destination.
4038 INFO is a plist used as a communication channel.
4040 Return value can be a radio-target object or nil. Assume LINK
4047 radio))
4051 ;;;; For References
4052 ;;
4053 ;; `org-export-get-ordinal' associates a sequence number to any object
4054 ;; or element.
4057 "Return ordinal number of an element or object.
4059 ELEMENT is the element or object considered. INFO is the plist
4060 used as a communication channel.
4062 Optional argument TYPES, when non-nil, is a list of element or
4063 object types, as symbols, that should also be counted in.
4064 Otherwise, only provided element's type is considered.
4066 Optional argument PREDICATE is a function returning a non-nil
4067 value if the current element or object should be counted in. It
4068 accepts two arguments: the element or object being considered and
4069 the plist used as a communication channel. This allows to count
4070 only a certain type of objects (i.e. inline images).
4072 Return value is a list of numbers if ELEMENT is a headline or an
4073 item. It is nil for keywords. It represents the footnote number
4074 for footnote definitions and footnote references. If ELEMENT is
4075 a target, return the same value as if ELEMENT was the closest
4076 table, item or headline containing the target. In any other
4077 case, return the sequence number of ELEMENT among elements or
4078 objects of the same type."
4079 ;; Ordinal of a target object refer to the ordinal of the closest
4080 ;; table, item, or headline containing the object.
4084 when
4088 table))
4089 return parent)))
4091 ;; Special case 1: A headline returns its number as a list.
4093 ;; Special case 2: An item returns its number as a list.
4097 struct
4104 ;; Increment counter until ELEMENT is found again.
4115 ;;;; For Src-Blocks
4116 ;;
4117 ;; `org-export-get-loc' counts number of code lines accumulated in
4118 ;; src-block or example-block elements with a "+n" switch until
4119 ;; a given element, excluded. Note: "-n" switches reset that count.
4120 ;;
4121 ;; `org-export-unravel-code' extracts source code (along with a code
4122 ;; references alist) from an `element-block' or `src-block' type
4123 ;; element.
4124 ;;
4125 ;; `org-export-format-code' applies a formatting function to each line
4126 ;; of code, providing relative line number and code reference when
4127 ;; appropriate. Since it doesn't access the original element from
4128 ;; which the source code is coming, it expects from the code calling
4129 ;; it to know if lines should be numbered and if code references
4130 ;; should appear.
4131 ;;
4132 ;; Eventually, `org-export-format-code-default' is a higher-level
4133 ;; function (it makes use of the two previous functions) which handles
4134 ;; line numbering and code references inclusion, and returns source
4135 ;; code in a format suitable for plain text or verbatim output.
4138 "Return accumulated lines of code up to ELEMENT.
4140 INFO is the plist used as a communication channel.
4142 ELEMENT is excluded from count."
4148 ;; ELEMENT is reached: Quit the loop.
4150 ;; Only count lines from src-block and example-block elements
4151 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4155 ;; Accumulate locs or reset them.
4159 ;; Return nil to stay in the loop.
4160 nil)))
4162 ;; Return value.
4163 loc))
4166 "Clean source code and extract references out of it.
4168 ELEMENT has either a `src-block' an `example-block' type.
4170 Return a cons cell whose CAR is the source code, cleaned from any
4171 reference and protective comma and CDR is an alist between
4172 relative line number (integer) and name of code reference on that
4173 line (string)."
4175 ;; Get code and clean it. Remove blank lines at its
4176 ;; beginning and end.
4182 ;; If appropriate, remove global indentation.
4185 c
4187 ;; Get format used for references.
4190 org-coderef-label-format)))
4191 ;; Build a regexp matching a loc with a reference.
4196 ;; Return value.
4198 ;; Code with references removed.
4204 ;; Ref line: remove ref, and signal its position in REFS.
4208 ;; Reference alist.
4209 refs)))
4212 "Format CODE by applying FUN line-wise and return it.
4214 CODE is a string representing the code to format. FUN is
4215 a function. It must accept three arguments: a line of
4216 code (string), the current line number (integer) or nil and the
4217 reference associated to the current line (string) or nil.
4219 Optional argument NUM-LINES can be an integer representing the
4220 number of code lines accumulated until the current code. Line
4221 numbers passed to FUN will take it into account. If it is nil,
4222 FUN's second argument will always be nil. This number can be
4223 obtained with `org-export-get-loc' function.
4225 Optional argument REF-ALIST can be an alist between relative line
4226 number (i.e. ignoring NUM-LINES) and the name of the code
4227 reference on it. If it is nil, FUN's third argument will always
4228 be nil. It can be obtained through the use of
4229 `org-export-unravel-code' function."
4241 "Return source code from ELEMENT, formatted in a standard way.
4243 ELEMENT is either a `src-block' or `example-block' element. INFO
4244 is a plist used as a communication channel.
4246 This function takes care of line numbering and code references
4247 inclusion. Line numbers, when applicable, appear at the
4248 beginning of the line, separated from the code by two white
4249 spaces. Code references, on the other hand, appear flushed to
4250 the right, separated by six white spaces from the widest line of
4251 code."
4252 ;; Extract code and references.
4259 ;; Handle line numbering.
4268 ;; Prepare references display, if required. Any reference
4269 ;; should start six columns after the widest line of code,
4270 ;; wrapped with parenthesis.
4275 code
4279 number-str
4280 loc
4286 num-start refs)))))
4289 ;;;; For Tables
4290 ;;
4291 ;; `org-export-table-has-special-column-p' and and
4292 ;; `org-export-table-row-is-special-p' are predicates used to look for
4293 ;; meta-information about the table structure.
4294 ;;
4295 ;; `org-table-has-header-p' tells when the rows before the first rule
4296 ;; should be considered as table's header.
4297 ;;
4298 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4299 ;; and `org-export-table-cell-borders' extract information from
4300 ;; a table-cell element.
4301 ;;
4302 ;; `org-export-table-dimensions' gives the number on rows and columns
4303 ;; in the table, ignoring horizontal rules and special columns.
4304 ;; `org-export-table-cell-address', given a table-cell object, returns
4305 ;; the absolute address of a cell. On the other hand,
4306 ;; `org-export-get-table-cell-at' does the contrary.
4307 ;;
4308 ;; `org-export-table-cell-starts-colgroup-p',
4309 ;; `org-export-table-cell-ends-colgroup-p',
4310 ;; `org-export-table-row-starts-rowgroup-p',
4311 ;; `org-export-table-row-ends-rowgroup-p',
4312 ;; `org-export-table-row-starts-header-p' and
4313 ;; `org-export-table-row-ends-header-p' indicate position of current
4314 ;; row or cell within the table.
4317 "Non-nil when TABLE has a special column.
4318 All special columns will be ignored during export."
4319 ;; The table has a special column when every first cell of every row
4320 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4321 ;; "*" "_" and "^". Though, do not consider a first row containing
4322 ;; only empty cells as special.
4338 "Non-nil when TABLE has a header.
4340 INFO is a plist used as a communication channel.
4342 A table has a header when it contains at least two row groups."
4352 info)))
4355 "Non-nil if TABLE-ROW is considered special.
4357 INFO is a plist used as the communication channel.
4359 All special rows will be ignored during export."
4363 ;; A row is special either when...
4365 ;; ... it starts with a field only containing "/",
4367 ;; ... the table contains a special column and the row start
4368 ;; with a marking character among, "^", "_", "$" or "!",
4372 ;; ... it contains only alignment cookies and empty cells.
4378 ;; Since VALUE is a secondary string, the following
4379 ;; checks avoid expanding it with `org-export-data'.
4391 "Return TABLE-ROW's group.
4393 INFO is a plist used as the communication channel.
4395 Return value is the group number, as an integer, or nil for
4396 special rows and table rules. Group 1 is also table's header."
4413 "Return TABLE-CELL contents width.
4415 INFO is a plist used as the communication channel.
4417 Return value is the width given by the last width cookie in the
4418 same column as TABLE-CELL, or nil."
4423 cookie-width)
4427 ;; In a special row, try to find a width cookie at COLUMN.
4431 ;; The following checks avoid expanding unnecessarily the
4432 ;; cell with `org-export-data'
4440 ;; Ignore table rules.
4443 ;; Return value.
4444 cookie-width))
4447 "Return TABLE-CELL contents alignment.
4449 INFO is a plist used as the communication channel.
4451 Return alignment as specified by the last alignment cookie in the
4452 same column as TABLE-CELL. If no such cookie is found, a default
4453 alignment value will be deduced from fraction of numbers in the
4454 column (see `org-table-number-fraction' for more information).
4455 Possible values are `left', `right' and `center'."
4462 cookie-align
4463 previous-cell-number-p)
4467 ;; In a special row, try to find an alignment cookie at
4468 ;; COLUMN.
4472 ;; Since VALUE is a secondary string, the following checks
4473 ;; avoid useless expansion through `org-export-data'.
4481 ;; Ignore table rules.
4483 ;; In a standard row, check if cell's contents are expressing
4484 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4485 ;; Though, don't bother if an alignment cookie has already
4486 ;; defined cell's alignment.
4491 info)))
4493 ;; Treat an empty cell as a number if it follows a number
4500 ;; Return value. Alignment specified by cookies has precedence
4501 ;; over alignment deduced from cells contents.
4510 "Return TABLE-CELL borders.
4512 INFO is a plist used as a communication channel.
4514 Return value is a list of symbols, or nil. Possible values are:
4515 `top', `bottom', `above', `below', `left' and `right'. Note:
4516 `top' (resp. `bottom') only happen for a cell in the first
4517 row (resp. last row) of the table, ignoring table rules, if any.
4519 Returned borders ignore special rows."
4522 borders)
4523 ;; Top/above border? TABLE-CELL has a border above when a rule
4524 ;; used to demarcate row groups can be found above. Hence,
4525 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4526 ;; another regular row has to be found above that rule.
4535 ;; Look at every row before the current one.
4537 ;; No rule above, or rule found starts the table (ignoring any
4538 ;; special row): TABLE-CELL is at the top of the table.
4541 ;; Bottom/below border? TABLE-CELL has a border below when next
4542 ;; non-regular row below is a rule.
4551 ;; Look at every row after the current one.
4553 ;; No rule below, or rule found ends the table (modulo some
4554 ;; special row): TABLE-CELL is at the bottom of the table.
4557 ;; Right/left borders? They can only be specified by column
4558 ;; groups. Column groups are defined in a row starting with "/".
4559 ;; Also a column groups row only contains "<", "<>", ">" or blank
4560 ;; cells.
4577 ;; There's a left border when previous cell, if
4578 ;; any, ends a group, or current one starts one.
4584 ;; There's a right border when next cell, if any,
4585 ;; starts a group, or current one ends one.
4592 ;; Table rows are read in reverse order so last column groups
4593 ;; row has precedence over any previous one.
4595 ;; Return value.
4596 borders))
4599 "Non-nil when TABLE-CELL is at the beginning of a row group.
4600 INFO is a plist used as a communication channel."
4601 ;; A cell starts a column group either when it is at the beginning
4602 ;; of a row (or after the special column, if any) or when it has
4603 ;; a left border.
4606 table-cell)
4610 "Non-nil when TABLE-CELL is at the end of a row group.
4611 INFO is a plist used as a communication channel."
4612 ;; A cell ends a column group either when it is at the end of a row
4613 ;; or when it has a right border.
4616 table-cell)
4620 "Non-nil when TABLE-ROW is at the beginning of a column group.
4621 INFO is a plist used as a communication channel."
4629 "Non-nil when TABLE-ROW is at the end of a column group.
4630 INFO is a plist used as a communication channel."
4638 "Non-nil when TABLE-ROW is the first table header's row.
4639 INFO is a plist used as a communication channel."
4646 "Non-nil when TABLE-ROW is the last table header's row.
4647 INFO is a plist used as a communication channel."
4654 "Return TABLE-ROW number.
4655 INFO is a plist used as a communication channel. Return value is
4656 zero-based and ignores separators. The function returns nil for
4657 special colums and separators."
4669 "Return TABLE dimensions.
4671 INFO is a plist used as a communication channel.
4673 Return value is a CONS like (ROWS . COLUMNS) where
4674 ROWS (resp. COLUMNS) is the number of exportable
4675 rows (resp. columns)."
4677 ;; Set number of rows, and extract first one.
4683 ;; Set number of columns.
4685 ;; Return value.
4689 "Return address of a regular TABLE-CELL object.
4691 TABLE-CELL is the cell considered. INFO is a plist used as
4692 a communication channel.
4694 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4695 zero-based index. Only exportable cells are considered. The
4696 function returns nil for other cells."
4699 ;; Ignore cells in special rows or in special column.
4704 ;; Row number.
4706 ;; Column number.
4714 "Return regular table-cell object at ADDRESS in TABLE.
4716 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4717 zero-based index. TABLE is a table type element. INFO is
4718 a plist used as a communication channel.
4720 If no table-cell, among exportable cells, is found at ADDRESS,
4721 return nil."
4724 ;; Row at (car address) or nil.
4732 'table-cell
4739 ;;;; For Tables Of Contents
4740 ;;
4741 ;; `org-export-collect-headlines' builds a list of all exportable
4742 ;; headline elements, maybe limited to a certain depth. One can then
4743 ;; easily parse it and transcode it.
4744 ;;
4745 ;; Building lists of tables, figures or listings is quite similar.
4746 ;; Once the generic function `org-export-collect-elements' is defined,
4747 ;; `org-export-collect-tables', `org-export-collect-figures' and
4748 ;; `org-export-collect-listings' can be derived from it.
4751 "Collect headlines in order to build a table of contents.
4753 INFO is a plist used as a communication channel.
4755 When optional argument N is an integer, it specifies the depth of
4756 the table of contents. Otherwise, it is set to the value of the
4757 last headline level. See `org-export-headline-levels' for more
4758 information.
4760 Return a list of all exportable headlines as parsed elements.
4761 Footnote sections, if any, will be ignored."
4766 ;; Strip contents from HEADLINE.
4769 info))
4772 "Collect referenceable elements of a determined type.
4774 TYPE can be a symbol or a list of symbols specifying element
4775 types to search. Only elements with a caption are collected.
4777 INFO is a plist used as a communication channel.
4779 When non-nil, optional argument PREDICATE is a function accepting
4780 one argument, an element of type TYPE. It returns a non-nil
4781 value when that element should be collected.
4783 Return a list of all elements found, in order of appearance."
4788 element))
4789 info))
4792 "Build a list of tables.
4793 INFO is a plist used as a communication channel.
4795 Return a list of table elements with a caption."
4799 "Build a list of figures.
4801 INFO is a plist used as a communication channel. PREDICATE is
4802 a function which accepts one argument: a paragraph element and
4803 whose return value is non-nil when that element should be
4804 collected.
4806 A figure is a paragraph type element, with a caption, verifying
4808 a vague concept that may depend on back-end.
4810 Return a list of elements recognized as figures."
4814 "Build a list of src blocks.
4816 INFO is a plist used as a communication channel.
4818 Return a list of src-block elements with a caption."
4822 ;;;; Smart Quotes
4823 ;;
4824 ;; The main function for the smart quotes sub-system is
4825 ;; `org-export-activate-smart-quotes', which replaces every quote in
4826 ;; a given string from the parse tree with its "smart" counterpart.
4827 ;;
4828 ;; Dictionary for smart quotes is stored in
4829 ;; `org-export-smart-quotes-alist'.
4830 ;;
4831 ;; Internally, regexps matching potential smart quotes (checks at
4832 ;; string boundaries are also necessary) are defined in
4833 ;; `org-export-smart-quotes-regexps'.
4870 "Smart quotes translations.
4872 Alist whose CAR is a language string and CDR is an alist with
4873 quote type as key and a plist associating various encodings to
4874 their translation as value.
4876 A quote type can be any symbol among `opening-double-quote',
4877 `closing-double-quote', `opening-single-quote',
4878 `closing-single-quote' and `apostrophe'.
4880 Valid encodings include `:utf-8', `:html', `:latex' and
4881 `:texinfo'.
4887 ;; Possible opening quote at beginning of string.
4889 ;; Possible closing quote at beginning of string.
4891 ;; Possible apostrophe at beginning of string.
4893 ;; Opening single and double quotes.
4895 ;; Closing single and double quotes.
4897 ;; Apostrophe.
4899 ;; Possible opening quote at end of string.
4901 ;; Possible closing quote at end of string.
4903 ;; Possible apostrophe at end of string.
4905 "List of regexps matching a quote or an apostrophe.
4911 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4912 `:utf-8'. INFO is a plist used as a communication channel.
4914 The function has to retrieve information about string
4915 surroundings in parse tree. It can only happen with an
4916 unmodified string. Thus, if S has already been through another
4917 process, a non-nil ORIGINAL optional argument will provide that
4918 original string.
4920 Return the new string."
4923 ;; Try to be flexible when computing number of blanks
4924 ;; before object. The previous object may be a string
4925 ;; introduced by the back-end and not completely parsed.
4928 ;; A string with missing `:post-blank'
4929 ;; property.
4933 ;; Fallback value.
4938 ;; Return smart quote associated to a give quote Q, as
4939 ;; a string. TYPE is a symbol among `open', `close' and
4940 ;; `apostrophe'.
4950 org-export-smart-quotes-alist))))
4951 encoding)
4952 q)))))
4954 ;; Only a quote: no regexp can match. We have to check both
4955 ;; sides and decide what to do.
4963 ;; 1. Replace quote character at the beginning of S.
4965 ;; Apostrophe?
4971 ;; Closing quote?
4977 ;; Opening quote?
4983 ;; 2. Replace quotes in the middle of the string.
4985 ;; Opening quotes.
4991 ;; Closing quotes.
4997 ;; Apostrophes.
5002 ;; 3. Replace quote character at the end of S.
5004 ;; Apostrophe?
5009 ;; Closing quote?
5015 ;; Opening quote?
5020 ;; Return string with smart quotes.
5021 s))))
5023 ;;;; Topology
5024 ;;
5025 ;; Here are various functions to retrieve information about the
5026 ;; neighbourhood of a given element or object. Neighbours of interest
5027 ;; are direct parent (`org-export-get-parent'), parent headline
5028 ;; (`org-export-get-parent-headline'), first element containing an
5029 ;; object, (`org-export-get-parent-element'), parent table
5030 ;; (`org-export-get-parent-table'), previous element or object
5031 ;; (`org-export-get-previous-element') and next element or object
5032 ;; (`org-export-get-next-element').
5033 ;;
5034 ;; `org-export-get-genealogy' returns the full genealogy of a given
5035 ;; element or object, from closest parent to full parse tree.
5038 "Return BLOB parent or nil.
5039 BLOB is the element or object considered."
5043 "Return full genealogy relative to a given element or object.
5045 BLOB is the element or object being considered.
5047 Ancestors are returned from closest to farthest, the last one
5048 being the full parse tree."
5055 "Return BLOB parent headline or nil.
5056 BLOB is the element or object being considered."
5060 parent))
5063 "Return first element containing OBJECT or nil.
5064 OBJECT is the object to consider."
5068 parent))
5071 "Return OBJECT parent table or nil.
5072 OBJECT is either a `table-cell' or `table-element' type object."
5076 parent))
5079 "Return previous element or object.
5081 BLOB is an element or object. INFO is a plist used as
5082 a communication channel. Return previous exportable element or
5083 object, a string, or nil.
5085 When optional argument N is a positive integer, return a list
5086 containing up to N siblings before BLOB, from farthest to
5087 closest. With any other non-nil value, return a list containing
5088 all of them."
5090 ;; An object can belong to the contents of its parent or
5091 ;; to a secondary string. We check the latter option
5092 ;; first.
5095 org-element-all-elements))
5099 org-element-secondary-value-alist))
5100 parent)))
5103 prev)
5112 prev)))
5115 "Return next element or object.
5117 BLOB is an element or object. INFO is a plist used as
5118 a communication channel. Return next exportable element or
5119 object, a string, or nil.
5121 When optional argument N is a positive integer, return a list
5122 containing up to N siblings after BLOB, from closest to farthest.
5123 With any other non-nil value, return a list containing all of
5124 them."
5126 ;; An object can belong to the contents of its parent or to
5127 ;; a secondary string. We check the latter option first.
5130 org-element-all-objects))
5134 org-element-secondary-value-alist))
5135 parent)))
5138 next)
5146 siblings)
5150 ;;;; Translation
5151 ;;
5152 ;; `org-export-translate' translates a string according to language
5153 ;; specified by LANGUAGE keyword or `org-export-language-setup'
5154 ;; variable and a specified charset. `org-export-dictionary' contains
5155 ;; the dictionary used for the translation.
5277 "Dictionary for export engine.
5279 Alist whose CAR is the string to translate and CDR is an alist
5280 whose CAR is the language string and CDR is a plist whose
5281 properties are possible charsets and values translated terms.
5283 It is used as a database for `org-export-translate'. Since this
5284 function returns the string as-is if no translation was found,
5285 the variable only needs to record values different from the
5289 "Translate string S according to language specification.
5291 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5292 and `:utf-8'. INFO is a plist used as a communication channel.
5294 Translation depends on `:language' property. Return the
5295 translated string. If no translation is found, try to fall back
5296 to `:default' encoding. If it fails, return S."
5302 s)))
5305 \f
5306 ;;; Asynchronous Export
5307 ;;
5308 ;; `org-export-async-start' is the entry point for asynchronous
5309 ;; export. It recreates current buffer (including visibility,
5310 ;; narrowing and visited file) in an external Emacs process, and
5311 ;; evaluates a command there. It then applies a function on the
5312 ;; returned results in the current process.
5313 ;;
5314 ;; Asynchronously generated results are never displayed directly.
5315 ;; Instead, they are stored in `org-export-stack-contents'. They can
5316 ;; then be retrieved by calling `org-export-stack'.
5317 ;;
5318 ;; Export Stack is viewed through a dedicated major mode
5319 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5320 ;;`org-export-stack-delete', `org-export-stack-view' and
5321 ;;`org-export-stack-clear'.
5322 ;;
5323 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5324 ;; It should used whenever `org-export-async-start' is called.
5327 "Call function FUN on the results returned by BODY evaluation.
5329 BODY evaluation happens in an asynchronous process, from a buffer
5330 which is an exact copy of the current one.
5332 Use `org-export-add-to-stack' in FUN in order to register results
5333 in the stack. Examples for, respectively a temporary buffer and
5334 a file are:
5336 \(org-export-async-start
5337 \(lambda (output)
5339 \(erase-buffer)
5340 \(insert output)
5341 \(goto-char (point-min))
5342 \(org-export-add-to-stack (current-buffer) 'backend)))
5343 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5345 and
5347 \(org-export-async-start
5348 \(lambda (f) (org-export-add-to-stack f 'backend))
5349 `(expand-file-name
5350 \(org-export-to-file
5351 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5354 ;; Write the full sexp evaluating BODY in a copy of the current
5355 ;; buffer to a temporary file, as it may be too long for program
5356 ;; args in `start-process'.
5363 ;; Null characters (from variable values) are inserted
5364 ;; within the file. As a consequence, coding system for
5365 ;; buffer contents will not be recognized properly. So,
5366 ;; we make sure it is the same as the one used to display
5367 ;; the original buffer.
5369 ,coding
5372 ;; Ignore `kill-emacs-hook' and code evaluation
5373 ;; queries from Babel as we need a truly
5374 ;; non-interactive process.
5376 org-babel-confirm-evaluate-answer-no t)
5377 ;; Initialize export framework.
5379 ;; Re-create current buffer there.
5382 ;; Sexp to evaluate in the buffer.
5384 ;; Start external process.
5387 (,process
5392 "-l" org-export-async-init-file
5394 ;; Register running process in stack.
5396 ;; Set-up sentinel in order to catch results.
5398 ,process
5422 "Add a new result to export stack if not present already.
5424 SOURCE is a buffer or a file name containing export results.
5425 BACKEND is a symbol representing export back-end used to generate
5426 it.
5428 Entries already pointing to SOURCE and unavailable entries are
5429 removed beforehand. Return the new stack."
5435 "Menu for asynchronous export results and running processes."
5445 "Return source from export results at point in stack."
5452 source
5453 ;; SOURCE is not consistent with current line. The stack
5454 ;; view is outdated.
5458 "Remove all entries from export stack."
5463 "Refresh the asynchronous export stack.
5464 DUMMY is ignored. Unavailable sources are removed from the list.
5465 Return the new stack."
5475 ;; Back-end.
5477 ;; Age.
5480 ;; Compute age of the results.
5482 "%4h:%.2m "
5484 ;; Source.
5489 ;; Clear stack from exited processes, dead buffers or
5490 ;; non-existent files.
5502 "Remove export results at point from stack.
5503 If optional argument SOURCE is non-nil, remove it instead."
5508 org-export-stack-contents))))
5511 "View export results at point in stack.
5512 With an optional prefix argument IN-EMACS, force viewing files
5513 within Emacs."
5527 (define-key km "p" 'previous-line)
5528 (define-key km "\C-p" 'previous-line)
5529 (define-key km "\C-?" 'previous-line)
5530 (define-key km [up] 'previous-line)
5531 (define-key km "C" 'org-export-stack-clear)
5532 (define-key km "v" 'org-export-stack-view)
5533 (define-key km (kbd "RET") 'org-export-stack-view)
5534 (define-key km "d" 'org-export-stack-remove)
5535 km)
5536 "Keymap for Org Export Stack.")
5538 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5539 "Mode for displaying asynchronous export stack.
5542 stack.
5544 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5545 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5546 stack completely.
5548 Removing entries in an Org Export Stack buffer doesn't affect
5549 files or buffers, only the display.
5552 (abbrev-mode 0)
5553 (auto-fill-mode 0)
5554 (setq buffer-read-only t
5555 buffer-undo-list t
5556 truncate-lines t
5557 header-line-format
5558 '(:eval
5559 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5560 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5561 (set (make-local-variable 'revert-buffer-function)
5562 'org-export-stack-refresh))
5565 \f
5566 ;;; The Dispatcher
5567 ;;
5568 ;; `org-export-dispatch' is the standard interactive way to start an
5569 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5570 ;; for its interface, which, in turn, delegates response to key
5571 ;; pressed to `org-export--dispatch-action'.
5573 ;;;###autoload
5574 (defun org-export-dispatch (&optional arg)
5575 "Export dispatcher for Org mode.
5577 It provides an access to common export related tasks in a buffer.
5578 Its interface comes in two flavours: standard and expert.
5580 While both share the same set of bindings, only the former
5581 displays the valid keys associations in a dedicated buffer.
5582 Scrolling (resp. line-wise motion) in this buffer is done with
5583 SPC and DEL (resp. C-n and C-p) keys.
5585 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5586 flavour or the other.
5589 of options used back then, on the current buffer.
5591 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5592 (interactive "P")
5593 (let* ((input
5594 (cond ((equal arg '(16)) '(stack))
5595 ((and arg org-export-dispatch-last-action))
5596 (t (save-window-excursion
5597 (unwind-protect
5598 (progn
5599 ;; Remember where we are
5600 (move-marker org-export-dispatch-last-position
5601 (point)
5602 (org-base-buffer (current-buffer)))
5603 ;; Get and store an export command
5604 (setq org-export-dispatch-last-action
5605 (org-export--dispatch-ui
5606 (list org-export-initial-scope
5607 (and org-export-in-background 'async))
5608 nil
5609 org-export-dispatch-use-expert-ui)))
5610 (and (get-buffer "*Org Export Dispatcher*")
5611 (kill-buffer "*Org Export Dispatcher*")))))))
5612 (action (car input))
5613 (optns (cdr input)))
5614 (unless (memq 'subtree optns)
5615 (move-marker org-export-dispatch-last-position nil))
5616 (case action
5617 ;; First handle special hard-coded actions.
5618 (template (org-export-insert-default-template nil optns))
5619 (stack (org-export-stack))
5620 (publish-current-file
5621 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5622 (publish-current-project
5623 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5624 (publish-choose-project
5625 (org-publish (assoc (org-icompleting-read
5626 "Publish project: "
5627 org-publish-project-alist nil t)
5628 org-publish-project-alist)
5629 (memq 'force optns)
5630 (memq 'async optns)))
5631 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5632 (otherwise
5633 (save-excursion
5634 (when arg
5635 ;; Repeating command, maybe move cursor to restore subtree
5636 ;; context.
5637 (if (eq (marker-buffer org-export-dispatch-last-position)
5638 (org-base-buffer (current-buffer)))
5639 (goto-char org-export-dispatch-last-position)
5640 ;; We are in a different buffer, forget position.
5641 (move-marker org-export-dispatch-last-position nil)))
5642 (funcall action
5643 ;; Return a symbol instead of a list to ease
5644 ;; asynchronous export macro use.
5645 (and (memq 'async optns) t)
5646 (and (memq 'subtree optns) t)
5647 (and (memq 'visible optns) t)
5648 (and (memq 'body optns) t)))))))
5650 (defun org-export--dispatch-ui (options first-key expertp)
5651 "Handle interface for `org-export-dispatch'.
5653 OPTIONS is a list containing current interactive options set for
5654 export. It can contain any of the following symbols:
5655 `body' toggles a body-only export
5656 `subtree' restricts export to current subtree
5657 `visible' restricts export to visible part of buffer.
5658 `force' force publishing files.
5659 `async' use asynchronous export process
5661 FIRST-KEY is the key pressed to select the first level menu. It
5662 is nil when this menu hasn't been selected yet.
5664 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5665 buffer is provided, but indications about currently active
5666 options are given in the prompt. Moreover, \[?] allows to switch
5667 back to standard interface."
5668 (let* ((fontify-key
5669 (lambda (key &optional access-key)
5670 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5671 ;; non-nil is the required first-level key to activate
5672 ;; KEY. When its value is t, activate KEY independently
5673 ;; on the first key, if any. A nil value means KEY will
5674 ;; only be activated at first level.
5675 (if (or (eq access-key t) (eq access-key first-key))
5676 (org-propertize key 'face 'org-warning)
5677 key)))
5678 (fontify-value
5679 (lambda (value)
5680 ;; Fontify VALUE string.
5681 (org-propertize value 'face 'font-lock-variable-name-face)))
5682 ;; Prepare menu entries by extracting them from
5683 ;; `org-export-registered-backends', and sorting them by
5684 ;; access key and by ordinal, if any.
5685 (backends
5686 (sort
5687 (sort
5688 (delq nil
5689 (mapcar
5690 (lambda (b)
5691 (let ((name (car b)))
5692 (catch 'ignored
5693 ;; Ignore any back-end belonging to
5694 ;; `org-export-invisible-backends' or derived
5695 ;; from one of them.
5696 (dolist (ignored org-export-invisible-backends)
5697 (when (org-export-derived-backend-p name ignored)
5698 (throw 'ignored nil)))
5699 (org-export-backend-menu name))))
5700 org-export-registered-backends))
5701 (lambda (a b)
5702 (let ((key-a (nth 1 a))
5703 (key-b (nth 1 b)))
5704 (cond ((and (numberp key-a) (numberp key-b))
5705 (< key-a key-b))
5706 ((numberp key-b) t)))))
5707 (lambda (a b) (< (car a) (car b)))))
5708 ;; Compute a list of allowed keys based on the first key
5709 ;; pressed, if any. Some keys
5710 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
5711 ;; available.
5712 (allowed-keys
5713 (nconc (list 2 22 19 6 1)
5714 (if (not first-key) (org-uniquify (mapcar 'car backends))
5715 (let (sub-menu)
5716 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5717 (when (eq (car backend) first-key)
5718 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5719 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5720 ((not first-key) (list ?P)))
5721 (list ?& ?#)
5722 (when expertp (list ??))
5723 (list ?q)))
5724 ;; Build the help menu for standard UI.
5725 (help
5726 (unless expertp
5727 (concat
5728 ;; Options are hard-coded.
5729 (format "[%s] Body only: %s [%s] Visible only: %s
5730 \[%s] Export scope: %s [%s] Force publishing: %s
5732 (funcall fontify-key "C-b" t)
5733 (funcall fontify-value
5734 (if (memq 'body options) "On " "Off"))
5735 (funcall fontify-key "C-v" t)
5736 (funcall fontify-value
5737 (if (memq 'visible options) "On " "Off"))
5738 (funcall fontify-key "C-s" t)
5739 (funcall fontify-value
5740 (if (memq 'subtree options) "Subtree" "Buffer "))
5741 (funcall fontify-key "C-f" t)
5742 (funcall fontify-value
5743 (if (memq 'force options) "On " "Off"))
5744 (funcall fontify-key "C-a" t)
5745 (funcall fontify-value
5746 (if (memq 'async options) "On " "Off")))
5747 ;; Display registered back-end entries. When a key
5748 ;; appears for the second time, do not create another
5749 ;; entry, but append its sub-menu to existing menu.
5750 (let (last-key)
5751 (mapconcat
5752 (lambda (entry)
5753 (let ((top-key (car entry)))
5754 (concat
5755 (unless (eq top-key last-key)
5756 (setq last-key top-key)
5758 (funcall fontify-key (char-to-string top-key))
5759 (nth 1 entry)))
5760 (let ((sub-menu (nth 2 entry)))
5761 (unless (functionp sub-menu)
5762 ;; Split sub-menu into two columns.
5763 (let ((index -1))
5764 (concat
5765 (mapconcat
5766 (lambda (sub-entry)
5767 (incf index)
5768 (format
5769 (if (zerop (mod index 2)) " [%s] %-26s"
5771 (funcall fontify-key
5772 (char-to-string (car sub-entry))
5773 top-key)
5774 (nth 1 sub-entry)))
5775 sub-menu "")
5777 backends ""))
5778 ;; Publishing menu is hard-coded.
5780 [%s] Current file [%s] Current project
5782 (funcall fontify-key "P")
5783 (funcall fontify-key "f" ?P)
5784 (funcall fontify-key "p" ?P)
5785 (funcall fontify-key "x" ?P)
5786 (funcall fontify-key "a" ?P))
5788 (funcall fontify-key "&" t)
5789 (funcall fontify-key "#" t))
5790 (format "[%s] %s"
5791 (funcall fontify-key "q" t)
5792 (if first-key "Main menu" "Exit")))))
5793 ;; Build prompts for both standard and expert UI.
5794 (standard-prompt (unless expertp "Export command: "))
5795 (expert-prompt
5796 (when expertp
5797 (format
5798 "Export command (C-%s%s%s%s%s) [%s]: "
5799 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5800 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5801 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5802 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5803 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5804 (mapconcat (lambda (k)
5805 ;; Strip control characters.
5806 (unless (< k 27) (char-to-string k)))
5807 allowed-keys "")))))
5808 ;; With expert UI, just read key with a fancy prompt. In standard
5809 ;; UI, display an intrusive help buffer.
5810 (if expertp
5811 (org-export--dispatch-action
5812 expert-prompt allowed-keys backends options first-key expertp)
5813 ;; At first call, create frame layout in order to display menu.
5814 (unless (get-buffer "*Org Export Dispatcher*")
5815 (delete-other-windows)
5816 (org-switch-to-buffer-other-window
5817 (get-buffer-create "*Org Export Dispatcher*"))
5818 (setq cursor-type nil
5819 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
5820 ;; Make sure that invisible cursor will not highlight square
5821 ;; brackets.
5822 (set-syntax-table (copy-syntax-table))
5823 (modify-syntax-entry ?\[ "w"))
5824 ;; At this point, the buffer containing the menu exists and is
5825 ;; visible in the current window. So, refresh it.
5826 (with-current-buffer "*Org Export Dispatcher*"
5827 ;; Refresh help. Maintain display continuity by re-visiting
5828 ;; previous window position.
5829 (let ((pos (window-start)))
5830 (erase-buffer)
5831 (insert help)
5832 (set-window-start nil pos)))
5833 (org-fit-window-to-buffer)
5834 (org-export--dispatch-action
5835 standard-prompt allowed-keys backends options first-key expertp))))
5837 (defun org-export--dispatch-action
5838 (prompt allowed-keys backends options first-key expertp)
5839 "Read a character from command input and act accordingly.
5841 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5842 a list of characters available at a given step in the process.
5843 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5844 EXPERTP are the same as defined in `org-export--dispatch-ui',
5845 which see.
5847 Toggle export options when required. Otherwise, return value is
5848 a list with action as CAR and a list of interactive export
5849 options as CDR."
5850 (let (key)
5851 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
5852 ;; C-p, SPC, DEL).
5853 (while (and (setq key (read-char-exclusive prompt))
5854 (not expertp)
5855 (memq key '(14 16 ?\s ?\d)))
5856 (case key
5857 (14 (if (not (pos-visible-in-window-p (point-max)))
5858 (ignore-errors (scroll-up-line))
5859 (message "End of buffer")
5860 (sit-for 1)))
5861 (16 (if (not (pos-visible-in-window-p (point-min)))
5862 (ignore-errors (scroll-down-line))
5863 (message "Beginning of buffer")
5864 (sit-for 1)))
5865 (?\s (if (not (pos-visible-in-window-p (point-max)))
5866 (scroll-up nil)
5867 (message "End of buffer")
5868 (sit-for 1)))
5869 (?\d (if (not (pos-visible-in-window-p (point-min)))
5870 (scroll-down nil)
5871 (message "Beginning of buffer")
5872 (sit-for 1)))))
5873 (cond
5874 ;; Ignore undefined associations.
5875 ((not (memq key allowed-keys))
5876 (ding)
5877 (unless expertp (message "Invalid key") (sit-for 1))
5878 (org-export--dispatch-ui options first-key expertp))
5879 ;; q key at first level aborts export. At second level, cancel
5880 ;; first key instead.
5881 ((eq key ?q) (if (not first-key) (error "Export aborted")
5882 (org-export--dispatch-ui options nil expertp)))
5883 ;; Help key: Switch back to standard interface if expert UI was
5884 ;; active.
5885 ((eq key ??) (org-export--dispatch-ui options first-key nil))
5886 ;; Send request for template insertion along with export scope.
5887 ((eq key ?#) (cons 'template (memq 'subtree options)))
5888 ;; Switch to asynchronous export stack.
5889 ((eq key ?&) '(stack))
5890 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
5891 ((memq key '(2 22 19 6 1))
5892 (org-export--dispatch-ui
5893 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
5894 (6 'force) (1 'async))))
5895 (if (memq option options) (remq option options)
5896 (cons option options)))
5897 first-key expertp))
5898 ;; Action selected: Send key and options back to
5899 ;; `org-export-dispatch'.
5900 ((or first-key (functionp (nth 2 (assq key backends))))
5901 (cons (cond
5902 ((not first-key) (nth 2 (assq key backends)))
5903 ;; Publishing actions are hard-coded. Send a special
5904 ;; signal to `org-export-dispatch'.
5905 ((eq first-key ?P)
5906 (case key
5907 (?f 'publish-current-file)
5908 (?p 'publish-current-project)
5909 (?x 'publish-choose-project)
5910 (?a 'publish-all)))
5911 ;; Return first action associated to FIRST-KEY + KEY
5912 ;; path. Indeed, derived backends can share the same
5913 ;; FIRST-KEY.
5914 (t (catch 'found
5915 (mapc (lambda (backend)
5916 (let ((match (assq key (nth 2 backend))))
5917 (when match (throw 'found (nth 2 match)))))
5918 (member (assq first-key backends) backends)))))
5919 options))
5920 ;; Otherwise, enter sub-menu.
5921 (t (org-export--dispatch-ui options key expertp)))))
5925 (provide 'ox)
5927 ;; Local variables:
5928 ;; generated-autoload-file: "org-loaddefs.el"
5929 ;; End:
5931 ;;; ox.el ends here