| blob | bc56414e42469067add247b6c67f5b642a197c6c |
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 ;; This function can also support specific buffer keywords, OPTION
52 ;; keyword's items and filters. Refer to function's documentation for
53 ;; more information.
54 ;;
55 ;; If the new back-end shares most properties with another one,
56 ;; `org-export-define-derived-backend' can be used to simplify the
57 ;; process.
58 ;;
59 ;; Any back-end can define its own variables. Among them, those
60 ;; customizable should belong to the `org-export-BACKEND' group.
61 ;;
62 ;; Tools for common tasks across back-ends are implemented in the
63 ;; following part of the file.
64 ;;
65 ;; Then, a wrapper macro for asynchronous export,
66 ;; `org-export-async-start', along with tools to display results. are
67 ;; given in the penultimate part.
68 ;;
69 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
70 ;; back-ends is provided in the last one.
72 ;;; Code:
91 \f
92 ;;; Internal Variables
93 ;;
94 ;; Among internal variables, the most important is
95 ;; `org-export-options-alist'. This variable define the global export
96 ;; options, shared between every exporter, and how they are acquired.
142 "Alist between export properties and ways to set them.
144 The CAR of the alist is the property name, and the CDR is a list
145 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
147 KEYWORD is a string representing a buffer keyword, or nil. Each
148 property defined this way can also be set, during subtree
149 export, through a headline property named after the keyword
151 property).
152 OPTION is a string that could be found in an #+OPTIONS: line.
153 DEFAULT is the default value for the property.
154 BEHAVIOUR determines how Org should handle multiple keywords for
155 the same property. It is a symbol among:
156 nil Keep old value and discard the new one.
157 t Replace old value with the new one.
158 `space' Concatenate the values, separating them with a space.
159 `newline' Concatenate the values, separating them with
160 a newline.
161 `split' Split values at white spaces, and cons them to the
162 previous list.
164 Values set through KEYWORD and OPTION have precedence over
165 DEFAULT.
167 All these properties should be back-end agnostic. Back-end
168 specific properties are set through `org-export-define-backend'.
172 "List of in-buffer keywords that require special treatment.
173 These keywords are not directly associated to a property. The
174 way they are handled must be hard-coded into
234 "Alist between filters properties and initial values.
236 The key of each association is a property name accessible through
237 the communication channel. Its value is a configurable global
238 variable defining initial filters.
240 This list is meant to install user specified filters. Back-end
241 developers may install their own filters using
242 `org-export-define-backend'. Filters defined there will always
243 be prepended to the current list, so they always get applied
252 "Default rule for link matching an inline image.
253 This rule applies to links with no description. By default, it
254 will be considered as an inline image if it targets a local file
257 See `org-export-inline-image-p' for more information about
261 "Non-nil means asynchronous export process should leave data behind.
265 located in `temporary-file-directory'.
267 When non-nil, it will also set `debug-on-error' to a non-nil
271 "Record asynchronously generated export results and processes.
272 This is an alist: its CAR is the source of the
273 result (destination file or buffer for a finished process,
274 original buffer for a running one) and its CDR is a list
275 containing the back-end used, as a symbol, and either a process
276 or the time at which it finished. It is used to build the menu
280 "List of backends currently available in the exporter.
281 This variable is set with `org-export-define-backend' and
285 "Last command called from the dispatcher.
286 The value should be a list. Its CAR is the action, as a symbol,
290 "The position where the last export command was created using the dispatcher.
291 This marker will be used with `C-u C-c C-e' to make sure export repetition
294 ;; For compatibility with Org < 8
296 "Name, if any, of the back-end used during an export process.
298 Its value is a symbol such as `html', `latex', `ascii', or nil if
299 the back-end is anonymous (see `org-export-create-backend') or if
300 there is no export process in progress.
302 It can be used to teach Babel blocks how to act differently
305 \f
306 ;;; User-configurable Variables
307 ;;
308 ;; Configuration for the masses.
309 ;;
310 ;; They should never be accessed directly, as their value is to be
311 ;; stored in a property list (cf. `org-export-options-alist').
312 ;; Back-ends will read their value from there instead.
315 "Options for exporting Org mode files."
320 "General options for export engine."
325 "Whether sub-trees with the ARCHIVE tag should be exported.
327 This can have three different values:
328 nil Do not export, pretend this tree is not present.
329 t Do export the entire tree.
330 `headline' Only export the headline, but skip the tree below it.
332 This option can also be set with the OPTIONS keyword,
341 "Non-nil means insert author name into the exported file.
342 This option can also be set with the OPTIONS keyword,
348 "Non-nil means export CLOCK keywords.
349 This option can also be set with the OPTIONS keyword,
355 "Non-nil means the postamble should contain a creator sentence.
357 The sentence can be set in `org-export-creator-string' and
360 If the value is `comment' insert it as a comment."
368 "Non-nil means insert date in the exported document.
369 This option can also be set with the OPTIONS keyword,
375 "Time-stamp format string to use for DATE keyword.
377 The format string, when specified, only applies if date consists
378 in a single time-stamp. Otherwise its value will be ignored.
380 See `format-time-string' for details on how to build this
381 string."
389 emacs-version
391 "Information about the creator of the document.
392 This option can also be set on with the CREATOR keyword."
397 "Non-nil means export contents of standard drawers.
399 When t, all drawers are exported. This may also be a list of
400 drawer names to export, as strings. If that list starts with
401 `not', only drawers with such names will be ignored.
403 This variable doesn't apply to properties drawers. See
404 `org-export-with-properties' instead.
406 This option can also be set with the OPTIONS keyword,
419 :inline t
423 "Non-nil means insert author email into the exported file.
424 This option can also be set with the OPTIONS keyword,
430 "Non-nil means interpret *word*, /word/, _word_ and +word+.
432 If the export target supports emphasizing text, the word will be
433 typeset in bold, italic, with an underline or strike-through,
434 respectively.
436 This option can also be set with the OPTIONS keyword,
442 "Tags that exclude a tree from export.
444 All trees carrying any of these tags will be excluded from
445 export. This is without condition, so even subtrees inside that
446 carry one of the `org-export-select-tags' will be removed.
448 This option can also be set with the EXCLUDE_TAGS keyword."
455 This can be used to have pre-formatted text, fragments of code
456 etc. For example:
457 : ;; Some Lisp examples
458 : (while (defc cnt)
459 : (ding))
460 will be looking just like this in also HTML. See also the QUOTE
461 keyword. Not all export backends support this.
463 This option can also be set with the OPTIONS keyword,
469 "Non-nil means Org footnotes should be exported.
470 This option can also be set with the OPTIONS keyword,
476 "Non-nil means process LaTeX environments and fragments.
478 This option can also be set with the OPTIONS line,
481 nil Ignore math snippets.
482 `verbatim' Keep everything in verbatim.
483 t Allow export of math snippets."
493 "The last level which is still exported as a headline.
495 Inferior levels will usually produce itemize or enumerate lists
496 when exported, but back-end behaviour may differ.
498 This option can also be set with the OPTIONS keyword,
504 "The default language for export and clocktable translations, as a string.
505 This may have an association in
506 `org-clock-clocktable-language-setup',
507 `org-export-smart-quotes-alist' and `org-export-dictionary'.
508 This option can also be set with the LANGUAGE keyword."
513 "Non-nil means preserve all line breaks when exporting.
514 This option can also be set with the OPTIONS keyword,
520 "Non-nil means interpret entities when exporting.
523 Å.
525 For a list of supported names, see the constant `org-entities'
526 and the user option `org-entities-user'.
528 This option can also be set with the OPTIONS keyword,
534 "Non-nil means inlinetasks should be exported.
535 This option can also be set with the OPTIONS keyword,
543 "Non-nil means include planning info in export.
545 Planning info is the line containing either SCHEDULED:,
546 DEADLINE:, CLOSED: time-stamps, or a combination of them.
548 This option can also be set with the OPTIONS keyword,
556 "Non-nil means include priority cookies in export.
557 This option can also be set with the OPTIONS keyword,
563 "Non-nil means export contents of properties drawers.
565 When t, all properties are exported. This may also be a list of
566 properties to export, as strings.
568 This option can also be set with the OPTIONS keyword,
580 "Non-nil means add section numbers to headlines when exporting.
582 When set to an integer n, numbering will only happen for
583 headlines whose relative level is higher or equal to n.
585 This option can also be set with the OPTIONS keyword,
591 "Tags that select a tree for export.
593 If any such tag is found in a buffer, all trees that do not carry
594 one of these tags will be ignored during export. Inside trees
595 that are selected like this, you can still deselect a subtree by
596 tagging it with one of the `org-export-exclude-tags'.
598 This option can also be set with the SELECT_TAGS keyword."
603 "Non-nil means activate smart quotes during export.
604 This option can also be set with the OPTIONS keyword,
607 When setting this to non-nil, you need to take care of
608 using the correct Babel package when exporting to LaTeX.
609 E.g., you can load Babel for french like this:
620 When this option is turned on, these strings will be exported as:
622 Org HTML LaTeX UTF-8
623 -----+----------+--------+-------
625 -- – -- –
626 --- — --- —
629 This option can also be set with the OPTIONS keyword,
635 "Non-nil means include statistics cookies in export.
636 This option can also be set with the OPTIONS keyword,
646 When this option is turned on, you can use TeX-like syntax for
648 will be considered as a single item - so grouping with {} is
649 normally not needed. For example, the following things will be
650 parsed as single sub- or superscripts.
652 10^24 or 10^tau several digits will be considered 1 item.
653 10^-12 or 10^-tau a leading sign with digits or a word
654 x^2-y^3 will be read as x^2 - y^3, because items are
655 terminated by almost any nonword/nondigit char.
656 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
658 Still, ambiguity is possible - so when in doubt use {} to enclose
659 the sub/superscript. If you set this variable to the symbol
660 `{}', the braces are *required* in order to trigger
661 interpretations as sub/superscript. This can be helpful in
664 This option can also be set with the OPTIONS keyword,
673 "Non-nil means create a table of contents in exported files.
675 The TOC contains headlines with levels up
676 to`org-export-headline-levels'. When an integer, include levels
677 up to N in the toc, this may then be different from
678 `org-export-headline-levels', but it will not be allowed to be
679 larger than the number of headline levels. When nil, no table of
680 contents is made.
682 This option can also be set with the OPTIONS keyword,
692 For example:
694 | Name | Address | Birthday |
695 |-------------+----------+-----------|
696 | Arthur Dent | England | 29.2.2100 |
698 This option can also be set with the OPTIONS keyword,
704 "If nil, do not export tags, just remove them from headlines.
706 If this is the symbol `not-in-toc', tags will be removed from
707 table of contents entries, but still be shown in the headlines of
708 the document.
710 This option can also be set with the OPTIONS keyword,
719 "Non-nil means include TODO items for export.
721 This may have the following values:
722 t include tasks independent of state.
723 `todo' include only tasks that are not yet done.
724 `done' include only tasks that are already done.
725 nil ignore all tasks.
726 list of keywords include tasks with these keywords.
728 This option can also be set with the OPTIONS keyword,
740 "Non-nil means insert a time stamp into the exported file.
741 The time stamp shows when the file was created. This option can
747 "Non nil means allow timestamps in export.
749 It can be set to any of the following values:
750 t export all timestamps.
751 `active' export active timestamps only.
752 `inactive' export inactive timestamps only.
753 nil do not export timestamps
755 This only applies to timestamps isolated in a paragraph
756 containing only timestamps. Other timestamps are always
757 exported.
759 This option can also be set with the OPTIONS keyword, e.g.
769 "Non-nil means include TODO keywords in export.
770 When nil, remove all these keywords from the export. This option
776 "Non-nil means BIND keywords can define local variable values.
777 This is a potential security risk, which is why the default value
778 is nil. You can also allow them through local buffer variables."
785 "Alist between export snippets back-ends and exporter back-ends.
787 This variable allows to provide shortcuts for export snippets.
791 HTML code while every other back-end will ignore it."
800 "Coding system for the exported file."
807 "Should we push exported content to the kill ring?"
816 "The initial scope when exporting with `org-export-dispatch'.
817 This variable can be either set to `buffer' or `subtree'."
824 "Non-nil means show buffer after exporting to temp buffer.
825 When Org exports to a file, the buffer visiting that file is ever
826 shown, but remains buried. However, when exporting to
827 a temporary buffer, that buffer is popped up in a second window.
828 When this variable is nil, the buffer remains buried also in
829 these cases."
834 "Non-nil means export and publishing commands will run in background.
835 Results from an asynchronous export are never displayed
843 "File used to initialize external export process.
845 Value must be either nil or an absolute file name. When nil, the
846 external process is launched like a regular Emacs session,
847 loading user's initialization file and any site specific
848 configuration. If a file is provided, it, and only it, is loaded
849 at start-up.
851 Therefore, using a specific configuration makes the process to
852 load faster and the export more portable."
861 "Non-nil means using a non-intrusive `org-export-dispatch'.
862 In that case, no help buffer is displayed. Though, an indicator
868 asynchronous). Also, \[?] allows to switch back to standard
869 mode."
876 \f
877 ;;; Defining Back-ends
878 ;;
879 ;; An export back-end is a structure with `org-export-backend' type
880 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
881 ;; and `menu' slots.
882 ;;
883 ;; At the lowest level, a back-end is created with
884 ;; `org-export-create-backend' function.
885 ;;
886 ;; A named back-end can be registered with
887 ;; `org-export-register-backend' function. A registered back-end can
888 ;; later be referred to by its name, with `org-export-get-backend'
889 ;; function. Also, such a back-end can become the parent of a derived
890 ;; back-end from which slot values will be inherited by default.
891 ;; `org-export-derived-backend-p' can check if a given back-end is
892 ;; derived from a list of back-end names.
893 ;;
894 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
895 ;; `org-export-get-all-filters' return the full alist of transcoders,
896 ;; options and filters, including those inherited from ancestors.
897 ;;
898 ;; At a higher level, `org-export-define-backend' is the standard way
899 ;; to define an export back-end. If the new back-end is similar to
900 ;; a registered back-end, `org-export-define-derived-backend' may be
901 ;; used instead.
902 ;;
903 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
904 ;; when a given back-end hasn't been registered yet.
908 name parent transcoders options filters blocks menu)
911 "Return export back-end named after NAME.
912 NAME is a symbol. Return nil if no such back-end is found."
919 "Register BACKEND as a known export back-end.
920 BACKEND is a structure with `org-export-backend' type."
921 ;; Refuse to register an unnamed back-end.
924 ;; Refuse to register a back-end with an unknown parent.
928 ;; Register dedicated export blocks in the parser.
932 ;; If a back-end with the same name as BACKEND is already
933 ;; registered, replace it with BACKEND. Otherwise, simply add
934 ;; BACKEND to the list of registered back-ends.
940 "Signal an error if BACKEND isn't defined."
945 "Non-nil if BACKEND is derived from one of BACKENDS.
946 BACKEND is an export back-end, as returned by, e.g.,
947 `org-export-create-backend', or a symbol referring to
948 a registered back-end. BACKENDS is constituted of symbols."
960 "Return full translation table for BACKEND.
962 BACKEND is an export back-end, as return by, e.g,,
963 `org-export-create-backend'. Return value is an alist where
964 keys are element or object types, as symbols, and values are
965 transcoders.
967 Unlike to `org-export-backend-transcoders', this function
968 also returns transcoders inherited from parent back-ends,
969 if any."
973 parent)
978 transcoders)))
981 "Return export options for BACKEND.
983 BACKEND is an export back-end, as return by, e.g,,
984 `org-export-create-backend'. See `org-export-options-alist'
985 for the shape of the return value.
987 Unlike to `org-export-backend-options', this function also
988 returns options inherited from parent back-ends, if any."
992 parent)
996 options)))
999 "Return complete list of filters for BACKEND.
1001 BACKEND is an export back-end, as return by, e.g,,
1002 `org-export-create-backend'. Return value is an alist where
1003 keys are symbols and values lists of functions.
1005 Unlike to `org-export-backend-filters', this function also
1006 returns filters inherited from parent back-ends, if any."
1010 parent)
1014 filters)))
1017 "Define a new back-end BACKEND.
1019 TRANSCODERS is an alist between object or element types and
1020 functions handling them.
1022 These functions should return a string without any trailing
1023 space, or nil. They must accept three arguments: the object or
1024 element itself, its contents or nil when it isn't recursive and
1025 the property list used as a communication channel.
1027 Contents, when not nil, are stripped from any global indentation
1028 \(although the relative one is preserved). They also always end
1029 with a single newline character.
1031 If, for a given type, no function is found, that element or
1032 object type will simply be ignored, along with any blank line or
1033 white space at its end. The same will happen if the function
1034 returns the nil value. If that function returns the empty
1035 string, the type will be ignored, but the blank lines or white
1036 spaces will be kept.
1038 In addition to element and object types, one function can be
1039 associated to the `template' (or `inner-template') symbol and
1040 another one to the `plain-text' symbol.
1042 The former returns the final transcoded string, and can be used
1043 to add a preamble and a postamble to document's body. It must
1044 accept two arguments: the transcoded string and the property list
1045 containing export options. A function associated to `template'
1047 A function associated to `inner-template' is always applied.
1049 The latter, when defined, is to be called on every text not
1050 recognized as an element or an object. It must accept two
1051 arguments: the text string and the information channel. It is an
1052 appropriate place to protect special chars relative to the
1053 back-end.
1055 BODY can start with pre-defined keyword arguments. The following
1056 keywords are understood:
1058 :export-block
1060 String, or list of strings, representing block names that
1061 will not be parsed. This is used to specify blocks that will
1062 contain raw code specific to the back-end. These blocks
1063 still have to be handled by the relative `export-block' type
1064 translator.
1066 :filters-alist
1068 Alist between filters and function, or list of functions,
1069 specific to the back-end. See `org-export-filters-alist' for
1070 a list of all allowed filters. Filters defined here
1071 shouldn't make a back-end test, as it may prevent back-ends
1072 derived from this one to behave properly.
1074 :menu-entry
1076 Menu entry for the export dispatcher. It should be a list
1077 like:
1079 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1081 where :
1083 KEY is a free character selecting the back-end.
1085 DESCRIPTION-OR-ORDINAL is either a string or a number.
1087 If it is a string, is will be used to name the back-end in
1088 its menu entry. If it is a number, the following menu will
1089 be displayed as a sub-menu of the back-end with the same
1090 KEY. Also, the number will be used to determine in which
1091 order such sub-menus will appear (lowest first).
1093 ACTION-OR-MENU is either a function or an alist.
1095 If it is an action, it will be called with four
1096 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1097 BODY-ONLY. See `org-export-as' for further explanations on
1098 some of them.
1100 If it is an alist, associations should follow the
1101 pattern:
1103 '(KEY DESCRIPTION ACTION)
1105 where KEY, DESCRIPTION and ACTION are described above.
1107 Valid values include:
1111 or
1116 \(lambda (a s v b)
1117 \(if a (org-latex-export-to-pdf t s v b)
1118 \(org-open-file
1119 \(org-latex-export-to-pdf nil s v b)))))))
1121 or the following, which will be added to the previous
1122 sub-menu,
1124 '(?l 1
1128 :options-alist
1130 Alist between back-end specific properties introduced in
1131 communication channel and how their value are acquired. See
1132 `org-export-options-alist' for more information about
1133 structure of the values."
1147 :transcoders transcoders
1148 :options options
1149 :filters filters
1150 :blocks blocks
1154 "Create a new back-end as a variant of an existing one.
1156 CHILD is the name of the derived back-end. PARENT is the name of
1157 the parent back-end.
1159 BODY can start with pre-defined keyword arguments. The following
1160 keywords are understood:
1162 :export-block
1164 String, or list of strings, representing block names that
1165 will not be parsed. This is used to specify blocks that will
1166 contain raw code specific to the back-end. These blocks
1167 still have to be handled by the relative `export-block' type
1168 translator.
1170 :filters-alist
1172 Alist of filters that will overwrite or complete filters
1173 defined in PARENT back-end. See `org-export-filters-alist'
1174 for a list of allowed filters.
1176 :menu-entry
1178 Menu entry for the export dispatcher. See
1179 `org-export-define-backend' for more information about the
1180 expected value.
1182 :options-alist
1184 Alist of back-end specific properties that will overwrite or
1185 complete those defined in PARENT back-end. Refer to
1186 `org-export-options-alist' for more information about
1187 structure of the values.
1189 :translate-alist
1191 Alist of element and object types and transcoders that will
1192 overwrite or complete transcode table from PARENT back-end.
1193 Refer to `org-export-define-backend' for detailed information
1194 about transcoders.
1197 as a variant of `latex' back-end with a custom template function:
1199 \(org-export-define-derived-backend 'my-latex 'latex
1200 :translate-alist '((template . my-latex-template-fun)))
1202 The back-end could then be called with, for example:
1219 :parent parent
1220 :transcoders transcoders
1221 :options options
1222 :filters filters
1223 :blocks blocks
1227 \f
1228 ;;; The Communication Channel
1229 ;;
1230 ;; During export process, every function has access to a number of
1231 ;; properties. They are of two types:
1232 ;;
1233 ;; 1. Environment options are collected once at the very beginning of
1234 ;; the process, out of the original buffer and configuration.
1235 ;; Collecting them is handled by `org-export-get-environment'
1236 ;; function.
1237 ;;
1238 ;; Most environment options are defined through the
1239 ;; `org-export-options-alist' variable.
1240 ;;
1241 ;; 2. Tree properties are extracted directly from the parsed tree,
1242 ;; just before export, by `org-export-collect-tree-properties'.
1243 ;;
1244 ;; Here is the full list of properties available during transcode
1245 ;; process, with their category and their value type.
1246 ;;
1247 ;; + `:author' :: Author's name.
1248 ;; - category :: option
1249 ;; - type :: string
1250 ;;
1251 ;; + `:back-end' :: Current back-end used for transcoding.
1252 ;; - category :: tree
1253 ;; - type :: structure
1254 ;;
1255 ;; + `:creator' :: String to write as creation information.
1256 ;; - category :: option
1257 ;; - type :: string
1258 ;;
1259 ;; + `:date' :: String to use as date.
1260 ;; - category :: option
1261 ;; - type :: string
1262 ;;
1263 ;; + `:description' :: Description text for the current data.
1264 ;; - category :: option
1265 ;; - type :: string
1266 ;;
1267 ;; + `:email' :: Author's email.
1268 ;; - category :: option
1269 ;; - type :: string
1270 ;;
1271 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1272 ;; process.
1273 ;; - category :: option
1274 ;; - type :: list of strings
1275 ;;
1276 ;; + `:export-options' :: List of export options available for current
1277 ;; process.
1278 ;; - category :: none
1279 ;; - type :: list of symbols, among `subtree', `body-only' and
1280 ;; `visible-only'.
1281 ;;
1282 ;; + `:exported-data' :: Hash table used for memoizing
1283 ;; `org-export-data'.
1284 ;; - category :: tree
1285 ;; - type :: hash table
1286 ;;
1287 ;; + `:filetags' :: List of global tags for buffer. Used by
1288 ;; `org-export-get-tags' to get tags with inheritance.
1289 ;; - category :: option
1290 ;; - type :: list of strings
1291 ;;
1292 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1293 ;; their definition, as parsed data. Only non-inlined footnotes
1294 ;; are represented in this alist. Also, every definition isn't
1295 ;; guaranteed to be referenced in the parse tree. The purpose of
1296 ;; this property is to preserve definitions from oblivion
1297 ;; (i.e. when the parse tree comes from a part of the original
1298 ;; buffer), it isn't meant for direct use in a back-end. To
1299 ;; retrieve a definition relative to a reference, use
1300 ;; `org-export-get-footnote-definition' instead.
1301 ;; - category :: option
1302 ;; - type :: alist (STRING . LIST)
1303 ;;
1304 ;; + `:headline-levels' :: Maximum level being exported as an
1305 ;; headline. Comparison is done with the relative level of
1306 ;; headlines in the parse tree, not necessarily with their
1307 ;; actual level.
1308 ;; - category :: option
1309 ;; - type :: integer
1310 ;;
1311 ;; + `:headline-offset' :: Difference between relative and real level
1312 ;; of headlines in the parse tree. For example, a value of -1
1313 ;; means a level 2 headline should be considered as level
1314 ;; 1 (cf. `org-export-get-relative-level').
1315 ;; - category :: tree
1316 ;; - type :: integer
1317 ;;
1318 ;; + `:headline-numbering' :: Alist between headlines and their
1319 ;; numbering, as a list of numbers
1320 ;; (cf. `org-export-get-headline-number').
1321 ;; - category :: tree
1322 ;; - type :: alist (INTEGER . LIST)
1323 ;;
1324 ;; + `:id-alist' :: Alist between ID strings and destination file's
1325 ;; path, relative to current directory. It is used by
1326 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1327 ;; external file.
1328 ;; - category :: option
1329 ;; - type :: alist (STRING . STRING)
1330 ;;
1331 ;; + `:ignore-list' :: List of elements and objects that should be
1332 ;; ignored during export.
1333 ;; - category :: tree
1334 ;; - type :: list of elements and objects
1335 ;;
1336 ;; + `:input-buffer' :: Original buffer name.
1337 ;; - category :: option
1338 ;; - type :: string
1339 ;;
1340 ;; + `:input-file' :: Full path to input file, if any.
1341 ;; - category :: option
1342 ;; - type :: string or nil
1343 ;;
1344 ;; + `:keywords' :: List of keywords attached to data.
1345 ;; - category :: option
1346 ;; - type :: string
1347 ;;
1348 ;; + `:language' :: Default language used for translations.
1349 ;; - category :: option
1350 ;; - type :: string
1351 ;;
1352 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1353 ;; transcoding.
1354 ;; - category :: option
1355 ;; - type :: list (as returned by `org-element-parse-buffer')
1356 ;;
1357 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1358 ;; all line breaks.
1359 ;; - category :: option
1360 ;; - type :: symbol (nil, t)
1361 ;;
1362 ;; + `:section-numbers' :: Non-nil means transcoding should add
1363 ;; section numbers to headlines.
1364 ;; - category :: option
1365 ;; - type :: symbol (nil, t)
1366 ;;
1367 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1368 ;; in transcoding. When such a tag is present, subtrees without
1369 ;; it are de facto excluded from the process. See
1370 ;; `use-select-tags'.
1371 ;; - category :: option
1372 ;; - type :: list of strings
1373 ;;
1374 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1375 ;; a time stamp in the output.
1376 ;; - category :: option
1377 ;; - type :: symbol (nil, t)
1378 ;;
1379 ;; + `:translate-alist' :: Alist between element and object types and
1380 ;; transcoding functions relative to the current back-end.
1381 ;; Special keys `inner-template', `template' and `plain-text' are
1382 ;; also possible.
1383 ;; - category :: option
1384 ;; - type :: alist (SYMBOL . FUNCTION)
1385 ;;
1386 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1387 ;; also be transcoded. If it is set to the `headline' symbol,
1388 ;; only the archived headline's name is retained.
1389 ;; - category :: option
1390 ;; - type :: symbol (nil, t, `headline')
1391 ;;
1392 ;; + `:with-author' :: Non-nil means author's name should be included
1393 ;; in the output.
1394 ;; - category :: option
1395 ;; - type :: symbol (nil, t)
1396 ;;
1397 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1398 ;; - category :: option
1399 ;; - type :: symbol (nil, t)
1400 ;;
1401 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1402 ;; inserted at the end of the transcoded string. If the value
1403 ;; is `comment', it should be commented.
1404 ;; - category :: option
1405 ;; - type :: symbol (`comment', nil, t)
1406 ;;
1407 ;; + `:with-date' :: Non-nil means output should contain a date.
1408 ;; - category :: option
1409 ;; - type :. symbol (nil, t)
1410 ;;
1411 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1412 ;; its value is a list of names, only drawers with such names
1413 ;; will be transcoded. If that list starts with `not', drawer
1414 ;; with these names will be skipped.
1415 ;; - category :: option
1416 ;; - type :: symbol (nil, t) or list of strings
1417 ;;
1418 ;; + `:with-email' :: Non-nil means output should contain author's
1419 ;; email.
1420 ;; - category :: option
1421 ;; - type :: symbol (nil, t)
1422 ;;
1423 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1424 ;; interpreted.
1425 ;; - category :: option
1426 ;; - type :: symbol (nil, t)
1427 ;;
1428 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1429 ;; strings starting with a colon as a fixed-with (verbatim) area.
1430 ;; - category :: option
1431 ;; - type :: symbol (nil, t)
1432 ;;
1433 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1434 ;; footnotes.
1435 ;; - category :: option
1436 ;; - type :: symbol (nil, t)
1437 ;;
1438 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1439 ;; `latex-fragment' objects should appear in export output. When
1440 ;; this property is set to `verbatim', they will be left as-is.
1441 ;; - category :: option
1442 ;; - type :: symbol (`verbatim', nil, t)
1443 ;;
1444 ;; + `:with-planning' :: Non-nil means transcoding should include
1445 ;; planning info.
1446 ;; - category :: option
1447 ;; - type :: symbol (nil, t)
1448 ;;
1449 ;; + `:with-priority' :: Non-nil means transcoding should include
1450 ;; priority cookies.
1451 ;; - category :: option
1452 ;; - type :: symbol (nil, t)
1453 ;;
1454 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1455 ;; plain text.
1456 ;; - category :: option
1457 ;; - type :: symbol (nil, t)
1458 ;;
1459 ;; + `:with-special-strings' :: Non-nil means transcoding should
1460 ;; interpret special strings in plain text.
1461 ;; - category :: option
1462 ;; - type :: symbol (nil, t)
1463 ;;
1464 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1465 ;; interpret subscript and superscript. With a value of "{}",
1466 ;; only interpret those using curly brackets.
1467 ;; - category :: option
1468 ;; - type :: symbol (nil, {}, t)
1469 ;;
1470 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1471 ;; tables.
1472 ;; - category :: option
1473 ;; - type :: symbol (nil, t)
1474 ;;
1475 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1476 ;; headlines. A `not-in-toc' value will remove them from the
1477 ;; table of contents, if any, nonetheless.
1478 ;; - category :: option
1479 ;; - type :: symbol (nil, t, `not-in-toc')
1480 ;;
1481 ;; + `:with-tasks' :: Non-nil means transcoding should include
1482 ;; headlines with a TODO keyword. A `todo' value will only
1483 ;; include headlines with a todo type keyword while a `done'
1484 ;; value will do the contrary. If a list of strings is provided,
1485 ;; only tasks with keywords belonging to that list will be kept.
1486 ;; - category :: option
1487 ;; - type :: symbol (t, todo, done, nil) or list of strings
1488 ;;
1489 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1490 ;; time stamps. Special value `active' (resp. `inactive') ask to
1491 ;; export only active (resp. inactive) timestamps. Otherwise,
1492 ;; completely remove them.
1493 ;; - category :: option
1494 ;; - type :: symbol: (`active', `inactive', t, nil)
1495 ;;
1496 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1497 ;; added to the output. An integer value limits its depth.
1498 ;; - category :: option
1499 ;; - type :: symbol (nil, t or integer)
1500 ;;
1501 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1502 ;; include TODO keywords.
1503 ;; - category :: option
1504 ;; - type :: symbol (nil, t)
1507 ;;;; Environment Options
1508 ;;
1509 ;; Environment options encompass all parameters defined outside the
1510 ;; scope of the parsed data. They come from five sources, in
1511 ;; increasing precedence order:
1512 ;;
1513 ;; - Global variables,
1514 ;; - Buffer's attributes,
1515 ;; - Options keyword symbols,
1516 ;; - Buffer keywords,
1517 ;; - Subtree properties.
1518 ;;
1519 ;; The central internal function with regards to environment options
1520 ;; is `org-export-get-environment'. It updates global variables with
1521 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1522 ;; the different sources.
1523 ;;
1524 ;; The internal functions doing the retrieval are:
1525 ;; `org-export--get-global-options',
1526 ;; `org-export--get-buffer-attributes',
1527 ;; `org-export--parse-option-keyword',
1528 ;; `org-export--get-subtree-options' and
1529 ;; `org-export--get-inbuffer-options'
1530 ;;
1531 ;; Also, `org-export--list-bound-variables' collects bound variables
1532 ;; along with their value in order to set them as buffer local
1533 ;; variables later in the process.
1536 "Collect export options from the current buffer.
1538 Optional argument BACKEND is an export back-end, as returned by
1539 `org-export-create-backend'.
1541 When optional argument SUBTREEP is non-nil, assume the export is
1542 done against the current sub-tree.
1544 Third optional argument EXT-PLIST is a property list with
1545 external parameters overriding Org default settings, but still
1546 inferior to file-local settings."
1547 ;; First install #+BIND variables since these must be set before
1548 ;; global options are read.
1551 ;; Get and prioritize export options...
1553 ;; ... from global variables...
1555 ;; ... from an external property list...
1556 ext-plist
1557 ;; ... from in-buffer settings...
1559 ;; ... and from subtree, when appropriate.
1561 ;; Eventually add misc. properties.
1563 :back-end
1564 backend
1566 :footnote-definition-alist
1567 ;; Footnotes definitions must be collected in the original
1568 ;; buffer, as there's no insurance that they will still be in
1569 ;; the parse tree, due to possible narrowing.
1583 alist))))
1584 alist))
1585 :id-alist
1586 ;; Collect id references.
1597 alist))))
1600 "Parse an OPTIONS line and return values as a plist.
1601 Optional argument BACKEND is an export back-end, as returned by,
1602 e.g., `org-export-create-backend'. It specifies which back-end
1603 specific items to read, if any."
1605 ;; Priority is given to back-end specific options.
1607 org-export-options-alist))
1608 plist)
1617 options))
1619 property
1622 plist))
1625 "Get export options in subtree at point.
1626 Optional argument BACKEND is an export back-end, as returned by,
1627 e.g., `org-export-create-backend'. It specifies back-end used
1628 for export. Return options as a plist."
1629 ;; For each buffer keyword, create a headline property setting the
1630 ;; same property in communication channel. The name for the property
1631 ;; is the keyword with "EXPORT_" appended to it.
1634 ;; Make sure point is at a heading.
1636 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1637 ;; title as its fallback value.
1643 plist :title
1646 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1650 ;; Handle other keywords. TITLE keyword is excluded as it has
1651 ;; been handled already.
1659 ;; Export properties are not case-sensitive.
1666 plist
1667 property
1669 ;; Parse VALUE if required.
1673 ;; If BEHAVIOUR is `split' expected value is
1674 ;; a list of strings, not a string.
1677 ;; Look for both general keywords and back-end specific
1678 ;; options, with priority given to the latter.
1680 org-export-options-alist)))
1681 ;; Return value.
1682 plist)))
1685 "Return current buffer export options, as a plist.
1687 Optional argument BACKEND, when non-nil, is an export back-end,
1688 as returned by, e.g., `org-export-create-backend'. It specifies
1689 which back-end specific options should also be read in the
1690 process.
1692 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1694 get-options ; For byte-compiler.
1697 ;; Priority is given to back-end specific options.
1699 org-export-options-alist))
1702 org-export-special-keywords))))
1705 ;; Return all properties associated to KEYWORD.
1712 ;; Recursively read keywords in buffer. FILES is a list
1713 ;; of files read so far. PLIST is the current property
1714 ;; list obtained.
1723 ;; Options in `org-export-special-keywords'.
1727 ;; Avoid circular dependencies.
1737 plist
1742 plist
1748 ;; Options in `org-export-options-alist'.
1753 plist property
1754 ;; Handle value depending on specified
1755 ;; BEHAVIOUR.
1761 " "
1774 ;; Return final value.
1775 plist))))
1776 ;; Read options in the current buffer.
1779 ;; Parse keywords specified in `org-element-document-properties'
1780 ;; and return PLIST.
1791 "Return properties related to buffer attributes, as a plist."
1792 ;; Store full path of input file name, or nil. For internal use.
1795 :input-file visited-file
1801 "Return global export options as a plist.
1802 Optional argument BACKEND, if non-nil, is an export back-end, as
1803 returned by, e.g., `org-export-create-backend'. It specifies
1804 which back-end specific export options should also be read in the
1805 process."
1807 ;; Priority is given to back-end specific options.
1809 org-export-options-alist)))
1816 plist
1817 prop
1818 ;; Eval default value provided. If keyword is
1819 ;; a member of `org-element-document-properties',
1820 ;; parse it as a secondary string before storing it.
1827 value)))))))))))
1830 "Return variables bound from BIND keywords in current buffer.
1831 Also look for BIND keywords in setup files. The return value is
1832 an alist where associations are (VARIABLE-NAME VALUE)."
1837 ;; Return an alist between variable names and their
1838 ;; value. FILES is a list of setup files names read so
1839 ;; far, used to avoid circular dependencies. ALIST is
1840 ;; the alist collected so far.
1851 ;; Enter setup file.
1861 alist))))))))))
1862 alist)))))
1863 ;; Return value in appropriate order of appearance.
1867 ;;;; Tree Properties
1868 ;;
1869 ;; Tree properties are information extracted from parse tree. They
1870 ;; are initialized at the beginning of the transcoding process by
1871 ;; `org-export-collect-tree-properties'.
1872 ;;
1873 ;; Dedicated functions focus on computing the value of specific tree
1874 ;; properties during initialization. Thus,
1875 ;; `org-export--populate-ignore-list' lists elements and objects that
1876 ;; should be skipped during export, `org-export--get-min-level' gets
1877 ;; the minimal exportable level, used as a basis to compute relative
1878 ;; level for headlines. Eventually
1879 ;; `org-export--collect-headline-numbering' builds an alist between
1880 ;; headlines and their numbering.
1883 "Extract tree properties from parse tree.
1885 DATA is the parse tree from which information is retrieved. INFO
1886 is a list holding export options.
1888 Following tree properties are set or updated:
1890 `:exported-data' Hash table used to memoize results from
1891 `org-export-data'.
1893 `:footnote-definition-alist' List of footnotes definitions in
1894 original buffer and current parse tree.
1896 `:headline-offset' Offset between true level of headlines and
1897 local level. An offset of -1 means a headline
1898 of level 2 should be considered as a level
1899 1 headline in the context.
1901 `:headline-numbering' Alist of all headlines as key an the
1902 associated numbering as value.
1904 `:ignore-list' List of elements that should be ignored during
1905 export.
1907 Return updated plist."
1908 ;; Install the parse tree in the communication channel, in order to
1909 ;; use `org-export-get-genealogy' and al.
1911 ;; Get the list of elements and objects to ignore, and put it into
1912 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1913 ;; been done during parse tree filtering.
1916 :ignore-list
1919 ;; Compute `:headline-offset' in order to be able to use
1920 ;; `org-export-get-relative-level'.
1923 :headline-offset
1925 ;; Update footnotes definitions list with definitions in parse tree.
1926 ;; This is required since buffer expansion might have modified
1927 ;; boundaries of footnote definitions contained in the parse tree.
1928 ;; This way, definitions in `footnote-definition-alist' are bound to
1929 ;; match those in the parse tree.
1935 defs)))
1937 ;; Properties order doesn't matter: get the rest of the tree
1938 ;; properties.
1942 info))
1945 "Return minimum exportable headline's level in DATA.
1946 DATA is parsed tree as returned by `org-element-parse-buffer'.
1947 OPTIONS is a plist holding export options."
1958 ;; If no headline was found, for the sake of consistency, set
1959 ;; minimum level to 1 nonetheless.
1963 "Return numbering of all exportable headlines in a parse tree.
1965 DATA is the parse tree. OPTIONS is the plist holding export
1966 options.
1968 Return an alist whose key is a headline and value is its
1969 associated numbering \(in the shape of a list of numbers\) or nil
1970 for a footnotes section."
1978 headline
1980 for idx from 0 to org-export-max-depth
1984 options)))
1987 "Return list of elements and objects to ignore during export.
1988 DATA is the parse tree to traverse. OPTIONS is the plist holding
1989 export options."
1991 ;; First find trees containing a select tag, if any.
1993 ;; If a select tag is active, also ignore the section before
1994 ;; the first headline, if any.
1998 first-element))))
2001 ;; Collect ignored elements or objects into IGNORE-LIST.
2007 ;; If headline is archived but tree below has
2008 ;; to be skipped, add it to ignore list.
2011 ;; Move into secondary string, if any.
2016 ;; Move into recursive objects/elements.
2018 ;; Main call.
2020 ;; Return value.
2021 ignore))
2024 "Return list of headlines and inlinetasks with a select tag in their tree.
2025 DATA is parsed data as returned by `org-element-parse-buffer'.
2026 INFO is a plist holding export options."
2028 walk-data ; For byte-compiler.
2038 ;; When a select tag is found, mark full
2039 ;; genealogy and every headline within the tree
2040 ;; as acceptable.
2043 genealogy
2046 selected-trees))
2047 ;; If at a headline, continue searching in tree,
2048 ;; recursively.
2058 selected-trees))
2061 "Non-nil when element or object BLOB should be skipped during export.
2062 OPTIONS is the plist holding export options. SELECTED, when
2063 non-nil, is a list of headlines or inlinetasks belonging to
2064 a tree with a select tag."
2071 ;; If `:with-drawers' value starts with `not', ignore
2072 ;; every drawer whose name belong to that list.
2073 ;; Otherwise, ignore drawers whose name isn't in that
2074 ;; list.
2090 ;; Ignore subtrees with an exclude tag.
2093 ;; When a select tag is present in the buffer, ignore any tree
2094 ;; without it.
2096 ;; Ignore commented sub-trees.
2098 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2100 ;; Ignore tasks, if specified by `:with-tasks' property.
2112 properties-set))))))
2122 ;; `:with-timestamps' only applies to isolated timestamps
2123 ;; objects, i.e. timestamp objects in a paragraph containing only
2124 ;; timestamps and whitespaces.
2132 options t))))
2141 \f
2142 ;;; The Transcoder
2143 ;;
2144 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2145 ;; `org-element-parse-buffer') and transcodes it into a specified
2146 ;; back-end output. It takes care of filtering out elements or
2147 ;; objects according to export options and organizing the output blank
2148 ;; lines and white space are preserved. The function memoizes its
2149 ;; results, so it is cheap to call it within transcoders.
2150 ;;
2151 ;; It is possible to modify locally the back-end used by
2152 ;; `org-export-data' or even use a temporary back-end by using
2153 ;; `org-export-data-with-backend'.
2154 ;;
2155 ;; Internally, three functions handle the filtering of objects and
2156 ;; elements during the export. In particular,
2157 ;; `org-export-ignore-element' marks an element or object so future
2158 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2159 ;; elements or objects should be seen as real Org syntax and
2160 ;; `org-export-expand' transforms the others back into their original
2161 ;; shape
2162 ;;
2163 ;; `org-export-transcoder' is an accessor returning appropriate
2164 ;; translator function for a given element or object.
2167 "Return appropriate transcoder for BLOB.
2168 INFO is a plist containing export directives."
2170 ;; Return contents only for complete parse trees.
2176 "Convert DATA into current back-end format.
2178 DATA is a parse tree, an element or an object or a secondary
2179 string. INFO is a plist holding export options.
2181 Return transcoded string."
2187 ;; Ignored element/object.
2189 ;; Plain text.
2195 info))
2196 ;; Uninterpreted element/object: change it back to Org
2197 ;; syntax and export again resulting raw string.
2201 data
2205 info))
2206 ;; Secondary string.
2209 ;; Element/Object without contents or, as a special case,
2210 ;; headline with archive tag and archived trees restricted
2211 ;; to title only.
2219 ;; Export snippets never return a nil value so
2220 ;; that white spaces following them are never
2221 ;; ignored.
2223 ;; Element/Object with contents.
2236 ;; Elements directly containing objects
2237 ;; must have their indentation normalized
2238 ;; first.
2240 data
2241 ;; When normalizing contents of the first
2242 ;; paragraph in an item or a footnote
2243 ;; definition, ignore first line's
2244 ;; indentation: there is none and it
2245 ;; might be misleading.
2250 data)
2257 info))))))))
2258 ;; Final result will be memoized before being returned.
2260 data
2264 ;; Append the same white space between elements or objects as in
2265 ;; the original buffer, and call appropriate filters.
2276 info)))
2277 results)))
2281 "Convert DATA into BACKEND format.
2283 DATA is an element, an object, a secondary string or a string.
2284 BACKEND is a symbol. INFO is a plist used as a communication
2285 channel.
2287 Unlike to `org-export-with-backend', this function will
2288 recursively convert DATA using BACKEND translation table."
2291 data
2292 ;; Set-up a new communication channel with translations defined in
2293 ;; BACKEND as the translate table and a new hash table for
2294 ;; memoization.
2296 info
2299 ;; Size of the hash table is reduced since this function
2300 ;; will probably be used on small trees.
2304 "Non-nil if element or object BLOB should be interpreted during export.
2305 If nil, BLOB will appear as raw Org syntax. Check is done
2306 according to export options INFO, stored as a plist."
2308 ;; ... entities...
2310 ;; ... emphasis...
2313 ;; ... fixed-width areas.
2315 ;; ... LaTeX environments and fragments...
2319 ;; ... sub/superscripts...
2325 ;; ... tables...
2330 "Expand a parsed element or object to its original state.
2332 BLOB is either an element or an object. CONTENTS is its
2333 contents, as a string or nil.
2335 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2336 keywords before output."
2341 blob contents))))
2344 "Add ELEMENT to `:ignore-list' in INFO.
2346 Any element in `:ignore-list' will be skipped when using
2347 `org-element-map'. INFO is modified by side effects."
2351 \f
2352 ;;; The Filter System
2353 ;;
2354 ;; Filters allow end-users to tweak easily the transcoded output.
2355 ;; They are the functional counterpart of hooks, as every filter in
2356 ;; a set is applied to the return value of the previous one.
2357 ;;
2358 ;; Every set is back-end agnostic. Although, a filter is always
2359 ;; called, in addition to the string it applies to, with the back-end
2360 ;; used as argument, so it's easy for the end-user to add back-end
2361 ;; specific filters in the set. The communication channel, as
2362 ;; a plist, is required as the third argument.
2363 ;;
2364 ;; From the developer side, filters sets can be installed in the
2365 ;; process with the help of `org-export-define-backend', which
2366 ;; internally stores filters as an alist. Each association has a key
2367 ;; among the following symbols and a function or a list of functions
2368 ;; as value.
2369 ;;
2370 ;; - `:filter-options' applies to the property list containing export
2371 ;; options. Unlike to other filters, functions in this list accept
2372 ;; two arguments instead of three: the property list containing
2373 ;; export options and the back-end. Users can set its value through
2374 ;; `org-export-filter-options-functions' variable.
2375 ;;
2376 ;; - `:filter-parse-tree' applies directly to the complete parsed
2377 ;; tree. Users can set it through
2378 ;; `org-export-filter-parse-tree-functions' variable.
2379 ;;
2380 ;; - `:filter-final-output' applies to the final transcoded string.
2381 ;; Users can set it with `org-export-filter-final-output-functions'
2382 ;; variable
2383 ;;
2384 ;; - `:filter-plain-text' applies to any string not recognized as Org
2385 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2386 ;; configure it.
2387 ;;
2388 ;; - `:filter-TYPE' applies on the string returned after an element or
2389 ;; object of type TYPE has been transcoded. A user can modify
2390 ;; `org-export-filter-TYPE-functions'
2391 ;;
2392 ;; All filters sets are applied with
2393 ;; `org-export-filter-apply-functions' function. Filters in a set are
2394 ;; applied in a LIFO fashion. It allows developers to be sure that
2395 ;; their filters will be applied first.
2396 ;;
2397 ;; Filters properties are installed in communication channel with
2398 ;; `org-export-install-filters' function.
2399 ;;
2400 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2401 ;; `org-export-before-parsing-hook') are run at the beginning of the
2402 ;; export process and just before parsing to allow for heavy structure
2403 ;; modifications.
2406 ;;;; Hooks
2409 "Hook run at the beginning of the export process.
2411 This is run before include keywords and macros are expanded and
2412 Babel code blocks executed, on a copy of the original buffer
2413 being exported. Visibility and narrowing are preserved. Point
2414 is at the beginning of the buffer.
2416 Every function in this hook will be called with one argument: the
2420 "Hook run before parsing an export buffer.
2422 This is run after include keywords and macros have been expanded
2423 and Babel code blocks executed, on a copy of the original buffer
2424 being exported. Visibility and narrowing are preserved. Point
2425 is at the beginning of the buffer.
2427 Every function in this hook will be called with one argument: the
2431 ;;;; Special Filters
2434 "List of functions applied to the export options.
2435 Each filter is called with two arguments: the export options, as
2436 a plist, and the back-end, as a symbol. It must return
2440 "List of functions applied to the parsed tree.
2441 Each filter is called with three arguments: the parse tree, as
2442 returned by `org-element-parse-buffer', the back-end, as
2443 a symbol, and the communication channel, as a plist. It must
2447 "List of functions applied to plain text.
2448 Each filter is called with three arguments: a string which
2449 contains no Org syntax, the back-end, as a symbol, and the
2450 communication channel, as a plist. It must return a string or
2454 "List of functions applied to the transcoded string.
2455 Each filter is called with three arguments: the full transcoded
2456 string, the back-end, as a symbol, and the communication channel,
2457 as a plist. It must return a string that will be used as the
2461 ;;;; Elements Filters
2464 "List of functions applied to a transcoded babel-call.
2465 Each filter is called with three arguments: the transcoded data,
2466 as a string, the back-end, as a symbol, and the communication
2470 "List of functions applied to a transcoded center block.
2471 Each filter is called with three arguments: the transcoded data,
2472 as a string, the back-end, as a symbol, and the communication
2476 "List of functions applied to a transcoded clock.
2477 Each filter is called with three arguments: the transcoded data,
2478 as a string, the back-end, as a symbol, and the communication
2482 "List of functions applied to a transcoded comment.
2483 Each filter is called with three arguments: the transcoded data,
2484 as a string, the back-end, as a symbol, and the communication
2488 "List of functions applied to a transcoded comment-block.
2489 Each filter is called with three arguments: the transcoded data,
2490 as a string, the back-end, as a symbol, and the communication
2494 "List of functions applied to a transcoded diary-sexp.
2495 Each filter is called with three arguments: the transcoded data,
2496 as a string, the back-end, as a symbol, and the communication
2500 "List of functions applied to a transcoded drawer.
2501 Each filter is called with three arguments: the transcoded data,
2502 as a string, the back-end, as a symbol, and the communication
2506 "List of functions applied to a transcoded dynamic-block.
2507 Each filter is called with three arguments: the transcoded data,
2508 as a string, the back-end, as a symbol, and the communication
2512 "List of functions applied to a transcoded example-block.
2513 Each filter is called with three arguments: the transcoded data,
2514 as a string, the back-end, as a symbol, and the communication
2518 "List of functions applied to a transcoded export-block.
2519 Each filter is called with three arguments: the transcoded data,
2520 as a string, the back-end, as a symbol, and the communication
2524 "List of functions applied to a transcoded fixed-width.
2525 Each filter is called with three arguments: the transcoded data,
2526 as a string, the back-end, as a symbol, and the communication
2530 "List of functions applied to a transcoded footnote-definition.
2531 Each filter is called with three arguments: the transcoded data,
2532 as a string, the back-end, as a symbol, and the communication
2536 "List of functions applied to a transcoded headline.
2537 Each filter is called with three arguments: the transcoded data,
2538 as a string, the back-end, as a symbol, and the communication
2542 "List of functions applied to a transcoded horizontal-rule.
2543 Each filter is called with three arguments: the transcoded data,
2544 as a string, the back-end, as a symbol, and the communication
2548 "List of functions applied to a transcoded inlinetask.
2549 Each filter is called with three arguments: the transcoded data,
2550 as a string, the back-end, as a symbol, and the communication
2554 "List of functions applied to a transcoded item.
2555 Each filter is called with three arguments: the transcoded data,
2556 as a string, the back-end, as a symbol, and the communication
2560 "List of functions applied to a transcoded keyword.
2561 Each filter is called with three arguments: the transcoded data,
2562 as a string, the back-end, as a symbol, and the communication
2566 "List of functions applied to a transcoded latex-environment.
2567 Each filter is called with three arguments: the transcoded data,
2568 as a string, the back-end, as a symbol, and the communication
2572 "List of functions applied to a transcoded node-property.
2573 Each filter is called with three arguments: the transcoded data,
2574 as a string, the back-end, as a symbol, and the communication
2578 "List of functions applied to a transcoded paragraph.
2579 Each filter is called with three arguments: the transcoded data,
2580 as a string, the back-end, as a symbol, and the communication
2584 "List of functions applied to a transcoded plain-list.
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 a transcoded planning.
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 property-drawer.
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 quote block.
2603 Each filter is called with three arguments: the transcoded quote
2604 data, as a string, the back-end, as a symbol, and the
2605 communication channel, as a plist. It must return a string or
2609 "List of functions applied to a transcoded quote-section.
2610 Each filter is called with three arguments: the transcoded data,
2611 as a string, the back-end, as a symbol, and the communication
2615 "List of functions applied to a transcoded section.
2616 Each filter is called with three arguments: the transcoded data,
2617 as a string, the back-end, as a symbol, and the communication
2621 "List of functions applied to a transcoded special block.
2622 Each filter is called with three arguments: the transcoded data,
2623 as a string, the back-end, as a symbol, and the communication
2627 "List of functions applied to a transcoded src-block.
2628 Each filter is called with three arguments: the transcoded data,
2629 as a string, the back-end, as a symbol, and the communication
2633 "List of functions applied to a transcoded table.
2634 Each filter is called with three arguments: the transcoded data,
2635 as a string, the back-end, as a symbol, and the communication
2639 "List of functions applied to a transcoded table-cell.
2640 Each filter is called with three arguments: the transcoded data,
2641 as a string, the back-end, as a symbol, and the communication
2645 "List of functions applied to a transcoded table-row.
2646 Each filter is called with three arguments: the transcoded data,
2647 as a string, the back-end, as a symbol, and the communication
2651 "List of functions applied to a transcoded verse block.
2652 Each filter is called with three arguments: the transcoded data,
2653 as a string, the back-end, as a symbol, and the communication
2657 ;;;; Objects Filters
2660 "List of functions applied to transcoded bold text.
2661 Each filter is called with three arguments: the transcoded data,
2662 as a string, the back-end, as a symbol, and the communication
2666 "List of functions applied to transcoded code text.
2667 Each filter is called with three arguments: the transcoded data,
2668 as a string, the back-end, as a symbol, and the communication
2672 "List of functions applied to a transcoded entity.
2673 Each filter is called with three arguments: the transcoded data,
2674 as a string, the back-end, as a symbol, and the communication
2678 "List of functions applied to a transcoded export-snippet.
2679 Each filter is called with three arguments: the transcoded data,
2680 as a string, the back-end, as a symbol, and the communication
2684 "List of functions applied to a transcoded footnote-reference.
2685 Each filter is called with three arguments: the transcoded data,
2686 as a string, the back-end, as a symbol, and the communication
2690 "List of functions applied to a transcoded inline-babel-call.
2691 Each filter is called with three arguments: the transcoded data,
2692 as a string, the back-end, as a symbol, and the communication
2696 "List of functions applied to a transcoded inline-src-block.
2697 Each filter is called with three arguments: the transcoded data,
2698 as a string, the back-end, as a symbol, and the communication
2702 "List of functions applied to transcoded italic text.
2703 Each filter is called with three arguments: the transcoded data,
2704 as a string, the back-end, as a symbol, and the communication
2708 "List of functions applied to a transcoded latex-fragment.
2709 Each filter is called with three arguments: the transcoded data,
2710 as a string, the back-end, as a symbol, and the communication
2714 "List of functions applied to a transcoded line-break.
2715 Each filter is called with three arguments: the transcoded data,
2716 as a string, the back-end, as a symbol, and the communication
2720 "List of functions applied to a transcoded link.
2721 Each filter is called with three arguments: the transcoded data,
2722 as a string, the back-end, as a symbol, and the communication
2726 "List of functions applied to a transcoded radio-target.
2727 Each filter is called with three arguments: the transcoded data,
2728 as a string, the back-end, as a symbol, and the communication
2732 "List of functions applied to a transcoded statistics-cookie.
2733 Each filter is called with three arguments: the transcoded data,
2734 as a string, the back-end, as a symbol, and the communication
2738 "List of functions applied to transcoded strike-through text.
2739 Each filter is called with three arguments: the transcoded data,
2740 as a string, the back-end, as a symbol, and the communication
2744 "List of functions applied to a transcoded subscript.
2745 Each filter is called with three arguments: the transcoded data,
2746 as a string, the back-end, as a symbol, and the communication
2750 "List of functions applied to a transcoded superscript.
2751 Each filter is called with three arguments: the transcoded data,
2752 as a string, the back-end, as a symbol, and the communication
2756 "List of functions applied to a transcoded target.
2757 Each filter is called with three arguments: the transcoded data,
2758 as a string, the back-end, as a symbol, and the communication
2762 "List of functions applied to a transcoded timestamp.
2763 Each filter is called with three arguments: the transcoded data,
2764 as a string, the back-end, as a symbol, and the communication
2768 "List of functions applied to transcoded underline text.
2769 Each filter is called with three arguments: the transcoded data,
2770 as a string, the back-end, as a symbol, and the communication
2774 "List of functions applied to transcoded verbatim text.
2775 Each filter is called with three arguments: the transcoded data,
2776 as a string, the back-end, as a symbol, and the communication
2780 ;;;; Filters Tools
2781 ;;
2782 ;; Internal function `org-export-install-filters' installs filters
2783 ;; hard-coded in back-ends (developer filters) and filters from global
2784 ;; variables (user filters) in the communication channel.
2785 ;;
2786 ;; Internal function `org-export-filter-apply-functions' takes care
2787 ;; about applying each filter in order to a given data. It ignores
2788 ;; filters returning a nil value but stops whenever a filter returns
2789 ;; an empty string.
2792 "Call every function in FILTERS.
2794 Functions are called with arguments VALUE, current export
2795 back-end's name and INFO. A function returning a nil value will
2796 be skipped. If it returns the empty string, the process ends and
2797 VALUE is ignored.
2799 Call is done in a LIFO fashion, to be sure that developer
2800 specified filters, if any, are called first."
2811 "Install filters properties in communication channel.
2812 INFO is a plist containing the current communication channel.
2813 Return the updated communication channel."
2815 ;; Install user-defined filters with `org-export-filters-alist'
2816 ;; and filters already in INFO (through ext-plist mechanism).
2823 ;; Filters in INFO will be called
2824 ;; before those user provided.
2827 default-value)))))
2828 org-export-filters-alist)
2829 ;; Prepend back-end specific filters to that list.
2831 ;; Single values get consed, lists are appended.
2836 plist key
2840 ;; Return new communication channel.
2844 \f
2845 ;;; Core functions
2846 ;;
2847 ;; This is the room for the main function, `org-export-as', along with
2848 ;; its derivative, `org-export-string-as'.
2849 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2850 ;; function should be added to kill ring.
2851 ;;
2852 ;; Note that `org-export-as' doesn't really parse the current buffer,
2853 ;; but a copy of it (with the same buffer-local variables and
2854 ;; visibility), where macros and include keywords are expanded and
2855 ;; Babel blocks are executed, if appropriate.
2856 ;; `org-export-with-buffer-copy' macro prepares that copy.
2857 ;;
2858 ;; File inclusion is taken care of by
2859 ;; `org-export-expand-include-keyword' and
2860 ;; `org-export--prepare-file-contents'. Structure wise, including
2861 ;; a whole Org file in a buffer often makes little sense. For
2862 ;; example, if the file contains a headline and the include keyword
2863 ;; was within an item, the item should contain the headline. That's
2864 ;; why file inclusion should be done before any structure can be
2865 ;; associated to the file, that is before parsing.
2866 ;;
2867 ;; `org-export-insert-default-template' is a command to insert
2868 ;; a default template (or a back-end specific template) at point or in
2869 ;; current subtree.
2872 "Return a copy of the current buffer.
2873 The copy preserves Org buffer-local variables, visibility and
2874 narrowing."
2880 new-buf))
2883 "Apply BODY in a copy of the current buffer.
2884 The copy preserves local variables, visibility and contents of
2885 the original buffer. Point is at the beginning of the buffer
2886 when BODY is applied."
2895 ;; Kill copy without confirmation.
2901 "Generate a function duplicating BUFFER.
2903 The copy will preserve local variables, visibility, contents and
2904 narrowing of the original buffer. If a region was active in
2905 BUFFER, contents will be narrowed to that region instead.
2907 The resulting function can be evaled at a later time, from
2908 another buffer, effectively cloning the original buffer there.
2910 The function assumes BUFFER's major mode is `org-mode'."
2914 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2915 ;; already in BUFFER.
2917 ;; Copy specific buffer local variables and variables set
2918 ;; through BIND keywords.
2920 vars)
2928 buffer-file-name
2929 buffer-file-coding-system))
2933 ;; Skip unreadable values, as they cannot be
2934 ;; sent to external process.
2938 vars))))))
2939 ;; Whole buffer contents.
2944 ;; Narrowing.
2948 ;; Current position of point.
2950 ;; Overlays with invisible property.
2960 ov-set))))
2962 ov-set)))))
2964 ;;;###autoload
2967 "Transcode current Org buffer into BACKEND code.
2969 BACKEND is either an export back-end, as returned by, e.g.,
2970 `org-export-create-backend', or a symbol referring to
2971 a registered back-end.
2973 If narrowing is active in the current buffer, only transcode its
2974 narrowed part.
2976 If a region is active, transcode that region.
2978 When optional argument SUBTREEP is non-nil, transcode the
2979 sub-tree at point, extracting information from the headline
2980 properties first.
2982 When optional argument VISIBLE-ONLY is non-nil, don't export
2983 contents of hidden elements.
2985 When optional argument BODY-ONLY is non-nil, only return body
2986 code, without surrounding template.
2988 Optional argument EXT-PLIST, when provided, is a property list
2989 with external parameters overriding Org default settings, but
2990 still inferior to file-local settings.
2992 Return code as a string."
2997 ;; Narrow buffer to an appropriate region or subtree for
2998 ;; parsing. If parsing subtree, be sure to remove main headline
2999 ;; too.
3007 ;; Initialize communication channel with original buffer
3008 ;; attributes, unavailable in its copy.
3017 tree)
3018 ;; Update communication channel and get parse tree. Buffer
3019 ;; isn't parsed directly. Instead, a temporary copy is
3020 ;; created, where include keywords, macros are expanded and
3021 ;; code blocks are evaluated.
3023 ;; Run first hook with current back-end's name as argument.
3027 ;; Update macro templates since #+INCLUDE keywords might have
3028 ;; added some new ones.
3032 ;; Update radio targets since keyword inclusion might have
3033 ;; added some more.
3035 ;; Run last hook with current back-end's name as argument.
3040 ;; Update communication channel with environment. Also
3041 ;; install user's and developer's filters.
3046 ;; Expand export-specific set of macros: {{{author}}},
3047 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3048 ;; once regular macros have been expanded, since document
3049 ;; keywords may contain one of them.
3055 ;; EMAIL is not a parsed keyword: store it as-is.
3059 ;; Call options filters and update export options. We do not
3060 ;; use `org-export-filter-apply-functions' here since the
3061 ;; arity of such filters is different.
3066 ;; Parse buffer and call parse-tree filter on it.
3071 ;; Now tree is complete, compute its properties and add them
3072 ;; to communication channel.
3076 ;; Eventually transcode TREE. Wrap the resulting string into
3077 ;; a template.
3086 ;; Remove all text properties since they cannot be
3087 ;; retrieved from an external process. Finally call
3088 ;; final-output filter and return result.
3094 info))))))))
3096 ;;;###autoload
3098 "Transcode STRING into BACKEND code.
3100 BACKEND is either an export back-end, as returned by, e.g.,
3101 `org-export-create-backend', or a symbol referring to
3102 a registered back-end.
3104 When optional argument BODY-ONLY is non-nil, only return body
3105 code, without preamble nor postamble.
3107 Optional argument EXT-PLIST, when provided, is a property list
3108 with external parameters overriding Org default settings, but
3109 still inferior to file-local settings.
3111 Return code as a string."
3117 ;;;###autoload
3119 "Replace the active region by its export to BACKEND.
3120 BACKEND is either an export back-end, as returned by, e.g.,
3121 `org-export-create-backend', or a symbol referring to
3122 a registered back-end."
3132 ;;;###autoload
3134 "Insert all export keywords with default values at beginning of line.
3136 BACKEND is a symbol referring to the name of a registered export
3137 back-end, for which specific export options should be added to
3138 the template, or `default' for default template. When it is nil,
3139 the user will be prompted for a category.
3141 If SUBTREEP is non-nil, export configuration will be set up
3142 locally for the subtree through node properties."
3152 "Options category: "
3156 org-export--registered-backends))))))
3157 options keywords)
3158 ;; Populate OPTIONS and KEYWORDS.
3175 ;; Move to an appropriate location in order to insert options.
3177 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3178 ;; list of available keywords.
3206 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3224 ;; And the rest of keywords.
3235 "Expand every include keyword in buffer.
3236 Optional argument INCLUDED is a list of included file names along
3237 with their line restriction, when appropriate. It is used to
3238 avoid infinite recursion. Optional argument DIR is the current
3239 working directory. It is used to properly resolve relative
3240 paths."
3247 ;; Extract arguments from keyword's value.
3255 dir)
3260 value)
3266 ;; Minimal level of included file defaults to the child
3267 ;; level of the current headline, if any, or one. It
3268 ;; only applies is the file is meant to be included as
3269 ;; an Org one.
3277 ;; Remove keyword.
3283 ;; Check if files has already been parsed. Look after
3284 ;; inclusion lines too, as different parts of the same file
3285 ;; can be included too.
3297 ind-str contents ind-str))))
3305 ind-str env contents ind-str))))
3318 "Prepare the contents of FILE for inclusion and return them as a string.
3320 When optional argument LINES is a string specifying a range of
3321 lines, include only those lines.
3323 Optional argument IND, when non-nil, is an integer specifying the
3324 global indentation of returned contents. Since its purpose is to
3325 allow an included file to stay in the same environment it was
3326 created \(i.e. a list item), it doesn't apply past the first
3327 headline encountered.
3329 Optional argument MINLEVEL, when non-nil, is an integer
3330 specifying the level that any top-level headline in the included
3331 file should have."
3347 ;; Remove blank lines at beginning and end of contents. The logic
3348 ;; behind that removal is that blank lines around include keyword
3349 ;; override blank lines in included file.
3358 ;; If IND is set, preserve indentation of include keyword until
3359 ;; the first headline encountered.
3366 ;; Do not move footnote definitions out of column 0.
3372 ;; When MINLEVEL is specified, compute minimal level for headlines
3373 ;; in the file (CUR-MIN), and remove stars to each headline so
3374 ;; that headlines with minimal level have a level of MINLEVEL.
3385 ;; Only change stars, don't bother moving whole
3386 ;; sections.
3393 "Execute every Babel code in the visible part of current buffer."
3394 ;; Get a pristine copy of current buffer so Babel references can be
3395 ;; properly resolved.
3402 "Return a non-nil value when output should be added to the kill ring.
3403 See also `org-export-copy-to-kill-ring'."
3409 \f
3410 ;;; Tools For Back-Ends
3411 ;;
3412 ;; A whole set of tools is available to help build new exporters. Any
3413 ;; function general enough to have its use across many back-ends
3414 ;; should be added here.
3416 ;;;; For Affiliated Keywords
3417 ;;
3418 ;; `org-export-read-attribute' reads a property from a given element
3419 ;; as a plist. It can be used to normalize affiliated keywords'
3420 ;; syntax.
3421 ;;
3422 ;; Since captions can span over multiple lines and accept dual values,
3423 ;; their internal representation is a bit tricky. Therefore,
3424 ;; `org-export-get-caption' transparently returns a given element's
3425 ;; caption as a secondary string.
3428 "Turn ATTRIBUTE property from ELEMENT into a plist.
3430 When optional argument PROPERTY is non-nil, return the value of
3431 that property within attributes.
3435 properties.
3437 All values will become strings except the empty string and
3440 will become the empty string."
3454 s)
3459 ;; Ignore any string before first property with `cdr'.
3464 "Return caption from ELEMENT as a secondary string.
3466 When optional argument SHORTP is non-nil, return short caption,
3467 as a secondary string, instead.
3469 Caption lines are separated by a white space."
3477 ;;;; For Derived Back-ends
3478 ;;
3479 ;; `org-export-with-backend' is a function allowing to locally use
3480 ;; another back-end to transcode some object or element. In a derived
3481 ;; back-end, it may be used as a fall-back function once all specific
3482 ;; cases have been treated.
3485 "Call a transcoder from BACKEND on DATA.
3486 BACKEND is an export back-end, as returned by, e.g.,
3487 `org-export-create-backend', or a symbol referring to
3488 a registered back-end. DATA is an Org element, object, secondary
3489 string or string. CONTENTS, when non-nil, is the transcoded
3490 contents of DATA element, as a string. INFO, when non-nil, is
3491 the communication channel used for export, as a plist."
3501 transcoder data contents
3504 :translate-alist all-transcoders
3508 ;;;; For Export Snippets
3509 ;;
3510 ;; Every export snippet is transmitted to the back-end. Though, the
3511 ;; latter will only retain one type of export-snippet, ignoring
3512 ;; others, based on the former's target back-end. The function
3513 ;; `org-export-snippet-backend' returns that back-end for a given
3514 ;; export-snippet.
3517 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3518 Translation, with `org-export-snippet-translation-alist', is
3519 applied."
3523 back-end))))
3526 ;;;; For Footnotes
3527 ;;
3528 ;; `org-export-collect-footnote-definitions' is a tool to list
3529 ;; actually used footnotes definitions in the whole parse tree, or in
3530 ;; a headline, in order to add footnote listings throughout the
3531 ;; transcoded data.
3532 ;;
3533 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3534 ;; back-ends, when they need to attach the footnote definition only to
3535 ;; the first occurrence of the corresponding label.
3536 ;;
3537 ;; `org-export-get-footnote-definition' and
3538 ;; `org-export-get-footnote-number' provide easier access to
3539 ;; additional information relative to a footnote reference.
3542 "Return an alist between footnote numbers, labels and definitions.
3544 DATA is the parse tree from which definitions are collected.
3545 INFO is the plist used as a communication channel.
3547 Definitions are sorted by order of references. They either
3548 appear as Org data or as a secondary string for inlined
3549 footnotes. Unreferenced definitions are ignored."
3551 collect-fn ; for byte-compiler.
3555 ;; Collect footnote number, label and definition in DATA.
3563 def)
3564 num-alist)
3565 ;; Also search in definition for nested footnotes.
3568 ;; Don't enter footnote definitions since it will happen
3569 ;; when their first reference is found.
3575 "Non-nil when a footnote reference is the first one for its label.
3577 FOOTNOTE-REFERENCE is the footnote reference being considered.
3578 INFO is the plist used as a communication channel."
3580 ;; Anonymous footnotes are always a first reference.
3582 ;; Otherwise, return the first footnote with the same LABEL and
3583 ;; test if it is equal to FOOTNOTE-REFERENCE.
3593 ;; If FN isn't inlined, be sure to traverse its
3594 ;; definition before resuming search. See
3595 ;; comments in `org-export-get-footnote-number'
3596 ;; for more information.
3600 ;; Don't enter footnote definitions since it will
3601 ;; happen when their first reference is found.
3604 footnote-reference)))))
3607 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3608 INFO is the plist used as a communication channel. If no such
3610 string."
3617 "Return number associated to a footnote.
3619 FOOTNOTE is either a footnote reference or a footnote definition.
3620 INFO is the plist used as a communication channel."
3622 seen-refs
3623 search-ref ; For byte-compiler.
3627 ;; Search footnote references through DATA, filling
3628 ;; SEEN-REFS along the way.
3633 ;; Anonymous footnote match: return number.
3636 ;; Labels match: return number.
3639 ;; Anonymous footnote: it's always a new one.
3640 ;; Also, be sure to return nil from the `cond' so
3641 ;; `first-match' doesn't get us out of the loop.
3643 ;; Label not seen so far: add it so SEEN-REFS.
3644 ;;
3645 ;; Also search for subsequent references in
3646 ;; footnote definition so numbering follows
3647 ;; reading logic. Note that we don't have to care
3648 ;; about inline definitions, since
3649 ;; `org-element-map' already traverses them at the
3650 ;; right time.
3651 ;;
3652 ;; Once again, return nil to stay in the loop.
3657 nil))))
3658 ;; Don't enter footnote definitions since it will
3659 ;; happen when their first reference is found.
3664 ;;;; For Headlines
3665 ;;
3666 ;; `org-export-get-relative-level' is a shortcut to get headline
3667 ;; level, relatively to the lower headline level in the parsed tree.
3668 ;;
3669 ;; `org-export-get-headline-number' returns the section number of an
3670 ;; headline, while `org-export-number-to-roman' allows to convert it
3671 ;; to roman numbers.
3672 ;;
3673 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3674 ;; `org-export-last-sibling-p' are three useful predicates when it
3675 ;; comes to fulfill the `:headline-levels' property.
3676 ;;
3677 ;; `org-export-get-tags', `org-export-get-category' and
3678 ;; `org-export-get-node-property' extract useful information from an
3679 ;; headline or a parent headline. They all handle inheritance.
3680 ;;
3681 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3682 ;; as a secondary string, suitable for table of contents. It falls
3683 ;; back onto default title.
3686 "Return HEADLINE relative level within current parsed tree.
3687 INFO is a plist holding contextual information."
3692 "Non-nil when HEADLINE is considered as low level.
3694 INFO is a plist used as a communication channel.
3696 A low level headlines has a relative level greater than
3697 `:headline-levels' property value.
3699 Return value is the difference between HEADLINE relative level
3700 and the last level being considered as high enough, or nil."
3707 "Return HEADLINE numbering as a list of numbers.
3708 INFO is a plist holding contextual information."
3712 "Return a non-nil value if HEADLINE element should be numbered.
3713 INFO is a plist used as a communication channel."
3719 "Convert integer N into a roman numeral."
3732 res)))
3735 "Return list of tags associated to ELEMENT.
3737 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3738 is a plist used as a communication channel.
3740 Select tags (see `org-export-select-tags') and exclude tags (see
3741 `org-export-exclude-tags') are removed from the list.
3743 When non-nil, optional argument TAGS should be a list of strings.
3744 Any tag belonging to this list will also be removed.
3746 When optional argument INHERITED is non-nil, tags can also be
3747 inherited from parent headlines and FILETAGS keywords."
3753 ;; Build complete list of inherited tags.
3764 ;; Add FILETAGS keywords and return results.
3768 "Return node PROPERTY value for BLOB.
3770 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3771 element or object.
3773 If optional argument INHERITED is non-nil, the value can be
3774 inherited from a parent headline.
3776 Return value is a string or nil."
3788 "Return category for element or object BLOB.
3790 INFO is a plist used as a communication channel.
3792 CATEGORY is automatically inherited from a parent headline, from
3793 #+CATEGORY: keyword or created out of original file name. If all
3797 ;; Almost like `org-export-node-property', but we cannot trust
3798 ;; `plist-member' as every headline has a `:CATEGORY'
3799 ;; property, would it be nil or equal to "???" (which has the
3800 ;; same meaning).
3818 "Return alternative title for HEADLINE, as a secondary string.
3819 INFO is a plist used as a communication channel. If no optional
3820 title is defined, fall-back to the regular title."
3825 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3826 INFO is a plist used as a communication channel."
3831 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3832 INFO is a plist used as a communication channel."
3836 ;;;; For Keywords
3837 ;;
3838 ;; `org-export-get-date' returns a date appropriate for the document
3839 ;; to about to be exported. In particular, it takes care of
3840 ;; `org-export-date-timestamp-format'.
3843 "Return date value for the current document.
3845 INFO is a plist used as a communication channel. FMT, when
3846 non-nil, is a time format string that will be applied on the date
3847 if it consists in a single timestamp object. It defaults to
3848 `org-export-date-timestamp-format' when nil.
3850 A proper date can be a secondary string, a string or nil. It is
3851 meant to be translated with `org-export-data' or alike."
3862 ;;;; For Links
3863 ;;
3864 ;; `org-export-solidify-link-text' turns a string into a safer version
3865 ;; for links, replacing most non-standard characters with hyphens.
3866 ;;
3867 ;; `org-export-get-coderef-format' returns an appropriate format
3868 ;; string for coderefs.
3869 ;;
3870 ;; `org-export-inline-image-p' returns a non-nil value when the link
3871 ;; provided should be considered as an inline image.
3872 ;;
3873 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3874 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3875 ;; returns an appropriate unique identifier when found, or nil.
3876 ;;
3877 ;; `org-export-resolve-id-link' returns the first headline with
3878 ;; specified id or custom-id in parse tree, the path to the external
3879 ;; file with the id or nil when neither was found.
3880 ;;
3881 ;; `org-export-resolve-coderef' associates a reference to a line
3882 ;; number in the element it belongs, or returns the reference itself
3883 ;; when the element isn't numbered.
3886 "Take link text S and make a safe target out of it."
3891 "Return format string for code reference link.
3892 PATH is the link path. DESC is its description."
3900 "Non-nil if LINK object points to an inline image.
3902 Optional argument is a set of RULES defining inline images. It
3903 is an alist where associations have the following shape:
3905 \(TYPE . REGEXP)
3907 Applying a rule means apply REGEXP against LINK's path when its
3908 type is TYPE. The function will return a non-nil value if any of
3909 the provided rules is non-nil. The default rule is
3910 `org-export-default-inline-image-rule'.
3912 This only applies to links without a description."
3923 rules)
3924 ;; Return nil if no rule matched.
3925 nil))))
3928 "Resolve a code reference REF.
3930 INFO is a plist used as a communication channel.
3932 Return associated line number in source code, or REF itself,
3933 depending on src-block or example element's switches."
3940 org-coderef-label-format)))
3944 ;; Element containing REF is found. Resolve it to either
3945 ;; a label or a line number, as needed.
3955 "Return LINK destination.
3957 INFO is a plist holding contextual information.
3959 Return value can be an object, an element, or nil:
3961 - If LINK path matches a target object (i.e. <<path>>) return it.
3963 - If LINK path exactly matches the name affiliated keyword
3964 \(i.e. #+NAME: path) of an element, return that element.
3966 - If LINK path exactly matches any headline name, return that
3967 element. If more than one headline share that name, priority
3968 will be given to the one with the closest common ancestor, if
3969 any, or the first one in the parse tree otherwise.
3971 - Otherwise, return nil.
3974 significant."
3977 ;; Split PATH at white spaces so matches are space
3978 ;; insensitive.
3981 ;; Cache for destinations that are not position dependent.
3989 ;; Destination is not position dependent: use cached value.
3991 ;; First try to find a matching "<<path>>" unless user specified
3992 ;; he was looking for a headline (path starts with a "*"
3993 ;; character).
3999 path)
4000 blob))
4003 ;; Then try to find an element with a matching "#+NAME: path"
4004 ;; affiliated keyword.
4007 org-element-all-elements
4012 el)))
4015 ;; Last case: link either points to a headline or to nothingness.
4016 ;; Try to find the source, with priority given to headlines with
4017 ;; the closest common ancestor. If such candidate is found,
4018 ;; return it, otherwise return nil.
4022 ;; Return first headline whose `:raw-value' property is
4023 ;; NAME in parse tree DATA, or nil. Statistics cookies
4024 ;; are ignored.
4032 name)
4033 headline))
4035 ;; Search among headlines sharing an ancestor with link, from
4036 ;; closest to farthest.
4045 ;; No destination found: return nil.
4049 "Return headline referenced as LINK destination.
4051 INFO is a plist used as a communication channel.
4053 Return value can be the headline element matched in current parse
4057 ;; First check if id is within the current parse tree.
4062 headline))
4064 ;; Otherwise, look for external files.
4068 "Return radio-target object referenced as LINK destination.
4070 INFO is a plist used as a communication channel.
4072 Return value can be a radio-target object or nil. Assume LINK
4081 nil nil path nil nil t)
4082 t)
4083 radio))
4087 ;;;; For References
4088 ;;
4089 ;; `org-export-get-ordinal' associates a sequence number to any object
4090 ;; or element.
4093 "Return ordinal number of an element or object.
4095 ELEMENT is the element or object considered. INFO is the plist
4096 used as a communication channel.
4098 Optional argument TYPES, when non-nil, is a list of element or
4099 object types, as symbols, that should also be counted in.
4100 Otherwise, only provided element's type is considered.
4102 Optional argument PREDICATE is a function returning a non-nil
4103 value if the current element or object should be counted in. It
4104 accepts two arguments: the element or object being considered and
4105 the plist used as a communication channel. This allows to count
4106 only a certain type of objects (i.e. inline images).
4108 Return value is a list of numbers if ELEMENT is a headline or an
4109 item. It is nil for keywords. It represents the footnote number
4110 for footnote definitions and footnote references. If ELEMENT is
4111 a target, return the same value as if ELEMENT was the closest
4112 table, item or headline containing the target. In any other
4113 case, return the sequence number of ELEMENT among elements or
4114 objects of the same type."
4115 ;; Ordinal of a target object refer to the ordinal of the closest
4116 ;; table, item, or headline containing the object.
4120 when
4124 table))
4125 return parent)))
4127 ;; Special case 1: A headline returns its number as a list.
4129 ;; Special case 2: An item returns its number as a list.
4133 struct
4140 ;; Increment counter until ELEMENT is found again.
4151 ;;;; For Src-Blocks
4152 ;;
4153 ;; `org-export-get-loc' counts number of code lines accumulated in
4154 ;; src-block or example-block elements with a "+n" switch until
4155 ;; a given element, excluded. Note: "-n" switches reset that count.
4156 ;;
4157 ;; `org-export-unravel-code' extracts source code (along with a code
4158 ;; references alist) from an `element-block' or `src-block' type
4159 ;; element.
4160 ;;
4161 ;; `org-export-format-code' applies a formatting function to each line
4162 ;; of code, providing relative line number and code reference when
4163 ;; appropriate. Since it doesn't access the original element from
4164 ;; which the source code is coming, it expects from the code calling
4165 ;; it to know if lines should be numbered and if code references
4166 ;; should appear.
4167 ;;
4168 ;; Eventually, `org-export-format-code-default' is a higher-level
4169 ;; function (it makes use of the two previous functions) which handles
4170 ;; line numbering and code references inclusion, and returns source
4171 ;; code in a format suitable for plain text or verbatim output.
4174 "Return accumulated lines of code up to ELEMENT.
4176 INFO is the plist used as a communication channel.
4178 ELEMENT is excluded from count."
4184 ;; ELEMENT is reached: Quit the loop.
4186 ;; Only count lines from src-block and example-block elements
4187 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4191 ;; Accumulate locs or reset them.
4195 ;; Return nil to stay in the loop.
4196 nil)))
4198 ;; Return value.
4199 loc))
4202 "Clean source code and extract references out of it.
4204 ELEMENT has either a `src-block' an `example-block' type.
4206 Return a cons cell whose CAR is the source code, cleaned from any
4207 reference, protective commas and spurious indentation, and CDR is
4208 an alist between relative line number (integer) and name of code
4209 reference on that line (string)."
4212 ;; Get code and clean it. Remove blank lines at its
4213 ;; beginning and end.
4220 value
4222 ;; Get format used for references.
4225 org-coderef-label-format)))
4226 ;; Build a regexp matching a loc with a reference.
4231 ;; Return value.
4233 ;; Code with references removed.
4239 ;; Ref line: remove ref, and signal its position in REFS.
4243 ;; Reference alist.
4244 refs)))
4247 "Format CODE by applying FUN line-wise and return it.
4249 CODE is a string representing the code to format. FUN is
4250 a function. It must accept three arguments: a line of
4251 code (string), the current line number (integer) or nil and the
4252 reference associated to the current line (string) or nil.
4254 Optional argument NUM-LINES can be an integer representing the
4255 number of code lines accumulated until the current code. Line
4256 numbers passed to FUN will take it into account. If it is nil,
4257 FUN's second argument will always be nil. This number can be
4258 obtained with `org-export-get-loc' function.
4260 Optional argument REF-ALIST can be an alist between relative line
4261 number (i.e. ignoring NUM-LINES) and the name of the code
4262 reference on it. If it is nil, FUN's third argument will always
4263 be nil. It can be obtained through the use of
4264 `org-export-unravel-code' function."
4276 "Return source code from ELEMENT, formatted in a standard way.
4278 ELEMENT is either a `src-block' or `example-block' element. INFO
4279 is a plist used as a communication channel.
4281 This function takes care of line numbering and code references
4282 inclusion. Line numbers, when applicable, appear at the
4283 beginning of the line, separated from the code by two white
4284 spaces. Code references, on the other hand, appear flushed to
4285 the right, separated by six white spaces from the widest line of
4286 code."
4287 ;; Extract code and references.
4294 ;; Handle line numbering.
4303 ;; Prepare references display, if required. Any reference
4304 ;; should start six columns after the widest line of code,
4305 ;; wrapped with parenthesis.
4310 code
4314 number-str
4315 loc
4321 num-start refs)))))
4324 ;;;; For Tables
4325 ;;
4326 ;; `org-export-table-has-special-column-p' and and
4327 ;; `org-export-table-row-is-special-p' are predicates used to look for
4328 ;; meta-information about the table structure.
4329 ;;
4330 ;; `org-table-has-header-p' tells when the rows before the first rule
4331 ;; should be considered as table's header.
4332 ;;
4333 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4334 ;; and `org-export-table-cell-borders' extract information from
4335 ;; a table-cell element.
4336 ;;
4337 ;; `org-export-table-dimensions' gives the number on rows and columns
4338 ;; in the table, ignoring horizontal rules and special columns.
4339 ;; `org-export-table-cell-address', given a table-cell object, returns
4340 ;; the absolute address of a cell. On the other hand,
4341 ;; `org-export-get-table-cell-at' does the contrary.
4342 ;;
4343 ;; `org-export-table-cell-starts-colgroup-p',
4344 ;; `org-export-table-cell-ends-colgroup-p',
4345 ;; `org-export-table-row-starts-rowgroup-p',
4346 ;; `org-export-table-row-ends-rowgroup-p',
4347 ;; `org-export-table-row-starts-header-p' and
4348 ;; `org-export-table-row-ends-header-p' indicate position of current
4349 ;; row or cell within the table.
4352 "Non-nil when TABLE has a special column.
4353 All special columns will be ignored during export."
4354 ;; The table has a special column when every first cell of every row
4355 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4356 ;; "*" "_" and "^". Though, do not consider a first row containing
4357 ;; only empty cells as special.
4373 "Non-nil when TABLE has a header.
4375 INFO is a plist used as a communication channel.
4377 A table has a header when it contains at least two row groups."
4386 table
4397 cache)))))
4400 "Non-nil if TABLE-ROW is considered special.
4402 INFO is a plist used as the communication channel.
4404 All special rows will be ignored during export."
4408 ;; A row is special either when...
4410 ;; ... it starts with a field only containing "/",
4412 ;; ... the table contains a special column and the row start
4413 ;; with a marking character among, "^", "_", "$" or "!",
4417 ;; ... it contains only alignment cookies and empty cells.
4423 ;; Since VALUE is a secondary string, the following
4424 ;; checks avoid expanding it with `org-export-data'.
4436 "Return TABLE-ROW's group number, as an integer.
4438 INFO is a plist used as the communication channel.
4440 Return value is the group number, as an integer, or nil for
4441 special rows and rows separators. First group is also table's
4442 header."
4460 "Return TABLE-CELL contents width.
4462 INFO is a plist used as the communication channel.
4464 Return value is the width given by the last width cookie in the
4465 same column as TABLE-CELL, or nil."
4484 ;; In a special row, try to find a width cookie at COLUMN.
4488 ;; The following checks avoid expanding unnecessarily
4489 ;; the cell with `org-export-data'.
4499 "Return TABLE-CELL contents alignment.
4501 INFO is a plist used as the communication channel.
4503 Return alignment as specified by the last alignment cookie in the
4504 same column as TABLE-CELL. If no such cookie is found, a default
4505 alignment value will be deduced from fraction of numbers in the
4506 column (see `org-table-number-fraction' for more information).
4507 Possible values are `left', `right' and `center'."
4508 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4525 cookie-align
4526 previous-cell-number-p)
4529 ;; In a special row, try to find an alignment cookie at
4530 ;; COLUMN.
4534 ;; Since VALUE is a secondary string, the following
4535 ;; checks avoid useless expansion through
4536 ;; `org-export-data'.
4544 ;; Ignore table rules.
4546 ;; In a standard row, check if cell's contents are
4547 ;; expressing some kind of number. Increase NUMBER-CELLS
4548 ;; accordingly. Though, don't bother if an alignment
4549 ;; cookie has already defined cell's alignment.
4554 info)))
4556 ;; Treat an empty cell as a number if it follows
4557 ;; a number.
4563 ;; Return value. Alignment specified by cookies has
4564 ;; precedence over alignment deduced from cell's contents.
4566 column
4571 org-table-number-fraction)
4576 "Return TABLE-CELL borders.
4578 INFO is a plist used as a communication channel.
4580 Return value is a list of symbols, or nil. Possible values are:
4581 `top', `bottom', `above', `below', `left' and `right'. Note:
4582 `top' (resp. `bottom') only happen for a cell in the first
4583 row (resp. last row) of the table, ignoring table rules, if any.
4585 Returned borders ignore special rows."
4588 borders)
4589 ;; Top/above border? TABLE-CELL has a border above when a rule
4590 ;; used to demarcate row groups can be found above. Hence,
4591 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4592 ;; another regular row has to be found above that rule.
4601 ;; Look at every row before the current one.
4603 ;; No rule above, or rule found starts the table (ignoring any
4604 ;; special row): TABLE-CELL is at the top of the table.
4607 ;; Bottom/below border? TABLE-CELL has a border below when next
4608 ;; non-regular row below is a rule.
4617 ;; Look at every row after the current one.
4619 ;; No rule below, or rule found ends the table (modulo some
4620 ;; special row): TABLE-CELL is at the bottom of the table.
4623 ;; Right/left borders? They can only be specified by column
4624 ;; groups. Column groups are defined in a row starting with "/".
4625 ;; Also a column groups row only contains "<", "<>", ">" or blank
4626 ;; cells.
4643 ;; There's a left border when previous cell, if
4644 ;; any, ends a group, or current one starts one.
4650 ;; There's a right border when next cell, if any,
4651 ;; starts a group, or current one ends one.
4658 ;; Table rows are read in reverse order so last column groups
4659 ;; row has precedence over any previous one.
4661 ;; Return value.
4662 borders))
4665 "Non-nil when TABLE-CELL is at the beginning of a column group.
4666 INFO is a plist used as a communication channel."
4667 ;; A cell starts a column group either when it is at the beginning
4668 ;; of a row (or after the special column, if any) or when it has
4669 ;; a left border.
4672 table-cell)
4676 "Non-nil when TABLE-CELL is at the end of a column group.
4677 INFO is a plist used as a communication channel."
4678 ;; A cell ends a column group either when it is at the end of a row
4679 ;; or when it has a right border.
4682 table-cell)
4686 "Non-nil when TABLE-ROW is at the beginning of a row group.
4687 INFO is a plist used as a communication channel."
4695 "Non-nil when TABLE-ROW is at the end of a row group.
4696 INFO is a plist used as a communication channel."
4704 "Non-nil when TABLE-ROW is the first table header's row.
4705 INFO is a plist used as a communication channel."
4712 "Non-nil when TABLE-ROW is the last table header's row.
4713 INFO is a plist used as a communication channel."
4720 "Return TABLE-ROW number.
4721 INFO is a plist used as a communication channel. Return value is
4722 zero-based and ignores separators. The function returns nil for
4723 special colums and separators."
4735 "Return TABLE dimensions.
4737 INFO is a plist used as a communication channel.
4739 Return value is a CONS like (ROWS . COLUMNS) where
4740 ROWS (resp. COLUMNS) is the number of exportable
4741 rows (resp. columns)."
4743 ;; Set number of rows, and extract first one.
4749 ;; Set number of columns.
4751 ;; Return value.
4755 "Return address of a regular TABLE-CELL object.
4757 TABLE-CELL is the cell considered. INFO is a plist used as
4758 a communication channel.
4760 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4761 zero-based index. Only exportable cells are considered. The
4762 function returns nil for other cells."
4774 "Return regular table-cell object at ADDRESS in TABLE.
4776 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4777 zero-based index. TABLE is a table type element. INFO is
4778 a plist used as a communication channel.
4780 If no table-cell, among exportable cells, is found at ADDRESS,
4781 return nil."
4784 ;; Row at (car address) or nil.
4792 'table-cell
4799 ;;;; For Tables Of Contents
4800 ;;
4801 ;; `org-export-collect-headlines' builds a list of all exportable
4802 ;; headline elements, maybe limited to a certain depth. One can then
4803 ;; easily parse it and transcode it.
4804 ;;
4805 ;; Building lists of tables, figures or listings is quite similar.
4806 ;; Once the generic function `org-export-collect-elements' is defined,
4807 ;; `org-export-collect-tables', `org-export-collect-figures' and
4808 ;; `org-export-collect-listings' can be derived from it.
4811 "Collect headlines in order to build a table of contents.
4813 INFO is a plist used as a communication channel.
4815 When optional argument N is an integer, it specifies the depth of
4816 the table of contents. Otherwise, it is set to the value of the
4817 last headline level. See `org-export-headline-levels' for more
4818 information.
4820 Return a list of all exportable headlines as parsed elements.
4821 Footnote sections, if any, will be ignored."
4829 info)))
4832 "Collect referenceable elements of a determined type.
4834 TYPE can be a symbol or a list of symbols specifying element
4835 types to search. Only elements with a caption are collected.
4837 INFO is a plist used as a communication channel.
4839 When non-nil, optional argument PREDICATE is a function accepting
4840 one argument, an element of type TYPE. It returns a non-nil
4841 value when that element should be collected.
4843 Return a list of all elements found, in order of appearance."
4848 element))
4849 info))
4852 "Build a list of tables.
4853 INFO is a plist used as a communication channel.
4855 Return a list of table elements with a caption."
4859 "Build a list of figures.
4861 INFO is a plist used as a communication channel. PREDICATE is
4862 a function which accepts one argument: a paragraph element and
4863 whose return value is non-nil when that element should be
4864 collected.
4866 A figure is a paragraph type element, with a caption, verifying
4868 a vague concept that may depend on back-end.
4870 Return a list of elements recognized as figures."
4874 "Build a list of src blocks.
4876 INFO is a plist used as a communication channel.
4878 Return a list of src-block elements with a caption."
4882 ;;;; Smart Quotes
4883 ;;
4884 ;; The main function for the smart quotes sub-system is
4885 ;; `org-export-activate-smart-quotes', which replaces every quote in
4886 ;; a given string from the parse tree with its "smart" counterpart.
4887 ;;
4888 ;; Dictionary for smart quotes is stored in
4889 ;; `org-export-smart-quotes-alist'.
4890 ;;
4891 ;; Internally, regexps matching potential smart quotes (checks at
4892 ;; string boundaries are also necessary) are defined in
4893 ;; `org-export-smart-quotes-regexps'.
4897 ;; one may use: »...«, "...", ›...‹, or '...'.
4898 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4899 ;; LaTeX quotes require Babel!
4944 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4953 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4962 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4971 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4977 )
4978 "Smart quotes translations.
4980 Alist whose CAR is a language string and CDR is an alist with
4981 quote type as key and a plist associating various encodings to
4982 their translation as value.
4984 A quote type can be any symbol among `opening-double-quote',
4985 `closing-double-quote', `opening-single-quote',
4986 `closing-single-quote' and `apostrophe'.
4988 Valid encodings include `:utf-8', `:html', `:latex' and
4989 `:texinfo'.
4995 ;; Possible opening quote at beginning of string.
4997 ;; Possible closing quote at beginning of string.
4999 ;; Possible apostrophe at beginning of string.
5001 ;; Opening single and double quotes.
5003 ;; Closing single and double quotes.
5005 ;; Apostrophe.
5007 ;; Possible opening quote at end of string.
5009 ;; Possible closing quote at end of string.
5011 ;; Possible apostrophe at end of string.
5013 "List of regexps matching a quote or an apostrophe.
5019 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5020 `:utf-8'. INFO is a plist used as a communication channel.
5022 The function has to retrieve information about string
5023 surroundings in parse tree. It can only happen with an
5024 unmodified string. Thus, if S has already been through another
5025 process, a non-nil ORIGINAL optional argument will provide that
5026 original string.
5028 Return the new string."
5031 ;; Try to be flexible when computing number of blanks
5032 ;; before object. The previous object may be a string
5033 ;; introduced by the back-end and not completely parsed.
5036 ;; A string with missing `:post-blank'
5037 ;; property.
5041 ;; Fallback value.
5046 ;; Return smart quote associated to a give quote Q, as
5047 ;; a string. TYPE is a symbol among `open', `close' and
5048 ;; `apostrophe'.
5058 org-export-smart-quotes-alist))))
5059 encoding)
5060 q)))))
5062 ;; Only a quote: no regexp can match. We have to check both
5063 ;; sides and decide what to do.
5071 ;; 1. Replace quote character at the beginning of S.
5073 ;; Apostrophe?
5079 ;; Closing quote?
5085 ;; Opening quote?
5091 ;; 2. Replace quotes in the middle of the string.
5093 ;; Opening quotes.
5099 ;; Closing quotes.
5105 ;; Apostrophes.
5110 ;; 3. Replace quote character at the end of S.
5112 ;; Apostrophe?
5117 ;; Closing quote?
5123 ;; Opening quote?
5128 ;; Return string with smart quotes.
5129 s))))
5131 ;;;; Topology
5132 ;;
5133 ;; Here are various functions to retrieve information about the
5134 ;; neighbourhood of a given element or object. Neighbours of interest
5135 ;; are direct parent (`org-export-get-parent'), parent headline
5136 ;; (`org-export-get-parent-headline'), first element containing an
5137 ;; object, (`org-export-get-parent-element'), parent table
5138 ;; (`org-export-get-parent-table'), previous element or object
5139 ;; (`org-export-get-previous-element') and next element or object
5140 ;; (`org-export-get-next-element').
5141 ;;
5142 ;; `org-export-get-genealogy' returns the full genealogy of a given
5143 ;; element or object, from closest parent to full parse tree.
5146 "Return BLOB parent or nil.
5147 BLOB is the element or object considered."
5151 "Return full genealogy relative to a given element or object.
5153 BLOB is the element or object being considered.
5155 Ancestors are returned from closest to farthest, the last one
5156 being the full parse tree."
5163 "Return BLOB parent headline or nil.
5164 BLOB is the element or object being considered."
5168 parent))
5171 "Return first element containing OBJECT or nil.
5172 OBJECT is the object to consider."
5176 parent))
5179 "Return OBJECT parent table or nil.
5180 OBJECT is either a `table-cell' or `table-element' type object."
5184 parent))
5187 "Return previous element or object.
5189 BLOB is an element or object. INFO is a plist used as
5190 a communication channel. Return previous exportable element or
5191 object, a string, or nil.
5193 When optional argument N is a positive integer, return a list
5194 containing up to N siblings before BLOB, from farthest to
5195 closest. With any other non-nil value, return a list containing
5196 all of them."
5198 ;; An object can belong to the contents of its parent or
5199 ;; to a secondary string. We check the latter option
5200 ;; first.
5203 org-element-all-elements))
5207 org-element-secondary-value-alist))
5208 parent)))
5211 prev)
5220 prev)))
5223 "Return next element or object.
5225 BLOB is an element or object. INFO is a plist used as
5226 a communication channel. Return next exportable element or
5227 object, a string, or nil.
5229 When optional argument N is a positive integer, return a list
5230 containing up to N siblings after BLOB, from closest to farthest.
5231 With any other non-nil value, return a list containing all of
5232 them."
5234 ;; An object can belong to the contents of its parent or to
5235 ;; a secondary string. We check the latter option first.
5238 org-element-all-objects))
5242 org-element-secondary-value-alist))
5243 parent)))
5246 next)
5254 siblings)
5258 ;;;; Translation
5259 ;;
5260 ;; `org-export-translate' translates a string according to the language
5261 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5262 ;; the dictionary used for the translation.
5476 "Dictionary for export engine.
5478 Alist whose CAR is the string to translate and CDR is an alist
5479 whose CAR is the language string and CDR is a plist whose
5480 properties are possible charsets and values translated terms.
5482 It is used as a database for `org-export-translate'. Since this
5483 function returns the string as-is if no translation was found,
5484 the variable only needs to record values different from the
5488 "Translate string S according to language specification.
5490 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5491 and `:utf-8'. INFO is a plist used as a communication channel.
5493 Translation depends on `:language' property. Return the
5494 translated string. If no translation is found, try to fall back
5495 to `:default' encoding. If it fails, return S."
5501 s)))
5504 \f
5505 ;;; Asynchronous Export
5506 ;;
5507 ;; `org-export-async-start' is the entry point for asynchronous
5508 ;; export. It recreates current buffer (including visibility,
5509 ;; narrowing and visited file) in an external Emacs process, and
5510 ;; evaluates a command there. It then applies a function on the
5511 ;; returned results in the current process.
5512 ;;
5513 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5514 ;; allow to export to a buffer or a file, asynchronously or not.
5515 ;;
5516 ;; `org-export-output-file-name' is an auxiliary function meant to be
5517 ;; used with `org-export-to-file'. With a given extension, it tries
5518 ;; to provide a canonical file name to write export output to.
5519 ;;
5520 ;; Asynchronously generated results are never displayed directly.
5521 ;; Instead, they are stored in `org-export-stack-contents'. They can
5522 ;; then be retrieved by calling `org-export-stack'.
5523 ;;
5524 ;; Export Stack is viewed through a dedicated major mode
5525 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5526 ;;`org-export-stack-delete', `org-export-stack-view' and
5527 ;;`org-export-stack-clear'.
5528 ;;
5529 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5530 ;; It should be used whenever `org-export-async-start' is called.
5533 "Call function FUN on the results returned by BODY evaluation.
5535 BODY evaluation happens in an asynchronous process, from a buffer
5536 which is an exact copy of the current one.
5538 Use `org-export-add-to-stack' in FUN in order to register results
5539 in the stack.
5541 This is a low level function. See also `org-export-to-buffer'
5542 and `org-export-to-file' for more specialized functions."
5545 ;; Write the full sexp evaluating BODY in a copy of the current
5546 ;; buffer to a temporary file, as it may be too long for program
5547 ;; args in `start-process'.
5554 ;; Null characters (from variable values) are inserted
5555 ;; within the file. As a consequence, coding system for
5556 ;; buffer contents will not be recognized properly. So,
5557 ;; we make sure it is the same as the one used to display
5558 ;; the original buffer.
5560 ,coding
5563 ;; Ignore `kill-emacs-hook' and code evaluation
5564 ;; queries from Babel as we need a truly
5565 ;; non-interactive process.
5567 org-babel-confirm-evaluate-answer-no t)
5568 ;; Initialize export framework.
5570 ;; Re-create current buffer there.
5573 ;; Sexp to evaluate in the buffer.
5575 ;; Start external process.
5578 (,process
5580 #'start-process
5583 ,proc-buffer
5590 ;; Register running process in stack.
5592 ;; Set-up sentinel in order to catch results.
5595 ,process
5617 ;;;###autoload
5620 &optional async subtreep visible-only body-only ext-plist
5621 post-process)
5622 "Call `org-export-as' with output to a specified buffer.
5624 BACKEND is either an export back-end, as returned by, e.g.,
5625 `org-export-create-backend', or a symbol referring to
5626 a registered back-end.
5628 BUFFER is the name of the output buffer. If it already exists,
5629 it will be erased first, otherwise, it will be created.
5631 A non-nil optional argument ASYNC means the process should happen
5632 asynchronously. The resulting buffer should then be accessible
5633 through the `org-export-stack' interface. When ASYNC is nil, the
5634 buffer is displayed if `org-export-show-temporary-export-buffer'
5635 is non-nil.
5637 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5638 EXT-PLIST are similar to those used in `org-export-as', which
5639 see.
5641 Optional argument POST-PROCESS is a function which should accept
5642 no argument. It is always called within the current process,
5643 from BUFFER, with point at its beginning. Export back-ends can
5644 use it to set a major mode there, e.g,
5646 \(defun org-latex-export-as-latex
5647 \(&optional async subtreep visible-only body-only ext-plist)
5648 \(interactive)
5650 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5652 This function returns BUFFER."
5680 buffer)))
5682 ;;;###autoload
5685 post-process)
5686 "Call `org-export-as' with output to a specified file.
5688 BACKEND is either an export back-end, as returned by, e.g.,
5689 `org-export-create-backend', or a symbol referring to
5690 a registered back-end. FILE is the name of the output file, as
5691 a string.
5693 A non-nil optional argument ASYNC means the process should happen
5694 asynchronously. The resulting buffer file then be accessible
5695 through the `org-export-stack' interface.
5697 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5698 EXT-PLIST are similar to those used in `org-export-as', which
5699 see.
5701 Optional argument POST-PROCESS is called with FILE as its
5702 argument and happens asynchronously when ASYNC is non-nil. It
5703 has to return a file name, or nil. Export back-ends can use this
5704 to send the output file through additional processing, e.g,
5706 \(defun org-latex-export-to-latex
5707 \(&optional async subtreep visible-only body-only ext-plist)
5708 \(interactive)
5710 \(org-export-to-file 'latex outfile
5711 async subtreep visible-only body-only ext-plist
5712 \(lambda (file) (org-latex-compile file)))
5714 The function returns either a file name returned by POST-PROCESS,
5715 or FILE."
5733 backend subtreep visible-only body-only ext-plist)))
5740 ;; Get proper return value.
5742 file))))))
5745 "Return output file's name according to buffer specifications.
5747 EXTENSION is a string representing the output file extension,
5748 with the leading dot.
5750 With a non-nil optional argument SUBTREEP, try to determine
5752 of subtree at point.
5754 When optional argument PUB-DIR is set, use it as the publishing
5755 directory.
5757 When optional argument VISIBLE-ONLY is non-nil, don't export
5758 contents of hidden elements.
5760 Return file name as a string."
5763 ;; File name may come from EXPORT_FILE_NAME subtree
5764 ;; property, assuming point is at beginning of said
5765 ;; sub-tree.
5772 ;; File name may be extracted from buffer's associated
5773 ;; file, if any.
5775 ;; Can't determine file name on our own: Ask user.
5779 "Output file: " pub-dir nil nil nil
5783 ;; Build file name. Enforce EXTENSION over whatever user
5784 ;; may have come up with. PUB-DIR, if defined, always has
5785 ;; precedence over any provided path.
5790 extension))
5793 ;; If writing to OUTPUT-FILE would overwrite original file, append
5794 ;; EXTENSION another time to final name.
5797 output-file)))
5800 "Add a new result to export stack if not present already.
5802 SOURCE is a buffer or a file name containing export results.
5803 BACKEND is a symbol representing export back-end used to generate
5804 it.
5806 Entries already pointing to SOURCE and unavailable entries are
5807 removed beforehand. Return the new stack."
5813 "Menu for asynchronous export results and running processes."
5823 "Return source from export results at point in stack."
5830 source
5831 ;; SOURCE is not consistent with current line. The stack
5832 ;; view is outdated.
5836 "Remove all entries from export stack."
5841 "Refresh the asynchronous export stack.
5842 DUMMY is ignored. Unavailable sources are removed from the list.
5843 Return the new stack."
5853 ;; Back-end.
5855 ;; Age.
5858 ;; Compute age of the results.
5860 "%4h:%.2m "
5862 ;; Source.
5867 ;; Clear stack from exited processes, dead buffers or
5868 ;; non-existent files.
5880 "Remove export results at point from stack.
5881 If optional argument SOURCE is non-nil, remove it instead."
5886 org-export-stack-contents))))
5889 "View export results at point in stack.
5890 With an optional prefix argument IN-EMACS, force viewing files
5891 within Emacs."
5905 (define-key km "p" 'previous-line)
5906 (define-key km "\C-p" 'previous-line)
5907 (define-key km "\C-?" 'previous-line)
5908 (define-key km [up] 'previous-line)
5909 (define-key km "C" 'org-export-stack-clear)
5910 (define-key km "v" 'org-export-stack-view)
5911 (define-key km (kbd "RET") 'org-export-stack-view)
5912 (define-key km "d" 'org-export-stack-remove)
5913 km)
5914 "Keymap for Org Export Stack.")
5916 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5917 "Mode for displaying asynchronous export stack.
5920 stack.
5922 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5923 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5924 stack completely.
5926 Removing entries in an Org Export Stack buffer doesn't affect
5927 files or buffers, only the display.
5930 (abbrev-mode 0)
5931 (auto-fill-mode 0)
5932 (setq buffer-read-only t
5933 buffer-undo-list t
5934 truncate-lines t
5935 header-line-format
5936 '(:eval
5937 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5938 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5939 (set (make-local-variable 'revert-buffer-function)
5940 'org-export-stack-refresh))
5943 \f
5944 ;;; The Dispatcher
5945 ;;
5946 ;; `org-export-dispatch' is the standard interactive way to start an
5947 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5948 ;; for its interface, which, in turn, delegates response to key
5949 ;; pressed to `org-export--dispatch-action'.
5951 ;;;###autoload
5952 (defun org-export-dispatch (&optional arg)
5953 "Export dispatcher for Org mode.
5955 It provides an access to common export related tasks in a buffer.
5956 Its interface comes in two flavours: standard and expert.
5958 While both share the same set of bindings, only the former
5959 displays the valid keys associations in a dedicated buffer.
5960 Scrolling (resp. line-wise motion) in this buffer is done with
5961 SPC and DEL (resp. C-n and C-p) keys.
5963 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5964 flavour or the other.
5967 of options used back then, on the current buffer.
5969 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5970 (interactive "P")
5971 (let* ((input
5972 (cond ((equal arg '(16)) '(stack))
5973 ((and arg org-export-dispatch-last-action))
5974 (t (save-window-excursion
5975 (unwind-protect
5976 (progn
5977 ;; Remember where we are
5978 (move-marker org-export-dispatch-last-position
5979 (point)
5980 (org-base-buffer (current-buffer)))
5981 ;; Get and store an export command
5982 (setq org-export-dispatch-last-action
5983 (org-export--dispatch-ui
5984 (list org-export-initial-scope
5985 (and org-export-in-background 'async))
5986 nil
5987 org-export-dispatch-use-expert-ui)))
5988 (and (get-buffer "*Org Export Dispatcher*")
5989 (kill-buffer "*Org Export Dispatcher*")))))))
5990 (action (car input))
5991 (optns (cdr input)))
5992 (unless (memq 'subtree optns)
5993 (move-marker org-export-dispatch-last-position nil))
5994 (case action
5995 ;; First handle special hard-coded actions.
5996 (template (org-export-insert-default-template nil optns))
5997 (stack (org-export-stack))
5998 (publish-current-file
5999 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6000 (publish-current-project
6001 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6002 (publish-choose-project
6003 (org-publish (assoc (org-icompleting-read
6004 "Publish project: "
6005 org-publish-project-alist nil t)
6006 org-publish-project-alist)
6007 (memq 'force optns)
6008 (memq 'async optns)))
6009 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6010 (otherwise
6011 (save-excursion
6012 (when arg
6013 ;; Repeating command, maybe move cursor to restore subtree
6014 ;; context.
6015 (if (eq (marker-buffer org-export-dispatch-last-position)
6016 (org-base-buffer (current-buffer)))
6017 (goto-char org-export-dispatch-last-position)
6018 ;; We are in a different buffer, forget position.
6019 (move-marker org-export-dispatch-last-position nil)))
6020 (funcall action
6021 ;; Return a symbol instead of a list to ease
6022 ;; asynchronous export macro use.
6023 (and (memq 'async optns) t)
6024 (and (memq 'subtree optns) t)
6025 (and (memq 'visible optns) t)
6026 (and (memq 'body optns) t)))))))
6028 (defun org-export--dispatch-ui (options first-key expertp)
6029 "Handle interface for `org-export-dispatch'.
6031 OPTIONS is a list containing current interactive options set for
6032 export. It can contain any of the following symbols:
6033 `body' toggles a body-only export
6034 `subtree' restricts export to current subtree
6035 `visible' restricts export to visible part of buffer.
6036 `force' force publishing files.
6037 `async' use asynchronous export process
6039 FIRST-KEY is the key pressed to select the first level menu. It
6040 is nil when this menu hasn't been selected yet.
6042 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6043 buffer is provided, but indications about currently active
6044 options are given in the prompt. Moreover, \[?] allows to switch
6045 back to standard interface."
6046 (let* ((fontify-key
6047 (lambda (key &optional access-key)
6048 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6049 ;; non-nil is the required first-level key to activate
6050 ;; KEY. When its value is t, activate KEY independently
6051 ;; on the first key, if any. A nil value means KEY will
6052 ;; only be activated at first level.
6053 (if (or (eq access-key t) (eq access-key first-key))
6054 (org-propertize key 'face 'org-warning)
6055 key)))
6056 (fontify-value
6057 (lambda (value)
6058 ;; Fontify VALUE string.
6059 (org-propertize value 'face 'font-lock-variable-name-face)))
6060 ;; Prepare menu entries by extracting them from registered
6061 ;; back-ends and sorting them by access key and by ordinal,
6062 ;; if any.
6063 (entries
6064 (sort (sort (delq nil
6065 (mapcar 'org-export-backend-menu
6066 org-export--registered-backends))
6067 (lambda (a b)
6068 (let ((key-a (nth 1 a))
6069 (key-b (nth 1 b)))
6070 (cond ((and (numberp key-a) (numberp key-b))
6071 (< key-a key-b))
6072 ((numberp key-b) t)))))
6073 'car-less-than-car))
6074 ;; Compute a list of allowed keys based on the first key
6075 ;; pressed, if any. Some keys
6076 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6077 ;; available.
6078 (allowed-keys
6079 (nconc (list 2 22 19 6 1)
6080 (if (not first-key) (org-uniquify (mapcar 'car entries))
6081 (let (sub-menu)
6082 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6083 (when (eq (car entry) first-key)
6084 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6085 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6086 ((not first-key) (list ?P)))
6087 (list ?& ?#)
6088 (when expertp (list ??))
6089 (list ?q)))
6090 ;; Build the help menu for standard UI.
6091 (help
6092 (unless expertp
6093 (concat
6094 ;; Options are hard-coded.
6095 (format "[%s] Body only: %s [%s] Visible only: %s
6096 \[%s] Export scope: %s [%s] Force publishing: %s
6098 (funcall fontify-key "C-b" t)
6099 (funcall fontify-value
6100 (if (memq 'body options) "On " "Off"))
6101 (funcall fontify-key "C-v" t)
6102 (funcall fontify-value
6103 (if (memq 'visible options) "On " "Off"))
6104 (funcall fontify-key "C-s" t)
6105 (funcall fontify-value
6106 (if (memq 'subtree options) "Subtree" "Buffer "))
6107 (funcall fontify-key "C-f" t)
6108 (funcall fontify-value
6109 (if (memq 'force options) "On " "Off"))
6110 (funcall fontify-key "C-a" t)
6111 (funcall fontify-value
6112 (if (memq 'async options) "On " "Off")))
6113 ;; Display registered back-end entries. When a key
6114 ;; appears for the second time, do not create another
6115 ;; entry, but append its sub-menu to existing menu.
6116 (let (last-key)
6117 (mapconcat
6118 (lambda (entry)
6119 (let ((top-key (car entry)))
6120 (concat
6121 (unless (eq top-key last-key)
6122 (setq last-key top-key)
6124 (funcall fontify-key (char-to-string top-key))
6125 (nth 1 entry)))
6126 (let ((sub-menu (nth 2 entry)))
6127 (unless (functionp sub-menu)
6128 ;; Split sub-menu into two columns.
6129 (let ((index -1))
6130 (concat
6131 (mapconcat
6132 (lambda (sub-entry)
6133 (incf index)
6134 (format
6135 (if (zerop (mod index 2)) " [%s] %-26s"
6137 (funcall fontify-key
6138 (char-to-string (car sub-entry))
6139 top-key)
6140 (nth 1 sub-entry)))
6141 sub-menu "")
6143 entries ""))
6144 ;; Publishing menu is hard-coded.
6146 [%s] Current file [%s] Current project
6148 (funcall fontify-key "P")
6149 (funcall fontify-key "f" ?P)
6150 (funcall fontify-key "p" ?P)
6151 (funcall fontify-key "x" ?P)
6152 (funcall fontify-key "a" ?P))
6154 (funcall fontify-key "&" t)
6155 (funcall fontify-key "#" t))
6156 (format "[%s] %s"
6157 (funcall fontify-key "q" t)
6158 (if first-key "Main menu" "Exit")))))
6159 ;; Build prompts for both standard and expert UI.
6160 (standard-prompt (unless expertp "Export command: "))
6161 (expert-prompt
6162 (when expertp
6163 (format
6164 "Export command (C-%s%s%s%s%s) [%s]: "
6165 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6166 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6167 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6168 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6169 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6170 (mapconcat (lambda (k)
6171 ;; Strip control characters.
6172 (unless (< k 27) (char-to-string k)))
6173 allowed-keys "")))))
6174 ;; With expert UI, just read key with a fancy prompt. In standard
6175 ;; UI, display an intrusive help buffer.
6176 (if expertp
6177 (org-export--dispatch-action
6178 expert-prompt allowed-keys entries options first-key expertp)
6179 ;; At first call, create frame layout in order to display menu.
6180 (unless (get-buffer "*Org Export Dispatcher*")
6181 (delete-other-windows)
6182 (org-switch-to-buffer-other-window
6183 (get-buffer-create "*Org Export Dispatcher*"))
6184 (setq cursor-type nil
6185 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6186 ;; Make sure that invisible cursor will not highlight square
6187 ;; brackets.
6188 (set-syntax-table (copy-syntax-table))
6189 (modify-syntax-entry ?\[ "w"))
6190 ;; At this point, the buffer containing the menu exists and is
6191 ;; visible in the current window. So, refresh it.
6192 (with-current-buffer "*Org Export Dispatcher*"
6193 ;; Refresh help. Maintain display continuity by re-visiting
6194 ;; previous window position.
6195 (let ((pos (window-start)))
6196 (erase-buffer)
6197 (insert help)
6198 (set-window-start nil pos)))
6199 (org-fit-window-to-buffer)
6200 (org-export--dispatch-action
6201 standard-prompt allowed-keys entries options first-key expertp))))
6203 (defun org-export--dispatch-action
6204 (prompt allowed-keys entries options first-key expertp)
6205 "Read a character from command input and act accordingly.
6207 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6208 a list of characters available at a given step in the process.
6209 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6210 EXPERTP are the same as defined in `org-export--dispatch-ui',
6211 which see.
6213 Toggle export options when required. Otherwise, return value is
6214 a list with action as CAR and a list of interactive export
6215 options as CDR."
6216 (let (key)
6217 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6218 ;; C-p, SPC, DEL).
6219 (while (and (setq key (read-char-exclusive prompt))
6220 (not expertp)
6221 (memq key '(14 16 ?\s ?\d)))
6222 (case key
6223 (14 (if (not (pos-visible-in-window-p (point-max)))
6224 (ignore-errors (scroll-up 1))
6225 (message "End of buffer")
6226 (sit-for 1)))
6227 (16 (if (not (pos-visible-in-window-p (point-min)))
6228 (ignore-errors (scroll-down 1))
6229 (message "Beginning of buffer")
6230 (sit-for 1)))
6231 (?\s (if (not (pos-visible-in-window-p (point-max)))
6232 (scroll-up nil)
6233 (message "End of buffer")
6234 (sit-for 1)))
6235 (?\d (if (not (pos-visible-in-window-p (point-min)))
6236 (scroll-down nil)
6237 (message "Beginning of buffer")
6238 (sit-for 1)))))
6239 (cond
6240 ;; Ignore undefined associations.
6241 ((not (memq key allowed-keys))
6242 (ding)
6243 (unless expertp (message "Invalid key") (sit-for 1))
6244 (org-export--dispatch-ui options first-key expertp))
6245 ;; q key at first level aborts export. At second level, cancel
6246 ;; first key instead.
6247 ((eq key ?q) (if (not first-key) (error "Export aborted")
6248 (org-export--dispatch-ui options nil expertp)))
6249 ;; Help key: Switch back to standard interface if expert UI was
6250 ;; active.
6251 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6252 ;; Send request for template insertion along with export scope.
6253 ((eq key ?#) (cons 'template (memq 'subtree options)))
6254 ;; Switch to asynchronous export stack.
6255 ((eq key ?&) '(stack))
6256 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6257 ((memq key '(2 22 19 6 1))
6258 (org-export--dispatch-ui
6259 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6260 (6 'force) (1 'async))))
6261 (if (memq option options) (remq option options)
6262 (cons option options)))
6263 first-key expertp))
6264 ;; Action selected: Send key and options back to
6265 ;; `org-export-dispatch'.
6266 ((or first-key (functionp (nth 2 (assq key entries))))
6267 (cons (cond
6268 ((not first-key) (nth 2 (assq key entries)))
6269 ;; Publishing actions are hard-coded. Send a special
6270 ;; signal to `org-export-dispatch'.
6271 ((eq first-key ?P)
6272 (case key
6273 (?f 'publish-current-file)
6274 (?p 'publish-current-project)
6275 (?x 'publish-choose-project)
6276 (?a 'publish-all)))
6277 ;; Return first action associated to FIRST-KEY + KEY
6278 ;; path. Indeed, derived backends can share the same
6279 ;; FIRST-KEY.
6280 (t (catch 'found
6281 (mapc (lambda (entry)
6282 (let ((match (assq key (nth 2 entry))))
6283 (when match (throw 'found (nth 2 match)))))
6284 (member (assq first-key entries) entries)))))
6285 options))
6286 ;; Otherwise, enter sub-menu.
6287 (t (org-export--dispatch-ui options key expertp)))))
6291 (provide 'ox)
6293 ;; Local variables:
6294 ;; generated-autoload-file: "org-loaddefs.el"
6295 ;; End:
6297 ;;; ox.el ends here