| blob | 06513d2843759c38a20ae067b1f6810edbfbb416 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012, 2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; GNU Emacs is free software: you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
22 ;;
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
25 ;;
26 ;; Besides that parser, the generic exporter is made of three distinct
27 ;; parts:
28 ;;
29 ;; - The communication channel consists in a property list, which is
30 ;; created and updated during the process. Its use is to offer
31 ;; every piece of information, would it be about initial environment
32 ;; or contextual data, all in a single place. The exhaustive list
33 ;; of properties is given in "The Communication Channel" section of
34 ;; this file.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core function is `org-export-as'. It returns the transcoded
48 ;; buffer as a string.
49 ;;
50 ;; An export back-end is defined with `org-export-define-backend',
51 ;; which defines one mandatory information: his translation table.
52 ;; Its value is an alist whose keys are elements and objects types and
53 ;; values translator functions. See function's docstring for more
54 ;; information about translators.
55 ;;
56 ;; Optionally, `org-export-define-backend' can also support specific
57 ;; buffer keywords, OPTION keyword's items and filters. Also refer to
58 ;; function documentation for more information.
59 ;;
60 ;; If the new back-end shares most properties with another one,
61 ;; `org-export-define-derived-backend' can be used to simplify the
62 ;; process.
63 ;;
64 ;; Any back-end can define its own variables. Among them, those
65 ;; customizable should belong to the `org-export-BACKEND' group.
66 ;;
67 ;; Tools for common tasks across back-ends are implemented in the
68 ;; following part of the file.
69 ;;
70 ;; Then, a wrapper macro for asynchronous export,
71 ;; `org-export-async-start', along with tools to display results. are
72 ;; given in the penultimate part.
73 ;;
74 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
75 ;; back-ends is provided in the last one.
77 ;;; Code:
96 \f
97 ;;; Internal Variables
98 ;;
99 ;; Among internal variables, the most important is
100 ;; `org-export-options-alist'. This variable define the global export
101 ;; options, shared between every exporter, and how they are acquired.
146 "Alist between export properties and ways to set them.
148 The CAR of the alist is the property name, and the CDR is a list
149 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
151 KEYWORD is a string representing a buffer keyword, or nil. Each
152 property defined this way can also be set, during subtree
153 export, through a headline property named after the keyword
155 property).
156 OPTION is a string that could be found in an #+OPTIONS: line.
157 DEFAULT is the default value for the property.
158 BEHAVIOUR determines how Org should handle multiple keywords for
159 the same property. It is a symbol among:
160 nil Keep old value and discard the new one.
161 t Replace old value with the new one.
162 `space' Concatenate the values, separating them with a space.
163 `newline' Concatenate the values, separating them with
164 a newline.
165 `split' Split values at white spaces, and cons them to the
166 previous list.
168 Values set through KEYWORD and OPTION have precedence over
169 DEFAULT.
171 All these properties should be back-end agnostic. Back-end
172 specific properties are set through `org-export-define-backend'.
176 "List of in-buffer keywords that require special treatment.
177 These keywords are not directly associated to a property. The
178 way they are handled must be hard-coded into
238 "Alist between filters properties and initial values.
240 The key of each association is a property name accessible through
241 the communication channel. Its value is a configurable global
242 variable defining initial filters.
244 This list is meant to install user specified filters. Back-end
245 developers may install their own filters using
246 `org-export-define-backend'. Filters defined there will always
247 be prepended to the current list, so they always get applied
256 "Default rule for link matching an inline image.
257 This rule applies to links with no description. By default, it
258 will be considered as an inline image if it targets a local file
261 See `org-export-inline-image-p' for more information about
265 "Non-nil means asynchronous export process should leave data behind.
269 located in `temporary-file-directory'.
271 When non-nil, it will also set `debug-on-error' to a non-nil
275 "Record asynchronously generated export results and processes.
276 This is an alist: its CAR is the source of the
277 result (destination file or buffer for a finished process,
278 original buffer for a running one) and its CDR is a list
279 containing the back-end used, as a symbol, and either a process
280 or the time at which it finished. It is used to build the menu
284 "List of backends currently available in the exporter.
286 A backend is stored as a list where CAR is its name, as a symbol,
287 and CDR is a plist with the following properties:
288 `:filters-alist', `:menu-entry', `:options-alist' and
289 `:translate-alist'.
291 This variable is set with `org-export-define-backend' and
295 "Last command called from the dispatcher.
296 The value should be a list. Its CAR is the action, as a symbol,
300 "The position where the last export command was created using the dispatcher.
301 This marker will be used with `C-u C-c C-e' to make sure export repetition
304 \f
305 ;;; User-configurable Variables
306 ;;
307 ;; Configuration for the masses.
308 ;;
309 ;; They should never be accessed directly, as their value is to be
310 ;; stored in a property list (cf. `org-export-options-alist').
311 ;; Back-ends will read their value from there instead.
314 "Options for exporting Org mode files."
319 "General options for export engine."
324 "Whether sub-trees with the ARCHIVE tag should be exported.
326 This can have three different values:
327 nil Do not export, pretend this tree is not present.
328 t Do export the entire tree.
329 `headline' Only export the headline, but skip the tree below it.
331 This option can also be set with the OPTIONS keyword,
340 "Non-nil means insert author name into the exported file.
341 This option can also be set with the OPTIONS keyword,
347 "Non-nil means export CLOCK keywords.
348 This option can also be set with the OPTIONS keyword,
354 "Non-nil means the postamble should contain a creator sentence.
356 The sentence can be set in `org-export-creator-string' and
359 If the value is `comment' insert it as a comment."
367 "Non-nil means insert date in the exported document.
368 This option can also be set with the OPTIONS keyword,
374 "Time-stamp format string to use for DATE keyword.
376 The format string, when specified, only applies if date consists
377 in a single time-stamp. Otherwise its value will be ignored.
379 See `format-time-string' for details on how to build this
380 string."
388 emacs-version
390 "Information about the creator of the document.
391 This option can also be set on with the CREATOR keyword."
396 "Non-nil means export contents of standard drawers.
398 When t, all drawers are exported. This may also be a list of
399 drawer names to export. If that list starts with `not', only
400 drawers with such names will be ignored.
402 This variable doesn't apply to properties drawers.
404 This option can also be set with the OPTIONS keyword,
417 :inline t
421 "Non-nil means insert author email into the exported file.
422 This option can also be set with the OPTIONS keyword,
428 "Non-nil means interpret *word*, /word/, _word_ and +word+.
430 If the export target supports emphasizing text, the word will be
431 typeset in bold, italic, with an underline or strike-through,
432 respectively.
434 This option can also be set with the OPTIONS keyword,
440 "Tags that exclude a tree from export.
442 All trees carrying any of these tags will be excluded from
443 export. This is without condition, so even subtrees inside that
444 carry one of the `org-export-select-tags' will be removed.
446 This option can also be set with the EXCLUDE_TAGS keyword."
453 This can be used to have pre-formatted text, fragments of code
454 etc. For example:
455 : ;; Some Lisp examples
456 : (while (defc cnt)
457 : (ding))
458 will be looking just like this in also HTML. See also the QUOTE
459 keyword. Not all export backends support this.
461 This option can also be set with the OPTIONS keyword,
467 "Non-nil means Org footnotes should be exported.
468 This option can also be set with the OPTIONS keyword,
474 "Non-nil means process LaTeX environments and fragments.
476 This option can also be set with the OPTIONS line,
479 nil Ignore math snippets.
480 `verbatim' Keep everything in verbatim.
481 t Allow export of math snippets."
491 "The last level which is still exported as a headline.
493 Inferior levels will usually produce itemize or enumerate lists
494 when exported, but back-end behaviour may differ.
496 This option can also be set with the OPTIONS keyword,
502 "The default language for export and clocktable translations, as a string.
503 This may have an association in
504 `org-clock-clocktable-language-setup'. This option can also be
505 set with the LANGUAGE keyword."
510 "Non-nil means preserve all line breaks when exporting.
511 This option can also be set with the OPTIONS keyword,
517 "Non-nil means interpret entities when exporting.
520 Å.
522 For a list of supported names, see the constant `org-entities'
523 and the user option `org-entities-user'.
525 This option can also be set with the OPTIONS keyword,
531 "Non-nil means inlinetasks should be exported.
532 This option can also be set with the OPTIONS keyword,
540 "Non-nil means include planning info in export.
542 Planning info is the line containing either SCHEDULED:,
543 DEADLINE:, CLOSED: time-stamps, or a combination of them.
545 This option can also be set with the OPTIONS keyword,
553 "Non-nil means include priority cookies in export.
554 This option can also be set with the OPTIONS keyword,
560 "Non-nil means add section numbers to headlines when exporting.
562 When set to an integer n, numbering will only happen for
563 headlines whose relative level is higher or equal to n.
565 This option can also be set with the OPTIONS keyword,
571 "Tags that select a tree for export.
573 If any such tag is found in a buffer, all trees that do not carry
574 one of these tags will be ignored during export. Inside trees
575 that are selected like this, you can still deselect a subtree by
576 tagging it with one of the `org-export-exclude-tags'.
578 This option can also be set with the SELECT_TAGS keyword."
583 "Non-nil means activate smart quotes during export.
584 This option can also be set with the OPTIONS keyword,
587 When setting this to non-nil, you need to take care of
588 using the correct Babel package when exporting to LaTeX.
589 E.g., you can load Babel for french like this:
600 When this option is turned on, these strings will be exported as:
602 Org HTML LaTeX UTF-8
603 -----+----------+--------+-------
605 -- – -- –
606 --- — --- —
609 This option can also be set with the OPTIONS keyword,
615 "Non-nil means include statistics cookies in export.
616 This option can also be set with the OPTIONS keyword,
626 When this option is turned on, you can use TeX-like syntax for
628 will be considered as a single item - so grouping with {} is
629 normally not needed. For example, the following things will be
630 parsed as single sub- or superscripts.
632 10^24 or 10^tau several digits will be considered 1 item.
633 10^-12 or 10^-tau a leading sign with digits or a word
634 x^2-y^3 will be read as x^2 - y^3, because items are
635 terminated by almost any nonword/nondigit char.
636 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
638 Still, ambiguity is possible - so when in doubt use {} to enclose
639 the sub/superscript. If you set this variable to the symbol
640 `{}', the braces are *required* in order to trigger
641 interpretations as sub/superscript. This can be helpful in
644 This option can also be set with the OPTIONS keyword,
653 "Non-nil means create a table of contents in exported files.
655 The TOC contains headlines with levels up
656 to`org-export-headline-levels'. When an integer, include levels
657 up to N in the toc, this may then be different from
658 `org-export-headline-levels', but it will not be allowed to be
659 larger than the number of headline levels. When nil, no table of
660 contents is made.
662 This option can also be set with the OPTIONS keyword,
672 For example:
674 | Name | Address | Birthday |
675 |-------------+----------+-----------|
676 | Arthur Dent | England | 29.2.2100 |
678 This option can also be set with the OPTIONS keyword,
684 "If nil, do not export tags, just remove them from headlines.
686 If this is the symbol `not-in-toc', tags will be removed from
687 table of contents entries, but still be shown in the headlines of
688 the document.
690 This option can also be set with the OPTIONS keyword,
699 "Non-nil means include TODO items for export.
701 This may have the following values:
702 t include tasks independent of state.
703 `todo' include only tasks that are not yet done.
704 `done' include only tasks that are already done.
705 nil ignore all tasks.
706 list of keywords include tasks with these keywords.
708 This option can also be set with the OPTIONS keyword,
720 "Non-nil means insert a time stamp into the exported file.
721 The time stamp shows when the file was created. This option can
727 "Non nil means allow timestamps in export.
729 It can be set to any of the following values:
730 t export all timestamps.
731 `active' export active timestamps only.
732 `inactive' export inactive timestamps only.
733 nil do not export timestamps
735 This only applies to timestamps isolated in a paragraph
736 containing only timestamps. Other timestamps are always
737 exported.
739 This option can also be set with the OPTIONS keyword, e.g.
749 "Non-nil means include TODO keywords in export.
750 When nil, remove all these keywords from the export. This option
756 "Non-nil means BIND keywords can define local variable values.
757 This is a potential security risk, which is why the default value
758 is nil. You can also allow them through local buffer variables."
765 "Alist between export snippets back-ends and exporter back-ends.
767 This variable allows to provide shortcuts for export snippets.
771 HTML code while every other back-end will ignore it."
780 "Coding system for the exported file."
787 "Should we push exported content to the kill ring?"
796 "The initial scope when exporting with `org-export-dispatch'.
797 This variable can be either set to `buffer' or `subtree'."
804 "Non-nil means show buffer after exporting to temp buffer.
805 When Org exports to a file, the buffer visiting that file is ever
806 shown, but remains buried. However, when exporting to
807 a temporary buffer, that buffer is popped up in a second window.
808 When this variable is nil, the buffer remains buried also in
809 these cases."
814 "Non-nil means export and publishing commands will run in background.
815 Results from an asynchronous export are never displayed
823 "File used to initialize external export process.
824 Value must be an absolute file name. It defaults to user's
825 initialization file. Though, a specific configuration makes the
826 process faster and the export more portable."
833 "List of back-ends that shouldn't appear in the dispatcher.
835 Any back-end belonging to this list or derived from a back-end
836 belonging to it will not appear in the dispatcher menu.
838 Indeed, Org may require some export back-ends without notice. If
839 these modules are never to be used interactively, adding them
840 here will avoid cluttering the dispatcher menu."
847 "Non-nil means using a non-intrusive `org-export-dispatch'.
848 In that case, no help buffer is displayed. Though, an indicator
854 asynchronous). Also, \[?] allows to switch back to standard
855 mode."
862 \f
863 ;;; Defining Back-ends
864 ;;
865 ;; `org-export-define-backend' is the standard way to define an export
866 ;; back-end. It allows to specify translators, filters, buffer
867 ;; options and a menu entry. If the new back-end shares translators
868 ;; with another back-end, `org-export-define-derived-backend' may be
869 ;; used instead.
870 ;;
871 ;; Internally, a back-end is stored as a list, of which CAR is the
872 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
873 ;; properties of a given back-end are: `org-export-backend-filters',
874 ;; `org-export-backend-menu', `org-export-backend-options' and
875 ;; `org-export-backend-translate-table'.
876 ;;
877 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
878 ;; when a given back-end hasn't been registered yet.
881 "Define a new back-end BACKEND.
883 TRANSLATORS is an alist between object or element types and
884 functions handling them.
886 These functions should return a string without any trailing
887 space, or nil. They must accept three arguments: the object or
888 element itself, its contents or nil when it isn't recursive and
889 the property list used as a communication channel.
891 Contents, when not nil, are stripped from any global indentation
892 \(although the relative one is preserved). They also always end
893 with a single newline character.
895 If, for a given type, no function is found, that element or
896 object type will simply be ignored, along with any blank line or
897 white space at its end. The same will happen if the function
898 returns the nil value. If that function returns the empty
899 string, the type will be ignored, but the blank lines or white
900 spaces will be kept.
902 In addition to element and object types, one function can be
903 associated to the `template' (or `inner-template') symbol and
904 another one to the `plain-text' symbol.
906 The former returns the final transcoded string, and can be used
907 to add a preamble and a postamble to document's body. It must
908 accept two arguments: the transcoded string and the property list
909 containing export options. A function associated to `template'
911 A function associated to `inner-template' is always applied.
913 The latter, when defined, is to be called on every text not
914 recognized as an element or an object. It must accept two
915 arguments: the text string and the information channel. It is an
916 appropriate place to protect special chars relative to the
917 back-end.
919 BODY can start with pre-defined keyword arguments. The following
920 keywords are understood:
922 :export-block
924 String, or list of strings, representing block names that
925 will not be parsed. This is used to specify blocks that will
926 contain raw code specific to the back-end. These blocks
927 still have to be handled by the relative `export-block' type
928 translator.
930 :filters-alist
932 Alist between filters and function, or list of functions,
933 specific to the back-end. See `org-export-filters-alist' for
934 a list of all allowed filters. Filters defined here
935 shouldn't make a back-end test, as it may prevent back-ends
936 derived from this one to behave properly.
938 :menu-entry
940 Menu entry for the export dispatcher. It should be a list
941 like:
943 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
945 where :
947 KEY is a free character selecting the back-end.
949 DESCRIPTION-OR-ORDINAL is either a string or a number.
951 If it is a string, is will be used to name the back-end in
952 its menu entry. If it is a number, the following menu will
953 be displayed as a sub-menu of the back-end with the same
954 KEY. Also, the number will be used to determine in which
955 order such sub-menus will appear (lowest first).
957 ACTION-OR-MENU is either a function or an alist.
959 If it is an action, it will be called with four
960 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
961 BODY-ONLY. See `org-export-as' for further explanations on
962 some of them.
964 If it is an alist, associations should follow the
965 pattern:
967 '(KEY DESCRIPTION ACTION)
969 where KEY, DESCRIPTION and ACTION are described above.
971 Valid values include:
975 or
980 \(lambda (a s v b)
981 \(if a (org-latex-export-to-pdf t s v b)
982 \(org-open-file
983 \(org-latex-export-to-pdf nil s v b)))))))
985 or the following, which will be added to the previous
986 sub-menu,
988 '(?l 1
992 :options-alist
994 Alist between back-end specific properties introduced in
995 communication channel and how their value are acquired. See
996 `org-export-options-alist' for more information about
997 structure of the values."
1014 ;; Register back-end.
1018 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1024 export-block))))
1027 "Create a new back-end as a variant of an existing one.
1029 CHILD is the name of the derived back-end. PARENT is the name of
1030 the parent back-end.
1032 BODY can start with pre-defined keyword arguments. The following
1033 keywords are understood:
1035 :export-block
1037 String, or list of strings, representing block names that
1038 will not be parsed. This is used to specify blocks that will
1039 contain raw code specific to the back-end. These blocks
1040 still have to be handled by the relative `export-block' type
1041 translator.
1043 :filters-alist
1045 Alist of filters that will overwrite or complete filters
1046 defined in PARENT back-end. See `org-export-filters-alist'
1047 for a list of allowed filters.
1049 :menu-entry
1051 Menu entry for the export dispatcher. See
1052 `org-export-define-backend' for more information about the
1053 expected value.
1055 :options-alist
1057 Alist of back-end specific properties that will overwrite or
1058 complete those defined in PARENT back-end. Refer to
1059 `org-export-options-alist' for more information about
1060 structure of the values.
1062 :translate-alist
1064 Alist of element and object types and transcoders that will
1065 overwrite or complete transcode table from PARENT back-end.
1066 Refer to `org-export-define-backend' for detailed information
1067 about transcoders.
1070 as a variant of `latex' back-end with a custom template function:
1072 \(org-export-define-derived-backend 'my-latex 'latex
1073 :translate-alist '((template . my-latex-template-fun)))
1075 The back-end could then be called with, for example:
1101 ;; Register back-end.
1105 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1111 export-block))))
1114 "Return back-end from which BACKEND is derived, or nil."
1118 "Return filters for BACKEND."
1123 "Return menu entry for BACKEND."
1128 "Return export options for BACKEND."
1133 "Return translate table for BACKEND."
1138 "Signal an error if BACKEND isn't defined."
1143 "Non-nil if BACKEND is derived from one of BACKENDS."
1147 parent))
1150 \f
1151 ;;; The Communication Channel
1152 ;;
1153 ;; During export process, every function has access to a number of
1154 ;; properties. They are of two types:
1155 ;;
1156 ;; 1. Environment options are collected once at the very beginning of
1157 ;; the process, out of the original buffer and configuration.
1158 ;; Collecting them is handled by `org-export-get-environment'
1159 ;; function.
1160 ;;
1161 ;; Most environment options are defined through the
1162 ;; `org-export-options-alist' variable.
1163 ;;
1164 ;; 2. Tree properties are extracted directly from the parsed tree,
1165 ;; just before export, by `org-export-collect-tree-properties'.
1166 ;;
1167 ;; Here is the full list of properties available during transcode
1168 ;; process, with their category and their value type.
1169 ;;
1170 ;; + `:author' :: Author's name.
1171 ;; - category :: option
1172 ;; - type :: string
1173 ;;
1174 ;; + `:back-end' :: Current back-end used for transcoding.
1175 ;; - category :: tree
1176 ;; - type :: symbol
1177 ;;
1178 ;; + `:creator' :: String to write as creation information.
1179 ;; - category :: option
1180 ;; - type :: string
1181 ;;
1182 ;; + `:date' :: String to use as date.
1183 ;; - category :: option
1184 ;; - type :: string
1185 ;;
1186 ;; + `:description' :: Description text for the current data.
1187 ;; - category :: option
1188 ;; - type :: string
1189 ;;
1190 ;; + `:email' :: Author's email.
1191 ;; - category :: option
1192 ;; - type :: string
1193 ;;
1194 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1195 ;; process.
1196 ;; - category :: option
1197 ;; - type :: list of strings
1198 ;;
1199 ;; + `:export-options' :: List of export options available for current
1200 ;; process.
1201 ;; - category :: none
1202 ;; - type :: list of symbols, among `subtree', `body-only' and
1203 ;; `visible-only'.
1204 ;;
1205 ;; + `:exported-data' :: Hash table used for memoizing
1206 ;; `org-export-data'.
1207 ;; - category :: tree
1208 ;; - type :: hash table
1209 ;;
1210 ;; + `:filetags' :: List of global tags for buffer. Used by
1211 ;; `org-export-get-tags' to get tags with inheritance.
1212 ;; - category :: option
1213 ;; - type :: list of strings
1214 ;;
1215 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1216 ;; their definition, as parsed data. Only non-inlined footnotes
1217 ;; are represented in this alist. Also, every definition isn't
1218 ;; guaranteed to be referenced in the parse tree. The purpose of
1219 ;; this property is to preserve definitions from oblivion
1220 ;; (i.e. when the parse tree comes from a part of the original
1221 ;; buffer), it isn't meant for direct use in a back-end. To
1222 ;; retrieve a definition relative to a reference, use
1223 ;; `org-export-get-footnote-definition' instead.
1224 ;; - category :: option
1225 ;; - type :: alist (STRING . LIST)
1226 ;;
1227 ;; + `:headline-levels' :: Maximum level being exported as an
1228 ;; headline. Comparison is done with the relative level of
1229 ;; headlines in the parse tree, not necessarily with their
1230 ;; actual level.
1231 ;; - category :: option
1232 ;; - type :: integer
1233 ;;
1234 ;; + `:headline-offset' :: Difference between relative and real level
1235 ;; of headlines in the parse tree. For example, a value of -1
1236 ;; means a level 2 headline should be considered as level
1237 ;; 1 (cf. `org-export-get-relative-level').
1238 ;; - category :: tree
1239 ;; - type :: integer
1240 ;;
1241 ;; + `:headline-numbering' :: Alist between headlines and their
1242 ;; numbering, as a list of numbers
1243 ;; (cf. `org-export-get-headline-number').
1244 ;; - category :: tree
1245 ;; - type :: alist (INTEGER . LIST)
1246 ;;
1247 ;; + `:id-alist' :: Alist between ID strings and destination file's
1248 ;; path, relative to current directory. It is used by
1249 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1250 ;; external file.
1251 ;; - category :: option
1252 ;; - type :: alist (STRING . STRING)
1253 ;;
1254 ;; + `:ignore-list' :: List of elements and objects that should be
1255 ;; ignored during export.
1256 ;; - category :: tree
1257 ;; - type :: list of elements and objects
1258 ;;
1259 ;; + `:input-file' :: Full path to input file, if any.
1260 ;; - category :: option
1261 ;; - type :: string or nil
1262 ;;
1263 ;; + `:keywords' :: List of keywords attached to data.
1264 ;; - category :: option
1265 ;; - type :: string
1266 ;;
1267 ;; + `:language' :: Default language used for translations.
1268 ;; - category :: option
1269 ;; - type :: string
1270 ;;
1271 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1272 ;; transcoding.
1273 ;; - category :: option
1274 ;; - type :: list (as returned by `org-element-parse-buffer')
1275 ;;
1276 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1277 ;; all line breaks.
1278 ;; - category :: option
1279 ;; - type :: symbol (nil, t)
1280 ;;
1281 ;; + `:section-numbers' :: Non-nil means transcoding should add
1282 ;; section numbers to headlines.
1283 ;; - category :: option
1284 ;; - type :: symbol (nil, t)
1285 ;;
1286 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1287 ;; in transcoding. When such a tag is present, subtrees without
1288 ;; it are de facto excluded from the process. See
1289 ;; `use-select-tags'.
1290 ;; - category :: option
1291 ;; - type :: list of strings
1292 ;;
1293 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1294 ;; a time stamp in the output.
1295 ;; - category :: option
1296 ;; - type :: symbol (nil, t)
1297 ;;
1298 ;; + `:translate-alist' :: Alist between element and object types and
1299 ;; transcoding functions relative to the current back-end.
1300 ;; Special keys `inner-template', `template' and `plain-text' are
1301 ;; also possible.
1302 ;; - category :: option
1303 ;; - type :: alist (SYMBOL . FUNCTION)
1304 ;;
1305 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1306 ;; also be transcoded. If it is set to the `headline' symbol,
1307 ;; only the archived headline's name is retained.
1308 ;; - category :: option
1309 ;; - type :: symbol (nil, t, `headline')
1310 ;;
1311 ;; + `:with-author' :: Non-nil means author's name should be included
1312 ;; in the output.
1313 ;; - category :: option
1314 ;; - type :: symbol (nil, t)
1315 ;;
1316 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1317 ;; - category :: option
1318 ;; - type :: symbol (nil, t)
1319 ;;
1320 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1321 ;; inserted at the end of the transcoded string. If the value
1322 ;; is `comment', it should be commented.
1323 ;; - category :: option
1324 ;; - type :: symbol (`comment', nil, t)
1325 ;;
1326 ;; + `:with-date' :: Non-nil means output should contain a date.
1327 ;; - category :: option
1328 ;; - type :. symbol (nil, t)
1329 ;;
1330 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1331 ;; its value is a list of names, only drawers with such names
1332 ;; will be transcoded. If that list starts with `not', drawer
1333 ;; with these names will be skipped.
1334 ;; - category :: option
1335 ;; - type :: symbol (nil, t) or list of strings
1336 ;;
1337 ;; + `:with-email' :: Non-nil means output should contain author's
1338 ;; email.
1339 ;; - category :: option
1340 ;; - type :: symbol (nil, t)
1341 ;;
1342 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1343 ;; interpreted.
1344 ;; - category :: option
1345 ;; - type :: symbol (nil, t)
1346 ;;
1347 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1348 ;; strings starting with a colon as a fixed-with (verbatim) area.
1349 ;; - category :: option
1350 ;; - type :: symbol (nil, t)
1351 ;;
1352 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1353 ;; footnotes.
1354 ;; - category :: option
1355 ;; - type :: symbol (nil, t)
1356 ;;
1357 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1358 ;; `latex-fragment' objects should appear in export output. When
1359 ;; this property is set to `verbatim', they will be left as-is.
1360 ;; - category :: option
1361 ;; - type :: symbol (`verbatim', nil, t)
1362 ;;
1363 ;; + `:with-planning' :: Non-nil means transcoding should include
1364 ;; planning info.
1365 ;; - category :: option
1366 ;; - type :: symbol (nil, t)
1367 ;;
1368 ;; + `:with-priority' :: Non-nil means transcoding should include
1369 ;; priority cookies.
1370 ;; - category :: option
1371 ;; - type :: symbol (nil, t)
1372 ;;
1373 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1374 ;; plain text.
1375 ;; - category :: option
1376 ;; - type :: symbol (nil, t)
1377 ;;
1378 ;; + `:with-special-strings' :: Non-nil means transcoding should
1379 ;; interpret special strings in plain text.
1380 ;; - category :: option
1381 ;; - type :: symbol (nil, t)
1382 ;;
1383 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1384 ;; interpret subscript and superscript. With a value of "{}",
1385 ;; only interpret those using curly brackets.
1386 ;; - category :: option
1387 ;; - type :: symbol (nil, {}, t)
1388 ;;
1389 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1390 ;; tables.
1391 ;; - category :: option
1392 ;; - type :: symbol (nil, t)
1393 ;;
1394 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1395 ;; headlines. A `not-in-toc' value will remove them from the
1396 ;; table of contents, if any, nonetheless.
1397 ;; - category :: option
1398 ;; - type :: symbol (nil, t, `not-in-toc')
1399 ;;
1400 ;; + `:with-tasks' :: Non-nil means transcoding should include
1401 ;; headlines with a TODO keyword. A `todo' value will only
1402 ;; include headlines with a todo type keyword while a `done'
1403 ;; value will do the contrary. If a list of strings is provided,
1404 ;; only tasks with keywords belonging to that list will be kept.
1405 ;; - category :: option
1406 ;; - type :: symbol (t, todo, done, nil) or list of strings
1407 ;;
1408 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1409 ;; time stamps. Special value `active' (resp. `inactive') ask to
1410 ;; export only active (resp. inactive) timestamps. Otherwise,
1411 ;; completely remove them.
1412 ;; - category :: option
1413 ;; - type :: symbol: (`active', `inactive', t, nil)
1414 ;;
1415 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1416 ;; added to the output. An integer value limits its depth.
1417 ;; - category :: option
1418 ;; - type :: symbol (nil, t or integer)
1419 ;;
1420 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1421 ;; include TODO keywords.
1422 ;; - category :: option
1423 ;; - type :: symbol (nil, t)
1426 ;;;; Environment Options
1427 ;;
1428 ;; Environment options encompass all parameters defined outside the
1429 ;; scope of the parsed data. They come from five sources, in
1430 ;; increasing precedence order:
1431 ;;
1432 ;; - Global variables,
1433 ;; - Buffer's attributes,
1434 ;; - Options keyword symbols,
1435 ;; - Buffer keywords,
1436 ;; - Subtree properties.
1437 ;;
1438 ;; The central internal function with regards to environment options
1439 ;; is `org-export-get-environment'. It updates global variables with
1440 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1441 ;; the different sources.
1442 ;;
1443 ;; The internal functions doing the retrieval are:
1444 ;; `org-export--get-global-options',
1445 ;; `org-export--get-buffer-attributes',
1446 ;; `org-export--parse-option-keyword',
1447 ;; `org-export--get-subtree-options' and
1448 ;; `org-export--get-inbuffer-options'
1449 ;;
1450 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1451 ;; relative to "#+BIND:" keywords.
1454 "Collect export options from the current buffer.
1456 Optional argument BACKEND is a symbol specifying which back-end
1457 specific options to read, if any.
1459 When optional argument SUBTREEP is non-nil, assume the export is
1460 done against the current sub-tree.
1462 Third optional argument EXT-PLIST is a property list with
1463 external parameters overriding Org default settings, but still
1464 inferior to file-local settings."
1465 ;; First install #+BIND variables since these must be set before
1466 ;; global options are read.
1469 ;; Get and prioritize export options...
1471 ;; ... from global variables...
1473 ;; ... from an external property list...
1474 ext-plist
1475 ;; ... from in-buffer settings...
1477 ;; ... and from subtree, when appropriate.
1479 ;; Eventually add misc. properties.
1481 :back-end
1482 backend
1483 :translate-alist
1485 :footnote-definition-alist
1486 ;; Footnotes definitions must be collected in the original
1487 ;; buffer, as there's no insurance that they will still be in
1488 ;; the parse tree, due to possible narrowing.
1502 alist))))
1503 alist))
1504 :id-alist
1505 ;; Collect id references.
1516 alist))))
1519 "Parse an OPTIONS line and return values as a plist.
1520 Optional argument BACKEND is a symbol specifying which back-end
1521 specific items to read, if any."
1523 ;; Priority is given to back-end specific options.
1525 org-export-options-alist))
1526 plist)
1535 options))
1537 property
1540 plist))
1543 "Get export options in subtree at point.
1544 Optional argument BACKEND is a symbol specifying back-end used
1545 for export. Return options as a plist."
1546 ;; For each buffer keyword, create a headline property setting the
1547 ;; same property in communication channel. The name for the property
1548 ;; is the keyword with "EXPORT_" appended to it.
1551 ;; Make sure point is at a heading.
1553 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1554 ;; title as its fallback value.
1560 plist :title
1563 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1567 ;; Handle other keywords. TITLE keyword is excluded as it has
1568 ;; been handled already.
1576 ;; Export properties are not case-sensitive.
1583 plist
1584 property
1586 ;; Parse VALUE if required.
1590 ;; If BEHAVIOUR is `split' expected value is
1591 ;; a list of strings, not a string.
1594 ;; Look for both general keywords and back-end specific
1595 ;; options, with priority given to the latter.
1597 org-export-options-alist)))
1598 ;; Return value.
1599 plist)))
1602 "Return current buffer export options, as a plist.
1604 Optional argument BACKEND, when non-nil, is a symbol specifying
1605 which back-end specific options should also be read in the
1606 process.
1608 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1610 get-options ; For byte-compiler.
1613 ;; Priority is given to back-end specific options.
1615 org-export-options-alist))
1618 org-export-special-keywords))))
1621 ;; Return property name associated to KEYWORD.
1626 options))))
1629 ;; Recursively read keywords in buffer. FILES is a list
1630 ;; of files read so far. PLIST is the current property
1631 ;; list obtained.
1640 ;; Options in `org-export-special-keywords'.
1644 ;; Avoid circular dependencies.
1654 plist
1659 plist
1665 ;; Options in `org-export-options-alist'.
1670 plist prop
1671 ;; Handle value depending on specified
1672 ;; BEHAVIOUR.
1678 " "
1690 ;; Return final value.
1691 plist))))
1692 ;; Read options in the current buffer.
1694 ;; Parse keywords specified in `org-element-document-properties'.
1696 ;; Find the property associated to the keyword.
1704 org-element-document-properties)
1705 ;; Return value.
1706 plist))
1709 "Return properties related to buffer attributes, as a plist."
1712 ;; Store full path of input file name, or nil. For internal use.
1713 :input-file visited-file
1720 "Return global export options as a plist.
1722 Optional argument BACKEND, if non-nil, is a symbol specifying
1723 which back-end specific export options should also be read in the
1724 process."
1726 ;; Priority is given to back-end specific options.
1728 org-export-options-alist))
1729 plist)
1735 ;; Only set property if default value is non-nil.
1739 plist
1740 prop
1741 ;; If keyword belongs to
1742 ;; `org-element-document-properties', parse
1743 ;; default value as a secondary string before
1744 ;; storing it.
1748 org-element-document-properties))
1749 value
1752 all)
1753 ;; Return value.
1754 plist))
1757 "Return variables bound from BIND keywords in current buffer.
1758 Also look for BIND keywords in setup files. The return value is
1759 an alist where associations are (VARIABLE-NAME VALUE)."
1764 ;; Return an alist between variable names and their
1765 ;; value. FILES is a list of setup files names read so
1766 ;; far, used to avoid circular dependencies. ALIST is
1767 ;; the alist collected so far.
1778 ;; Enter setup file.
1788 alist))))))))))
1789 alist)))))
1790 ;; Return value in appropriate order of appearance.
1794 ;;;; Tree Properties
1795 ;;
1796 ;; Tree properties are information extracted from parse tree. They
1797 ;; are initialized at the beginning of the transcoding process by
1798 ;; `org-export-collect-tree-properties'.
1799 ;;
1800 ;; Dedicated functions focus on computing the value of specific tree
1801 ;; properties during initialization. Thus,
1802 ;; `org-export--populate-ignore-list' lists elements and objects that
1803 ;; should be skipped during export, `org-export--get-min-level' gets
1804 ;; the minimal exportable level, used as a basis to compute relative
1805 ;; level for headlines. Eventually
1806 ;; `org-export--collect-headline-numbering' builds an alist between
1807 ;; headlines and their numbering.
1810 "Extract tree properties from parse tree.
1812 DATA is the parse tree from which information is retrieved. INFO
1813 is a list holding export options.
1815 Following tree properties are set or updated:
1817 `:exported-data' Hash table used to memoize results from
1818 `org-export-data'.
1820 `:footnote-definition-alist' List of footnotes definitions in
1821 original buffer and current parse tree.
1823 `:headline-offset' Offset between true level of headlines and
1824 local level. An offset of -1 means a headline
1825 of level 2 should be considered as a level
1826 1 headline in the context.
1828 `:headline-numbering' Alist of all headlines as key an the
1829 associated numbering as value.
1831 `:ignore-list' List of elements that should be ignored during
1832 export.
1834 Return updated plist."
1835 ;; Install the parse tree in the communication channel, in order to
1836 ;; use `org-export-get-genealogy' and al.
1838 ;; Get the list of elements and objects to ignore, and put it into
1839 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1840 ;; been done during parse tree filtering.
1843 :ignore-list
1846 ;; Compute `:headline-offset' in order to be able to use
1847 ;; `org-export-get-relative-level'.
1850 :headline-offset
1852 ;; Update footnotes definitions list with definitions in parse tree.
1853 ;; This is required since buffer expansion might have modified
1854 ;; boundaries of footnote definitions contained in the parse tree.
1855 ;; This way, definitions in `footnote-definition-alist' are bound to
1856 ;; match those in the parse tree.
1862 defs)))
1864 ;; Properties order doesn't matter: get the rest of the tree
1865 ;; properties.
1869 info))
1872 "Return minimum exportable headline's level in DATA.
1873 DATA is parsed tree as returned by `org-element-parse-buffer'.
1874 OPTIONS is a plist holding export options."
1885 ;; If no headline was found, for the sake of consistency, set
1886 ;; minimum level to 1 nonetheless.
1890 "Return numbering of all exportable headlines in a parse tree.
1892 DATA is the parse tree. OPTIONS is the plist holding export
1893 options.
1895 Return an alist whose key is a headline and value is its
1896 associated numbering \(in the shape of a list of numbers\) or nil
1897 for a footnotes section."
1905 headline
1907 for idx from 0 to org-export-max-depth
1911 options)))
1914 "Return list of elements and objects to ignore during export.
1915 DATA is the parse tree to traverse. OPTIONS is the plist holding
1916 export options."
1918 walk-data
1919 ;; First find trees containing a select tag, if any.
1923 ;; Collect ignored elements or objects into IGNORE-LIST.
1929 ;; If headline is archived but tree below has
1930 ;; to be skipped, add it to ignore list.
1933 ;; Move into secondary string, if any.
1938 ;; Move into recursive objects/elements.
1940 ;; Main call.
1942 ;; Return value.
1943 ignore))
1946 "Return list of headlines and inlinetasks with a select tag in their tree.
1947 DATA is parsed data as returned by `org-element-parse-buffer'.
1948 INFO is a plist holding export options."
1950 walk-data ; For byte-compiler.
1960 ;; When a select tag is found, mark full
1961 ;; genealogy and every headline within the tree
1962 ;; as acceptable.
1965 genealogy
1968 selected-trees))
1969 ;; If at a headline, continue searching in tree,
1970 ;; recursively.
1980 selected-trees))
1983 "Non-nil when element or object BLOB should be skipped during export.
1984 OPTIONS is the plist holding export options. SELECTED, when
1985 non-nil, is a list of headlines or inlinetasks belonging to
1986 a tree with a select tag."
1993 ;; If `:with-drawers' value starts with `not', ignore
1994 ;; every drawer whose name belong to that list.
1995 ;; Otherwise, ignore drawers whose name isn't in that
1996 ;; list.
2012 ;; Ignore subtrees with an exclude tag.
2015 ;; When a select tag is present in the buffer, ignore any tree
2016 ;; without it.
2018 ;; Ignore commented sub-trees.
2020 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2022 ;; Ignore tasks, if specified by `:with-tasks' property.
2037 ;; `:with-timestamps' only applies to isolated timestamps
2038 ;; objects, i.e. timestamp objects in a paragraph containing only
2039 ;; timestamps and whitespaces.
2047 options t))))
2056 \f
2057 ;;; The Transcoder
2058 ;;
2059 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2060 ;; `org-element-parse-buffer') and transcodes it into a specified
2061 ;; back-end output. It takes care of filtering out elements or
2062 ;; objects according to export options and organizing the output blank
2063 ;; lines and white space are preserved. The function memoizes its
2064 ;; results, so it is cheap to call it within translators.
2065 ;;
2066 ;; It is possible to modify locally the back-end used by
2067 ;; `org-export-data' or even use a temporary back-end by using
2068 ;; `org-export-data-with-translations' and
2069 ;; `org-export-data-with-backend'.
2070 ;;
2071 ;; Internally, three functions handle the filtering of objects and
2072 ;; elements during the export. In particular,
2073 ;; `org-export-ignore-element' marks an element or object so future
2074 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2075 ;; elements or objects should be seen as real Org syntax and
2076 ;; `org-export-expand' transforms the others back into their original
2077 ;; shape
2078 ;;
2079 ;; `org-export-transcoder' is an accessor returning appropriate
2080 ;; translator function for a given element or object.
2083 "Return appropriate transcoder for BLOB.
2084 INFO is a plist containing export directives."
2086 ;; Return contents only for complete parse trees.
2092 "Convert DATA into current back-end format.
2094 DATA is a parse tree, an element or an object or a secondary
2095 string. INFO is a plist holding export options.
2097 Return transcoded string."
2103 ;; Ignored element/object.
2105 ;; Plain text.
2111 info))
2112 ;; Uninterpreted element/object: change it back to Org
2113 ;; syntax and export again resulting raw string.
2117 data
2121 info))
2122 ;; Secondary string.
2125 ;; Element/Object without contents or, as a special case,
2126 ;; headline with archive tag and archived trees restricted
2127 ;; to title only.
2135 ;; Export snippets never return a nil value so
2136 ;; that white spaces following them are never
2137 ;; ignored.
2139 ;; Element/Object with contents.
2152 ;; Elements directly containing objects
2153 ;; must have their indentation normalized
2154 ;; first.
2156 data
2157 ;; When normalizing contents of the first
2158 ;; paragraph in an item or a footnote
2159 ;; definition, ignore first line's
2160 ;; indentation: there is none and it
2161 ;; might be misleading.
2166 data)
2173 info))))))))
2174 ;; Final result will be memoized before being returned.
2176 data
2180 ;; Append the same white space between elements or objects as in
2181 ;; the original buffer, and call appropriate filters.
2192 info)))
2193 results)))
2197 "Convert DATA into another format using a given translation table.
2198 DATA is an element, an object, a secondary string or a string.
2199 TRANSLATIONS is an alist between element or object types and
2200 a functions handling them. See `org-export-define-backend' for
2201 more information. INFO is a plist used as a communication
2202 channel."
2204 data
2205 ;; Set-up a new communication channel with TRANSLATIONS as the
2206 ;; translate table and a new hash table for memoization.
2208 info
2210 ;; Size of the hash table is reduced since this function
2211 ;; will probably be used on short trees.
2215 "Convert DATA into BACKEND format.
2217 DATA is an element, an object, a secondary string or a string.
2218 BACKEND is a symbol. INFO is a plist used as a communication
2219 channel.
2221 Unlike to `org-export-with-backend', this function will
2222 recursively convert DATA using BACKEND translation table."
2228 "Non-nil if element or object BLOB should be interpreted during export.
2229 If nil, BLOB will appear as raw Org syntax. Check is done
2230 according to export options INFO, stored as a plist."
2232 ;; ... entities...
2234 ;; ... emphasis...
2237 ;; ... fixed-width areas.
2239 ;; ... LaTeX environments and fragments...
2243 ;; ... sub/superscripts...
2249 ;; ... tables...
2254 "Expand a parsed element or object to its original state.
2256 BLOB is either an element or an object. CONTENTS is its
2257 contents, as a string or nil.
2259 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2260 keywords before output."
2265 blob contents))))
2268 "Add ELEMENT to `:ignore-list' in INFO.
2270 Any element in `:ignore-list' will be skipped when using
2271 `org-element-map'. INFO is modified by side effects."
2275 \f
2276 ;;; The Filter System
2277 ;;
2278 ;; Filters allow end-users to tweak easily the transcoded output.
2279 ;; They are the functional counterpart of hooks, as every filter in
2280 ;; a set is applied to the return value of the previous one.
2281 ;;
2282 ;; Every set is back-end agnostic. Although, a filter is always
2283 ;; called, in addition to the string it applies to, with the back-end
2284 ;; used as argument, so it's easy for the end-user to add back-end
2285 ;; specific filters in the set. The communication channel, as
2286 ;; a plist, is required as the third argument.
2287 ;;
2288 ;; From the developer side, filters sets can be installed in the
2289 ;; process with the help of `org-export-define-backend', which
2290 ;; internally stores filters as an alist. Each association has a key
2291 ;; among the following symbols and a function or a list of functions
2292 ;; as value.
2293 ;;
2294 ;; - `:filter-options' applies to the property list containing export
2295 ;; options. Unlike to other filters, functions in this list accept
2296 ;; two arguments instead of three: the property list containing
2297 ;; export options and the back-end. Users can set its value through
2298 ;; `org-export-filter-options-functions' variable.
2299 ;;
2300 ;; - `:filter-parse-tree' applies directly to the complete parsed
2301 ;; tree. Users can set it through
2302 ;; `org-export-filter-parse-tree-functions' variable.
2303 ;;
2304 ;; - `:filter-final-output' applies to the final transcoded string.
2305 ;; Users can set it with `org-export-filter-final-output-functions'
2306 ;; variable
2307 ;;
2308 ;; - `:filter-plain-text' applies to any string not recognized as Org
2309 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2310 ;; configure it.
2311 ;;
2312 ;; - `:filter-TYPE' applies on the string returned after an element or
2313 ;; object of type TYPE has been transcoded. A user can modify
2314 ;; `org-export-filter-TYPE-functions'
2315 ;;
2316 ;; All filters sets are applied with
2317 ;; `org-export-filter-apply-functions' function. Filters in a set are
2318 ;; applied in a LIFO fashion. It allows developers to be sure that
2319 ;; their filters will be applied first.
2320 ;;
2321 ;; Filters properties are installed in communication channel with
2322 ;; `org-export-install-filters' function.
2323 ;;
2324 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2325 ;; `org-export-before-parsing-hook') are run at the beginning of the
2326 ;; export process and just before parsing to allow for heavy structure
2327 ;; modifications.
2330 ;;;; Hooks
2333 "Hook run at the beginning of the export process.
2335 This is run before include keywords and macros are expanded and
2336 Babel code blocks executed, on a copy of the original buffer
2337 being exported. Visibility and narrowing are preserved. Point
2338 is at the beginning of the buffer.
2340 Every function in this hook will be called with one argument: the
2344 "Hook run before parsing an export buffer.
2346 This is run after include keywords and macros have been expanded
2347 and Babel code blocks executed, on a copy of the original buffer
2348 being exported. Visibility and narrowing are preserved. Point
2349 is at the beginning of the buffer.
2351 Every function in this hook will be called with one argument: the
2355 ;;;; Special Filters
2358 "List of functions applied to the export options.
2359 Each filter is called with two arguments: the export options, as
2360 a plist, and the back-end, as a symbol. It must return
2364 "List of functions applied to the parsed tree.
2365 Each filter is called with three arguments: the parse tree, as
2366 returned by `org-element-parse-buffer', the back-end, as
2367 a symbol, and the communication channel, as a plist. It must
2371 "List of functions applied to plain text.
2372 Each filter is called with three arguments: a string which
2373 contains no Org syntax, the back-end, as a symbol, and the
2374 communication channel, as a plist. It must return a string or
2378 "List of functions applied to the transcoded string.
2379 Each filter is called with three arguments: the full transcoded
2380 string, the back-end, as a symbol, and the communication channel,
2381 as a plist. It must return a string that will be used as the
2385 ;;;; Elements Filters
2388 "List of functions applied to a transcoded babel-call.
2389 Each filter is called with three arguments: the transcoded data,
2390 as a string, the back-end, as a symbol, and the communication
2394 "List of functions applied to a transcoded center block.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2400 "List of functions applied to a transcoded clock.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2406 "List of functions applied to a transcoded comment.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2412 "List of functions applied to a transcoded comment-block.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2418 "List of functions applied to a transcoded diary-sexp.
2419 Each filter is called with three arguments: the transcoded data,
2420 as a string, the back-end, as a symbol, and the communication
2424 "List of functions applied to a transcoded drawer.
2425 Each filter is called with three arguments: the transcoded data,
2426 as a string, the back-end, as a symbol, and the communication
2430 "List of functions applied to a transcoded dynamic-block.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2436 "List of functions applied to a transcoded example-block.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2442 "List of functions applied to a transcoded export-block.
2443 Each filter is called with three arguments: the transcoded data,
2444 as a string, the back-end, as a symbol, and the communication
2448 "List of functions applied to a transcoded fixed-width.
2449 Each filter is called with three arguments: the transcoded data,
2450 as a string, the back-end, as a symbol, and the communication
2454 "List of functions applied to a transcoded footnote-definition.
2455 Each filter is called with three arguments: the transcoded data,
2456 as a string, the back-end, as a symbol, and the communication
2460 "List of functions applied to a transcoded headline.
2461 Each filter is called with three arguments: the transcoded data,
2462 as a string, the back-end, as a symbol, and the communication
2466 "List of functions applied to a transcoded horizontal-rule.
2467 Each filter is called with three arguments: the transcoded data,
2468 as a string, the back-end, as a symbol, and the communication
2472 "List of functions applied to a transcoded inlinetask.
2473 Each filter is called with three arguments: the transcoded data,
2474 as a string, the back-end, as a symbol, and the communication
2478 "List of functions applied to a transcoded item.
2479 Each filter is called with three arguments: the transcoded data,
2480 as a string, the back-end, as a symbol, and the communication
2484 "List of functions applied to a transcoded keyword.
2485 Each filter is called with three arguments: the transcoded data,
2486 as a string, the back-end, as a symbol, and the communication
2490 "List of functions applied to a transcoded latex-environment.
2491 Each filter is called with three arguments: the transcoded data,
2492 as a string, the back-end, as a symbol, and the communication
2496 "List of functions applied to a transcoded node-property.
2497 Each filter is called with three arguments: the transcoded data,
2498 as a string, the back-end, as a symbol, and the communication
2502 "List of functions applied to a transcoded paragraph.
2503 Each filter is called with three arguments: the transcoded data,
2504 as a string, the back-end, as a symbol, and the communication
2508 "List of functions applied to a transcoded plain-list.
2509 Each filter is called with three arguments: the transcoded data,
2510 as a string, the back-end, as a symbol, and the communication
2514 "List of functions applied to a transcoded planning.
2515 Each filter is called with three arguments: the transcoded data,
2516 as a string, the back-end, as a symbol, and the communication
2520 "List of functions applied to a transcoded property-drawer.
2521 Each filter is called with three arguments: the transcoded data,
2522 as a string, the back-end, as a symbol, and the communication
2526 "List of functions applied to a transcoded quote block.
2527 Each filter is called with three arguments: the transcoded quote
2528 data, as a string, the back-end, as a symbol, and the
2529 communication channel, as a plist. It must return a string or
2533 "List of functions applied to a transcoded quote-section.
2534 Each filter is called with three arguments: the transcoded data,
2535 as a string, the back-end, as a symbol, and the communication
2539 "List of functions applied to a transcoded section.
2540 Each filter is called with three arguments: the transcoded data,
2541 as a string, the back-end, as a symbol, and the communication
2545 "List of functions applied to a transcoded special block.
2546 Each filter is called with three arguments: the transcoded data,
2547 as a string, the back-end, as a symbol, and the communication
2551 "List of functions applied to a transcoded src-block.
2552 Each filter is called with three arguments: the transcoded data,
2553 as a string, the back-end, as a symbol, and the communication
2557 "List of functions applied to a transcoded table.
2558 Each filter is called with three arguments: the transcoded data,
2559 as a string, the back-end, as a symbol, and the communication
2563 "List of functions applied to a transcoded table-cell.
2564 Each filter is called with three arguments: the transcoded data,
2565 as a string, the back-end, as a symbol, and the communication
2569 "List of functions applied to a transcoded table-row.
2570 Each filter is called with three arguments: the transcoded data,
2571 as a string, the back-end, as a symbol, and the communication
2575 "List of functions applied to a transcoded verse block.
2576 Each filter is called with three arguments: the transcoded data,
2577 as a string, the back-end, as a symbol, and the communication
2581 ;;;; Objects Filters
2584 "List of functions applied to transcoded bold text.
2585 Each filter is called with three arguments: the transcoded data,
2586 as a string, the back-end, as a symbol, and the communication
2590 "List of functions applied to transcoded code text.
2591 Each filter is called with three arguments: the transcoded data,
2592 as a string, the back-end, as a symbol, and the communication
2596 "List of functions applied to a transcoded entity.
2597 Each filter is called with three arguments: the transcoded data,
2598 as a string, the back-end, as a symbol, and the communication
2602 "List of functions applied to a transcoded export-snippet.
2603 Each filter is called with three arguments: the transcoded data,
2604 as a string, the back-end, as a symbol, and the communication
2608 "List of functions applied to a transcoded footnote-reference.
2609 Each filter is called with three arguments: the transcoded data,
2610 as a string, the back-end, as a symbol, and the communication
2614 "List of functions applied to a transcoded inline-babel-call.
2615 Each filter is called with three arguments: the transcoded data,
2616 as a string, the back-end, as a symbol, and the communication
2620 "List of functions applied to a transcoded inline-src-block.
2621 Each filter is called with three arguments: the transcoded data,
2622 as a string, the back-end, as a symbol, and the communication
2626 "List of functions applied to transcoded italic text.
2627 Each filter is called with three arguments: the transcoded data,
2628 as a string, the back-end, as a symbol, and the communication
2632 "List of functions applied to a transcoded latex-fragment.
2633 Each filter is called with three arguments: the transcoded data,
2634 as a string, the back-end, as a symbol, and the communication
2638 "List of functions applied to a transcoded line-break.
2639 Each filter is called with three arguments: the transcoded data,
2640 as a string, the back-end, as a symbol, and the communication
2644 "List of functions applied to a transcoded link.
2645 Each filter is called with three arguments: the transcoded data,
2646 as a string, the back-end, as a symbol, and the communication
2650 "List of functions applied to a transcoded radio-target.
2651 Each filter is called with three arguments: the transcoded data,
2652 as a string, the back-end, as a symbol, and the communication
2656 "List of functions applied to a transcoded statistics-cookie.
2657 Each filter is called with three arguments: the transcoded data,
2658 as a string, the back-end, as a symbol, and the communication
2662 "List of functions applied to transcoded strike-through text.
2663 Each filter is called with three arguments: the transcoded data,
2664 as a string, the back-end, as a symbol, and the communication
2668 "List of functions applied to a transcoded subscript.
2669 Each filter is called with three arguments: the transcoded data,
2670 as a string, the back-end, as a symbol, and the communication
2674 "List of functions applied to a transcoded superscript.
2675 Each filter is called with three arguments: the transcoded data,
2676 as a string, the back-end, as a symbol, and the communication
2680 "List of functions applied to a transcoded target.
2681 Each filter is called with three arguments: the transcoded data,
2682 as a string, the back-end, as a symbol, and the communication
2686 "List of functions applied to a transcoded timestamp.
2687 Each filter is called with three arguments: the transcoded data,
2688 as a string, the back-end, as a symbol, and the communication
2692 "List of functions applied to transcoded underline text.
2693 Each filter is called with three arguments: the transcoded data,
2694 as a string, the back-end, as a symbol, and the communication
2698 "List of functions applied to transcoded verbatim text.
2699 Each filter is called with three arguments: the transcoded data,
2700 as a string, the back-end, as a symbol, and the communication
2704 ;;;; Filters Tools
2705 ;;
2706 ;; Internal function `org-export-install-filters' installs filters
2707 ;; hard-coded in back-ends (developer filters) and filters from global
2708 ;; variables (user filters) in the communication channel.
2709 ;;
2710 ;; Internal function `org-export-filter-apply-functions' takes care
2711 ;; about applying each filter in order to a given data. It ignores
2712 ;; filters returning a nil value but stops whenever a filter returns
2713 ;; an empty string.
2716 "Call every function in FILTERS.
2718 Functions are called with arguments VALUE, current export
2719 back-end and INFO. A function returning a nil value will be
2720 skipped. If it returns the empty string, the process ends and
2721 VALUE is ignored.
2723 Call is done in a LIFO fashion, to be sure that developer
2724 specified filters, if any, are called first."
2733 "Install filters properties in communication channel.
2734 INFO is a plist containing the current communication channel.
2735 Return the updated communication channel."
2737 ;; Install user-defined filters with `org-export-filters-alist'
2738 ;; and filters already in INFO (through ext-plist mechanism).
2745 ;; Filters in INFO will be called
2746 ;; before those user provided.
2749 default-value)))))
2750 org-export-filters-alist)
2751 ;; Prepend back-end specific filters to that list.
2753 ;; Single values get consed, lists are appended.
2758 plist key
2762 ;; Return new communication channel.
2766 \f
2767 ;;; Core functions
2768 ;;
2769 ;; This is the room for the main function, `org-export-as', along with
2770 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2771 ;; `org-export-string-as'. They differ either by the way they output
2772 ;; the resulting code (for the first two) or by the input type (for
2773 ;; the latter). `org-export--copy-to-kill-ring-p' determines if
2774 ;; output of these function should be added to kill ring.
2775 ;;
2776 ;; `org-export-output-file-name' is an auxiliary function meant to be
2777 ;; used with `org-export-to-file'. With a given extension, it tries
2778 ;; to provide a canonical file name to write export output to.
2779 ;;
2780 ;; Note that `org-export-as' doesn't really parse the current buffer,
2781 ;; but a copy of it (with the same buffer-local variables and
2782 ;; visibility), where macros and include keywords are expanded and
2783 ;; Babel blocks are executed, if appropriate.
2784 ;; `org-export-with-buffer-copy' macro prepares that copy.
2785 ;;
2786 ;; File inclusion is taken care of by
2787 ;; `org-export-expand-include-keyword' and
2788 ;; `org-export--prepare-file-contents'. Structure wise, including
2789 ;; a whole Org file in a buffer often makes little sense. For
2790 ;; example, if the file contains a headline and the include keyword
2791 ;; was within an item, the item should contain the headline. That's
2792 ;; why file inclusion should be done before any structure can be
2793 ;; associated to the file, that is before parsing.
2794 ;;
2795 ;; `org-export-insert-default-template' is a command to insert
2796 ;; a default template (or a back-end specific template) at point or in
2797 ;; current subtree.
2800 "Return a copy of the current buffer.
2801 The copy preserves Org buffer-local variables, visibility and
2802 narrowing."
2808 new-buf))
2811 "Apply BODY in a copy of the current buffer.
2812 The copy preserves local variables, visibility and contents of
2813 the original buffer. Point is at the beginning of the buffer
2814 when BODY is applied."
2823 ;; Kill copy without confirmation.
2829 "Generate a function duplicating BUFFER.
2831 The copy will preserve local variables, visibility, contents and
2832 narrowing of the original buffer. If a region was active in
2833 BUFFER, contents will be narrowed to that region instead.
2835 The resulting function can be evaled at a later time, from
2836 another buffer, effectively cloning the original buffer there.
2838 The function assumes BUFFER's major mode is `org-mode'."
2842 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2843 ;; already in BUFFER.
2845 ;; Copy specific buffer local variables and variables set
2846 ;; through BIND keywords.
2848 vars)
2856 buffer-file-name
2857 buffer-file-coding-system))
2861 ;; Skip unreadable values, as they cannot be
2862 ;; sent to external process.
2866 vars))))))
2867 ;; Whole buffer contents.
2872 ;; Narrowing.
2876 ;; Current position of point.
2878 ;; Overlays with invisible property.
2888 ov-set))))
2890 ov-set)))))
2892 ;;;###autoload
2895 "Transcode current Org buffer into BACKEND code.
2897 If narrowing is active in the current buffer, only transcode its
2898 narrowed part.
2900 If a region is active, transcode that region.
2902 When optional argument SUBTREEP is non-nil, transcode the
2903 sub-tree at point, extracting information from the headline
2904 properties first.
2906 When optional argument VISIBLE-ONLY is non-nil, don't export
2907 contents of hidden elements.
2909 When optional argument BODY-ONLY is non-nil, only return body
2910 code, without surrounding template.
2912 Optional argument EXT-PLIST, when provided, is a property list
2913 with external parameters overriding Org default settings, but
2914 still inferior to file-local settings.
2916 Return code as a string."
2920 ;; Narrow buffer to an appropriate region or subtree for
2921 ;; parsing. If parsing subtree, be sure to remove main headline
2922 ;; too.
2930 ;; Initialize communication channel with original buffer
2931 ;; attributes, unavailable in its copy.
2939 tree)
2940 ;; Update communication channel and get parse tree. Buffer
2941 ;; isn't parsed directly. Instead, a temporary copy is
2942 ;; created, where include keywords, macros are expanded and
2943 ;; code blocks are evaluated.
2945 ;; Run first hook with current back-end as argument.
2948 ;; Update macro templates since #+INCLUDE keywords might have
2949 ;; added some new ones.
2953 ;; Update radio targets since keyword inclusion might have
2954 ;; added some more.
2956 ;; Run last hook with current back-end as argument.
2960 ;; Update communication channel with environment. Also
2961 ;; install user's and developer's filters.
2966 ;; Expand export-specific set of macros: {{{author}}},
2967 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2968 ;; once regular macros have been expanded, since document
2969 ;; keywords may contain one of them.
2975 ;; EMAIL is not a parsed keyword: store it as-is.
2979 ;; Call options filters and update export options. We do not
2980 ;; use `org-export-filter-apply-functions' here since the
2981 ;; arity of such filters is different.
2985 ;; Parse buffer and call parse-tree filter on it.
2990 ;; Now tree is complete, compute its properties and add them
2991 ;; to communication channel.
2995 ;; Eventually transcode TREE. Wrap the resulting string into
2996 ;; a template.
3005 ;; Remove all text properties since they cannot be
3006 ;; retrieved from an external process. Finally call
3007 ;; final-output filter and return result.
3013 info))))))))
3015 ;;;###autoload
3018 "Call `org-export-as' with output to a specified buffer.
3020 BACKEND is the back-end used for transcoding, as a symbol.
3022 BUFFER is the output buffer. If it already exists, it will be
3023 erased first, otherwise, it will be created.
3025 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3026 EXT-PLIST are similar to those used in `org-export-as', which
3027 see.
3029 Depending on `org-export-copy-to-kill-ring', add buffer contents
3030 to kill ring. Return buffer."
3037 ;; Maybe add buffer contents to kill ring.
3040 ;; Return buffer.
3041 buffer))
3043 ;;;###autoload
3046 "Call `org-export-as' with output to a specified file.
3048 BACKEND is the back-end used for transcoding, as a symbol. FILE
3049 is the name of the output file, as a string.
3051 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3052 EXT-PLIST are similar to those used in `org-export-as', which
3053 see.
3055 Depending on `org-export-copy-to-kill-ring', add file contents
3056 to kill ring. Return output file's name."
3057 ;; Checks for FILE permissions. `write-file' would do the same, but
3058 ;; we'd rather avoid needless transcoding of parse tree.
3060 ;; Insert contents to a temporary buffer and write it to FILE.
3066 ;; Maybe add file contents to kill ring.
3069 ;; Return full path.
3070 file)
3072 ;;;###autoload
3074 "Transcode STRING into BACKEND code.
3076 When optional argument BODY-ONLY is non-nil, only return body
3077 code, without preamble nor postamble.
3079 Optional argument EXT-PLIST, when provided, is a property list
3080 with external parameters overriding Org default settings, but
3081 still inferior to file-local settings.
3083 Return code as a string."
3089 ;;;###autoload
3091 "Replace the active region by its export to BACKEND."
3101 ;;;###autoload
3103 "Insert all export keywords with default values at beginning of line.
3105 BACKEND is a symbol representing the export back-end for which
3106 specific export options should be added to the template, or
3107 `default' for default template. When it is nil, the user will be
3108 prompted for a category.
3110 If SUBTREEP is non-nil, export configuration will be set up
3111 locally for the subtree through node properties."
3120 "Options category: "
3123 org-export-registered-backends))))))
3124 options keywords)
3125 ;; Populate OPTIONS and KEYWORDS.
3139 ;; Move to an appropriate location in order to insert options.
3141 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3142 ;; list of available keywords.
3170 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3189 ;; And the rest of keywords.
3200 "Return output file's name according to buffer specifications.
3202 EXTENSION is a string representing the output file extension,
3203 with the leading dot.
3205 With a non-nil optional argument SUBTREEP, try to determine
3207 of subtree at point.
3209 When optional argument PUB-DIR is set, use it as the publishing
3210 directory.
3212 When optional argument VISIBLE-ONLY is non-nil, don't export
3213 contents of hidden elements.
3215 Return file name as a string."
3218 ;; File name may come from EXPORT_FILE_NAME subtree
3219 ;; property, assuming point is at beginning of said
3220 ;; sub-tree.
3227 ;; File name may be extracted from buffer's associated
3228 ;; file, if any.
3230 ;; Can't determine file name on our own: Ask user.
3234 "Output file: " pub-dir nil nil nil
3238 ;; Build file name. Enforce EXTENSION over whatever user
3239 ;; may have come up with. PUB-DIR, if defined, always has
3240 ;; precedence over any provided path.
3245 extension))
3248 ;; If writing to OUTPUT-FILE would overwrite original file, append
3249 ;; EXTENSION another time to final name.
3252 output-file)))
3255 "Expand every include keyword in buffer.
3256 Optional argument INCLUDED is a list of included file names along
3257 with their line restriction, when appropriate. It is used to
3258 avoid infinite recursion. Optional argument DIR is the current
3259 working directory. It is used to properly resolve relative
3260 paths."
3267 ;; Extract arguments from keyword's value.
3275 dir)
3280 value)
3286 ;; Minimal level of included file defaults to the child
3287 ;; level of the current headline, if any, or one. It
3288 ;; only applies is the file is meant to be included as
3289 ;; an Org one.
3297 ;; Remove keyword.
3303 ;; Check if files has already been parsed. Look after
3304 ;; inclusion lines too, as different parts of the same file
3305 ;; can be included too.
3317 ind-str contents ind-str))))
3325 ind-str env contents ind-str))))
3338 "Prepare the contents of FILE for inclusion and return them as a string.
3340 When optional argument LINES is a string specifying a range of
3341 lines, include only those lines.
3343 Optional argument IND, when non-nil, is an integer specifying the
3344 global indentation of returned contents. Since its purpose is to
3345 allow an included file to stay in the same environment it was
3346 created \(i.e. a list item), it doesn't apply past the first
3347 headline encountered.
3349 Optional argument MINLEVEL, when non-nil, is an integer
3350 specifying the level that any top-level headline in the included
3351 file should have."
3367 ;; Remove blank lines at beginning and end of contents. The logic
3368 ;; behind that removal is that blank lines around include keyword
3369 ;; override blank lines in included file.
3378 ;; If IND is set, preserve indentation of include keyword until
3379 ;; the first headline encountered.
3386 ;; Do not move footnote definitions out of column 0.
3392 ;; When MINLEVEL is specified, compute minimal level for headlines
3393 ;; in the file (CUR-MIN), and remove stars to each headline so
3394 ;; that headlines with minimal level have a level of MINLEVEL.
3405 ;; Only change stars, don't bother moving whole
3406 ;; sections.
3413 "Execute every Babel code in the visible part of current buffer."
3414 ;; Get a pristine copy of current buffer so Babel references can be
3415 ;; properly resolved.
3422 "Return a non-nil value when output should be added to the kill ring.
3423 See also `org-export-copy-to-kill-ring'."
3429 \f
3430 ;;; Tools For Back-Ends
3431 ;;
3432 ;; A whole set of tools is available to help build new exporters. Any
3433 ;; function general enough to have its use across many back-ends
3434 ;; should be added here.
3436 ;;;; For Affiliated Keywords
3437 ;;
3438 ;; `org-export-read-attribute' reads a property from a given element
3439 ;; as a plist. It can be used to normalize affiliated keywords'
3440 ;; syntax.
3441 ;;
3442 ;; Since captions can span over multiple lines and accept dual values,
3443 ;; their internal representation is a bit tricky. Therefore,
3444 ;; `org-export-get-caption' transparently returns a given element's
3445 ;; caption as a secondary string.
3448 "Turn ATTRIBUTE property from ELEMENT into a plist.
3450 When optional argument PROPERTY is non-nil, return the value of
3451 that property within attributes.
3455 properties.
3457 All values will become strings except the empty string and
3460 will become the empty string."
3473 s)
3478 ;; Ignore any string before first property with `cdr'.
3483 "Return caption from ELEMENT as a secondary string.
3485 When optional argument SHORTP is non-nil, return short caption,
3486 as a secondary string, instead.
3488 Caption lines are separated by a white space."
3496 ;;;; For Derived Back-ends
3497 ;;
3498 ;; `org-export-with-backend' is a function allowing to locally use
3499 ;; another back-end to transcode some object or element. In a derived
3500 ;; back-end, it may be used as a fall-back function once all specific
3501 ;; cases have been treated.
3504 "Call a transcoder from BACK-END on DATA.
3505 CONTENTS, when non-nil, is the transcoded contents of DATA
3506 element, as a string. INFO, when non-nil, is the communication
3507 channel used for export, as a plist.."
3517 ;;;; For Export Snippets
3518 ;;
3519 ;; Every export snippet is transmitted to the back-end. Though, the
3520 ;; latter will only retain one type of export-snippet, ignoring
3521 ;; others, based on the former's target back-end. The function
3522 ;; `org-export-snippet-backend' returns that back-end for a given
3523 ;; export-snippet.
3526 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3527 Translation, with `org-export-snippet-translation-alist', is
3528 applied."
3532 back-end))))
3535 ;;;; For Footnotes
3536 ;;
3537 ;; `org-export-collect-footnote-definitions' is a tool to list
3538 ;; actually used footnotes definitions in the whole parse tree, or in
3539 ;; a headline, in order to add footnote listings throughout the
3540 ;; transcoded data.
3541 ;;
3542 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3543 ;; back-ends, when they need to attach the footnote definition only to
3544 ;; the first occurrence of the corresponding label.
3545 ;;
3546 ;; `org-export-get-footnote-definition' and
3547 ;; `org-export-get-footnote-number' provide easier access to
3548 ;; additional information relative to a footnote reference.
3551 "Return an alist between footnote numbers, labels and definitions.
3553 DATA is the parse tree from which definitions are collected.
3554 INFO is the plist used as a communication channel.
3556 Definitions are sorted by order of references. They either
3557 appear as Org data or as a secondary string for inlined
3558 footnotes. Unreferenced definitions are ignored."
3560 collect-fn ; for byte-compiler.
3564 ;; Collect footnote number, label and definition in DATA.
3572 def)
3573 num-alist)
3574 ;; Also search in definition for nested footnotes.
3577 ;; Don't enter footnote definitions since it will happen
3578 ;; when their first reference is found.
3584 "Non-nil when a footnote reference is the first one for its label.
3586 FOOTNOTE-REFERENCE is the footnote reference being considered.
3587 INFO is the plist used as a communication channel."
3589 ;; Anonymous footnotes are always a first reference.
3591 ;; Otherwise, return the first footnote with the same LABEL and
3592 ;; test if it is equal to FOOTNOTE-REFERENCE.
3602 ;; If FN isn't inlined, be sure to traverse its
3603 ;; definition before resuming search. See
3604 ;; comments in `org-export-get-footnote-number'
3605 ;; for more information.
3609 ;; Don't enter footnote definitions since it will
3610 ;; happen when their first reference is found.
3613 footnote-reference)))))
3616 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3617 INFO is the plist used as a communication channel. If no such
3619 string."
3626 "Return number associated to a footnote.
3628 FOOTNOTE is either a footnote reference or a footnote definition.
3629 INFO is the plist used as a communication channel."
3631 seen-refs
3632 search-ref ; For byte-compiler.
3636 ;; Search footnote references through DATA, filling
3637 ;; SEEN-REFS along the way.
3642 ;; Anonymous footnote match: return number.
3645 ;; Labels match: return number.
3648 ;; Anonymous footnote: it's always a new one.
3649 ;; Also, be sure to return nil from the `cond' so
3650 ;; `first-match' doesn't get us out of the loop.
3652 ;; Label not seen so far: add it so SEEN-REFS.
3653 ;;
3654 ;; Also search for subsequent references in
3655 ;; footnote definition so numbering follows
3656 ;; reading logic. Note that we don't have to care
3657 ;; about inline definitions, since
3658 ;; `org-element-map' already traverses them at the
3659 ;; right time.
3660 ;;
3661 ;; Once again, return nil to stay in the loop.
3666 nil))))
3667 ;; Don't enter footnote definitions since it will
3668 ;; happen when their first reference is found.
3673 ;;;; For Headlines
3674 ;;
3675 ;; `org-export-get-relative-level' is a shortcut to get headline
3676 ;; level, relatively to the lower headline level in the parsed tree.
3677 ;;
3678 ;; `org-export-get-headline-number' returns the section number of an
3679 ;; headline, while `org-export-number-to-roman' allows to convert it
3680 ;; to roman numbers.
3681 ;;
3682 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3683 ;; `org-export-last-sibling-p' are three useful predicates when it
3684 ;; comes to fulfill the `:headline-levels' property.
3685 ;;
3686 ;; `org-export-get-tags', `org-export-get-category' and
3687 ;; `org-export-get-node-property' extract useful information from an
3688 ;; headline or a parent headline. They all handle inheritance.
3689 ;;
3690 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3691 ;; as a secondary string, suitable for table of contents. It falls
3692 ;; back onto default title.
3695 "Return HEADLINE relative level within current parsed tree.
3696 INFO is a plist holding contextual information."
3701 "Non-nil when HEADLINE is considered as low level.
3703 INFO is a plist used as a communication channel.
3705 A low level headlines has a relative level greater than
3706 `:headline-levels' property value.
3708 Return value is the difference between HEADLINE relative level
3709 and the last level being considered as high enough, or nil."
3716 "Return HEADLINE numbering as a list of numbers.
3717 INFO is a plist holding contextual information."
3721 "Return a non-nil value if HEADLINE element should be numbered.
3722 INFO is a plist used as a communication channel."
3728 "Convert integer N into a roman numeral."
3741 res)))
3744 "Return list of tags associated to ELEMENT.
3746 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3747 is a plist used as a communication channel.
3749 Select tags (see `org-export-select-tags') and exclude tags (see
3750 `org-export-exclude-tags') are removed from the list.
3752 When non-nil, optional argument TAGS should be a list of strings.
3753 Any tag belonging to this list will also be removed.
3755 When optional argument INHERITED is non-nil, tags can also be
3756 inherited from parent headlines and FILETAGS keywords."
3762 ;; Build complete list of inherited tags.
3773 ;; Add FILETAGS keywords and return results.
3777 "Return node PROPERTY value for BLOB.
3779 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3780 element or object.
3782 If optional argument INHERITED is non-nil, the value can be
3783 inherited from a parent headline.
3785 Return value is a string or nil."
3797 "Return category for element or object BLOB.
3799 INFO is a plist used as a communication channel.
3801 CATEGORY is automatically inherited from a parent headline, from
3802 #+CATEGORY: keyword or created out of original file name. If all
3806 ;; Almost like `org-export-node-property', but we cannot trust
3807 ;; `plist-member' as every headline has a `:CATEGORY'
3808 ;; property, would it be nil or equal to "???" (which has the
3809 ;; same meaning).
3827 "Return alternative title for HEADLINE, as a secondary string.
3828 INFO is a plist used as a communication channel. If no optional
3829 title is defined, fall-back to the regular title."
3834 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3835 INFO is a plist used as a communication channel."
3840 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3841 INFO is a plist used as a communication channel."
3845 ;;;; For Keywords
3846 ;;
3847 ;; `org-export-get-date' returns a date appropriate for the document
3848 ;; to about to be exported. In particular, it takes care of
3849 ;; `org-export-date-timestamp-format'.
3852 "Return date value for the current document.
3854 INFO is a plist used as a communication channel. FMT, when
3855 non-nil, is a time format string that will be applied on the date
3856 if it consists in a single timestamp object. It defaults to
3857 `org-export-date-timestamp-format' when nil.
3859 A proper date can be a secondary string, a string or nil. It is
3860 meant to be translated with `org-export-data' or alike."
3871 ;;;; For Links
3872 ;;
3873 ;; `org-export-solidify-link-text' turns a string into a safer version
3874 ;; for links, replacing most non-standard characters with hyphens.
3875 ;;
3876 ;; `org-export-get-coderef-format' returns an appropriate format
3877 ;; string for coderefs.
3878 ;;
3879 ;; `org-export-inline-image-p' returns a non-nil value when the link
3880 ;; provided should be considered as an inline image.
3881 ;;
3882 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3883 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3884 ;; returns an appropriate unique identifier when found, or nil.
3885 ;;
3886 ;; `org-export-resolve-id-link' returns the first headline with
3887 ;; specified id or custom-id in parse tree, the path to the external
3888 ;; file with the id or nil when neither was found.
3889 ;;
3890 ;; `org-export-resolve-coderef' associates a reference to a line
3891 ;; number in the element it belongs, or returns the reference itself
3892 ;; when the element isn't numbered.
3895 "Take link text S and make a safe target out of it."
3900 "Return format string for code reference link.
3901 PATH is the link path. DESC is its description."
3909 "Non-nil if LINK object points to an inline image.
3911 Optional argument is a set of RULES defining inline images. It
3912 is an alist where associations have the following shape:
3914 \(TYPE . REGEXP)
3916 Applying a rule means apply REGEXP against LINK's path when its
3917 type is TYPE. The function will return a non-nil value if any of
3918 the provided rules is non-nil. The default rule is
3919 `org-export-default-inline-image-rule'.
3921 This only applies to links without a description."
3932 rules)
3933 ;; Return nil if no rule matched.
3934 nil))))
3937 "Resolve a code reference REF.
3939 INFO is a plist used as a communication channel.
3941 Return associated line number in source code, or REF itself,
3942 depending on src-block or example element's switches."
3949 org-coderef-label-format)))
3953 ;; Element containing REF is found. Resolve it to either
3954 ;; a label or a line number, as needed.
3964 "Return LINK destination.
3966 INFO is a plist holding contextual information.
3968 Return value can be an object, an element, or nil:
3970 - If LINK path matches a target object (i.e. <<path>>) return it.
3972 - If LINK path exactly matches the name affiliated keyword
3973 \(i.e. #+NAME: path) of an element, return that element.
3975 - If LINK path exactly matches any headline name, return that
3976 element. If more than one headline share that name, priority
3977 will be given to the one with the closest common ancestor, if
3978 any, or the first one in the parse tree otherwise.
3980 - Otherwise, return nil.
3983 significant."
3986 ;; Split PATH at white spaces so matches are space
3987 ;; insensitive.
3990 ;; Cache for destinations that are not position dependent.
3998 ;; Destination is not position dependent: use cached value.
4000 ;; First try to find a matching "<<path>>" unless user specified
4001 ;; he was looking for a headline (path starts with a "*"
4002 ;; character).
4008 path)
4009 blob))
4012 ;; Then try to find an element with a matching "#+NAME: path"
4013 ;; affiliated keyword.
4016 org-element-all-elements
4021 el)))
4024 ;; Last case: link either points to a headline or to nothingness.
4025 ;; Try to find the source, with priority given to headlines with
4026 ;; the closest common ancestor. If such candidate is found,
4027 ;; return it, otherwise return nil.
4031 ;; Return first headline whose `:raw-value' property is
4032 ;; NAME in parse tree DATA, or nil. Statistics cookies
4033 ;; are ignored.
4041 name)
4042 headline))
4044 ;; Search among headlines sharing an ancestor with link, from
4045 ;; closest to farthest.
4053 ;; No destination found: return nil.
4057 "Return headline referenced as LINK destination.
4059 INFO is a plist used as a communication channel.
4061 Return value can be the headline element matched in current parse
4065 ;; First check if id is within the current parse tree.
4070 headline))
4072 ;; Otherwise, look for external files.
4076 "Return radio-target object referenced as LINK destination.
4078 INFO is a plist used as a communication channel.
4080 Return value can be a radio-target object or nil. Assume LINK
4087 radio))
4091 ;;;; For References
4092 ;;
4093 ;; `org-export-get-ordinal' associates a sequence number to any object
4094 ;; or element.
4097 "Return ordinal number of an element or object.
4099 ELEMENT is the element or object considered. INFO is the plist
4100 used as a communication channel.
4102 Optional argument TYPES, when non-nil, is a list of element or
4103 object types, as symbols, that should also be counted in.
4104 Otherwise, only provided element's type is considered.
4106 Optional argument PREDICATE is a function returning a non-nil
4107 value if the current element or object should be counted in. It
4108 accepts two arguments: the element or object being considered and
4109 the plist used as a communication channel. This allows to count
4110 only a certain type of objects (i.e. inline images).
4112 Return value is a list of numbers if ELEMENT is a headline or an
4113 item. It is nil for keywords. It represents the footnote number
4114 for footnote definitions and footnote references. If ELEMENT is
4115 a target, return the same value as if ELEMENT was the closest
4116 table, item or headline containing the target. In any other
4117 case, return the sequence number of ELEMENT among elements or
4118 objects of the same type."
4119 ;; Ordinal of a target object refer to the ordinal of the closest
4120 ;; table, item, or headline containing the object.
4124 when
4128 table))
4129 return parent)))
4131 ;; Special case 1: A headline returns its number as a list.
4133 ;; Special case 2: An item returns its number as a list.
4137 struct
4144 ;; Increment counter until ELEMENT is found again.
4155 ;;;; For Src-Blocks
4156 ;;
4157 ;; `org-export-get-loc' counts number of code lines accumulated in
4158 ;; src-block or example-block elements with a "+n" switch until
4159 ;; a given element, excluded. Note: "-n" switches reset that count.
4160 ;;
4161 ;; `org-export-unravel-code' extracts source code (along with a code
4162 ;; references alist) from an `element-block' or `src-block' type
4163 ;; element.
4164 ;;
4165 ;; `org-export-format-code' applies a formatting function to each line
4166 ;; of code, providing relative line number and code reference when
4167 ;; appropriate. Since it doesn't access the original element from
4168 ;; which the source code is coming, it expects from the code calling
4169 ;; it to know if lines should be numbered and if code references
4170 ;; should appear.
4171 ;;
4172 ;; Eventually, `org-export-format-code-default' is a higher-level
4173 ;; function (it makes use of the two previous functions) which handles
4174 ;; line numbering and code references inclusion, and returns source
4175 ;; code in a format suitable for plain text or verbatim output.
4178 "Return accumulated lines of code up to ELEMENT.
4180 INFO is the plist used as a communication channel.
4182 ELEMENT is excluded from count."
4188 ;; ELEMENT is reached: Quit the loop.
4190 ;; Only count lines from src-block and example-block elements
4191 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4195 ;; Accumulate locs or reset them.
4199 ;; Return nil to stay in the loop.
4200 nil)))
4202 ;; Return value.
4203 loc))
4206 "Clean source code and extract references out of it.
4208 ELEMENT has either a `src-block' an `example-block' type.
4210 Return a cons cell whose CAR is the source code, cleaned from any
4211 reference and protective comma and CDR is an alist between
4212 relative line number (integer) and name of code reference on that
4213 line (string)."
4215 ;; Get code and clean it. Remove blank lines at its
4216 ;; beginning and end.
4222 ;; If appropriate, remove global indentation.
4225 c
4227 ;; Get format used for references.
4230 org-coderef-label-format)))
4231 ;; Build a regexp matching a loc with a reference.
4236 ;; Return value.
4238 ;; Code with references removed.
4244 ;; Ref line: remove ref, and signal its position in REFS.
4248 ;; Reference alist.
4249 refs)))
4252 "Format CODE by applying FUN line-wise and return it.
4254 CODE is a string representing the code to format. FUN is
4255 a function. It must accept three arguments: a line of
4256 code (string), the current line number (integer) or nil and the
4257 reference associated to the current line (string) or nil.
4259 Optional argument NUM-LINES can be an integer representing the
4260 number of code lines accumulated until the current code. Line
4261 numbers passed to FUN will take it into account. If it is nil,
4262 FUN's second argument will always be nil. This number can be
4263 obtained with `org-export-get-loc' function.
4265 Optional argument REF-ALIST can be an alist between relative line
4266 number (i.e. ignoring NUM-LINES) and the name of the code
4267 reference on it. If it is nil, FUN's third argument will always
4268 be nil. It can be obtained through the use of
4269 `org-export-unravel-code' function."
4281 "Return source code from ELEMENT, formatted in a standard way.
4283 ELEMENT is either a `src-block' or `example-block' element. INFO
4284 is a plist used as a communication channel.
4286 This function takes care of line numbering and code references
4287 inclusion. Line numbers, when applicable, appear at the
4288 beginning of the line, separated from the code by two white
4289 spaces. Code references, on the other hand, appear flushed to
4290 the right, separated by six white spaces from the widest line of
4291 code."
4292 ;; Extract code and references.
4299 ;; Handle line numbering.
4308 ;; Prepare references display, if required. Any reference
4309 ;; should start six columns after the widest line of code,
4310 ;; wrapped with parenthesis.
4315 code
4319 number-str
4320 loc
4326 num-start refs)))))
4329 ;;;; For Tables
4330 ;;
4331 ;; `org-export-table-has-special-column-p' and and
4332 ;; `org-export-table-row-is-special-p' are predicates used to look for
4333 ;; meta-information about the table structure.
4334 ;;
4335 ;; `org-table-has-header-p' tells when the rows before the first rule
4336 ;; should be considered as table's header.
4337 ;;
4338 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4339 ;; and `org-export-table-cell-borders' extract information from
4340 ;; a table-cell element.
4341 ;;
4342 ;; `org-export-table-dimensions' gives the number on rows and columns
4343 ;; in the table, ignoring horizontal rules and special columns.
4344 ;; `org-export-table-cell-address', given a table-cell object, returns
4345 ;; the absolute address of a cell. On the other hand,
4346 ;; `org-export-get-table-cell-at' does the contrary.
4347 ;;
4348 ;; `org-export-table-cell-starts-colgroup-p',
4349 ;; `org-export-table-cell-ends-colgroup-p',
4350 ;; `org-export-table-row-starts-rowgroup-p',
4351 ;; `org-export-table-row-ends-rowgroup-p',
4352 ;; `org-export-table-row-starts-header-p' and
4353 ;; `org-export-table-row-ends-header-p' indicate position of current
4354 ;; row or cell within the table.
4357 "Non-nil when TABLE has a special column.
4358 All special columns will be ignored during export."
4359 ;; The table has a special column when every first cell of every row
4360 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4361 ;; "*" "_" and "^". Though, do not consider a first row containing
4362 ;; only empty cells as special.
4378 "Non-nil when TABLE has a header.
4380 INFO is a plist used as a communication channel.
4382 A table has a header when it contains at least two row groups."
4392 info)))
4395 "Non-nil if TABLE-ROW is considered special.
4397 INFO is a plist used as the communication channel.
4399 All special rows will be ignored during export."
4403 ;; A row is special either when...
4405 ;; ... it starts with a field only containing "/",
4407 ;; ... the table contains a special column and the row start
4408 ;; with a marking character among, "^", "_", "$" or "!",
4412 ;; ... it contains only alignment cookies and empty cells.
4418 ;; Since VALUE is a secondary string, the following
4419 ;; checks avoid expanding it with `org-export-data'.
4431 "Return TABLE-ROW's group.
4433 INFO is a plist used as the communication channel.
4435 Return value is the group number, as an integer, or nil for
4436 special rows and table rules. Group 1 is also table's header."
4453 "Return TABLE-CELL contents width.
4455 INFO is a plist used as the communication channel.
4457 Return value is the width given by the last width cookie in the
4458 same column as TABLE-CELL, or nil."
4463 cookie-width)
4467 ;; In a special row, try to find a width cookie at COLUMN.
4471 ;; The following checks avoid expanding unnecessarily the
4472 ;; cell with `org-export-data'
4480 ;; Ignore table rules.
4483 ;; Return value.
4484 cookie-width))
4487 "Return TABLE-CELL contents alignment.
4489 INFO is a plist used as the communication channel.
4491 Return alignment as specified by the last alignment cookie in the
4492 same column as TABLE-CELL. If no such cookie is found, a default
4493 alignment value will be deduced from fraction of numbers in the
4494 column (see `org-table-number-fraction' for more information).
4495 Possible values are `left', `right' and `center'."
4502 cookie-align
4503 previous-cell-number-p)
4507 ;; In a special row, try to find an alignment cookie at
4508 ;; COLUMN.
4512 ;; Since VALUE is a secondary string, the following checks
4513 ;; avoid useless expansion through `org-export-data'.
4521 ;; Ignore table rules.
4523 ;; In a standard row, check if cell's contents are expressing
4524 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4525 ;; Though, don't bother if an alignment cookie has already
4526 ;; defined cell's alignment.
4531 info)))
4533 ;; Treat an empty cell as a number if it follows a number
4540 ;; Return value. Alignment specified by cookies has precedence
4541 ;; over alignment deduced from cells contents.
4550 "Return TABLE-CELL borders.
4552 INFO is a plist used as a communication channel.
4554 Return value is a list of symbols, or nil. Possible values are:
4555 `top', `bottom', `above', `below', `left' and `right'. Note:
4556 `top' (resp. `bottom') only happen for a cell in the first
4557 row (resp. last row) of the table, ignoring table rules, if any.
4559 Returned borders ignore special rows."
4562 borders)
4563 ;; Top/above border? TABLE-CELL has a border above when a rule
4564 ;; used to demarcate row groups can be found above. Hence,
4565 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4566 ;; another regular row has to be found above that rule.
4575 ;; Look at every row before the current one.
4577 ;; No rule above, or rule found starts the table (ignoring any
4578 ;; special row): TABLE-CELL is at the top of the table.
4581 ;; Bottom/below border? TABLE-CELL has a border below when next
4582 ;; non-regular row below is a rule.
4591 ;; Look at every row after the current one.
4593 ;; No rule below, or rule found ends the table (modulo some
4594 ;; special row): TABLE-CELL is at the bottom of the table.
4597 ;; Right/left borders? They can only be specified by column
4598 ;; groups. Column groups are defined in a row starting with "/".
4599 ;; Also a column groups row only contains "<", "<>", ">" or blank
4600 ;; cells.
4617 ;; There's a left border when previous cell, if
4618 ;; any, ends a group, or current one starts one.
4624 ;; There's a right border when next cell, if any,
4625 ;; starts a group, or current one ends one.
4632 ;; Table rows are read in reverse order so last column groups
4633 ;; row has precedence over any previous one.
4635 ;; Return value.
4636 borders))
4639 "Non-nil when TABLE-CELL is at the beginning of a row group.
4640 INFO is a plist used as a communication channel."
4641 ;; A cell starts a column group either when it is at the beginning
4642 ;; of a row (or after the special column, if any) or when it has
4643 ;; a left border.
4646 table-cell)
4650 "Non-nil when TABLE-CELL is at the end of a row group.
4651 INFO is a plist used as a communication channel."
4652 ;; A cell ends a column group either when it is at the end of a row
4653 ;; or when it has a right border.
4656 table-cell)
4660 "Non-nil when TABLE-ROW is at the beginning of a column group.
4661 INFO is a plist used as a communication channel."
4669 "Non-nil when TABLE-ROW is at the end of a column group.
4670 INFO is a plist used as a communication channel."
4678 "Non-nil when TABLE-ROW is the first table header's row.
4679 INFO is a plist used as a communication channel."
4686 "Non-nil when TABLE-ROW is the last table header's row.
4687 INFO is a plist used as a communication channel."
4694 "Return TABLE-ROW number.
4695 INFO is a plist used as a communication channel. Return value is
4696 zero-based and ignores separators. The function returns nil for
4697 special colums and separators."
4709 "Return TABLE dimensions.
4711 INFO is a plist used as a communication channel.
4713 Return value is a CONS like (ROWS . COLUMNS) where
4714 ROWS (resp. COLUMNS) is the number of exportable
4715 rows (resp. columns)."
4717 ;; Set number of rows, and extract first one.
4723 ;; Set number of columns.
4725 ;; Return value.
4729 "Return address of a regular TABLE-CELL object.
4731 TABLE-CELL is the cell considered. INFO is a plist used as
4732 a communication channel.
4734 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4735 zero-based index. Only exportable cells are considered. The
4736 function returns nil for other cells."
4739 ;; Ignore cells in special rows or in special column.
4744 ;; Row number.
4746 ;; Column number.
4754 "Return regular table-cell object at ADDRESS in TABLE.
4756 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4757 zero-based index. TABLE is a table type element. INFO is
4758 a plist used as a communication channel.
4760 If no table-cell, among exportable cells, is found at ADDRESS,
4761 return nil."
4764 ;; Row at (car address) or nil.
4772 'table-cell
4779 ;;;; For Tables Of Contents
4780 ;;
4781 ;; `org-export-collect-headlines' builds a list of all exportable
4782 ;; headline elements, maybe limited to a certain depth. One can then
4783 ;; easily parse it and transcode it.
4784 ;;
4785 ;; Building lists of tables, figures or listings is quite similar.
4786 ;; Once the generic function `org-export-collect-elements' is defined,
4787 ;; `org-export-collect-tables', `org-export-collect-figures' and
4788 ;; `org-export-collect-listings' can be derived from it.
4791 "Collect headlines in order to build a table of contents.
4793 INFO is a plist used as a communication channel.
4795 When optional argument N is an integer, it specifies the depth of
4796 the table of contents. Otherwise, it is set to the value of the
4797 last headline level. See `org-export-headline-levels' for more
4798 information.
4800 Return a list of all exportable headlines as parsed elements.
4801 Footnote sections, if any, will be ignored."
4806 ;; Strip contents from HEADLINE.
4809 info))
4812 "Collect referenceable elements of a determined type.
4814 TYPE can be a symbol or a list of symbols specifying element
4815 types to search. Only elements with a caption are collected.
4817 INFO is a plist used as a communication channel.
4819 When non-nil, optional argument PREDICATE is a function accepting
4820 one argument, an element of type TYPE. It returns a non-nil
4821 value when that element should be collected.
4823 Return a list of all elements found, in order of appearance."
4828 element))
4829 info))
4832 "Build a list of tables.
4833 INFO is a plist used as a communication channel.
4835 Return a list of table elements with a caption."
4839 "Build a list of figures.
4841 INFO is a plist used as a communication channel. PREDICATE is
4842 a function which accepts one argument: a paragraph element and
4843 whose return value is non-nil when that element should be
4844 collected.
4846 A figure is a paragraph type element, with a caption, verifying
4848 a vague concept that may depend on back-end.
4850 Return a list of elements recognized as figures."
4854 "Build a list of src blocks.
4856 INFO is a plist used as a communication channel.
4858 Return a list of src-block elements with a caption."
4862 ;;;; Smart Quotes
4863 ;;
4864 ;; The main function for the smart quotes sub-system is
4865 ;; `org-export-activate-smart-quotes', which replaces every quote in
4866 ;; a given string from the parse tree with its "smart" counterpart.
4867 ;;
4868 ;; Dictionary for smart quotes is stored in
4869 ;; `org-export-smart-quotes-alist'.
4870 ;;
4871 ;; Internally, regexps matching potential smart quotes (checks at
4872 ;; string boundaries are also necessary) are defined in
4873 ;; `org-export-smart-quotes-regexps'.
4910 "Smart quotes translations.
4912 Alist whose CAR is a language string and CDR is an alist with
4913 quote type as key and a plist associating various encodings to
4914 their translation as value.
4916 A quote type can be any symbol among `opening-double-quote',
4917 `closing-double-quote', `opening-single-quote',
4918 `closing-single-quote' and `apostrophe'.
4920 Valid encodings include `:utf-8', `:html', `:latex' and
4921 `:texinfo'.
4927 ;; Possible opening quote at beginning of string.
4929 ;; Possible closing quote at beginning of string.
4931 ;; Possible apostrophe at beginning of string.
4933 ;; Opening single and double quotes.
4935 ;; Closing single and double quotes.
4937 ;; Apostrophe.
4939 ;; Possible opening quote at end of string.
4941 ;; Possible closing quote at end of string.
4943 ;; Possible apostrophe at end of string.
4945 "List of regexps matching a quote or an apostrophe.
4951 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4952 `:utf-8'. INFO is a plist used as a communication channel.
4954 The function has to retrieve information about string
4955 surroundings in parse tree. It can only happen with an
4956 unmodified string. Thus, if S has already been through another
4957 process, a non-nil ORIGINAL optional argument will provide that
4958 original string.
4960 Return the new string."
4963 ;; Try to be flexible when computing number of blanks
4964 ;; before object. The previous object may be a string
4965 ;; introduced by the back-end and not completely parsed.
4968 ;; A string with missing `:post-blank'
4969 ;; property.
4973 ;; Fallback value.
4978 ;; Return smart quote associated to a give quote Q, as
4979 ;; a string. TYPE is a symbol among `open', `close' and
4980 ;; `apostrophe'.
4990 org-export-smart-quotes-alist))))
4991 encoding)
4992 q)))))
4994 ;; Only a quote: no regexp can match. We have to check both
4995 ;; sides and decide what to do.
5003 ;; 1. Replace quote character at the beginning of S.
5005 ;; Apostrophe?
5011 ;; Closing quote?
5017 ;; Opening quote?
5023 ;; 2. Replace quotes in the middle of the string.
5025 ;; Opening quotes.
5031 ;; Closing quotes.
5037 ;; Apostrophes.
5042 ;; 3. Replace quote character at the end of S.
5044 ;; Apostrophe?
5049 ;; Closing quote?
5055 ;; Opening quote?
5060 ;; Return string with smart quotes.
5061 s))))
5063 ;;;; Topology
5064 ;;
5065 ;; Here are various functions to retrieve information about the
5066 ;; neighbourhood of a given element or object. Neighbours of interest
5067 ;; are direct parent (`org-export-get-parent'), parent headline
5068 ;; (`org-export-get-parent-headline'), first element containing an
5069 ;; object, (`org-export-get-parent-element'), parent table
5070 ;; (`org-export-get-parent-table'), previous element or object
5071 ;; (`org-export-get-previous-element') and next element or object
5072 ;; (`org-export-get-next-element').
5073 ;;
5074 ;; `org-export-get-genealogy' returns the full genealogy of a given
5075 ;; element or object, from closest parent to full parse tree.
5078 "Return BLOB parent or nil.
5079 BLOB is the element or object considered."
5083 "Return full genealogy relative to a given element or object.
5085 BLOB is the element or object being considered.
5087 Ancestors are returned from closest to farthest, the last one
5088 being the full parse tree."
5095 "Return BLOB parent headline or nil.
5096 BLOB is the element or object being considered."
5100 parent))
5103 "Return first element containing OBJECT or nil.
5104 OBJECT is the object to consider."
5108 parent))
5111 "Return OBJECT parent table or nil.
5112 OBJECT is either a `table-cell' or `table-element' type object."
5116 parent))
5119 "Return previous element or object.
5121 BLOB is an element or object. INFO is a plist used as
5122 a communication channel. Return previous exportable element or
5123 object, a string, or nil.
5125 When optional argument N is a positive integer, return a list
5126 containing up to N siblings before BLOB, from farthest to
5127 closest. With any other non-nil value, return a list containing
5128 all of them."
5130 ;; An object can belong to the contents of its parent or
5131 ;; to a secondary string. We check the latter option
5132 ;; first.
5135 org-element-all-elements))
5139 org-element-secondary-value-alist))
5140 parent)))
5143 prev)
5152 prev)))
5155 "Return next element or object.
5157 BLOB is an element or object. INFO is a plist used as
5158 a communication channel. Return next exportable element or
5159 object, a string, or nil.
5161 When optional argument N is a positive integer, return a list
5162 containing up to N siblings after BLOB, from closest to farthest.
5163 With any other non-nil value, return a list containing all of
5164 them."
5166 ;; An object can belong to the contents of its parent or to
5167 ;; a secondary string. We check the latter option first.
5170 org-element-all-objects))
5174 org-element-secondary-value-alist))
5175 parent)))
5178 next)
5186 siblings)
5190 ;;;; Translation
5191 ;;
5192 ;; `org-export-translate' translates a string according to language
5193 ;; specified by LANGUAGE keyword or `org-export-language-setup'
5194 ;; variable and a specified charset. `org-export-dictionary' contains
5195 ;; the dictionary used for the translation.
5317 "Dictionary for export engine.
5319 Alist whose CAR is the string to translate and CDR is an alist
5320 whose CAR is the language string and CDR is a plist whose
5321 properties are possible charsets and values translated terms.
5323 It is used as a database for `org-export-translate'. Since this
5324 function returns the string as-is if no translation was found,
5325 the variable only needs to record values different from the
5329 "Translate string S according to language specification.
5331 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5332 and `:utf-8'. INFO is a plist used as a communication channel.
5334 Translation depends on `:language' property. Return the
5335 translated string. If no translation is found, try to fall back
5336 to `:default' encoding. If it fails, return S."
5342 s)))
5345 \f
5346 ;;; Asynchronous Export
5347 ;;
5348 ;; `org-export-async-start' is the entry point for asynchronous
5349 ;; export. It recreates current buffer (including visibility,
5350 ;; narrowing and visited file) in an external Emacs process, and
5351 ;; evaluates a command there. It then applies a function on the
5352 ;; returned results in the current process.
5353 ;;
5354 ;; Asynchronously generated results are never displayed directly.
5355 ;; Instead, they are stored in `org-export-stack-contents'. They can
5356 ;; then be retrieved by calling `org-export-stack'.
5357 ;;
5358 ;; Export Stack is viewed through a dedicated major mode
5359 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5360 ;;`org-export-stack-delete', `org-export-stack-view' and
5361 ;;`org-export-stack-clear'.
5362 ;;
5363 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5364 ;; It should used whenever `org-export-async-start' is called.
5367 "Call function FUN on the results returned by BODY evaluation.
5369 BODY evaluation happens in an asynchronous process, from a buffer
5370 which is an exact copy of the current one.
5372 Use `org-export-add-to-stack' in FUN in order to register results
5373 in the stack. Examples for, respectively a temporary buffer and
5374 a file are:
5376 \(org-export-async-start
5377 \(lambda (output)
5379 \(erase-buffer)
5380 \(insert output)
5381 \(goto-char (point-min))
5382 \(org-export-add-to-stack (current-buffer) 'backend)))
5383 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5385 and
5387 \(org-export-async-start
5388 \(lambda (f) (org-export-add-to-stack f 'backend))
5389 `(expand-file-name
5390 \(org-export-to-file
5391 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5394 ;; Write the full sexp evaluating BODY in a copy of the current
5395 ;; buffer to a temporary file, as it may be too long for program
5396 ;; args in `start-process'.
5403 ;; Null characters (from variable values) are inserted
5404 ;; within the file. As a consequence, coding system for
5405 ;; buffer contents will not be recognized properly. So,
5406 ;; we make sure it is the same as the one used to display
5407 ;; the original buffer.
5409 ,coding
5412 ;; Ignore `kill-emacs-hook' and code evaluation
5413 ;; queries from Babel as we need a truly
5414 ;; non-interactive process.
5416 org-babel-confirm-evaluate-answer-no t)
5417 ;; Initialize export framework.
5419 ;; Re-create current buffer there.
5422 ;; Sexp to evaluate in the buffer.
5424 ;; Start external process.
5427 (,process
5432 "-l" org-export-async-init-file
5434 ;; Register running process in stack.
5436 ;; Set-up sentinel in order to catch results.
5438 ,process
5462 "Add a new result to export stack if not present already.
5464 SOURCE is a buffer or a file name containing export results.
5465 BACKEND is a symbol representing export back-end used to generate
5466 it.
5468 Entries already pointing to SOURCE and unavailable entries are
5469 removed beforehand. Return the new stack."
5475 "Menu for asynchronous export results and running processes."
5485 "Return source from export results at point in stack."
5492 source
5493 ;; SOURCE is not consistent with current line. The stack
5494 ;; view is outdated.
5498 "Remove all entries from export stack."
5503 "Refresh the asynchronous export stack.
5504 DUMMY is ignored. Unavailable sources are removed from the list.
5505 Return the new stack."
5515 ;; Back-end.
5517 ;; Age.
5520 ;; Compute age of the results.
5522 "%4h:%.2m "
5524 ;; Source.
5529 ;; Clear stack from exited processes, dead buffers or
5530 ;; non-existent files.
5542 "Remove export results at point from stack.
5543 If optional argument SOURCE is non-nil, remove it instead."
5548 org-export-stack-contents))))
5551 "View export results at point in stack.
5552 With an optional prefix argument IN-EMACS, force viewing files
5553 within Emacs."
5567 (define-key km "p" 'previous-line)
5568 (define-key km "\C-p" 'previous-line)
5569 (define-key km "\C-?" 'previous-line)
5570 (define-key km [up] 'previous-line)
5571 (define-key km "C" 'org-export-stack-clear)
5572 (define-key km "v" 'org-export-stack-view)
5573 (define-key km (kbd "RET") 'org-export-stack-view)
5574 (define-key km "d" 'org-export-stack-remove)
5575 km)
5576 "Keymap for Org Export Stack.")
5578 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5579 "Mode for displaying asynchronous export stack.
5582 stack.
5584 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5585 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5586 stack completely.
5588 Removing entries in an Org Export Stack buffer doesn't affect
5589 files or buffers, only the display.
5592 (abbrev-mode 0)
5593 (auto-fill-mode 0)
5594 (setq buffer-read-only t
5595 buffer-undo-list t
5596 truncate-lines t
5597 header-line-format
5598 '(:eval
5599 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5600 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5601 (set (make-local-variable 'revert-buffer-function)
5602 'org-export-stack-refresh))
5605 \f
5606 ;;; The Dispatcher
5607 ;;
5608 ;; `org-export-dispatch' is the standard interactive way to start an
5609 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5610 ;; for its interface, which, in turn, delegates response to key
5611 ;; pressed to `org-export--dispatch-action'.
5613 ;;;###autoload
5614 (defun org-export-dispatch (&optional arg)
5615 "Export dispatcher for Org mode.
5617 It provides an access to common export related tasks in a buffer.
5618 Its interface comes in two flavours: standard and expert.
5620 While both share the same set of bindings, only the former
5621 displays the valid keys associations in a dedicated buffer.
5622 Scrolling (resp. line-wise motion) in this buffer is done with
5623 SPC and DEL (resp. C-n and C-p) keys.
5625 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5626 flavour or the other.
5629 of options used back then, on the current buffer.
5631 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5632 (interactive "P")
5633 (let* ((input
5634 (cond ((equal arg '(16)) '(stack))
5635 ((and arg org-export-dispatch-last-action))
5636 (t (save-window-excursion
5637 (unwind-protect
5638 (progn
5639 ;; Remember where we are
5640 (move-marker org-export-dispatch-last-position
5641 (point)
5642 (org-base-buffer (current-buffer)))
5643 ;; Get and store an export command
5644 (setq org-export-dispatch-last-action
5645 (org-export--dispatch-ui
5646 (list org-export-initial-scope
5647 (and org-export-in-background 'async))
5648 nil
5649 org-export-dispatch-use-expert-ui)))
5650 (and (get-buffer "*Org Export Dispatcher*")
5651 (kill-buffer "*Org Export Dispatcher*")))))))
5652 (action (car input))
5653 (optns (cdr input)))
5654 (unless (memq 'subtree optns)
5655 (move-marker org-export-dispatch-last-position nil))
5656 (case action
5657 ;; First handle special hard-coded actions.
5658 (template (org-export-insert-default-template nil optns))
5659 (stack (org-export-stack))
5660 (publish-current-file
5661 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5662 (publish-current-project
5663 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5664 (publish-choose-project
5665 (org-publish (assoc (org-icompleting-read
5666 "Publish project: "
5667 org-publish-project-alist nil t)
5668 org-publish-project-alist)
5669 (memq 'force optns)
5670 (memq 'async optns)))
5671 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5672 (otherwise
5673 (save-excursion
5674 (when arg
5675 ;; Repeating command, maybe move cursor to restore subtree
5676 ;; context.
5677 (if (eq (marker-buffer org-export-dispatch-last-position)
5678 (org-base-buffer (current-buffer)))
5679 (goto-char org-export-dispatch-last-position)
5680 ;; We are in a different buffer, forget position.
5681 (move-marker org-export-dispatch-last-position nil)))
5682 (funcall action
5683 ;; Return a symbol instead of a list to ease
5684 ;; asynchronous export macro use.
5685 (and (memq 'async optns) t)
5686 (and (memq 'subtree optns) t)
5687 (and (memq 'visible optns) t)
5688 (and (memq 'body optns) t)))))))
5690 (defun org-export--dispatch-ui (options first-key expertp)
5691 "Handle interface for `org-export-dispatch'.
5693 OPTIONS is a list containing current interactive options set for
5694 export. It can contain any of the following symbols:
5695 `body' toggles a body-only export
5696 `subtree' restricts export to current subtree
5697 `visible' restricts export to visible part of buffer.
5698 `force' force publishing files.
5699 `async' use asynchronous export process
5701 FIRST-KEY is the key pressed to select the first level menu. It
5702 is nil when this menu hasn't been selected yet.
5704 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5705 buffer is provided, but indications about currently active
5706 options are given in the prompt. Moreover, \[?] allows to switch
5707 back to standard interface."
5708 (let* ((fontify-key
5709 (lambda (key &optional access-key)
5710 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5711 ;; non-nil is the required first-level key to activate
5712 ;; KEY. When its value is t, activate KEY independently
5713 ;; on the first key, if any. A nil value means KEY will
5714 ;; only be activated at first level.
5715 (if (or (eq access-key t) (eq access-key first-key))
5716 (org-propertize key 'face 'org-warning)
5717 key)))
5718 (fontify-value
5719 (lambda (value)
5720 ;; Fontify VALUE string.
5721 (org-propertize value 'face 'font-lock-variable-name-face)))
5722 ;; Prepare menu entries by extracting them from
5723 ;; `org-export-registered-backends', and sorting them by
5724 ;; access key and by ordinal, if any.
5725 (backends
5726 (sort
5727 (sort
5728 (delq nil
5729 (mapcar
5730 (lambda (b)
5731 (let ((name (car b)))
5732 (catch 'ignored
5733 ;; Ignore any back-end belonging to
5734 ;; `org-export-invisible-backends' or derived
5735 ;; from one of them.
5736 (dolist (ignored org-export-invisible-backends)
5737 (when (org-export-derived-backend-p name ignored)
5738 (throw 'ignored nil)))
5739 (org-export-backend-menu name))))
5740 org-export-registered-backends))
5741 (lambda (a b)
5742 (let ((key-a (nth 1 a))
5743 (key-b (nth 1 b)))
5744 (cond ((and (numberp key-a) (numberp key-b))
5745 (< key-a key-b))
5746 ((numberp key-b) t)))))
5747 (lambda (a b) (< (car a) (car b)))))
5748 ;; Compute a list of allowed keys based on the first key
5749 ;; pressed, if any. Some keys
5750 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
5751 ;; available.
5752 (allowed-keys
5753 (nconc (list 2 22 19 6 1)
5754 (if (not first-key) (org-uniquify (mapcar 'car backends))
5755 (let (sub-menu)
5756 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5757 (when (eq (car backend) first-key)
5758 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5759 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5760 ((not first-key) (list ?P)))
5761 (list ?& ?#)
5762 (when expertp (list ??))
5763 (list ?q)))
5764 ;; Build the help menu for standard UI.
5765 (help
5766 (unless expertp
5767 (concat
5768 ;; Options are hard-coded.
5769 (format "[%s] Body only: %s [%s] Visible only: %s
5770 \[%s] Export scope: %s [%s] Force publishing: %s
5772 (funcall fontify-key "C-b" t)
5773 (funcall fontify-value
5774 (if (memq 'body options) "On " "Off"))
5775 (funcall fontify-key "C-v" t)
5776 (funcall fontify-value
5777 (if (memq 'visible options) "On " "Off"))
5778 (funcall fontify-key "C-s" t)
5779 (funcall fontify-value
5780 (if (memq 'subtree options) "Subtree" "Buffer "))
5781 (funcall fontify-key "C-f" t)
5782 (funcall fontify-value
5783 (if (memq 'force options) "On " "Off"))
5784 (funcall fontify-key "C-a" t)
5785 (funcall fontify-value
5786 (if (memq 'async options) "On " "Off")))
5787 ;; Display registered back-end entries. When a key
5788 ;; appears for the second time, do not create another
5789 ;; entry, but append its sub-menu to existing menu.
5790 (let (last-key)
5791 (mapconcat
5792 (lambda (entry)
5793 (let ((top-key (car entry)))
5794 (concat
5795 (unless (eq top-key last-key)
5796 (setq last-key top-key)
5798 (funcall fontify-key (char-to-string top-key))
5799 (nth 1 entry)))
5800 (let ((sub-menu (nth 2 entry)))
5801 (unless (functionp sub-menu)
5802 ;; Split sub-menu into two columns.
5803 (let ((index -1))
5804 (concat
5805 (mapconcat
5806 (lambda (sub-entry)
5807 (incf index)
5808 (format
5809 (if (zerop (mod index 2)) " [%s] %-26s"
5811 (funcall fontify-key
5812 (char-to-string (car sub-entry))
5813 top-key)
5814 (nth 1 sub-entry)))
5815 sub-menu "")
5817 backends ""))
5818 ;; Publishing menu is hard-coded.
5820 [%s] Current file [%s] Current project
5822 (funcall fontify-key "P")
5823 (funcall fontify-key "f" ?P)
5824 (funcall fontify-key "p" ?P)
5825 (funcall fontify-key "x" ?P)
5826 (funcall fontify-key "a" ?P))
5828 (funcall fontify-key "&" t)
5829 (funcall fontify-key "#" t))
5830 (format "[%s] %s"
5831 (funcall fontify-key "q" t)
5832 (if first-key "Main menu" "Exit")))))
5833 ;; Build prompts for both standard and expert UI.
5834 (standard-prompt (unless expertp "Export command: "))
5835 (expert-prompt
5836 (when expertp
5837 (format
5838 "Export command (C-%s%s%s%s%s) [%s]: "
5839 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5840 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5841 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5842 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5843 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5844 (mapconcat (lambda (k)
5845 ;; Strip control characters.
5846 (unless (< k 27) (char-to-string k)))
5847 allowed-keys "")))))
5848 ;; With expert UI, just read key with a fancy prompt. In standard
5849 ;; UI, display an intrusive help buffer.
5850 (if expertp
5851 (org-export--dispatch-action
5852 expert-prompt allowed-keys backends options first-key expertp)
5853 ;; At first call, create frame layout in order to display menu.
5854 (unless (get-buffer "*Org Export Dispatcher*")
5855 (delete-other-windows)
5856 (org-switch-to-buffer-other-window
5857 (get-buffer-create "*Org Export Dispatcher*"))
5858 (setq cursor-type nil
5859 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
5860 ;; Make sure that invisible cursor will not highlight square
5861 ;; brackets.
5862 (set-syntax-table (copy-syntax-table))
5863 (modify-syntax-entry ?\[ "w"))
5864 ;; At this point, the buffer containing the menu exists and is
5865 ;; visible in the current window. So, refresh it.
5866 (with-current-buffer "*Org Export Dispatcher*"
5867 ;; Refresh help. Maintain display continuity by re-visiting
5868 ;; previous window position.
5869 (let ((pos (window-start)))
5870 (erase-buffer)
5871 (insert help)
5872 (set-window-start nil pos)))
5873 (org-fit-window-to-buffer)
5874 (org-export--dispatch-action
5875 standard-prompt allowed-keys backends options first-key expertp))))
5877 (defun org-export--dispatch-action
5878 (prompt allowed-keys backends options first-key expertp)
5879 "Read a character from command input and act accordingly.
5881 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5882 a list of characters available at a given step in the process.
5883 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5884 EXPERTP are the same as defined in `org-export--dispatch-ui',
5885 which see.
5887 Toggle export options when required. Otherwise, return value is
5888 a list with action as CAR and a list of interactive export
5889 options as CDR."
5890 (let (key)
5891 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
5892 ;; C-p, SPC, DEL).
5893 (while (and (setq key (read-char-exclusive prompt))
5894 (not expertp)
5895 (memq key '(14 16 ?\s ?\d)))
5896 (case key
5897 (14 (if (not (pos-visible-in-window-p (point-max)))
5898 (ignore-errors (scroll-up-line))
5899 (message "End of buffer")
5900 (sit-for 1)))
5901 (16 (if (not (pos-visible-in-window-p (point-min)))
5902 (ignore-errors (scroll-down-line))
5903 (message "Beginning of buffer")
5904 (sit-for 1)))
5905 (?\s (if (not (pos-visible-in-window-p (point-max)))
5906 (scroll-up nil)
5907 (message "End of buffer")
5908 (sit-for 1)))
5909 (?\d (if (not (pos-visible-in-window-p (point-min)))
5910 (scroll-down nil)
5911 (message "Beginning of buffer")
5912 (sit-for 1)))))
5913 (cond
5914 ;; Ignore undefined associations.
5915 ((not (memq key allowed-keys))
5916 (ding)
5917 (unless expertp (message "Invalid key") (sit-for 1))
5918 (org-export--dispatch-ui options first-key expertp))
5919 ;; q key at first level aborts export. At second level, cancel
5920 ;; first key instead.
5921 ((eq key ?q) (if (not first-key) (error "Export aborted")
5922 (org-export--dispatch-ui options nil expertp)))
5923 ;; Help key: Switch back to standard interface if expert UI was
5924 ;; active.
5925 ((eq key ??) (org-export--dispatch-ui options first-key nil))
5926 ;; Send request for template insertion along with export scope.
5927 ((eq key ?#) (cons 'template (memq 'subtree options)))
5928 ;; Switch to asynchronous export stack.
5929 ((eq key ?&) '(stack))
5930 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
5931 ((memq key '(2 22 19 6 1))
5932 (org-export--dispatch-ui
5933 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
5934 (6 'force) (1 'async))))
5935 (if (memq option options) (remq option options)
5936 (cons option options)))
5937 first-key expertp))
5938 ;; Action selected: Send key and options back to
5939 ;; `org-export-dispatch'.
5940 ((or first-key (functionp (nth 2 (assq key backends))))
5941 (cons (cond
5942 ((not first-key) (nth 2 (assq key backends)))
5943 ;; Publishing actions are hard-coded. Send a special
5944 ;; signal to `org-export-dispatch'.
5945 ((eq first-key ?P)
5946 (case key
5947 (?f 'publish-current-file)
5948 (?p 'publish-current-project)
5949 (?x 'publish-choose-project)
5950 (?a 'publish-all)))
5951 ;; Return first action associated to FIRST-KEY + KEY
5952 ;; path. Indeed, derived backends can share the same
5953 ;; FIRST-KEY.
5954 (t (catch 'found
5955 (mapc (lambda (backend)
5956 (let ((match (assq key (nth 2 backend))))
5957 (when match (throw 'found (nth 2 match)))))
5958 (member (assq first-key backends) backends)))))
5959 options))
5960 ;; Otherwise, enter sub-menu.
5961 (t (org-export--dispatch-ui options key expertp)))))
5965 (provide 'ox)
5967 ;; Local variables:
5968 ;; generated-autoload-file: "org-loaddefs.el"
5969 ;; End:
5971 ;;; ox.el ends here