| blob | 343c4ef21073717e102b10840f8760d8a6b853fe |
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.
844 Value must be an absolute file name. It defaults to user's
845 initialization file. Though, a specific configuration makes the
846 process faster and the export more portable."
853 "Non-nil means using a non-intrusive `org-export-dispatch'.
854 In that case, no help buffer is displayed. Though, an indicator
860 asynchronous). Also, \[?] allows to switch back to standard
861 mode."
868 \f
869 ;;; Defining Back-ends
870 ;;
871 ;; An export back-end is a structure with `org-export-backend' type
872 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
873 ;; and `menu' slots.
874 ;;
875 ;; At the lowest level, a back-end is created with
876 ;; `org-export-create-backend' function.
877 ;;
878 ;; A named back-end can be registered with
879 ;; `org-export-register-backend' function. A registered back-end can
880 ;; later be referred to by its name, with `org-export-get-backend'
881 ;; function. Also, such a back-end can become the parent of a derived
882 ;; back-end from which slot values will be inherited by default.
883 ;; `org-export-derived-backend-p' can check if a given back-end is
884 ;; derived from a list of back-end names.
885 ;;
886 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
887 ;; `org-export-get-all-filters' return the full alist of transcoders,
888 ;; options and filters, including those inherited from ancestors.
889 ;;
890 ;; At a higher level, `org-export-define-backend' is the standard way
891 ;; to define an export back-end. If the new back-end is similar to
892 ;; a registered back-end, `org-export-define-derived-backend' may be
893 ;; used instead.
894 ;;
895 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
896 ;; when a given back-end hasn't been registered yet.
900 name parent transcoders options filters blocks menu)
903 "Return export back-end named after NAME.
904 NAME is a symbol. Return nil if no such back-end is found."
911 "Register BACKEND as a known export back-end.
912 BACKEND is a structure with `org-export-backend' type."
913 ;; Refuse to register an unnamed back-end.
916 ;; Refuse to register a back-end with an unknown parent.
920 ;; Register dedicated export blocks in the parser.
924 ;; If a back-end with the same name as BACKEND is already
925 ;; registered, replace it with BACKEND. Otherwise, simply add
926 ;; BACKEND to the list of registered back-ends.
932 "Signal an error if BACKEND isn't defined."
937 "Non-nil if BACKEND is derived from one of BACKENDS.
938 BACKEND is an export back-end, as returned by, e.g.,
939 `org-export-create-backend', or a symbol referring to
940 a registered back-end. BACKENDS is constituted of symbols."
952 "Return full translation table for BACKEND.
954 BACKEND is an export back-end, as return by, e.g,,
955 `org-export-create-backend'. Return value is an alist where
956 keys are element or object types, as symbols, and values are
957 transcoders.
959 Unlike to `org-export-backend-transcoders', this function
960 also returns transcoders inherited from parent back-ends,
961 if any."
965 parent)
970 transcoders)))
973 "Return export options for BACKEND.
975 BACKEND is an export back-end, as return by, e.g,,
976 `org-export-create-backend'. See `org-export-options-alist'
977 for the shape of the return value.
979 Unlike to `org-export-backend-options', this function also
980 returns options inherited from parent back-ends, if any."
984 parent)
988 options)))
991 "Return complete list of filters for BACKEND.
993 BACKEND is an export back-end, as return by, e.g,,
994 `org-export-create-backend'. Return value is an alist where
995 keys are symbols and values lists of functions.
997 Unlike to `org-export-backend-filters', this function also
998 returns filters inherited from parent back-ends, if any."
1002 parent)
1006 filters)))
1009 "Define a new back-end BACKEND.
1011 TRANSCODERS is an alist between object or element types and
1012 functions handling them.
1014 These functions should return a string without any trailing
1015 space, or nil. They must accept three arguments: the object or
1016 element itself, its contents or nil when it isn't recursive and
1017 the property list used as a communication channel.
1019 Contents, when not nil, are stripped from any global indentation
1020 \(although the relative one is preserved). They also always end
1021 with a single newline character.
1023 If, for a given type, no function is found, that element or
1024 object type will simply be ignored, along with any blank line or
1025 white space at its end. The same will happen if the function
1026 returns the nil value. If that function returns the empty
1027 string, the type will be ignored, but the blank lines or white
1028 spaces will be kept.
1030 In addition to element and object types, one function can be
1031 associated to the `template' (or `inner-template') symbol and
1032 another one to the `plain-text' symbol.
1034 The former returns the final transcoded string, and can be used
1035 to add a preamble and a postamble to document's body. It must
1036 accept two arguments: the transcoded string and the property list
1037 containing export options. A function associated to `template'
1039 A function associated to `inner-template' is always applied.
1041 The latter, when defined, is to be called on every text not
1042 recognized as an element or an object. It must accept two
1043 arguments: the text string and the information channel. It is an
1044 appropriate place to protect special chars relative to the
1045 back-end.
1047 BODY can start with pre-defined keyword arguments. The following
1048 keywords are understood:
1050 :export-block
1052 String, or list of strings, representing block names that
1053 will not be parsed. This is used to specify blocks that will
1054 contain raw code specific to the back-end. These blocks
1055 still have to be handled by the relative `export-block' type
1056 translator.
1058 :filters-alist
1060 Alist between filters and function, or list of functions,
1061 specific to the back-end. See `org-export-filters-alist' for
1062 a list of all allowed filters. Filters defined here
1063 shouldn't make a back-end test, as it may prevent back-ends
1064 derived from this one to behave properly.
1066 :menu-entry
1068 Menu entry for the export dispatcher. It should be a list
1069 like:
1071 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1073 where :
1075 KEY is a free character selecting the back-end.
1077 DESCRIPTION-OR-ORDINAL is either a string or a number.
1079 If it is a string, is will be used to name the back-end in
1080 its menu entry. If it is a number, the following menu will
1081 be displayed as a sub-menu of the back-end with the same
1082 KEY. Also, the number will be used to determine in which
1083 order such sub-menus will appear (lowest first).
1085 ACTION-OR-MENU is either a function or an alist.
1087 If it is an action, it will be called with four
1088 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1089 BODY-ONLY. See `org-export-as' for further explanations on
1090 some of them.
1092 If it is an alist, associations should follow the
1093 pattern:
1095 '(KEY DESCRIPTION ACTION)
1097 where KEY, DESCRIPTION and ACTION are described above.
1099 Valid values include:
1103 or
1108 \(lambda (a s v b)
1109 \(if a (org-latex-export-to-pdf t s v b)
1110 \(org-open-file
1111 \(org-latex-export-to-pdf nil s v b)))))))
1113 or the following, which will be added to the previous
1114 sub-menu,
1116 '(?l 1
1120 :options-alist
1122 Alist between back-end specific properties introduced in
1123 communication channel and how their value are acquired. See
1124 `org-export-options-alist' for more information about
1125 structure of the values."
1139 :transcoders transcoders
1140 :options options
1141 :filters filters
1142 :blocks blocks
1146 "Create a new back-end as a variant of an existing one.
1148 CHILD is the name of the derived back-end. PARENT is the name of
1149 the parent back-end.
1151 BODY can start with pre-defined keyword arguments. The following
1152 keywords are understood:
1154 :export-block
1156 String, or list of strings, representing block names that
1157 will not be parsed. This is used to specify blocks that will
1158 contain raw code specific to the back-end. These blocks
1159 still have to be handled by the relative `export-block' type
1160 translator.
1162 :filters-alist
1164 Alist of filters that will overwrite or complete filters
1165 defined in PARENT back-end. See `org-export-filters-alist'
1166 for a list of allowed filters.
1168 :menu-entry
1170 Menu entry for the export dispatcher. See
1171 `org-export-define-backend' for more information about the
1172 expected value.
1174 :options-alist
1176 Alist of back-end specific properties that will overwrite or
1177 complete those defined in PARENT back-end. Refer to
1178 `org-export-options-alist' for more information about
1179 structure of the values.
1181 :translate-alist
1183 Alist of element and object types and transcoders that will
1184 overwrite or complete transcode table from PARENT back-end.
1185 Refer to `org-export-define-backend' for detailed information
1186 about transcoders.
1189 as a variant of `latex' back-end with a custom template function:
1191 \(org-export-define-derived-backend 'my-latex 'latex
1192 :translate-alist '((template . my-latex-template-fun)))
1194 The back-end could then be called with, for example:
1211 :parent parent
1212 :transcoders transcoders
1213 :options options
1214 :filters filters
1215 :blocks blocks
1219 \f
1220 ;;; The Communication Channel
1221 ;;
1222 ;; During export process, every function has access to a number of
1223 ;; properties. They are of two types:
1224 ;;
1225 ;; 1. Environment options are collected once at the very beginning of
1226 ;; the process, out of the original buffer and configuration.
1227 ;; Collecting them is handled by `org-export-get-environment'
1228 ;; function.
1229 ;;
1230 ;; Most environment options are defined through the
1231 ;; `org-export-options-alist' variable.
1232 ;;
1233 ;; 2. Tree properties are extracted directly from the parsed tree,
1234 ;; just before export, by `org-export-collect-tree-properties'.
1235 ;;
1236 ;; Here is the full list of properties available during transcode
1237 ;; process, with their category and their value type.
1238 ;;
1239 ;; + `:author' :: Author's name.
1240 ;; - category :: option
1241 ;; - type :: string
1242 ;;
1243 ;; + `:back-end' :: Current back-end used for transcoding.
1244 ;; - category :: tree
1245 ;; - type :: symbol
1246 ;;
1247 ;; + `:creator' :: String to write as creation information.
1248 ;; - category :: option
1249 ;; - type :: string
1250 ;;
1251 ;; + `:date' :: String to use as date.
1252 ;; - category :: option
1253 ;; - type :: string
1254 ;;
1255 ;; + `:description' :: Description text for the current data.
1256 ;; - category :: option
1257 ;; - type :: string
1258 ;;
1259 ;; + `:email' :: Author's email.
1260 ;; - category :: option
1261 ;; - type :: string
1262 ;;
1263 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1264 ;; process.
1265 ;; - category :: option
1266 ;; - type :: list of strings
1267 ;;
1268 ;; + `:export-options' :: List of export options available for current
1269 ;; process.
1270 ;; - category :: none
1271 ;; - type :: list of symbols, among `subtree', `body-only' and
1272 ;; `visible-only'.
1273 ;;
1274 ;; + `:exported-data' :: Hash table used for memoizing
1275 ;; `org-export-data'.
1276 ;; - category :: tree
1277 ;; - type :: hash table
1278 ;;
1279 ;; + `:filetags' :: List of global tags for buffer. Used by
1280 ;; `org-export-get-tags' to get tags with inheritance.
1281 ;; - category :: option
1282 ;; - type :: list of strings
1283 ;;
1284 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1285 ;; their definition, as parsed data. Only non-inlined footnotes
1286 ;; are represented in this alist. Also, every definition isn't
1287 ;; guaranteed to be referenced in the parse tree. The purpose of
1288 ;; this property is to preserve definitions from oblivion
1289 ;; (i.e. when the parse tree comes from a part of the original
1290 ;; buffer), it isn't meant for direct use in a back-end. To
1291 ;; retrieve a definition relative to a reference, use
1292 ;; `org-export-get-footnote-definition' instead.
1293 ;; - category :: option
1294 ;; - type :: alist (STRING . LIST)
1295 ;;
1296 ;; + `:headline-levels' :: Maximum level being exported as an
1297 ;; headline. Comparison is done with the relative level of
1298 ;; headlines in the parse tree, not necessarily with their
1299 ;; actual level.
1300 ;; - category :: option
1301 ;; - type :: integer
1302 ;;
1303 ;; + `:headline-offset' :: Difference between relative and real level
1304 ;; of headlines in the parse tree. For example, a value of -1
1305 ;; means a level 2 headline should be considered as level
1306 ;; 1 (cf. `org-export-get-relative-level').
1307 ;; - category :: tree
1308 ;; - type :: integer
1309 ;;
1310 ;; + `:headline-numbering' :: Alist between headlines and their
1311 ;; numbering, as a list of numbers
1312 ;; (cf. `org-export-get-headline-number').
1313 ;; - category :: tree
1314 ;; - type :: alist (INTEGER . LIST)
1315 ;;
1316 ;; + `:id-alist' :: Alist between ID strings and destination file's
1317 ;; path, relative to current directory. It is used by
1318 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1319 ;; external file.
1320 ;; - category :: option
1321 ;; - type :: alist (STRING . STRING)
1322 ;;
1323 ;; + `:ignore-list' :: List of elements and objects that should be
1324 ;; ignored during export.
1325 ;; - category :: tree
1326 ;; - type :: list of elements and objects
1327 ;;
1328 ;; + `:input-file' :: Full path to input file, if any.
1329 ;; - category :: option
1330 ;; - type :: string or nil
1331 ;;
1332 ;; + `:keywords' :: List of keywords attached to data.
1333 ;; - category :: option
1334 ;; - type :: string
1335 ;;
1336 ;; + `:language' :: Default language used for translations.
1337 ;; - category :: option
1338 ;; - type :: string
1339 ;;
1340 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1341 ;; transcoding.
1342 ;; - category :: option
1343 ;; - type :: list (as returned by `org-element-parse-buffer')
1344 ;;
1345 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1346 ;; all line breaks.
1347 ;; - category :: option
1348 ;; - type :: symbol (nil, t)
1349 ;;
1350 ;; + `:section-numbers' :: Non-nil means transcoding should add
1351 ;; section numbers to headlines.
1352 ;; - category :: option
1353 ;; - type :: symbol (nil, t)
1354 ;;
1355 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1356 ;; in transcoding. When such a tag is present, subtrees without
1357 ;; it are de facto excluded from the process. See
1358 ;; `use-select-tags'.
1359 ;; - category :: option
1360 ;; - type :: list of strings
1361 ;;
1362 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1363 ;; a time stamp in the output.
1364 ;; - category :: option
1365 ;; - type :: symbol (nil, t)
1366 ;;
1367 ;; + `:translate-alist' :: Alist between element and object types and
1368 ;; transcoding functions relative to the current back-end.
1369 ;; Special keys `inner-template', `template' and `plain-text' are
1370 ;; also possible.
1371 ;; - category :: option
1372 ;; - type :: alist (SYMBOL . FUNCTION)
1373 ;;
1374 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1375 ;; also be transcoded. If it is set to the `headline' symbol,
1376 ;; only the archived headline's name is retained.
1377 ;; - category :: option
1378 ;; - type :: symbol (nil, t, `headline')
1379 ;;
1380 ;; + `:with-author' :: Non-nil means author's name should be included
1381 ;; in the output.
1382 ;; - category :: option
1383 ;; - type :: symbol (nil, t)
1384 ;;
1385 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1386 ;; - category :: option
1387 ;; - type :: symbol (nil, t)
1388 ;;
1389 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1390 ;; inserted at the end of the transcoded string. If the value
1391 ;; is `comment', it should be commented.
1392 ;; - category :: option
1393 ;; - type :: symbol (`comment', nil, t)
1394 ;;
1395 ;; + `:with-date' :: Non-nil means output should contain a date.
1396 ;; - category :: option
1397 ;; - type :. symbol (nil, t)
1398 ;;
1399 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1400 ;; its value is a list of names, only drawers with such names
1401 ;; will be transcoded. If that list starts with `not', drawer
1402 ;; with these names will be skipped.
1403 ;; - category :: option
1404 ;; - type :: symbol (nil, t) or list of strings
1405 ;;
1406 ;; + `:with-email' :: Non-nil means output should contain author's
1407 ;; email.
1408 ;; - category :: option
1409 ;; - type :: symbol (nil, t)
1410 ;;
1411 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1412 ;; interpreted.
1413 ;; - category :: option
1414 ;; - type :: symbol (nil, t)
1415 ;;
1416 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1417 ;; strings starting with a colon as a fixed-with (verbatim) area.
1418 ;; - category :: option
1419 ;; - type :: symbol (nil, t)
1420 ;;
1421 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1422 ;; footnotes.
1423 ;; - category :: option
1424 ;; - type :: symbol (nil, t)
1425 ;;
1426 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1427 ;; `latex-fragment' objects should appear in export output. When
1428 ;; this property is set to `verbatim', they will be left as-is.
1429 ;; - category :: option
1430 ;; - type :: symbol (`verbatim', nil, t)
1431 ;;
1432 ;; + `:with-planning' :: Non-nil means transcoding should include
1433 ;; planning info.
1434 ;; - category :: option
1435 ;; - type :: symbol (nil, t)
1436 ;;
1437 ;; + `:with-priority' :: Non-nil means transcoding should include
1438 ;; priority cookies.
1439 ;; - category :: option
1440 ;; - type :: symbol (nil, t)
1441 ;;
1442 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1443 ;; plain text.
1444 ;; - category :: option
1445 ;; - type :: symbol (nil, t)
1446 ;;
1447 ;; + `:with-special-strings' :: Non-nil means transcoding should
1448 ;; interpret special strings in plain text.
1449 ;; - category :: option
1450 ;; - type :: symbol (nil, t)
1451 ;;
1452 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1453 ;; interpret subscript and superscript. With a value of "{}",
1454 ;; only interpret those using curly brackets.
1455 ;; - category :: option
1456 ;; - type :: symbol (nil, {}, t)
1457 ;;
1458 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1459 ;; tables.
1460 ;; - category :: option
1461 ;; - type :: symbol (nil, t)
1462 ;;
1463 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1464 ;; headlines. A `not-in-toc' value will remove them from the
1465 ;; table of contents, if any, nonetheless.
1466 ;; - category :: option
1467 ;; - type :: symbol (nil, t, `not-in-toc')
1468 ;;
1469 ;; + `:with-tasks' :: Non-nil means transcoding should include
1470 ;; headlines with a TODO keyword. A `todo' value will only
1471 ;; include headlines with a todo type keyword while a `done'
1472 ;; value will do the contrary. If a list of strings is provided,
1473 ;; only tasks with keywords belonging to that list will be kept.
1474 ;; - category :: option
1475 ;; - type :: symbol (t, todo, done, nil) or list of strings
1476 ;;
1477 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1478 ;; time stamps. Special value `active' (resp. `inactive') ask to
1479 ;; export only active (resp. inactive) timestamps. Otherwise,
1480 ;; completely remove them.
1481 ;; - category :: option
1482 ;; - type :: symbol: (`active', `inactive', t, nil)
1483 ;;
1484 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1485 ;; added to the output. An integer value limits its depth.
1486 ;; - category :: option
1487 ;; - type :: symbol (nil, t or integer)
1488 ;;
1489 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1490 ;; include TODO keywords.
1491 ;; - category :: option
1492 ;; - type :: symbol (nil, t)
1495 ;;;; Environment Options
1496 ;;
1497 ;; Environment options encompass all parameters defined outside the
1498 ;; scope of the parsed data. They come from five sources, in
1499 ;; increasing precedence order:
1500 ;;
1501 ;; - Global variables,
1502 ;; - Buffer's attributes,
1503 ;; - Options keyword symbols,
1504 ;; - Buffer keywords,
1505 ;; - Subtree properties.
1506 ;;
1507 ;; The central internal function with regards to environment options
1508 ;; is `org-export-get-environment'. It updates global variables with
1509 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1510 ;; the different sources.
1511 ;;
1512 ;; The internal functions doing the retrieval are:
1513 ;; `org-export--get-global-options',
1514 ;; `org-export--get-buffer-attributes',
1515 ;; `org-export--parse-option-keyword',
1516 ;; `org-export--get-subtree-options' and
1517 ;; `org-export--get-inbuffer-options'
1518 ;;
1519 ;; Also, `org-export--list-bound-variables' collects bound variables
1520 ;; along with their value in order to set them as buffer local
1521 ;; variables later in the process.
1524 "Collect export options from the current buffer.
1526 Optional argument BACKEND is an export back-end, as returned by
1527 `org-export-create-backend'.
1529 When optional argument SUBTREEP is non-nil, assume the export is
1530 done against the current sub-tree.
1532 Third optional argument EXT-PLIST is a property list with
1533 external parameters overriding Org default settings, but still
1534 inferior to file-local settings."
1535 ;; First install #+BIND variables since these must be set before
1536 ;; global options are read.
1539 ;; Get and prioritize export options...
1541 ;; ... from global variables...
1543 ;; ... from an external property list...
1544 ext-plist
1545 ;; ... from in-buffer settings...
1547 ;; ... and from subtree, when appropriate.
1549 ;; Eventually add misc. properties.
1551 :back-end
1552 backend
1554 :footnote-definition-alist
1555 ;; Footnotes definitions must be collected in the original
1556 ;; buffer, as there's no insurance that they will still be in
1557 ;; the parse tree, due to possible narrowing.
1571 alist))))
1572 alist))
1573 :id-alist
1574 ;; Collect id references.
1585 alist))))
1588 "Parse an OPTIONS line and return values as a plist.
1589 Optional argument BACKEND is an export back-end, as returned by,
1590 e.g., `org-export-create-backend'. It specifies which back-end
1591 specific items to read, if any."
1593 ;; Priority is given to back-end specific options.
1595 org-export-options-alist))
1596 plist)
1605 options))
1607 property
1610 plist))
1613 "Get export options in subtree at point.
1614 Optional argument BACKEND is an export back-end, as returned by,
1615 e.g., `org-export-create-backend'. It specifies back-end used
1616 for export. Return options as a plist."
1617 ;; For each buffer keyword, create a headline property setting the
1618 ;; same property in communication channel. The name for the property
1619 ;; is the keyword with "EXPORT_" appended to it.
1622 ;; Make sure point is at a heading.
1624 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1625 ;; title as its fallback value.
1631 plist :title
1634 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1638 ;; Handle other keywords. TITLE keyword is excluded as it has
1639 ;; been handled already.
1647 ;; Export properties are not case-sensitive.
1654 plist
1655 property
1657 ;; Parse VALUE if required.
1661 ;; If BEHAVIOUR is `split' expected value is
1662 ;; a list of strings, not a string.
1665 ;; Look for both general keywords and back-end specific
1666 ;; options, with priority given to the latter.
1668 org-export-options-alist)))
1669 ;; Return value.
1670 plist)))
1673 "Return current buffer export options, as a plist.
1675 Optional argument BACKEND, when non-nil, is an export back-end,
1676 as returned by, e.g., `org-export-create-backend'. It specifies
1677 which back-end specific options should also be read in the
1678 process.
1680 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1682 get-options ; For byte-compiler.
1685 ;; Priority is given to back-end specific options.
1687 org-export-options-alist))
1690 org-export-special-keywords))))
1693 ;; Return all properties associated to KEYWORD.
1700 ;; Recursively read keywords in buffer. FILES is a list
1701 ;; of files read so far. PLIST is the current property
1702 ;; list obtained.
1711 ;; Options in `org-export-special-keywords'.
1715 ;; Avoid circular dependencies.
1725 plist
1730 plist
1736 ;; Options in `org-export-options-alist'.
1741 plist property
1742 ;; Handle value depending on specified
1743 ;; BEHAVIOUR.
1749 " "
1762 ;; Return final value.
1763 plist))))
1764 ;; Read options in the current buffer.
1767 ;; Parse keywords specified in `org-element-document-properties'
1768 ;; and return PLIST.
1779 "Return properties related to buffer attributes, as a plist."
1780 ;; Store full path of input file name, or nil. For internal use.
1788 "Return global export options as a plist.
1789 Optional argument BACKEND, if non-nil, is an export back-end, as
1790 returned by, e.g., `org-export-create-backend'. It specifies
1791 which back-end specific export options should also be read in the
1792 process."
1794 ;; Priority is given to back-end specific options.
1796 org-export-options-alist)))
1803 plist
1804 prop
1805 ;; Eval default value provided. If keyword is
1806 ;; a member of `org-element-document-properties',
1807 ;; parse it as a secondary string before storing it.
1814 value)))))))))))
1817 "Return variables bound from BIND keywords in current buffer.
1818 Also look for BIND keywords in setup files. The return value is
1819 an alist where associations are (VARIABLE-NAME VALUE)."
1824 ;; Return an alist between variable names and their
1825 ;; value. FILES is a list of setup files names read so
1826 ;; far, used to avoid circular dependencies. ALIST is
1827 ;; the alist collected so far.
1838 ;; Enter setup file.
1848 alist))))))))))
1849 alist)))))
1850 ;; Return value in appropriate order of appearance.
1854 ;;;; Tree Properties
1855 ;;
1856 ;; Tree properties are information extracted from parse tree. They
1857 ;; are initialized at the beginning of the transcoding process by
1858 ;; `org-export-collect-tree-properties'.
1859 ;;
1860 ;; Dedicated functions focus on computing the value of specific tree
1861 ;; properties during initialization. Thus,
1862 ;; `org-export--populate-ignore-list' lists elements and objects that
1863 ;; should be skipped during export, `org-export--get-min-level' gets
1864 ;; the minimal exportable level, used as a basis to compute relative
1865 ;; level for headlines. Eventually
1866 ;; `org-export--collect-headline-numbering' builds an alist between
1867 ;; headlines and their numbering.
1870 "Extract tree properties from parse tree.
1872 DATA is the parse tree from which information is retrieved. INFO
1873 is a list holding export options.
1875 Following tree properties are set or updated:
1877 `:exported-data' Hash table used to memoize results from
1878 `org-export-data'.
1880 `:footnote-definition-alist' List of footnotes definitions in
1881 original buffer and current parse tree.
1883 `:headline-offset' Offset between true level of headlines and
1884 local level. An offset of -1 means a headline
1885 of level 2 should be considered as a level
1886 1 headline in the context.
1888 `:headline-numbering' Alist of all headlines as key an the
1889 associated numbering as value.
1891 `:ignore-list' List of elements that should be ignored during
1892 export.
1894 Return updated plist."
1895 ;; Install the parse tree in the communication channel, in order to
1896 ;; use `org-export-get-genealogy' and al.
1898 ;; Get the list of elements and objects to ignore, and put it into
1899 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1900 ;; been done during parse tree filtering.
1903 :ignore-list
1906 ;; Compute `:headline-offset' in order to be able to use
1907 ;; `org-export-get-relative-level'.
1910 :headline-offset
1912 ;; Update footnotes definitions list with definitions in parse tree.
1913 ;; This is required since buffer expansion might have modified
1914 ;; boundaries of footnote definitions contained in the parse tree.
1915 ;; This way, definitions in `footnote-definition-alist' are bound to
1916 ;; match those in the parse tree.
1922 defs)))
1924 ;; Properties order doesn't matter: get the rest of the tree
1925 ;; properties.
1929 info))
1932 "Return minimum exportable headline's level in DATA.
1933 DATA is parsed tree as returned by `org-element-parse-buffer'.
1934 OPTIONS is a plist holding export options."
1945 ;; If no headline was found, for the sake of consistency, set
1946 ;; minimum level to 1 nonetheless.
1950 "Return numbering of all exportable headlines in a parse tree.
1952 DATA is the parse tree. OPTIONS is the plist holding export
1953 options.
1955 Return an alist whose key is a headline and value is its
1956 associated numbering \(in the shape of a list of numbers\) or nil
1957 for a footnotes section."
1965 headline
1967 for idx from 0 to org-export-max-depth
1971 options)))
1974 "Return list of elements and objects to ignore during export.
1975 DATA is the parse tree to traverse. OPTIONS is the plist holding
1976 export options."
1978 ;; First find trees containing a select tag, if any.
1980 ;; If a select tag is active, also ignore the section before
1981 ;; the first headline, if any.
1985 first-element))))
1988 ;; Collect ignored elements or objects into IGNORE-LIST.
1994 ;; If headline is archived but tree below has
1995 ;; to be skipped, add it to ignore list.
1998 ;; Move into secondary string, if any.
2003 ;; Move into recursive objects/elements.
2005 ;; Main call.
2007 ;; Return value.
2008 ignore))
2011 "Return list of headlines and inlinetasks with a select tag in their tree.
2012 DATA is parsed data as returned by `org-element-parse-buffer'.
2013 INFO is a plist holding export options."
2015 walk-data ; For byte-compiler.
2025 ;; When a select tag is found, mark full
2026 ;; genealogy and every headline within the tree
2027 ;; as acceptable.
2030 genealogy
2033 selected-trees))
2034 ;; If at a headline, continue searching in tree,
2035 ;; recursively.
2045 selected-trees))
2048 "Non-nil when element or object BLOB should be skipped during export.
2049 OPTIONS is the plist holding export options. SELECTED, when
2050 non-nil, is a list of headlines or inlinetasks belonging to
2051 a tree with a select tag."
2058 ;; If `:with-drawers' value starts with `not', ignore
2059 ;; every drawer whose name belong to that list.
2060 ;; Otherwise, ignore drawers whose name isn't in that
2061 ;; list.
2077 ;; Ignore subtrees with an exclude tag.
2080 ;; When a select tag is present in the buffer, ignore any tree
2081 ;; without it.
2083 ;; Ignore commented sub-trees.
2085 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2087 ;; Ignore tasks, if specified by `:with-tasks' property.
2099 properties-set))))))
2109 ;; `:with-timestamps' only applies to isolated timestamps
2110 ;; objects, i.e. timestamp objects in a paragraph containing only
2111 ;; timestamps and whitespaces.
2119 options t))))
2128 \f
2129 ;;; The Transcoder
2130 ;;
2131 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2132 ;; `org-element-parse-buffer') and transcodes it into a specified
2133 ;; back-end output. It takes care of filtering out elements or
2134 ;; objects according to export options and organizing the output blank
2135 ;; lines and white space are preserved. The function memoizes its
2136 ;; results, so it is cheap to call it within transcoders.
2137 ;;
2138 ;; It is possible to modify locally the back-end used by
2139 ;; `org-export-data' or even use a temporary back-end by using
2140 ;; `org-export-data-with-backend'.
2141 ;;
2142 ;; Internally, three functions handle the filtering of objects and
2143 ;; elements during the export. In particular,
2144 ;; `org-export-ignore-element' marks an element or object so future
2145 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2146 ;; elements or objects should be seen as real Org syntax and
2147 ;; `org-export-expand' transforms the others back into their original
2148 ;; shape
2149 ;;
2150 ;; `org-export-transcoder' is an accessor returning appropriate
2151 ;; translator function for a given element or object.
2154 "Return appropriate transcoder for BLOB.
2155 INFO is a plist containing export directives."
2157 ;; Return contents only for complete parse trees.
2163 "Convert DATA into current back-end format.
2165 DATA is a parse tree, an element or an object or a secondary
2166 string. INFO is a plist holding export options.
2168 Return transcoded string."
2174 ;; Ignored element/object.
2176 ;; Plain text.
2182 info))
2183 ;; Uninterpreted element/object: change it back to Org
2184 ;; syntax and export again resulting raw string.
2188 data
2192 info))
2193 ;; Secondary string.
2196 ;; Element/Object without contents or, as a special case,
2197 ;; headline with archive tag and archived trees restricted
2198 ;; to title only.
2206 ;; Export snippets never return a nil value so
2207 ;; that white spaces following them are never
2208 ;; ignored.
2210 ;; Element/Object with contents.
2223 ;; Elements directly containing objects
2224 ;; must have their indentation normalized
2225 ;; first.
2227 data
2228 ;; When normalizing contents of the first
2229 ;; paragraph in an item or a footnote
2230 ;; definition, ignore first line's
2231 ;; indentation: there is none and it
2232 ;; might be misleading.
2237 data)
2244 info))))))))
2245 ;; Final result will be memoized before being returned.
2247 data
2251 ;; Append the same white space between elements or objects as in
2252 ;; the original buffer, and call appropriate filters.
2263 info)))
2264 results)))
2268 "Convert DATA into BACKEND format.
2270 DATA is an element, an object, a secondary string or a string.
2271 BACKEND is a symbol. INFO is a plist used as a communication
2272 channel.
2274 Unlike to `org-export-with-backend', this function will
2275 recursively convert DATA using BACKEND translation table."
2278 data
2279 ;; Set-up a new communication channel with translations defined in
2280 ;; BACKEND as the translate table and a new hash table for
2281 ;; memoization.
2283 info
2286 ;; Size of the hash table is reduced since this function
2287 ;; will probably be used on small trees.
2291 "Non-nil if element or object BLOB should be interpreted during export.
2292 If nil, BLOB will appear as raw Org syntax. Check is done
2293 according to export options INFO, stored as a plist."
2295 ;; ... entities...
2297 ;; ... emphasis...
2300 ;; ... fixed-width areas.
2302 ;; ... LaTeX environments and fragments...
2306 ;; ... sub/superscripts...
2312 ;; ... tables...
2317 "Expand a parsed element or object to its original state.
2319 BLOB is either an element or an object. CONTENTS is its
2320 contents, as a string or nil.
2322 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2323 keywords before output."
2328 blob contents))))
2331 "Add ELEMENT to `:ignore-list' in INFO.
2333 Any element in `:ignore-list' will be skipped when using
2334 `org-element-map'. INFO is modified by side effects."
2338 \f
2339 ;;; The Filter System
2340 ;;
2341 ;; Filters allow end-users to tweak easily the transcoded output.
2342 ;; They are the functional counterpart of hooks, as every filter in
2343 ;; a set is applied to the return value of the previous one.
2344 ;;
2345 ;; Every set is back-end agnostic. Although, a filter is always
2346 ;; called, in addition to the string it applies to, with the back-end
2347 ;; used as argument, so it's easy for the end-user to add back-end
2348 ;; specific filters in the set. The communication channel, as
2349 ;; a plist, is required as the third argument.
2350 ;;
2351 ;; From the developer side, filters sets can be installed in the
2352 ;; process with the help of `org-export-define-backend', which
2353 ;; internally stores filters as an alist. Each association has a key
2354 ;; among the following symbols and a function or a list of functions
2355 ;; as value.
2356 ;;
2357 ;; - `:filter-options' applies to the property list containing export
2358 ;; options. Unlike to other filters, functions in this list accept
2359 ;; two arguments instead of three: the property list containing
2360 ;; export options and the back-end. Users can set its value through
2361 ;; `org-export-filter-options-functions' variable.
2362 ;;
2363 ;; - `:filter-parse-tree' applies directly to the complete parsed
2364 ;; tree. Users can set it through
2365 ;; `org-export-filter-parse-tree-functions' variable.
2366 ;;
2367 ;; - `:filter-final-output' applies to the final transcoded string.
2368 ;; Users can set it with `org-export-filter-final-output-functions'
2369 ;; variable
2370 ;;
2371 ;; - `:filter-plain-text' applies to any string not recognized as Org
2372 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2373 ;; configure it.
2374 ;;
2375 ;; - `:filter-TYPE' applies on the string returned after an element or
2376 ;; object of type TYPE has been transcoded. A user can modify
2377 ;; `org-export-filter-TYPE-functions'
2378 ;;
2379 ;; All filters sets are applied with
2380 ;; `org-export-filter-apply-functions' function. Filters in a set are
2381 ;; applied in a LIFO fashion. It allows developers to be sure that
2382 ;; their filters will be applied first.
2383 ;;
2384 ;; Filters properties are installed in communication channel with
2385 ;; `org-export-install-filters' function.
2386 ;;
2387 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2388 ;; `org-export-before-parsing-hook') are run at the beginning of the
2389 ;; export process and just before parsing to allow for heavy structure
2390 ;; modifications.
2393 ;;;; Hooks
2396 "Hook run at the beginning of the export process.
2398 This is run before include keywords and macros are expanded and
2399 Babel code blocks executed, on a copy of the original buffer
2400 being exported. Visibility and narrowing are preserved. Point
2401 is at the beginning of the buffer.
2403 Every function in this hook will be called with one argument: the
2407 "Hook run before parsing an export buffer.
2409 This is run after include keywords and macros have been expanded
2410 and Babel code blocks executed, on a copy of the original buffer
2411 being exported. Visibility and narrowing are preserved. Point
2412 is at the beginning of the buffer.
2414 Every function in this hook will be called with one argument: the
2418 ;;;; Special Filters
2421 "List of functions applied to the export options.
2422 Each filter is called with two arguments: the export options, as
2423 a plist, and the back-end, as a symbol. It must return
2427 "List of functions applied to the parsed tree.
2428 Each filter is called with three arguments: the parse tree, as
2429 returned by `org-element-parse-buffer', the back-end, as
2430 a symbol, and the communication channel, as a plist. It must
2434 "List of functions applied to plain text.
2435 Each filter is called with three arguments: a string which
2436 contains no Org syntax, the back-end, as a symbol, and the
2437 communication channel, as a plist. It must return a string or
2441 "List of functions applied to the transcoded string.
2442 Each filter is called with three arguments: the full transcoded
2443 string, the back-end, as a symbol, and the communication channel,
2444 as a plist. It must return a string that will be used as the
2448 ;;;; Elements Filters
2451 "List of functions applied to a transcoded babel-call.
2452 Each filter is called with three arguments: the transcoded data,
2453 as a string, the back-end, as a symbol, and the communication
2457 "List of functions applied to a transcoded center block.
2458 Each filter is called with three arguments: the transcoded data,
2459 as a string, the back-end, as a symbol, and the communication
2463 "List of functions applied to a transcoded clock.
2464 Each filter is called with three arguments: the transcoded data,
2465 as a string, the back-end, as a symbol, and the communication
2469 "List of functions applied to a transcoded comment.
2470 Each filter is called with three arguments: the transcoded data,
2471 as a string, the back-end, as a symbol, and the communication
2475 "List of functions applied to a transcoded comment-block.
2476 Each filter is called with three arguments: the transcoded data,
2477 as a string, the back-end, as a symbol, and the communication
2481 "List of functions applied to a transcoded diary-sexp.
2482 Each filter is called with three arguments: the transcoded data,
2483 as a string, the back-end, as a symbol, and the communication
2487 "List of functions applied to a transcoded drawer.
2488 Each filter is called with three arguments: the transcoded data,
2489 as a string, the back-end, as a symbol, and the communication
2493 "List of functions applied to a transcoded dynamic-block.
2494 Each filter is called with three arguments: the transcoded data,
2495 as a string, the back-end, as a symbol, and the communication
2499 "List of functions applied to a transcoded example-block.
2500 Each filter is called with three arguments: the transcoded data,
2501 as a string, the back-end, as a symbol, and the communication
2505 "List of functions applied to a transcoded export-block.
2506 Each filter is called with three arguments: the transcoded data,
2507 as a string, the back-end, as a symbol, and the communication
2511 "List of functions applied to a transcoded fixed-width.
2512 Each filter is called with three arguments: the transcoded data,
2513 as a string, the back-end, as a symbol, and the communication
2517 "List of functions applied to a transcoded footnote-definition.
2518 Each filter is called with three arguments: the transcoded data,
2519 as a string, the back-end, as a symbol, and the communication
2523 "List of functions applied to a transcoded headline.
2524 Each filter is called with three arguments: the transcoded data,
2525 as a string, the back-end, as a symbol, and the communication
2529 "List of functions applied to a transcoded horizontal-rule.
2530 Each filter is called with three arguments: the transcoded data,
2531 as a string, the back-end, as a symbol, and the communication
2535 "List of functions applied to a transcoded inlinetask.
2536 Each filter is called with three arguments: the transcoded data,
2537 as a string, the back-end, as a symbol, and the communication
2541 "List of functions applied to a transcoded item.
2542 Each filter is called with three arguments: the transcoded data,
2543 as a string, the back-end, as a symbol, and the communication
2547 "List of functions applied to a transcoded keyword.
2548 Each filter is called with three arguments: the transcoded data,
2549 as a string, the back-end, as a symbol, and the communication
2553 "List of functions applied to a transcoded latex-environment.
2554 Each filter is called with three arguments: the transcoded data,
2555 as a string, the back-end, as a symbol, and the communication
2559 "List of functions applied to a transcoded node-property.
2560 Each filter is called with three arguments: the transcoded data,
2561 as a string, the back-end, as a symbol, and the communication
2565 "List of functions applied to a transcoded paragraph.
2566 Each filter is called with three arguments: the transcoded data,
2567 as a string, the back-end, as a symbol, and the communication
2571 "List of functions applied to a transcoded plain-list.
2572 Each filter is called with three arguments: the transcoded data,
2573 as a string, the back-end, as a symbol, and the communication
2577 "List of functions applied to a transcoded planning.
2578 Each filter is called with three arguments: the transcoded data,
2579 as a string, the back-end, as a symbol, and the communication
2583 "List of functions applied to a transcoded property-drawer.
2584 Each filter is called with three arguments: the transcoded data,
2585 as a string, the back-end, as a symbol, and the communication
2589 "List of functions applied to a transcoded quote block.
2590 Each filter is called with three arguments: the transcoded quote
2591 data, as a string, the back-end, as a symbol, and the
2592 communication channel, as a plist. It must return a string or
2596 "List of functions applied to a transcoded quote-section.
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 section.
2603 Each filter is called with three arguments: the transcoded data,
2604 as a string, the back-end, as a symbol, and the communication
2608 "List of functions applied to a transcoded special block.
2609 Each filter is called with three arguments: the transcoded data,
2610 as a string, the back-end, as a symbol, and the communication
2614 "List of functions applied to a transcoded src-block.
2615 Each filter is called with three arguments: the transcoded data,
2616 as a string, the back-end, as a symbol, and the communication
2620 "List of functions applied to a transcoded table.
2621 Each filter is called with three arguments: the transcoded data,
2622 as a string, the back-end, as a symbol, and the communication
2626 "List of functions applied to a transcoded table-cell.
2627 Each filter is called with three arguments: the transcoded data,
2628 as a string, the back-end, as a symbol, and the communication
2632 "List of functions applied to a transcoded table-row.
2633 Each filter is called with three arguments: the transcoded data,
2634 as a string, the back-end, as a symbol, and the communication
2638 "List of functions applied to a transcoded verse block.
2639 Each filter is called with three arguments: the transcoded data,
2640 as a string, the back-end, as a symbol, and the communication
2644 ;;;; Objects Filters
2647 "List of functions applied to transcoded bold text.
2648 Each filter is called with three arguments: the transcoded data,
2649 as a string, the back-end, as a symbol, and the communication
2653 "List of functions applied to transcoded code text.
2654 Each filter is called with three arguments: the transcoded data,
2655 as a string, the back-end, as a symbol, and the communication
2659 "List of functions applied to a transcoded entity.
2660 Each filter is called with three arguments: the transcoded data,
2661 as a string, the back-end, as a symbol, and the communication
2665 "List of functions applied to a transcoded export-snippet.
2666 Each filter is called with three arguments: the transcoded data,
2667 as a string, the back-end, as a symbol, and the communication
2671 "List of functions applied to a transcoded footnote-reference.
2672 Each filter is called with three arguments: the transcoded data,
2673 as a string, the back-end, as a symbol, and the communication
2677 "List of functions applied to a transcoded inline-babel-call.
2678 Each filter is called with three arguments: the transcoded data,
2679 as a string, the back-end, as a symbol, and the communication
2683 "List of functions applied to a transcoded inline-src-block.
2684 Each filter is called with three arguments: the transcoded data,
2685 as a string, the back-end, as a symbol, and the communication
2689 "List of functions applied to transcoded italic text.
2690 Each filter is called with three arguments: the transcoded data,
2691 as a string, the back-end, as a symbol, and the communication
2695 "List of functions applied to a transcoded latex-fragment.
2696 Each filter is called with three arguments: the transcoded data,
2697 as a string, the back-end, as a symbol, and the communication
2701 "List of functions applied to a transcoded line-break.
2702 Each filter is called with three arguments: the transcoded data,
2703 as a string, the back-end, as a symbol, and the communication
2707 "List of functions applied to a transcoded link.
2708 Each filter is called with three arguments: the transcoded data,
2709 as a string, the back-end, as a symbol, and the communication
2713 "List of functions applied to a transcoded radio-target.
2714 Each filter is called with three arguments: the transcoded data,
2715 as a string, the back-end, as a symbol, and the communication
2719 "List of functions applied to a transcoded statistics-cookie.
2720 Each filter is called with three arguments: the transcoded data,
2721 as a string, the back-end, as a symbol, and the communication
2725 "List of functions applied to transcoded strike-through text.
2726 Each filter is called with three arguments: the transcoded data,
2727 as a string, the back-end, as a symbol, and the communication
2731 "List of functions applied to a transcoded subscript.
2732 Each filter is called with three arguments: the transcoded data,
2733 as a string, the back-end, as a symbol, and the communication
2737 "List of functions applied to a transcoded superscript.
2738 Each filter is called with three arguments: the transcoded data,
2739 as a string, the back-end, as a symbol, and the communication
2743 "List of functions applied to a transcoded target.
2744 Each filter is called with three arguments: the transcoded data,
2745 as a string, the back-end, as a symbol, and the communication
2749 "List of functions applied to a transcoded timestamp.
2750 Each filter is called with three arguments: the transcoded data,
2751 as a string, the back-end, as a symbol, and the communication
2755 "List of functions applied to transcoded underline text.
2756 Each filter is called with three arguments: the transcoded data,
2757 as a string, the back-end, as a symbol, and the communication
2761 "List of functions applied to transcoded verbatim text.
2762 Each filter is called with three arguments: the transcoded data,
2763 as a string, the back-end, as a symbol, and the communication
2767 ;;;; Filters Tools
2768 ;;
2769 ;; Internal function `org-export-install-filters' installs filters
2770 ;; hard-coded in back-ends (developer filters) and filters from global
2771 ;; variables (user filters) in the communication channel.
2772 ;;
2773 ;; Internal function `org-export-filter-apply-functions' takes care
2774 ;; about applying each filter in order to a given data. It ignores
2775 ;; filters returning a nil value but stops whenever a filter returns
2776 ;; an empty string.
2779 "Call every function in FILTERS.
2781 Functions are called with arguments VALUE, current export
2782 back-end's name and INFO. A function returning a nil value will
2783 be skipped. If it returns the empty string, the process ends and
2784 VALUE is ignored.
2786 Call is done in a LIFO fashion, to be sure that developer
2787 specified filters, if any, are called first."
2798 "Install filters properties in communication channel.
2799 INFO is a plist containing the current communication channel.
2800 Return the updated communication channel."
2802 ;; Install user-defined filters with `org-export-filters-alist'
2803 ;; and filters already in INFO (through ext-plist mechanism).
2810 ;; Filters in INFO will be called
2811 ;; before those user provided.
2814 default-value)))))
2815 org-export-filters-alist)
2816 ;; Prepend back-end specific filters to that list.
2818 ;; Single values get consed, lists are appended.
2823 plist key
2827 ;; Return new communication channel.
2831 \f
2832 ;;; Core functions
2833 ;;
2834 ;; This is the room for the main function, `org-export-as', along with
2835 ;; its derivative, `org-export-string-as'.
2836 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2837 ;; function should be added to kill ring.
2838 ;;
2839 ;; Note that `org-export-as' doesn't really parse the current buffer,
2840 ;; but a copy of it (with the same buffer-local variables and
2841 ;; visibility), where macros and include keywords are expanded and
2842 ;; Babel blocks are executed, if appropriate.
2843 ;; `org-export-with-buffer-copy' macro prepares that copy.
2844 ;;
2845 ;; File inclusion is taken care of by
2846 ;; `org-export-expand-include-keyword' and
2847 ;; `org-export--prepare-file-contents'. Structure wise, including
2848 ;; a whole Org file in a buffer often makes little sense. For
2849 ;; example, if the file contains a headline and the include keyword
2850 ;; was within an item, the item should contain the headline. That's
2851 ;; why file inclusion should be done before any structure can be
2852 ;; associated to the file, that is before parsing.
2853 ;;
2854 ;; `org-export-insert-default-template' is a command to insert
2855 ;; a default template (or a back-end specific template) at point or in
2856 ;; current subtree.
2859 "Return a copy of the current buffer.
2860 The copy preserves Org buffer-local variables, visibility and
2861 narrowing."
2867 new-buf))
2870 "Apply BODY in a copy of the current buffer.
2871 The copy preserves local variables, visibility and contents of
2872 the original buffer. Point is at the beginning of the buffer
2873 when BODY is applied."
2882 ;; Kill copy without confirmation.
2888 "Generate a function duplicating BUFFER.
2890 The copy will preserve local variables, visibility, contents and
2891 narrowing of the original buffer. If a region was active in
2892 BUFFER, contents will be narrowed to that region instead.
2894 The resulting function can be evaled at a later time, from
2895 another buffer, effectively cloning the original buffer there.
2897 The function assumes BUFFER's major mode is `org-mode'."
2901 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2902 ;; already in BUFFER.
2904 ;; Copy specific buffer local variables and variables set
2905 ;; through BIND keywords.
2907 vars)
2915 buffer-file-name
2916 buffer-file-coding-system))
2920 ;; Skip unreadable values, as they cannot be
2921 ;; sent to external process.
2925 vars))))))
2926 ;; Whole buffer contents.
2931 ;; Narrowing.
2935 ;; Current position of point.
2937 ;; Overlays with invisible property.
2947 ov-set))))
2949 ov-set)))))
2951 ;;;###autoload
2954 "Transcode current Org buffer into BACKEND code.
2956 BACKEND is either an export back-end, as returned by, e.g.,
2957 `org-export-create-backend', or a symbol referring to
2958 a registered back-end.
2960 If narrowing is active in the current buffer, only transcode its
2961 narrowed part.
2963 If a region is active, transcode that region.
2965 When optional argument SUBTREEP is non-nil, transcode the
2966 sub-tree at point, extracting information from the headline
2967 properties first.
2969 When optional argument VISIBLE-ONLY is non-nil, don't export
2970 contents of hidden elements.
2972 When optional argument BODY-ONLY is non-nil, only return body
2973 code, without surrounding template.
2975 Optional argument EXT-PLIST, when provided, is a property list
2976 with external parameters overriding Org default settings, but
2977 still inferior to file-local settings.
2979 Return code as a string."
2984 ;; Narrow buffer to an appropriate region or subtree for
2985 ;; parsing. If parsing subtree, be sure to remove main headline
2986 ;; too.
2994 ;; Initialize communication channel with original buffer
2995 ;; attributes, unavailable in its copy.
3004 tree)
3005 ;; Update communication channel and get parse tree. Buffer
3006 ;; isn't parsed directly. Instead, a temporary copy is
3007 ;; created, where include keywords, macros are expanded and
3008 ;; code blocks are evaluated.
3010 ;; Run first hook with current back-end's name as argument.
3014 ;; Update macro templates since #+INCLUDE keywords might have
3015 ;; added some new ones.
3019 ;; Update radio targets since keyword inclusion might have
3020 ;; added some more.
3022 ;; Run last hook with current back-end's name as argument.
3027 ;; Update communication channel with environment. Also
3028 ;; install user's and developer's filters.
3033 ;; Expand export-specific set of macros: {{{author}}},
3034 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3035 ;; once regular macros have been expanded, since document
3036 ;; keywords may contain one of them.
3042 ;; EMAIL is not a parsed keyword: store it as-is.
3046 ;; Call options filters and update export options. We do not
3047 ;; use `org-export-filter-apply-functions' here since the
3048 ;; arity of such filters is different.
3053 ;; Parse buffer and call parse-tree filter on it.
3058 ;; Now tree is complete, compute its properties and add them
3059 ;; to communication channel.
3063 ;; Eventually transcode TREE. Wrap the resulting string into
3064 ;; a template.
3073 ;; Remove all text properties since they cannot be
3074 ;; retrieved from an external process. Finally call
3075 ;; final-output filter and return result.
3081 info))))))))
3083 ;;;###autoload
3085 "Transcode STRING into BACKEND code.
3087 BACKEND is either an export back-end, as returned by, e.g.,
3088 `org-export-create-backend', or a symbol referring to
3089 a registered back-end.
3091 When optional argument BODY-ONLY is non-nil, only return body
3092 code, without preamble nor postamble.
3094 Optional argument EXT-PLIST, when provided, is a property list
3095 with external parameters overriding Org default settings, but
3096 still inferior to file-local settings.
3098 Return code as a string."
3104 ;;;###autoload
3106 "Replace the active region by its export to BACKEND.
3107 BACKEND is either an export back-end, as returned by, e.g.,
3108 `org-export-create-backend', or a symbol referring to
3109 a registered back-end."
3119 ;;;###autoload
3121 "Insert all export keywords with default values at beginning of line.
3123 BACKEND is a symbol referring to the name of a registered export
3124 back-end, for which specific export options should be added to
3125 the template, or `default' for default template. When it is nil,
3126 the user will be prompted for a category.
3128 If SUBTREEP is non-nil, export configuration will be set up
3129 locally for the subtree through node properties."
3139 "Options category: "
3143 org-export--registered-backends))))))
3144 options keywords)
3145 ;; Populate OPTIONS and KEYWORDS.
3162 ;; Move to an appropriate location in order to insert options.
3164 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3165 ;; list of available keywords.
3193 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3212 ;; And the rest of keywords.
3223 "Expand every include keyword in buffer.
3224 Optional argument INCLUDED is a list of included file names along
3225 with their line restriction, when appropriate. It is used to
3226 avoid infinite recursion. Optional argument DIR is the current
3227 working directory. It is used to properly resolve relative
3228 paths."
3235 ;; Extract arguments from keyword's value.
3243 dir)
3248 value)
3254 ;; Minimal level of included file defaults to the child
3255 ;; level of the current headline, if any, or one. It
3256 ;; only applies is the file is meant to be included as
3257 ;; an Org one.
3265 ;; Remove keyword.
3271 ;; Check if files has already been parsed. Look after
3272 ;; inclusion lines too, as different parts of the same file
3273 ;; can be included too.
3285 ind-str contents ind-str))))
3293 ind-str env contents ind-str))))
3306 "Prepare the contents of FILE for inclusion and return them as a string.
3308 When optional argument LINES is a string specifying a range of
3309 lines, include only those lines.
3311 Optional argument IND, when non-nil, is an integer specifying the
3312 global indentation of returned contents. Since its purpose is to
3313 allow an included file to stay in the same environment it was
3314 created \(i.e. a list item), it doesn't apply past the first
3315 headline encountered.
3317 Optional argument MINLEVEL, when non-nil, is an integer
3318 specifying the level that any top-level headline in the included
3319 file should have."
3335 ;; Remove blank lines at beginning and end of contents. The logic
3336 ;; behind that removal is that blank lines around include keyword
3337 ;; override blank lines in included file.
3346 ;; If IND is set, preserve indentation of include keyword until
3347 ;; the first headline encountered.
3354 ;; Do not move footnote definitions out of column 0.
3360 ;; When MINLEVEL is specified, compute minimal level for headlines
3361 ;; in the file (CUR-MIN), and remove stars to each headline so
3362 ;; that headlines with minimal level have a level of MINLEVEL.
3373 ;; Only change stars, don't bother moving whole
3374 ;; sections.
3381 "Execute every Babel code in the visible part of current buffer."
3382 ;; Get a pristine copy of current buffer so Babel references can be
3383 ;; properly resolved.
3390 "Return a non-nil value when output should be added to the kill ring.
3391 See also `org-export-copy-to-kill-ring'."
3397 \f
3398 ;;; Tools For Back-Ends
3399 ;;
3400 ;; A whole set of tools is available to help build new exporters. Any
3401 ;; function general enough to have its use across many back-ends
3402 ;; should be added here.
3404 ;;;; For Affiliated Keywords
3405 ;;
3406 ;; `org-export-read-attribute' reads a property from a given element
3407 ;; as a plist. It can be used to normalize affiliated keywords'
3408 ;; syntax.
3409 ;;
3410 ;; Since captions can span over multiple lines and accept dual values,
3411 ;; their internal representation is a bit tricky. Therefore,
3412 ;; `org-export-get-caption' transparently returns a given element's
3413 ;; caption as a secondary string.
3416 "Turn ATTRIBUTE property from ELEMENT into a plist.
3418 When optional argument PROPERTY is non-nil, return the value of
3419 that property within attributes.
3423 properties.
3425 All values will become strings except the empty string and
3428 will become the empty string."
3442 s)
3447 ;; Ignore any string before first property with `cdr'.
3452 "Return caption from ELEMENT as a secondary string.
3454 When optional argument SHORTP is non-nil, return short caption,
3455 as a secondary string, instead.
3457 Caption lines are separated by a white space."
3465 ;;;; For Derived Back-ends
3466 ;;
3467 ;; `org-export-with-backend' is a function allowing to locally use
3468 ;; another back-end to transcode some object or element. In a derived
3469 ;; back-end, it may be used as a fall-back function once all specific
3470 ;; cases have been treated.
3473 "Call a transcoder from BACKEND on DATA.
3474 BACKEND is an export back-end, as returned by, e.g.,
3475 `org-export-create-backend', or a symbol referring to
3476 a registered back-end. DATA is an Org element, object, secondary
3477 string or string. CONTENTS, when non-nil, is the transcoded
3478 contents of DATA element, as a string. INFO, when non-nil, is
3479 the communication channel used for export, as a plist."
3490 ;;;; For Export Snippets
3491 ;;
3492 ;; Every export snippet is transmitted to the back-end. Though, the
3493 ;; latter will only retain one type of export-snippet, ignoring
3494 ;; others, based on the former's target back-end. The function
3495 ;; `org-export-snippet-backend' returns that back-end for a given
3496 ;; export-snippet.
3499 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3500 Translation, with `org-export-snippet-translation-alist', is
3501 applied."
3505 back-end))))
3508 ;;;; For Footnotes
3509 ;;
3510 ;; `org-export-collect-footnote-definitions' is a tool to list
3511 ;; actually used footnotes definitions in the whole parse tree, or in
3512 ;; a headline, in order to add footnote listings throughout the
3513 ;; transcoded data.
3514 ;;
3515 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3516 ;; back-ends, when they need to attach the footnote definition only to
3517 ;; the first occurrence of the corresponding label.
3518 ;;
3519 ;; `org-export-get-footnote-definition' and
3520 ;; `org-export-get-footnote-number' provide easier access to
3521 ;; additional information relative to a footnote reference.
3524 "Return an alist between footnote numbers, labels and definitions.
3526 DATA is the parse tree from which definitions are collected.
3527 INFO is the plist used as a communication channel.
3529 Definitions are sorted by order of references. They either
3530 appear as Org data or as a secondary string for inlined
3531 footnotes. Unreferenced definitions are ignored."
3533 collect-fn ; for byte-compiler.
3537 ;; Collect footnote number, label and definition in DATA.
3545 def)
3546 num-alist)
3547 ;; Also search in definition for nested footnotes.
3550 ;; Don't enter footnote definitions since it will happen
3551 ;; when their first reference is found.
3557 "Non-nil when a footnote reference is the first one for its label.
3559 FOOTNOTE-REFERENCE is the footnote reference being considered.
3560 INFO is the plist used as a communication channel."
3562 ;; Anonymous footnotes are always a first reference.
3564 ;; Otherwise, return the first footnote with the same LABEL and
3565 ;; test if it is equal to FOOTNOTE-REFERENCE.
3575 ;; If FN isn't inlined, be sure to traverse its
3576 ;; definition before resuming search. See
3577 ;; comments in `org-export-get-footnote-number'
3578 ;; for more information.
3582 ;; Don't enter footnote definitions since it will
3583 ;; happen when their first reference is found.
3586 footnote-reference)))))
3589 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3590 INFO is the plist used as a communication channel. If no such
3592 string."
3599 "Return number associated to a footnote.
3601 FOOTNOTE is either a footnote reference or a footnote definition.
3602 INFO is the plist used as a communication channel."
3604 seen-refs
3605 search-ref ; For byte-compiler.
3609 ;; Search footnote references through DATA, filling
3610 ;; SEEN-REFS along the way.
3615 ;; Anonymous footnote match: return number.
3618 ;; Labels match: return number.
3621 ;; Anonymous footnote: it's always a new one.
3622 ;; Also, be sure to return nil from the `cond' so
3623 ;; `first-match' doesn't get us out of the loop.
3625 ;; Label not seen so far: add it so SEEN-REFS.
3626 ;;
3627 ;; Also search for subsequent references in
3628 ;; footnote definition so numbering follows
3629 ;; reading logic. Note that we don't have to care
3630 ;; about inline definitions, since
3631 ;; `org-element-map' already traverses them at the
3632 ;; right time.
3633 ;;
3634 ;; Once again, return nil to stay in the loop.
3639 nil))))
3640 ;; Don't enter footnote definitions since it will
3641 ;; happen when their first reference is found.
3646 ;;;; For Headlines
3647 ;;
3648 ;; `org-export-get-relative-level' is a shortcut to get headline
3649 ;; level, relatively to the lower headline level in the parsed tree.
3650 ;;
3651 ;; `org-export-get-headline-number' returns the section number of an
3652 ;; headline, while `org-export-number-to-roman' allows to convert it
3653 ;; to roman numbers.
3654 ;;
3655 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3656 ;; `org-export-last-sibling-p' are three useful predicates when it
3657 ;; comes to fulfill the `:headline-levels' property.
3658 ;;
3659 ;; `org-export-get-tags', `org-export-get-category' and
3660 ;; `org-export-get-node-property' extract useful information from an
3661 ;; headline or a parent headline. They all handle inheritance.
3662 ;;
3663 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3664 ;; as a secondary string, suitable for table of contents. It falls
3665 ;; back onto default title.
3668 "Return HEADLINE relative level within current parsed tree.
3669 INFO is a plist holding contextual information."
3674 "Non-nil when HEADLINE is considered as low level.
3676 INFO is a plist used as a communication channel.
3678 A low level headlines has a relative level greater than
3679 `:headline-levels' property value.
3681 Return value is the difference between HEADLINE relative level
3682 and the last level being considered as high enough, or nil."
3689 "Return HEADLINE numbering as a list of numbers.
3690 INFO is a plist holding contextual information."
3694 "Return a non-nil value if HEADLINE element should be numbered.
3695 INFO is a plist used as a communication channel."
3701 "Convert integer N into a roman numeral."
3714 res)))
3717 "Return list of tags associated to ELEMENT.
3719 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3720 is a plist used as a communication channel.
3722 Select tags (see `org-export-select-tags') and exclude tags (see
3723 `org-export-exclude-tags') are removed from the list.
3725 When non-nil, optional argument TAGS should be a list of strings.
3726 Any tag belonging to this list will also be removed.
3728 When optional argument INHERITED is non-nil, tags can also be
3729 inherited from parent headlines and FILETAGS keywords."
3735 ;; Build complete list of inherited tags.
3746 ;; Add FILETAGS keywords and return results.
3750 "Return node PROPERTY value for BLOB.
3752 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3753 element or object.
3755 If optional argument INHERITED is non-nil, the value can be
3756 inherited from a parent headline.
3758 Return value is a string or nil."
3770 "Return category for element or object BLOB.
3772 INFO is a plist used as a communication channel.
3774 CATEGORY is automatically inherited from a parent headline, from
3775 #+CATEGORY: keyword or created out of original file name. If all
3779 ;; Almost like `org-export-node-property', but we cannot trust
3780 ;; `plist-member' as every headline has a `:CATEGORY'
3781 ;; property, would it be nil or equal to "???" (which has the
3782 ;; same meaning).
3800 "Return alternative title for HEADLINE, as a secondary string.
3801 INFO is a plist used as a communication channel. If no optional
3802 title is defined, fall-back to the regular title."
3807 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3808 INFO is a plist used as a communication channel."
3813 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3814 INFO is a plist used as a communication channel."
3818 ;;;; For Keywords
3819 ;;
3820 ;; `org-export-get-date' returns a date appropriate for the document
3821 ;; to about to be exported. In particular, it takes care of
3822 ;; `org-export-date-timestamp-format'.
3825 "Return date value for the current document.
3827 INFO is a plist used as a communication channel. FMT, when
3828 non-nil, is a time format string that will be applied on the date
3829 if it consists in a single timestamp object. It defaults to
3830 `org-export-date-timestamp-format' when nil.
3832 A proper date can be a secondary string, a string or nil. It is
3833 meant to be translated with `org-export-data' or alike."
3844 ;;;; For Links
3845 ;;
3846 ;; `org-export-solidify-link-text' turns a string into a safer version
3847 ;; for links, replacing most non-standard characters with hyphens.
3848 ;;
3849 ;; `org-export-get-coderef-format' returns an appropriate format
3850 ;; string for coderefs.
3851 ;;
3852 ;; `org-export-inline-image-p' returns a non-nil value when the link
3853 ;; provided should be considered as an inline image.
3854 ;;
3855 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3856 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3857 ;; returns an appropriate unique identifier when found, or nil.
3858 ;;
3859 ;; `org-export-resolve-id-link' returns the first headline with
3860 ;; specified id or custom-id in parse tree, the path to the external
3861 ;; file with the id or nil when neither was found.
3862 ;;
3863 ;; `org-export-resolve-coderef' associates a reference to a line
3864 ;; number in the element it belongs, or returns the reference itself
3865 ;; when the element isn't numbered.
3868 "Take link text S and make a safe target out of it."
3873 "Return format string for code reference link.
3874 PATH is the link path. DESC is its description."
3882 "Non-nil if LINK object points to an inline image.
3884 Optional argument is a set of RULES defining inline images. It
3885 is an alist where associations have the following shape:
3887 \(TYPE . REGEXP)
3889 Applying a rule means apply REGEXP against LINK's path when its
3890 type is TYPE. The function will return a non-nil value if any of
3891 the provided rules is non-nil. The default rule is
3892 `org-export-default-inline-image-rule'.
3894 This only applies to links without a description."
3905 rules)
3906 ;; Return nil if no rule matched.
3907 nil))))
3910 "Resolve a code reference REF.
3912 INFO is a plist used as a communication channel.
3914 Return associated line number in source code, or REF itself,
3915 depending on src-block or example element's switches."
3922 org-coderef-label-format)))
3926 ;; Element containing REF is found. Resolve it to either
3927 ;; a label or a line number, as needed.
3937 "Return LINK destination.
3939 INFO is a plist holding contextual information.
3941 Return value can be an object, an element, or nil:
3943 - If LINK path matches a target object (i.e. <<path>>) return it.
3945 - If LINK path exactly matches the name affiliated keyword
3946 \(i.e. #+NAME: path) of an element, return that element.
3948 - If LINK path exactly matches any headline name, return that
3949 element. If more than one headline share that name, priority
3950 will be given to the one with the closest common ancestor, if
3951 any, or the first one in the parse tree otherwise.
3953 - Otherwise, return nil.
3956 significant."
3959 ;; Split PATH at white spaces so matches are space
3960 ;; insensitive.
3963 ;; Cache for destinations that are not position dependent.
3971 ;; Destination is not position dependent: use cached value.
3973 ;; First try to find a matching "<<path>>" unless user specified
3974 ;; he was looking for a headline (path starts with a "*"
3975 ;; character).
3981 path)
3982 blob))
3985 ;; Then try to find an element with a matching "#+NAME: path"
3986 ;; affiliated keyword.
3989 org-element-all-elements
3994 el)))
3997 ;; Last case: link either points to a headline or to nothingness.
3998 ;; Try to find the source, with priority given to headlines with
3999 ;; the closest common ancestor. If such candidate is found,
4000 ;; return it, otherwise return nil.
4004 ;; Return first headline whose `:raw-value' property is
4005 ;; NAME in parse tree DATA, or nil. Statistics cookies
4006 ;; are ignored.
4014 name)
4015 headline))
4017 ;; Search among headlines sharing an ancestor with link, from
4018 ;; closest to farthest.
4027 ;; No destination found: return nil.
4031 "Return headline referenced as LINK destination.
4033 INFO is a plist used as a communication channel.
4035 Return value can be the headline element matched in current parse
4039 ;; First check if id is within the current parse tree.
4044 headline))
4046 ;; Otherwise, look for external files.
4050 "Return radio-target object referenced as LINK destination.
4052 INFO is a plist used as a communication channel.
4054 Return value can be a radio-target object or nil. Assume LINK
4063 nil nil path nil nil t)
4064 t)
4065 radio))
4069 ;;;; For References
4070 ;;
4071 ;; `org-export-get-ordinal' associates a sequence number to any object
4072 ;; or element.
4075 "Return ordinal number of an element or object.
4077 ELEMENT is the element or object considered. INFO is the plist
4078 used as a communication channel.
4080 Optional argument TYPES, when non-nil, is a list of element or
4081 object types, as symbols, that should also be counted in.
4082 Otherwise, only provided element's type is considered.
4084 Optional argument PREDICATE is a function returning a non-nil
4085 value if the current element or object should be counted in. It
4086 accepts two arguments: the element or object being considered and
4087 the plist used as a communication channel. This allows to count
4088 only a certain type of objects (i.e. inline images).
4090 Return value is a list of numbers if ELEMENT is a headline or an
4091 item. It is nil for keywords. It represents the footnote number
4092 for footnote definitions and footnote references. If ELEMENT is
4093 a target, return the same value as if ELEMENT was the closest
4094 table, item or headline containing the target. In any other
4095 case, return the sequence number of ELEMENT among elements or
4096 objects of the same type."
4097 ;; Ordinal of a target object refer to the ordinal of the closest
4098 ;; table, item, or headline containing the object.
4102 when
4106 table))
4107 return parent)))
4109 ;; Special case 1: A headline returns its number as a list.
4111 ;; Special case 2: An item returns its number as a list.
4115 struct
4122 ;; Increment counter until ELEMENT is found again.
4133 ;;;; For Src-Blocks
4134 ;;
4135 ;; `org-export-get-loc' counts number of code lines accumulated in
4136 ;; src-block or example-block elements with a "+n" switch until
4137 ;; a given element, excluded. Note: "-n" switches reset that count.
4138 ;;
4139 ;; `org-export-unravel-code' extracts source code (along with a code
4140 ;; references alist) from an `element-block' or `src-block' type
4141 ;; element.
4142 ;;
4143 ;; `org-export-format-code' applies a formatting function to each line
4144 ;; of code, providing relative line number and code reference when
4145 ;; appropriate. Since it doesn't access the original element from
4146 ;; which the source code is coming, it expects from the code calling
4147 ;; it to know if lines should be numbered and if code references
4148 ;; should appear.
4149 ;;
4150 ;; Eventually, `org-export-format-code-default' is a higher-level
4151 ;; function (it makes use of the two previous functions) which handles
4152 ;; line numbering and code references inclusion, and returns source
4153 ;; code in a format suitable for plain text or verbatim output.
4156 "Return accumulated lines of code up to ELEMENT.
4158 INFO is the plist used as a communication channel.
4160 ELEMENT is excluded from count."
4166 ;; ELEMENT is reached: Quit the loop.
4168 ;; Only count lines from src-block and example-block elements
4169 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4173 ;; Accumulate locs or reset them.
4177 ;; Return nil to stay in the loop.
4178 nil)))
4180 ;; Return value.
4181 loc))
4184 "Clean source code and extract references out of it.
4186 ELEMENT has either a `src-block' an `example-block' type.
4188 Return a cons cell whose CAR is the source code, cleaned from any
4189 reference and protective comma and CDR is an alist between
4190 relative line number (integer) and name of code reference on that
4191 line (string)."
4193 ;; Get code and clean it. Remove blank lines at its
4194 ;; beginning and end.
4200 ;; Get format used for references.
4203 org-coderef-label-format)))
4204 ;; Build a regexp matching a loc with a reference.
4209 ;; Return value.
4211 ;; Code with references removed.
4217 ;; Ref line: remove ref, and signal its position in REFS.
4221 ;; Reference alist.
4222 refs)))
4225 "Format CODE by applying FUN line-wise and return it.
4227 CODE is a string representing the code to format. FUN is
4228 a function. It must accept three arguments: a line of
4229 code (string), the current line number (integer) or nil and the
4230 reference associated to the current line (string) or nil.
4232 Optional argument NUM-LINES can be an integer representing the
4233 number of code lines accumulated until the current code. Line
4234 numbers passed to FUN will take it into account. If it is nil,
4235 FUN's second argument will always be nil. This number can be
4236 obtained with `org-export-get-loc' function.
4238 Optional argument REF-ALIST can be an alist between relative line
4239 number (i.e. ignoring NUM-LINES) and the name of the code
4240 reference on it. If it is nil, FUN's third argument will always
4241 be nil. It can be obtained through the use of
4242 `org-export-unravel-code' function."
4254 "Return source code from ELEMENT, formatted in a standard way.
4256 ELEMENT is either a `src-block' or `example-block' element. INFO
4257 is a plist used as a communication channel.
4259 This function takes care of line numbering and code references
4260 inclusion. Line numbers, when applicable, appear at the
4261 beginning of the line, separated from the code by two white
4262 spaces. Code references, on the other hand, appear flushed to
4263 the right, separated by six white spaces from the widest line of
4264 code."
4265 ;; Extract code and references.
4272 ;; Handle line numbering.
4281 ;; Prepare references display, if required. Any reference
4282 ;; should start six columns after the widest line of code,
4283 ;; wrapped with parenthesis.
4288 code
4292 number-str
4293 loc
4299 num-start refs)))))
4302 ;;;; For Tables
4303 ;;
4304 ;; `org-export-table-has-special-column-p' and and
4305 ;; `org-export-table-row-is-special-p' are predicates used to look for
4306 ;; meta-information about the table structure.
4307 ;;
4308 ;; `org-table-has-header-p' tells when the rows before the first rule
4309 ;; should be considered as table's header.
4310 ;;
4311 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4312 ;; and `org-export-table-cell-borders' extract information from
4313 ;; a table-cell element.
4314 ;;
4315 ;; `org-export-table-dimensions' gives the number on rows and columns
4316 ;; in the table, ignoring horizontal rules and special columns.
4317 ;; `org-export-table-cell-address', given a table-cell object, returns
4318 ;; the absolute address of a cell. On the other hand,
4319 ;; `org-export-get-table-cell-at' does the contrary.
4320 ;;
4321 ;; `org-export-table-cell-starts-colgroup-p',
4322 ;; `org-export-table-cell-ends-colgroup-p',
4323 ;; `org-export-table-row-starts-rowgroup-p',
4324 ;; `org-export-table-row-ends-rowgroup-p',
4325 ;; `org-export-table-row-starts-header-p' and
4326 ;; `org-export-table-row-ends-header-p' indicate position of current
4327 ;; row or cell within the table.
4330 "Non-nil when TABLE has a special column.
4331 All special columns will be ignored during export."
4332 ;; The table has a special column when every first cell of every row
4333 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4334 ;; "*" "_" and "^". Though, do not consider a first row containing
4335 ;; only empty cells as special.
4351 "Non-nil when TABLE has a header.
4353 INFO is a plist used as a communication channel.
4355 A table has a header when it contains at least two row groups."
4364 table
4375 cache)))))
4378 "Non-nil if TABLE-ROW is considered special.
4380 INFO is a plist used as the communication channel.
4382 All special rows will be ignored during export."
4386 ;; A row is special either when...
4388 ;; ... it starts with a field only containing "/",
4390 ;; ... the table contains a special column and the row start
4391 ;; with a marking character among, "^", "_", "$" or "!",
4395 ;; ... it contains only alignment cookies and empty cells.
4401 ;; Since VALUE is a secondary string, the following
4402 ;; checks avoid expanding it with `org-export-data'.
4414 "Return TABLE-ROW's group number, as an integer.
4416 INFO is a plist used as the communication channel.
4418 Return value is the group number, as an integer, or nil for
4419 special rows and rows separators. First group is also table's
4420 header."
4438 "Return TABLE-CELL contents width.
4440 INFO is a plist used as the communication channel.
4442 Return value is the width given by the last width cookie in the
4443 same column as TABLE-CELL, or nil."
4462 ;; In a special row, try to find a width cookie at COLUMN.
4466 ;; The following checks avoid expanding unnecessarily
4467 ;; the cell with `org-export-data'.
4477 "Return TABLE-CELL contents alignment.
4479 INFO is a plist used as the communication channel.
4481 Return alignment as specified by the last alignment cookie in the
4482 same column as TABLE-CELL. If no such cookie is found, a default
4483 alignment value will be deduced from fraction of numbers in the
4484 column (see `org-table-number-fraction' for more information).
4485 Possible values are `left', `right' and `center'."
4486 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4503 cookie-align
4504 previous-cell-number-p)
4507 ;; In a special row, try to find an alignment cookie at
4508 ;; COLUMN.
4512 ;; Since VALUE is a secondary string, the following
4513 ;; checks avoid useless expansion through
4514 ;; `org-export-data'.
4522 ;; Ignore table rules.
4524 ;; In a standard row, check if cell's contents are
4525 ;; expressing some kind of number. Increase NUMBER-CELLS
4526 ;; accordingly. Though, don't bother if an alignment
4527 ;; cookie has already defined cell's alignment.
4532 info)))
4534 ;; Treat an empty cell as a number if it follows
4535 ;; a number.
4541 ;; Return value. Alignment specified by cookies has
4542 ;; precedence over alignment deduced from cell's contents.
4544 column
4549 org-table-number-fraction)
4554 "Return TABLE-CELL borders.
4556 INFO is a plist used as a communication channel.
4558 Return value is a list of symbols, or nil. Possible values are:
4559 `top', `bottom', `above', `below', `left' and `right'. Note:
4560 `top' (resp. `bottom') only happen for a cell in the first
4561 row (resp. last row) of the table, ignoring table rules, if any.
4563 Returned borders ignore special rows."
4566 borders)
4567 ;; Top/above border? TABLE-CELL has a border above when a rule
4568 ;; used to demarcate row groups can be found above. Hence,
4569 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4570 ;; another regular row has to be found above that rule.
4579 ;; Look at every row before the current one.
4581 ;; No rule above, or rule found starts the table (ignoring any
4582 ;; special row): TABLE-CELL is at the top of the table.
4585 ;; Bottom/below border? TABLE-CELL has a border below when next
4586 ;; non-regular row below is a rule.
4595 ;; Look at every row after the current one.
4597 ;; No rule below, or rule found ends the table (modulo some
4598 ;; special row): TABLE-CELL is at the bottom of the table.
4601 ;; Right/left borders? They can only be specified by column
4602 ;; groups. Column groups are defined in a row starting with "/".
4603 ;; Also a column groups row only contains "<", "<>", ">" or blank
4604 ;; cells.
4621 ;; There's a left border when previous cell, if
4622 ;; any, ends a group, or current one starts one.
4628 ;; There's a right border when next cell, if any,
4629 ;; starts a group, or current one ends one.
4636 ;; Table rows are read in reverse order so last column groups
4637 ;; row has precedence over any previous one.
4639 ;; Return value.
4640 borders))
4643 "Non-nil when TABLE-CELL is at the beginning of a row group.
4644 INFO is a plist used as a communication channel."
4645 ;; A cell starts a column group either when it is at the beginning
4646 ;; of a row (or after the special column, if any) or when it has
4647 ;; a left border.
4650 table-cell)
4654 "Non-nil when TABLE-CELL is at the end of a row group.
4655 INFO is a plist used as a communication channel."
4656 ;; A cell ends a column group either when it is at the end of a row
4657 ;; or when it has a right border.
4660 table-cell)
4664 "Non-nil when TABLE-ROW is at the beginning of a column group.
4665 INFO is a plist used as a communication channel."
4673 "Non-nil when TABLE-ROW is at the end of a column group.
4674 INFO is a plist used as a communication channel."
4682 "Non-nil when TABLE-ROW is the first table header's row.
4683 INFO is a plist used as a communication channel."
4690 "Non-nil when TABLE-ROW is the last table header's row.
4691 INFO is a plist used as a communication channel."
4698 "Return TABLE-ROW number.
4699 INFO is a plist used as a communication channel. Return value is
4700 zero-based and ignores separators. The function returns nil for
4701 special colums and separators."
4713 "Return TABLE dimensions.
4715 INFO is a plist used as a communication channel.
4717 Return value is a CONS like (ROWS . COLUMNS) where
4718 ROWS (resp. COLUMNS) is the number of exportable
4719 rows (resp. columns)."
4721 ;; Set number of rows, and extract first one.
4727 ;; Set number of columns.
4729 ;; Return value.
4733 "Return address of a regular TABLE-CELL object.
4735 TABLE-CELL is the cell considered. INFO is a plist used as
4736 a communication channel.
4738 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4739 zero-based index. Only exportable cells are considered. The
4740 function returns nil for other cells."
4752 "Return regular table-cell object at ADDRESS in TABLE.
4754 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4755 zero-based index. TABLE is a table type element. INFO is
4756 a plist used as a communication channel.
4758 If no table-cell, among exportable cells, is found at ADDRESS,
4759 return nil."
4762 ;; Row at (car address) or nil.
4770 'table-cell
4777 ;;;; For Tables Of Contents
4778 ;;
4779 ;; `org-export-collect-headlines' builds a list of all exportable
4780 ;; headline elements, maybe limited to a certain depth. One can then
4781 ;; easily parse it and transcode it.
4782 ;;
4783 ;; Building lists of tables, figures or listings is quite similar.
4784 ;; Once the generic function `org-export-collect-elements' is defined,
4785 ;; `org-export-collect-tables', `org-export-collect-figures' and
4786 ;; `org-export-collect-listings' can be derived from it.
4789 "Collect headlines in order to build a table of contents.
4791 INFO is a plist used as a communication channel.
4793 When optional argument N is an integer, it specifies the depth of
4794 the table of contents. Otherwise, it is set to the value of the
4795 last headline level. See `org-export-headline-levels' for more
4796 information.
4798 Return a list of all exportable headlines as parsed elements.
4799 Footnote sections, if any, will be ignored."
4807 info)))
4810 "Collect referenceable elements of a determined type.
4812 TYPE can be a symbol or a list of symbols specifying element
4813 types to search. Only elements with a caption are collected.
4815 INFO is a plist used as a communication channel.
4817 When non-nil, optional argument PREDICATE is a function accepting
4818 one argument, an element of type TYPE. It returns a non-nil
4819 value when that element should be collected.
4821 Return a list of all elements found, in order of appearance."
4826 element))
4827 info))
4830 "Build a list of tables.
4831 INFO is a plist used as a communication channel.
4833 Return a list of table elements with a caption."
4837 "Build a list of figures.
4839 INFO is a plist used as a communication channel. PREDICATE is
4840 a function which accepts one argument: a paragraph element and
4841 whose return value is non-nil when that element should be
4842 collected.
4844 A figure is a paragraph type element, with a caption, verifying
4846 a vague concept that may depend on back-end.
4848 Return a list of elements recognized as figures."
4852 "Build a list of src blocks.
4854 INFO is a plist used as a communication channel.
4856 Return a list of src-block elements with a caption."
4860 ;;;; Smart Quotes
4861 ;;
4862 ;; The main function for the smart quotes sub-system is
4863 ;; `org-export-activate-smart-quotes', which replaces every quote in
4864 ;; a given string from the parse tree with its "smart" counterpart.
4865 ;;
4866 ;; Dictionary for smart quotes is stored in
4867 ;; `org-export-smart-quotes-alist'.
4868 ;;
4869 ;; Internally, regexps matching potential smart quotes (checks at
4870 ;; string boundaries are also necessary) are defined in
4871 ;; `org-export-smart-quotes-regexps'.
4875 ;; one may use: »...«, "...", ›...‹, or '...'.
4876 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4877 ;; LaTeX quotes require Babel!
4922 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4931 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4940 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4949 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4955 )
4956 "Smart quotes translations.
4958 Alist whose CAR is a language string and CDR is an alist with
4959 quote type as key and a plist associating various encodings to
4960 their translation as value.
4962 A quote type can be any symbol among `opening-double-quote',
4963 `closing-double-quote', `opening-single-quote',
4964 `closing-single-quote' and `apostrophe'.
4966 Valid encodings include `:utf-8', `:html', `:latex' and
4967 `:texinfo'.
4973 ;; Possible opening quote at beginning of string.
4975 ;; Possible closing quote at beginning of string.
4977 ;; Possible apostrophe at beginning of string.
4979 ;; Opening single and double quotes.
4981 ;; Closing single and double quotes.
4983 ;; Apostrophe.
4985 ;; Possible opening quote at end of string.
4987 ;; Possible closing quote at end of string.
4989 ;; Possible apostrophe at end of string.
4991 "List of regexps matching a quote or an apostrophe.
4997 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4998 `:utf-8'. INFO is a plist used as a communication channel.
5000 The function has to retrieve information about string
5001 surroundings in parse tree. It can only happen with an
5002 unmodified string. Thus, if S has already been through another
5003 process, a non-nil ORIGINAL optional argument will provide that
5004 original string.
5006 Return the new string."
5009 ;; Try to be flexible when computing number of blanks
5010 ;; before object. The previous object may be a string
5011 ;; introduced by the back-end and not completely parsed.
5014 ;; A string with missing `:post-blank'
5015 ;; property.
5019 ;; Fallback value.
5024 ;; Return smart quote associated to a give quote Q, as
5025 ;; a string. TYPE is a symbol among `open', `close' and
5026 ;; `apostrophe'.
5036 org-export-smart-quotes-alist))))
5037 encoding)
5038 q)))))
5040 ;; Only a quote: no regexp can match. We have to check both
5041 ;; sides and decide what to do.
5049 ;; 1. Replace quote character at the beginning of S.
5051 ;; Apostrophe?
5057 ;; Closing quote?
5063 ;; Opening quote?
5069 ;; 2. Replace quotes in the middle of the string.
5071 ;; Opening quotes.
5077 ;; Closing quotes.
5083 ;; Apostrophes.
5088 ;; 3. Replace quote character at the end of S.
5090 ;; Apostrophe?
5095 ;; Closing quote?
5101 ;; Opening quote?
5106 ;; Return string with smart quotes.
5107 s))))
5109 ;;;; Topology
5110 ;;
5111 ;; Here are various functions to retrieve information about the
5112 ;; neighbourhood of a given element or object. Neighbours of interest
5113 ;; are direct parent (`org-export-get-parent'), parent headline
5114 ;; (`org-export-get-parent-headline'), first element containing an
5115 ;; object, (`org-export-get-parent-element'), parent table
5116 ;; (`org-export-get-parent-table'), previous element or object
5117 ;; (`org-export-get-previous-element') and next element or object
5118 ;; (`org-export-get-next-element').
5119 ;;
5120 ;; `org-export-get-genealogy' returns the full genealogy of a given
5121 ;; element or object, from closest parent to full parse tree.
5124 "Return BLOB parent or nil.
5125 BLOB is the element or object considered."
5129 "Return full genealogy relative to a given element or object.
5131 BLOB is the element or object being considered.
5133 Ancestors are returned from closest to farthest, the last one
5134 being the full parse tree."
5141 "Return BLOB parent headline or nil.
5142 BLOB is the element or object being considered."
5146 parent))
5149 "Return first element containing OBJECT or nil.
5150 OBJECT is the object to consider."
5154 parent))
5157 "Return OBJECT parent table or nil.
5158 OBJECT is either a `table-cell' or `table-element' type object."
5162 parent))
5165 "Return previous element or object.
5167 BLOB is an element or object. INFO is a plist used as
5168 a communication channel. Return previous exportable element or
5169 object, a string, or nil.
5171 When optional argument N is a positive integer, return a list
5172 containing up to N siblings before BLOB, from farthest to
5173 closest. With any other non-nil value, return a list containing
5174 all of them."
5176 ;; An object can belong to the contents of its parent or
5177 ;; to a secondary string. We check the latter option
5178 ;; first.
5181 org-element-all-elements))
5185 org-element-secondary-value-alist))
5186 parent)))
5189 prev)
5198 prev)))
5201 "Return next element or object.
5203 BLOB is an element or object. INFO is a plist used as
5204 a communication channel. Return next exportable element or
5205 object, a string, or nil.
5207 When optional argument N is a positive integer, return a list
5208 containing up to N siblings after BLOB, from closest to farthest.
5209 With any other non-nil value, return a list containing all of
5210 them."
5212 ;; An object can belong to the contents of its parent or to
5213 ;; a secondary string. We check the latter option first.
5216 org-element-all-objects))
5220 org-element-secondary-value-alist))
5221 parent)))
5224 next)
5232 siblings)
5236 ;;;; Translation
5237 ;;
5238 ;; `org-export-translate' translates a string according to the language
5239 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5240 ;; the dictionary used for the translation.
5438 "Dictionary for export engine.
5440 Alist whose CAR is the string to translate and CDR is an alist
5441 whose CAR is the language string and CDR is a plist whose
5442 properties are possible charsets and values translated terms.
5444 It is used as a database for `org-export-translate'. Since this
5445 function returns the string as-is if no translation was found,
5446 the variable only needs to record values different from the
5450 "Translate string S according to language specification.
5452 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5453 and `:utf-8'. INFO is a plist used as a communication channel.
5455 Translation depends on `:language' property. Return the
5456 translated string. If no translation is found, try to fall back
5457 to `:default' encoding. If it fails, return S."
5463 s)))
5466 \f
5467 ;;; Asynchronous Export
5468 ;;
5469 ;; `org-export-async-start' is the entry point for asynchronous
5470 ;; export. It recreates current buffer (including visibility,
5471 ;; narrowing and visited file) in an external Emacs process, and
5472 ;; evaluates a command there. It then applies a function on the
5473 ;; returned results in the current process.
5474 ;;
5475 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5476 ;; allow to export to a buffer or a file, asynchronously or not.
5477 ;;
5478 ;; `org-export-output-file-name' is an auxiliary function meant to be
5479 ;; used with `org-export-to-file'. With a given extension, it tries
5480 ;; to provide a canonical file name to write export output to.
5481 ;;
5482 ;; Asynchronously generated results are never displayed directly.
5483 ;; Instead, they are stored in `org-export-stack-contents'. They can
5484 ;; then be retrieved by calling `org-export-stack'.
5485 ;;
5486 ;; Export Stack is viewed through a dedicated major mode
5487 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5488 ;;`org-export-stack-delete', `org-export-stack-view' and
5489 ;;`org-export-stack-clear'.
5490 ;;
5491 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5492 ;; It should be used whenever `org-export-async-start' is called.
5495 "Call function FUN on the results returned by BODY evaluation.
5497 BODY evaluation happens in an asynchronous process, from a buffer
5498 which is an exact copy of the current one.
5500 Use `org-export-add-to-stack' in FUN in order to register results
5501 in the stack.
5503 This is a low level function. See also `org-export-to-buffer'
5504 and `org-export-to-file' for more specialized functions."
5507 ;; Write the full sexp evaluating BODY in a copy of the current
5508 ;; buffer to a temporary file, as it may be too long for program
5509 ;; args in `start-process'.
5516 ;; Null characters (from variable values) are inserted
5517 ;; within the file. As a consequence, coding system for
5518 ;; buffer contents will not be recognized properly. So,
5519 ;; we make sure it is the same as the one used to display
5520 ;; the original buffer.
5522 ,coding
5525 ;; Ignore `kill-emacs-hook' and code evaluation
5526 ;; queries from Babel as we need a truly
5527 ;; non-interactive process.
5529 org-babel-confirm-evaluate-answer-no t)
5530 ;; Initialize export framework.
5532 ;; Re-create current buffer there.
5535 ;; Sexp to evaluate in the buffer.
5537 ;; Start external process.
5540 (,process
5545 "-l" org-export-async-init-file
5547 ;; Register running process in stack.
5549 ;; Set-up sentinel in order to catch results.
5552 ,process
5574 ;;;###autoload
5577 &optional async subtreep visible-only body-only ext-plist
5578 post-process)
5579 "Call `org-export-as' with output to a specified buffer.
5581 BACKEND is either an export back-end, as returned by, e.g.,
5582 `org-export-create-backend', or a symbol referring to
5583 a registered back-end.
5585 BUFFER is the name of the output buffer. If it already exists,
5586 it will be erased first, otherwise, it will be created.
5588 A non-nil optional argument ASYNC means the process should happen
5589 asynchronously. The resulting buffer should then be accessible
5590 through the `org-export-stack' interface. When ASYNC is nil, the
5591 buffer is displayed if `org-export-show-temporary-export-buffer'
5592 is non-nil.
5594 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5595 EXT-PLIST are similar to those used in `org-export-as', which
5596 see.
5598 Optional argument POST-PROCESS is a function which should accept
5599 no argument. It is always called within the current process,
5600 from BUFFER, with point at its beginning. Export back-ends can
5601 use it to set a major mode there, e.g,
5603 \(defun org-latex-export-as-latex
5604 \(&optional async subtreep visible-only body-only ext-plist)
5605 \(interactive)
5607 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5609 This function returns BUFFER."
5637 buffer)))
5639 ;;;###autoload
5642 post-process)
5643 "Call `org-export-as' with output to a specified file.
5645 BACKEND is either an export back-end, as returned by, e.g.,
5646 `org-export-create-backend', or a symbol referring to
5647 a registered back-end. FILE is the name of the output file, as
5648 a string.
5650 A non-nil optional argument ASYNC means the process should happen
5651 asynchronously. The resulting buffer file then be accessible
5652 through the `org-export-stack' interface.
5654 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5655 EXT-PLIST are similar to those used in `org-export-as', which
5656 see.
5658 Optional argument POST-PROCESS is called with FILE as its
5659 argument and happens asynchronously when ASYNC is non-nil. It
5660 has to return a file name, or nil. Export back-ends can use this
5661 to send the output file through additional processing, e.g,
5663 \(defun org-latex-export-to-latex
5664 \(&optional async subtreep visible-only body-only ext-plist)
5665 \(interactive)
5667 \(org-export-to-file 'latex outfile
5668 async subtreep visible-only body-only ext-plist
5669 \(lambda (file) (org-latex-compile file)))
5671 The function returns either a file name returned by POST-PROCESS,
5672 or FILE."
5690 backend subtreep visible-only body-only ext-plist)))
5697 ;; Get proper return value.
5699 file))))))
5702 "Return output file's name according to buffer specifications.
5704 EXTENSION is a string representing the output file extension,
5705 with the leading dot.
5707 With a non-nil optional argument SUBTREEP, try to determine
5709 of subtree at point.
5711 When optional argument PUB-DIR is set, use it as the publishing
5712 directory.
5714 When optional argument VISIBLE-ONLY is non-nil, don't export
5715 contents of hidden elements.
5717 Return file name as a string."
5720 ;; File name may come from EXPORT_FILE_NAME subtree
5721 ;; property, assuming point is at beginning of said
5722 ;; sub-tree.
5729 ;; File name may be extracted from buffer's associated
5730 ;; file, if any.
5732 ;; Can't determine file name on our own: Ask user.
5736 "Output file: " pub-dir nil nil nil
5740 ;; Build file name. Enforce EXTENSION over whatever user
5741 ;; may have come up with. PUB-DIR, if defined, always has
5742 ;; precedence over any provided path.
5747 extension))
5750 ;; If writing to OUTPUT-FILE would overwrite original file, append
5751 ;; EXTENSION another time to final name.
5754 output-file)))
5757 "Add a new result to export stack if not present already.
5759 SOURCE is a buffer or a file name containing export results.
5760 BACKEND is a symbol representing export back-end used to generate
5761 it.
5763 Entries already pointing to SOURCE and unavailable entries are
5764 removed beforehand. Return the new stack."
5770 "Menu for asynchronous export results and running processes."
5780 "Return source from export results at point in stack."
5787 source
5788 ;; SOURCE is not consistent with current line. The stack
5789 ;; view is outdated.
5793 "Remove all entries from export stack."
5798 "Refresh the asynchronous export stack.
5799 DUMMY is ignored. Unavailable sources are removed from the list.
5800 Return the new stack."
5810 ;; Back-end.
5812 ;; Age.
5815 ;; Compute age of the results.
5817 "%4h:%.2m "
5819 ;; Source.
5824 ;; Clear stack from exited processes, dead buffers or
5825 ;; non-existent files.
5837 "Remove export results at point from stack.
5838 If optional argument SOURCE is non-nil, remove it instead."
5843 org-export-stack-contents))))
5846 "View export results at point in stack.
5847 With an optional prefix argument IN-EMACS, force viewing files
5848 within Emacs."
5862 (define-key km "p" 'previous-line)
5863 (define-key km "\C-p" 'previous-line)
5864 (define-key km "\C-?" 'previous-line)
5865 (define-key km [up] 'previous-line)
5866 (define-key km "C" 'org-export-stack-clear)
5867 (define-key km "v" 'org-export-stack-view)
5868 (define-key km (kbd "RET") 'org-export-stack-view)
5869 (define-key km "d" 'org-export-stack-remove)
5870 km)
5871 "Keymap for Org Export Stack.")
5873 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5874 "Mode for displaying asynchronous export stack.
5877 stack.
5879 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5880 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5881 stack completely.
5883 Removing entries in an Org Export Stack buffer doesn't affect
5884 files or buffers, only the display.
5887 (abbrev-mode 0)
5888 (auto-fill-mode 0)
5889 (setq buffer-read-only t
5890 buffer-undo-list t
5891 truncate-lines t
5892 header-line-format
5893 '(:eval
5894 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5895 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5896 (set (make-local-variable 'revert-buffer-function)
5897 'org-export-stack-refresh))
5900 \f
5901 ;;; The Dispatcher
5902 ;;
5903 ;; `org-export-dispatch' is the standard interactive way to start an
5904 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5905 ;; for its interface, which, in turn, delegates response to key
5906 ;; pressed to `org-export--dispatch-action'.
5908 ;;;###autoload
5909 (defun org-export-dispatch (&optional arg)
5910 "Export dispatcher for Org mode.
5912 It provides an access to common export related tasks in a buffer.
5913 Its interface comes in two flavours: standard and expert.
5915 While both share the same set of bindings, only the former
5916 displays the valid keys associations in a dedicated buffer.
5917 Scrolling (resp. line-wise motion) in this buffer is done with
5918 SPC and DEL (resp. C-n and C-p) keys.
5920 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5921 flavour or the other.
5924 of options used back then, on the current buffer.
5926 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5927 (interactive "P")
5928 (let* ((input
5929 (cond ((equal arg '(16)) '(stack))
5930 ((and arg org-export-dispatch-last-action))
5931 (t (save-window-excursion
5932 (unwind-protect
5933 (progn
5934 ;; Remember where we are
5935 (move-marker org-export-dispatch-last-position
5936 (point)
5937 (org-base-buffer (current-buffer)))
5938 ;; Get and store an export command
5939 (setq org-export-dispatch-last-action
5940 (org-export--dispatch-ui
5941 (list org-export-initial-scope
5942 (and org-export-in-background 'async))
5943 nil
5944 org-export-dispatch-use-expert-ui)))
5945 (and (get-buffer "*Org Export Dispatcher*")
5946 (kill-buffer "*Org Export Dispatcher*")))))))
5947 (action (car input))
5948 (optns (cdr input)))
5949 (unless (memq 'subtree optns)
5950 (move-marker org-export-dispatch-last-position nil))
5951 (case action
5952 ;; First handle special hard-coded actions.
5953 (template (org-export-insert-default-template nil optns))
5954 (stack (org-export-stack))
5955 (publish-current-file
5956 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5957 (publish-current-project
5958 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5959 (publish-choose-project
5960 (org-publish (assoc (org-icompleting-read
5961 "Publish project: "
5962 org-publish-project-alist nil t)
5963 org-publish-project-alist)
5964 (memq 'force optns)
5965 (memq 'async optns)))
5966 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5967 (otherwise
5968 (save-excursion
5969 (when arg
5970 ;; Repeating command, maybe move cursor to restore subtree
5971 ;; context.
5972 (if (eq (marker-buffer org-export-dispatch-last-position)
5973 (org-base-buffer (current-buffer)))
5974 (goto-char org-export-dispatch-last-position)
5975 ;; We are in a different buffer, forget position.
5976 (move-marker org-export-dispatch-last-position nil)))
5977 (funcall action
5978 ;; Return a symbol instead of a list to ease
5979 ;; asynchronous export macro use.
5980 (and (memq 'async optns) t)
5981 (and (memq 'subtree optns) t)
5982 (and (memq 'visible optns) t)
5983 (and (memq 'body optns) t)))))))
5985 (defun org-export--dispatch-ui (options first-key expertp)
5986 "Handle interface for `org-export-dispatch'.
5988 OPTIONS is a list containing current interactive options set for
5989 export. It can contain any of the following symbols:
5990 `body' toggles a body-only export
5991 `subtree' restricts export to current subtree
5992 `visible' restricts export to visible part of buffer.
5993 `force' force publishing files.
5994 `async' use asynchronous export process
5996 FIRST-KEY is the key pressed to select the first level menu. It
5997 is nil when this menu hasn't been selected yet.
5999 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6000 buffer is provided, but indications about currently active
6001 options are given in the prompt. Moreover, \[?] allows to switch
6002 back to standard interface."
6003 (let* ((fontify-key
6004 (lambda (key &optional access-key)
6005 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6006 ;; non-nil is the required first-level key to activate
6007 ;; KEY. When its value is t, activate KEY independently
6008 ;; on the first key, if any. A nil value means KEY will
6009 ;; only be activated at first level.
6010 (if (or (eq access-key t) (eq access-key first-key))
6011 (org-propertize key 'face 'org-warning)
6012 key)))
6013 (fontify-value
6014 (lambda (value)
6015 ;; Fontify VALUE string.
6016 (org-propertize value 'face 'font-lock-variable-name-face)))
6017 ;; Prepare menu entries by extracting them from registered
6018 ;; back-ends and sorting them by access key and by ordinal,
6019 ;; if any.
6020 (entries
6021 (sort (sort (delq nil
6022 (mapcar 'org-export-backend-menu
6023 org-export--registered-backends))
6024 (lambda (a b)
6025 (let ((key-a (nth 1 a))
6026 (key-b (nth 1 b)))
6027 (cond ((and (numberp key-a) (numberp key-b))
6028 (< key-a key-b))
6029 ((numberp key-b) t)))))
6030 'car-less-than-car))
6031 ;; Compute a list of allowed keys based on the first key
6032 ;; pressed, if any. Some keys
6033 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6034 ;; available.
6035 (allowed-keys
6036 (nconc (list 2 22 19 6 1)
6037 (if (not first-key) (org-uniquify (mapcar 'car entries))
6038 (let (sub-menu)
6039 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6040 (when (eq (car entry) first-key)
6041 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6042 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6043 ((not first-key) (list ?P)))
6044 (list ?& ?#)
6045 (when expertp (list ??))
6046 (list ?q)))
6047 ;; Build the help menu for standard UI.
6048 (help
6049 (unless expertp
6050 (concat
6051 ;; Options are hard-coded.
6052 (format "[%s] Body only: %s [%s] Visible only: %s
6053 \[%s] Export scope: %s [%s] Force publishing: %s
6055 (funcall fontify-key "C-b" t)
6056 (funcall fontify-value
6057 (if (memq 'body options) "On " "Off"))
6058 (funcall fontify-key "C-v" t)
6059 (funcall fontify-value
6060 (if (memq 'visible options) "On " "Off"))
6061 (funcall fontify-key "C-s" t)
6062 (funcall fontify-value
6063 (if (memq 'subtree options) "Subtree" "Buffer "))
6064 (funcall fontify-key "C-f" t)
6065 (funcall fontify-value
6066 (if (memq 'force options) "On " "Off"))
6067 (funcall fontify-key "C-a" t)
6068 (funcall fontify-value
6069 (if (memq 'async options) "On " "Off")))
6070 ;; Display registered back-end entries. When a key
6071 ;; appears for the second time, do not create another
6072 ;; entry, but append its sub-menu to existing menu.
6073 (let (last-key)
6074 (mapconcat
6075 (lambda (entry)
6076 (let ((top-key (car entry)))
6077 (concat
6078 (unless (eq top-key last-key)
6079 (setq last-key top-key)
6081 (funcall fontify-key (char-to-string top-key))
6082 (nth 1 entry)))
6083 (let ((sub-menu (nth 2 entry)))
6084 (unless (functionp sub-menu)
6085 ;; Split sub-menu into two columns.
6086 (let ((index -1))
6087 (concat
6088 (mapconcat
6089 (lambda (sub-entry)
6090 (incf index)
6091 (format
6092 (if (zerop (mod index 2)) " [%s] %-26s"
6094 (funcall fontify-key
6095 (char-to-string (car sub-entry))
6096 top-key)
6097 (nth 1 sub-entry)))
6098 sub-menu "")
6100 entries ""))
6101 ;; Publishing menu is hard-coded.
6103 [%s] Current file [%s] Current project
6105 (funcall fontify-key "P")
6106 (funcall fontify-key "f" ?P)
6107 (funcall fontify-key "p" ?P)
6108 (funcall fontify-key "x" ?P)
6109 (funcall fontify-key "a" ?P))
6111 (funcall fontify-key "&" t)
6112 (funcall fontify-key "#" t))
6113 (format "[%s] %s"
6114 (funcall fontify-key "q" t)
6115 (if first-key "Main menu" "Exit")))))
6116 ;; Build prompts for both standard and expert UI.
6117 (standard-prompt (unless expertp "Export command: "))
6118 (expert-prompt
6119 (when expertp
6120 (format
6121 "Export command (C-%s%s%s%s%s) [%s]: "
6122 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6123 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6124 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6125 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6126 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6127 (mapconcat (lambda (k)
6128 ;; Strip control characters.
6129 (unless (< k 27) (char-to-string k)))
6130 allowed-keys "")))))
6131 ;; With expert UI, just read key with a fancy prompt. In standard
6132 ;; UI, display an intrusive help buffer.
6133 (if expertp
6134 (org-export--dispatch-action
6135 expert-prompt allowed-keys entries options first-key expertp)
6136 ;; At first call, create frame layout in order to display menu.
6137 (unless (get-buffer "*Org Export Dispatcher*")
6138 (delete-other-windows)
6139 (org-switch-to-buffer-other-window
6140 (get-buffer-create "*Org Export Dispatcher*"))
6141 (setq cursor-type nil
6142 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6143 ;; Make sure that invisible cursor will not highlight square
6144 ;; brackets.
6145 (set-syntax-table (copy-syntax-table))
6146 (modify-syntax-entry ?\[ "w"))
6147 ;; At this point, the buffer containing the menu exists and is
6148 ;; visible in the current window. So, refresh it.
6149 (with-current-buffer "*Org Export Dispatcher*"
6150 ;; Refresh help. Maintain display continuity by re-visiting
6151 ;; previous window position.
6152 (let ((pos (window-start)))
6153 (erase-buffer)
6154 (insert help)
6155 (set-window-start nil pos)))
6156 (org-fit-window-to-buffer)
6157 (org-export--dispatch-action
6158 standard-prompt allowed-keys entries options first-key expertp))))
6160 (defun org-export--dispatch-action
6161 (prompt allowed-keys entries options first-key expertp)
6162 "Read a character from command input and act accordingly.
6164 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6165 a list of characters available at a given step in the process.
6166 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6167 EXPERTP are the same as defined in `org-export--dispatch-ui',
6168 which see.
6170 Toggle export options when required. Otherwise, return value is
6171 a list with action as CAR and a list of interactive export
6172 options as CDR."
6173 (let (key)
6174 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6175 ;; C-p, SPC, DEL).
6176 (while (and (setq key (read-char-exclusive prompt))
6177 (not expertp)
6178 (memq key '(14 16 ?\s ?\d)))
6179 (case key
6180 (14 (if (not (pos-visible-in-window-p (point-max)))
6181 (ignore-errors (scroll-up 1))
6182 (message "End of buffer")
6183 (sit-for 1)))
6184 (16 (if (not (pos-visible-in-window-p (point-min)))
6185 (ignore-errors (scroll-down 1))
6186 (message "Beginning of buffer")
6187 (sit-for 1)))
6188 (?\s (if (not (pos-visible-in-window-p (point-max)))
6189 (scroll-up nil)
6190 (message "End of buffer")
6191 (sit-for 1)))
6192 (?\d (if (not (pos-visible-in-window-p (point-min)))
6193 (scroll-down nil)
6194 (message "Beginning of buffer")
6195 (sit-for 1)))))
6196 (cond
6197 ;; Ignore undefined associations.
6198 ((not (memq key allowed-keys))
6199 (ding)
6200 (unless expertp (message "Invalid key") (sit-for 1))
6201 (org-export--dispatch-ui options first-key expertp))
6202 ;; q key at first level aborts export. At second level, cancel
6203 ;; first key instead.
6204 ((eq key ?q) (if (not first-key) (error "Export aborted")
6205 (org-export--dispatch-ui options nil expertp)))
6206 ;; Help key: Switch back to standard interface if expert UI was
6207 ;; active.
6208 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6209 ;; Send request for template insertion along with export scope.
6210 ((eq key ?#) (cons 'template (memq 'subtree options)))
6211 ;; Switch to asynchronous export stack.
6212 ((eq key ?&) '(stack))
6213 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6214 ((memq key '(2 22 19 6 1))
6215 (org-export--dispatch-ui
6216 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6217 (6 'force) (1 'async))))
6218 (if (memq option options) (remq option options)
6219 (cons option options)))
6220 first-key expertp))
6221 ;; Action selected: Send key and options back to
6222 ;; `org-export-dispatch'.
6223 ((or first-key (functionp (nth 2 (assq key entries))))
6224 (cons (cond
6225 ((not first-key) (nth 2 (assq key entries)))
6226 ;; Publishing actions are hard-coded. Send a special
6227 ;; signal to `org-export-dispatch'.
6228 ((eq first-key ?P)
6229 (case key
6230 (?f 'publish-current-file)
6231 (?p 'publish-current-project)
6232 (?x 'publish-choose-project)
6233 (?a 'publish-all)))
6234 ;; Return first action associated to FIRST-KEY + KEY
6235 ;; path. Indeed, derived backends can share the same
6236 ;; FIRST-KEY.
6237 (t (catch 'found
6238 (mapc (lambda (entry)
6239 (let ((match (assq key (nth 2 entry))))
6240 (when match (throw 'found (nth 2 match)))))
6241 (member (assq first-key entries) entries)))))
6242 options))
6243 ;; Otherwise, enter sub-menu.
6244 (t (org-export--dispatch-ui options key expertp)))))
6248 (provide 'ox)
6250 ;; Local variables:
6251 ;; generated-autoload-file: "org-loaddefs.el"
6252 ;; End:
6254 ;;; ox.el ends here