| blob | 8c68cdac42421cfbada4803cfd9f9645e8c8df5a |
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 ;; For compatibility with Org < 8
306 "Name, if any, of the back-end used during an export process.
308 Its value is a symbol such as `html', `latex', `ascii', or nil if
309 the back-end is anonymous (see `org-export-create-backend') or if
310 there is no export process in progress.
312 It can be used to teach Babel blocks how to act differently
315 \f
316 ;;; User-configurable Variables
317 ;;
318 ;; Configuration for the masses.
319 ;;
320 ;; They should never be accessed directly, as their value is to be
321 ;; stored in a property list (cf. `org-export-options-alist').
322 ;; Back-ends will read their value from there instead.
325 "Options for exporting Org mode files."
330 "General options for export engine."
335 "Whether sub-trees with the ARCHIVE tag should be exported.
337 This can have three different values:
338 nil Do not export, pretend this tree is not present.
339 t Do export the entire tree.
340 `headline' Only export the headline, but skip the tree below it.
342 This option can also be set with the OPTIONS keyword,
351 "Non-nil means insert author name into the exported file.
352 This option can also be set with the OPTIONS keyword,
358 "Non-nil means export CLOCK keywords.
359 This option can also be set with the OPTIONS keyword,
365 "Non-nil means the postamble should contain a creator sentence.
367 The sentence can be set in `org-export-creator-string' and
370 If the value is `comment' insert it as a comment."
378 "Non-nil means insert date in the exported document.
379 This option can also be set with the OPTIONS keyword,
385 "Time-stamp format string to use for DATE keyword.
387 The format string, when specified, only applies if date consists
388 in a single time-stamp. Otherwise its value will be ignored.
390 See `format-time-string' for details on how to build this
391 string."
399 emacs-version
401 "Information about the creator of the document.
402 This option can also be set on with the CREATOR keyword."
407 "Non-nil means export contents of standard drawers.
409 When t, all drawers are exported. This may also be a list of
410 drawer names to export. If that list starts with `not', only
411 drawers with such names will be ignored.
413 This variable doesn't apply to properties drawers.
415 This option can also be set with the OPTIONS keyword,
428 :inline t
432 "Non-nil means insert author email into the exported file.
433 This option can also be set with the OPTIONS keyword,
439 "Non-nil means interpret *word*, /word/, _word_ and +word+.
441 If the export target supports emphasizing text, the word will be
442 typeset in bold, italic, with an underline or strike-through,
443 respectively.
445 This option can also be set with the OPTIONS keyword,
451 "Tags that exclude a tree from export.
453 All trees carrying any of these tags will be excluded from
454 export. This is without condition, so even subtrees inside that
455 carry one of the `org-export-select-tags' will be removed.
457 This option can also be set with the EXCLUDE_TAGS keyword."
464 This can be used to have pre-formatted text, fragments of code
465 etc. For example:
466 : ;; Some Lisp examples
467 : (while (defc cnt)
468 : (ding))
469 will be looking just like this in also HTML. See also the QUOTE
470 keyword. Not all export backends support this.
472 This option can also be set with the OPTIONS keyword,
478 "Non-nil means Org footnotes should be exported.
479 This option can also be set with the OPTIONS keyword,
485 "Non-nil means process LaTeX environments and fragments.
487 This option can also be set with the OPTIONS line,
490 nil Ignore math snippets.
491 `verbatim' Keep everything in verbatim.
492 t Allow export of math snippets."
502 "The last level which is still exported as a headline.
504 Inferior levels will usually produce itemize or enumerate lists
505 when exported, but back-end behaviour may differ.
507 This option can also be set with the OPTIONS keyword,
513 "The default language for export and clocktable translations, as a string.
514 This may have an association in
515 `org-clock-clocktable-language-setup'. This option can also be
516 set with the LANGUAGE keyword."
521 "Non-nil means preserve all line breaks when exporting.
522 This option can also be set with the OPTIONS keyword,
528 "Non-nil means interpret entities when exporting.
531 Å.
533 For a list of supported names, see the constant `org-entities'
534 and the user option `org-entities-user'.
536 This option can also be set with the OPTIONS keyword,
542 "Non-nil means inlinetasks should be exported.
543 This option can also be set with the OPTIONS keyword,
551 "Non-nil means include planning info in export.
553 Planning info is the line containing either SCHEDULED:,
554 DEADLINE:, CLOSED: time-stamps, or a combination of them.
556 This option can also be set with the OPTIONS keyword,
564 "Non-nil means include priority cookies in export.
565 This option can also be set with the OPTIONS keyword,
571 "Non-nil means add section numbers to headlines when exporting.
573 When set to an integer n, numbering will only happen for
574 headlines whose relative level is higher or equal to n.
576 This option can also be set with the OPTIONS keyword,
582 "Tags that select a tree for export.
584 If any such tag is found in a buffer, all trees that do not carry
585 one of these tags will be ignored during export. Inside trees
586 that are selected like this, you can still deselect a subtree by
587 tagging it with one of the `org-export-exclude-tags'.
589 This option can also be set with the SELECT_TAGS keyword."
594 "Non-nil means activate smart quotes during export.
595 This option can also be set with the OPTIONS keyword,
598 When setting this to non-nil, you need to take care of
599 using the correct Babel package when exporting to LaTeX.
600 E.g., you can load Babel for french like this:
611 When this option is turned on, these strings will be exported as:
613 Org HTML LaTeX UTF-8
614 -----+----------+--------+-------
616 -- – -- –
617 --- — --- —
620 This option can also be set with the OPTIONS keyword,
626 "Non-nil means include statistics cookies in export.
627 This option can also be set with the OPTIONS keyword,
637 When this option is turned on, you can use TeX-like syntax for
639 will be considered as a single item - so grouping with {} is
640 normally not needed. For example, the following things will be
641 parsed as single sub- or superscripts.
643 10^24 or 10^tau several digits will be considered 1 item.
644 10^-12 or 10^-tau a leading sign with digits or a word
645 x^2-y^3 will be read as x^2 - y^3, because items are
646 terminated by almost any nonword/nondigit char.
647 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
649 Still, ambiguity is possible - so when in doubt use {} to enclose
650 the sub/superscript. If you set this variable to the symbol
651 `{}', the braces are *required* in order to trigger
652 interpretations as sub/superscript. This can be helpful in
655 This option can also be set with the OPTIONS keyword,
664 "Non-nil means create a table of contents in exported files.
666 The TOC contains headlines with levels up
667 to`org-export-headline-levels'. When an integer, include levels
668 up to N in the toc, this may then be different from
669 `org-export-headline-levels', but it will not be allowed to be
670 larger than the number of headline levels. When nil, no table of
671 contents is made.
673 This option can also be set with the OPTIONS keyword,
683 For example:
685 | Name | Address | Birthday |
686 |-------------+----------+-----------|
687 | Arthur Dent | England | 29.2.2100 |
689 This option can also be set with the OPTIONS keyword,
695 "If nil, do not export tags, just remove them from headlines.
697 If this is the symbol `not-in-toc', tags will be removed from
698 table of contents entries, but still be shown in the headlines of
699 the document.
701 This option can also be set with the OPTIONS keyword,
710 "Non-nil means include TODO items for export.
712 This may have the following values:
713 t include tasks independent of state.
714 `todo' include only tasks that are not yet done.
715 `done' include only tasks that are already done.
716 nil ignore all tasks.
717 list of keywords include tasks with these keywords.
719 This option can also be set with the OPTIONS keyword,
731 "Non-nil means insert a time stamp into the exported file.
732 The time stamp shows when the file was created. This option can
738 "Non nil means allow timestamps in export.
740 It can be set to any of the following values:
741 t export all timestamps.
742 `active' export active timestamps only.
743 `inactive' export inactive timestamps only.
744 nil do not export timestamps
746 This only applies to timestamps isolated in a paragraph
747 containing only timestamps. Other timestamps are always
748 exported.
750 This option can also be set with the OPTIONS keyword, e.g.
760 "Non-nil means include TODO keywords in export.
761 When nil, remove all these keywords from the export. This option
767 "Non-nil means BIND keywords can define local variable values.
768 This is a potential security risk, which is why the default value
769 is nil. You can also allow them through local buffer variables."
776 "Alist between export snippets back-ends and exporter back-ends.
778 This variable allows to provide shortcuts for export snippets.
782 HTML code while every other back-end will ignore it."
791 "Coding system for the exported file."
798 "Should we push exported content to the kill ring?"
807 "The initial scope when exporting with `org-export-dispatch'.
808 This variable can be either set to `buffer' or `subtree'."
815 "Non-nil means show buffer after exporting to temp buffer.
816 When Org exports to a file, the buffer visiting that file is ever
817 shown, but remains buried. However, when exporting to
818 a temporary buffer, that buffer is popped up in a second window.
819 When this variable is nil, the buffer remains buried also in
820 these cases."
825 "Non-nil means export and publishing commands will run in background.
826 Results from an asynchronous export are never displayed
834 "File used to initialize external export process.
835 Value must be an absolute file name. It defaults to user's
836 initialization file. Though, a specific configuration makes the
837 process faster and the export more portable."
844 "List of back-ends that shouldn't appear in the dispatcher.
846 Any back-end belonging to this list or derived from a back-end
847 belonging to it will not appear in the dispatcher menu.
849 Indeed, Org may require some export back-ends without notice. If
850 these modules are never to be used interactively, adding them
851 here will avoid cluttering the dispatcher menu."
858 "Non-nil means using a non-intrusive `org-export-dispatch'.
859 In that case, no help buffer is displayed. Though, an indicator
865 asynchronous). Also, \[?] allows to switch back to standard
866 mode."
873 \f
874 ;;; Defining Back-ends
875 ;;
876 ;; `org-export-define-backend' is the standard way to define an export
877 ;; back-end. It allows to specify translators, filters, buffer
878 ;; options and a menu entry. If the new back-end shares translators
879 ;; with another back-end, `org-export-define-derived-backend' may be
880 ;; used instead.
881 ;;
882 ;; Internally, a back-end is stored as a list, of which CAR is the
883 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
884 ;; properties of a given back-end are: `org-export-backend-filters',
885 ;; `org-export-backend-menu', `org-export-backend-options' and
886 ;; `org-export-backend-translate-table'.
887 ;;
888 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
889 ;; when a given back-end hasn't been registered yet.
892 "Define a new back-end BACKEND.
894 TRANSLATORS is an alist between object or element types and
895 functions handling them.
897 These functions should return a string without any trailing
898 space, or nil. They must accept three arguments: the object or
899 element itself, its contents or nil when it isn't recursive and
900 the property list used as a communication channel.
902 Contents, when not nil, are stripped from any global indentation
903 \(although the relative one is preserved). They also always end
904 with a single newline character.
906 If, for a given type, no function is found, that element or
907 object type will simply be ignored, along with any blank line or
908 white space at its end. The same will happen if the function
909 returns the nil value. If that function returns the empty
910 string, the type will be ignored, but the blank lines or white
911 spaces will be kept.
913 In addition to element and object types, one function can be
914 associated to the `template' (or `inner-template') symbol and
915 another one to the `plain-text' symbol.
917 The former returns the final transcoded string, and can be used
918 to add a preamble and a postamble to document's body. It must
919 accept two arguments: the transcoded string and the property list
920 containing export options. A function associated to `template'
922 A function associated to `inner-template' is always applied.
924 The latter, when defined, is to be called on every text not
925 recognized as an element or an object. It must accept two
926 arguments: the text string and the information channel. It is an
927 appropriate place to protect special chars relative to the
928 back-end.
930 BODY can start with pre-defined keyword arguments. The following
931 keywords are understood:
933 :export-block
935 String, or list of strings, representing block names that
936 will not be parsed. This is used to specify blocks that will
937 contain raw code specific to the back-end. These blocks
938 still have to be handled by the relative `export-block' type
939 translator.
941 :filters-alist
943 Alist between filters and function, or list of functions,
944 specific to the back-end. See `org-export-filters-alist' for
945 a list of all allowed filters. Filters defined here
946 shouldn't make a back-end test, as it may prevent back-ends
947 derived from this one to behave properly.
949 :menu-entry
951 Menu entry for the export dispatcher. It should be a list
952 like:
954 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
956 where :
958 KEY is a free character selecting the back-end.
960 DESCRIPTION-OR-ORDINAL is either a string or a number.
962 If it is a string, is will be used to name the back-end in
963 its menu entry. If it is a number, the following menu will
964 be displayed as a sub-menu of the back-end with the same
965 KEY. Also, the number will be used to determine in which
966 order such sub-menus will appear (lowest first).
968 ACTION-OR-MENU is either a function or an alist.
970 If it is an action, it will be called with four
971 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
972 BODY-ONLY. See `org-export-as' for further explanations on
973 some of them.
975 If it is an alist, associations should follow the
976 pattern:
978 '(KEY DESCRIPTION ACTION)
980 where KEY, DESCRIPTION and ACTION are described above.
982 Valid values include:
986 or
991 \(lambda (a s v b)
992 \(if a (org-latex-export-to-pdf t s v b)
993 \(org-open-file
994 \(org-latex-export-to-pdf nil s v b)))))))
996 or the following, which will be added to the previous
997 sub-menu,
999 '(?l 1
1003 :options-alist
1005 Alist between back-end specific properties introduced in
1006 communication channel and how their value are acquired. See
1007 `org-export-options-alist' for more information about
1008 structure of the values."
1025 ;; Register back-end.
1029 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1035 export-block))))
1038 "Create a new back-end as a variant of an existing one.
1040 CHILD is the name of the derived back-end. PARENT is the name of
1041 the parent back-end.
1043 BODY can start with pre-defined keyword arguments. The following
1044 keywords are understood:
1046 :export-block
1048 String, or list of strings, representing block names that
1049 will not be parsed. This is used to specify blocks that will
1050 contain raw code specific to the back-end. These blocks
1051 still have to be handled by the relative `export-block' type
1052 translator.
1054 :filters-alist
1056 Alist of filters that will overwrite or complete filters
1057 defined in PARENT back-end. See `org-export-filters-alist'
1058 for a list of allowed filters.
1060 :menu-entry
1062 Menu entry for the export dispatcher. See
1063 `org-export-define-backend' for more information about the
1064 expected value.
1066 :options-alist
1068 Alist of back-end specific properties that will overwrite or
1069 complete those defined in PARENT back-end. Refer to
1070 `org-export-options-alist' for more information about
1071 structure of the values.
1073 :translate-alist
1075 Alist of element and object types and transcoders that will
1076 overwrite or complete transcode table from PARENT back-end.
1077 Refer to `org-export-define-backend' for detailed information
1078 about transcoders.
1081 as a variant of `latex' back-end with a custom template function:
1083 \(org-export-define-derived-backend 'my-latex 'latex
1084 :translate-alist '((template . my-latex-template-fun)))
1086 The back-end could then be called with, for example:
1112 ;; Register back-end.
1116 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1122 export-block))))
1125 "Return back-end from which BACKEND is derived, or nil."
1129 "Return filters for BACKEND."
1134 "Return menu entry for BACKEND."
1139 "Return export options for BACKEND."
1144 "Return translate table for BACKEND."
1149 "Signal an error if BACKEND isn't defined."
1154 "Non-nil if BACKEND is derived from one of BACKENDS."
1158 parent))
1161 \f
1162 ;;; The Communication Channel
1163 ;;
1164 ;; During export process, every function has access to a number of
1165 ;; properties. They are of two types:
1166 ;;
1167 ;; 1. Environment options are collected once at the very beginning of
1168 ;; the process, out of the original buffer and configuration.
1169 ;; Collecting them is handled by `org-export-get-environment'
1170 ;; function.
1171 ;;
1172 ;; Most environment options are defined through the
1173 ;; `org-export-options-alist' variable.
1174 ;;
1175 ;; 2. Tree properties are extracted directly from the parsed tree,
1176 ;; just before export, by `org-export-collect-tree-properties'.
1177 ;;
1178 ;; Here is the full list of properties available during transcode
1179 ;; process, with their category and their value type.
1180 ;;
1181 ;; + `:author' :: Author's name.
1182 ;; - category :: option
1183 ;; - type :: string
1184 ;;
1185 ;; + `:back-end' :: Current back-end used for transcoding.
1186 ;; - category :: tree
1187 ;; - type :: symbol
1188 ;;
1189 ;; + `:creator' :: String to write as creation information.
1190 ;; - category :: option
1191 ;; - type :: string
1192 ;;
1193 ;; + `:date' :: String to use as date.
1194 ;; - category :: option
1195 ;; - type :: string
1196 ;;
1197 ;; + `:description' :: Description text for the current data.
1198 ;; - category :: option
1199 ;; - type :: string
1200 ;;
1201 ;; + `:email' :: Author's email.
1202 ;; - category :: option
1203 ;; - type :: string
1204 ;;
1205 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1206 ;; process.
1207 ;; - category :: option
1208 ;; - type :: list of strings
1209 ;;
1210 ;; + `:export-options' :: List of export options available for current
1211 ;; process.
1212 ;; - category :: none
1213 ;; - type :: list of symbols, among `subtree', `body-only' and
1214 ;; `visible-only'.
1215 ;;
1216 ;; + `:exported-data' :: Hash table used for memoizing
1217 ;; `org-export-data'.
1218 ;; - category :: tree
1219 ;; - type :: hash table
1220 ;;
1221 ;; + `:filetags' :: List of global tags for buffer. Used by
1222 ;; `org-export-get-tags' to get tags with inheritance.
1223 ;; - category :: option
1224 ;; - type :: list of strings
1225 ;;
1226 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1227 ;; their definition, as parsed data. Only non-inlined footnotes
1228 ;; are represented in this alist. Also, every definition isn't
1229 ;; guaranteed to be referenced in the parse tree. The purpose of
1230 ;; this property is to preserve definitions from oblivion
1231 ;; (i.e. when the parse tree comes from a part of the original
1232 ;; buffer), it isn't meant for direct use in a back-end. To
1233 ;; retrieve a definition relative to a reference, use
1234 ;; `org-export-get-footnote-definition' instead.
1235 ;; - category :: option
1236 ;; - type :: alist (STRING . LIST)
1237 ;;
1238 ;; + `:headline-levels' :: Maximum level being exported as an
1239 ;; headline. Comparison is done with the relative level of
1240 ;; headlines in the parse tree, not necessarily with their
1241 ;; actual level.
1242 ;; - category :: option
1243 ;; - type :: integer
1244 ;;
1245 ;; + `:headline-offset' :: Difference between relative and real level
1246 ;; of headlines in the parse tree. For example, a value of -1
1247 ;; means a level 2 headline should be considered as level
1248 ;; 1 (cf. `org-export-get-relative-level').
1249 ;; - category :: tree
1250 ;; - type :: integer
1251 ;;
1252 ;; + `:headline-numbering' :: Alist between headlines and their
1253 ;; numbering, as a list of numbers
1254 ;; (cf. `org-export-get-headline-number').
1255 ;; - category :: tree
1256 ;; - type :: alist (INTEGER . LIST)
1257 ;;
1258 ;; + `:id-alist' :: Alist between ID strings and destination file's
1259 ;; path, relative to current directory. It is used by
1260 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1261 ;; external file.
1262 ;; - category :: option
1263 ;; - type :: alist (STRING . STRING)
1264 ;;
1265 ;; + `:ignore-list' :: List of elements and objects that should be
1266 ;; ignored during export.
1267 ;; - category :: tree
1268 ;; - type :: list of elements and objects
1269 ;;
1270 ;; + `:input-file' :: Full path to input file, if any.
1271 ;; - category :: option
1272 ;; - type :: string or nil
1273 ;;
1274 ;; + `:keywords' :: List of keywords attached to data.
1275 ;; - category :: option
1276 ;; - type :: string
1277 ;;
1278 ;; + `:language' :: Default language used for translations.
1279 ;; - category :: option
1280 ;; - type :: string
1281 ;;
1282 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1283 ;; transcoding.
1284 ;; - category :: option
1285 ;; - type :: list (as returned by `org-element-parse-buffer')
1286 ;;
1287 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1288 ;; all line breaks.
1289 ;; - category :: option
1290 ;; - type :: symbol (nil, t)
1291 ;;
1292 ;; + `:section-numbers' :: Non-nil means transcoding should add
1293 ;; section numbers to headlines.
1294 ;; - category :: option
1295 ;; - type :: symbol (nil, t)
1296 ;;
1297 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1298 ;; in transcoding. When such a tag is present, subtrees without
1299 ;; it are de facto excluded from the process. See
1300 ;; `use-select-tags'.
1301 ;; - category :: option
1302 ;; - type :: list of strings
1303 ;;
1304 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1305 ;; a time stamp in the output.
1306 ;; - category :: option
1307 ;; - type :: symbol (nil, t)
1308 ;;
1309 ;; + `:translate-alist' :: Alist between element and object types and
1310 ;; transcoding functions relative to the current back-end.
1311 ;; Special keys `inner-template', `template' and `plain-text' are
1312 ;; also possible.
1313 ;; - category :: option
1314 ;; - type :: alist (SYMBOL . FUNCTION)
1315 ;;
1316 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1317 ;; also be transcoded. If it is set to the `headline' symbol,
1318 ;; only the archived headline's name is retained.
1319 ;; - category :: option
1320 ;; - type :: symbol (nil, t, `headline')
1321 ;;
1322 ;; + `:with-author' :: Non-nil means author's name should be included
1323 ;; in the output.
1324 ;; - category :: option
1325 ;; - type :: symbol (nil, t)
1326 ;;
1327 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1328 ;; - category :: option
1329 ;; - type :: symbol (nil, t)
1330 ;;
1331 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1332 ;; inserted at the end of the transcoded string. If the value
1333 ;; is `comment', it should be commented.
1334 ;; - category :: option
1335 ;; - type :: symbol (`comment', nil, t)
1336 ;;
1337 ;; + `:with-date' :: Non-nil means output should contain a date.
1338 ;; - category :: option
1339 ;; - type :. symbol (nil, t)
1340 ;;
1341 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1342 ;; its value is a list of names, only drawers with such names
1343 ;; will be transcoded. If that list starts with `not', drawer
1344 ;; with these names will be skipped.
1345 ;; - category :: option
1346 ;; - type :: symbol (nil, t) or list of strings
1347 ;;
1348 ;; + `:with-email' :: Non-nil means output should contain author's
1349 ;; email.
1350 ;; - category :: option
1351 ;; - type :: symbol (nil, t)
1352 ;;
1353 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1354 ;; interpreted.
1355 ;; - category :: option
1356 ;; - type :: symbol (nil, t)
1357 ;;
1358 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1359 ;; strings starting with a colon as a fixed-with (verbatim) area.
1360 ;; - category :: option
1361 ;; - type :: symbol (nil, t)
1362 ;;
1363 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1364 ;; footnotes.
1365 ;; - category :: option
1366 ;; - type :: symbol (nil, t)
1367 ;;
1368 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1369 ;; `latex-fragment' objects should appear in export output. When
1370 ;; this property is set to `verbatim', they will be left as-is.
1371 ;; - category :: option
1372 ;; - type :: symbol (`verbatim', nil, t)
1373 ;;
1374 ;; + `:with-planning' :: Non-nil means transcoding should include
1375 ;; planning info.
1376 ;; - category :: option
1377 ;; - type :: symbol (nil, t)
1378 ;;
1379 ;; + `:with-priority' :: Non-nil means transcoding should include
1380 ;; priority cookies.
1381 ;; - category :: option
1382 ;; - type :: symbol (nil, t)
1383 ;;
1384 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1385 ;; plain text.
1386 ;; - category :: option
1387 ;; - type :: symbol (nil, t)
1388 ;;
1389 ;; + `:with-special-strings' :: Non-nil means transcoding should
1390 ;; interpret special strings in plain text.
1391 ;; - category :: option
1392 ;; - type :: symbol (nil, t)
1393 ;;
1394 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1395 ;; interpret subscript and superscript. With a value of "{}",
1396 ;; only interpret those using curly brackets.
1397 ;; - category :: option
1398 ;; - type :: symbol (nil, {}, t)
1399 ;;
1400 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1401 ;; tables.
1402 ;; - category :: option
1403 ;; - type :: symbol (nil, t)
1404 ;;
1405 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1406 ;; headlines. A `not-in-toc' value will remove them from the
1407 ;; table of contents, if any, nonetheless.
1408 ;; - category :: option
1409 ;; - type :: symbol (nil, t, `not-in-toc')
1410 ;;
1411 ;; + `:with-tasks' :: Non-nil means transcoding should include
1412 ;; headlines with a TODO keyword. A `todo' value will only
1413 ;; include headlines with a todo type keyword while a `done'
1414 ;; value will do the contrary. If a list of strings is provided,
1415 ;; only tasks with keywords belonging to that list will be kept.
1416 ;; - category :: option
1417 ;; - type :: symbol (t, todo, done, nil) or list of strings
1418 ;;
1419 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1420 ;; time stamps. Special value `active' (resp. `inactive') ask to
1421 ;; export only active (resp. inactive) timestamps. Otherwise,
1422 ;; completely remove them.
1423 ;; - category :: option
1424 ;; - type :: symbol: (`active', `inactive', t, nil)
1425 ;;
1426 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1427 ;; added to the output. An integer value limits its depth.
1428 ;; - category :: option
1429 ;; - type :: symbol (nil, t or integer)
1430 ;;
1431 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1432 ;; include TODO keywords.
1433 ;; - category :: option
1434 ;; - type :: symbol (nil, t)
1437 ;;;; Environment Options
1438 ;;
1439 ;; Environment options encompass all parameters defined outside the
1440 ;; scope of the parsed data. They come from five sources, in
1441 ;; increasing precedence order:
1442 ;;
1443 ;; - Global variables,
1444 ;; - Buffer's attributes,
1445 ;; - Options keyword symbols,
1446 ;; - Buffer keywords,
1447 ;; - Subtree properties.
1448 ;;
1449 ;; The central internal function with regards to environment options
1450 ;; is `org-export-get-environment'. It updates global variables with
1451 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1452 ;; the different sources.
1453 ;;
1454 ;; The internal functions doing the retrieval are:
1455 ;; `org-export--get-global-options',
1456 ;; `org-export--get-buffer-attributes',
1457 ;; `org-export--parse-option-keyword',
1458 ;; `org-export--get-subtree-options' and
1459 ;; `org-export--get-inbuffer-options'
1460 ;;
1461 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1462 ;; relative to "#+BIND:" keywords.
1465 "Collect export options from the current buffer.
1467 Optional argument BACKEND is a symbol specifying which back-end
1468 specific options to read, if any.
1470 When optional argument SUBTREEP is non-nil, assume the export is
1471 done against the current sub-tree.
1473 Third optional argument EXT-PLIST is a property list with
1474 external parameters overriding Org default settings, but still
1475 inferior to file-local settings."
1476 ;; First install #+BIND variables since these must be set before
1477 ;; global options are read.
1480 ;; Get and prioritize export options...
1482 ;; ... from global variables...
1484 ;; ... from an external property list...
1485 ext-plist
1486 ;; ... from in-buffer settings...
1488 ;; ... and from subtree, when appropriate.
1490 ;; Eventually add misc. properties.
1492 :back-end
1493 backend
1494 :translate-alist
1496 :footnote-definition-alist
1497 ;; Footnotes definitions must be collected in the original
1498 ;; buffer, as there's no insurance that they will still be in
1499 ;; the parse tree, due to possible narrowing.
1513 alist))))
1514 alist))
1515 :id-alist
1516 ;; Collect id references.
1527 alist))))
1530 "Parse an OPTIONS line and return values as a plist.
1531 Optional argument BACKEND is a symbol specifying which back-end
1532 specific items to read, if any."
1534 ;; Priority is given to back-end specific options.
1536 org-export-options-alist))
1537 plist)
1546 options))
1548 property
1551 plist))
1554 "Get export options in subtree at point.
1555 Optional argument BACKEND is a symbol specifying back-end used
1556 for export. Return options as a plist."
1557 ;; For each buffer keyword, create a headline property setting the
1558 ;; same property in communication channel. The name for the property
1559 ;; is the keyword with "EXPORT_" appended to it.
1562 ;; Make sure point is at a heading.
1564 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1565 ;; title as its fallback value.
1571 plist :title
1574 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1578 ;; Handle other keywords. TITLE keyword is excluded as it has
1579 ;; been handled already.
1587 ;; Export properties are not case-sensitive.
1594 plist
1595 property
1597 ;; Parse VALUE if required.
1601 ;; If BEHAVIOUR is `split' expected value is
1602 ;; a list of strings, not a string.
1605 ;; Look for both general keywords and back-end specific
1606 ;; options, with priority given to the latter.
1608 org-export-options-alist)))
1609 ;; Return value.
1610 plist)))
1613 "Return current buffer export options, as a plist.
1615 Optional argument BACKEND, when non-nil, is a symbol specifying
1616 which back-end specific options should also be read in the
1617 process.
1619 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1621 get-options ; For byte-compiler.
1624 ;; Priority is given to back-end specific options.
1626 org-export-options-alist))
1629 org-export-special-keywords))))
1632 ;; Return property name associated to KEYWORD.
1637 options))))
1640 ;; Recursively read keywords in buffer. FILES is a list
1641 ;; of files read so far. PLIST is the current property
1642 ;; list obtained.
1651 ;; Options in `org-export-special-keywords'.
1655 ;; Avoid circular dependencies.
1665 plist
1670 plist
1676 ;; Options in `org-export-options-alist'.
1681 plist prop
1682 ;; Handle value depending on specified
1683 ;; BEHAVIOUR.
1689 " "
1701 ;; Return final value.
1702 plist))))
1703 ;; Read options in the current buffer.
1707 ;; Parse keywords specified in `org-element-document-properties'.
1709 ;; Find the property associated to the keyword.
1717 org-element-document-properties)
1718 ;; Return value.
1719 plist))
1722 "Return properties related to buffer attributes, as a plist."
1723 ;; Store full path of input file name, or nil. For internal use.
1731 "Return global export options as a plist.
1732 Optional argument BACKEND, if non-nil, is a symbol specifying
1733 which back-end specific export options should also be read in the
1734 process."
1736 ;; Priority is given to back-end specific options.
1738 org-export-options-alist)))
1745 plist
1746 prop
1747 ;; Eval default value provided. If keyword is
1748 ;; a member of `org-element-document-properties',
1749 ;; parse it as a secondary string before storing it.
1756 value)))))))))))
1759 "Return variables bound from BIND keywords in current buffer.
1760 Also look for BIND keywords in setup files. The return value is
1761 an alist where associations are (VARIABLE-NAME VALUE)."
1766 ;; Return an alist between variable names and their
1767 ;; value. FILES is a list of setup files names read so
1768 ;; far, used to avoid circular dependencies. ALIST is
1769 ;; the alist collected so far.
1780 ;; Enter setup file.
1790 alist))))))))))
1791 alist)))))
1792 ;; Return value in appropriate order of appearance.
1796 ;;;; Tree Properties
1797 ;;
1798 ;; Tree properties are information extracted from parse tree. They
1799 ;; are initialized at the beginning of the transcoding process by
1800 ;; `org-export-collect-tree-properties'.
1801 ;;
1802 ;; Dedicated functions focus on computing the value of specific tree
1803 ;; properties during initialization. Thus,
1804 ;; `org-export--populate-ignore-list' lists elements and objects that
1805 ;; should be skipped during export, `org-export--get-min-level' gets
1806 ;; the minimal exportable level, used as a basis to compute relative
1807 ;; level for headlines. Eventually
1808 ;; `org-export--collect-headline-numbering' builds an alist between
1809 ;; headlines and their numbering.
1812 "Extract tree properties from parse tree.
1814 DATA is the parse tree from which information is retrieved. INFO
1815 is a list holding export options.
1817 Following tree properties are set or updated:
1819 `:exported-data' Hash table used to memoize results from
1820 `org-export-data'.
1822 `:footnote-definition-alist' List of footnotes definitions in
1823 original buffer and current parse tree.
1825 `:headline-offset' Offset between true level of headlines and
1826 local level. An offset of -1 means a headline
1827 of level 2 should be considered as a level
1828 1 headline in the context.
1830 `:headline-numbering' Alist of all headlines as key an the
1831 associated numbering as value.
1833 `:ignore-list' List of elements that should be ignored during
1834 export.
1836 Return updated plist."
1837 ;; Install the parse tree in the communication channel, in order to
1838 ;; use `org-export-get-genealogy' and al.
1840 ;; Get the list of elements and objects to ignore, and put it into
1841 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1842 ;; been done during parse tree filtering.
1845 :ignore-list
1848 ;; Compute `:headline-offset' in order to be able to use
1849 ;; `org-export-get-relative-level'.
1852 :headline-offset
1854 ;; Update footnotes definitions list with definitions in parse tree.
1855 ;; This is required since buffer expansion might have modified
1856 ;; boundaries of footnote definitions contained in the parse tree.
1857 ;; This way, definitions in `footnote-definition-alist' are bound to
1858 ;; match those in the parse tree.
1864 defs)))
1866 ;; Properties order doesn't matter: get the rest of the tree
1867 ;; properties.
1871 info))
1874 "Return minimum exportable headline's level in DATA.
1875 DATA is parsed tree as returned by `org-element-parse-buffer'.
1876 OPTIONS is a plist holding export options."
1887 ;; If no headline was found, for the sake of consistency, set
1888 ;; minimum level to 1 nonetheless.
1892 "Return numbering of all exportable headlines in a parse tree.
1894 DATA is the parse tree. OPTIONS is the plist holding export
1895 options.
1897 Return an alist whose key is a headline and value is its
1898 associated numbering \(in the shape of a list of numbers\) or nil
1899 for a footnotes section."
1907 headline
1909 for idx from 0 to org-export-max-depth
1913 options)))
1916 "Return list of elements and objects to ignore during export.
1917 DATA is the parse tree to traverse. OPTIONS is the plist holding
1918 export options."
1920 walk-data
1921 ;; First find trees containing a select tag, if any.
1925 ;; Collect ignored elements or objects into IGNORE-LIST.
1931 ;; If headline is archived but tree below has
1932 ;; to be skipped, add it to ignore list.
1935 ;; Move into secondary string, if any.
1940 ;; Move into recursive objects/elements.
1942 ;; Main call.
1944 ;; Return value.
1945 ignore))
1948 "Return list of headlines and inlinetasks with a select tag in their tree.
1949 DATA is parsed data as returned by `org-element-parse-buffer'.
1950 INFO is a plist holding export options."
1952 walk-data ; For byte-compiler.
1962 ;; When a select tag is found, mark full
1963 ;; genealogy and every headline within the tree
1964 ;; as acceptable.
1967 genealogy
1970 selected-trees))
1971 ;; If at a headline, continue searching in tree,
1972 ;; recursively.
1982 selected-trees))
1985 "Non-nil when element or object BLOB should be skipped during export.
1986 OPTIONS is the plist holding export options. SELECTED, when
1987 non-nil, is a list of headlines or inlinetasks belonging to
1988 a tree with a select tag."
1995 ;; If `:with-drawers' value starts with `not', ignore
1996 ;; every drawer whose name belong to that list.
1997 ;; Otherwise, ignore drawers whose name isn't in that
1998 ;; list.
2014 ;; Ignore subtrees with an exclude tag.
2017 ;; When a select tag is present in the buffer, ignore any tree
2018 ;; without it.
2020 ;; Ignore commented sub-trees.
2022 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2024 ;; Ignore tasks, if specified by `:with-tasks' property.
2039 ;; `:with-timestamps' only applies to isolated timestamps
2040 ;; objects, i.e. timestamp objects in a paragraph containing only
2041 ;; timestamps and whitespaces.
2049 options t))))
2058 \f
2059 ;;; The Transcoder
2060 ;;
2061 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2062 ;; `org-element-parse-buffer') and transcodes it into a specified
2063 ;; back-end output. It takes care of filtering out elements or
2064 ;; objects according to export options and organizing the output blank
2065 ;; lines and white space are preserved. The function memoizes its
2066 ;; results, so it is cheap to call it within translators.
2067 ;;
2068 ;; It is possible to modify locally the back-end used by
2069 ;; `org-export-data' or even use a temporary back-end by using
2070 ;; `org-export-data-with-translations' and
2071 ;; `org-export-data-with-backend'.
2072 ;;
2073 ;; Internally, three functions handle the filtering of objects and
2074 ;; elements during the export. In particular,
2075 ;; `org-export-ignore-element' marks an element or object so future
2076 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2077 ;; elements or objects should be seen as real Org syntax and
2078 ;; `org-export-expand' transforms the others back into their original
2079 ;; shape
2080 ;;
2081 ;; `org-export-transcoder' is an accessor returning appropriate
2082 ;; translator function for a given element or object.
2085 "Return appropriate transcoder for BLOB.
2086 INFO is a plist containing export directives."
2088 ;; Return contents only for complete parse trees.
2094 "Convert DATA into current back-end format.
2096 DATA is a parse tree, an element or an object or a secondary
2097 string. INFO is a plist holding export options.
2099 Return transcoded string."
2105 ;; Ignored element/object.
2107 ;; Plain text.
2113 info))
2114 ;; Uninterpreted element/object: change it back to Org
2115 ;; syntax and export again resulting raw string.
2119 data
2123 info))
2124 ;; Secondary string.
2127 ;; Element/Object without contents or, as a special case,
2128 ;; headline with archive tag and archived trees restricted
2129 ;; to title only.
2137 ;; Export snippets never return a nil value so
2138 ;; that white spaces following them are never
2139 ;; ignored.
2141 ;; Element/Object with contents.
2154 ;; Elements directly containing objects
2155 ;; must have their indentation normalized
2156 ;; first.
2158 data
2159 ;; When normalizing contents of the first
2160 ;; paragraph in an item or a footnote
2161 ;; definition, ignore first line's
2162 ;; indentation: there is none and it
2163 ;; might be misleading.
2168 data)
2175 info))))))))
2176 ;; Final result will be memoized before being returned.
2178 data
2182 ;; Append the same white space between elements or objects as in
2183 ;; the original buffer, and call appropriate filters.
2194 info)))
2195 results)))
2199 "Convert DATA into another format using a given translation table.
2200 DATA is an element, an object, a secondary string or a string.
2201 TRANSLATIONS is an alist between element or object types and
2202 a functions handling them. See `org-export-define-backend' for
2203 more information. INFO is a plist used as a communication
2204 channel."
2206 data
2207 ;; Set-up a new communication channel with TRANSLATIONS as the
2208 ;; translate table and a new hash table for memoization.
2210 info
2212 ;; Size of the hash table is reduced since this function
2213 ;; will probably be used on short trees.
2217 "Convert DATA into BACKEND format.
2219 DATA is an element, an object, a secondary string or a string.
2220 BACKEND is a symbol. INFO is a plist used as a communication
2221 channel.
2223 Unlike to `org-export-with-backend', this function will
2224 recursively convert DATA using BACKEND translation table."
2230 "Non-nil if element or object BLOB should be interpreted during export.
2231 If nil, BLOB will appear as raw Org syntax. Check is done
2232 according to export options INFO, stored as a plist."
2234 ;; ... entities...
2236 ;; ... emphasis...
2239 ;; ... fixed-width areas.
2241 ;; ... LaTeX environments and fragments...
2245 ;; ... sub/superscripts...
2251 ;; ... tables...
2256 "Expand a parsed element or object to its original state.
2258 BLOB is either an element or an object. CONTENTS is its
2259 contents, as a string or nil.
2261 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2262 keywords before output."
2267 blob contents))))
2270 "Add ELEMENT to `:ignore-list' in INFO.
2272 Any element in `:ignore-list' will be skipped when using
2273 `org-element-map'. INFO is modified by side effects."
2277 \f
2278 ;;; The Filter System
2279 ;;
2280 ;; Filters allow end-users to tweak easily the transcoded output.
2281 ;; They are the functional counterpart of hooks, as every filter in
2282 ;; a set is applied to the return value of the previous one.
2283 ;;
2284 ;; Every set is back-end agnostic. Although, a filter is always
2285 ;; called, in addition to the string it applies to, with the back-end
2286 ;; used as argument, so it's easy for the end-user to add back-end
2287 ;; specific filters in the set. The communication channel, as
2288 ;; a plist, is required as the third argument.
2289 ;;
2290 ;; From the developer side, filters sets can be installed in the
2291 ;; process with the help of `org-export-define-backend', which
2292 ;; internally stores filters as an alist. Each association has a key
2293 ;; among the following symbols and a function or a list of functions
2294 ;; as value.
2295 ;;
2296 ;; - `:filter-options' applies to the property list containing export
2297 ;; options. Unlike to other filters, functions in this list accept
2298 ;; two arguments instead of three: the property list containing
2299 ;; export options and the back-end. Users can set its value through
2300 ;; `org-export-filter-options-functions' variable.
2301 ;;
2302 ;; - `:filter-parse-tree' applies directly to the complete parsed
2303 ;; tree. Users can set it through
2304 ;; `org-export-filter-parse-tree-functions' variable.
2305 ;;
2306 ;; - `:filter-final-output' applies to the final transcoded string.
2307 ;; Users can set it with `org-export-filter-final-output-functions'
2308 ;; variable
2309 ;;
2310 ;; - `:filter-plain-text' applies to any string not recognized as Org
2311 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2312 ;; configure it.
2313 ;;
2314 ;; - `:filter-TYPE' applies on the string returned after an element or
2315 ;; object of type TYPE has been transcoded. A user can modify
2316 ;; `org-export-filter-TYPE-functions'
2317 ;;
2318 ;; All filters sets are applied with
2319 ;; `org-export-filter-apply-functions' function. Filters in a set are
2320 ;; applied in a LIFO fashion. It allows developers to be sure that
2321 ;; their filters will be applied first.
2322 ;;
2323 ;; Filters properties are installed in communication channel with
2324 ;; `org-export-install-filters' function.
2325 ;;
2326 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2327 ;; `org-export-before-parsing-hook') are run at the beginning of the
2328 ;; export process and just before parsing to allow for heavy structure
2329 ;; modifications.
2332 ;;;; Hooks
2335 "Hook run at the beginning of the export process.
2337 This is run before include keywords and macros are expanded and
2338 Babel code blocks executed, on a copy of the original buffer
2339 being exported. Visibility and narrowing are preserved. Point
2340 is at the beginning of the buffer.
2342 Every function in this hook will be called with one argument: the
2346 "Hook run before parsing an export buffer.
2348 This is run after include keywords and macros have been expanded
2349 and Babel code blocks executed, on a copy of the original buffer
2350 being exported. Visibility and narrowing are preserved. Point
2351 is at the beginning of the buffer.
2353 Every function in this hook will be called with one argument: the
2357 ;;;; Special Filters
2360 "List of functions applied to the export options.
2361 Each filter is called with two arguments: the export options, as
2362 a plist, and the back-end, as a symbol. It must return
2366 "List of functions applied to the parsed tree.
2367 Each filter is called with three arguments: the parse tree, as
2368 returned by `org-element-parse-buffer', the back-end, as
2369 a symbol, and the communication channel, as a plist. It must
2373 "List of functions applied to plain text.
2374 Each filter is called with three arguments: a string which
2375 contains no Org syntax, the back-end, as a symbol, and the
2376 communication channel, as a plist. It must return a string or
2380 "List of functions applied to the transcoded string.
2381 Each filter is called with three arguments: the full transcoded
2382 string, the back-end, as a symbol, and the communication channel,
2383 as a plist. It must return a string that will be used as the
2387 ;;;; Elements Filters
2390 "List of functions applied to a transcoded babel-call.
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 center block.
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 clock.
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.
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 comment-block.
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 diary-sexp.
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 drawer.
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 dynamic-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 example-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 export-block.
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 fixed-width.
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 footnote-definition.
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 headline.
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 horizontal-rule.
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 inlinetask.
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 item.
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 keyword.
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 latex-environment.
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 node-property.
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 paragraph.
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 plain-list.
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 planning.
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 property-drawer.
2523 Each filter is called with three arguments: the transcoded data,
2524 as a string, the back-end, as a symbol, and the communication
2528 "List of functions applied to a transcoded quote block.
2529 Each filter is called with three arguments: the transcoded quote
2530 data, as a string, the back-end, as a symbol, and the
2531 communication channel, as a plist. It must return a string or
2535 "List of functions applied to a transcoded quote-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 section.
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 special 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 src-block.
2554 Each filter is called with three arguments: the transcoded data,
2555 as a string, the back-end, as a symbol, and the communication
2559 "List of functions applied to a transcoded table.
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-cell.
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 table-row.
2572 Each filter is called with three arguments: the transcoded data,
2573 as a string, the back-end, as a symbol, and the communication
2577 "List of functions applied to a transcoded verse block.
2578 Each filter is called with three arguments: the transcoded data,
2579 as a string, the back-end, as a symbol, and the communication
2583 ;;;; Objects Filters
2586 "List of functions applied to transcoded bold 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 transcoded code text.
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 entity.
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 export-snippet.
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 footnote-reference.
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-babel-call.
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 a transcoded inline-src-block.
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 transcoded italic text.
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 latex-fragment.
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 line-break.
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 link.
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 radio-target.
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 a transcoded statistics-cookie.
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 transcoded strike-through text.
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 subscript.
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 superscript.
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 target.
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 a transcoded timestamp.
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 underline 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 "List of functions applied to transcoded verbatim text.
2701 Each filter is called with three arguments: the transcoded data,
2702 as a string, the back-end, as a symbol, and the communication
2706 ;;;; Filters Tools
2707 ;;
2708 ;; Internal function `org-export-install-filters' installs filters
2709 ;; hard-coded in back-ends (developer filters) and filters from global
2710 ;; variables (user filters) in the communication channel.
2711 ;;
2712 ;; Internal function `org-export-filter-apply-functions' takes care
2713 ;; about applying each filter in order to a given data. It ignores
2714 ;; filters returning a nil value but stops whenever a filter returns
2715 ;; an empty string.
2718 "Call every function in FILTERS.
2720 Functions are called with arguments VALUE, current export
2721 back-end and INFO. A function returning a nil value will be
2722 skipped. If it returns the empty string, the process ends and
2723 VALUE is ignored.
2725 Call is done in a LIFO fashion, to be sure that developer
2726 specified filters, if any, are called first."
2735 "Install filters properties in communication channel.
2736 INFO is a plist containing the current communication channel.
2737 Return the updated communication channel."
2739 ;; Install user-defined filters with `org-export-filters-alist'
2740 ;; and filters already in INFO (through ext-plist mechanism).
2747 ;; Filters in INFO will be called
2748 ;; before those user provided.
2751 default-value)))))
2752 org-export-filters-alist)
2753 ;; Prepend back-end specific filters to that list.
2755 ;; Single values get consed, lists are appended.
2760 plist key
2764 ;; Return new communication channel.
2768 \f
2769 ;;; Core functions
2770 ;;
2771 ;; This is the room for the main function, `org-export-as', along with
2772 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2773 ;; `org-export-string-as'. They differ either by the way they output
2774 ;; the resulting code (for the first two) or by the input type (for
2775 ;; the latter). `org-export--copy-to-kill-ring-p' determines if
2776 ;; output of these function should be added to kill ring.
2777 ;;
2778 ;; `org-export-output-file-name' is an auxiliary function meant to be
2779 ;; used with `org-export-to-file'. With a given extension, it tries
2780 ;; to provide a canonical file name to write export output to.
2781 ;;
2782 ;; Note that `org-export-as' doesn't really parse the current buffer,
2783 ;; but a copy of it (with the same buffer-local variables and
2784 ;; visibility), where macros and include keywords are expanded and
2785 ;; Babel blocks are executed, if appropriate.
2786 ;; `org-export-with-buffer-copy' macro prepares that copy.
2787 ;;
2788 ;; File inclusion is taken care of by
2789 ;; `org-export-expand-include-keyword' and
2790 ;; `org-export--prepare-file-contents'. Structure wise, including
2791 ;; a whole Org file in a buffer often makes little sense. For
2792 ;; example, if the file contains a headline and the include keyword
2793 ;; was within an item, the item should contain the headline. That's
2794 ;; why file inclusion should be done before any structure can be
2795 ;; associated to the file, that is before parsing.
2796 ;;
2797 ;; `org-export-insert-default-template' is a command to insert
2798 ;; a default template (or a back-end specific template) at point or in
2799 ;; current subtree.
2802 "Return a copy of the current buffer.
2803 The copy preserves Org buffer-local variables, visibility and
2804 narrowing."
2810 new-buf))
2813 "Apply BODY in a copy of the current buffer.
2814 The copy preserves local variables, visibility and contents of
2815 the original buffer. Point is at the beginning of the buffer
2816 when BODY is applied."
2825 ;; Kill copy without confirmation.
2831 "Generate a function duplicating BUFFER.
2833 The copy will preserve local variables, visibility, contents and
2834 narrowing of the original buffer. If a region was active in
2835 BUFFER, contents will be narrowed to that region instead.
2837 The resulting function can be evaled at a later time, from
2838 another buffer, effectively cloning the original buffer there.
2840 The function assumes BUFFER's major mode is `org-mode'."
2844 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2845 ;; already in BUFFER.
2847 ;; Copy specific buffer local variables and variables set
2848 ;; through BIND keywords.
2850 vars)
2858 buffer-file-name
2859 buffer-file-coding-system))
2863 ;; Skip unreadable values, as they cannot be
2864 ;; sent to external process.
2868 vars))))))
2869 ;; Whole buffer contents.
2874 ;; Narrowing.
2878 ;; Current position of point.
2880 ;; Overlays with invisible property.
2890 ov-set))))
2892 ov-set)))))
2894 ;;;###autoload
2897 "Transcode current Org buffer into BACKEND code.
2899 If narrowing is active in the current buffer, only transcode its
2900 narrowed part.
2902 If a region is active, transcode that region.
2904 When optional argument SUBTREEP is non-nil, transcode the
2905 sub-tree at point, extracting information from the headline
2906 properties first.
2908 When optional argument VISIBLE-ONLY is non-nil, don't export
2909 contents of hidden elements.
2911 When optional argument BODY-ONLY is non-nil, only return body
2912 code, without surrounding template.
2914 Optional argument EXT-PLIST, when provided, is a property list
2915 with external parameters overriding Org default settings, but
2916 still inferior to file-local settings.
2918 Return code as a string."
2922 ;; Narrow buffer to an appropriate region or subtree for
2923 ;; parsing. If parsing subtree, be sure to remove main headline
2924 ;; too.
2932 ;; Initialize communication channel with original buffer
2933 ;; attributes, unavailable in its copy.
2942 tree)
2943 ;; Update communication channel and get parse tree. Buffer
2944 ;; isn't parsed directly. Instead, a temporary copy is
2945 ;; created, where include keywords, macros are expanded and
2946 ;; code blocks are evaluated.
2948 ;; Run first hook with current back-end as argument.
2951 ;; Update macro templates since #+INCLUDE keywords might have
2952 ;; added some new ones.
2956 ;; Update radio targets since keyword inclusion might have
2957 ;; added some more.
2959 ;; Run last hook with current back-end as argument.
2963 ;; Update communication channel with environment. Also
2964 ;; install user's and developer's filters.
2969 ;; Expand export-specific set of macros: {{{author}}},
2970 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2971 ;; once regular macros have been expanded, since document
2972 ;; keywords may contain one of them.
2978 ;; EMAIL is not a parsed keyword: store it as-is.
2982 ;; Call options filters and update export options. We do not
2983 ;; use `org-export-filter-apply-functions' here since the
2984 ;; arity of such filters is different.
2988 ;; Parse buffer and call parse-tree filter on it.
2993 ;; Now tree is complete, compute its properties and add them
2994 ;; to communication channel.
2998 ;; Eventually transcode TREE. Wrap the resulting string into
2999 ;; a template.
3008 ;; Remove all text properties since they cannot be
3009 ;; retrieved from an external process. Finally call
3010 ;; final-output filter and return result.
3016 info))))))))
3018 ;;;###autoload
3021 "Call `org-export-as' with output to a specified buffer.
3023 BACKEND is the back-end used for transcoding, as a symbol.
3025 BUFFER is the output buffer. If it already exists, it will be
3026 erased first, otherwise, it will be created.
3028 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3029 EXT-PLIST are similar to those used in `org-export-as', which
3030 see.
3032 Depending on `org-export-copy-to-kill-ring', add buffer contents
3033 to kill ring. Return buffer."
3040 ;; Maybe add buffer contents to kill ring.
3043 ;; Return buffer.
3044 buffer))
3046 ;;;###autoload
3049 "Call `org-export-as' with output to a specified file.
3051 BACKEND is the back-end used for transcoding, as a symbol. FILE
3052 is the name of the output file, as a string.
3054 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3055 EXT-PLIST are similar to those used in `org-export-as', which
3056 see.
3058 Depending on `org-export-copy-to-kill-ring', add file contents
3059 to kill ring. Return output file's name."
3060 ;; Checks for FILE permissions. `write-file' would do the same, but
3061 ;; we'd rather avoid needless transcoding of parse tree.
3063 ;; Insert contents to a temporary buffer and write it to FILE.
3070 ;; Maybe add file contents to kill ring.
3073 ;; Return full path.
3074 file)
3076 ;;;###autoload
3078 "Transcode STRING into BACKEND code.
3080 When optional argument BODY-ONLY is non-nil, only return body
3081 code, without preamble nor postamble.
3083 Optional argument EXT-PLIST, when provided, is a property list
3084 with external parameters overriding Org default settings, but
3085 still inferior to file-local settings.
3087 Return code as a string."
3093 ;;;###autoload
3095 "Replace the active region by its export to BACKEND."
3105 ;;;###autoload
3107 "Insert all export keywords with default values at beginning of line.
3109 BACKEND is a symbol representing the export back-end for which
3110 specific export options should be added to the template, or
3111 `default' for default template. When it is nil, the user will be
3112 prompted for a category.
3114 If SUBTREEP is non-nil, export configuration will be set up
3115 locally for the subtree through node properties."
3124 "Options category: "
3127 org-export-registered-backends))))))
3128 options keywords)
3129 ;; Populate OPTIONS and KEYWORDS.
3143 ;; Move to an appropriate location in order to insert options.
3145 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3146 ;; list of available keywords.
3174 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3193 ;; And the rest of keywords.
3204 "Return output file's name according to buffer specifications.
3206 EXTENSION is a string representing the output file extension,
3207 with the leading dot.
3209 With a non-nil optional argument SUBTREEP, try to determine
3211 of subtree at point.
3213 When optional argument PUB-DIR is set, use it as the publishing
3214 directory.
3216 When optional argument VISIBLE-ONLY is non-nil, don't export
3217 contents of hidden elements.
3219 Return file name as a string."
3222 ;; File name may come from EXPORT_FILE_NAME subtree
3223 ;; property, assuming point is at beginning of said
3224 ;; sub-tree.
3231 ;; File name may be extracted from buffer's associated
3232 ;; file, if any.
3234 ;; Can't determine file name on our own: Ask user.
3238 "Output file: " pub-dir nil nil nil
3242 ;; Build file name. Enforce EXTENSION over whatever user
3243 ;; may have come up with. PUB-DIR, if defined, always has
3244 ;; precedence over any provided path.
3249 extension))
3252 ;; If writing to OUTPUT-FILE would overwrite original file, append
3253 ;; EXTENSION another time to final name.
3256 output-file)))
3259 "Expand every include keyword in buffer.
3260 Optional argument INCLUDED is a list of included file names along
3261 with their line restriction, when appropriate. It is used to
3262 avoid infinite recursion. Optional argument DIR is the current
3263 working directory. It is used to properly resolve relative
3264 paths."
3271 ;; Extract arguments from keyword's value.
3279 dir)
3284 value)
3290 ;; Minimal level of included file defaults to the child
3291 ;; level of the current headline, if any, or one. It
3292 ;; only applies is the file is meant to be included as
3293 ;; an Org one.
3301 ;; Remove keyword.
3307 ;; Check if files has already been parsed. Look after
3308 ;; inclusion lines too, as different parts of the same file
3309 ;; can be included too.
3321 ind-str contents ind-str))))
3329 ind-str env contents ind-str))))
3342 "Prepare the contents of FILE for inclusion and return them as a string.
3344 When optional argument LINES is a string specifying a range of
3345 lines, include only those lines.
3347 Optional argument IND, when non-nil, is an integer specifying the
3348 global indentation of returned contents. Since its purpose is to
3349 allow an included file to stay in the same environment it was
3350 created \(i.e. a list item), it doesn't apply past the first
3351 headline encountered.
3353 Optional argument MINLEVEL, when non-nil, is an integer
3354 specifying the level that any top-level headline in the included
3355 file should have."
3371 ;; Remove blank lines at beginning and end of contents. The logic
3372 ;; behind that removal is that blank lines around include keyword
3373 ;; override blank lines in included file.
3382 ;; If IND is set, preserve indentation of include keyword until
3383 ;; the first headline encountered.
3390 ;; Do not move footnote definitions out of column 0.
3396 ;; When MINLEVEL is specified, compute minimal level for headlines
3397 ;; in the file (CUR-MIN), and remove stars to each headline so
3398 ;; that headlines with minimal level have a level of MINLEVEL.
3409 ;; Only change stars, don't bother moving whole
3410 ;; sections.
3417 "Execute every Babel code in the visible part of current buffer."
3418 ;; Get a pristine copy of current buffer so Babel references can be
3419 ;; properly resolved.
3426 "Return a non-nil value when output should be added to the kill ring.
3427 See also `org-export-copy-to-kill-ring'."
3433 \f
3434 ;;; Tools For Back-Ends
3435 ;;
3436 ;; A whole set of tools is available to help build new exporters. Any
3437 ;; function general enough to have its use across many back-ends
3438 ;; should be added here.
3440 ;;;; For Affiliated Keywords
3441 ;;
3442 ;; `org-export-read-attribute' reads a property from a given element
3443 ;; as a plist. It can be used to normalize affiliated keywords'
3444 ;; syntax.
3445 ;;
3446 ;; Since captions can span over multiple lines and accept dual values,
3447 ;; their internal representation is a bit tricky. Therefore,
3448 ;; `org-export-get-caption' transparently returns a given element's
3449 ;; caption as a secondary string.
3452 "Turn ATTRIBUTE property from ELEMENT into a plist.
3454 When optional argument PROPERTY is non-nil, return the value of
3455 that property within attributes.
3459 properties.
3461 All values will become strings except the empty string and
3464 will become the empty string."
3478 s)
3483 ;; Ignore any string before first property with `cdr'.
3488 "Return caption from ELEMENT as a secondary string.
3490 When optional argument SHORTP is non-nil, return short caption,
3491 as a secondary string, instead.
3493 Caption lines are separated by a white space."
3501 ;;;; For Derived Back-ends
3502 ;;
3503 ;; `org-export-with-backend' is a function allowing to locally use
3504 ;; another back-end to transcode some object or element. In a derived
3505 ;; back-end, it may be used as a fall-back function once all specific
3506 ;; cases have been treated.
3509 "Call a transcoder from BACK-END on DATA.
3510 CONTENTS, when non-nil, is the transcoded contents of DATA
3511 element, as a string. INFO, when non-nil, is the communication
3512 channel used for export, as a plist.."
3522 ;;;; For Export Snippets
3523 ;;
3524 ;; Every export snippet is transmitted to the back-end. Though, the
3525 ;; latter will only retain one type of export-snippet, ignoring
3526 ;; others, based on the former's target back-end. The function
3527 ;; `org-export-snippet-backend' returns that back-end for a given
3528 ;; export-snippet.
3531 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3532 Translation, with `org-export-snippet-translation-alist', is
3533 applied."
3537 back-end))))
3540 ;;;; For Footnotes
3541 ;;
3542 ;; `org-export-collect-footnote-definitions' is a tool to list
3543 ;; actually used footnotes definitions in the whole parse tree, or in
3544 ;; a headline, in order to add footnote listings throughout the
3545 ;; transcoded data.
3546 ;;
3547 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3548 ;; back-ends, when they need to attach the footnote definition only to
3549 ;; the first occurrence of the corresponding label.
3550 ;;
3551 ;; `org-export-get-footnote-definition' and
3552 ;; `org-export-get-footnote-number' provide easier access to
3553 ;; additional information relative to a footnote reference.
3556 "Return an alist between footnote numbers, labels and definitions.
3558 DATA is the parse tree from which definitions are collected.
3559 INFO is the plist used as a communication channel.
3561 Definitions are sorted by order of references. They either
3562 appear as Org data or as a secondary string for inlined
3563 footnotes. Unreferenced definitions are ignored."
3565 collect-fn ; for byte-compiler.
3569 ;; Collect footnote number, label and definition in DATA.
3577 def)
3578 num-alist)
3579 ;; Also search in definition for nested footnotes.
3582 ;; Don't enter footnote definitions since it will happen
3583 ;; when their first reference is found.
3589 "Non-nil when a footnote reference is the first one for its label.
3591 FOOTNOTE-REFERENCE is the footnote reference being considered.
3592 INFO is the plist used as a communication channel."
3594 ;; Anonymous footnotes are always a first reference.
3596 ;; Otherwise, return the first footnote with the same LABEL and
3597 ;; test if it is equal to FOOTNOTE-REFERENCE.
3607 ;; If FN isn't inlined, be sure to traverse its
3608 ;; definition before resuming search. See
3609 ;; comments in `org-export-get-footnote-number'
3610 ;; for more information.
3614 ;; Don't enter footnote definitions since it will
3615 ;; happen when their first reference is found.
3618 footnote-reference)))))
3621 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3622 INFO is the plist used as a communication channel. If no such
3624 string."
3631 "Return number associated to a footnote.
3633 FOOTNOTE is either a footnote reference or a footnote definition.
3634 INFO is the plist used as a communication channel."
3636 seen-refs
3637 search-ref ; For byte-compiler.
3641 ;; Search footnote references through DATA, filling
3642 ;; SEEN-REFS along the way.
3647 ;; Anonymous footnote match: return number.
3650 ;; Labels match: return number.
3653 ;; Anonymous footnote: it's always a new one.
3654 ;; Also, be sure to return nil from the `cond' so
3655 ;; `first-match' doesn't get us out of the loop.
3657 ;; Label not seen so far: add it so SEEN-REFS.
3658 ;;
3659 ;; Also search for subsequent references in
3660 ;; footnote definition so numbering follows
3661 ;; reading logic. Note that we don't have to care
3662 ;; about inline definitions, since
3663 ;; `org-element-map' already traverses them at the
3664 ;; right time.
3665 ;;
3666 ;; Once again, return nil to stay in the loop.
3671 nil))))
3672 ;; Don't enter footnote definitions since it will
3673 ;; happen when their first reference is found.
3678 ;;;; For Headlines
3679 ;;
3680 ;; `org-export-get-relative-level' is a shortcut to get headline
3681 ;; level, relatively to the lower headline level in the parsed tree.
3682 ;;
3683 ;; `org-export-get-headline-number' returns the section number of an
3684 ;; headline, while `org-export-number-to-roman' allows to convert it
3685 ;; to roman numbers.
3686 ;;
3687 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3688 ;; `org-export-last-sibling-p' are three useful predicates when it
3689 ;; comes to fulfill the `:headline-levels' property.
3690 ;;
3691 ;; `org-export-get-tags', `org-export-get-category' and
3692 ;; `org-export-get-node-property' extract useful information from an
3693 ;; headline or a parent headline. They all handle inheritance.
3694 ;;
3695 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3696 ;; as a secondary string, suitable for table of contents. It falls
3697 ;; back onto default title.
3700 "Return HEADLINE relative level within current parsed tree.
3701 INFO is a plist holding contextual information."
3706 "Non-nil when HEADLINE is considered as low level.
3708 INFO is a plist used as a communication channel.
3710 A low level headlines has a relative level greater than
3711 `:headline-levels' property value.
3713 Return value is the difference between HEADLINE relative level
3714 and the last level being considered as high enough, or nil."
3721 "Return HEADLINE numbering as a list of numbers.
3722 INFO is a plist holding contextual information."
3726 "Return a non-nil value if HEADLINE element should be numbered.
3727 INFO is a plist used as a communication channel."
3733 "Convert integer N into a roman numeral."
3746 res)))
3749 "Return list of tags associated to ELEMENT.
3751 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3752 is a plist used as a communication channel.
3754 Select tags (see `org-export-select-tags') and exclude tags (see
3755 `org-export-exclude-tags') are removed from the list.
3757 When non-nil, optional argument TAGS should be a list of strings.
3758 Any tag belonging to this list will also be removed.
3760 When optional argument INHERITED is non-nil, tags can also be
3761 inherited from parent headlines and FILETAGS keywords."
3767 ;; Build complete list of inherited tags.
3778 ;; Add FILETAGS keywords and return results.
3782 "Return node PROPERTY value for BLOB.
3784 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3785 element or object.
3787 If optional argument INHERITED is non-nil, the value can be
3788 inherited from a parent headline.
3790 Return value is a string or nil."
3802 "Return category for element or object BLOB.
3804 INFO is a plist used as a communication channel.
3806 CATEGORY is automatically inherited from a parent headline, from
3807 #+CATEGORY: keyword or created out of original file name. If all
3811 ;; Almost like `org-export-node-property', but we cannot trust
3812 ;; `plist-member' as every headline has a `:CATEGORY'
3813 ;; property, would it be nil or equal to "???" (which has the
3814 ;; same meaning).
3832 "Return alternative title for HEADLINE, as a secondary string.
3833 INFO is a plist used as a communication channel. If no optional
3834 title is defined, fall-back to the regular title."
3839 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3840 INFO is a plist used as a communication channel."
3845 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3846 INFO is a plist used as a communication channel."
3850 ;;;; For Keywords
3851 ;;
3852 ;; `org-export-get-date' returns a date appropriate for the document
3853 ;; to about to be exported. In particular, it takes care of
3854 ;; `org-export-date-timestamp-format'.
3857 "Return date value for the current document.
3859 INFO is a plist used as a communication channel. FMT, when
3860 non-nil, is a time format string that will be applied on the date
3861 if it consists in a single timestamp object. It defaults to
3862 `org-export-date-timestamp-format' when nil.
3864 A proper date can be a secondary string, a string or nil. It is
3865 meant to be translated with `org-export-data' or alike."
3876 ;;;; For Links
3877 ;;
3878 ;; `org-export-solidify-link-text' turns a string into a safer version
3879 ;; for links, replacing most non-standard characters with hyphens.
3880 ;;
3881 ;; `org-export-get-coderef-format' returns an appropriate format
3882 ;; string for coderefs.
3883 ;;
3884 ;; `org-export-inline-image-p' returns a non-nil value when the link
3885 ;; provided should be considered as an inline image.
3886 ;;
3887 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3888 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3889 ;; returns an appropriate unique identifier when found, or nil.
3890 ;;
3891 ;; `org-export-resolve-id-link' returns the first headline with
3892 ;; specified id or custom-id in parse tree, the path to the external
3893 ;; file with the id or nil when neither was found.
3894 ;;
3895 ;; `org-export-resolve-coderef' associates a reference to a line
3896 ;; number in the element it belongs, or returns the reference itself
3897 ;; when the element isn't numbered.
3900 "Take link text S and make a safe target out of it."
3905 "Return format string for code reference link.
3906 PATH is the link path. DESC is its description."
3914 "Non-nil if LINK object points to an inline image.
3916 Optional argument is a set of RULES defining inline images. It
3917 is an alist where associations have the following shape:
3919 \(TYPE . REGEXP)
3921 Applying a rule means apply REGEXP against LINK's path when its
3922 type is TYPE. The function will return a non-nil value if any of
3923 the provided rules is non-nil. The default rule is
3924 `org-export-default-inline-image-rule'.
3926 This only applies to links without a description."
3937 rules)
3938 ;; Return nil if no rule matched.
3939 nil))))
3942 "Resolve a code reference REF.
3944 INFO is a plist used as a communication channel.
3946 Return associated line number in source code, or REF itself,
3947 depending on src-block or example element's switches."
3954 org-coderef-label-format)))
3958 ;; Element containing REF is found. Resolve it to either
3959 ;; a label or a line number, as needed.
3969 "Return LINK destination.
3971 INFO is a plist holding contextual information.
3973 Return value can be an object, an element, or nil:
3975 - If LINK path matches a target object (i.e. <<path>>) return it.
3977 - If LINK path exactly matches the name affiliated keyword
3978 \(i.e. #+NAME: path) of an element, return that element.
3980 - If LINK path exactly matches any headline name, return that
3981 element. If more than one headline share that name, priority
3982 will be given to the one with the closest common ancestor, if
3983 any, or the first one in the parse tree otherwise.
3985 - Otherwise, return nil.
3988 significant."
3991 ;; Split PATH at white spaces so matches are space
3992 ;; insensitive.
3995 ;; Cache for destinations that are not position dependent.
4003 ;; Destination is not position dependent: use cached value.
4005 ;; First try to find a matching "<<path>>" unless user specified
4006 ;; he was looking for a headline (path starts with a "*"
4007 ;; character).
4013 path)
4014 blob))
4017 ;; Then try to find an element with a matching "#+NAME: path"
4018 ;; affiliated keyword.
4021 org-element-all-elements
4026 el)))
4029 ;; Last case: link either points to a headline or to nothingness.
4030 ;; Try to find the source, with priority given to headlines with
4031 ;; the closest common ancestor. If such candidate is found,
4032 ;; return it, otherwise return nil.
4036 ;; Return first headline whose `:raw-value' property is
4037 ;; NAME in parse tree DATA, or nil. Statistics cookies
4038 ;; are ignored.
4046 name)
4047 headline))
4049 ;; Search among headlines sharing an ancestor with link, from
4050 ;; closest to farthest.
4059 ;; No destination found: return nil.
4063 "Return headline referenced as LINK destination.
4065 INFO is a plist used as a communication channel.
4067 Return value can be the headline element matched in current parse
4071 ;; First check if id is within the current parse tree.
4076 headline))
4078 ;; Otherwise, look for external files.
4082 "Return radio-target object referenced as LINK destination.
4084 INFO is a plist used as a communication channel.
4086 Return value can be a radio-target object or nil. Assume LINK
4095 nil nil path nil nil t)
4096 t)
4097 radio))
4101 ;;;; For References
4102 ;;
4103 ;; `org-export-get-ordinal' associates a sequence number to any object
4104 ;; or element.
4107 "Return ordinal number of an element or object.
4109 ELEMENT is the element or object considered. INFO is the plist
4110 used as a communication channel.
4112 Optional argument TYPES, when non-nil, is a list of element or
4113 object types, as symbols, that should also be counted in.
4114 Otherwise, only provided element's type is considered.
4116 Optional argument PREDICATE is a function returning a non-nil
4117 value if the current element or object should be counted in. It
4118 accepts two arguments: the element or object being considered and
4119 the plist used as a communication channel. This allows to count
4120 only a certain type of objects (i.e. inline images).
4122 Return value is a list of numbers if ELEMENT is a headline or an
4123 item. It is nil for keywords. It represents the footnote number
4124 for footnote definitions and footnote references. If ELEMENT is
4125 a target, return the same value as if ELEMENT was the closest
4126 table, item or headline containing the target. In any other
4127 case, return the sequence number of ELEMENT among elements or
4128 objects of the same type."
4129 ;; Ordinal of a target object refer to the ordinal of the closest
4130 ;; table, item, or headline containing the object.
4134 when
4138 table))
4139 return parent)))
4141 ;; Special case 1: A headline returns its number as a list.
4143 ;; Special case 2: An item returns its number as a list.
4147 struct
4154 ;; Increment counter until ELEMENT is found again.
4165 ;;;; For Src-Blocks
4166 ;;
4167 ;; `org-export-get-loc' counts number of code lines accumulated in
4168 ;; src-block or example-block elements with a "+n" switch until
4169 ;; a given element, excluded. Note: "-n" switches reset that count.
4170 ;;
4171 ;; `org-export-unravel-code' extracts source code (along with a code
4172 ;; references alist) from an `element-block' or `src-block' type
4173 ;; element.
4174 ;;
4175 ;; `org-export-format-code' applies a formatting function to each line
4176 ;; of code, providing relative line number and code reference when
4177 ;; appropriate. Since it doesn't access the original element from
4178 ;; which the source code is coming, it expects from the code calling
4179 ;; it to know if lines should be numbered and if code references
4180 ;; should appear.
4181 ;;
4182 ;; Eventually, `org-export-format-code-default' is a higher-level
4183 ;; function (it makes use of the two previous functions) which handles
4184 ;; line numbering and code references inclusion, and returns source
4185 ;; code in a format suitable for plain text or verbatim output.
4188 "Return accumulated lines of code up to ELEMENT.
4190 INFO is the plist used as a communication channel.
4192 ELEMENT is excluded from count."
4198 ;; ELEMENT is reached: Quit the loop.
4200 ;; Only count lines from src-block and example-block elements
4201 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4205 ;; Accumulate locs or reset them.
4209 ;; Return nil to stay in the loop.
4210 nil)))
4212 ;; Return value.
4213 loc))
4216 "Clean source code and extract references out of it.
4218 ELEMENT has either a `src-block' an `example-block' type.
4220 Return a cons cell whose CAR is the source code, cleaned from any
4221 reference and protective comma and CDR is an alist between
4222 relative line number (integer) and name of code reference on that
4223 line (string)."
4225 ;; Get code and clean it. Remove blank lines at its
4226 ;; beginning and end.
4232 ;; Get format used for references.
4235 org-coderef-label-format)))
4236 ;; Build a regexp matching a loc with a reference.
4241 ;; Return value.
4243 ;; Code with references removed.
4249 ;; Ref line: remove ref, and signal its position in REFS.
4253 ;; Reference alist.
4254 refs)))
4257 "Format CODE by applying FUN line-wise and return it.
4259 CODE is a string representing the code to format. FUN is
4260 a function. It must accept three arguments: a line of
4261 code (string), the current line number (integer) or nil and the
4262 reference associated to the current line (string) or nil.
4264 Optional argument NUM-LINES can be an integer representing the
4265 number of code lines accumulated until the current code. Line
4266 numbers passed to FUN will take it into account. If it is nil,
4267 FUN's second argument will always be nil. This number can be
4268 obtained with `org-export-get-loc' function.
4270 Optional argument REF-ALIST can be an alist between relative line
4271 number (i.e. ignoring NUM-LINES) and the name of the code
4272 reference on it. If it is nil, FUN's third argument will always
4273 be nil. It can be obtained through the use of
4274 `org-export-unravel-code' function."
4286 "Return source code from ELEMENT, formatted in a standard way.
4288 ELEMENT is either a `src-block' or `example-block' element. INFO
4289 is a plist used as a communication channel.
4291 This function takes care of line numbering and code references
4292 inclusion. Line numbers, when applicable, appear at the
4293 beginning of the line, separated from the code by two white
4294 spaces. Code references, on the other hand, appear flushed to
4295 the right, separated by six white spaces from the widest line of
4296 code."
4297 ;; Extract code and references.
4304 ;; Handle line numbering.
4313 ;; Prepare references display, if required. Any reference
4314 ;; should start six columns after the widest line of code,
4315 ;; wrapped with parenthesis.
4320 code
4324 number-str
4325 loc
4331 num-start refs)))))
4334 ;;;; For Tables
4335 ;;
4336 ;; `org-export-table-has-special-column-p' and and
4337 ;; `org-export-table-row-is-special-p' are predicates used to look for
4338 ;; meta-information about the table structure.
4339 ;;
4340 ;; `org-table-has-header-p' tells when the rows before the first rule
4341 ;; should be considered as table's header.
4342 ;;
4343 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4344 ;; and `org-export-table-cell-borders' extract information from
4345 ;; a table-cell element.
4346 ;;
4347 ;; `org-export-table-dimensions' gives the number on rows and columns
4348 ;; in the table, ignoring horizontal rules and special columns.
4349 ;; `org-export-table-cell-address', given a table-cell object, returns
4350 ;; the absolute address of a cell. On the other hand,
4351 ;; `org-export-get-table-cell-at' does the contrary.
4352 ;;
4353 ;; `org-export-table-cell-starts-colgroup-p',
4354 ;; `org-export-table-cell-ends-colgroup-p',
4355 ;; `org-export-table-row-starts-rowgroup-p',
4356 ;; `org-export-table-row-ends-rowgroup-p',
4357 ;; `org-export-table-row-starts-header-p' and
4358 ;; `org-export-table-row-ends-header-p' indicate position of current
4359 ;; row or cell within the table.
4362 "Non-nil when TABLE has a special column.
4363 All special columns will be ignored during export."
4364 ;; The table has a special column when every first cell of every row
4365 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4366 ;; "*" "_" and "^". Though, do not consider a first row containing
4367 ;; only empty cells as special.
4383 "Non-nil when TABLE has a header.
4385 INFO is a plist used as a communication channel.
4387 A table has a header when it contains at least two row groups."
4396 table
4407 cache)))))
4410 "Non-nil if TABLE-ROW is considered special.
4412 INFO is a plist used as the communication channel.
4414 All special rows will be ignored during export."
4418 ;; A row is special either when...
4420 ;; ... it starts with a field only containing "/",
4422 ;; ... the table contains a special column and the row start
4423 ;; with a marking character among, "^", "_", "$" or "!",
4427 ;; ... it contains only alignment cookies and empty cells.
4433 ;; Since VALUE is a secondary string, the following
4434 ;; checks avoid expanding it with `org-export-data'.
4446 "Return TABLE-ROW's group number, as an integer.
4448 INFO is a plist used as the communication channel.
4450 Return value is the group number, as an integer, or nil for
4451 special rows and rows separators. First group is also table's
4452 header."
4470 "Return TABLE-CELL contents width.
4472 INFO is a plist used as the communication channel.
4474 Return value is the width given by the last width cookie in the
4475 same column as TABLE-CELL, or nil."
4494 ;; In a special row, try to find a width cookie at COLUMN.
4498 ;; The following checks avoid expanding unnecessarily
4499 ;; the cell with `org-export-data'.
4509 "Return TABLE-CELL contents alignment.
4511 INFO is a plist used as the communication channel.
4513 Return alignment as specified by the last alignment cookie in the
4514 same column as TABLE-CELL. If no such cookie is found, a default
4515 alignment value will be deduced from fraction of numbers in the
4516 column (see `org-table-number-fraction' for more information).
4517 Possible values are `left', `right' and `center'."
4533 cookie-align
4534 previous-cell-number-p)
4537 ;; In a special row, try to find an alignment cookie at
4538 ;; COLUMN.
4542 ;; Since VALUE is a secondary string, the following
4543 ;; checks avoid useless expansion through
4544 ;; `org-export-data'.
4552 ;; Ignore table rules.
4554 ;; In a standard row, check if cell's contents are
4555 ;; expressing some kind of number. Increase NUMBER-CELLS
4556 ;; accordingly. Though, don't bother if an alignment
4557 ;; cookie has already defined cell's alignment.
4562 info)))
4564 ;; Treat an empty cell as a number if it follows
4565 ;; a number.
4571 ;; Return value. Alignment specified by cookies has
4572 ;; precedence over alignment deduced from cell's contents.
4574 column
4579 org-table-number-fraction)
4584 "Return TABLE-CELL borders.
4586 INFO is a plist used as a communication channel.
4588 Return value is a list of symbols, or nil. Possible values are:
4589 `top', `bottom', `above', `below', `left' and `right'. Note:
4590 `top' (resp. `bottom') only happen for a cell in the first
4591 row (resp. last row) of the table, ignoring table rules, if any.
4593 Returned borders ignore special rows."
4596 borders)
4597 ;; Top/above border? TABLE-CELL has a border above when a rule
4598 ;; used to demarcate row groups can be found above. Hence,
4599 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4600 ;; another regular row has to be found above that rule.
4609 ;; Look at every row before the current one.
4611 ;; No rule above, or rule found starts the table (ignoring any
4612 ;; special row): TABLE-CELL is at the top of the table.
4615 ;; Bottom/below border? TABLE-CELL has a border below when next
4616 ;; non-regular row below is a rule.
4625 ;; Look at every row after the current one.
4627 ;; No rule below, or rule found ends the table (modulo some
4628 ;; special row): TABLE-CELL is at the bottom of the table.
4631 ;; Right/left borders? They can only be specified by column
4632 ;; groups. Column groups are defined in a row starting with "/".
4633 ;; Also a column groups row only contains "<", "<>", ">" or blank
4634 ;; cells.
4651 ;; There's a left border when previous cell, if
4652 ;; any, ends a group, or current one starts one.
4658 ;; There's a right border when next cell, if any,
4659 ;; starts a group, or current one ends one.
4666 ;; Table rows are read in reverse order so last column groups
4667 ;; row has precedence over any previous one.
4669 ;; Return value.
4670 borders))
4673 "Non-nil when TABLE-CELL is at the beginning of a row group.
4674 INFO is a plist used as a communication channel."
4675 ;; A cell starts a column group either when it is at the beginning
4676 ;; of a row (or after the special column, if any) or when it has
4677 ;; a left border.
4680 table-cell)
4684 "Non-nil when TABLE-CELL is at the end of a row group.
4685 INFO is a plist used as a communication channel."
4686 ;; A cell ends a column group either when it is at the end of a row
4687 ;; or when it has a right border.
4690 table-cell)
4694 "Non-nil when TABLE-ROW is at the beginning of a column group.
4695 INFO is a plist used as a communication channel."
4703 "Non-nil when TABLE-ROW is at the end of a column group.
4704 INFO is a plist used as a communication channel."
4712 "Non-nil when TABLE-ROW is the first table header's row.
4713 INFO is a plist used as a communication channel."
4720 "Non-nil when TABLE-ROW is the last table header's row.
4721 INFO is a plist used as a communication channel."
4728 "Return TABLE-ROW number.
4729 INFO is a plist used as a communication channel. Return value is
4730 zero-based and ignores separators. The function returns nil for
4731 special colums and separators."
4743 "Return TABLE dimensions.
4745 INFO is a plist used as a communication channel.
4747 Return value is a CONS like (ROWS . COLUMNS) where
4748 ROWS (resp. COLUMNS) is the number of exportable
4749 rows (resp. columns)."
4751 ;; Set number of rows, and extract first one.
4757 ;; Set number of columns.
4759 ;; Return value.
4763 "Return address of a regular TABLE-CELL object.
4765 TABLE-CELL is the cell considered. INFO is a plist used as
4766 a communication channel.
4768 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4769 zero-based index. Only exportable cells are considered. The
4770 function returns nil for other cells."
4782 "Return regular table-cell object at ADDRESS in TABLE.
4784 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4785 zero-based index. TABLE is a table type element. INFO is
4786 a plist used as a communication channel.
4788 If no table-cell, among exportable cells, is found at ADDRESS,
4789 return nil."
4792 ;; Row at (car address) or nil.
4800 'table-cell
4807 ;;;; For Tables Of Contents
4808 ;;
4809 ;; `org-export-collect-headlines' builds a list of all exportable
4810 ;; headline elements, maybe limited to a certain depth. One can then
4811 ;; easily parse it and transcode it.
4812 ;;
4813 ;; Building lists of tables, figures or listings is quite similar.
4814 ;; Once the generic function `org-export-collect-elements' is defined,
4815 ;; `org-export-collect-tables', `org-export-collect-figures' and
4816 ;; `org-export-collect-listings' can be derived from it.
4819 "Collect headlines in order to build a table of contents.
4821 INFO is a plist used as a communication channel.
4823 When optional argument N is an integer, it specifies the depth of
4824 the table of contents. Otherwise, it is set to the value of the
4825 last headline level. See `org-export-headline-levels' for more
4826 information.
4828 Return a list of all exportable headlines as parsed elements.
4829 Footnote sections, if any, will be ignored."
4834 ;; Strip contents from HEADLINE.
4837 info))
4840 "Collect referenceable elements of a determined type.
4842 TYPE can be a symbol or a list of symbols specifying element
4843 types to search. Only elements with a caption are collected.
4845 INFO is a plist used as a communication channel.
4847 When non-nil, optional argument PREDICATE is a function accepting
4848 one argument, an element of type TYPE. It returns a non-nil
4849 value when that element should be collected.
4851 Return a list of all elements found, in order of appearance."
4856 element))
4857 info))
4860 "Build a list of tables.
4861 INFO is a plist used as a communication channel.
4863 Return a list of table elements with a caption."
4867 "Build a list of figures.
4869 INFO is a plist used as a communication channel. PREDICATE is
4870 a function which accepts one argument: a paragraph element and
4871 whose return value is non-nil when that element should be
4872 collected.
4874 A figure is a paragraph type element, with a caption, verifying
4876 a vague concept that may depend on back-end.
4878 Return a list of elements recognized as figures."
4882 "Build a list of src blocks.
4884 INFO is a plist used as a communication channel.
4886 Return a list of src-block elements with a caption."
4890 ;;;; Smart Quotes
4891 ;;
4892 ;; The main function for the smart quotes sub-system is
4893 ;; `org-export-activate-smart-quotes', which replaces every quote in
4894 ;; a given string from the parse tree with its "smart" counterpart.
4895 ;;
4896 ;; Dictionary for smart quotes is stored in
4897 ;; `org-export-smart-quotes-alist'.
4898 ;;
4899 ;; Internally, regexps matching potential smart quotes (checks at
4900 ;; string boundaries are also necessary) are defined in
4901 ;; `org-export-smart-quotes-regexps'.
4938 "Smart quotes translations.
4940 Alist whose CAR is a language string and CDR is an alist with
4941 quote type as key and a plist associating various encodings to
4942 their translation as value.
4944 A quote type can be any symbol among `opening-double-quote',
4945 `closing-double-quote', `opening-single-quote',
4946 `closing-single-quote' and `apostrophe'.
4948 Valid encodings include `:utf-8', `:html', `:latex' and
4949 `:texinfo'.
4955 ;; Possible opening quote at beginning of string.
4957 ;; Possible closing quote at beginning of string.
4959 ;; Possible apostrophe at beginning of string.
4961 ;; Opening single and double quotes.
4963 ;; Closing single and double quotes.
4965 ;; Apostrophe.
4967 ;; Possible opening quote at end of string.
4969 ;; Possible closing quote at end of string.
4971 ;; Possible apostrophe at end of string.
4973 "List of regexps matching a quote or an apostrophe.
4979 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4980 `:utf-8'. INFO is a plist used as a communication channel.
4982 The function has to retrieve information about string
4983 surroundings in parse tree. It can only happen with an
4984 unmodified string. Thus, if S has already been through another
4985 process, a non-nil ORIGINAL optional argument will provide that
4986 original string.
4988 Return the new string."
4991 ;; Try to be flexible when computing number of blanks
4992 ;; before object. The previous object may be a string
4993 ;; introduced by the back-end and not completely parsed.
4996 ;; A string with missing `:post-blank'
4997 ;; property.
5001 ;; Fallback value.
5006 ;; Return smart quote associated to a give quote Q, as
5007 ;; a string. TYPE is a symbol among `open', `close' and
5008 ;; `apostrophe'.
5018 org-export-smart-quotes-alist))))
5019 encoding)
5020 q)))))
5022 ;; Only a quote: no regexp can match. We have to check both
5023 ;; sides and decide what to do.
5031 ;; 1. Replace quote character at the beginning of S.
5033 ;; Apostrophe?
5039 ;; Closing quote?
5045 ;; Opening quote?
5051 ;; 2. Replace quotes in the middle of the string.
5053 ;; Opening quotes.
5059 ;; Closing quotes.
5065 ;; Apostrophes.
5070 ;; 3. Replace quote character at the end of S.
5072 ;; Apostrophe?
5077 ;; Closing quote?
5083 ;; Opening quote?
5088 ;; Return string with smart quotes.
5089 s))))
5091 ;;;; Topology
5092 ;;
5093 ;; Here are various functions to retrieve information about the
5094 ;; neighbourhood of a given element or object. Neighbours of interest
5095 ;; are direct parent (`org-export-get-parent'), parent headline
5096 ;; (`org-export-get-parent-headline'), first element containing an
5097 ;; object, (`org-export-get-parent-element'), parent table
5098 ;; (`org-export-get-parent-table'), previous element or object
5099 ;; (`org-export-get-previous-element') and next element or object
5100 ;; (`org-export-get-next-element').
5101 ;;
5102 ;; `org-export-get-genealogy' returns the full genealogy of a given
5103 ;; element or object, from closest parent to full parse tree.
5106 "Return BLOB parent or nil.
5107 BLOB is the element or object considered."
5111 "Return full genealogy relative to a given element or object.
5113 BLOB is the element or object being considered.
5115 Ancestors are returned from closest to farthest, the last one
5116 being the full parse tree."
5123 "Return BLOB parent headline or nil.
5124 BLOB is the element or object being considered."
5128 parent))
5131 "Return first element containing OBJECT or nil.
5132 OBJECT is the object to consider."
5136 parent))
5139 "Return OBJECT parent table or nil.
5140 OBJECT is either a `table-cell' or `table-element' type object."
5144 parent))
5147 "Return previous element or object.
5149 BLOB is an element or object. INFO is a plist used as
5150 a communication channel. Return previous exportable element or
5151 object, a string, or nil.
5153 When optional argument N is a positive integer, return a list
5154 containing up to N siblings before BLOB, from farthest to
5155 closest. With any other non-nil value, return a list containing
5156 all of them."
5158 ;; An object can belong to the contents of its parent or
5159 ;; to a secondary string. We check the latter option
5160 ;; first.
5163 org-element-all-elements))
5167 org-element-secondary-value-alist))
5168 parent)))
5171 prev)
5180 prev)))
5183 "Return next element or object.
5185 BLOB is an element or object. INFO is a plist used as
5186 a communication channel. Return next exportable element or
5187 object, a string, or nil.
5189 When optional argument N is a positive integer, return a list
5190 containing up to N siblings after BLOB, from closest to farthest.
5191 With any other non-nil value, return a list containing all of
5192 them."
5194 ;; An object can belong to the contents of its parent or to
5195 ;; a secondary string. We check the latter option first.
5198 org-element-all-objects))
5202 org-element-secondary-value-alist))
5203 parent)))
5206 next)
5214 siblings)
5218 ;;;; Translation
5219 ;;
5220 ;; `org-export-translate' translates a string according to the language
5221 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5222 ;; the dictionary used for the translation.
5352 "Dictionary for export engine.
5354 Alist whose CAR is the string to translate and CDR is an alist
5355 whose CAR is the language string and CDR is a plist whose
5356 properties are possible charsets and values translated terms.
5358 It is used as a database for `org-export-translate'. Since this
5359 function returns the string as-is if no translation was found,
5360 the variable only needs to record values different from the
5364 "Translate string S according to language specification.
5366 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5367 and `:utf-8'. INFO is a plist used as a communication channel.
5369 Translation depends on `:language' property. Return the
5370 translated string. If no translation is found, try to fall back
5371 to `:default' encoding. If it fails, return S."
5377 s)))
5380 \f
5381 ;;; Asynchronous Export
5382 ;;
5383 ;; `org-export-async-start' is the entry point for asynchronous
5384 ;; export. It recreates current buffer (including visibility,
5385 ;; narrowing and visited file) in an external Emacs process, and
5386 ;; evaluates a command there. It then applies a function on the
5387 ;; returned results in the current process.
5388 ;;
5389 ;; Asynchronously generated results are never displayed directly.
5390 ;; Instead, they are stored in `org-export-stack-contents'. They can
5391 ;; then be retrieved by calling `org-export-stack'.
5392 ;;
5393 ;; Export Stack is viewed through a dedicated major mode
5394 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5395 ;;`org-export-stack-delete', `org-export-stack-view' and
5396 ;;`org-export-stack-clear'.
5397 ;;
5398 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5399 ;; It should used whenever `org-export-async-start' is called.
5402 "Call function FUN on the results returned by BODY evaluation.
5404 BODY evaluation happens in an asynchronous process, from a buffer
5405 which is an exact copy of the current one.
5407 Use `org-export-add-to-stack' in FUN in order to register results
5408 in the stack. Examples for, respectively a temporary buffer and
5409 a file are:
5411 \(org-export-async-start
5412 \(lambda (output)
5414 \(erase-buffer)
5415 \(insert output)
5416 \(goto-char (point-min))
5417 \(org-export-add-to-stack (current-buffer) 'backend)))
5418 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5420 and
5422 \(org-export-async-start
5423 \(lambda (f) (org-export-add-to-stack f 'backend))
5424 `(expand-file-name
5425 \(org-export-to-file
5426 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5429 ;; Write the full sexp evaluating BODY in a copy of the current
5430 ;; buffer to a temporary file, as it may be too long for program
5431 ;; args in `start-process'.
5438 ;; Null characters (from variable values) are inserted
5439 ;; within the file. As a consequence, coding system for
5440 ;; buffer contents will not be recognized properly. So,
5441 ;; we make sure it is the same as the one used to display
5442 ;; the original buffer.
5444 ,coding
5447 ;; Ignore `kill-emacs-hook' and code evaluation
5448 ;; queries from Babel as we need a truly
5449 ;; non-interactive process.
5451 org-babel-confirm-evaluate-answer-no t)
5452 ;; Initialize export framework.
5454 ;; Re-create current buffer there.
5457 ;; Sexp to evaluate in the buffer.
5459 ;; Start external process.
5462 (,process
5467 "-l" org-export-async-init-file
5469 ;; Register running process in stack.
5471 ;; Set-up sentinel in order to catch results.
5473 ,process
5497 "Add a new result to export stack if not present already.
5499 SOURCE is a buffer or a file name containing export results.
5500 BACKEND is a symbol representing export back-end used to generate
5501 it.
5503 Entries already pointing to SOURCE and unavailable entries are
5504 removed beforehand. Return the new stack."
5510 "Menu for asynchronous export results and running processes."
5520 "Return source from export results at point in stack."
5527 source
5528 ;; SOURCE is not consistent with current line. The stack
5529 ;; view is outdated.
5533 "Remove all entries from export stack."
5538 "Refresh the asynchronous export stack.
5539 DUMMY is ignored. Unavailable sources are removed from the list.
5540 Return the new stack."
5550 ;; Back-end.
5552 ;; Age.
5555 ;; Compute age of the results.
5557 "%4h:%.2m "
5559 ;; Source.
5564 ;; Clear stack from exited processes, dead buffers or
5565 ;; non-existent files.
5577 "Remove export results at point from stack.
5578 If optional argument SOURCE is non-nil, remove it instead."
5583 org-export-stack-contents))))
5586 "View export results at point in stack.
5587 With an optional prefix argument IN-EMACS, force viewing files
5588 within Emacs."
5602 (define-key km "p" 'previous-line)
5603 (define-key km "\C-p" 'previous-line)
5604 (define-key km "\C-?" 'previous-line)
5605 (define-key km [up] 'previous-line)
5606 (define-key km "C" 'org-export-stack-clear)
5607 (define-key km "v" 'org-export-stack-view)
5608 (define-key km (kbd "RET") 'org-export-stack-view)
5609 (define-key km "d" 'org-export-stack-remove)
5610 km)
5611 "Keymap for Org Export Stack.")
5613 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5614 "Mode for displaying asynchronous export stack.
5617 stack.
5619 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5620 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5621 stack completely.
5623 Removing entries in an Org Export Stack buffer doesn't affect
5624 files or buffers, only the display.
5627 (abbrev-mode 0)
5628 (auto-fill-mode 0)
5629 (setq buffer-read-only t
5630 buffer-undo-list t
5631 truncate-lines t
5632 header-line-format
5633 '(:eval
5634 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5635 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5636 (set (make-local-variable 'revert-buffer-function)
5637 'org-export-stack-refresh))
5640 \f
5641 ;;; The Dispatcher
5642 ;;
5643 ;; `org-export-dispatch' is the standard interactive way to start an
5644 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5645 ;; for its interface, which, in turn, delegates response to key
5646 ;; pressed to `org-export--dispatch-action'.
5648 ;;;###autoload
5649 (defun org-export-dispatch (&optional arg)
5650 "Export dispatcher for Org mode.
5652 It provides an access to common export related tasks in a buffer.
5653 Its interface comes in two flavours: standard and expert.
5655 While both share the same set of bindings, only the former
5656 displays the valid keys associations in a dedicated buffer.
5657 Scrolling (resp. line-wise motion) in this buffer is done with
5658 SPC and DEL (resp. C-n and C-p) keys.
5660 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5661 flavour or the other.
5664 of options used back then, on the current buffer.
5666 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5667 (interactive "P")
5668 (let* ((input
5669 (cond ((equal arg '(16)) '(stack))
5670 ((and arg org-export-dispatch-last-action))
5671 (t (save-window-excursion
5672 (unwind-protect
5673 (progn
5674 ;; Remember where we are
5675 (move-marker org-export-dispatch-last-position
5676 (point)
5677 (org-base-buffer (current-buffer)))
5678 ;; Get and store an export command
5679 (setq org-export-dispatch-last-action
5680 (org-export--dispatch-ui
5681 (list org-export-initial-scope
5682 (and org-export-in-background 'async))
5683 nil
5684 org-export-dispatch-use-expert-ui)))
5685 (and (get-buffer "*Org Export Dispatcher*")
5686 (kill-buffer "*Org Export Dispatcher*")))))))
5687 (action (car input))
5688 (optns (cdr input)))
5689 (unless (memq 'subtree optns)
5690 (move-marker org-export-dispatch-last-position nil))
5691 (case action
5692 ;; First handle special hard-coded actions.
5693 (template (org-export-insert-default-template nil optns))
5694 (stack (org-export-stack))
5695 (publish-current-file
5696 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5697 (publish-current-project
5698 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5699 (publish-choose-project
5700 (org-publish (assoc (org-icompleting-read
5701 "Publish project: "
5702 org-publish-project-alist nil t)
5703 org-publish-project-alist)
5704 (memq 'force optns)
5705 (memq 'async optns)))
5706 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5707 (otherwise
5708 (save-excursion
5709 (when arg
5710 ;; Repeating command, maybe move cursor to restore subtree
5711 ;; context.
5712 (if (eq (marker-buffer org-export-dispatch-last-position)
5713 (org-base-buffer (current-buffer)))
5714 (goto-char org-export-dispatch-last-position)
5715 ;; We are in a different buffer, forget position.
5716 (move-marker org-export-dispatch-last-position nil)))
5717 (funcall action
5718 ;; Return a symbol instead of a list to ease
5719 ;; asynchronous export macro use.
5720 (and (memq 'async optns) t)
5721 (and (memq 'subtree optns) t)
5722 (and (memq 'visible optns) t)
5723 (and (memq 'body optns) t)))))))
5725 (defun org-export--dispatch-ui (options first-key expertp)
5726 "Handle interface for `org-export-dispatch'.
5728 OPTIONS is a list containing current interactive options set for
5729 export. It can contain any of the following symbols:
5730 `body' toggles a body-only export
5731 `subtree' restricts export to current subtree
5732 `visible' restricts export to visible part of buffer.
5733 `force' force publishing files.
5734 `async' use asynchronous export process
5736 FIRST-KEY is the key pressed to select the first level menu. It
5737 is nil when this menu hasn't been selected yet.
5739 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5740 buffer is provided, but indications about currently active
5741 options are given in the prompt. Moreover, \[?] allows to switch
5742 back to standard interface."
5743 (let* ((fontify-key
5744 (lambda (key &optional access-key)
5745 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5746 ;; non-nil is the required first-level key to activate
5747 ;; KEY. When its value is t, activate KEY independently
5748 ;; on the first key, if any. A nil value means KEY will
5749 ;; only be activated at first level.
5750 (if (or (eq access-key t) (eq access-key first-key))
5751 (org-propertize key 'face 'org-warning)
5752 key)))
5753 (fontify-value
5754 (lambda (value)
5755 ;; Fontify VALUE string.
5756 (org-propertize value 'face 'font-lock-variable-name-face)))
5757 ;; Prepare menu entries by extracting them from
5758 ;; `org-export-registered-backends', and sorting them by
5759 ;; access key and by ordinal, if any.
5760 (backends
5761 (sort
5762 (sort
5763 (delq nil
5764 (mapcar
5765 (lambda (b)
5766 (let ((name (car b)))
5767 (catch 'ignored
5768 ;; Ignore any back-end belonging to
5769 ;; `org-export-invisible-backends' or derived
5770 ;; from one of them.
5771 (dolist (ignored org-export-invisible-backends)
5772 (when (org-export-derived-backend-p name ignored)
5773 (throw 'ignored nil)))
5774 (org-export-backend-menu name))))
5775 org-export-registered-backends))
5776 (lambda (a b)
5777 (let ((key-a (nth 1 a))
5778 (key-b (nth 1 b)))
5779 (cond ((and (numberp key-a) (numberp key-b))
5780 (< key-a key-b))
5781 ((numberp key-b) t)))))
5782 (lambda (a b) (< (car a) (car b)))))
5783 ;; Compute a list of allowed keys based on the first key
5784 ;; pressed, if any. Some keys
5785 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
5786 ;; available.
5787 (allowed-keys
5788 (nconc (list 2 22 19 6 1)
5789 (if (not first-key) (org-uniquify (mapcar 'car backends))
5790 (let (sub-menu)
5791 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5792 (when (eq (car backend) first-key)
5793 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5794 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5795 ((not first-key) (list ?P)))
5796 (list ?& ?#)
5797 (when expertp (list ??))
5798 (list ?q)))
5799 ;; Build the help menu for standard UI.
5800 (help
5801 (unless expertp
5802 (concat
5803 ;; Options are hard-coded.
5804 (format "[%s] Body only: %s [%s] Visible only: %s
5805 \[%s] Export scope: %s [%s] Force publishing: %s
5807 (funcall fontify-key "C-b" t)
5808 (funcall fontify-value
5809 (if (memq 'body options) "On " "Off"))
5810 (funcall fontify-key "C-v" t)
5811 (funcall fontify-value
5812 (if (memq 'visible options) "On " "Off"))
5813 (funcall fontify-key "C-s" t)
5814 (funcall fontify-value
5815 (if (memq 'subtree options) "Subtree" "Buffer "))
5816 (funcall fontify-key "C-f" t)
5817 (funcall fontify-value
5818 (if (memq 'force options) "On " "Off"))
5819 (funcall fontify-key "C-a" t)
5820 (funcall fontify-value
5821 (if (memq 'async options) "On " "Off")))
5822 ;; Display registered back-end entries. When a key
5823 ;; appears for the second time, do not create another
5824 ;; entry, but append its sub-menu to existing menu.
5825 (let (last-key)
5826 (mapconcat
5827 (lambda (entry)
5828 (let ((top-key (car entry)))
5829 (concat
5830 (unless (eq top-key last-key)
5831 (setq last-key top-key)
5833 (funcall fontify-key (char-to-string top-key))
5834 (nth 1 entry)))
5835 (let ((sub-menu (nth 2 entry)))
5836 (unless (functionp sub-menu)
5837 ;; Split sub-menu into two columns.
5838 (let ((index -1))
5839 (concat
5840 (mapconcat
5841 (lambda (sub-entry)
5842 (incf index)
5843 (format
5844 (if (zerop (mod index 2)) " [%s] %-26s"
5846 (funcall fontify-key
5847 (char-to-string (car sub-entry))
5848 top-key)
5849 (nth 1 sub-entry)))
5850 sub-menu "")
5852 backends ""))
5853 ;; Publishing menu is hard-coded.
5855 [%s] Current file [%s] Current project
5857 (funcall fontify-key "P")
5858 (funcall fontify-key "f" ?P)
5859 (funcall fontify-key "p" ?P)
5860 (funcall fontify-key "x" ?P)
5861 (funcall fontify-key "a" ?P))
5863 (funcall fontify-key "&" t)
5864 (funcall fontify-key "#" t))
5865 (format "[%s] %s"
5866 (funcall fontify-key "q" t)
5867 (if first-key "Main menu" "Exit")))))
5868 ;; Build prompts for both standard and expert UI.
5869 (standard-prompt (unless expertp "Export command: "))
5870 (expert-prompt
5871 (when expertp
5872 (format
5873 "Export command (C-%s%s%s%s%s) [%s]: "
5874 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5875 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5876 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5877 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5878 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5879 (mapconcat (lambda (k)
5880 ;; Strip control characters.
5881 (unless (< k 27) (char-to-string k)))
5882 allowed-keys "")))))
5883 ;; With expert UI, just read key with a fancy prompt. In standard
5884 ;; UI, display an intrusive help buffer.
5885 (if expertp
5886 (org-export--dispatch-action
5887 expert-prompt allowed-keys backends options first-key expertp)
5888 ;; At first call, create frame layout in order to display menu.
5889 (unless (get-buffer "*Org Export Dispatcher*")
5890 (delete-other-windows)
5891 (org-switch-to-buffer-other-window
5892 (get-buffer-create "*Org Export Dispatcher*"))
5893 (setq cursor-type nil
5894 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
5895 ;; Make sure that invisible cursor will not highlight square
5896 ;; brackets.
5897 (set-syntax-table (copy-syntax-table))
5898 (modify-syntax-entry ?\[ "w"))
5899 ;; At this point, the buffer containing the menu exists and is
5900 ;; visible in the current window. So, refresh it.
5901 (with-current-buffer "*Org Export Dispatcher*"
5902 ;; Refresh help. Maintain display continuity by re-visiting
5903 ;; previous window position.
5904 (let ((pos (window-start)))
5905 (erase-buffer)
5906 (insert help)
5907 (set-window-start nil pos)))
5908 (org-fit-window-to-buffer)
5909 (org-export--dispatch-action
5910 standard-prompt allowed-keys backends options first-key expertp))))
5912 (defun org-export--dispatch-action
5913 (prompt allowed-keys backends options first-key expertp)
5914 "Read a character from command input and act accordingly.
5916 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5917 a list of characters available at a given step in the process.
5918 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5919 EXPERTP are the same as defined in `org-export--dispatch-ui',
5920 which see.
5922 Toggle export options when required. Otherwise, return value is
5923 a list with action as CAR and a list of interactive export
5924 options as CDR."
5925 (let (key)
5926 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
5927 ;; C-p, SPC, DEL).
5928 (while (and (setq key (read-char-exclusive prompt))
5929 (not expertp)
5930 (memq key '(14 16 ?\s ?\d)))
5931 (case key
5932 (14 (if (not (pos-visible-in-window-p (point-max)))
5933 (ignore-errors (scroll-up 1))
5934 (message "End of buffer")
5935 (sit-for 1)))
5936 (16 (if (not (pos-visible-in-window-p (point-min)))
5937 (ignore-errors (scroll-down 1))
5938 (message "Beginning of buffer")
5939 (sit-for 1)))
5940 (?\s (if (not (pos-visible-in-window-p (point-max)))
5941 (scroll-up nil)
5942 (message "End of buffer")
5943 (sit-for 1)))
5944 (?\d (if (not (pos-visible-in-window-p (point-min)))
5945 (scroll-down nil)
5946 (message "Beginning of buffer")
5947 (sit-for 1)))))
5948 (cond
5949 ;; Ignore undefined associations.
5950 ((not (memq key allowed-keys))
5951 (ding)
5952 (unless expertp (message "Invalid key") (sit-for 1))
5953 (org-export--dispatch-ui options first-key expertp))
5954 ;; q key at first level aborts export. At second level, cancel
5955 ;; first key instead.
5956 ((eq key ?q) (if (not first-key) (error "Export aborted")
5957 (org-export--dispatch-ui options nil expertp)))
5958 ;; Help key: Switch back to standard interface if expert UI was
5959 ;; active.
5960 ((eq key ??) (org-export--dispatch-ui options first-key nil))
5961 ;; Send request for template insertion along with export scope.
5962 ((eq key ?#) (cons 'template (memq 'subtree options)))
5963 ;; Switch to asynchronous export stack.
5964 ((eq key ?&) '(stack))
5965 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
5966 ((memq key '(2 22 19 6 1))
5967 (org-export--dispatch-ui
5968 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
5969 (6 'force) (1 'async))))
5970 (if (memq option options) (remq option options)
5971 (cons option options)))
5972 first-key expertp))
5973 ;; Action selected: Send key and options back to
5974 ;; `org-export-dispatch'.
5975 ((or first-key (functionp (nth 2 (assq key backends))))
5976 (cons (cond
5977 ((not first-key) (nth 2 (assq key backends)))
5978 ;; Publishing actions are hard-coded. Send a special
5979 ;; signal to `org-export-dispatch'.
5980 ((eq first-key ?P)
5981 (case key
5982 (?f 'publish-current-file)
5983 (?p 'publish-current-project)
5984 (?x 'publish-choose-project)
5985 (?a 'publish-all)))
5986 ;; Return first action associated to FIRST-KEY + KEY
5987 ;; path. Indeed, derived backends can share the same
5988 ;; FIRST-KEY.
5989 (t (catch 'found
5990 (mapc (lambda (backend)
5991 (let ((match (assq key (nth 2 backend))))
5992 (when match (throw 'found (nth 2 match)))))
5993 (member (assq first-key backends) backends)))))
5994 options))
5995 ;; Otherwise, enter sub-menu.
5996 (t (org-export--dispatch-ui options key expertp)))))
6000 (provide 'ox)
6002 ;; Local variables:
6003 ;; generated-autoload-file: "org-loaddefs.el"
6004 ;; End:
6006 ;;; ox.el ends here