| blob | abdc636782efcbee7c1f7c789215029589a162e9 |
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 any of the following values:
730 t export all timestamps.
731 `active' export active timestamps only.
732 `inactive' export inactive timestamps only.
733 nil do not export timestamps
735 This only applies to timestamps isolated in a paragraph
736 containing only timestamps. Other timestamps are always
737 exported.
739 This option can also be set with the OPTIONS keyword, e.g.
749 "Non-nil means include TODO keywords in export.
750 When nil, remove all these keywords from the export. This option
756 "Non-nil means BIND keywords can define local variable values.
757 This is a potential security risk, which is why the default value
758 is nil. You can also allow them through local buffer variables."
765 "Alist between export snippets back-ends and exporter back-ends.
767 This variable allows to provide shortcuts for export snippets.
771 HTML code while every other back-end will ignore it."
780 "Coding system for the exported file."
787 "Should we push exported content to the kill ring?"
796 "The initial scope when exporting with `org-export-dispatch'.
797 This variable can be either set to `buffer' or `subtree'."
804 "Non-nil means show buffer after exporting to temp buffer.
805 When Org exports to a file, the buffer visiting that file is ever
806 shown, but remains buried. However, when exporting to
807 a temporary buffer, that buffer is popped up in a second window.
808 When this variable is nil, the buffer remains buried also in
809 these cases."
814 "Non-nil means export and publishing commands will run in background.
815 Results from an asynchronous export are never displayed
823 "File used to initialize external export process.
824 Value must be an absolute file name. It defaults to user's
825 initialization file. Though, a specific configuration makes the
826 process faster and the export more portable."
833 "List of back-ends that shouldn't appear in the dispatcher.
835 Any back-end belonging to this list or derived from a back-end
836 belonging to it will not appear in the dispatcher menu.
838 Indeed, Org may require some export back-ends without notice. If
839 these modules are never to be used interactively, adding them
840 here will avoid cluttering the dispatcher menu."
847 "Non-nil means using a non-intrusive `org-export-dispatch'.
848 In that case, no help buffer is displayed. Though, an indicator
854 asynchronous). Also, \[?] allows to switch back to standard
855 mode."
862 \f
863 ;;; Defining Back-ends
864 ;;
865 ;; `org-export-define-backend' is the standard way to define an export
866 ;; back-end. It allows to specify translators, filters, buffer
867 ;; options and a menu entry. If the new back-end shares translators
868 ;; with another back-end, `org-export-define-derived-backend' may be
869 ;; used instead.
870 ;;
871 ;; Internally, a back-end is stored as a list, of which CAR is the
872 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
873 ;; properties of a given back-end are: `org-export-backend-filters',
874 ;; `org-export-backend-menu', `org-export-backend-options' and
875 ;; `org-export-backend-translate-table'.
876 ;;
877 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
878 ;; when a given back-end hasn't been registered yet.
881 "Define a new back-end BACKEND.
883 TRANSLATORS is an alist between object or element types and
884 functions handling them.
886 These functions should return a string without any trailing
887 space, or nil. They must accept three arguments: the object or
888 element itself, its contents or nil when it isn't recursive and
889 the property list used as a communication channel.
891 Contents, when not nil, are stripped from any global indentation
892 \(although the relative one is preserved). They also always end
893 with a single newline character.
895 If, for a given type, no function is found, that element or
896 object type will simply be ignored, along with any blank line or
897 white space at its end. The same will happen if the function
898 returns the nil value. If that function returns the empty
899 string, the type will be ignored, but the blank lines or white
900 spaces will be kept.
902 In addition to element and object types, one function can be
903 associated to the `template' (or `inner-template') symbol and
904 another one to the `plain-text' symbol.
906 The former returns the final transcoded string, and can be used
907 to add a preamble and a postamble to document's body. It must
908 accept two arguments: the transcoded string and the property list
909 containing export options. A function associated to `template'
911 A function associated to `inner-template' is always applied.
913 The latter, when defined, is to be called on every text not
914 recognized as an element or an object. It must accept two
915 arguments: the text string and the information channel. It is an
916 appropriate place to protect special chars relative to the
917 back-end.
919 BODY can start with pre-defined keyword arguments. The following
920 keywords are understood:
922 :export-block
924 String, or list of strings, representing block names that
925 will not be parsed. This is used to specify blocks that will
926 contain raw code specific to the back-end. These blocks
927 still have to be handled by the relative `export-block' type
928 translator.
930 :filters-alist
932 Alist between filters and function, or list of functions,
933 specific to the back-end. See `org-export-filters-alist' for
934 a list of all allowed filters. Filters defined here
935 shouldn't make a back-end test, as it may prevent back-ends
936 derived from this one to behave properly.
938 :menu-entry
940 Menu entry for the export dispatcher. It should be a list
941 like:
943 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
945 where :
947 KEY is a free character selecting the back-end.
949 DESCRIPTION-OR-ORDINAL is either a string or a number.
951 If it is a string, is will be used to name the back-end in
952 its menu entry. If it is a number, the following menu will
953 be displayed as a sub-menu of the back-end with the same
954 KEY. Also, the number will be used to determine in which
955 order such sub-menus will appear (lowest first).
957 ACTION-OR-MENU is either a function or an alist.
959 If it is an action, it will be called with four
960 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
961 BODY-ONLY. See `org-export-as' for further explanations on
962 some of them.
964 If it is an alist, associations should follow the
965 pattern:
967 '(KEY DESCRIPTION ACTION)
969 where KEY, DESCRIPTION and ACTION are described above.
971 Valid values include:
975 or
980 \(lambda (a s v b)
981 \(if a (org-latex-export-to-pdf t s v b)
982 \(org-open-file
983 \(org-latex-export-to-pdf nil s v b)))))))
985 or the following, which will be added to the previous
986 sub-menu,
988 '(?l 1
992 :options-alist
994 Alist between back-end specific properties introduced in
995 communication channel and how their value are acquired. See
996 `org-export-options-alist' for more information about
997 structure of the values."
1014 ;; Register back-end.
1018 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1024 export-block))))
1027 "Create a new back-end as a variant of an existing one.
1029 CHILD is the name of the derived back-end. PARENT is the name of
1030 the parent back-end.
1032 BODY can start with pre-defined keyword arguments. The following
1033 keywords are understood:
1035 :export-block
1037 String, or list of strings, representing block names that
1038 will not be parsed. This is used to specify blocks that will
1039 contain raw code specific to the back-end. These blocks
1040 still have to be handled by the relative `export-block' type
1041 translator.
1043 :filters-alist
1045 Alist of filters that will overwrite or complete filters
1046 defined in PARENT back-end. See `org-export-filters-alist'
1047 for a list of allowed filters.
1049 :menu-entry
1051 Menu entry for the export dispatcher. See
1052 `org-export-define-backend' for more information about the
1053 expected value.
1055 :options-alist
1057 Alist of back-end specific properties that will overwrite or
1058 complete those defined in PARENT back-end. Refer to
1059 `org-export-options-alist' for more information about
1060 structure of the values.
1062 :translate-alist
1064 Alist of element and object types and transcoders that will
1065 overwrite or complete transcode table from PARENT back-end.
1066 Refer to `org-export-define-backend' for detailed information
1067 about transcoders.
1070 as a variant of `latex' back-end with a custom template function:
1072 \(org-export-define-derived-backend 'my-latex 'latex
1073 :translate-alist '((template . my-latex-template-fun)))
1075 The back-end could then be called with, for example:
1101 ;; Register back-end.
1105 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1111 export-block))))
1114 "Return back-end from which BACKEND is derived, or nil."
1118 "Return filters for BACKEND."
1123 "Return menu entry for BACKEND."
1128 "Return export options for BACKEND."
1133 "Return translate table for BACKEND."
1138 "Signal an error if BACKEND isn't defined."
1143 "Non-nil if BACKEND is derived from one of BACKENDS."
1147 parent))
1150 \f
1151 ;;; The Communication Channel
1152 ;;
1153 ;; During export process, every function has access to a number of
1154 ;; properties. They are of two types:
1155 ;;
1156 ;; 1. Environment options are collected once at the very beginning of
1157 ;; the process, out of the original buffer and configuration.
1158 ;; Collecting them is handled by `org-export-get-environment'
1159 ;; function.
1160 ;;
1161 ;; Most environment options are defined through the
1162 ;; `org-export-options-alist' variable.
1163 ;;
1164 ;; 2. Tree properties are extracted directly from the parsed tree,
1165 ;; just before export, by `org-export-collect-tree-properties'.
1166 ;;
1167 ;; Here is the full list of properties available during transcode
1168 ;; process, with their category and their value type.
1169 ;;
1170 ;; + `:author' :: Author's name.
1171 ;; - category :: option
1172 ;; - type :: string
1173 ;;
1174 ;; + `:back-end' :: Current back-end used for transcoding.
1175 ;; - category :: tree
1176 ;; - type :: symbol
1177 ;;
1178 ;; + `:creator' :: String to write as creation information.
1179 ;; - category :: option
1180 ;; - type :: string
1181 ;;
1182 ;; + `:date' :: String to use as date.
1183 ;; - category :: option
1184 ;; - type :: string
1185 ;;
1186 ;; + `:description' :: Description text for the current data.
1187 ;; - category :: option
1188 ;; - type :: string
1189 ;;
1190 ;; + `:email' :: Author's email.
1191 ;; - category :: option
1192 ;; - type :: string
1193 ;;
1194 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1195 ;; process.
1196 ;; - category :: option
1197 ;; - type :: list of strings
1198 ;;
1199 ;; + `:export-options' :: List of export options available for current
1200 ;; process.
1201 ;; - category :: none
1202 ;; - type :: list of symbols, among `subtree', `body-only' and
1203 ;; `visible-only'.
1204 ;;
1205 ;; + `:exported-data' :: Hash table used for memoizing
1206 ;; `org-export-data'.
1207 ;; - category :: tree
1208 ;; - type :: hash table
1209 ;;
1210 ;; + `:filetags' :: List of global tags for buffer. Used by
1211 ;; `org-export-get-tags' to get tags with inheritance.
1212 ;; - category :: option
1213 ;; - type :: list of strings
1214 ;;
1215 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1216 ;; their definition, as parsed data. Only non-inlined footnotes
1217 ;; are represented in this alist. Also, every definition isn't
1218 ;; guaranteed to be referenced in the parse tree. The purpose of
1219 ;; this property is to preserve definitions from oblivion
1220 ;; (i.e. when the parse tree comes from a part of the original
1221 ;; buffer), it isn't meant for direct use in a back-end. To
1222 ;; retrieve a definition relative to a reference, use
1223 ;; `org-export-get-footnote-definition' instead.
1224 ;; - category :: option
1225 ;; - type :: alist (STRING . LIST)
1226 ;;
1227 ;; + `:headline-levels' :: Maximum level being exported as an
1228 ;; headline. Comparison is done with the relative level of
1229 ;; headlines in the parse tree, not necessarily with their
1230 ;; actual level.
1231 ;; - category :: option
1232 ;; - type :: integer
1233 ;;
1234 ;; + `:headline-offset' :: Difference between relative and real level
1235 ;; of headlines in the parse tree. For example, a value of -1
1236 ;; means a level 2 headline should be considered as level
1237 ;; 1 (cf. `org-export-get-relative-level').
1238 ;; - category :: tree
1239 ;; - type :: integer
1240 ;;
1241 ;; + `:headline-numbering' :: Alist between headlines and their
1242 ;; numbering, as a list of numbers
1243 ;; (cf. `org-export-get-headline-number').
1244 ;; - category :: tree
1245 ;; - type :: alist (INTEGER . LIST)
1246 ;;
1247 ;; + `:id-alist' :: Alist between ID strings and destination file's
1248 ;; path, relative to current directory. It is used by
1249 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1250 ;; external file.
1251 ;; - category :: option
1252 ;; - type :: alist (STRING . STRING)
1253 ;;
1254 ;; + `:ignore-list' :: List of elements and objects that should be
1255 ;; ignored during export.
1256 ;; - category :: tree
1257 ;; - type :: list of elements and objects
1258 ;;
1259 ;; + `:input-file' :: Full path to input file, if any.
1260 ;; - category :: option
1261 ;; - type :: string or nil
1262 ;;
1263 ;; + `:keywords' :: List of keywords attached to data.
1264 ;; - category :: option
1265 ;; - type :: string
1266 ;;
1267 ;; + `:language' :: Default language used for translations.
1268 ;; - category :: option
1269 ;; - type :: string
1270 ;;
1271 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1272 ;; transcoding.
1273 ;; - category :: option
1274 ;; - type :: list (as returned by `org-element-parse-buffer')
1275 ;;
1276 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1277 ;; all line breaks.
1278 ;; - category :: option
1279 ;; - type :: symbol (nil, t)
1280 ;;
1281 ;; + `:section-numbers' :: Non-nil means transcoding should add
1282 ;; section numbers to headlines.
1283 ;; - category :: option
1284 ;; - type :: symbol (nil, t)
1285 ;;
1286 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1287 ;; in transcoding. When such a tag is present, subtrees without
1288 ;; it are de facto excluded from the process. See
1289 ;; `use-select-tags'.
1290 ;; - category :: option
1291 ;; - type :: list of strings
1292 ;;
1293 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1294 ;; a time stamp in the output.
1295 ;; - category :: option
1296 ;; - type :: symbol (nil, t)
1297 ;;
1298 ;; + `:translate-alist' :: Alist between element and object types and
1299 ;; transcoding functions relative to the current back-end.
1300 ;; Special keys `inner-template', `template' and `plain-text' are
1301 ;; also possible.
1302 ;; - category :: option
1303 ;; - type :: alist (SYMBOL . FUNCTION)
1304 ;;
1305 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1306 ;; also be transcoded. If it is set to the `headline' symbol,
1307 ;; only the archived headline's name is retained.
1308 ;; - category :: option
1309 ;; - type :: symbol (nil, t, `headline')
1310 ;;
1311 ;; + `:with-author' :: Non-nil means author's name should be included
1312 ;; in the output.
1313 ;; - category :: option
1314 ;; - type :: symbol (nil, t)
1315 ;;
1316 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1317 ;; - category :: option
1318 ;; - type :: symbol (nil, t)
1319 ;;
1320 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1321 ;; inserted at the end of the transcoded string. If the value
1322 ;; is `comment', it should be commented.
1323 ;; - category :: option
1324 ;; - type :: symbol (`comment', nil, t)
1325 ;;
1326 ;; + `:with-date' :: Non-nil means output should contain a date.
1327 ;; - category :: option
1328 ;; - type :. symbol (nil, t)
1329 ;;
1330 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1331 ;; its value is a list of names, only drawers with such names
1332 ;; will be transcoded. If that list starts with `not', drawer
1333 ;; with these names will be skipped.
1334 ;; - category :: option
1335 ;; - type :: symbol (nil, t) or list of strings
1336 ;;
1337 ;; + `:with-email' :: Non-nil means output should contain author's
1338 ;; email.
1339 ;; - category :: option
1340 ;; - type :: symbol (nil, t)
1341 ;;
1342 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1343 ;; interpreted.
1344 ;; - category :: option
1345 ;; - type :: symbol (nil, t)
1346 ;;
1347 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1348 ;; strings starting with a colon as a fixed-with (verbatim) area.
1349 ;; - category :: option
1350 ;; - type :: symbol (nil, t)
1351 ;;
1352 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1353 ;; footnotes.
1354 ;; - category :: option
1355 ;; - type :: symbol (nil, t)
1356 ;;
1357 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1358 ;; `latex-fragment' objects should appear in export output. When
1359 ;; this property is set to `verbatim', they will be left as-is.
1360 ;; - category :: option
1361 ;; - type :: symbol (`verbatim', nil, t)
1362 ;;
1363 ;; + `:with-planning' :: Non-nil means transcoding should include
1364 ;; planning info.
1365 ;; - category :: option
1366 ;; - type :: symbol (nil, t)
1367 ;;
1368 ;; + `:with-priority' :: Non-nil means transcoding should include
1369 ;; priority cookies.
1370 ;; - category :: option
1371 ;; - type :: symbol (nil, t)
1372 ;;
1373 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1374 ;; plain text.
1375 ;; - category :: option
1376 ;; - type :: symbol (nil, t)
1377 ;;
1378 ;; + `:with-special-strings' :: Non-nil means transcoding should
1379 ;; interpret special strings in plain text.
1380 ;; - category :: option
1381 ;; - type :: symbol (nil, t)
1382 ;;
1383 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1384 ;; interpret subscript and superscript. With a value of "{}",
1385 ;; only interpret those using curly brackets.
1386 ;; - category :: option
1387 ;; - type :: symbol (nil, {}, t)
1388 ;;
1389 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1390 ;; tables.
1391 ;; - category :: option
1392 ;; - type :: symbol (nil, t)
1393 ;;
1394 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1395 ;; headlines. A `not-in-toc' value will remove them from the
1396 ;; table of contents, if any, nonetheless.
1397 ;; - category :: option
1398 ;; - type :: symbol (nil, t, `not-in-toc')
1399 ;;
1400 ;; + `:with-tasks' :: Non-nil means transcoding should include
1401 ;; headlines with a TODO keyword. A `todo' value will only
1402 ;; include headlines with a todo type keyword while a `done'
1403 ;; value will do the contrary. If a list of strings is provided,
1404 ;; only tasks with keywords belonging to that list will be kept.
1405 ;; - category :: option
1406 ;; - type :: symbol (t, todo, done, nil) or list of strings
1407 ;;
1408 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1409 ;; time stamps. Special value `active' (resp. `inactive') ask to
1410 ;; export only active (resp. inactive) timestamps. Otherwise,
1411 ;; completely remove them.
1412 ;; - category :: option
1413 ;; - type :: symbol: (`active', `inactive', t, nil)
1414 ;;
1415 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1416 ;; added to the output. An integer value limits its depth.
1417 ;; - category :: option
1418 ;; - type :: symbol (nil, t or integer)
1419 ;;
1420 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1421 ;; include TODO keywords.
1422 ;; - category :: option
1423 ;; - type :: symbol (nil, t)
1426 ;;;; Environment Options
1427 ;;
1428 ;; Environment options encompass all parameters defined outside the
1429 ;; scope of the parsed data. They come from five sources, in
1430 ;; increasing precedence order:
1431 ;;
1432 ;; - Global variables,
1433 ;; - Buffer's attributes,
1434 ;; - Options keyword symbols,
1435 ;; - Buffer keywords,
1436 ;; - Subtree properties.
1437 ;;
1438 ;; The central internal function with regards to environment options
1439 ;; is `org-export-get-environment'. It updates global variables with
1440 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1441 ;; the different sources.
1442 ;;
1443 ;; The internal functions doing the retrieval are:
1444 ;; `org-export--get-global-options',
1445 ;; `org-export--get-buffer-attributes',
1446 ;; `org-export--parse-option-keyword',
1447 ;; `org-export--get-subtree-options' and
1448 ;; `org-export--get-inbuffer-options'
1449 ;;
1450 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1451 ;; relative to "#+BIND:" keywords.
1454 "Collect export options from the current buffer.
1456 Optional argument BACKEND is a symbol specifying which back-end
1457 specific options to read, if any.
1459 When optional argument SUBTREEP is non-nil, assume the export is
1460 done against the current sub-tree.
1462 Third optional argument EXT-PLIST is a property list with
1463 external parameters overriding Org default settings, but still
1464 inferior to file-local settings."
1465 ;; First install #+BIND variables since these must be set before
1466 ;; global options are read.
1469 ;; Get and prioritize export options...
1471 ;; ... from global variables...
1473 ;; ... from an external property list...
1474 ext-plist
1475 ;; ... from in-buffer settings...
1477 ;; ... and from subtree, when appropriate.
1479 ;; Eventually add misc. properties.
1481 :back-end
1482 backend
1483 :translate-alist
1485 :footnote-definition-alist
1486 ;; Footnotes definitions must be collected in the original
1487 ;; buffer, as there's no insurance that they will still be in
1488 ;; the parse tree, due to possible narrowing.
1502 alist))))
1503 alist))
1504 :id-alist
1505 ;; Collect id references.
1516 alist))))
1519 "Parse an OPTIONS line and return values as a plist.
1520 Optional argument BACKEND is a symbol specifying which back-end
1521 specific items to read, if any."
1523 ;; Priority is given to back-end specific options.
1525 org-export-options-alist))
1526 plist)
1535 options))
1537 property
1540 plist))
1543 "Get export options in subtree at point.
1544 Optional argument BACKEND is a symbol specifying back-end used
1545 for export. Return options as a plist."
1546 ;; For each buffer keyword, create a headline property setting the
1547 ;; same property in communication channel. The name for the property
1548 ;; is the keyword with "EXPORT_" appended to it.
1551 ;; Make sure point is at a heading.
1553 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1554 ;; title as its fallback value.
1560 plist :title
1563 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1567 ;; Handle other keywords. TITLE keyword is excluded as it has
1568 ;; been handled already.
1576 ;; Export properties are not case-sensitive.
1583 plist
1584 property
1586 ;; Parse VALUE if required.
1590 ;; If BEHAVIOUR is `split' expected value is
1591 ;; a list of strings, not a string.
1594 ;; Look for both general keywords and back-end specific
1595 ;; options, with priority given to the latter.
1597 org-export-options-alist)))
1598 ;; Return value.
1599 plist)))
1602 "Return current buffer export options, as a plist.
1604 Optional argument BACKEND, when non-nil, is a symbol specifying
1605 which back-end specific options should also be read in the
1606 process.
1608 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1610 get-options ; For byte-compiler.
1613 ;; Priority is given to back-end specific options.
1615 org-export-options-alist))
1618 org-export-special-keywords))))
1621 ;; Return property name associated to KEYWORD.
1626 options))))
1629 ;; Recursively read keywords in buffer. FILES is a list
1630 ;; of files read so far. PLIST is the current property
1631 ;; list obtained.
1640 ;; Options in `org-export-special-keywords'.
1644 ;; Avoid circular dependencies.
1654 plist
1659 plist
1665 ;; Options in `org-export-options-alist'.
1670 plist prop
1671 ;; Handle value depending on specified
1672 ;; BEHAVIOUR.
1678 " "
1690 ;; Return final value.
1691 plist))))
1692 ;; Read options in the current buffer.
1694 ;; Parse keywords specified in `org-element-document-properties'.
1696 ;; Find the property associated to the keyword.
1704 org-element-document-properties)
1705 ;; Return value.
1706 plist))
1709 "Return properties related to buffer attributes, as a plist."
1710 ;; Store full path of input file name, or nil. For internal use.
1715 "Return default title for current document, as a string.
1716 Title is extracted from associated file name, if any, or buffer's
1717 name."
1726 "Return global export options as a plist.
1727 Optional argument BACKEND, if non-nil, is a symbol specifying
1728 which back-end specific export options should also be read in the
1729 process."
1731 ;; Priority is given to back-end specific options.
1733 org-export-options-alist)))
1739 plist
1740 prop
1741 ;; Eval default value provided. If keyword is
1742 ;; a member of `org-element-document-properties',
1743 ;; parse it as a secondary string before storing it.
1750 value)))))))))))
1753 "Return variables bound from BIND keywords in current buffer.
1754 Also look for BIND keywords in setup files. The return value is
1755 an alist where associations are (VARIABLE-NAME VALUE)."
1760 ;; Return an alist between variable names and their
1761 ;; value. FILES is a list of setup files names read so
1762 ;; far, used to avoid circular dependencies. ALIST is
1763 ;; the alist collected so far.
1774 ;; Enter setup file.
1784 alist))))))))))
1785 alist)))))
1786 ;; Return value in appropriate order of appearance.
1790 ;;;; Tree Properties
1791 ;;
1792 ;; Tree properties are information extracted from parse tree. They
1793 ;; are initialized at the beginning of the transcoding process by
1794 ;; `org-export-collect-tree-properties'.
1795 ;;
1796 ;; Dedicated functions focus on computing the value of specific tree
1797 ;; properties during initialization. Thus,
1798 ;; `org-export--populate-ignore-list' lists elements and objects that
1799 ;; should be skipped during export, `org-export--get-min-level' gets
1800 ;; the minimal exportable level, used as a basis to compute relative
1801 ;; level for headlines. Eventually
1802 ;; `org-export--collect-headline-numbering' builds an alist between
1803 ;; headlines and their numbering.
1806 "Extract tree properties from parse tree.
1808 DATA is the parse tree from which information is retrieved. INFO
1809 is a list holding export options.
1811 Following tree properties are set or updated:
1813 `:exported-data' Hash table used to memoize results from
1814 `org-export-data'.
1816 `:footnote-definition-alist' List of footnotes definitions in
1817 original buffer and current parse tree.
1819 `:headline-offset' Offset between true level of headlines and
1820 local level. An offset of -1 means a headline
1821 of level 2 should be considered as a level
1822 1 headline in the context.
1824 `:headline-numbering' Alist of all headlines as key an the
1825 associated numbering as value.
1827 `:ignore-list' List of elements that should be ignored during
1828 export.
1830 Return updated plist."
1831 ;; Install the parse tree in the communication channel, in order to
1832 ;; use `org-export-get-genealogy' and al.
1834 ;; Get the list of elements and objects to ignore, and put it into
1835 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1836 ;; been done during parse tree filtering.
1839 :ignore-list
1842 ;; Compute `:headline-offset' in order to be able to use
1843 ;; `org-export-get-relative-level'.
1846 :headline-offset
1848 ;; Update footnotes definitions list with definitions in parse tree.
1849 ;; This is required since buffer expansion might have modified
1850 ;; boundaries of footnote definitions contained in the parse tree.
1851 ;; This way, definitions in `footnote-definition-alist' are bound to
1852 ;; match those in the parse tree.
1858 defs)))
1860 ;; Properties order doesn't matter: get the rest of the tree
1861 ;; properties.
1865 info))
1868 "Return minimum exportable headline's level in DATA.
1869 DATA is parsed tree as returned by `org-element-parse-buffer'.
1870 OPTIONS is a plist holding export options."
1881 ;; If no headline was found, for the sake of consistency, set
1882 ;; minimum level to 1 nonetheless.
1886 "Return numbering of all exportable headlines in a parse tree.
1888 DATA is the parse tree. OPTIONS is the plist holding export
1889 options.
1891 Return an alist whose key is a headline and value is its
1892 associated numbering \(in the shape of a list of numbers\) or nil
1893 for a footnotes section."
1901 headline
1903 for idx from 0 to org-export-max-depth
1907 options)))
1910 "Return list of elements and objects to ignore during export.
1911 DATA is the parse tree to traverse. OPTIONS is the plist holding
1912 export options."
1914 walk-data
1915 ;; First find trees containing a select tag, if any.
1919 ;; Collect ignored elements or objects into IGNORE-LIST.
1925 ;; If headline is archived but tree below has
1926 ;; to be skipped, add it to ignore list.
1929 ;; Move into secondary string, if any.
1934 ;; Move into recursive objects/elements.
1936 ;; Main call.
1938 ;; Return value.
1939 ignore))
1942 "Return list of headlines and inlinetasks with a select tag in their tree.
1943 DATA is parsed data as returned by `org-element-parse-buffer'.
1944 INFO is a plist holding export options."
1946 walk-data ; For byte-compiler.
1956 ;; When a select tag is found, mark full
1957 ;; genealogy and every headline within the tree
1958 ;; as acceptable.
1961 genealogy
1964 selected-trees))
1965 ;; If at a headline, continue searching in tree,
1966 ;; recursively.
1976 selected-trees))
1979 "Non-nil when element or object BLOB should be skipped during export.
1980 OPTIONS is the plist holding export options. SELECTED, when
1981 non-nil, is a list of headlines or inlinetasks belonging to
1982 a tree with a select tag."
1989 ;; If `:with-drawers' value starts with `not', ignore
1990 ;; every drawer whose name belong to that list.
1991 ;; Otherwise, ignore drawers whose name isn't in that
1992 ;; list.
2008 ;; Ignore subtrees with an exclude tag.
2011 ;; When a select tag is present in the buffer, ignore any tree
2012 ;; without it.
2014 ;; Ignore commented sub-trees.
2016 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2018 ;; Ignore tasks, if specified by `:with-tasks' property.
2033 ;; `:with-timestamps' only applies to isolated timestamps
2034 ;; objects, i.e. timestamp objects in a paragraph containing only
2035 ;; timestamps and whitespaces.
2043 options t))))
2052 \f
2053 ;;; The Transcoder
2054 ;;
2055 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2056 ;; `org-element-parse-buffer') and transcodes it into a specified
2057 ;; back-end output. It takes care of filtering out elements or
2058 ;; objects according to export options and organizing the output blank
2059 ;; lines and white space are preserved. The function memoizes its
2060 ;; results, so it is cheap to call it within translators.
2061 ;;
2062 ;; It is possible to modify locally the back-end used by
2063 ;; `org-export-data' or even use a temporary back-end by using
2064 ;; `org-export-data-with-translations' and
2065 ;; `org-export-data-with-backend'.
2066 ;;
2067 ;; Internally, three functions handle the filtering of objects and
2068 ;; elements during the export. In particular,
2069 ;; `org-export-ignore-element' marks an element or object so future
2070 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2071 ;; elements or objects should be seen as real Org syntax and
2072 ;; `org-export-expand' transforms the others back into their original
2073 ;; shape
2074 ;;
2075 ;; `org-export-transcoder' is an accessor returning appropriate
2076 ;; translator function for a given element or object.
2079 "Return appropriate transcoder for BLOB.
2080 INFO is a plist containing export directives."
2082 ;; Return contents only for complete parse trees.
2088 "Convert DATA into current back-end format.
2090 DATA is a parse tree, an element or an object or a secondary
2091 string. INFO is a plist holding export options.
2093 Return transcoded string."
2099 ;; Ignored element/object.
2101 ;; Plain text.
2107 info))
2108 ;; Uninterpreted element/object: change it back to Org
2109 ;; syntax and export again resulting raw string.
2113 data
2117 info))
2118 ;; Secondary string.
2121 ;; Element/Object without contents or, as a special case,
2122 ;; headline with archive tag and archived trees restricted
2123 ;; to title only.
2131 ;; Export snippets never return a nil value so
2132 ;; that white spaces following them are never
2133 ;; ignored.
2135 ;; Element/Object with contents.
2148 ;; Elements directly containing objects
2149 ;; must have their indentation normalized
2150 ;; first.
2152 data
2153 ;; When normalizing contents of the first
2154 ;; paragraph in an item or a footnote
2155 ;; definition, ignore first line's
2156 ;; indentation: there is none and it
2157 ;; might be misleading.
2162 data)
2169 info))))))))
2170 ;; Final result will be memoized before being returned.
2172 data
2176 ;; Append the same white space between elements or objects as in
2177 ;; the original buffer, and call appropriate filters.
2188 info)))
2189 results)))
2193 "Convert DATA into another format using a given translation table.
2194 DATA is an element, an object, a secondary string or a string.
2195 TRANSLATIONS is an alist between element or object types and
2196 a functions handling them. See `org-export-define-backend' for
2197 more information. INFO is a plist used as a communication
2198 channel."
2200 data
2201 ;; Set-up a new communication channel with TRANSLATIONS as the
2202 ;; translate table and a new hash table for memoization.
2204 info
2206 ;; Size of the hash table is reduced since this function
2207 ;; will probably be used on short trees.
2211 "Convert DATA into BACKEND format.
2213 DATA is an element, an object, a secondary string or a string.
2214 BACKEND is a symbol. INFO is a plist used as a communication
2215 channel.
2217 Unlike to `org-export-with-backend', this function will
2218 recursively convert DATA using BACKEND translation table."
2224 "Non-nil if element or object BLOB should be interpreted during export.
2225 If nil, BLOB will appear as raw Org syntax. Check is done
2226 according to export options INFO, stored as a plist."
2228 ;; ... entities...
2230 ;; ... emphasis...
2233 ;; ... fixed-width areas.
2235 ;; ... LaTeX environments and fragments...
2239 ;; ... sub/superscripts...
2245 ;; ... tables...
2250 "Expand a parsed element or object to its original state.
2252 BLOB is either an element or an object. CONTENTS is its
2253 contents, as a string or nil.
2255 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2256 keywords before output."
2261 blob contents))))
2264 "Add ELEMENT to `:ignore-list' in INFO.
2266 Any element in `:ignore-list' will be skipped when using
2267 `org-element-map'. INFO is modified by side effects."
2271 \f
2272 ;;; The Filter System
2273 ;;
2274 ;; Filters allow end-users to tweak easily the transcoded output.
2275 ;; They are the functional counterpart of hooks, as every filter in
2276 ;; a set is applied to the return value of the previous one.
2277 ;;
2278 ;; Every set is back-end agnostic. Although, a filter is always
2279 ;; called, in addition to the string it applies to, with the back-end
2280 ;; used as argument, so it's easy for the end-user to add back-end
2281 ;; specific filters in the set. The communication channel, as
2282 ;; a plist, is required as the third argument.
2283 ;;
2284 ;; From the developer side, filters sets can be installed in the
2285 ;; process with the help of `org-export-define-backend', which
2286 ;; internally stores filters as an alist. Each association has a key
2287 ;; among the following symbols and a function or a list of functions
2288 ;; as value.
2289 ;;
2290 ;; - `:filter-options' applies to the property list containing export
2291 ;; options. Unlike to other filters, functions in this list accept
2292 ;; two arguments instead of three: the property list containing
2293 ;; export options and the back-end. Users can set its value through
2294 ;; `org-export-filter-options-functions' variable.
2295 ;;
2296 ;; - `:filter-parse-tree' applies directly to the complete parsed
2297 ;; tree. Users can set it through
2298 ;; `org-export-filter-parse-tree-functions' variable.
2299 ;;
2300 ;; - `:filter-final-output' applies to the final transcoded string.
2301 ;; Users can set it with `org-export-filter-final-output-functions'
2302 ;; variable
2303 ;;
2304 ;; - `:filter-plain-text' applies to any string not recognized as Org
2305 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2306 ;; configure it.
2307 ;;
2308 ;; - `:filter-TYPE' applies on the string returned after an element or
2309 ;; object of type TYPE has been transcoded. A user can modify
2310 ;; `org-export-filter-TYPE-functions'
2311 ;;
2312 ;; All filters sets are applied with
2313 ;; `org-export-filter-apply-functions' function. Filters in a set are
2314 ;; applied in a LIFO fashion. It allows developers to be sure that
2315 ;; their filters will be applied first.
2316 ;;
2317 ;; Filters properties are installed in communication channel with
2318 ;; `org-export-install-filters' function.
2319 ;;
2320 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2321 ;; `org-export-before-parsing-hook') are run at the beginning of the
2322 ;; export process and just before parsing to allow for heavy structure
2323 ;; modifications.
2326 ;;;; Hooks
2329 "Hook run at the beginning of the export process.
2331 This is run before include keywords and macros are expanded and
2332 Babel code blocks executed, on a copy of the original buffer
2333 being exported. Visibility and narrowing are preserved. Point
2334 is at the beginning of the buffer.
2336 Every function in this hook will be called with one argument: the
2340 "Hook run before parsing an export buffer.
2342 This is run after include keywords and macros have been expanded
2343 and Babel code blocks executed, on a copy of the original buffer
2344 being exported. Visibility and narrowing are preserved. Point
2345 is at the beginning of the buffer.
2347 Every function in this hook will be called with one argument: the
2351 ;;;; Special Filters
2354 "List of functions applied to the export options.
2355 Each filter is called with two arguments: the export options, as
2356 a plist, and the back-end, as a symbol. It must return
2360 "List of functions applied to the parsed tree.
2361 Each filter is called with three arguments: the parse tree, as
2362 returned by `org-element-parse-buffer', the back-end, as
2363 a symbol, and the communication channel, as a plist. It must
2367 "List of functions applied to plain text.
2368 Each filter is called with three arguments: a string which
2369 contains no Org syntax, the back-end, as a symbol, and the
2370 communication channel, as a plist. It must return a string or
2374 "List of functions applied to the transcoded string.
2375 Each filter is called with three arguments: the full transcoded
2376 string, the back-end, as a symbol, and the communication channel,
2377 as a plist. It must return a string that will be used as the
2381 ;;;; Elements Filters
2384 "List of functions applied to a transcoded babel-call.
2385 Each filter is called with three arguments: the transcoded data,
2386 as a string, the back-end, as a symbol, and the communication
2390 "List of functions applied to a transcoded center block.
2391 Each filter is called with three arguments: the transcoded data,
2392 as a string, the back-end, as a symbol, and the communication
2396 "List of functions applied to a transcoded clock.
2397 Each filter is called with three arguments: the transcoded data,
2398 as a string, the back-end, as a symbol, and the communication
2402 "List of functions applied to a transcoded comment.
2403 Each filter is called with three arguments: the transcoded data,
2404 as a string, the back-end, as a symbol, and the communication
2408 "List of functions applied to a transcoded comment-block.
2409 Each filter is called with three arguments: the transcoded data,
2410 as a string, the back-end, as a symbol, and the communication
2414 "List of functions applied to a transcoded diary-sexp.
2415 Each filter is called with three arguments: the transcoded data,
2416 as a string, the back-end, as a symbol, and the communication
2420 "List of functions applied to a transcoded drawer.
2421 Each filter is called with three arguments: the transcoded data,
2422 as a string, the back-end, as a symbol, and the communication
2426 "List of functions applied to a transcoded dynamic-block.
2427 Each filter is called with three arguments: the transcoded data,
2428 as a string, the back-end, as a symbol, and the communication
2432 "List of functions applied to a transcoded example-block.
2433 Each filter is called with three arguments: the transcoded data,
2434 as a string, the back-end, as a symbol, and the communication
2438 "List of functions applied to a transcoded export-block.
2439 Each filter is called with three arguments: the transcoded data,
2440 as a string, the back-end, as a symbol, and the communication
2444 "List of functions applied to a transcoded fixed-width.
2445 Each filter is called with three arguments: the transcoded data,
2446 as a string, the back-end, as a symbol, and the communication
2450 "List of functions applied to a transcoded footnote-definition.
2451 Each filter is called with three arguments: the transcoded data,
2452 as a string, the back-end, as a symbol, and the communication
2456 "List of functions applied to a transcoded headline.
2457 Each filter is called with three arguments: the transcoded data,
2458 as a string, the back-end, as a symbol, and the communication
2462 "List of functions applied to a transcoded horizontal-rule.
2463 Each filter is called with three arguments: the transcoded data,
2464 as a string, the back-end, as a symbol, and the communication
2468 "List of functions applied to a transcoded inlinetask.
2469 Each filter is called with three arguments: the transcoded data,
2470 as a string, the back-end, as a symbol, and the communication
2474 "List of functions applied to a transcoded item.
2475 Each filter is called with three arguments: the transcoded data,
2476 as a string, the back-end, as a symbol, and the communication
2480 "List of functions applied to a transcoded keyword.
2481 Each filter is called with three arguments: the transcoded data,
2482 as a string, the back-end, as a symbol, and the communication
2486 "List of functions applied to a transcoded latex-environment.
2487 Each filter is called with three arguments: the transcoded data,
2488 as a string, the back-end, as a symbol, and the communication
2492 "List of functions applied to a transcoded node-property.
2493 Each filter is called with three arguments: the transcoded data,
2494 as a string, the back-end, as a symbol, and the communication
2498 "List of functions applied to a transcoded paragraph.
2499 Each filter is called with three arguments: the transcoded data,
2500 as a string, the back-end, as a symbol, and the communication
2504 "List of functions applied to a transcoded plain-list.
2505 Each filter is called with three arguments: the transcoded data,
2506 as a string, the back-end, as a symbol, and the communication
2510 "List of functions applied to a transcoded planning.
2511 Each filter is called with three arguments: the transcoded data,
2512 as a string, the back-end, as a symbol, and the communication
2516 "List of functions applied to a transcoded property-drawer.
2517 Each filter is called with three arguments: the transcoded data,
2518 as a string, the back-end, as a symbol, and the communication
2522 "List of functions applied to a transcoded quote block.
2523 Each filter is called with three arguments: the transcoded quote
2524 data, as a string, the back-end, as a symbol, and the
2525 communication channel, as a plist. It must return a string or
2529 "List of functions applied to a transcoded quote-section.
2530 Each filter is called with three arguments: the transcoded data,
2531 as a string, the back-end, as a symbol, and the communication
2535 "List of functions applied to a transcoded section.
2536 Each filter is called with three arguments: the transcoded data,
2537 as a string, the back-end, as a symbol, and the communication
2541 "List of functions applied to a transcoded special block.
2542 Each filter is called with three arguments: the transcoded data,
2543 as a string, the back-end, as a symbol, and the communication
2547 "List of functions applied to a transcoded src-block.
2548 Each filter is called with three arguments: the transcoded data,
2549 as a string, the back-end, as a symbol, and the communication
2553 "List of functions applied to a transcoded table.
2554 Each filter is called with three arguments: the transcoded data,
2555 as a string, the back-end, as a symbol, and the communication
2559 "List of functions applied to a transcoded table-cell.
2560 Each filter is called with three arguments: the transcoded data,
2561 as a string, the back-end, as a symbol, and the communication
2565 "List of functions applied to a transcoded table-row.
2566 Each filter is called with three arguments: the transcoded data,
2567 as a string, the back-end, as a symbol, and the communication
2571 "List of functions applied to a transcoded verse block.
2572 Each filter is called with three arguments: the transcoded data,
2573 as a string, the back-end, as a symbol, and the communication
2577 ;;;; Objects Filters
2580 "List of functions applied to transcoded bold text.
2581 Each filter is called with three arguments: the transcoded data,
2582 as a string, the back-end, as a symbol, and the communication
2586 "List of functions applied to transcoded code text.
2587 Each filter is called with three arguments: the transcoded data,
2588 as a string, the back-end, as a symbol, and the communication
2592 "List of functions applied to a transcoded entity.
2593 Each filter is called with three arguments: the transcoded data,
2594 as a string, the back-end, as a symbol, and the communication
2598 "List of functions applied to a transcoded export-snippet.
2599 Each filter is called with three arguments: the transcoded data,
2600 as a string, the back-end, as a symbol, and the communication
2604 "List of functions applied to a transcoded footnote-reference.
2605 Each filter is called with three arguments: the transcoded data,
2606 as a string, the back-end, as a symbol, and the communication
2610 "List of functions applied to a transcoded inline-babel-call.
2611 Each filter is called with three arguments: the transcoded data,
2612 as a string, the back-end, as a symbol, and the communication
2616 "List of functions applied to a transcoded inline-src-block.
2617 Each filter is called with three arguments: the transcoded data,
2618 as a string, the back-end, as a symbol, and the communication
2622 "List of functions applied to transcoded italic text.
2623 Each filter is called with three arguments: the transcoded data,
2624 as a string, the back-end, as a symbol, and the communication
2628 "List of functions applied to a transcoded latex-fragment.
2629 Each filter is called with three arguments: the transcoded data,
2630 as a string, the back-end, as a symbol, and the communication
2634 "List of functions applied to a transcoded line-break.
2635 Each filter is called with three arguments: the transcoded data,
2636 as a string, the back-end, as a symbol, and the communication
2640 "List of functions applied to a transcoded link.
2641 Each filter is called with three arguments: the transcoded data,
2642 as a string, the back-end, as a symbol, and the communication
2646 "List of functions applied to a transcoded radio-target.
2647 Each filter is called with three arguments: the transcoded data,
2648 as a string, the back-end, as a symbol, and the communication
2652 "List of functions applied to a transcoded statistics-cookie.
2653 Each filter is called with three arguments: the transcoded data,
2654 as a string, the back-end, as a symbol, and the communication
2658 "List of functions applied to transcoded strike-through text.
2659 Each filter is called with three arguments: the transcoded data,
2660 as a string, the back-end, as a symbol, and the communication
2664 "List of functions applied to a transcoded subscript.
2665 Each filter is called with three arguments: the transcoded data,
2666 as a string, the back-end, as a symbol, and the communication
2670 "List of functions applied to a transcoded superscript.
2671 Each filter is called with three arguments: the transcoded data,
2672 as a string, the back-end, as a symbol, and the communication
2676 "List of functions applied to a transcoded target.
2677 Each filter is called with three arguments: the transcoded data,
2678 as a string, the back-end, as a symbol, and the communication
2682 "List of functions applied to a transcoded timestamp.
2683 Each filter is called with three arguments: the transcoded data,
2684 as a string, the back-end, as a symbol, and the communication
2688 "List of functions applied to transcoded underline text.
2689 Each filter is called with three arguments: the transcoded data,
2690 as a string, the back-end, as a symbol, and the communication
2694 "List of functions applied to transcoded verbatim text.
2695 Each filter is called with three arguments: the transcoded data,
2696 as a string, the back-end, as a symbol, and the communication
2700 ;;;; Filters Tools
2701 ;;
2702 ;; Internal function `org-export-install-filters' installs filters
2703 ;; hard-coded in back-ends (developer filters) and filters from global
2704 ;; variables (user filters) in the communication channel.
2705 ;;
2706 ;; Internal function `org-export-filter-apply-functions' takes care
2707 ;; about applying each filter in order to a given data. It ignores
2708 ;; filters returning a nil value but stops whenever a filter returns
2709 ;; an empty string.
2712 "Call every function in FILTERS.
2714 Functions are called with arguments VALUE, current export
2715 back-end and INFO. A function returning a nil value will be
2716 skipped. If it returns the empty string, the process ends and
2717 VALUE is ignored.
2719 Call is done in a LIFO fashion, to be sure that developer
2720 specified filters, if any, are called first."
2729 "Install filters properties in communication channel.
2730 INFO is a plist containing the current communication channel.
2731 Return the updated communication channel."
2733 ;; Install user-defined filters with `org-export-filters-alist'
2734 ;; and filters already in INFO (through ext-plist mechanism).
2741 ;; Filters in INFO will be called
2742 ;; before those user provided.
2745 default-value)))))
2746 org-export-filters-alist)
2747 ;; Prepend back-end specific filters to that list.
2749 ;; Single values get consed, lists are appended.
2754 plist key
2758 ;; Return new communication channel.
2762 \f
2763 ;;; Core functions
2764 ;;
2765 ;; This is the room for the main function, `org-export-as', along with
2766 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2767 ;; `org-export-string-as'. They differ either by the way they output
2768 ;; the resulting code (for the first two) or by the input type (for
2769 ;; the latter). `org-export--copy-to-kill-ring-p' determines if
2770 ;; output of these function should be added to kill ring.
2771 ;;
2772 ;; `org-export-output-file-name' is an auxiliary function meant to be
2773 ;; used with `org-export-to-file'. With a given extension, it tries
2774 ;; to provide a canonical file name to write export output to.
2775 ;;
2776 ;; Note that `org-export-as' doesn't really parse the current buffer,
2777 ;; but a copy of it (with the same buffer-local variables and
2778 ;; visibility), where macros and include keywords are expanded and
2779 ;; Babel blocks are executed, if appropriate.
2780 ;; `org-export-with-buffer-copy' macro prepares that copy.
2781 ;;
2782 ;; File inclusion is taken care of by
2783 ;; `org-export-expand-include-keyword' and
2784 ;; `org-export--prepare-file-contents'. Structure wise, including
2785 ;; a whole Org file in a buffer often makes little sense. For
2786 ;; example, if the file contains a headline and the include keyword
2787 ;; was within an item, the item should contain the headline. That's
2788 ;; why file inclusion should be done before any structure can be
2789 ;; associated to the file, that is before parsing.
2790 ;;
2791 ;; `org-export-insert-default-template' is a command to insert
2792 ;; a default template (or a back-end specific template) at point or in
2793 ;; current subtree.
2796 "Return a copy of the current buffer.
2797 The copy preserves Org buffer-local variables, visibility and
2798 narrowing."
2804 new-buf))
2807 "Apply BODY in a copy of the current buffer.
2808 The copy preserves local variables, visibility and contents of
2809 the original buffer. Point is at the beginning of the buffer
2810 when BODY is applied."
2819 ;; Kill copy without confirmation.
2825 "Generate a function duplicating BUFFER.
2827 The copy will preserve local variables, visibility, contents and
2828 narrowing of the original buffer. If a region was active in
2829 BUFFER, contents will be narrowed to that region instead.
2831 The resulting function can be evaled at a later time, from
2832 another buffer, effectively cloning the original buffer there.
2834 The function assumes BUFFER's major mode is `org-mode'."
2838 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2839 ;; already in BUFFER.
2841 ;; Copy specific buffer local variables and variables set
2842 ;; through BIND keywords.
2844 vars)
2852 buffer-file-name
2853 buffer-file-coding-system))
2857 ;; Skip unreadable values, as they cannot be
2858 ;; sent to external process.
2862 vars))))))
2863 ;; Whole buffer contents.
2868 ;; Narrowing.
2872 ;; Current position of point.
2874 ;; Overlays with invisible property.
2884 ov-set))))
2886 ov-set)))))
2888 ;;;###autoload
2891 "Transcode current Org buffer into BACKEND code.
2893 If narrowing is active in the current buffer, only transcode its
2894 narrowed part.
2896 If a region is active, transcode that region.
2898 When optional argument SUBTREEP is non-nil, transcode the
2899 sub-tree at point, extracting information from the headline
2900 properties first.
2902 When optional argument VISIBLE-ONLY is non-nil, don't export
2903 contents of hidden elements.
2905 When optional argument BODY-ONLY is non-nil, only return body
2906 code, without surrounding template.
2908 Optional argument EXT-PLIST, when provided, is a property list
2909 with external parameters overriding Org default settings, but
2910 still inferior to file-local settings.
2912 Return code as a string."
2916 ;; Narrow buffer to an appropriate region or subtree for
2917 ;; parsing. If parsing subtree, be sure to remove main headline
2918 ;; too.
2926 ;; Initialize communication channel with original buffer
2927 ;; attributes, unavailable in its copy.
2935 tree)
2936 ;; Store default title in `org-export--default-title' so that
2937 ;; `org-export-get-environment' can access it from buffer's
2938 ;; copy and then add it properly to communication channel.
2940 ;; Update communication channel and get parse tree. Buffer
2941 ;; isn't parsed directly. Instead, a temporary copy is
2942 ;; created, where include keywords, macros are expanded and
2943 ;; code blocks are evaluated.
2945 ;; Run first hook with current back-end as argument.
2948 ;; Update macro templates since #+INCLUDE keywords might have
2949 ;; added some new ones.
2953 ;; Update radio targets since keyword inclusion might have
2954 ;; added some more.
2956 ;; Run last hook with current back-end as argument.
2960 ;; Update communication channel with environment. Also
2961 ;; install user's and developer's filters.
2966 ;; Expand export-specific set of macros: {{{author}}},
2967 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2968 ;; once regular macros have been expanded, since document
2969 ;; keywords may contain one of them.
2975 ;; EMAIL is not a parsed keyword: store it as-is.
2979 ;; Call options filters and update export options. We do not
2980 ;; use `org-export-filter-apply-functions' here since the
2981 ;; arity of such filters is different.
2985 ;; Parse buffer and call parse-tree filter on it.
2990 ;; Now tree is complete, compute its properties and add them
2991 ;; to communication channel.
2995 ;; Eventually transcode TREE. Wrap the resulting string into
2996 ;; a template.
3005 ;; Remove all text properties since they cannot be
3006 ;; retrieved from an external process. Finally call
3007 ;; final-output filter and return result.
3013 info))))))))
3015 ;;;###autoload
3018 "Call `org-export-as' with output to a specified buffer.
3020 BACKEND is the back-end used for transcoding, as a symbol.
3022 BUFFER is the output buffer. If it already exists, it will be
3023 erased first, otherwise, it will be created.
3025 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3026 EXT-PLIST are similar to those used in `org-export-as', which
3027 see.
3029 Depending on `org-export-copy-to-kill-ring', add buffer contents
3030 to kill ring. Return buffer."
3037 ;; Maybe add buffer contents to kill ring.
3040 ;; Return buffer.
3041 buffer))
3043 ;;;###autoload
3046 "Call `org-export-as' with output to a specified file.
3048 BACKEND is the back-end used for transcoding, as a symbol. FILE
3049 is the name of the output file, as a string.
3051 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3052 EXT-PLIST are similar to those used in `org-export-as', which
3053 see.
3055 Depending on `org-export-copy-to-kill-ring', add file contents
3056 to kill ring. Return output file's name."
3057 ;; Checks for FILE permissions. `write-file' would do the same, but
3058 ;; we'd rather avoid needless transcoding of parse tree.
3060 ;; Insert contents to a temporary buffer and write it to FILE.
3067 ;; Maybe add file contents to kill ring.
3070 ;; Return full path.
3071 file)
3073 ;;;###autoload
3075 "Transcode STRING into BACKEND code.
3077 When optional argument BODY-ONLY is non-nil, only return body
3078 code, without preamble nor postamble.
3080 Optional argument EXT-PLIST, when provided, is a property list
3081 with external parameters overriding Org default settings, but
3082 still inferior to file-local settings.
3084 Return code as a string."
3090 ;;;###autoload
3092 "Replace the active region by its export to BACKEND."
3102 ;;;###autoload
3104 "Insert all export keywords with default values at beginning of line.
3106 BACKEND is a symbol representing the export back-end for which
3107 specific export options should be added to the template, or
3108 `default' for default template. When it is nil, the user will be
3109 prompted for a category.
3111 If SUBTREEP is non-nil, export configuration will be set up
3112 locally for the subtree through node properties."
3121 "Options category: "
3124 org-export-registered-backends))))))
3125 options keywords)
3126 ;; Populate OPTIONS and KEYWORDS.
3140 ;; Move to an appropriate location in order to insert options.
3142 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3143 ;; list of available keywords.
3171 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3190 ;; And the rest of keywords.
3201 "Return output file's name according to buffer specifications.
3203 EXTENSION is a string representing the output file extension,
3204 with the leading dot.
3206 With a non-nil optional argument SUBTREEP, try to determine
3208 of subtree at point.
3210 When optional argument PUB-DIR is set, use it as the publishing
3211 directory.
3213 When optional argument VISIBLE-ONLY is non-nil, don't export
3214 contents of hidden elements.
3216 Return file name as a string."
3219 ;; File name may come from EXPORT_FILE_NAME subtree
3220 ;; property, assuming point is at beginning of said
3221 ;; sub-tree.
3228 ;; File name may be extracted from buffer's associated
3229 ;; file, if any.
3231 ;; Can't determine file name on our own: Ask user.
3235 "Output file: " pub-dir nil nil nil
3239 ;; Build file name. Enforce EXTENSION over whatever user
3240 ;; may have come up with. PUB-DIR, if defined, always has
3241 ;; precedence over any provided path.
3246 extension))
3249 ;; If writing to OUTPUT-FILE would overwrite original file, append
3250 ;; EXTENSION another time to final name.
3253 output-file)))
3256 "Expand every include keyword in buffer.
3257 Optional argument INCLUDED is a list of included file names along
3258 with their line restriction, when appropriate. It is used to
3259 avoid infinite recursion. Optional argument DIR is the current
3260 working directory. It is used to properly resolve relative
3261 paths."
3268 ;; Extract arguments from keyword's value.
3276 dir)
3281 value)
3287 ;; Minimal level of included file defaults to the child
3288 ;; level of the current headline, if any, or one. It
3289 ;; only applies is the file is meant to be included as
3290 ;; an Org one.
3298 ;; Remove keyword.
3304 ;; Check if files has already been parsed. Look after
3305 ;; inclusion lines too, as different parts of the same file
3306 ;; can be included too.
3318 ind-str contents ind-str))))
3326 ind-str env contents ind-str))))
3339 "Prepare the contents of FILE for inclusion and return them as a string.
3341 When optional argument LINES is a string specifying a range of
3342 lines, include only those lines.
3344 Optional argument IND, when non-nil, is an integer specifying the
3345 global indentation of returned contents. Since its purpose is to
3346 allow an included file to stay in the same environment it was
3347 created \(i.e. a list item), it doesn't apply past the first
3348 headline encountered.
3350 Optional argument MINLEVEL, when non-nil, is an integer
3351 specifying the level that any top-level headline in the included
3352 file should have."
3368 ;; Remove blank lines at beginning and end of contents. The logic
3369 ;; behind that removal is that blank lines around include keyword
3370 ;; override blank lines in included file.
3379 ;; If IND is set, preserve indentation of include keyword until
3380 ;; the first headline encountered.
3387 ;; Do not move footnote definitions out of column 0.
3393 ;; When MINLEVEL is specified, compute minimal level for headlines
3394 ;; in the file (CUR-MIN), and remove stars to each headline so
3395 ;; that headlines with minimal level have a level of MINLEVEL.
3406 ;; Only change stars, don't bother moving whole
3407 ;; sections.
3414 "Execute every Babel code in the visible part of current buffer."
3415 ;; Get a pristine copy of current buffer so Babel references can be
3416 ;; properly resolved.
3423 "Return a non-nil value when output should be added to the kill ring.
3424 See also `org-export-copy-to-kill-ring'."
3430 \f
3431 ;;; Tools For Back-Ends
3432 ;;
3433 ;; A whole set of tools is available to help build new exporters. Any
3434 ;; function general enough to have its use across many back-ends
3435 ;; should be added here.
3437 ;;;; For Affiliated Keywords
3438 ;;
3439 ;; `org-export-read-attribute' reads a property from a given element
3440 ;; as a plist. It can be used to normalize affiliated keywords'
3441 ;; syntax.
3442 ;;
3443 ;; Since captions can span over multiple lines and accept dual values,
3444 ;; their internal representation is a bit tricky. Therefore,
3445 ;; `org-export-get-caption' transparently returns a given element's
3446 ;; caption as a secondary string.
3449 "Turn ATTRIBUTE property from ELEMENT into a plist.
3451 When optional argument PROPERTY is non-nil, return the value of
3452 that property within attributes.
3456 properties.
3458 All values will become strings except the empty string and
3461 will become the empty string."
3475 s)
3480 ;; Ignore any string before first property with `cdr'.
3485 "Return caption from ELEMENT as a secondary string.
3487 When optional argument SHORTP is non-nil, return short caption,
3488 as a secondary string, instead.
3490 Caption lines are separated by a white space."
3498 ;;;; For Derived Back-ends
3499 ;;
3500 ;; `org-export-with-backend' is a function allowing to locally use
3501 ;; another back-end to transcode some object or element. In a derived
3502 ;; back-end, it may be used as a fall-back function once all specific
3503 ;; cases have been treated.
3506 "Call a transcoder from BACK-END on DATA.
3507 CONTENTS, when non-nil, is the transcoded contents of DATA
3508 element, as a string. INFO, when non-nil, is the communication
3509 channel used for export, as a plist.."
3519 ;;;; For Export Snippets
3520 ;;
3521 ;; Every export snippet is transmitted to the back-end. Though, the
3522 ;; latter will only retain one type of export-snippet, ignoring
3523 ;; others, based on the former's target back-end. The function
3524 ;; `org-export-snippet-backend' returns that back-end for a given
3525 ;; export-snippet.
3528 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3529 Translation, with `org-export-snippet-translation-alist', is
3530 applied."
3534 back-end))))
3537 ;;;; For Footnotes
3538 ;;
3539 ;; `org-export-collect-footnote-definitions' is a tool to list
3540 ;; actually used footnotes definitions in the whole parse tree, or in
3541 ;; a headline, in order to add footnote listings throughout the
3542 ;; transcoded data.
3543 ;;
3544 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3545 ;; back-ends, when they need to attach the footnote definition only to
3546 ;; the first occurrence of the corresponding label.
3547 ;;
3548 ;; `org-export-get-footnote-definition' and
3549 ;; `org-export-get-footnote-number' provide easier access to
3550 ;; additional information relative to a footnote reference.
3553 "Return an alist between footnote numbers, labels and definitions.
3555 DATA is the parse tree from which definitions are collected.
3556 INFO is the plist used as a communication channel.
3558 Definitions are sorted by order of references. They either
3559 appear as Org data or as a secondary string for inlined
3560 footnotes. Unreferenced definitions are ignored."
3562 collect-fn ; for byte-compiler.
3566 ;; Collect footnote number, label and definition in DATA.
3574 def)
3575 num-alist)
3576 ;; Also search in definition for nested footnotes.
3579 ;; Don't enter footnote definitions since it will happen
3580 ;; when their first reference is found.
3586 "Non-nil when a footnote reference is the first one for its label.
3588 FOOTNOTE-REFERENCE is the footnote reference being considered.
3589 INFO is the plist used as a communication channel."
3591 ;; Anonymous footnotes are always a first reference.
3593 ;; Otherwise, return the first footnote with the same LABEL and
3594 ;; test if it is equal to FOOTNOTE-REFERENCE.
3604 ;; If FN isn't inlined, be sure to traverse its
3605 ;; definition before resuming search. See
3606 ;; comments in `org-export-get-footnote-number'
3607 ;; for more information.
3611 ;; Don't enter footnote definitions since it will
3612 ;; happen when their first reference is found.
3615 footnote-reference)))))
3618 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3619 INFO is the plist used as a communication channel. If no such
3621 string."
3628 "Return number associated to a footnote.
3630 FOOTNOTE is either a footnote reference or a footnote definition.
3631 INFO is the plist used as a communication channel."
3633 seen-refs
3634 search-ref ; For byte-compiler.
3638 ;; Search footnote references through DATA, filling
3639 ;; SEEN-REFS along the way.
3644 ;; Anonymous footnote match: return number.
3647 ;; Labels match: return number.
3650 ;; Anonymous footnote: it's always a new one.
3651 ;; Also, be sure to return nil from the `cond' so
3652 ;; `first-match' doesn't get us out of the loop.
3654 ;; Label not seen so far: add it so SEEN-REFS.
3655 ;;
3656 ;; Also search for subsequent references in
3657 ;; footnote definition so numbering follows
3658 ;; reading logic. Note that we don't have to care
3659 ;; about inline definitions, since
3660 ;; `org-element-map' already traverses them at the
3661 ;; right time.
3662 ;;
3663 ;; Once again, return nil to stay in the loop.
3668 nil))))
3669 ;; Don't enter footnote definitions since it will
3670 ;; happen when their first reference is found.
3675 ;;;; For Headlines
3676 ;;
3677 ;; `org-export-get-relative-level' is a shortcut to get headline
3678 ;; level, relatively to the lower headline level in the parsed tree.
3679 ;;
3680 ;; `org-export-get-headline-number' returns the section number of an
3681 ;; headline, while `org-export-number-to-roman' allows to convert it
3682 ;; to roman numbers.
3683 ;;
3684 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3685 ;; `org-export-last-sibling-p' are three useful predicates when it
3686 ;; comes to fulfill the `:headline-levels' property.
3687 ;;
3688 ;; `org-export-get-tags', `org-export-get-category' and
3689 ;; `org-export-get-node-property' extract useful information from an
3690 ;; headline or a parent headline. They all handle inheritance.
3691 ;;
3692 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3693 ;; as a secondary string, suitable for table of contents. It falls
3694 ;; back onto default title.
3697 "Return HEADLINE relative level within current parsed tree.
3698 INFO is a plist holding contextual information."
3703 "Non-nil when HEADLINE is considered as low level.
3705 INFO is a plist used as a communication channel.
3707 A low level headlines has a relative level greater than
3708 `:headline-levels' property value.
3710 Return value is the difference between HEADLINE relative level
3711 and the last level being considered as high enough, or nil."
3718 "Return HEADLINE numbering as a list of numbers.
3719 INFO is a plist holding contextual information."
3723 "Return a non-nil value if HEADLINE element should be numbered.
3724 INFO is a plist used as a communication channel."
3730 "Convert integer N into a roman numeral."
3743 res)))
3746 "Return list of tags associated to ELEMENT.
3748 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3749 is a plist used as a communication channel.
3751 Select tags (see `org-export-select-tags') and exclude tags (see
3752 `org-export-exclude-tags') are removed from the list.
3754 When non-nil, optional argument TAGS should be a list of strings.
3755 Any tag belonging to this list will also be removed.
3757 When optional argument INHERITED is non-nil, tags can also be
3758 inherited from parent headlines and FILETAGS keywords."
3764 ;; Build complete list of inherited tags.
3775 ;; Add FILETAGS keywords and return results.
3779 "Return node PROPERTY value for BLOB.
3781 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3782 element or object.
3784 If optional argument INHERITED is non-nil, the value can be
3785 inherited from a parent headline.
3787 Return value is a string or nil."
3799 "Return category for element or object BLOB.
3801 INFO is a plist used as a communication channel.
3803 CATEGORY is automatically inherited from a parent headline, from
3804 #+CATEGORY: keyword or created out of original file name. If all
3808 ;; Almost like `org-export-node-property', but we cannot trust
3809 ;; `plist-member' as every headline has a `:CATEGORY'
3810 ;; property, would it be nil or equal to "???" (which has the
3811 ;; same meaning).
3829 "Return alternative title for HEADLINE, as a secondary string.
3830 INFO is a plist used as a communication channel. If no optional
3831 title is defined, fall-back to the regular title."
3836 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3837 INFO is a plist used as a communication channel."
3842 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3843 INFO is a plist used as a communication channel."
3847 ;;;; For Keywords
3848 ;;
3849 ;; `org-export-get-date' returns a date appropriate for the document
3850 ;; to about to be exported. In particular, it takes care of
3851 ;; `org-export-date-timestamp-format'.
3854 "Return date value for the current document.
3856 INFO is a plist used as a communication channel. FMT, when
3857 non-nil, is a time format string that will be applied on the date
3858 if it consists in a single timestamp object. It defaults to
3859 `org-export-date-timestamp-format' when nil.
3861 A proper date can be a secondary string, a string or nil. It is
3862 meant to be translated with `org-export-data' or alike."
3873 ;;;; For Links
3874 ;;
3875 ;; `org-export-solidify-link-text' turns a string into a safer version
3876 ;; for links, replacing most non-standard characters with hyphens.
3877 ;;
3878 ;; `org-export-get-coderef-format' returns an appropriate format
3879 ;; string for coderefs.
3880 ;;
3881 ;; `org-export-inline-image-p' returns a non-nil value when the link
3882 ;; provided should be considered as an inline image.
3883 ;;
3884 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3885 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3886 ;; returns an appropriate unique identifier when found, or nil.
3887 ;;
3888 ;; `org-export-resolve-id-link' returns the first headline with
3889 ;; specified id or custom-id in parse tree, the path to the external
3890 ;; file with the id or nil when neither was found.
3891 ;;
3892 ;; `org-export-resolve-coderef' associates a reference to a line
3893 ;; number in the element it belongs, or returns the reference itself
3894 ;; when the element isn't numbered.
3897 "Take link text S and make a safe target out of it."
3902 "Return format string for code reference link.
3903 PATH is the link path. DESC is its description."
3911 "Non-nil if LINK object points to an inline image.
3913 Optional argument is a set of RULES defining inline images. It
3914 is an alist where associations have the following shape:
3916 \(TYPE . REGEXP)
3918 Applying a rule means apply REGEXP against LINK's path when its
3919 type is TYPE. The function will return a non-nil value if any of
3920 the provided rules is non-nil. The default rule is
3921 `org-export-default-inline-image-rule'.
3923 This only applies to links without a description."
3934 rules)
3935 ;; Return nil if no rule matched.
3936 nil))))
3939 "Resolve a code reference REF.
3941 INFO is a plist used as a communication channel.
3943 Return associated line number in source code, or REF itself,
3944 depending on src-block or example element's switches."
3951 org-coderef-label-format)))
3955 ;; Element containing REF is found. Resolve it to either
3956 ;; a label or a line number, as needed.
3966 "Return LINK destination.
3968 INFO is a plist holding contextual information.
3970 Return value can be an object, an element, or nil:
3972 - If LINK path matches a target object (i.e. <<path>>) return it.
3974 - If LINK path exactly matches the name affiliated keyword
3975 \(i.e. #+NAME: path) of an element, return that element.
3977 - If LINK path exactly matches any headline name, return that
3978 element. If more than one headline share that name, priority
3979 will be given to the one with the closest common ancestor, if
3980 any, or the first one in the parse tree otherwise.
3982 - Otherwise, return nil.
3985 significant."
3988 ;; Split PATH at white spaces so matches are space
3989 ;; insensitive.
3992 ;; Cache for destinations that are not position dependent.
4000 ;; Destination is not position dependent: use cached value.
4002 ;; First try to find a matching "<<path>>" unless user specified
4003 ;; he was looking for a headline (path starts with a "*"
4004 ;; character).
4010 path)
4011 blob))
4014 ;; Then try to find an element with a matching "#+NAME: path"
4015 ;; affiliated keyword.
4018 org-element-all-elements
4023 el)))
4026 ;; Last case: link either points to a headline or to nothingness.
4027 ;; Try to find the source, with priority given to headlines with
4028 ;; the closest common ancestor. If such candidate is found,
4029 ;; return it, otherwise return nil.
4033 ;; Return first headline whose `:raw-value' property is
4034 ;; NAME in parse tree DATA, or nil. Statistics cookies
4035 ;; are ignored.
4043 name)
4044 headline))
4046 ;; Search among headlines sharing an ancestor with link, from
4047 ;; closest to farthest.
4056 ;; No destination found: return nil.
4060 "Return headline referenced as LINK destination.
4062 INFO is a plist used as a communication channel.
4064 Return value can be the headline element matched in current parse
4068 ;; First check if id is within the current parse tree.
4073 headline))
4075 ;; Otherwise, look for external files.
4079 "Return radio-target object referenced as LINK destination.
4081 INFO is a plist used as a communication channel.
4083 Return value can be a radio-target object or nil. Assume LINK
4092 nil nil path nil nil t)
4093 t)
4094 radio))
4098 ;;;; For References
4099 ;;
4100 ;; `org-export-get-ordinal' associates a sequence number to any object
4101 ;; or element.
4104 "Return ordinal number of an element or object.
4106 ELEMENT is the element or object considered. INFO is the plist
4107 used as a communication channel.
4109 Optional argument TYPES, when non-nil, is a list of element or
4110 object types, as symbols, that should also be counted in.
4111 Otherwise, only provided element's type is considered.
4113 Optional argument PREDICATE is a function returning a non-nil
4114 value if the current element or object should be counted in. It
4115 accepts two arguments: the element or object being considered and
4116 the plist used as a communication channel. This allows to count
4117 only a certain type of objects (i.e. inline images).
4119 Return value is a list of numbers if ELEMENT is a headline or an
4120 item. It is nil for keywords. It represents the footnote number
4121 for footnote definitions and footnote references. If ELEMENT is
4122 a target, return the same value as if ELEMENT was the closest
4123 table, item or headline containing the target. In any other
4124 case, return the sequence number of ELEMENT among elements or
4125 objects of the same type."
4126 ;; Ordinal of a target object refer to the ordinal of the closest
4127 ;; table, item, or headline containing the object.
4131 when
4135 table))
4136 return parent)))
4138 ;; Special case 1: A headline returns its number as a list.
4140 ;; Special case 2: An item returns its number as a list.
4144 struct
4151 ;; Increment counter until ELEMENT is found again.
4162 ;;;; For Src-Blocks
4163 ;;
4164 ;; `org-export-get-loc' counts number of code lines accumulated in
4165 ;; src-block or example-block elements with a "+n" switch until
4166 ;; a given element, excluded. Note: "-n" switches reset that count.
4167 ;;
4168 ;; `org-export-unravel-code' extracts source code (along with a code
4169 ;; references alist) from an `element-block' or `src-block' type
4170 ;; element.
4171 ;;
4172 ;; `org-export-format-code' applies a formatting function to each line
4173 ;; of code, providing relative line number and code reference when
4174 ;; appropriate. Since it doesn't access the original element from
4175 ;; which the source code is coming, it expects from the code calling
4176 ;; it to know if lines should be numbered and if code references
4177 ;; should appear.
4178 ;;
4179 ;; Eventually, `org-export-format-code-default' is a higher-level
4180 ;; function (it makes use of the two previous functions) which handles
4181 ;; line numbering and code references inclusion, and returns source
4182 ;; code in a format suitable for plain text or verbatim output.
4185 "Return accumulated lines of code up to ELEMENT.
4187 INFO is the plist used as a communication channel.
4189 ELEMENT is excluded from count."
4195 ;; ELEMENT is reached: Quit the loop.
4197 ;; Only count lines from src-block and example-block elements
4198 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4202 ;; Accumulate locs or reset them.
4206 ;; Return nil to stay in the loop.
4207 nil)))
4209 ;; Return value.
4210 loc))
4213 "Clean source code and extract references out of it.
4215 ELEMENT has either a `src-block' an `example-block' type.
4217 Return a cons cell whose CAR is the source code, cleaned from any
4218 reference and protective comma and CDR is an alist between
4219 relative line number (integer) and name of code reference on that
4220 line (string)."
4222 ;; Get code and clean it. Remove blank lines at its
4223 ;; beginning and end.
4229 ;; Get format used for references.
4232 org-coderef-label-format)))
4233 ;; Build a regexp matching a loc with a reference.
4238 ;; Return value.
4240 ;; Code with references removed.
4246 ;; Ref line: remove ref, and signal its position in REFS.
4250 ;; Reference alist.
4251 refs)))
4254 "Format CODE by applying FUN line-wise and return it.
4256 CODE is a string representing the code to format. FUN is
4257 a function. It must accept three arguments: a line of
4258 code (string), the current line number (integer) or nil and the
4259 reference associated to the current line (string) or nil.
4261 Optional argument NUM-LINES can be an integer representing the
4262 number of code lines accumulated until the current code. Line
4263 numbers passed to FUN will take it into account. If it is nil,
4264 FUN's second argument will always be nil. This number can be
4265 obtained with `org-export-get-loc' function.
4267 Optional argument REF-ALIST can be an alist between relative line
4268 number (i.e. ignoring NUM-LINES) and the name of the code
4269 reference on it. If it is nil, FUN's third argument will always
4270 be nil. It can be obtained through the use of
4271 `org-export-unravel-code' function."
4283 "Return source code from ELEMENT, formatted in a standard way.
4285 ELEMENT is either a `src-block' or `example-block' element. INFO
4286 is a plist used as a communication channel.
4288 This function takes care of line numbering and code references
4289 inclusion. Line numbers, when applicable, appear at the
4290 beginning of the line, separated from the code by two white
4291 spaces. Code references, on the other hand, appear flushed to
4292 the right, separated by six white spaces from the widest line of
4293 code."
4294 ;; Extract code and references.
4301 ;; Handle line numbering.
4310 ;; Prepare references display, if required. Any reference
4311 ;; should start six columns after the widest line of code,
4312 ;; wrapped with parenthesis.
4317 code
4321 number-str
4322 loc
4328 num-start refs)))))
4331 ;;;; For Tables
4332 ;;
4333 ;; `org-export-table-has-special-column-p' and and
4334 ;; `org-export-table-row-is-special-p' are predicates used to look for
4335 ;; meta-information about the table structure.
4336 ;;
4337 ;; `org-table-has-header-p' tells when the rows before the first rule
4338 ;; should be considered as table's header.
4339 ;;
4340 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4341 ;; and `org-export-table-cell-borders' extract information from
4342 ;; a table-cell element.
4343 ;;
4344 ;; `org-export-table-dimensions' gives the number on rows and columns
4345 ;; in the table, ignoring horizontal rules and special columns.
4346 ;; `org-export-table-cell-address', given a table-cell object, returns
4347 ;; the absolute address of a cell. On the other hand,
4348 ;; `org-export-get-table-cell-at' does the contrary.
4349 ;;
4350 ;; `org-export-table-cell-starts-colgroup-p',
4351 ;; `org-export-table-cell-ends-colgroup-p',
4352 ;; `org-export-table-row-starts-rowgroup-p',
4353 ;; `org-export-table-row-ends-rowgroup-p',
4354 ;; `org-export-table-row-starts-header-p' and
4355 ;; `org-export-table-row-ends-header-p' indicate position of current
4356 ;; row or cell within the table.
4359 "Non-nil when TABLE has a special column.
4360 All special columns will be ignored during export."
4361 ;; The table has a special column when every first cell of every row
4362 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4363 ;; "*" "_" and "^". Though, do not consider a first row containing
4364 ;; only empty cells as special.
4380 "Non-nil when TABLE has a header.
4382 INFO is a plist used as a communication channel.
4384 A table has a header when it contains at least two row groups."
4393 table
4404 cache)))))
4407 "Non-nil if TABLE-ROW is considered special.
4409 INFO is a plist used as the communication channel.
4411 All special rows will be ignored during export."
4415 ;; A row is special either when...
4417 ;; ... it starts with a field only containing "/",
4419 ;; ... the table contains a special column and the row start
4420 ;; with a marking character among, "^", "_", "$" or "!",
4424 ;; ... it contains only alignment cookies and empty cells.
4430 ;; Since VALUE is a secondary string, the following
4431 ;; checks avoid expanding it with `org-export-data'.
4443 "Return TABLE-ROW's group number, as an integer.
4445 INFO is a plist used as the communication channel.
4447 Return value is the group number, as an integer, or nil for
4448 special rows and rows separators. First group is also table's
4449 header."
4467 "Return TABLE-CELL contents width.
4469 INFO is a plist used as the communication channel.
4471 Return value is the width given by the last width cookie in the
4472 same column as TABLE-CELL, or nil."
4489 ;; In a special row, try to find a width cookie at COLUMN.
4493 ;; The following checks avoid expanding unnecessarily
4494 ;; the cell with `org-export-data'.
4504 "Return TABLE-CELL contents alignment.
4506 INFO is a plist used as the communication channel.
4508 Return alignment as specified by the last alignment cookie in the
4509 same column as TABLE-CELL. If no such cookie is found, a default
4510 alignment value will be deduced from fraction of numbers in the
4511 column (see `org-table-number-fraction' for more information).
4512 Possible values are `left', `right' and `center'."
4525 cookie-align
4526 previous-cell-number-p)
4529 ;; In a special row, try to find an alignment cookie at
4530 ;; COLUMN.
4534 ;; Since VALUE is a secondary string, the following
4535 ;; checks avoid useless expansion through
4536 ;; `org-export-data'.
4544 ;; Ignore table rules.
4546 ;; In a standard row, check if cell's contents are
4547 ;; expressing some kind of number. Increase NUMBER-CELLS
4548 ;; accordingly. Though, don't bother if an alignment
4549 ;; cookie has already defined cell's alignment.
4554 info)))
4556 ;; Treat an empty cell as a number if it follows
4557 ;; a number.
4563 ;; Return value. Alignment specified by cookies has
4564 ;; precedence over alignment deduced from cell's contents.
4570 org-table-number-fraction)
4573 cache)))))
4576 "Return TABLE-CELL borders.
4578 INFO is a plist used as a communication channel.
4580 Return value is a list of symbols, or nil. Possible values are:
4581 `top', `bottom', `above', `below', `left' and `right'. Note:
4582 `top' (resp. `bottom') only happen for a cell in the first
4583 row (resp. last row) of the table, ignoring table rules, if any.
4585 Returned borders ignore special rows."
4588 borders)
4589 ;; Top/above border? TABLE-CELL has a border above when a rule
4590 ;; used to demarcate row groups can be found above. Hence,
4591 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4592 ;; another regular row has to be found above that rule.
4601 ;; Look at every row before the current one.
4603 ;; No rule above, or rule found starts the table (ignoring any
4604 ;; special row): TABLE-CELL is at the top of the table.
4607 ;; Bottom/below border? TABLE-CELL has a border below when next
4608 ;; non-regular row below is a rule.
4617 ;; Look at every row after the current one.
4619 ;; No rule below, or rule found ends the table (modulo some
4620 ;; special row): TABLE-CELL is at the bottom of the table.
4623 ;; Right/left borders? They can only be specified by column
4624 ;; groups. Column groups are defined in a row starting with "/".
4625 ;; Also a column groups row only contains "<", "<>", ">" or blank
4626 ;; cells.
4643 ;; There's a left border when previous cell, if
4644 ;; any, ends a group, or current one starts one.
4650 ;; There's a right border when next cell, if any,
4651 ;; starts a group, or current one ends one.
4658 ;; Table rows are read in reverse order so last column groups
4659 ;; row has precedence over any previous one.
4661 ;; Return value.
4662 borders))
4665 "Non-nil when TABLE-CELL is at the beginning of a row group.
4666 INFO is a plist used as a communication channel."
4667 ;; A cell starts a column group either when it is at the beginning
4668 ;; of a row (or after the special column, if any) or when it has
4669 ;; a left border.
4672 table-cell)
4676 "Non-nil when TABLE-CELL is at the end of a row group.
4677 INFO is a plist used as a communication channel."
4678 ;; A cell ends a column group either when it is at the end of a row
4679 ;; or when it has a right border.
4682 table-cell)
4686 "Non-nil when TABLE-ROW is at the beginning of a column group.
4687 INFO is a plist used as a communication channel."
4695 "Non-nil when TABLE-ROW is at the end of a column group.
4696 INFO is a plist used as a communication channel."
4704 "Non-nil when TABLE-ROW is the first table header's row.
4705 INFO is a plist used as a communication channel."
4712 "Non-nil when TABLE-ROW is the last table header's row.
4713 INFO is a plist used as a communication channel."
4720 "Return TABLE-ROW number.
4721 INFO is a plist used as a communication channel. Return value is
4722 zero-based and ignores separators. The function returns nil for
4723 special colums and separators."
4735 "Return TABLE dimensions.
4737 INFO is a plist used as a communication channel.
4739 Return value is a CONS like (ROWS . COLUMNS) where
4740 ROWS (resp. COLUMNS) is the number of exportable
4741 rows (resp. columns)."
4743 ;; Set number of rows, and extract first one.
4749 ;; Set number of columns.
4751 ;; Return value.
4755 "Return address of a regular TABLE-CELL object.
4757 TABLE-CELL is the cell considered. INFO is a plist used as
4758 a communication channel.
4760 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4761 zero-based index. Only exportable cells are considered. The
4762 function returns nil for other cells."
4774 "Return regular table-cell object at ADDRESS in TABLE.
4776 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4777 zero-based index. TABLE is a table type element. INFO is
4778 a plist used as a communication channel.
4780 If no table-cell, among exportable cells, is found at ADDRESS,
4781 return nil."
4784 ;; Row at (car address) or nil.
4792 'table-cell
4799 ;;;; For Tables Of Contents
4800 ;;
4801 ;; `org-export-collect-headlines' builds a list of all exportable
4802 ;; headline elements, maybe limited to a certain depth. One can then
4803 ;; easily parse it and transcode it.
4804 ;;
4805 ;; Building lists of tables, figures or listings is quite similar.
4806 ;; Once the generic function `org-export-collect-elements' is defined,
4807 ;; `org-export-collect-tables', `org-export-collect-figures' and
4808 ;; `org-export-collect-listings' can be derived from it.
4811 "Collect headlines in order to build a table of contents.
4813 INFO is a plist used as a communication channel.
4815 When optional argument N is an integer, it specifies the depth of
4816 the table of contents. Otherwise, it is set to the value of the
4817 last headline level. See `org-export-headline-levels' for more
4818 information.
4820 Return a list of all exportable headlines as parsed elements.
4821 Footnote sections, if any, will be ignored."
4826 ;; Strip contents from HEADLINE.
4829 info))
4832 "Collect referenceable elements of a determined type.
4834 TYPE can be a symbol or a list of symbols specifying element
4835 types to search. Only elements with a caption are collected.
4837 INFO is a plist used as a communication channel.
4839 When non-nil, optional argument PREDICATE is a function accepting
4840 one argument, an element of type TYPE. It returns a non-nil
4841 value when that element should be collected.
4843 Return a list of all elements found, in order of appearance."
4848 element))
4849 info))
4852 "Build a list of tables.
4853 INFO is a plist used as a communication channel.
4855 Return a list of table elements with a caption."
4859 "Build a list of figures.
4861 INFO is a plist used as a communication channel. PREDICATE is
4862 a function which accepts one argument: a paragraph element and
4863 whose return value is non-nil when that element should be
4864 collected.
4866 A figure is a paragraph type element, with a caption, verifying
4868 a vague concept that may depend on back-end.
4870 Return a list of elements recognized as figures."
4874 "Build a list of src blocks.
4876 INFO is a plist used as a communication channel.
4878 Return a list of src-block elements with a caption."
4882 ;;;; Smart Quotes
4883 ;;
4884 ;; The main function for the smart quotes sub-system is
4885 ;; `org-export-activate-smart-quotes', which replaces every quote in
4886 ;; a given string from the parse tree with its "smart" counterpart.
4887 ;;
4888 ;; Dictionary for smart quotes is stored in
4889 ;; `org-export-smart-quotes-alist'.
4890 ;;
4891 ;; Internally, regexps matching potential smart quotes (checks at
4892 ;; string boundaries are also necessary) are defined in
4893 ;; `org-export-smart-quotes-regexps'.
4930 "Smart quotes translations.
4932 Alist whose CAR is a language string and CDR is an alist with
4933 quote type as key and a plist associating various encodings to
4934 their translation as value.
4936 A quote type can be any symbol among `opening-double-quote',
4937 `closing-double-quote', `opening-single-quote',
4938 `closing-single-quote' and `apostrophe'.
4940 Valid encodings include `:utf-8', `:html', `:latex' and
4941 `:texinfo'.
4947 ;; Possible opening quote at beginning of string.
4949 ;; Possible closing quote at beginning of string.
4951 ;; Possible apostrophe at beginning of string.
4953 ;; Opening single and double quotes.
4955 ;; Closing single and double quotes.
4957 ;; Apostrophe.
4959 ;; Possible opening quote at end of string.
4961 ;; Possible closing quote at end of string.
4963 ;; Possible apostrophe at end of string.
4965 "List of regexps matching a quote or an apostrophe.
4971 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4972 `:utf-8'. INFO is a plist used as a communication channel.
4974 The function has to retrieve information about string
4975 surroundings in parse tree. It can only happen with an
4976 unmodified string. Thus, if S has already been through another
4977 process, a non-nil ORIGINAL optional argument will provide that
4978 original string.
4980 Return the new string."
4983 ;; Try to be flexible when computing number of blanks
4984 ;; before object. The previous object may be a string
4985 ;; introduced by the back-end and not completely parsed.
4988 ;; A string with missing `:post-blank'
4989 ;; property.
4993 ;; Fallback value.
4998 ;; Return smart quote associated to a give quote Q, as
4999 ;; a string. TYPE is a symbol among `open', `close' and
5000 ;; `apostrophe'.
5010 org-export-smart-quotes-alist))))
5011 encoding)
5012 q)))))
5014 ;; Only a quote: no regexp can match. We have to check both
5015 ;; sides and decide what to do.
5023 ;; 1. Replace quote character at the beginning of S.
5025 ;; Apostrophe?
5031 ;; Closing quote?
5037 ;; Opening quote?
5043 ;; 2. Replace quotes in the middle of the string.
5045 ;; Opening quotes.
5051 ;; Closing quotes.
5057 ;; Apostrophes.
5062 ;; 3. Replace quote character at the end of S.
5064 ;; Apostrophe?
5069 ;; Closing quote?
5075 ;; Opening quote?
5080 ;; Return string with smart quotes.
5081 s))))
5083 ;;;; Topology
5084 ;;
5085 ;; Here are various functions to retrieve information about the
5086 ;; neighbourhood of a given element or object. Neighbours of interest
5087 ;; are direct parent (`org-export-get-parent'), parent headline
5088 ;; (`org-export-get-parent-headline'), first element containing an
5089 ;; object, (`org-export-get-parent-element'), parent table
5090 ;; (`org-export-get-parent-table'), previous element or object
5091 ;; (`org-export-get-previous-element') and next element or object
5092 ;; (`org-export-get-next-element').
5093 ;;
5094 ;; `org-export-get-genealogy' returns the full genealogy of a given
5095 ;; element or object, from closest parent to full parse tree.
5098 "Return BLOB parent or nil.
5099 BLOB is the element or object considered."
5103 "Return full genealogy relative to a given element or object.
5105 BLOB is the element or object being considered.
5107 Ancestors are returned from closest to farthest, the last one
5108 being the full parse tree."
5115 "Return BLOB parent headline or nil.
5116 BLOB is the element or object being considered."
5120 parent))
5123 "Return first element containing OBJECT or nil.
5124 OBJECT is the object to consider."
5128 parent))
5131 "Return OBJECT parent table or nil.
5132 OBJECT is either a `table-cell' or `table-element' type object."
5136 parent))
5139 "Return previous element or object.
5141 BLOB is an element or object. INFO is a plist used as
5142 a communication channel. Return previous exportable element or
5143 object, a string, or nil.
5145 When optional argument N is a positive integer, return a list
5146 containing up to N siblings before BLOB, from farthest to
5147 closest. With any other non-nil value, return a list containing
5148 all of them."
5150 ;; An object can belong to the contents of its parent or
5151 ;; to a secondary string. We check the latter option
5152 ;; first.
5155 org-element-all-elements))
5159 org-element-secondary-value-alist))
5160 parent)))
5163 prev)
5172 prev)))
5175 "Return next element or object.
5177 BLOB is an element or object. INFO is a plist used as
5178 a communication channel. Return next exportable element or
5179 object, a string, or nil.
5181 When optional argument N is a positive integer, return a list
5182 containing up to N siblings after BLOB, from closest to farthest.
5183 With any other non-nil value, return a list containing all of
5184 them."
5186 ;; An object can belong to the contents of its parent or to
5187 ;; a secondary string. We check the latter option first.
5190 org-element-all-objects))
5194 org-element-secondary-value-alist))
5195 parent)))
5198 next)
5206 siblings)
5210 ;;;; Translation
5211 ;;
5212 ;; `org-export-translate' translates a string according to the language
5213 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5214 ;; the dictionary used for the translation.
5344 "Dictionary for export engine.
5346 Alist whose CAR is the string to translate and CDR is an alist
5347 whose CAR is the language string and CDR is a plist whose
5348 properties are possible charsets and values translated terms.
5350 It is used as a database for `org-export-translate'. Since this
5351 function returns the string as-is if no translation was found,
5352 the variable only needs to record values different from the
5356 "Translate string S according to language specification.
5358 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5359 and `:utf-8'. INFO is a plist used as a communication channel.
5361 Translation depends on `:language' property. Return the
5362 translated string. If no translation is found, try to fall back
5363 to `:default' encoding. If it fails, return S."
5369 s)))
5372 \f
5373 ;;; Asynchronous Export
5374 ;;
5375 ;; `org-export-async-start' is the entry point for asynchronous
5376 ;; export. It recreates current buffer (including visibility,
5377 ;; narrowing and visited file) in an external Emacs process, and
5378 ;; evaluates a command there. It then applies a function on the
5379 ;; returned results in the current process.
5380 ;;
5381 ;; Asynchronously generated results are never displayed directly.
5382 ;; Instead, they are stored in `org-export-stack-contents'. They can
5383 ;; then be retrieved by calling `org-export-stack'.
5384 ;;
5385 ;; Export Stack is viewed through a dedicated major mode
5386 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5387 ;;`org-export-stack-delete', `org-export-stack-view' and
5388 ;;`org-export-stack-clear'.
5389 ;;
5390 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5391 ;; It should used whenever `org-export-async-start' is called.
5394 "Call function FUN on the results returned by BODY evaluation.
5396 BODY evaluation happens in an asynchronous process, from a buffer
5397 which is an exact copy of the current one.
5399 Use `org-export-add-to-stack' in FUN in order to register results
5400 in the stack. Examples for, respectively a temporary buffer and
5401 a file are:
5403 \(org-export-async-start
5404 \(lambda (output)
5406 \(erase-buffer)
5407 \(insert output)
5408 \(goto-char (point-min))
5409 \(org-export-add-to-stack (current-buffer) 'backend)))
5410 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5412 and
5414 \(org-export-async-start
5415 \(lambda (f) (org-export-add-to-stack f 'backend))
5416 `(expand-file-name
5417 \(org-export-to-file
5418 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5421 ;; Write the full sexp evaluating BODY in a copy of the current
5422 ;; buffer to a temporary file, as it may be too long for program
5423 ;; args in `start-process'.
5430 ;; Null characters (from variable values) are inserted
5431 ;; within the file. As a consequence, coding system for
5432 ;; buffer contents will not be recognized properly. So,
5433 ;; we make sure it is the same as the one used to display
5434 ;; the original buffer.
5436 ,coding
5439 ;; Ignore `kill-emacs-hook' and code evaluation
5440 ;; queries from Babel as we need a truly
5441 ;; non-interactive process.
5443 org-babel-confirm-evaluate-answer-no t)
5444 ;; Initialize export framework.
5446 ;; Re-create current buffer there.
5449 ;; Sexp to evaluate in the buffer.
5451 ;; Start external process.
5454 (,process
5459 "-l" org-export-async-init-file
5461 ;; Register running process in stack.
5463 ;; Set-up sentinel in order to catch results.
5465 ,process
5489 "Add a new result to export stack if not present already.
5491 SOURCE is a buffer or a file name containing export results.
5492 BACKEND is a symbol representing export back-end used to generate
5493 it.
5495 Entries already pointing to SOURCE and unavailable entries are
5496 removed beforehand. Return the new stack."
5502 "Menu for asynchronous export results and running processes."
5512 "Return source from export results at point in stack."
5519 source
5520 ;; SOURCE is not consistent with current line. The stack
5521 ;; view is outdated.
5525 "Remove all entries from export stack."
5530 "Refresh the asynchronous export stack.
5531 DUMMY is ignored. Unavailable sources are removed from the list.
5532 Return the new stack."
5542 ;; Back-end.
5544 ;; Age.
5547 ;; Compute age of the results.
5549 "%4h:%.2m "
5551 ;; Source.
5556 ;; Clear stack from exited processes, dead buffers or
5557 ;; non-existent files.
5569 "Remove export results at point from stack.
5570 If optional argument SOURCE is non-nil, remove it instead."
5575 org-export-stack-contents))))
5578 "View export results at point in stack.
5579 With an optional prefix argument IN-EMACS, force viewing files
5580 within Emacs."
5594 (define-key km "p" 'previous-line)
5595 (define-key km "\C-p" 'previous-line)
5596 (define-key km "\C-?" 'previous-line)
5597 (define-key km [up] 'previous-line)
5598 (define-key km "C" 'org-export-stack-clear)
5599 (define-key km "v" 'org-export-stack-view)
5600 (define-key km (kbd "RET") 'org-export-stack-view)
5601 (define-key km "d" 'org-export-stack-remove)
5602 km)
5603 "Keymap for Org Export Stack.")
5605 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5606 "Mode for displaying asynchronous export stack.
5609 stack.
5611 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5612 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5613 stack completely.
5615 Removing entries in an Org Export Stack buffer doesn't affect
5616 files or buffers, only the display.
5619 (abbrev-mode 0)
5620 (auto-fill-mode 0)
5621 (setq buffer-read-only t
5622 buffer-undo-list t
5623 truncate-lines t
5624 header-line-format
5625 '(:eval
5626 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5627 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5628 (set (make-local-variable 'revert-buffer-function)
5629 'org-export-stack-refresh))
5632 \f
5633 ;;; The Dispatcher
5634 ;;
5635 ;; `org-export-dispatch' is the standard interactive way to start an
5636 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5637 ;; for its interface, which, in turn, delegates response to key
5638 ;; pressed to `org-export--dispatch-action'.
5640 ;;;###autoload
5641 (defun org-export-dispatch (&optional arg)
5642 "Export dispatcher for Org mode.
5644 It provides an access to common export related tasks in a buffer.
5645 Its interface comes in two flavours: standard and expert.
5647 While both share the same set of bindings, only the former
5648 displays the valid keys associations in a dedicated buffer.
5649 Scrolling (resp. line-wise motion) in this buffer is done with
5650 SPC and DEL (resp. C-n and C-p) keys.
5652 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5653 flavour or the other.
5656 of options used back then, on the current buffer.
5658 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5659 (interactive "P")
5660 (let* ((input
5661 (cond ((equal arg '(16)) '(stack))
5662 ((and arg org-export-dispatch-last-action))
5663 (t (save-window-excursion
5664 (unwind-protect
5665 (progn
5666 ;; Remember where we are
5667 (move-marker org-export-dispatch-last-position
5668 (point)
5669 (org-base-buffer (current-buffer)))
5670 ;; Get and store an export command
5671 (setq org-export-dispatch-last-action
5672 (org-export--dispatch-ui
5673 (list org-export-initial-scope
5674 (and org-export-in-background 'async))
5675 nil
5676 org-export-dispatch-use-expert-ui)))
5677 (and (get-buffer "*Org Export Dispatcher*")
5678 (kill-buffer "*Org Export Dispatcher*")))))))
5679 (action (car input))
5680 (optns (cdr input)))
5681 (unless (memq 'subtree optns)
5682 (move-marker org-export-dispatch-last-position nil))
5683 (case action
5684 ;; First handle special hard-coded actions.
5685 (template (org-export-insert-default-template nil optns))
5686 (stack (org-export-stack))
5687 (publish-current-file
5688 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5689 (publish-current-project
5690 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5691 (publish-choose-project
5692 (org-publish (assoc (org-icompleting-read
5693 "Publish project: "
5694 org-publish-project-alist nil t)
5695 org-publish-project-alist)
5696 (memq 'force optns)
5697 (memq 'async optns)))
5698 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5699 (otherwise
5700 (save-excursion
5701 (when arg
5702 ;; Repeating command, maybe move cursor to restore subtree
5703 ;; context.
5704 (if (eq (marker-buffer org-export-dispatch-last-position)
5705 (org-base-buffer (current-buffer)))
5706 (goto-char org-export-dispatch-last-position)
5707 ;; We are in a different buffer, forget position.
5708 (move-marker org-export-dispatch-last-position nil)))
5709 (funcall action
5710 ;; Return a symbol instead of a list to ease
5711 ;; asynchronous export macro use.
5712 (and (memq 'async optns) t)
5713 (and (memq 'subtree optns) t)
5714 (and (memq 'visible optns) t)
5715 (and (memq 'body optns) t)))))))
5717 (defun org-export--dispatch-ui (options first-key expertp)
5718 "Handle interface for `org-export-dispatch'.
5720 OPTIONS is a list containing current interactive options set for
5721 export. It can contain any of the following symbols:
5722 `body' toggles a body-only export
5723 `subtree' restricts export to current subtree
5724 `visible' restricts export to visible part of buffer.
5725 `force' force publishing files.
5726 `async' use asynchronous export process
5728 FIRST-KEY is the key pressed to select the first level menu. It
5729 is nil when this menu hasn't been selected yet.
5731 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5732 buffer is provided, but indications about currently active
5733 options are given in the prompt. Moreover, \[?] allows to switch
5734 back to standard interface."
5735 (let* ((fontify-key
5736 (lambda (key &optional access-key)
5737 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5738 ;; non-nil is the required first-level key to activate
5739 ;; KEY. When its value is t, activate KEY independently
5740 ;; on the first key, if any. A nil value means KEY will
5741 ;; only be activated at first level.
5742 (if (or (eq access-key t) (eq access-key first-key))
5743 (org-propertize key 'face 'org-warning)
5744 key)))
5745 (fontify-value
5746 (lambda (value)
5747 ;; Fontify VALUE string.
5748 (org-propertize value 'face 'font-lock-variable-name-face)))
5749 ;; Prepare menu entries by extracting them from
5750 ;; `org-export-registered-backends', and sorting them by
5751 ;; access key and by ordinal, if any.
5752 (backends
5753 (sort
5754 (sort
5755 (delq nil
5756 (mapcar
5757 (lambda (b)
5758 (let ((name (car b)))
5759 (catch 'ignored
5760 ;; Ignore any back-end belonging to
5761 ;; `org-export-invisible-backends' or derived
5762 ;; from one of them.
5763 (dolist (ignored org-export-invisible-backends)
5764 (when (org-export-derived-backend-p name ignored)
5765 (throw 'ignored nil)))
5766 (org-export-backend-menu name))))
5767 org-export-registered-backends))
5768 (lambda (a b)
5769 (let ((key-a (nth 1 a))
5770 (key-b (nth 1 b)))
5771 (cond ((and (numberp key-a) (numberp key-b))
5772 (< key-a key-b))
5773 ((numberp key-b) t)))))
5774 (lambda (a b) (< (car a) (car b)))))
5775 ;; Compute a list of allowed keys based on the first key
5776 ;; pressed, if any. Some keys
5777 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
5778 ;; available.
5779 (allowed-keys
5780 (nconc (list 2 22 19 6 1)
5781 (if (not first-key) (org-uniquify (mapcar 'car backends))
5782 (let (sub-menu)
5783 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5784 (when (eq (car backend) first-key)
5785 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5786 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5787 ((not first-key) (list ?P)))
5788 (list ?& ?#)
5789 (when expertp (list ??))
5790 (list ?q)))
5791 ;; Build the help menu for standard UI.
5792 (help
5793 (unless expertp
5794 (concat
5795 ;; Options are hard-coded.
5796 (format "[%s] Body only: %s [%s] Visible only: %s
5797 \[%s] Export scope: %s [%s] Force publishing: %s
5799 (funcall fontify-key "C-b" t)
5800 (funcall fontify-value
5801 (if (memq 'body options) "On " "Off"))
5802 (funcall fontify-key "C-v" t)
5803 (funcall fontify-value
5804 (if (memq 'visible options) "On " "Off"))
5805 (funcall fontify-key "C-s" t)
5806 (funcall fontify-value
5807 (if (memq 'subtree options) "Subtree" "Buffer "))
5808 (funcall fontify-key "C-f" t)
5809 (funcall fontify-value
5810 (if (memq 'force options) "On " "Off"))
5811 (funcall fontify-key "C-a" t)
5812 (funcall fontify-value
5813 (if (memq 'async options) "On " "Off")))
5814 ;; Display registered back-end entries. When a key
5815 ;; appears for the second time, do not create another
5816 ;; entry, but append its sub-menu to existing menu.
5817 (let (last-key)
5818 (mapconcat
5819 (lambda (entry)
5820 (let ((top-key (car entry)))
5821 (concat
5822 (unless (eq top-key last-key)
5823 (setq last-key top-key)
5825 (funcall fontify-key (char-to-string top-key))
5826 (nth 1 entry)))
5827 (let ((sub-menu (nth 2 entry)))
5828 (unless (functionp sub-menu)
5829 ;; Split sub-menu into two columns.
5830 (let ((index -1))
5831 (concat
5832 (mapconcat
5833 (lambda (sub-entry)
5834 (incf index)
5835 (format
5836 (if (zerop (mod index 2)) " [%s] %-26s"
5838 (funcall fontify-key
5839 (char-to-string (car sub-entry))
5840 top-key)
5841 (nth 1 sub-entry)))
5842 sub-menu "")
5844 backends ""))
5845 ;; Publishing menu is hard-coded.
5847 [%s] Current file [%s] Current project
5849 (funcall fontify-key "P")
5850 (funcall fontify-key "f" ?P)
5851 (funcall fontify-key "p" ?P)
5852 (funcall fontify-key "x" ?P)
5853 (funcall fontify-key "a" ?P))
5855 (funcall fontify-key "&" t)
5856 (funcall fontify-key "#" t))
5857 (format "[%s] %s"
5858 (funcall fontify-key "q" t)
5859 (if first-key "Main menu" "Exit")))))
5860 ;; Build prompts for both standard and expert UI.
5861 (standard-prompt (unless expertp "Export command: "))
5862 (expert-prompt
5863 (when expertp
5864 (format
5865 "Export command (C-%s%s%s%s%s) [%s]: "
5866 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5867 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5868 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5869 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5870 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5871 (mapconcat (lambda (k)
5872 ;; Strip control characters.
5873 (unless (< k 27) (char-to-string k)))
5874 allowed-keys "")))))
5875 ;; With expert UI, just read key with a fancy prompt. In standard
5876 ;; UI, display an intrusive help buffer.
5877 (if expertp
5878 (org-export--dispatch-action
5879 expert-prompt allowed-keys backends options first-key expertp)
5880 ;; At first call, create frame layout in order to display menu.
5881 (unless (get-buffer "*Org Export Dispatcher*")
5882 (delete-other-windows)
5883 (org-switch-to-buffer-other-window
5884 (get-buffer-create "*Org Export Dispatcher*"))
5885 (setq cursor-type nil
5886 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
5887 ;; Make sure that invisible cursor will not highlight square
5888 ;; brackets.
5889 (set-syntax-table (copy-syntax-table))
5890 (modify-syntax-entry ?\[ "w"))
5891 ;; At this point, the buffer containing the menu exists and is
5892 ;; visible in the current window. So, refresh it.
5893 (with-current-buffer "*Org Export Dispatcher*"
5894 ;; Refresh help. Maintain display continuity by re-visiting
5895 ;; previous window position.
5896 (let ((pos (window-start)))
5897 (erase-buffer)
5898 (insert help)
5899 (set-window-start nil pos)))
5900 (org-fit-window-to-buffer)
5901 (org-export--dispatch-action
5902 standard-prompt allowed-keys backends options first-key expertp))))
5904 (defun org-export--dispatch-action
5905 (prompt allowed-keys backends options first-key expertp)
5906 "Read a character from command input and act accordingly.
5908 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5909 a list of characters available at a given step in the process.
5910 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5911 EXPERTP are the same as defined in `org-export--dispatch-ui',
5912 which see.
5914 Toggle export options when required. Otherwise, return value is
5915 a list with action as CAR and a list of interactive export
5916 options as CDR."
5917 (let (key)
5918 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
5919 ;; C-p, SPC, DEL).
5920 (while (and (setq key (read-char-exclusive prompt))
5921 (not expertp)
5922 (memq key '(14 16 ?\s ?\d)))
5923 (case key
5924 (14 (if (not (pos-visible-in-window-p (point-max)))
5925 (ignore-errors (scroll-up 1))
5926 (message "End of buffer")
5927 (sit-for 1)))
5928 (16 (if (not (pos-visible-in-window-p (point-min)))
5929 (ignore-errors (scroll-down 1))
5930 (message "Beginning of buffer")
5931 (sit-for 1)))
5932 (?\s (if (not (pos-visible-in-window-p (point-max)))
5933 (scroll-up nil)
5934 (message "End of buffer")
5935 (sit-for 1)))
5936 (?\d (if (not (pos-visible-in-window-p (point-min)))
5937 (scroll-down nil)
5938 (message "Beginning of buffer")
5939 (sit-for 1)))))
5940 (cond
5941 ;; Ignore undefined associations.
5942 ((not (memq key allowed-keys))
5943 (ding)
5944 (unless expertp (message "Invalid key") (sit-for 1))
5945 (org-export--dispatch-ui options first-key expertp))
5946 ;; q key at first level aborts export. At second level, cancel
5947 ;; first key instead.
5948 ((eq key ?q) (if (not first-key) (error "Export aborted")
5949 (org-export--dispatch-ui options nil expertp)))
5950 ;; Help key: Switch back to standard interface if expert UI was
5951 ;; active.
5952 ((eq key ??) (org-export--dispatch-ui options first-key nil))
5953 ;; Send request for template insertion along with export scope.
5954 ((eq key ?#) (cons 'template (memq 'subtree options)))
5955 ;; Switch to asynchronous export stack.
5956 ((eq key ?&) '(stack))
5957 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
5958 ((memq key '(2 22 19 6 1))
5959 (org-export--dispatch-ui
5960 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
5961 (6 'force) (1 'async))))
5962 (if (memq option options) (remq option options)
5963 (cons option options)))
5964 first-key expertp))
5965 ;; Action selected: Send key and options back to
5966 ;; `org-export-dispatch'.
5967 ((or first-key (functionp (nth 2 (assq key backends))))
5968 (cons (cond
5969 ((not first-key) (nth 2 (assq key backends)))
5970 ;; Publishing actions are hard-coded. Send a special
5971 ;; signal to `org-export-dispatch'.
5972 ((eq first-key ?P)
5973 (case key
5974 (?f 'publish-current-file)
5975 (?p 'publish-current-project)
5976 (?x 'publish-choose-project)
5977 (?a 'publish-all)))
5978 ;; Return first action associated to FIRST-KEY + KEY
5979 ;; path. Indeed, derived backends can share the same
5980 ;; FIRST-KEY.
5981 (t (catch 'found
5982 (mapc (lambda (backend)
5983 (let ((match (assq key (nth 2 backend))))
5984 (when match (throw 'found (nth 2 match)))))
5985 (member (assq first-key backends) backends)))))
5986 options))
5987 ;; Otherwise, enter sub-menu.
5988 (t (org-export--dispatch-ui options key expertp)))))
5992 (provide 'ox)
5994 ;; Local variables:
5995 ;; generated-autoload-file: "org-loaddefs.el"
5996 ;; End:
5998 ;;; ox.el ends here