| blob | 99a345079e0046cd388c3991992868100da914dd |
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 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists in a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place. The exhaustive list
35 ;; of properties is given in "The Communication Channel" section of
36 ;; this file.
37 ;;
38 ;; - The transcoder walks the parse tree, ignores or treat as plain
39 ;; text elements and objects according to export options, and
40 ;; eventually calls back-end specific functions to do the real
41 ;; transcoding, concatenating their return value along the way.
42 ;;
43 ;; - The filter system is activated at the very beginning and the very
44 ;; end of the export process, and each time an element or an object
45 ;; has been converted. It is the entry point to fine-tune standard
46 ;; output from back-end transcoders. See "The Filter System"
47 ;; section for more information.
48 ;;
49 ;; The core function is `org-export-as'. It returns the transcoded
50 ;; buffer as a string.
51 ;;
52 ;; An export back-end is defined with `org-export-define-backend'.
53 ;; This function can also support specific buffer keywords, OPTION
54 ;; keyword's items and filters. Refer to function's documentation for
55 ;; more information.
56 ;;
57 ;; If the new back-end shares most properties with another one,
58 ;; `org-export-define-derived-backend' can be used to simplify the
59 ;; process.
60 ;;
61 ;; Any back-end can define its own variables. Among them, those
62 ;; customizable should belong to the `org-export-BACKEND' group.
63 ;;
64 ;; Tools for common tasks across back-ends are implemented in the
65 ;; following part of the file.
66 ;;
67 ;; Then, a wrapper macro for asynchronous export,
68 ;; `org-export-async-start', along with tools to display results. are
69 ;; given in the penultimate part.
70 ;;
71 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
72 ;; back-ends is provided in the last one.
74 ;;; Code:
93 \f
94 ;;; Internal Variables
95 ;;
96 ;; Among internal variables, the most important is
97 ;; `org-export-options-alist'. This variable define the global export
98 ;; options, shared between every exporter, and how they are acquired.
144 "Alist between export properties and ways to set them.
146 The CAR of the alist is the property name, and the CDR is a list
147 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
149 KEYWORD is a string representing a buffer keyword, or nil. Each
150 property defined this way can also be set, during subtree
151 export, through a headline property named after the keyword
153 property).
154 OPTION is a string that could be found in an #+OPTIONS: line.
155 DEFAULT is the default value for the property.
156 BEHAVIOUR determines how Org should handle multiple keywords for
157 the same property. It is a symbol among:
158 nil Keep old value and discard the new one.
159 t Replace old value with the new one.
160 `space' Concatenate the values, separating them with a space.
161 `newline' Concatenate the values, separating them with
162 a newline.
163 `split' Split values at white spaces, and cons them to the
164 previous list.
166 Values set through KEYWORD and OPTION have precedence over
167 DEFAULT.
169 All these properties should be back-end agnostic. Back-end
170 specific properties are set through `org-export-define-backend'.
174 "List of in-buffer keywords that require special treatment.
175 These keywords are not directly associated to a property. The
176 way they are handled must be hard-coded into
236 "Alist between filters properties and initial values.
238 The key of each association is a property name accessible through
239 the communication channel. Its value is a configurable global
240 variable defining initial filters.
242 This list is meant to install user specified filters. Back-end
243 developers may install their own filters using
244 `org-export-define-backend'. Filters defined there will always
245 be prepended to the current list, so they always get applied
254 "Default rule for link matching an inline image.
255 This rule applies to links with no description. By default, it
256 will be considered as an inline image if it targets a local file
259 See `org-export-inline-image-p' for more information about
263 "Non-nil means asynchronous export process should leave data behind.
267 located in `temporary-file-directory'.
269 When non-nil, it will also set `debug-on-error' to a non-nil
273 "Record asynchronously generated export results and processes.
274 This is an alist: its CAR is the source of the
275 result (destination file or buffer for a finished process,
276 original buffer for a running one) and its CDR is a list
277 containing the back-end used, as a symbol, and either a process
278 or the time at which it finished. It is used to build the menu
282 "List of backends currently available in the exporter.
283 This variable is set with `org-export-define-backend' and
287 "Last command called from the dispatcher.
288 The value should be a list. Its CAR is the action, as a symbol,
292 "The position where the last export command was created using the dispatcher.
293 This marker will be used with `C-u C-c C-e' to make sure export repetition
296 ;; For compatibility with Org < 8
298 "Name, if any, of the back-end used during an export process.
300 Its value is a symbol such as `html', `latex', `ascii', or nil if
301 the back-end is anonymous (see `org-export-create-backend') or if
302 there is no export process in progress.
304 It can be used to teach Babel blocks how to act differently
307 \f
308 ;;; User-configurable Variables
309 ;;
310 ;; Configuration for the masses.
311 ;;
312 ;; They should never be accessed directly, as their value is to be
313 ;; stored in a property list (cf. `org-export-options-alist').
314 ;; Back-ends will read their value from there instead.
317 "Options for exporting Org mode files."
322 "General options for export engine."
327 "Whether sub-trees with the ARCHIVE tag should be exported.
329 This can have three different values:
330 nil Do not export, pretend this tree is not present.
331 t Do export the entire tree.
332 `headline' Only export the headline, but skip the tree below it.
334 This option can also be set with the OPTIONS keyword,
343 "Non-nil means insert author name into the exported file.
344 This option can also be set with the OPTIONS keyword,
350 "Non-nil means export CLOCK keywords.
351 This option can also be set with the OPTIONS keyword,
357 "Non-nil means the postamble should contain a creator sentence.
359 The sentence can be set in `org-export-creator-string' and
362 If the value is `comment' insert it as a comment."
370 "Non-nil means insert date in the exported document.
371 This option can also be set with the OPTIONS keyword,
377 "Time-stamp format string to use for DATE keyword.
379 The format string, when specified, only applies if date consists
380 in a single time-stamp. Otherwise its value will be ignored.
382 See `format-time-string' for details on how to build this
383 string."
391 emacs-version
393 "Information about the creator of the document.
394 This option can also be set on with the CREATOR keyword."
399 "Non-nil means export contents of standard drawers.
401 When t, all drawers are exported. This may also be a list of
402 drawer names to export, as strings. If that list starts with
403 `not', only drawers with such names will be ignored.
405 This variable doesn't apply to properties drawers. See
406 `org-export-with-properties' instead.
408 This option can also be set with the OPTIONS keyword,
421 :inline t
425 "Non-nil means insert author email into the exported file.
426 This option can also be set with the OPTIONS keyword,
432 "Non-nil means interpret *word*, /word/, _word_ and +word+.
434 If the export target supports emphasizing text, the word will be
435 typeset in bold, italic, with an underline or strike-through,
436 respectively.
438 This option can also be set with the OPTIONS keyword,
444 "Tags that exclude a tree from export.
446 All trees carrying any of these tags will be excluded from
447 export. This is without condition, so even subtrees inside that
448 carry one of the `org-export-select-tags' will be removed.
450 This option can also be set with the EXCLUDE_TAGS keyword."
457 This can be used to have pre-formatted text, fragments of code
458 etc. For example:
459 : ;; Some Lisp examples
460 : (while (defc cnt)
461 : (ding))
462 will be looking just like this in also HTML. See also the QUOTE
463 keyword. Not all export backends support this.
465 This option can also be set with the OPTIONS keyword,
471 "Non-nil means Org footnotes should be exported.
472 This option can also be set with the OPTIONS keyword,
478 "Non-nil means process LaTeX environments and fragments.
480 This option can also be set with the OPTIONS line,
483 nil Ignore math snippets.
484 `verbatim' Keep everything in verbatim.
485 t Allow export of math snippets."
495 "The last level which is still exported as a headline.
497 Inferior levels will usually produce itemize or enumerate lists
498 when exported, but back-end behaviour may differ.
500 This option can also be set with the OPTIONS keyword,
506 "The default language for export and clocktable translations, as a string.
507 This may have an association in
508 `org-clock-clocktable-language-setup',
509 `org-export-smart-quotes-alist' and `org-export-dictionary'.
510 This option can also be set with the LANGUAGE keyword."
515 "Non-nil means preserve all line breaks when exporting.
516 This option can also be set with the OPTIONS keyword,
522 "Non-nil means interpret entities when exporting.
525 Å.
527 For a list of supported names, see the constant `org-entities'
528 and the user option `org-entities-user'.
530 This option can also be set with the OPTIONS keyword,
536 "Non-nil means inlinetasks should be exported.
537 This option can also be set with the OPTIONS keyword,
545 "Non-nil means include planning info in export.
547 Planning info is the line containing either SCHEDULED:,
548 DEADLINE:, CLOSED: time-stamps, or a combination of them.
550 This option can also be set with the OPTIONS keyword,
558 "Non-nil means include priority cookies in export.
559 This option can also be set with the OPTIONS keyword,
565 "Non-nil means export contents of properties drawers.
567 When t, all properties are exported. This may also be a list of
568 properties to export, as strings.
570 This option can also be set with the OPTIONS keyword,
582 "Non-nil means add section numbers to headlines when exporting.
584 When set to an integer n, numbering will only happen for
585 headlines whose relative level is higher or equal to n.
587 This option can also be set with the OPTIONS keyword,
593 "Tags that select a tree for export.
595 If any such tag is found in a buffer, all trees that do not carry
596 one of these tags will be ignored during export. Inside trees
597 that are selected like this, you can still deselect a subtree by
598 tagging it with one of the `org-export-exclude-tags'.
600 This option can also be set with the SELECT_TAGS keyword."
605 "Non-nil means activate smart quotes during export.
606 This option can also be set with the OPTIONS keyword,
609 When setting this to non-nil, you need to take care of
610 using the correct Babel package when exporting to LaTeX.
611 E.g., you can load Babel for french like this:
622 When this option is turned on, these strings will be exported as:
624 Org HTML LaTeX UTF-8
625 -----+----------+--------+-------
627 -- – -- –
628 --- — --- —
631 This option can also be set with the OPTIONS keyword,
637 "Non-nil means include statistics cookies in export.
638 This option can also be set with the OPTIONS keyword,
648 When this option is turned on, you can use TeX-like syntax for
650 will be considered as a single item - so grouping with {} is
651 normally not needed. For example, the following things will be
652 parsed as single sub- or superscripts.
654 10^24 or 10^tau several digits will be considered 1 item.
655 10^-12 or 10^-tau a leading sign with digits or a word
656 x^2-y^3 will be read as x^2 - y^3, because items are
657 terminated by almost any nonword/nondigit char.
658 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
660 Still, ambiguity is possible - so when in doubt use {} to enclose
661 the sub/superscript. If you set this variable to the symbol
662 `{}', the braces are *required* in order to trigger
663 interpretations as sub/superscript. This can be helpful in
666 This option can also be set with the OPTIONS keyword,
675 "Non-nil means create a table of contents in exported files.
677 The TOC contains headlines with levels up
678 to`org-export-headline-levels'. When an integer, include levels
679 up to N in the toc, this may then be different from
680 `org-export-headline-levels', but it will not be allowed to be
681 larger than the number of headline levels. When nil, no table of
682 contents is made.
684 This option can also be set with the OPTIONS keyword,
694 For example:
696 | Name | Address | Birthday |
697 |-------------+----------+-----------|
698 | Arthur Dent | England | 29.2.2100 |
700 This option can also be set with the OPTIONS keyword,
706 "If nil, do not export tags, just remove them from headlines.
708 If this is the symbol `not-in-toc', tags will be removed from
709 table of contents entries, but still be shown in the headlines of
710 the document.
712 This option can also be set with the OPTIONS keyword,
721 "Non-nil means include TODO items for export.
723 This may have the following values:
724 t include tasks independent of state.
725 `todo' include only tasks that are not yet done.
726 `done' include only tasks that are already done.
727 nil ignore all tasks.
728 list of keywords include tasks with these keywords.
730 This option can also be set with the OPTIONS keyword,
742 "Non-nil means insert a time stamp into the exported file.
743 The time stamp shows when the file was created. This option can
749 "Non nil means allow timestamps in export.
751 It can be set to any of the following values:
752 t export all timestamps.
753 `active' export active timestamps only.
754 `inactive' export inactive timestamps only.
755 nil do not export timestamps
757 This only applies to timestamps isolated in a paragraph
758 containing only timestamps. Other timestamps are always
759 exported.
761 This option can also be set with the OPTIONS keyword, e.g.
771 "Non-nil means include TODO keywords in export.
772 When nil, remove all these keywords from the export. This option
778 "Non-nil means BIND keywords can define local variable values.
779 This is a potential security risk, which is why the default value
780 is nil. You can also allow them through local buffer variables."
787 "Alist between export snippets back-ends and exporter back-ends.
789 This variable allows to provide shortcuts for export snippets.
793 HTML code while every other back-end will ignore it."
802 "Coding system for the exported file."
809 "Should we push exported content to the kill ring?"
818 "The initial scope when exporting with `org-export-dispatch'.
819 This variable can be either set to `buffer' or `subtree'."
826 "Non-nil means show buffer after exporting to temp buffer.
827 When Org exports to a file, the buffer visiting that file is ever
828 shown, but remains buried. However, when exporting to
829 a temporary buffer, that buffer is popped up in a second window.
830 When this variable is nil, the buffer remains buried also in
831 these cases."
836 "Non-nil means export and publishing commands will run in background.
837 Results from an asynchronous export are never displayed
845 "File used to initialize external export process.
847 Value must be either nil or an absolute file name. When nil, the
848 external process is launched like a regular Emacs session,
849 loading user's initialization file and any site specific
850 configuration. If a file is provided, it, and only it, is loaded
851 at start-up.
853 Therefore, using a specific configuration makes the process to
854 load faster and the export more portable."
863 "Non-nil means using a non-intrusive `org-export-dispatch'.
864 In that case, no help buffer is displayed. Though, an indicator
870 asynchronous). Also, \[?] allows to switch back to standard
871 mode."
878 \f
879 ;;; Defining Back-ends
880 ;;
881 ;; An export back-end is a structure with `org-export-backend' type
882 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
883 ;; and `menu' slots.
884 ;;
885 ;; At the lowest level, a back-end is created with
886 ;; `org-export-create-backend' function.
887 ;;
888 ;; A named back-end can be registered with
889 ;; `org-export-register-backend' function. A registered back-end can
890 ;; later be referred to by its name, with `org-export-get-backend'
891 ;; function. Also, such a back-end can become the parent of a derived
892 ;; back-end from which slot values will be inherited by default.
893 ;; `org-export-derived-backend-p' can check if a given back-end is
894 ;; derived from a list of back-end names.
895 ;;
896 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
897 ;; `org-export-get-all-filters' return the full alist of transcoders,
898 ;; options and filters, including those inherited from ancestors.
899 ;;
900 ;; At a higher level, `org-export-define-backend' is the standard way
901 ;; to define an export back-end. If the new back-end is similar to
902 ;; a registered back-end, `org-export-define-derived-backend' may be
903 ;; used instead.
904 ;;
905 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
906 ;; when a given back-end hasn't been registered yet.
910 name parent transcoders options filters blocks menu)
913 "Return export back-end named after NAME.
914 NAME is a symbol. Return nil if no such back-end is found."
921 "Register BACKEND as a known export back-end.
922 BACKEND is a structure with `org-export-backend' type."
923 ;; Refuse to register an unnamed back-end.
926 ;; Refuse to register a back-end with an unknown parent.
930 ;; Register dedicated export blocks in the parser.
934 ;; If a back-end with the same name as BACKEND is already
935 ;; registered, replace it with BACKEND. Otherwise, simply add
936 ;; BACKEND to the list of registered back-ends.
942 "Signal an error if BACKEND isn't defined."
947 "Non-nil if BACKEND is derived from one of BACKENDS.
948 BACKEND is an export back-end, as returned by, e.g.,
949 `org-export-create-backend', or a symbol referring to
950 a registered back-end. BACKENDS is constituted of symbols."
962 "Return full translation table for BACKEND.
964 BACKEND is an export back-end, as return by, e.g,,
965 `org-export-create-backend'. Return value is an alist where
966 keys are element or object types, as symbols, and values are
967 transcoders.
969 Unlike to `org-export-backend-transcoders', this function
970 also returns transcoders inherited from parent back-ends,
971 if any."
975 parent)
980 transcoders)))
983 "Return export options for BACKEND.
985 BACKEND is an export back-end, as return by, e.g,,
986 `org-export-create-backend'. See `org-export-options-alist'
987 for the shape of the return value.
989 Unlike to `org-export-backend-options', this function also
990 returns options inherited from parent back-ends, if any."
994 parent)
998 options)))
1001 "Return complete list of filters for BACKEND.
1003 BACKEND is an export back-end, as return by, e.g,,
1004 `org-export-create-backend'. Return value is an alist where
1005 keys are symbols and values lists of functions.
1007 Unlike to `org-export-backend-filters', this function also
1008 returns filters inherited from parent back-ends, if any."
1012 parent)
1016 filters)))
1019 "Define a new back-end BACKEND.
1021 TRANSCODERS is an alist between object or element types and
1022 functions handling them.
1024 These functions should return a string without any trailing
1025 space, or nil. They must accept three arguments: the object or
1026 element itself, its contents or nil when it isn't recursive and
1027 the property list used as a communication channel.
1029 Contents, when not nil, are stripped from any global indentation
1030 \(although the relative one is preserved). They also always end
1031 with a single newline character.
1033 If, for a given type, no function is found, that element or
1034 object type will simply be ignored, along with any blank line or
1035 white space at its end. The same will happen if the function
1036 returns the nil value. If that function returns the empty
1037 string, the type will be ignored, but the blank lines or white
1038 spaces will be kept.
1040 In addition to element and object types, one function can be
1041 associated to the `template' (or `inner-template') symbol and
1042 another one to the `plain-text' symbol.
1044 The former returns the final transcoded string, and can be used
1045 to add a preamble and a postamble to document's body. It must
1046 accept two arguments: the transcoded string and the property list
1047 containing export options. A function associated to `template'
1049 A function associated to `inner-template' is always applied.
1051 The latter, when defined, is to be called on every text not
1052 recognized as an element or an object. It must accept two
1053 arguments: the text string and the information channel. It is an
1054 appropriate place to protect special chars relative to the
1055 back-end.
1057 BODY can start with pre-defined keyword arguments. The following
1058 keywords are understood:
1060 :export-block
1062 String, or list of strings, representing block names that
1063 will not be parsed. This is used to specify blocks that will
1064 contain raw code specific to the back-end. These blocks
1065 still have to be handled by the relative `export-block' type
1066 translator.
1068 :filters-alist
1070 Alist between filters and function, or list of functions,
1071 specific to the back-end. See `org-export-filters-alist' for
1072 a list of all allowed filters. Filters defined here
1073 shouldn't make a back-end test, as it may prevent back-ends
1074 derived from this one to behave properly.
1076 :menu-entry
1078 Menu entry for the export dispatcher. It should be a list
1079 like:
1081 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1083 where :
1085 KEY is a free character selecting the back-end.
1087 DESCRIPTION-OR-ORDINAL is either a string or a number.
1089 If it is a string, is will be used to name the back-end in
1090 its menu entry. If it is a number, the following menu will
1091 be displayed as a sub-menu of the back-end with the same
1092 KEY. Also, the number will be used to determine in which
1093 order such sub-menus will appear (lowest first).
1095 ACTION-OR-MENU is either a function or an alist.
1097 If it is an action, it will be called with four
1098 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1099 BODY-ONLY. See `org-export-as' for further explanations on
1100 some of them.
1102 If it is an alist, associations should follow the
1103 pattern:
1105 '(KEY DESCRIPTION ACTION)
1107 where KEY, DESCRIPTION and ACTION are described above.
1109 Valid values include:
1113 or
1118 \(lambda (a s v b)
1119 \(if a (org-latex-export-to-pdf t s v b)
1120 \(org-open-file
1121 \(org-latex-export-to-pdf nil s v b)))))))
1123 or the following, which will be added to the previous
1124 sub-menu,
1126 '(?l 1
1130 :options-alist
1132 Alist between back-end specific properties introduced in
1133 communication channel and how their value are acquired. See
1134 `org-export-options-alist' for more information about
1135 structure of the values."
1149 :transcoders transcoders
1150 :options options
1151 :filters filters
1152 :blocks blocks
1156 "Create a new back-end as a variant of an existing one.
1158 CHILD is the name of the derived back-end. PARENT is the name of
1159 the parent back-end.
1161 BODY can start with pre-defined keyword arguments. The following
1162 keywords are understood:
1164 :export-block
1166 String, or list of strings, representing block names that
1167 will not be parsed. This is used to specify blocks that will
1168 contain raw code specific to the back-end. These blocks
1169 still have to be handled by the relative `export-block' type
1170 translator.
1172 :filters-alist
1174 Alist of filters that will overwrite or complete filters
1175 defined in PARENT back-end. See `org-export-filters-alist'
1176 for a list of allowed filters.
1178 :menu-entry
1180 Menu entry for the export dispatcher. See
1181 `org-export-define-backend' for more information about the
1182 expected value.
1184 :options-alist
1186 Alist of back-end specific properties that will overwrite or
1187 complete those defined in PARENT back-end. Refer to
1188 `org-export-options-alist' for more information about
1189 structure of the values.
1191 :translate-alist
1193 Alist of element and object types and transcoders that will
1194 overwrite or complete transcode table from PARENT back-end.
1195 Refer to `org-export-define-backend' for detailed information
1196 about transcoders.
1199 as a variant of `latex' back-end with a custom template function:
1201 \(org-export-define-derived-backend 'my-latex 'latex
1202 :translate-alist '((template . my-latex-template-fun)))
1204 The back-end could then be called with, for example:
1221 :parent parent
1222 :transcoders transcoders
1223 :options options
1224 :filters filters
1225 :blocks blocks
1229 \f
1230 ;;; The Communication Channel
1231 ;;
1232 ;; During export process, every function has access to a number of
1233 ;; properties. They are of two types:
1234 ;;
1235 ;; 1. Environment options are collected once at the very beginning of
1236 ;; the process, out of the original buffer and configuration.
1237 ;; Collecting them is handled by `org-export-get-environment'
1238 ;; function.
1239 ;;
1240 ;; Most environment options are defined through the
1241 ;; `org-export-options-alist' variable.
1242 ;;
1243 ;; 2. Tree properties are extracted directly from the parsed tree,
1244 ;; just before export, by `org-export-collect-tree-properties'.
1245 ;;
1246 ;; Here is the full list of properties available during transcode
1247 ;; process, with their category and their value type.
1248 ;;
1249 ;; + `:author' :: Author's name.
1250 ;; - category :: option
1251 ;; - type :: string
1252 ;;
1253 ;; + `:back-end' :: Current back-end used for transcoding.
1254 ;; - category :: tree
1255 ;; - type :: structure
1256 ;;
1257 ;; + `:creator' :: String to write as creation information.
1258 ;; - category :: option
1259 ;; - type :: string
1260 ;;
1261 ;; + `:date' :: String to use as date.
1262 ;; - category :: option
1263 ;; - type :: string
1264 ;;
1265 ;; + `:description' :: Description text for the current data.
1266 ;; - category :: option
1267 ;; - type :: string
1268 ;;
1269 ;; + `:email' :: Author's email.
1270 ;; - category :: option
1271 ;; - type :: string
1272 ;;
1273 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1274 ;; process.
1275 ;; - category :: option
1276 ;; - type :: list of strings
1277 ;;
1278 ;; + `:export-options' :: List of export options available for current
1279 ;; process.
1280 ;; - category :: none
1281 ;; - type :: list of symbols, among `subtree', `body-only' and
1282 ;; `visible-only'.
1283 ;;
1284 ;; + `:exported-data' :: Hash table used for memoizing
1285 ;; `org-export-data'.
1286 ;; - category :: tree
1287 ;; - type :: hash table
1288 ;;
1289 ;; + `:filetags' :: List of global tags for buffer. Used by
1290 ;; `org-export-get-tags' to get tags with inheritance.
1291 ;; - category :: option
1292 ;; - type :: list of strings
1293 ;;
1294 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1295 ;; their definition, as parsed data. Only non-inlined footnotes
1296 ;; are represented in this alist. Also, every definition isn't
1297 ;; guaranteed to be referenced in the parse tree. The purpose of
1298 ;; this property is to preserve definitions from oblivion
1299 ;; (i.e. when the parse tree comes from a part of the original
1300 ;; buffer), it isn't meant for direct use in a back-end. To
1301 ;; retrieve a definition relative to a reference, use
1302 ;; `org-export-get-footnote-definition' instead.
1303 ;; - category :: option
1304 ;; - type :: alist (STRING . LIST)
1305 ;;
1306 ;; + `:headline-levels' :: Maximum level being exported as an
1307 ;; headline. Comparison is done with the relative level of
1308 ;; headlines in the parse tree, not necessarily with their
1309 ;; actual level.
1310 ;; - category :: option
1311 ;; - type :: integer
1312 ;;
1313 ;; + `:headline-offset' :: Difference between relative and real level
1314 ;; of headlines in the parse tree. For example, a value of -1
1315 ;; means a level 2 headline should be considered as level
1316 ;; 1 (cf. `org-export-get-relative-level').
1317 ;; - category :: tree
1318 ;; - type :: integer
1319 ;;
1320 ;; + `:headline-numbering' :: Alist between headlines and their
1321 ;; numbering, as a list of numbers
1322 ;; (cf. `org-export-get-headline-number').
1323 ;; - category :: tree
1324 ;; - type :: alist (INTEGER . LIST)
1325 ;;
1326 ;; + `:id-alist' :: Alist between ID strings and destination file's
1327 ;; path, relative to current directory. It is used by
1328 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1329 ;; external file.
1330 ;; - category :: option
1331 ;; - type :: alist (STRING . STRING)
1332 ;;
1333 ;; + `:ignore-list' :: List of elements and objects that should be
1334 ;; ignored during export.
1335 ;; - category :: tree
1336 ;; - type :: list of elements and objects
1337 ;;
1338 ;; + `:input-buffer' :: Original buffer name.
1339 ;; - category :: option
1340 ;; - type :: string
1341 ;;
1342 ;; + `:input-file' :: Full path to input file, if any.
1343 ;; - category :: option
1344 ;; - type :: string or nil
1345 ;;
1346 ;; + `:keywords' :: List of keywords attached to data.
1347 ;; - category :: option
1348 ;; - type :: string
1349 ;;
1350 ;; + `:language' :: Default language used for translations.
1351 ;; - category :: option
1352 ;; - type :: string
1353 ;;
1354 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1355 ;; transcoding.
1356 ;; - category :: option
1357 ;; - type :: list (as returned by `org-element-parse-buffer')
1358 ;;
1359 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1360 ;; all line breaks.
1361 ;; - category :: option
1362 ;; - type :: symbol (nil, t)
1363 ;;
1364 ;; + `:section-numbers' :: Non-nil means transcoding should add
1365 ;; section numbers to headlines.
1366 ;; - category :: option
1367 ;; - type :: symbol (nil, t)
1368 ;;
1369 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1370 ;; in transcoding. When such a tag is present, subtrees without
1371 ;; it are de facto excluded from the process. See
1372 ;; `use-select-tags'.
1373 ;; - category :: option
1374 ;; - type :: list of strings
1375 ;;
1376 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1377 ;; a time stamp in the output.
1378 ;; - category :: option
1379 ;; - type :: symbol (nil, t)
1380 ;;
1381 ;; + `:translate-alist' :: Alist between element and object types and
1382 ;; transcoding functions relative to the current back-end.
1383 ;; Special keys `inner-template', `template' and `plain-text' are
1384 ;; also possible.
1385 ;; - category :: option
1386 ;; - type :: alist (SYMBOL . FUNCTION)
1387 ;;
1388 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1389 ;; also be transcoded. If it is set to the `headline' symbol,
1390 ;; only the archived headline's name is retained.
1391 ;; - category :: option
1392 ;; - type :: symbol (nil, t, `headline')
1393 ;;
1394 ;; + `:with-author' :: Non-nil means author's name should be included
1395 ;; in the output.
1396 ;; - category :: option
1397 ;; - type :: symbol (nil, t)
1398 ;;
1399 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1400 ;; - category :: option
1401 ;; - type :: symbol (nil, t)
1402 ;;
1403 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1404 ;; inserted at the end of the transcoded string. If the value
1405 ;; is `comment', it should be commented.
1406 ;; - category :: option
1407 ;; - type :: symbol (`comment', nil, t)
1408 ;;
1409 ;; + `:with-date' :: Non-nil means output should contain a date.
1410 ;; - category :: option
1411 ;; - type :. symbol (nil, t)
1412 ;;
1413 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1414 ;; its value is a list of names, only drawers with such names
1415 ;; will be transcoded. If that list starts with `not', drawer
1416 ;; with these names will be skipped.
1417 ;; - category :: option
1418 ;; - type :: symbol (nil, t) or list of strings
1419 ;;
1420 ;; + `:with-email' :: Non-nil means output should contain author's
1421 ;; email.
1422 ;; - category :: option
1423 ;; - type :: symbol (nil, t)
1424 ;;
1425 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1426 ;; interpreted.
1427 ;; - category :: option
1428 ;; - type :: symbol (nil, t)
1429 ;;
1430 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1431 ;; strings starting with a colon as a fixed-with (verbatim) area.
1432 ;; - category :: option
1433 ;; - type :: symbol (nil, t)
1434 ;;
1435 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1436 ;; footnotes.
1437 ;; - category :: option
1438 ;; - type :: symbol (nil, t)
1439 ;;
1440 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1441 ;; `latex-fragment' objects should appear in export output. When
1442 ;; this property is set to `verbatim', they will be left as-is.
1443 ;; - category :: option
1444 ;; - type :: symbol (`verbatim', nil, t)
1445 ;;
1446 ;; + `:with-planning' :: Non-nil means transcoding should include
1447 ;; planning info.
1448 ;; - category :: option
1449 ;; - type :: symbol (nil, t)
1450 ;;
1451 ;; + `:with-priority' :: Non-nil means transcoding should include
1452 ;; priority cookies.
1453 ;; - category :: option
1454 ;; - type :: symbol (nil, t)
1455 ;;
1456 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1457 ;; plain text.
1458 ;; - category :: option
1459 ;; - type :: symbol (nil, t)
1460 ;;
1461 ;; + `:with-special-strings' :: Non-nil means transcoding should
1462 ;; interpret special strings in plain text.
1463 ;; - category :: option
1464 ;; - type :: symbol (nil, t)
1465 ;;
1466 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1467 ;; interpret subscript and superscript. With a value of "{}",
1468 ;; only interpret those using curly brackets.
1469 ;; - category :: option
1470 ;; - type :: symbol (nil, {}, t)
1471 ;;
1472 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1473 ;; tables.
1474 ;; - category :: option
1475 ;; - type :: symbol (nil, t)
1476 ;;
1477 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1478 ;; headlines. A `not-in-toc' value will remove them from the
1479 ;; table of contents, if any, nonetheless.
1480 ;; - category :: option
1481 ;; - type :: symbol (nil, t, `not-in-toc')
1482 ;;
1483 ;; + `:with-tasks' :: Non-nil means transcoding should include
1484 ;; headlines with a TODO keyword. A `todo' value will only
1485 ;; include headlines with a todo type keyword while a `done'
1486 ;; value will do the contrary. If a list of strings is provided,
1487 ;; only tasks with keywords belonging to that list will be kept.
1488 ;; - category :: option
1489 ;; - type :: symbol (t, todo, done, nil) or list of strings
1490 ;;
1491 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1492 ;; time stamps. Special value `active' (resp. `inactive') ask to
1493 ;; export only active (resp. inactive) timestamps. Otherwise,
1494 ;; completely remove them.
1495 ;; - category :: option
1496 ;; - type :: symbol: (`active', `inactive', t, nil)
1497 ;;
1498 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1499 ;; added to the output. An integer value limits its depth.
1500 ;; - category :: option
1501 ;; - type :: symbol (nil, t or integer)
1502 ;;
1503 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1504 ;; include TODO keywords.
1505 ;; - category :: option
1506 ;; - type :: symbol (nil, t)
1509 ;;;; Environment Options
1510 ;;
1511 ;; Environment options encompass all parameters defined outside the
1512 ;; scope of the parsed data. They come from five sources, in
1513 ;; increasing precedence order:
1514 ;;
1515 ;; - Global variables,
1516 ;; - Buffer's attributes,
1517 ;; - Options keyword symbols,
1518 ;; - Buffer keywords,
1519 ;; - Subtree properties.
1520 ;;
1521 ;; The central internal function with regards to environment options
1522 ;; is `org-export-get-environment'. It updates global variables with
1523 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1524 ;; the different sources.
1525 ;;
1526 ;; The internal functions doing the retrieval are:
1527 ;; `org-export--get-global-options',
1528 ;; `org-export--get-buffer-attributes',
1529 ;; `org-export--parse-option-keyword',
1530 ;; `org-export--get-subtree-options' and
1531 ;; `org-export--get-inbuffer-options'
1532 ;;
1533 ;; Also, `org-export--list-bound-variables' collects bound variables
1534 ;; along with their value in order to set them as buffer local
1535 ;; variables later in the process.
1538 "Collect export options from the current buffer.
1540 Optional argument BACKEND is an export back-end, as returned by
1541 `org-export-create-backend'.
1543 When optional argument SUBTREEP is non-nil, assume the export is
1544 done against the current sub-tree.
1546 Third optional argument EXT-PLIST is a property list with
1547 external parameters overriding Org default settings, but still
1548 inferior to file-local settings."
1549 ;; First install #+BIND variables since these must be set before
1550 ;; global options are read.
1553 ;; Get and prioritize export options...
1555 ;; ... from global variables...
1557 ;; ... from an external property list...
1558 ext-plist
1559 ;; ... from in-buffer settings...
1561 ;; ... and from subtree, when appropriate.
1563 ;; Eventually add misc. properties.
1565 :back-end
1566 backend
1568 :footnote-definition-alist
1569 ;; Footnotes definitions must be collected in the original
1570 ;; buffer, as there's no insurance that they will still be in
1571 ;; the parse tree, due to possible narrowing.
1585 alist))))
1586 alist))
1587 :id-alist
1588 ;; Collect id references.
1599 alist))))
1602 "Parse an OPTIONS line and return values as a plist.
1603 Optional argument BACKEND is an export back-end, as returned by,
1604 e.g., `org-export-create-backend'. It specifies which back-end
1605 specific items to read, if any."
1607 ;; Priority is given to back-end specific options.
1609 org-export-options-alist))
1610 plist)
1619 options))
1621 property
1624 plist))
1627 "Get export options in subtree at point.
1628 Optional argument BACKEND is an export back-end, as returned by,
1629 e.g., `org-export-create-backend'. It specifies back-end used
1630 for export. Return options as a plist."
1631 ;; For each buffer keyword, create a headline property setting the
1632 ;; same property in communication channel. The name for the property
1633 ;; is the keyword with "EXPORT_" appended to it.
1636 ;; Make sure point is at a heading.
1638 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1639 ;; title as its fallback value.
1645 plist :title
1648 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1652 ;; Handle other keywords. TITLE keyword is excluded as it has
1653 ;; been handled already.
1661 ;; Export properties are not case-sensitive.
1668 plist
1669 property
1671 ;; Parse VALUE if required.
1675 ;; If BEHAVIOUR is `split' expected value is
1676 ;; a list of strings, not a string.
1679 ;; Look for both general keywords and back-end specific
1680 ;; options, with priority given to the latter.
1682 org-export-options-alist)))
1683 ;; Return value.
1684 plist)))
1687 "Return current buffer export options, as a plist.
1689 Optional argument BACKEND, when non-nil, is an export back-end,
1690 as returned by, e.g., `org-export-create-backend'. It specifies
1691 which back-end specific options should also be read in the
1692 process.
1694 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1696 get-options ; For byte-compiler.
1699 ;; Priority is given to back-end specific options.
1701 org-export-options-alist))
1704 org-export-special-keywords))))
1707 ;; Return all properties associated to KEYWORD.
1714 ;; Recursively read keywords in buffer. FILES is a list
1715 ;; of files read so far. PLIST is the current property
1716 ;; list obtained.
1725 ;; Options in `org-export-special-keywords'.
1729 ;; Avoid circular dependencies.
1739 plist
1744 plist
1750 ;; Options in `org-export-options-alist'.
1755 plist property
1756 ;; Handle value depending on specified
1757 ;; BEHAVIOUR.
1763 " "
1776 ;; Return final value.
1777 plist))))
1778 ;; Read options in the current buffer.
1781 ;; Parse keywords specified in `org-element-document-properties'
1782 ;; and return PLIST.
1793 "Return properties related to buffer attributes, as a plist."
1794 ;; Store full path of input file name, or nil. For internal use.
1797 :input-file visited-file
1803 "Return global export options as a plist.
1804 Optional argument BACKEND, if non-nil, is an export back-end, as
1805 returned by, e.g., `org-export-create-backend'. It specifies
1806 which back-end specific export options should also be read in the
1807 process."
1809 ;; Priority is given to back-end specific options.
1811 org-export-options-alist)))
1818 plist
1819 prop
1820 ;; Eval default value provided. If keyword is
1821 ;; a member of `org-element-document-properties',
1822 ;; parse it as a secondary string before storing it.
1829 value)))))))))))
1832 "Return variables bound from BIND keywords in current buffer.
1833 Also look for BIND keywords in setup files. The return value is
1834 an alist where associations are (VARIABLE-NAME VALUE)."
1839 ;; Return an alist between variable names and their
1840 ;; value. FILES is a list of setup files names read so
1841 ;; far, used to avoid circular dependencies. ALIST is
1842 ;; the alist collected so far.
1853 ;; Enter setup file.
1863 alist))))))))))
1864 alist)))))
1865 ;; Return value in appropriate order of appearance.
1869 ;;;; Tree Properties
1870 ;;
1871 ;; Tree properties are information extracted from parse tree. They
1872 ;; are initialized at the beginning of the transcoding process by
1873 ;; `org-export-collect-tree-properties'.
1874 ;;
1875 ;; Dedicated functions focus on computing the value of specific tree
1876 ;; properties during initialization. Thus,
1877 ;; `org-export--populate-ignore-list' lists elements and objects that
1878 ;; should be skipped during export, `org-export--get-min-level' gets
1879 ;; the minimal exportable level, used as a basis to compute relative
1880 ;; level for headlines. Eventually
1881 ;; `org-export--collect-headline-numbering' builds an alist between
1882 ;; headlines and their numbering.
1885 "Extract tree properties from parse tree.
1887 DATA is the parse tree from which information is retrieved. INFO
1888 is a list holding export options.
1890 Following tree properties are set or updated:
1892 `:exported-data' Hash table used to memoize results from
1893 `org-export-data'.
1895 `:footnote-definition-alist' List of footnotes definitions in
1896 original buffer and current parse tree.
1898 `:headline-offset' Offset between true level of headlines and
1899 local level. An offset of -1 means a headline
1900 of level 2 should be considered as a level
1901 1 headline in the context.
1903 `:headline-numbering' Alist of all headlines as key an the
1904 associated numbering as value.
1906 `:ignore-list' List of elements that should be ignored during
1907 export.
1909 Return updated plist."
1910 ;; Install the parse tree in the communication channel, in order to
1911 ;; use `org-export-get-genealogy' and al.
1913 ;; Get the list of elements and objects to ignore, and put it into
1914 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1915 ;; been done during parse tree filtering.
1918 :ignore-list
1921 ;; Compute `:headline-offset' in order to be able to use
1922 ;; `org-export-get-relative-level'.
1925 :headline-offset
1927 ;; Update footnotes definitions list with definitions in parse tree.
1928 ;; This is required since buffer expansion might have modified
1929 ;; boundaries of footnote definitions contained in the parse tree.
1930 ;; This way, definitions in `footnote-definition-alist' are bound to
1931 ;; match those in the parse tree.
1937 defs)))
1939 ;; Properties order doesn't matter: get the rest of the tree
1940 ;; properties.
1944 info))
1947 "Return minimum exportable headline's level in DATA.
1948 DATA is parsed tree as returned by `org-element-parse-buffer'.
1949 OPTIONS is a plist holding export options."
1960 ;; If no headline was found, for the sake of consistency, set
1961 ;; minimum level to 1 nonetheless.
1965 "Return numbering of all exportable headlines in a parse tree.
1967 DATA is the parse tree. OPTIONS is the plist holding export
1968 options.
1970 Return an alist whose key is a headline and value is its
1971 associated numbering \(in the shape of a list of numbers\) or nil
1972 for a footnotes section."
1980 headline
1982 for idx from 0 to org-export-max-depth
1986 options)))
1989 "Return list of elements and objects to ignore during export.
1990 DATA is the parse tree to traverse. OPTIONS is the plist holding
1991 export options."
1993 ;; First find trees containing a select tag, if any.
1995 ;; If a select tag is active, also ignore the section before
1996 ;; the first headline, if any.
2000 first-element))))
2003 ;; Collect ignored elements or objects into IGNORE-LIST.
2009 ;; If headline is archived but tree below has
2010 ;; to be skipped, add it to ignore list.
2013 ;; Move into secondary string, if any.
2018 ;; Move into recursive objects/elements.
2020 ;; Main call.
2022 ;; Return value.
2023 ignore))
2026 "Return list of headlines and inlinetasks with a select tag in their tree.
2027 DATA is parsed data as returned by `org-element-parse-buffer'.
2028 INFO is a plist holding export options."
2030 walk-data ; For byte-compiler.
2040 ;; When a select tag is found, mark full
2041 ;; genealogy and every headline within the tree
2042 ;; as acceptable.
2045 genealogy
2048 selected-trees))
2049 ;; If at a headline, continue searching in tree,
2050 ;; recursively.
2060 selected-trees))
2063 "Non-nil when element or object BLOB should be skipped during export.
2064 OPTIONS is the plist holding export options. SELECTED, when
2065 non-nil, is a list of headlines or inlinetasks belonging to
2066 a tree with a select tag."
2073 ;; If `:with-drawers' value starts with `not', ignore
2074 ;; every drawer whose name belong to that list.
2075 ;; Otherwise, ignore drawers whose name isn't in that
2076 ;; list.
2092 ;; Ignore subtrees with an exclude tag.
2095 ;; When a select tag is present in the buffer, ignore any tree
2096 ;; without it.
2098 ;; Ignore commented sub-trees.
2100 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2102 ;; Ignore tasks, if specified by `:with-tasks' property.
2114 properties-set))))))
2124 ;; `:with-timestamps' only applies to isolated timestamps
2125 ;; objects, i.e. timestamp objects in a paragraph containing only
2126 ;; timestamps and whitespaces.
2134 options t))))
2143 \f
2144 ;;; The Transcoder
2145 ;;
2146 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2147 ;; `org-element-parse-buffer') and transcodes it into a specified
2148 ;; back-end output. It takes care of filtering out elements or
2149 ;; objects according to export options and organizing the output blank
2150 ;; lines and white space are preserved. The function memoizes its
2151 ;; results, so it is cheap to call it within transcoders.
2152 ;;
2153 ;; It is possible to modify locally the back-end used by
2154 ;; `org-export-data' or even use a temporary back-end by using
2155 ;; `org-export-data-with-backend'.
2156 ;;
2157 ;; Internally, three functions handle the filtering of objects and
2158 ;; elements during the export. In particular,
2159 ;; `org-export-ignore-element' marks an element or object so future
2160 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2161 ;; elements or objects should be seen as real Org syntax and
2162 ;; `org-export-expand' transforms the others back into their original
2163 ;; shape
2164 ;;
2165 ;; `org-export-transcoder' is an accessor returning appropriate
2166 ;; translator function for a given element or object.
2169 "Return appropriate transcoder for BLOB.
2170 INFO is a plist containing export directives."
2172 ;; Return contents only for complete parse trees.
2178 "Convert DATA into current back-end format.
2180 DATA is a parse tree, an element or an object or a secondary
2181 string. INFO is a plist holding export options.
2183 Return transcoded string."
2189 ;; Ignored element/object.
2191 ;; Plain text.
2197 info))
2198 ;; Uninterpreted element/object: change it back to Org
2199 ;; syntax and export again resulting raw string.
2203 data
2207 info))
2208 ;; Secondary string.
2211 ;; Element/Object without contents or, as a special case,
2212 ;; headline with archive tag and archived trees restricted
2213 ;; to title only.
2221 ;; Export snippets never return a nil value so
2222 ;; that white spaces following them are never
2223 ;; ignored.
2225 ;; Element/Object with contents.
2238 ;; Elements directly containing objects
2239 ;; must have their indentation normalized
2240 ;; first.
2242 data
2243 ;; When normalizing contents of the first
2244 ;; paragraph in an item or a footnote
2245 ;; definition, ignore first line's
2246 ;; indentation: there is none and it
2247 ;; might be misleading.
2252 data)
2259 info))))))))
2260 ;; Final result will be memoized before being returned.
2262 data
2266 ;; Append the same white space between elements or objects as in
2267 ;; the original buffer, and call appropriate filters.
2278 info)))
2279 results)))
2283 "Convert DATA into BACKEND format.
2285 DATA is an element, an object, a secondary string or a string.
2286 BACKEND is a symbol. INFO is a plist used as a communication
2287 channel.
2289 Unlike to `org-export-with-backend', this function will
2290 recursively convert DATA using BACKEND translation table."
2293 data
2294 ;; Set-up a new communication channel with translations defined in
2295 ;; BACKEND as the translate table and a new hash table for
2296 ;; memoization.
2298 info
2301 ;; Size of the hash table is reduced since this function
2302 ;; will probably be used on small trees.
2306 "Non-nil if element or object BLOB should be interpreted during export.
2307 If nil, BLOB will appear as raw Org syntax. Check is done
2308 according to export options INFO, stored as a plist."
2310 ;; ... entities...
2312 ;; ... emphasis...
2315 ;; ... fixed-width areas.
2317 ;; ... LaTeX environments and fragments...
2321 ;; ... sub/superscripts...
2327 ;; ... tables...
2332 "Expand a parsed element or object to its original state.
2334 BLOB is either an element or an object. CONTENTS is its
2335 contents, as a string or nil.
2337 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2338 keywords before output."
2343 blob contents))))
2346 "Add ELEMENT to `:ignore-list' in INFO.
2348 Any element in `:ignore-list' will be skipped when using
2349 `org-element-map'. INFO is modified by side effects."
2353 \f
2354 ;;; The Filter System
2355 ;;
2356 ;; Filters allow end-users to tweak easily the transcoded output.
2357 ;; They are the functional counterpart of hooks, as every filter in
2358 ;; a set is applied to the return value of the previous one.
2359 ;;
2360 ;; Every set is back-end agnostic. Although, a filter is always
2361 ;; called, in addition to the string it applies to, with the back-end
2362 ;; used as argument, so it's easy for the end-user to add back-end
2363 ;; specific filters in the set. The communication channel, as
2364 ;; a plist, is required as the third argument.
2365 ;;
2366 ;; From the developer side, filters sets can be installed in the
2367 ;; process with the help of `org-export-define-backend', which
2368 ;; internally stores filters as an alist. Each association has a key
2369 ;; among the following symbols and a function or a list of functions
2370 ;; as value.
2371 ;;
2372 ;; - `:filter-options' applies to the property list containing export
2373 ;; options. Unlike to other filters, functions in this list accept
2374 ;; two arguments instead of three: the property list containing
2375 ;; export options and the back-end. Users can set its value through
2376 ;; `org-export-filter-options-functions' variable.
2377 ;;
2378 ;; - `:filter-parse-tree' applies directly to the complete parsed
2379 ;; tree. Users can set it through
2380 ;; `org-export-filter-parse-tree-functions' variable.
2381 ;;
2382 ;; - `:filter-final-output' applies to the final transcoded string.
2383 ;; Users can set it with `org-export-filter-final-output-functions'
2384 ;; variable
2385 ;;
2386 ;; - `:filter-plain-text' applies to any string not recognized as Org
2387 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2388 ;; configure it.
2389 ;;
2390 ;; - `:filter-TYPE' applies on the string returned after an element or
2391 ;; object of type TYPE has been transcoded. A user can modify
2392 ;; `org-export-filter-TYPE-functions'
2393 ;;
2394 ;; All filters sets are applied with
2395 ;; `org-export-filter-apply-functions' function. Filters in a set are
2396 ;; applied in a LIFO fashion. It allows developers to be sure that
2397 ;; their filters will be applied first.
2398 ;;
2399 ;; Filters properties are installed in communication channel with
2400 ;; `org-export-install-filters' function.
2401 ;;
2402 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2403 ;; `org-export-before-parsing-hook') are run at the beginning of the
2404 ;; export process and just before parsing to allow for heavy structure
2405 ;; modifications.
2408 ;;;; Hooks
2411 "Hook run at the beginning of the export process.
2413 This is run before include keywords and macros are expanded and
2414 Babel code blocks executed, on a copy of the original buffer
2415 being exported. Visibility and narrowing are preserved. Point
2416 is at the beginning of the buffer.
2418 Every function in this hook will be called with one argument: the
2422 "Hook run before parsing an export buffer.
2424 This is run after include keywords and macros have been expanded
2425 and Babel code blocks executed, on a copy of the original buffer
2426 being exported. Visibility and narrowing are preserved. Point
2427 is at the beginning of the buffer.
2429 Every function in this hook will be called with one argument: the
2433 ;;;; Special Filters
2436 "List of functions applied to the export options.
2437 Each filter is called with two arguments: the export options, as
2438 a plist, and the back-end, as a symbol. It must return
2442 "List of functions applied to the parsed tree.
2443 Each filter is called with three arguments: the parse tree, as
2444 returned by `org-element-parse-buffer', the back-end, as
2445 a symbol, and the communication channel, as a plist. It must
2449 "List of functions applied to plain text.
2450 Each filter is called with three arguments: a string which
2451 contains no Org syntax, the back-end, as a symbol, and the
2452 communication channel, as a plist. It must return a string or
2456 "List of functions applied to the transcoded string.
2457 Each filter is called with three arguments: the full transcoded
2458 string, the back-end, as a symbol, and the communication channel,
2459 as a plist. It must return a string that will be used as the
2463 ;;;; Elements Filters
2466 "List of functions applied to a transcoded babel-call.
2467 Each filter is called with three arguments: the transcoded data,
2468 as a string, the back-end, as a symbol, and the communication
2472 "List of functions applied to a transcoded center block.
2473 Each filter is called with three arguments: the transcoded data,
2474 as a string, the back-end, as a symbol, and the communication
2478 "List of functions applied to a transcoded clock.
2479 Each filter is called with three arguments: the transcoded data,
2480 as a string, the back-end, as a symbol, and the communication
2484 "List of functions applied to a transcoded comment.
2485 Each filter is called with three arguments: the transcoded data,
2486 as a string, the back-end, as a symbol, and the communication
2490 "List of functions applied to a transcoded comment-block.
2491 Each filter is called with three arguments: the transcoded data,
2492 as a string, the back-end, as a symbol, and the communication
2496 "List of functions applied to a transcoded diary-sexp.
2497 Each filter is called with three arguments: the transcoded data,
2498 as a string, the back-end, as a symbol, and the communication
2502 "List of functions applied to a transcoded drawer.
2503 Each filter is called with three arguments: the transcoded data,
2504 as a string, the back-end, as a symbol, and the communication
2508 "List of functions applied to a transcoded dynamic-block.
2509 Each filter is called with three arguments: the transcoded data,
2510 as a string, the back-end, as a symbol, and the communication
2514 "List of functions applied to a transcoded example-block.
2515 Each filter is called with three arguments: the transcoded data,
2516 as a string, the back-end, as a symbol, and the communication
2520 "List of functions applied to a transcoded export-block.
2521 Each filter is called with three arguments: the transcoded data,
2522 as a string, the back-end, as a symbol, and the communication
2526 "List of functions applied to a transcoded fixed-width.
2527 Each filter is called with three arguments: the transcoded data,
2528 as a string, the back-end, as a symbol, and the communication
2532 "List of functions applied to a transcoded footnote-definition.
2533 Each filter is called with three arguments: the transcoded data,
2534 as a string, the back-end, as a symbol, and the communication
2538 "List of functions applied to a transcoded headline.
2539 Each filter is called with three arguments: the transcoded data,
2540 as a string, the back-end, as a symbol, and the communication
2544 "List of functions applied to a transcoded horizontal-rule.
2545 Each filter is called with three arguments: the transcoded data,
2546 as a string, the back-end, as a symbol, and the communication
2550 "List of functions applied to a transcoded inlinetask.
2551 Each filter is called with three arguments: the transcoded data,
2552 as a string, the back-end, as a symbol, and the communication
2556 "List of functions applied to a transcoded item.
2557 Each filter is called with three arguments: the transcoded data,
2558 as a string, the back-end, as a symbol, and the communication
2562 "List of functions applied to a transcoded keyword.
2563 Each filter is called with three arguments: the transcoded data,
2564 as a string, the back-end, as a symbol, and the communication
2568 "List of functions applied to a transcoded latex-environment.
2569 Each filter is called with three arguments: the transcoded data,
2570 as a string, the back-end, as a symbol, and the communication
2574 "List of functions applied to a transcoded node-property.
2575 Each filter is called with three arguments: the transcoded data,
2576 as a string, the back-end, as a symbol, and the communication
2580 "List of functions applied to a transcoded paragraph.
2581 Each filter is called with three arguments: the transcoded data,
2582 as a string, the back-end, as a symbol, and the communication
2586 "List of functions applied to a transcoded plain-list.
2587 Each filter is called with three arguments: the transcoded data,
2588 as a string, the back-end, as a symbol, and the communication
2592 "List of functions applied to a transcoded planning.
2593 Each filter is called with three arguments: the transcoded data,
2594 as a string, the back-end, as a symbol, and the communication
2598 "List of functions applied to a transcoded property-drawer.
2599 Each filter is called with three arguments: the transcoded data,
2600 as a string, the back-end, as a symbol, and the communication
2604 "List of functions applied to a transcoded quote block.
2605 Each filter is called with three arguments: the transcoded quote
2606 data, as a string, the back-end, as a symbol, and the
2607 communication channel, as a plist. It must return a string or
2611 "List of functions applied to a transcoded quote-section.
2612 Each filter is called with three arguments: the transcoded data,
2613 as a string, the back-end, as a symbol, and the communication
2617 "List of functions applied to a transcoded section.
2618 Each filter is called with three arguments: the transcoded data,
2619 as a string, the back-end, as a symbol, and the communication
2623 "List of functions applied to a transcoded special block.
2624 Each filter is called with three arguments: the transcoded data,
2625 as a string, the back-end, as a symbol, and the communication
2629 "List of functions applied to a transcoded src-block.
2630 Each filter is called with three arguments: the transcoded data,
2631 as a string, the back-end, as a symbol, and the communication
2635 "List of functions applied to a transcoded table.
2636 Each filter is called with three arguments: the transcoded data,
2637 as a string, the back-end, as a symbol, and the communication
2641 "List of functions applied to a transcoded table-cell.
2642 Each filter is called with three arguments: the transcoded data,
2643 as a string, the back-end, as a symbol, and the communication
2647 "List of functions applied to a transcoded table-row.
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 a transcoded verse block.
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 ;;;; Objects Filters
2662 "List of functions applied to transcoded bold text.
2663 Each filter is called with three arguments: the transcoded data,
2664 as a string, the back-end, as a symbol, and the communication
2668 "List of functions applied to transcoded code text.
2669 Each filter is called with three arguments: the transcoded data,
2670 as a string, the back-end, as a symbol, and the communication
2674 "List of functions applied to a transcoded entity.
2675 Each filter is called with three arguments: the transcoded data,
2676 as a string, the back-end, as a symbol, and the communication
2680 "List of functions applied to a transcoded export-snippet.
2681 Each filter is called with three arguments: the transcoded data,
2682 as a string, the back-end, as a symbol, and the communication
2686 "List of functions applied to a transcoded footnote-reference.
2687 Each filter is called with three arguments: the transcoded data,
2688 as a string, the back-end, as a symbol, and the communication
2692 "List of functions applied to a transcoded inline-babel-call.
2693 Each filter is called with three arguments: the transcoded data,
2694 as a string, the back-end, as a symbol, and the communication
2698 "List of functions applied to a transcoded inline-src-block.
2699 Each filter is called with three arguments: the transcoded data,
2700 as a string, the back-end, as a symbol, and the communication
2704 "List of functions applied to transcoded italic text.
2705 Each filter is called with three arguments: the transcoded data,
2706 as a string, the back-end, as a symbol, and the communication
2710 "List of functions applied to a transcoded latex-fragment.
2711 Each filter is called with three arguments: the transcoded data,
2712 as a string, the back-end, as a symbol, and the communication
2716 "List of functions applied to a transcoded line-break.
2717 Each filter is called with three arguments: the transcoded data,
2718 as a string, the back-end, as a symbol, and the communication
2722 "List of functions applied to a transcoded link.
2723 Each filter is called with three arguments: the transcoded data,
2724 as a string, the back-end, as a symbol, and the communication
2728 "List of functions applied to a transcoded radio-target.
2729 Each filter is called with three arguments: the transcoded data,
2730 as a string, the back-end, as a symbol, and the communication
2734 "List of functions applied to a transcoded statistics-cookie.
2735 Each filter is called with three arguments: the transcoded data,
2736 as a string, the back-end, as a symbol, and the communication
2740 "List of functions applied to transcoded strike-through text.
2741 Each filter is called with three arguments: the transcoded data,
2742 as a string, the back-end, as a symbol, and the communication
2746 "List of functions applied to a transcoded subscript.
2747 Each filter is called with three arguments: the transcoded data,
2748 as a string, the back-end, as a symbol, and the communication
2752 "List of functions applied to a transcoded superscript.
2753 Each filter is called with three arguments: the transcoded data,
2754 as a string, the back-end, as a symbol, and the communication
2758 "List of functions applied to a transcoded target.
2759 Each filter is called with three arguments: the transcoded data,
2760 as a string, the back-end, as a symbol, and the communication
2764 "List of functions applied to a transcoded timestamp.
2765 Each filter is called with three arguments: the transcoded data,
2766 as a string, the back-end, as a symbol, and the communication
2770 "List of functions applied to transcoded underline text.
2771 Each filter is called with three arguments: the transcoded data,
2772 as a string, the back-end, as a symbol, and the communication
2776 "List of functions applied to transcoded verbatim text.
2777 Each filter is called with three arguments: the transcoded data,
2778 as a string, the back-end, as a symbol, and the communication
2782 ;;;; Filters Tools
2783 ;;
2784 ;; Internal function `org-export-install-filters' installs filters
2785 ;; hard-coded in back-ends (developer filters) and filters from global
2786 ;; variables (user filters) in the communication channel.
2787 ;;
2788 ;; Internal function `org-export-filter-apply-functions' takes care
2789 ;; about applying each filter in order to a given data. It ignores
2790 ;; filters returning a nil value but stops whenever a filter returns
2791 ;; an empty string.
2794 "Call every function in FILTERS.
2796 Functions are called with arguments VALUE, current export
2797 back-end's name and INFO. A function returning a nil value will
2798 be skipped. If it returns the empty string, the process ends and
2799 VALUE is ignored.
2801 Call is done in a LIFO fashion, to be sure that developer
2802 specified filters, if any, are called first."
2813 "Install filters properties in communication channel.
2814 INFO is a plist containing the current communication channel.
2815 Return the updated communication channel."
2817 ;; Install user-defined filters with `org-export-filters-alist'
2818 ;; and filters already in INFO (through ext-plist mechanism).
2825 ;; Filters in INFO will be called
2826 ;; before those user provided.
2829 default-value)))))
2830 org-export-filters-alist)
2831 ;; Prepend back-end specific filters to that list.
2833 ;; Single values get consed, lists are appended.
2838 plist key
2842 ;; Return new communication channel.
2846 \f
2847 ;;; Core functions
2848 ;;
2849 ;; This is the room for the main function, `org-export-as', along with
2850 ;; its derivative, `org-export-string-as'.
2851 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2852 ;; function should be added to kill ring.
2853 ;;
2854 ;; Note that `org-export-as' doesn't really parse the current buffer,
2855 ;; but a copy of it (with the same buffer-local variables and
2856 ;; visibility), where macros and include keywords are expanded and
2857 ;; Babel blocks are executed, if appropriate.
2858 ;; `org-export-with-buffer-copy' macro prepares that copy.
2859 ;;
2860 ;; File inclusion is taken care of by
2861 ;; `org-export-expand-include-keyword' and
2862 ;; `org-export--prepare-file-contents'. Structure wise, including
2863 ;; a whole Org file in a buffer often makes little sense. For
2864 ;; example, if the file contains a headline and the include keyword
2865 ;; was within an item, the item should contain the headline. That's
2866 ;; why file inclusion should be done before any structure can be
2867 ;; associated to the file, that is before parsing.
2868 ;;
2869 ;; `org-export-insert-default-template' is a command to insert
2870 ;; a default template (or a back-end specific template) at point or in
2871 ;; current subtree.
2874 "Return a copy of the current buffer.
2875 The copy preserves Org buffer-local variables, visibility and
2876 narrowing."
2882 new-buf))
2885 "Apply BODY in a copy of the current buffer.
2886 The copy preserves local variables, visibility and contents of
2887 the original buffer. Point is at the beginning of the buffer
2888 when BODY is applied."
2897 ;; Kill copy without confirmation.
2903 "Generate a function duplicating BUFFER.
2905 The copy will preserve local variables, visibility, contents and
2906 narrowing of the original buffer. If a region was active in
2907 BUFFER, contents will be narrowed to that region instead.
2909 The resulting function can be evaled at a later time, from
2910 another buffer, effectively cloning the original buffer there.
2912 The function assumes BUFFER's major mode is `org-mode'."
2916 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2917 ;; already in BUFFER.
2919 ;; Copy specific buffer local variables and variables set
2920 ;; through BIND keywords.
2922 vars)
2930 buffer-file-name
2931 buffer-file-coding-system))
2935 ;; Skip unreadable values, as they cannot be
2936 ;; sent to external process.
2940 vars))))))
2941 ;; Whole buffer contents.
2946 ;; Narrowing.
2950 ;; Current position of point.
2952 ;; Overlays with invisible property.
2962 ov-set))))
2964 ov-set)))))
2966 ;;;###autoload
2969 "Transcode current Org buffer into BACKEND code.
2971 BACKEND is either an export back-end, as returned by, e.g.,
2972 `org-export-create-backend', or a symbol referring to
2973 a registered back-end.
2975 If narrowing is active in the current buffer, only transcode its
2976 narrowed part.
2978 If a region is active, transcode that region.
2980 When optional argument SUBTREEP is non-nil, transcode the
2981 sub-tree at point, extracting information from the headline
2982 properties first.
2984 When optional argument VISIBLE-ONLY is non-nil, don't export
2985 contents of hidden elements.
2987 When optional argument BODY-ONLY is non-nil, only return body
2988 code, without surrounding template.
2990 Optional argument EXT-PLIST, when provided, is a property list
2991 with external parameters overriding Org default settings, but
2992 still inferior to file-local settings.
2994 Return code as a string."
2999 ;; Narrow buffer to an appropriate region or subtree for
3000 ;; parsing. If parsing subtree, be sure to remove main headline
3001 ;; too.
3009 ;; Initialize communication channel with original buffer
3010 ;; attributes, unavailable in its copy.
3019 tree)
3020 ;; Update communication channel and get parse tree. Buffer
3021 ;; isn't parsed directly. Instead, a temporary copy is
3022 ;; created, where include keywords, macros are expanded and
3023 ;; code blocks are evaluated.
3025 ;; Run first hook with current back-end's name as argument.
3029 ;; Update macro templates since #+INCLUDE keywords might have
3030 ;; added some new ones.
3034 ;; Update radio targets since keyword inclusion might have
3035 ;; added some more.
3037 ;; Run last hook with current back-end's name as argument.
3042 ;; Update communication channel with environment. Also
3043 ;; install user's and developer's filters.
3048 ;; Expand export-specific set of macros: {{{author}}},
3049 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3050 ;; once regular macros have been expanded, since document
3051 ;; keywords may contain one of them.
3057 ;; EMAIL is not a parsed keyword: store it as-is.
3061 ;; Call options filters and update export options. We do not
3062 ;; use `org-export-filter-apply-functions' here since the
3063 ;; arity of such filters is different.
3068 ;; Parse buffer and call parse-tree filter on it.
3073 ;; Now tree is complete, compute its properties and add them
3074 ;; to communication channel.
3078 ;; Eventually transcode TREE. Wrap the resulting string into
3079 ;; a template.
3088 ;; Remove all text properties since they cannot be
3089 ;; retrieved from an external process. Finally call
3090 ;; final-output filter and return result.
3096 info))))))))
3098 ;;;###autoload
3100 "Transcode STRING into BACKEND code.
3102 BACKEND is either an export back-end, as returned by, e.g.,
3103 `org-export-create-backend', or a symbol referring to
3104 a registered back-end.
3106 When optional argument BODY-ONLY is non-nil, only return body
3107 code, without preamble nor postamble.
3109 Optional argument EXT-PLIST, when provided, is a property list
3110 with external parameters overriding Org default settings, but
3111 still inferior to file-local settings.
3113 Return code as a string."
3119 ;;;###autoload
3121 "Replace the active region by its export to BACKEND.
3122 BACKEND is either an export back-end, as returned by, e.g.,
3123 `org-export-create-backend', or a symbol referring to
3124 a registered back-end."
3134 ;;;###autoload
3136 "Insert all export keywords with default values at beginning of line.
3138 BACKEND is a symbol referring to the name of a registered export
3139 back-end, for which specific export options should be added to
3140 the template, or `default' for default template. When it is nil,
3141 the user will be prompted for a category.
3143 If SUBTREEP is non-nil, export configuration will be set up
3144 locally for the subtree through node properties."
3154 "Options category: "
3158 org-export--registered-backends))))))
3159 options keywords)
3160 ;; Populate OPTIONS and KEYWORDS.
3177 ;; Move to an appropriate location in order to insert options.
3179 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3180 ;; list of available keywords.
3208 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3226 ;; And the rest of keywords.
3237 "Expand every include keyword in buffer.
3238 Optional argument INCLUDED is a list of included file names along
3239 with their line restriction, when appropriate. It is used to
3240 avoid infinite recursion. Optional argument DIR is the current
3241 working directory. It is used to properly resolve relative
3242 paths."
3249 ;; Extract arguments from keyword's value.
3257 dir)
3262 value)
3268 ;; Minimal level of included file defaults to the child
3269 ;; level of the current headline, if any, or one. It
3270 ;; only applies is the file is meant to be included as
3271 ;; an Org one.
3279 ;; Remove keyword.
3285 ;; Check if files has already been parsed. Look after
3286 ;; inclusion lines too, as different parts of the same file
3287 ;; can be included too.
3299 ind-str contents ind-str))))
3307 ind-str env contents ind-str))))
3320 "Prepare the contents of FILE for inclusion and return them as a string.
3322 When optional argument LINES is a string specifying a range of
3323 lines, include only those lines.
3325 Optional argument IND, when non-nil, is an integer specifying the
3326 global indentation of returned contents. Since its purpose is to
3327 allow an included file to stay in the same environment it was
3328 created \(i.e. a list item), it doesn't apply past the first
3329 headline encountered.
3331 Optional argument MINLEVEL, when non-nil, is an integer
3332 specifying the level that any top-level headline in the included
3333 file should have."
3349 ;; Remove blank lines at beginning and end of contents. The logic
3350 ;; behind that removal is that blank lines around include keyword
3351 ;; override blank lines in included file.
3360 ;; If IND is set, preserve indentation of include keyword until
3361 ;; the first headline encountered.
3368 ;; Do not move footnote definitions out of column 0.
3374 ;; When MINLEVEL is specified, compute minimal level for headlines
3375 ;; in the file (CUR-MIN), and remove stars to each headline so
3376 ;; that headlines with minimal level have a level of MINLEVEL.
3387 ;; Only change stars, don't bother moving whole
3388 ;; sections.
3395 "Execute every Babel code in the visible part of current buffer."
3396 ;; Get a pristine copy of current buffer so Babel references can be
3397 ;; properly resolved.
3404 "Return a non-nil value when output should be added to the kill ring.
3405 See also `org-export-copy-to-kill-ring'."
3411 \f
3412 ;;; Tools For Back-Ends
3413 ;;
3414 ;; A whole set of tools is available to help build new exporters. Any
3415 ;; function general enough to have its use across many back-ends
3416 ;; should be added here.
3418 ;;;; For Affiliated Keywords
3419 ;;
3420 ;; `org-export-read-attribute' reads a property from a given element
3421 ;; as a plist. It can be used to normalize affiliated keywords'
3422 ;; syntax.
3423 ;;
3424 ;; Since captions can span over multiple lines and accept dual values,
3425 ;; their internal representation is a bit tricky. Therefore,
3426 ;; `org-export-get-caption' transparently returns a given element's
3427 ;; caption as a secondary string.
3430 "Turn ATTRIBUTE property from ELEMENT into a plist.
3432 When optional argument PROPERTY is non-nil, return the value of
3433 that property within attributes.
3437 properties.
3439 All values will become strings except the empty string and
3442 will become the empty string."
3456 s)
3461 ;; Ignore any string before first property with `cdr'.
3466 "Return caption from ELEMENT as a secondary string.
3468 When optional argument SHORTP is non-nil, return short caption,
3469 as a secondary string, instead.
3471 Caption lines are separated by a white space."
3479 ;;;; For Derived Back-ends
3480 ;;
3481 ;; `org-export-with-backend' is a function allowing to locally use
3482 ;; another back-end to transcode some object or element. In a derived
3483 ;; back-end, it may be used as a fall-back function once all specific
3484 ;; cases have been treated.
3487 "Call a transcoder from BACKEND on DATA.
3488 BACKEND is an export back-end, as returned by, e.g.,
3489 `org-export-create-backend', or a symbol referring to
3490 a registered back-end. DATA is an Org element, object, secondary
3491 string or string. CONTENTS, when non-nil, is the transcoded
3492 contents of DATA element, as a string. INFO, when non-nil, is
3493 the communication channel used for export, as a plist."
3503 transcoder data contents
3506 :translate-alist all-transcoders
3510 ;;;; For Export Snippets
3511 ;;
3512 ;; Every export snippet is transmitted to the back-end. Though, the
3513 ;; latter will only retain one type of export-snippet, ignoring
3514 ;; others, based on the former's target back-end. The function
3515 ;; `org-export-snippet-backend' returns that back-end for a given
3516 ;; export-snippet.
3519 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3520 Translation, with `org-export-snippet-translation-alist', is
3521 applied."
3525 back-end))))
3528 ;;;; For Footnotes
3529 ;;
3530 ;; `org-export-collect-footnote-definitions' is a tool to list
3531 ;; actually used footnotes definitions in the whole parse tree, or in
3532 ;; a headline, in order to add footnote listings throughout the
3533 ;; transcoded data.
3534 ;;
3535 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3536 ;; back-ends, when they need to attach the footnote definition only to
3537 ;; the first occurrence of the corresponding label.
3538 ;;
3539 ;; `org-export-get-footnote-definition' and
3540 ;; `org-export-get-footnote-number' provide easier access to
3541 ;; additional information relative to a footnote reference.
3544 "Return an alist between footnote numbers, labels and definitions.
3546 DATA is the parse tree from which definitions are collected.
3547 INFO is the plist used as a communication channel.
3549 Definitions are sorted by order of references. They either
3550 appear as Org data or as a secondary string for inlined
3551 footnotes. Unreferenced definitions are ignored."
3553 collect-fn ; for byte-compiler.
3557 ;; Collect footnote number, label and definition in DATA.
3565 def)
3566 num-alist)
3567 ;; Also search in definition for nested footnotes.
3570 ;; Don't enter footnote definitions since it will happen
3571 ;; when their first reference is found.
3577 "Non-nil when a footnote reference is the first one for its label.
3579 FOOTNOTE-REFERENCE is the footnote reference being considered.
3580 INFO is the plist used as a communication channel."
3582 ;; Anonymous footnotes are always a first reference.
3584 ;; Otherwise, return the first footnote with the same LABEL and
3585 ;; test if it is equal to FOOTNOTE-REFERENCE.
3595 ;; If FN isn't inlined, be sure to traverse its
3596 ;; definition before resuming search. See
3597 ;; comments in `org-export-get-footnote-number'
3598 ;; for more information.
3602 ;; Don't enter footnote definitions since it will
3603 ;; happen when their first reference is found.
3606 footnote-reference)))))
3609 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3610 INFO is the plist used as a communication channel. If no such
3612 string."
3619 "Return number associated to a footnote.
3621 FOOTNOTE is either a footnote reference or a footnote definition.
3622 INFO is the plist used as a communication channel."
3624 seen-refs
3625 search-ref ; For byte-compiler.
3629 ;; Search footnote references through DATA, filling
3630 ;; SEEN-REFS along the way.
3635 ;; Anonymous footnote match: return number.
3638 ;; Labels match: return number.
3641 ;; Anonymous footnote: it's always a new one.
3642 ;; Also, be sure to return nil from the `cond' so
3643 ;; `first-match' doesn't get us out of the loop.
3645 ;; Label not seen so far: add it so SEEN-REFS.
3646 ;;
3647 ;; Also search for subsequent references in
3648 ;; footnote definition so numbering follows
3649 ;; reading logic. Note that we don't have to care
3650 ;; about inline definitions, since
3651 ;; `org-element-map' already traverses them at the
3652 ;; right time.
3653 ;;
3654 ;; Once again, return nil to stay in the loop.
3659 nil))))
3660 ;; Don't enter footnote definitions since it will
3661 ;; happen when their first reference is found.
3666 ;;;; For Headlines
3667 ;;
3668 ;; `org-export-get-relative-level' is a shortcut to get headline
3669 ;; level, relatively to the lower headline level in the parsed tree.
3670 ;;
3671 ;; `org-export-get-headline-number' returns the section number of an
3672 ;; headline, while `org-export-number-to-roman' allows to convert it
3673 ;; to roman numbers.
3674 ;;
3675 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3676 ;; `org-export-last-sibling-p' are three useful predicates when it
3677 ;; comes to fulfill the `:headline-levels' property.
3678 ;;
3679 ;; `org-export-get-tags', `org-export-get-category' and
3680 ;; `org-export-get-node-property' extract useful information from an
3681 ;; headline or a parent headline. They all handle inheritance.
3682 ;;
3683 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3684 ;; as a secondary string, suitable for table of contents. It falls
3685 ;; back onto default title.
3688 "Return HEADLINE relative level within current parsed tree.
3689 INFO is a plist holding contextual information."
3694 "Non-nil when HEADLINE is considered as low level.
3696 INFO is a plist used as a communication channel.
3698 A low level headlines has a relative level greater than
3699 `:headline-levels' property value.
3701 Return value is the difference between HEADLINE relative level
3702 and the last level being considered as high enough, or nil."
3709 "Return HEADLINE numbering as a list of numbers.
3710 INFO is a plist holding contextual information."
3714 "Return a non-nil value if HEADLINE element should be numbered.
3715 INFO is a plist used as a communication channel."
3721 "Convert integer N into a roman numeral."
3734 res)))
3737 "Return list of tags associated to ELEMENT.
3739 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3740 is a plist used as a communication channel.
3742 Select tags (see `org-export-select-tags') and exclude tags (see
3743 `org-export-exclude-tags') are removed from the list.
3745 When non-nil, optional argument TAGS should be a list of strings.
3746 Any tag belonging to this list will also be removed.
3748 When optional argument INHERITED is non-nil, tags can also be
3749 inherited from parent headlines and FILETAGS keywords."
3755 ;; Build complete list of inherited tags.
3766 ;; Add FILETAGS keywords and return results.
3770 "Return node PROPERTY value for BLOB.
3772 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3773 element or object.
3775 If optional argument INHERITED is non-nil, the value can be
3776 inherited from a parent headline.
3778 Return value is a string or nil."
3790 "Return category for element or object BLOB.
3792 INFO is a plist used as a communication channel.
3794 CATEGORY is automatically inherited from a parent headline, from
3795 #+CATEGORY: keyword or created out of original file name. If all
3799 ;; Almost like `org-export-node-property', but we cannot trust
3800 ;; `plist-member' as every headline has a `:CATEGORY'
3801 ;; property, would it be nil or equal to "???" (which has the
3802 ;; same meaning).
3820 "Return alternative title for HEADLINE, as a secondary string.
3821 INFO is a plist used as a communication channel. If no optional
3822 title is defined, fall-back to the regular title."
3827 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3828 INFO is a plist used as a communication channel."
3833 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3834 INFO is a plist used as a communication channel."
3838 ;;;; For Keywords
3839 ;;
3840 ;; `org-export-get-date' returns a date appropriate for the document
3841 ;; to about to be exported. In particular, it takes care of
3842 ;; `org-export-date-timestamp-format'.
3845 "Return date value for the current document.
3847 INFO is a plist used as a communication channel. FMT, when
3848 non-nil, is a time format string that will be applied on the date
3849 if it consists in a single timestamp object. It defaults to
3850 `org-export-date-timestamp-format' when nil.
3852 A proper date can be a secondary string, a string or nil. It is
3853 meant to be translated with `org-export-data' or alike."
3864 ;;;; For Links
3865 ;;
3866 ;; `org-export-solidify-link-text' turns a string into a safer version
3867 ;; for links, replacing most non-standard characters with hyphens.
3868 ;;
3869 ;; `org-export-get-coderef-format' returns an appropriate format
3870 ;; string for coderefs.
3871 ;;
3872 ;; `org-export-inline-image-p' returns a non-nil value when the link
3873 ;; provided should be considered as an inline image.
3874 ;;
3875 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3876 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3877 ;; returns an appropriate unique identifier when found, or nil.
3878 ;;
3879 ;; `org-export-resolve-id-link' returns the first headline with
3880 ;; specified id or custom-id in parse tree, the path to the external
3881 ;; file with the id or nil when neither was found.
3882 ;;
3883 ;; `org-export-resolve-coderef' associates a reference to a line
3884 ;; number in the element it belongs, or returns the reference itself
3885 ;; when the element isn't numbered.
3888 "Take link text S and make a safe target out of it."
3893 "Return format string for code reference link.
3894 PATH is the link path. DESC is its description."
3902 "Non-nil if LINK object points to an inline image.
3904 Optional argument is a set of RULES defining inline images. It
3905 is an alist where associations have the following shape:
3907 \(TYPE . REGEXP)
3909 Applying a rule means apply REGEXP against LINK's path when its
3910 type is TYPE. The function will return a non-nil value if any of
3911 the provided rules is non-nil. The default rule is
3912 `org-export-default-inline-image-rule'.
3914 This only applies to links without a description."
3925 rules)
3926 ;; Return nil if no rule matched.
3927 nil))))
3930 "Resolve a code reference REF.
3932 INFO is a plist used as a communication channel.
3934 Return associated line number in source code, or REF itself,
3935 depending on src-block or example element's switches."
3942 org-coderef-label-format)))
3946 ;; Element containing REF is found. Resolve it to either
3947 ;; a label or a line number, as needed.
3957 "Return LINK destination.
3959 INFO is a plist holding contextual information.
3961 Return value can be an object, an element, or nil:
3963 - If LINK path matches a target object (i.e. <<path>>) return it.
3965 - If LINK path exactly matches the name affiliated keyword
3966 \(i.e. #+NAME: path) of an element, return that element.
3968 - If LINK path exactly matches any headline name, return that
3969 element. If more than one headline share that name, priority
3970 will be given to the one with the closest common ancestor, if
3971 any, or the first one in the parse tree otherwise.
3973 - Otherwise, return nil.
3976 significant."
3979 ;; Split PATH at white spaces so matches are space
3980 ;; insensitive.
3983 ;; Cache for destinations that are not position dependent.
3991 ;; Destination is not position dependent: use cached value.
3993 ;; First try to find a matching "<<path>>" unless user specified
3994 ;; he was looking for a headline (path starts with a "*"
3995 ;; character).
4001 path)
4002 blob))
4005 ;; Then try to find an element with a matching "#+NAME: path"
4006 ;; affiliated keyword.
4009 org-element-all-elements
4014 el)))
4017 ;; Last case: link either points to a headline or to nothingness.
4018 ;; Try to find the source, with priority given to headlines with
4019 ;; the closest common ancestor. If such candidate is found,
4020 ;; return it, otherwise return nil.
4024 ;; Return first headline whose `:raw-value' property is
4025 ;; NAME in parse tree DATA, or nil. Statistics cookies
4026 ;; are ignored.
4034 name)
4035 headline))
4037 ;; Search among headlines sharing an ancestor with link, from
4038 ;; closest to farthest.
4047 ;; No destination found: return nil.
4051 "Return headline referenced as LINK destination.
4053 INFO is a plist used as a communication channel.
4055 Return value can be the headline element matched in current parse
4059 ;; First check if id is within the current parse tree.
4064 headline))
4066 ;; Otherwise, look for external files.
4070 "Return radio-target object referenced as LINK destination.
4072 INFO is a plist used as a communication channel.
4074 Return value can be a radio-target object or nil. Assume LINK
4083 nil nil path nil nil t)
4084 t)
4085 radio))
4089 ;;;; For References
4090 ;;
4091 ;; `org-export-get-ordinal' associates a sequence number to any object
4092 ;; or element.
4095 "Return ordinal number of an element or object.
4097 ELEMENT is the element or object considered. INFO is the plist
4098 used as a communication channel.
4100 Optional argument TYPES, when non-nil, is a list of element or
4101 object types, as symbols, that should also be counted in.
4102 Otherwise, only provided element's type is considered.
4104 Optional argument PREDICATE is a function returning a non-nil
4105 value if the current element or object should be counted in. It
4106 accepts two arguments: the element or object being considered and
4107 the plist used as a communication channel. This allows to count
4108 only a certain type of objects (i.e. inline images).
4110 Return value is a list of numbers if ELEMENT is a headline or an
4111 item. It is nil for keywords. It represents the footnote number
4112 for footnote definitions and footnote references. If ELEMENT is
4113 a target, return the same value as if ELEMENT was the closest
4114 table, item or headline containing the target. In any other
4115 case, return the sequence number of ELEMENT among elements or
4116 objects of the same type."
4117 ;; Ordinal of a target object refer to the ordinal of the closest
4118 ;; table, item, or headline containing the object.
4122 when
4126 table))
4127 return parent)))
4129 ;; Special case 1: A headline returns its number as a list.
4131 ;; Special case 2: An item returns its number as a list.
4135 struct
4142 ;; Increment counter until ELEMENT is found again.
4153 ;;;; For Src-Blocks
4154 ;;
4155 ;; `org-export-get-loc' counts number of code lines accumulated in
4156 ;; src-block or example-block elements with a "+n" switch until
4157 ;; a given element, excluded. Note: "-n" switches reset that count.
4158 ;;
4159 ;; `org-export-unravel-code' extracts source code (along with a code
4160 ;; references alist) from an `element-block' or `src-block' type
4161 ;; element.
4162 ;;
4163 ;; `org-export-format-code' applies a formatting function to each line
4164 ;; of code, providing relative line number and code reference when
4165 ;; appropriate. Since it doesn't access the original element from
4166 ;; which the source code is coming, it expects from the code calling
4167 ;; it to know if lines should be numbered and if code references
4168 ;; should appear.
4169 ;;
4170 ;; Eventually, `org-export-format-code-default' is a higher-level
4171 ;; function (it makes use of the two previous functions) which handles
4172 ;; line numbering and code references inclusion, and returns source
4173 ;; code in a format suitable for plain text or verbatim output.
4176 "Return accumulated lines of code up to ELEMENT.
4178 INFO is the plist used as a communication channel.
4180 ELEMENT is excluded from count."
4186 ;; ELEMENT is reached: Quit the loop.
4188 ;; Only count lines from src-block and example-block elements
4189 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4193 ;; Accumulate locs or reset them.
4197 ;; Return nil to stay in the loop.
4198 nil)))
4200 ;; Return value.
4201 loc))
4204 "Clean source code and extract references out of it.
4206 ELEMENT has either a `src-block' an `example-block' type.
4208 Return a cons cell whose CAR is the source code, cleaned from any
4209 reference, protective commas and spurious indentation, and CDR is
4210 an alist between relative line number (integer) and name of code
4211 reference on that line (string)."
4214 ;; Get code and clean it. Remove blank lines at its
4215 ;; beginning and end.
4222 value
4224 ;; Get format used for references.
4227 org-coderef-label-format)))
4228 ;; Build a regexp matching a loc with a reference.
4233 ;; Return value.
4235 ;; Code with references removed.
4241 ;; Ref line: remove ref, and signal its position in REFS.
4245 ;; Reference alist.
4246 refs)))
4249 "Format CODE by applying FUN line-wise and return it.
4251 CODE is a string representing the code to format. FUN is
4252 a function. It must accept three arguments: a line of
4253 code (string), the current line number (integer) or nil and the
4254 reference associated to the current line (string) or nil.
4256 Optional argument NUM-LINES can be an integer representing the
4257 number of code lines accumulated until the current code. Line
4258 numbers passed to FUN will take it into account. If it is nil,
4259 FUN's second argument will always be nil. This number can be
4260 obtained with `org-export-get-loc' function.
4262 Optional argument REF-ALIST can be an alist between relative line
4263 number (i.e. ignoring NUM-LINES) and the name of the code
4264 reference on it. If it is nil, FUN's third argument will always
4265 be nil. It can be obtained through the use of
4266 `org-export-unravel-code' function."
4278 "Return source code from ELEMENT, formatted in a standard way.
4280 ELEMENT is either a `src-block' or `example-block' element. INFO
4281 is a plist used as a communication channel.
4283 This function takes care of line numbering and code references
4284 inclusion. Line numbers, when applicable, appear at the
4285 beginning of the line, separated from the code by two white
4286 spaces. Code references, on the other hand, appear flushed to
4287 the right, separated by six white spaces from the widest line of
4288 code."
4289 ;; Extract code and references.
4296 ;; Handle line numbering.
4305 ;; Prepare references display, if required. Any reference
4306 ;; should start six columns after the widest line of code,
4307 ;; wrapped with parenthesis.
4312 code
4316 number-str
4317 loc
4323 num-start refs)))))
4326 ;;;; For Tables
4327 ;;
4328 ;; `org-export-table-has-special-column-p' and and
4329 ;; `org-export-table-row-is-special-p' are predicates used to look for
4330 ;; meta-information about the table structure.
4331 ;;
4332 ;; `org-table-has-header-p' tells when the rows before the first rule
4333 ;; should be considered as table's header.
4334 ;;
4335 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4336 ;; and `org-export-table-cell-borders' extract information from
4337 ;; a table-cell element.
4338 ;;
4339 ;; `org-export-table-dimensions' gives the number on rows and columns
4340 ;; in the table, ignoring horizontal rules and special columns.
4341 ;; `org-export-table-cell-address', given a table-cell object, returns
4342 ;; the absolute address of a cell. On the other hand,
4343 ;; `org-export-get-table-cell-at' does the contrary.
4344 ;;
4345 ;; `org-export-table-cell-starts-colgroup-p',
4346 ;; `org-export-table-cell-ends-colgroup-p',
4347 ;; `org-export-table-row-starts-rowgroup-p',
4348 ;; `org-export-table-row-ends-rowgroup-p',
4349 ;; `org-export-table-row-starts-header-p' and
4350 ;; `org-export-table-row-ends-header-p' indicate position of current
4351 ;; row or cell within the table.
4354 "Non-nil when TABLE has a special column.
4355 All special columns will be ignored during export."
4356 ;; The table has a special column when every first cell of every row
4357 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4358 ;; "*" "_" and "^". Though, do not consider a first row containing
4359 ;; only empty cells as special.
4375 "Non-nil when TABLE has a header.
4377 INFO is a plist used as a communication channel.
4379 A table has a header when it contains at least two row groups."
4388 table
4399 cache)))))
4402 "Non-nil if TABLE-ROW is considered special.
4404 INFO is a plist used as the communication channel.
4406 All special rows will be ignored during export."
4410 ;; A row is special either when...
4412 ;; ... it starts with a field only containing "/",
4414 ;; ... the table contains a special column and the row start
4415 ;; with a marking character among, "^", "_", "$" or "!",
4419 ;; ... it contains only alignment cookies and empty cells.
4425 ;; Since VALUE is a secondary string, the following
4426 ;; checks avoid expanding it with `org-export-data'.
4438 "Return TABLE-ROW's group number, as an integer.
4440 INFO is a plist used as the communication channel.
4442 Return value is the group number, as an integer, or nil for
4443 special rows and rows separators. First group is also table's
4444 header."
4462 "Return TABLE-CELL contents width.
4464 INFO is a plist used as the communication channel.
4466 Return value is the width given by the last width cookie in the
4467 same column as TABLE-CELL, or nil."
4486 ;; In a special row, try to find a width cookie at COLUMN.
4490 ;; The following checks avoid expanding unnecessarily
4491 ;; the cell with `org-export-data'.
4501 "Return TABLE-CELL contents alignment.
4503 INFO is a plist used as the communication channel.
4505 Return alignment as specified by the last alignment cookie in the
4506 same column as TABLE-CELL. If no such cookie is found, a default
4507 alignment value will be deduced from fraction of numbers in the
4508 column (see `org-table-number-fraction' for more information).
4509 Possible values are `left', `right' and `center'."
4510 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4527 cookie-align
4528 previous-cell-number-p)
4531 ;; In a special row, try to find an alignment cookie at
4532 ;; COLUMN.
4536 ;; Since VALUE is a secondary string, the following
4537 ;; checks avoid useless expansion through
4538 ;; `org-export-data'.
4546 ;; Ignore table rules.
4548 ;; In a standard row, check if cell's contents are
4549 ;; expressing some kind of number. Increase NUMBER-CELLS
4550 ;; accordingly. Though, don't bother if an alignment
4551 ;; cookie has already defined cell's alignment.
4556 info)))
4558 ;; Treat an empty cell as a number if it follows
4559 ;; a number.
4565 ;; Return value. Alignment specified by cookies has
4566 ;; precedence over alignment deduced from cell's contents.
4568 column
4573 org-table-number-fraction)
4578 "Return TABLE-CELL borders.
4580 INFO is a plist used as a communication channel.
4582 Return value is a list of symbols, or nil. Possible values are:
4583 `top', `bottom', `above', `below', `left' and `right'. Note:
4584 `top' (resp. `bottom') only happen for a cell in the first
4585 row (resp. last row) of the table, ignoring table rules, if any.
4587 Returned borders ignore special rows."
4590 borders)
4591 ;; Top/above border? TABLE-CELL has a border above when a rule
4592 ;; used to demarcate row groups can be found above. Hence,
4593 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4594 ;; another regular row has to be found above that rule.
4603 ;; Look at every row before the current one.
4605 ;; No rule above, or rule found starts the table (ignoring any
4606 ;; special row): TABLE-CELL is at the top of the table.
4609 ;; Bottom/below border? TABLE-CELL has a border below when next
4610 ;; non-regular row below is a rule.
4619 ;; Look at every row after the current one.
4621 ;; No rule below, or rule found ends the table (modulo some
4622 ;; special row): TABLE-CELL is at the bottom of the table.
4625 ;; Right/left borders? They can only be specified by column
4626 ;; groups. Column groups are defined in a row starting with "/".
4627 ;; Also a column groups row only contains "<", "<>", ">" or blank
4628 ;; cells.
4645 ;; There's a left border when previous cell, if
4646 ;; any, ends a group, or current one starts one.
4652 ;; There's a right border when next cell, if any,
4653 ;; starts a group, or current one ends one.
4660 ;; Table rows are read in reverse order so last column groups
4661 ;; row has precedence over any previous one.
4663 ;; Return value.
4664 borders))
4667 "Non-nil when TABLE-CELL is at the beginning of a column group.
4668 INFO is a plist used as a communication channel."
4669 ;; A cell starts a column group either when it is at the beginning
4670 ;; of a row (or after the special column, if any) or when it has
4671 ;; a left border.
4674 table-cell)
4678 "Non-nil when TABLE-CELL is at the end of a column group.
4679 INFO is a plist used as a communication channel."
4680 ;; A cell ends a column group either when it is at the end of a row
4681 ;; or when it has a right border.
4684 table-cell)
4688 "Non-nil when TABLE-ROW is at the beginning of a row group.
4689 INFO is a plist used as a communication channel."
4697 "Non-nil when TABLE-ROW is at the end of a row group.
4698 INFO is a plist used as a communication channel."
4706 "Non-nil when TABLE-ROW is the first table header's row.
4707 INFO is a plist used as a communication channel."
4714 "Non-nil when TABLE-ROW is the last table header's row.
4715 INFO is a plist used as a communication channel."
4722 "Return TABLE-ROW number.
4723 INFO is a plist used as a communication channel. Return value is
4724 zero-based and ignores separators. The function returns nil for
4725 special colums and separators."
4737 "Return TABLE dimensions.
4739 INFO is a plist used as a communication channel.
4741 Return value is a CONS like (ROWS . COLUMNS) where
4742 ROWS (resp. COLUMNS) is the number of exportable
4743 rows (resp. columns)."
4745 ;; Set number of rows, and extract first one.
4751 ;; Set number of columns.
4753 ;; Return value.
4757 "Return address of a regular TABLE-CELL object.
4759 TABLE-CELL is the cell considered. INFO is a plist used as
4760 a communication channel.
4762 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4763 zero-based index. Only exportable cells are considered. The
4764 function returns nil for other cells."
4776 "Return regular table-cell object at ADDRESS in TABLE.
4778 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4779 zero-based index. TABLE is a table type element. INFO is
4780 a plist used as a communication channel.
4782 If no table-cell, among exportable cells, is found at ADDRESS,
4783 return nil."
4786 ;; Row at (car address) or nil.
4794 'table-cell
4801 ;;;; For Tables Of Contents
4802 ;;
4803 ;; `org-export-collect-headlines' builds a list of all exportable
4804 ;; headline elements, maybe limited to a certain depth. One can then
4805 ;; easily parse it and transcode it.
4806 ;;
4807 ;; Building lists of tables, figures or listings is quite similar.
4808 ;; Once the generic function `org-export-collect-elements' is defined,
4809 ;; `org-export-collect-tables', `org-export-collect-figures' and
4810 ;; `org-export-collect-listings' can be derived from it.
4813 "Collect headlines in order to build a table of contents.
4815 INFO is a plist used as a communication channel.
4817 When optional argument N is an integer, it specifies the depth of
4818 the table of contents. Otherwise, it is set to the value of the
4819 last headline level. See `org-export-headline-levels' for more
4820 information.
4822 Return a list of all exportable headlines as parsed elements.
4823 Footnote sections, if any, will be ignored."
4831 info)))
4834 "Collect referenceable elements of a determined type.
4836 TYPE can be a symbol or a list of symbols specifying element
4837 types to search. Only elements with a caption are collected.
4839 INFO is a plist used as a communication channel.
4841 When non-nil, optional argument PREDICATE is a function accepting
4842 one argument, an element of type TYPE. It returns a non-nil
4843 value when that element should be collected.
4845 Return a list of all elements found, in order of appearance."
4850 element))
4851 info))
4854 "Build a list of tables.
4855 INFO is a plist used as a communication channel.
4857 Return a list of table elements with a caption."
4861 "Build a list of figures.
4863 INFO is a plist used as a communication channel. PREDICATE is
4864 a function which accepts one argument: a paragraph element and
4865 whose return value is non-nil when that element should be
4866 collected.
4868 A figure is a paragraph type element, with a caption, verifying
4870 a vague concept that may depend on back-end.
4872 Return a list of elements recognized as figures."
4876 "Build a list of src blocks.
4878 INFO is a plist used as a communication channel.
4880 Return a list of src-block elements with a caption."
4884 ;;;; Smart Quotes
4885 ;;
4886 ;; The main function for the smart quotes sub-system is
4887 ;; `org-export-activate-smart-quotes', which replaces every quote in
4888 ;; a given string from the parse tree with its "smart" counterpart.
4889 ;;
4890 ;; Dictionary for smart quotes is stored in
4891 ;; `org-export-smart-quotes-alist'.
4892 ;;
4893 ;; Internally, regexps matching potential smart quotes (checks at
4894 ;; string boundaries are also necessary) are defined in
4895 ;; `org-export-smart-quotes-regexps'.
4899 ;; one may use: »...«, "...", ›...‹, or '...'.
4900 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4901 ;; LaTeX quotes require Babel!
4946 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4955 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4964 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4973 ;; http://ru.wikipedia.org/wiki/%D0%9A%D0%B0%D0%B2%D1%8B%D1%87%D0%BA%D0%B8#.D0.9A.D0.B0.D0.B2.D1.8B.D1.87.D0.BA.D0.B8.2C_.D0.B8.D1.81.D0.BF.D0.BE.D0.BB.D1.8C.D0.B7.D1.83.D0.B5.D0.BC.D1.8B.D0.B5_.D0.B2_.D1.80.D1.83.D1.81.D1.81.D0.BA.D0.BE.D0.BC_.D1.8F.D0.B7.D1.8B.D0.BA.D0.B5
4974 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
4985 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4991 )
4992 "Smart quotes translations.
4994 Alist whose CAR is a language string and CDR is an alist with
4995 quote type as key and a plist associating various encodings to
4996 their translation as value.
4998 A quote type can be any symbol among `opening-double-quote',
4999 `closing-double-quote', `opening-single-quote',
5000 `closing-single-quote' and `apostrophe'.
5002 Valid encodings include `:utf-8', `:html', `:latex' and
5003 `:texinfo'.
5009 ;; Possible opening quote at beginning of string.
5011 ;; Possible closing quote at beginning of string.
5013 ;; Possible apostrophe at beginning of string.
5015 ;; Opening single and double quotes.
5017 ;; Closing single and double quotes.
5019 ;; Apostrophe.
5021 ;; Possible opening quote at end of string.
5023 ;; Possible closing quote at end of string.
5025 ;; Possible apostrophe at end of string.
5027 "List of regexps matching a quote or an apostrophe.
5033 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5034 `:utf-8'. INFO is a plist used as a communication channel.
5036 The function has to retrieve information about string
5037 surroundings in parse tree. It can only happen with an
5038 unmodified string. Thus, if S has already been through another
5039 process, a non-nil ORIGINAL optional argument will provide that
5040 original string.
5042 Return the new string."
5045 ;; Try to be flexible when computing number of blanks
5046 ;; before object. The previous object may be a string
5047 ;; introduced by the back-end and not completely parsed.
5050 ;; A string with missing `:post-blank'
5051 ;; property.
5055 ;; Fallback value.
5060 ;; Return smart quote associated to a give quote Q, as
5061 ;; a string. TYPE is a symbol among `open', `close' and
5062 ;; `apostrophe'.
5072 org-export-smart-quotes-alist))))
5073 encoding)
5074 q)))))
5076 ;; Only a quote: no regexp can match. We have to check both
5077 ;; sides and decide what to do.
5085 ;; 1. Replace quote character at the beginning of S.
5087 ;; Apostrophe?
5093 ;; Closing quote?
5099 ;; Opening quote?
5105 ;; 2. Replace quotes in the middle of the string.
5107 ;; Opening quotes.
5113 ;; Closing quotes.
5119 ;; Apostrophes.
5124 ;; 3. Replace quote character at the end of S.
5126 ;; Apostrophe?
5131 ;; Closing quote?
5137 ;; Opening quote?
5142 ;; Return string with smart quotes.
5143 s))))
5145 ;;;; Topology
5146 ;;
5147 ;; Here are various functions to retrieve information about the
5148 ;; neighbourhood of a given element or object. Neighbours of interest
5149 ;; are direct parent (`org-export-get-parent'), parent headline
5150 ;; (`org-export-get-parent-headline'), first element containing an
5151 ;; object, (`org-export-get-parent-element'), parent table
5152 ;; (`org-export-get-parent-table'), previous element or object
5153 ;; (`org-export-get-previous-element') and next element or object
5154 ;; (`org-export-get-next-element').
5155 ;;
5156 ;; `org-export-get-genealogy' returns the full genealogy of a given
5157 ;; element or object, from closest parent to full parse tree.
5160 "Return BLOB parent or nil.
5161 BLOB is the element or object considered."
5165 "Return full genealogy relative to a given element or object.
5167 BLOB is the element or object being considered.
5169 Ancestors are returned from closest to farthest, the last one
5170 being the full parse tree."
5177 "Return BLOB parent headline or nil.
5178 BLOB is the element or object being considered."
5182 parent))
5185 "Return first element containing OBJECT or nil.
5186 OBJECT is the object to consider."
5190 parent))
5193 "Return OBJECT parent table or nil.
5194 OBJECT is either a `table-cell' or `table-element' type object."
5198 parent))
5201 "Return previous element or object.
5203 BLOB is an element or object. INFO is a plist used as
5204 a communication channel. Return previous 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 before BLOB, from farthest to
5209 closest. With any other non-nil value, return a list containing
5210 all of them."
5212 ;; An object can belong to the contents of its parent or
5213 ;; to a secondary string. We check the latter option
5214 ;; first.
5218 org-element-secondary-value-alist))
5219 parent)))
5222 prev)
5231 prev)))
5234 "Return next element or object.
5236 BLOB is an element or object. INFO is a plist used as
5237 a communication channel. Return next exportable element or
5238 object, a string, or nil.
5240 When optional argument N is a positive integer, return a list
5241 containing up to N siblings after BLOB, from closest to farthest.
5242 With any other non-nil value, return a list containing all of
5243 them."
5245 ;; An object can belong to the contents of its parent or to
5246 ;; a secondary string. We check the latter option first.
5250 org-element-secondary-value-alist))
5251 parent)))
5254 next)
5262 siblings)
5266 ;;;; Translation
5267 ;;
5268 ;; `org-export-translate' translates a string according to the language
5269 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5270 ;; the dictionary used for the translation.
5484 "Dictionary for export engine.
5486 Alist whose CAR is the string to translate and CDR is an alist
5487 whose CAR is the language string and CDR is a plist whose
5488 properties are possible charsets and values translated terms.
5490 It is used as a database for `org-export-translate'. Since this
5491 function returns the string as-is if no translation was found,
5492 the variable only needs to record values different from the
5496 "Translate string S according to language specification.
5498 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5499 and `:utf-8'. INFO is a plist used as a communication channel.
5501 Translation depends on `:language' property. Return the
5502 translated string. If no translation is found, try to fall back
5503 to `:default' encoding. If it fails, return S."
5509 s)))
5512 \f
5513 ;;; Asynchronous Export
5514 ;;
5515 ;; `org-export-async-start' is the entry point for asynchronous
5516 ;; export. It recreates current buffer (including visibility,
5517 ;; narrowing and visited file) in an external Emacs process, and
5518 ;; evaluates a command there. It then applies a function on the
5519 ;; returned results in the current process.
5520 ;;
5521 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5522 ;; allow to export to a buffer or a file, asynchronously or not.
5523 ;;
5524 ;; `org-export-output-file-name' is an auxiliary function meant to be
5525 ;; used with `org-export-to-file'. With a given extension, it tries
5526 ;; to provide a canonical file name to write export output to.
5527 ;;
5528 ;; Asynchronously generated results are never displayed directly.
5529 ;; Instead, they are stored in `org-export-stack-contents'. They can
5530 ;; then be retrieved by calling `org-export-stack'.
5531 ;;
5532 ;; Export Stack is viewed through a dedicated major mode
5533 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5534 ;;`org-export-stack-delete', `org-export-stack-view' and
5535 ;;`org-export-stack-clear'.
5536 ;;
5537 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5538 ;; It should be used whenever `org-export-async-start' is called.
5541 "Call function FUN on the results returned by BODY evaluation.
5543 BODY evaluation happens in an asynchronous process, from a buffer
5544 which is an exact copy of the current one.
5546 Use `org-export-add-to-stack' in FUN in order to register results
5547 in the stack.
5549 This is a low level function. See also `org-export-to-buffer'
5550 and `org-export-to-file' for more specialized functions."
5553 ;; Write the full sexp evaluating BODY in a copy of the current
5554 ;; buffer to a temporary file, as it may be too long for program
5555 ;; args in `start-process'.
5562 ;; Null characters (from variable values) are inserted
5563 ;; within the file. As a consequence, coding system for
5564 ;; buffer contents will not be recognized properly. So,
5565 ;; we make sure it is the same as the one used to display
5566 ;; the original buffer.
5568 ,coding
5571 ;; Ignore `kill-emacs-hook' and code evaluation
5572 ;; queries from Babel as we need a truly
5573 ;; non-interactive process.
5575 org-babel-confirm-evaluate-answer-no t)
5576 ;; Initialize export framework.
5578 ;; Re-create current buffer there.
5581 ;; Sexp to evaluate in the buffer.
5583 ;; Start external process.
5586 (,process
5588 #'start-process
5591 ,proc-buffer
5598 ;; Register running process in stack.
5600 ;; Set-up sentinel in order to catch results.
5603 ,process
5625 ;;;###autoload
5628 &optional async subtreep visible-only body-only ext-plist
5629 post-process)
5630 "Call `org-export-as' with output to a specified buffer.
5632 BACKEND is either an export back-end, as returned by, e.g.,
5633 `org-export-create-backend', or a symbol referring to
5634 a registered back-end.
5636 BUFFER is the name of the output buffer. If it already exists,
5637 it will be erased first, otherwise, it will be created.
5639 A non-nil optional argument ASYNC means the process should happen
5640 asynchronously. The resulting buffer should then be accessible
5641 through the `org-export-stack' interface. When ASYNC is nil, the
5642 buffer is displayed if `org-export-show-temporary-export-buffer'
5643 is non-nil.
5645 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5646 EXT-PLIST are similar to those used in `org-export-as', which
5647 see.
5649 Optional argument POST-PROCESS is a function which should accept
5650 no argument. It is always called within the current process,
5651 from BUFFER, with point at its beginning. Export back-ends can
5652 use it to set a major mode there, e.g,
5654 \(defun org-latex-export-as-latex
5655 \(&optional async subtreep visible-only body-only ext-plist)
5656 \(interactive)
5658 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5660 This function returns BUFFER."
5688 buffer)))
5690 ;;;###autoload
5693 post-process)
5694 "Call `org-export-as' with output to a specified file.
5696 BACKEND is either an export back-end, as returned by, e.g.,
5697 `org-export-create-backend', or a symbol referring to
5698 a registered back-end. FILE is the name of the output file, as
5699 a string.
5701 A non-nil optional argument ASYNC means the process should happen
5702 asynchronously. The resulting buffer file then be accessible
5703 through the `org-export-stack' interface.
5705 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5706 EXT-PLIST are similar to those used in `org-export-as', which
5707 see.
5709 Optional argument POST-PROCESS is called with FILE as its
5710 argument and happens asynchronously when ASYNC is non-nil. It
5711 has to return a file name, or nil. Export back-ends can use this
5712 to send the output file through additional processing, e.g,
5714 \(defun org-latex-export-to-latex
5715 \(&optional async subtreep visible-only body-only ext-plist)
5716 \(interactive)
5718 \(org-export-to-file 'latex outfile
5719 async subtreep visible-only body-only ext-plist
5720 \(lambda (file) (org-latex-compile file)))
5722 The function returns either a file name returned by POST-PROCESS,
5723 or FILE."
5741 backend subtreep visible-only body-only ext-plist)))
5748 ;; Get proper return value.
5750 file))))))
5753 "Return output file's name according to buffer specifications.
5755 EXTENSION is a string representing the output file extension,
5756 with the leading dot.
5758 With a non-nil optional argument SUBTREEP, try to determine
5760 of subtree at point.
5762 When optional argument PUB-DIR is set, use it as the publishing
5763 directory.
5765 When optional argument VISIBLE-ONLY is non-nil, don't export
5766 contents of hidden elements.
5768 Return file name as a string."
5771 ;; File name may come from EXPORT_FILE_NAME subtree
5772 ;; property, assuming point is at beginning of said
5773 ;; sub-tree.
5780 ;; File name may be extracted from buffer's associated
5781 ;; file, if any.
5783 ;; Can't determine file name on our own: Ask user.
5787 "Output file: " pub-dir nil nil nil
5791 ;; Build file name. Enforce EXTENSION over whatever user
5792 ;; may have come up with. PUB-DIR, if defined, always has
5793 ;; precedence over any provided path.
5798 extension))
5801 ;; If writing to OUTPUT-FILE would overwrite original file, append
5802 ;; EXTENSION another time to final name.
5805 output-file)))
5808 "Add a new result to export stack if not present already.
5810 SOURCE is a buffer or a file name containing export results.
5811 BACKEND is a symbol representing export back-end used to generate
5812 it.
5814 Entries already pointing to SOURCE and unavailable entries are
5815 removed beforehand. Return the new stack."
5821 "Menu for asynchronous export results and running processes."
5831 "Return source from export results at point in stack."
5838 source
5839 ;; SOURCE is not consistent with current line. The stack
5840 ;; view is outdated.
5844 "Remove all entries from export stack."
5849 "Refresh the asynchronous export stack.
5850 DUMMY is ignored. Unavailable sources are removed from the list.
5851 Return the new stack."
5861 ;; Back-end.
5863 ;; Age.
5866 ;; Compute age of the results.
5868 "%4h:%.2m "
5870 ;; Source.
5875 ;; Clear stack from exited processes, dead buffers or
5876 ;; non-existent files.
5888 "Remove export results at point from stack.
5889 If optional argument SOURCE is non-nil, remove it instead."
5894 org-export-stack-contents))))
5897 "View export results at point in stack.
5898 With an optional prefix argument IN-EMACS, force viewing files
5899 within Emacs."
5913 (define-key km "p" 'previous-line)
5914 (define-key km "\C-p" 'previous-line)
5915 (define-key km "\C-?" 'previous-line)
5916 (define-key km [up] 'previous-line)
5917 (define-key km "C" 'org-export-stack-clear)
5918 (define-key km "v" 'org-export-stack-view)
5919 (define-key km (kbd "RET") 'org-export-stack-view)
5920 (define-key km "d" 'org-export-stack-remove)
5921 km)
5922 "Keymap for Org Export Stack.")
5924 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5925 "Mode for displaying asynchronous export stack.
5928 stack.
5930 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5931 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5932 stack completely.
5934 Removing entries in an Org Export Stack buffer doesn't affect
5935 files or buffers, only the display.
5938 (abbrev-mode 0)
5939 (auto-fill-mode 0)
5940 (setq buffer-read-only t
5941 buffer-undo-list t
5942 truncate-lines t
5943 header-line-format
5944 '(:eval
5945 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5946 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5947 (set (make-local-variable 'revert-buffer-function)
5948 'org-export-stack-refresh))
5951 \f
5952 ;;; The Dispatcher
5953 ;;
5954 ;; `org-export-dispatch' is the standard interactive way to start an
5955 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5956 ;; for its interface, which, in turn, delegates response to key
5957 ;; pressed to `org-export--dispatch-action'.
5959 ;;;###autoload
5960 (defun org-export-dispatch (&optional arg)
5961 "Export dispatcher for Org mode.
5963 It provides an access to common export related tasks in a buffer.
5964 Its interface comes in two flavours: standard and expert.
5966 While both share the same set of bindings, only the former
5967 displays the valid keys associations in a dedicated buffer.
5968 Scrolling (resp. line-wise motion) in this buffer is done with
5969 SPC and DEL (resp. C-n and C-p) keys.
5971 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5972 flavour or the other.
5975 of options used back then, on the current buffer.
5977 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5978 (interactive "P")
5979 (let* ((input
5980 (cond ((equal arg '(16)) '(stack))
5981 ((and arg org-export-dispatch-last-action))
5982 (t (save-window-excursion
5983 (unwind-protect
5984 (progn
5985 ;; Remember where we are
5986 (move-marker org-export-dispatch-last-position
5987 (point)
5988 (org-base-buffer (current-buffer)))
5989 ;; Get and store an export command
5990 (setq org-export-dispatch-last-action
5991 (org-export--dispatch-ui
5992 (list org-export-initial-scope
5993 (and org-export-in-background 'async))
5994 nil
5995 org-export-dispatch-use-expert-ui)))
5996 (and (get-buffer "*Org Export Dispatcher*")
5997 (kill-buffer "*Org Export Dispatcher*")))))))
5998 (action (car input))
5999 (optns (cdr input)))
6000 (unless (memq 'subtree optns)
6001 (move-marker org-export-dispatch-last-position nil))
6002 (case action
6003 ;; First handle special hard-coded actions.
6004 (template (org-export-insert-default-template nil optns))
6005 (stack (org-export-stack))
6006 (publish-current-file
6007 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6008 (publish-current-project
6009 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6010 (publish-choose-project
6011 (org-publish (assoc (org-icompleting-read
6012 "Publish project: "
6013 org-publish-project-alist nil t)
6014 org-publish-project-alist)
6015 (memq 'force optns)
6016 (memq 'async optns)))
6017 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6018 (otherwise
6019 (save-excursion
6020 (when arg
6021 ;; Repeating command, maybe move cursor to restore subtree
6022 ;; context.
6023 (if (eq (marker-buffer org-export-dispatch-last-position)
6024 (org-base-buffer (current-buffer)))
6025 (goto-char org-export-dispatch-last-position)
6026 ;; We are in a different buffer, forget position.
6027 (move-marker org-export-dispatch-last-position nil)))
6028 (funcall action
6029 ;; Return a symbol instead of a list to ease
6030 ;; asynchronous export macro use.
6031 (and (memq 'async optns) t)
6032 (and (memq 'subtree optns) t)
6033 (and (memq 'visible optns) t)
6034 (and (memq 'body optns) t)))))))
6036 (defun org-export--dispatch-ui (options first-key expertp)
6037 "Handle interface for `org-export-dispatch'.
6039 OPTIONS is a list containing current interactive options set for
6040 export. It can contain any of the following symbols:
6041 `body' toggles a body-only export
6042 `subtree' restricts export to current subtree
6043 `visible' restricts export to visible part of buffer.
6044 `force' force publishing files.
6045 `async' use asynchronous export process
6047 FIRST-KEY is the key pressed to select the first level menu. It
6048 is nil when this menu hasn't been selected yet.
6050 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6051 buffer is provided, but indications about currently active
6052 options are given in the prompt. Moreover, \[?] allows to switch
6053 back to standard interface."
6054 (let* ((fontify-key
6055 (lambda (key &optional access-key)
6056 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6057 ;; non-nil is the required first-level key to activate
6058 ;; KEY. When its value is t, activate KEY independently
6059 ;; on the first key, if any. A nil value means KEY will
6060 ;; only be activated at first level.
6061 (if (or (eq access-key t) (eq access-key first-key))
6062 (org-propertize key 'face 'org-warning)
6063 key)))
6064 (fontify-value
6065 (lambda (value)
6066 ;; Fontify VALUE string.
6067 (org-propertize value 'face 'font-lock-variable-name-face)))
6068 ;; Prepare menu entries by extracting them from registered
6069 ;; back-ends and sorting them by access key and by ordinal,
6070 ;; if any.
6071 (entries
6072 (sort (sort (delq nil
6073 (mapcar 'org-export-backend-menu
6074 org-export--registered-backends))
6075 (lambda (a b)
6076 (let ((key-a (nth 1 a))
6077 (key-b (nth 1 b)))
6078 (cond ((and (numberp key-a) (numberp key-b))
6079 (< key-a key-b))
6080 ((numberp key-b) t)))))
6081 'car-less-than-car))
6082 ;; Compute a list of allowed keys based on the first key
6083 ;; pressed, if any. Some keys
6084 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6085 ;; available.
6086 (allowed-keys
6087 (nconc (list 2 22 19 6 1)
6088 (if (not first-key) (org-uniquify (mapcar 'car entries))
6089 (let (sub-menu)
6090 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6091 (when (eq (car entry) first-key)
6092 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6093 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6094 ((not first-key) (list ?P)))
6095 (list ?& ?#)
6096 (when expertp (list ??))
6097 (list ?q)))
6098 ;; Build the help menu for standard UI.
6099 (help
6100 (unless expertp
6101 (concat
6102 ;; Options are hard-coded.
6103 (format "[%s] Body only: %s [%s] Visible only: %s
6104 \[%s] Export scope: %s [%s] Force publishing: %s
6106 (funcall fontify-key "C-b" t)
6107 (funcall fontify-value
6108 (if (memq 'body options) "On " "Off"))
6109 (funcall fontify-key "C-v" t)
6110 (funcall fontify-value
6111 (if (memq 'visible options) "On " "Off"))
6112 (funcall fontify-key "C-s" t)
6113 (funcall fontify-value
6114 (if (memq 'subtree options) "Subtree" "Buffer "))
6115 (funcall fontify-key "C-f" t)
6116 (funcall fontify-value
6117 (if (memq 'force options) "On " "Off"))
6118 (funcall fontify-key "C-a" t)
6119 (funcall fontify-value
6120 (if (memq 'async options) "On " "Off")))
6121 ;; Display registered back-end entries. When a key
6122 ;; appears for the second time, do not create another
6123 ;; entry, but append its sub-menu to existing menu.
6124 (let (last-key)
6125 (mapconcat
6126 (lambda (entry)
6127 (let ((top-key (car entry)))
6128 (concat
6129 (unless (eq top-key last-key)
6130 (setq last-key top-key)
6132 (funcall fontify-key (char-to-string top-key))
6133 (nth 1 entry)))
6134 (let ((sub-menu (nth 2 entry)))
6135 (unless (functionp sub-menu)
6136 ;; Split sub-menu into two columns.
6137 (let ((index -1))
6138 (concat
6139 (mapconcat
6140 (lambda (sub-entry)
6141 (incf index)
6142 (format
6143 (if (zerop (mod index 2)) " [%s] %-26s"
6145 (funcall fontify-key
6146 (char-to-string (car sub-entry))
6147 top-key)
6148 (nth 1 sub-entry)))
6149 sub-menu "")
6151 entries ""))
6152 ;; Publishing menu is hard-coded.
6154 [%s] Current file [%s] Current project
6156 (funcall fontify-key "P")
6157 (funcall fontify-key "f" ?P)
6158 (funcall fontify-key "p" ?P)
6159 (funcall fontify-key "x" ?P)
6160 (funcall fontify-key "a" ?P))
6162 (funcall fontify-key "&" t)
6163 (funcall fontify-key "#" t))
6164 (format "[%s] %s"
6165 (funcall fontify-key "q" t)
6166 (if first-key "Main menu" "Exit")))))
6167 ;; Build prompts for both standard and expert UI.
6168 (standard-prompt (unless expertp "Export command: "))
6169 (expert-prompt
6170 (when expertp
6171 (format
6172 "Export command (C-%s%s%s%s%s) [%s]: "
6173 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6174 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6175 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6176 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6177 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6178 (mapconcat (lambda (k)
6179 ;; Strip control characters.
6180 (unless (< k 27) (char-to-string k)))
6181 allowed-keys "")))))
6182 ;; With expert UI, just read key with a fancy prompt. In standard
6183 ;; UI, display an intrusive help buffer.
6184 (if expertp
6185 (org-export--dispatch-action
6186 expert-prompt allowed-keys entries options first-key expertp)
6187 ;; At first call, create frame layout in order to display menu.
6188 (unless (get-buffer "*Org Export Dispatcher*")
6189 (delete-other-windows)
6190 (org-switch-to-buffer-other-window
6191 (get-buffer-create "*Org Export Dispatcher*"))
6192 (setq cursor-type nil
6193 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6194 ;; Make sure that invisible cursor will not highlight square
6195 ;; brackets.
6196 (set-syntax-table (copy-syntax-table))
6197 (modify-syntax-entry ?\[ "w"))
6198 ;; At this point, the buffer containing the menu exists and is
6199 ;; visible in the current window. So, refresh it.
6200 (with-current-buffer "*Org Export Dispatcher*"
6201 ;; Refresh help. Maintain display continuity by re-visiting
6202 ;; previous window position.
6203 (let ((pos (window-start)))
6204 (erase-buffer)
6205 (insert help)
6206 (set-window-start nil pos)))
6207 (org-fit-window-to-buffer)
6208 (org-export--dispatch-action
6209 standard-prompt allowed-keys entries options first-key expertp))))
6211 (defun org-export--dispatch-action
6212 (prompt allowed-keys entries options first-key expertp)
6213 "Read a character from command input and act accordingly.
6215 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6216 a list of characters available at a given step in the process.
6217 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6218 EXPERTP are the same as defined in `org-export--dispatch-ui',
6219 which see.
6221 Toggle export options when required. Otherwise, return value is
6222 a list with action as CAR and a list of interactive export
6223 options as CDR."
6224 (let (key)
6225 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6226 ;; C-p, SPC, DEL).
6227 (while (and (setq key (read-char-exclusive prompt))
6228 (not expertp)
6229 (memq key '(14 16 ?\s ?\d)))
6230 (case key
6231 (14 (if (not (pos-visible-in-window-p (point-max)))
6232 (ignore-errors (scroll-up 1))
6233 (message "End of buffer")
6234 (sit-for 1)))
6235 (16 (if (not (pos-visible-in-window-p (point-min)))
6236 (ignore-errors (scroll-down 1))
6237 (message "Beginning of buffer")
6238 (sit-for 1)))
6239 (?\s (if (not (pos-visible-in-window-p (point-max)))
6240 (scroll-up nil)
6241 (message "End of buffer")
6242 (sit-for 1)))
6243 (?\d (if (not (pos-visible-in-window-p (point-min)))
6244 (scroll-down nil)
6245 (message "Beginning of buffer")
6246 (sit-for 1)))))
6247 (cond
6248 ;; Ignore undefined associations.
6249 ((not (memq key allowed-keys))
6250 (ding)
6251 (unless expertp (message "Invalid key") (sit-for 1))
6252 (org-export--dispatch-ui options first-key expertp))
6253 ;; q key at first level aborts export. At second level, cancel
6254 ;; first key instead.
6255 ((eq key ?q) (if (not first-key) (error "Export aborted")
6256 (org-export--dispatch-ui options nil expertp)))
6257 ;; Help key: Switch back to standard interface if expert UI was
6258 ;; active.
6259 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6260 ;; Send request for template insertion along with export scope.
6261 ((eq key ?#) (cons 'template (memq 'subtree options)))
6262 ;; Switch to asynchronous export stack.
6263 ((eq key ?&) '(stack))
6264 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6265 ((memq key '(2 22 19 6 1))
6266 (org-export--dispatch-ui
6267 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6268 (6 'force) (1 'async))))
6269 (if (memq option options) (remq option options)
6270 (cons option options)))
6271 first-key expertp))
6272 ;; Action selected: Send key and options back to
6273 ;; `org-export-dispatch'.
6274 ((or first-key (functionp (nth 2 (assq key entries))))
6275 (cons (cond
6276 ((not first-key) (nth 2 (assq key entries)))
6277 ;; Publishing actions are hard-coded. Send a special
6278 ;; signal to `org-export-dispatch'.
6279 ((eq first-key ?P)
6280 (case key
6281 (?f 'publish-current-file)
6282 (?p 'publish-current-project)
6283 (?x 'publish-choose-project)
6284 (?a 'publish-all)))
6285 ;; Return first action associated to FIRST-KEY + KEY
6286 ;; path. Indeed, derived backends can share the same
6287 ;; FIRST-KEY.
6288 (t (catch 'found
6289 (mapc (lambda (entry)
6290 (let ((match (assq key (nth 2 entry))))
6291 (when match (throw 'found (nth 2 match)))))
6292 (member (assq first-key entries) entries)))))
6293 options))
6294 ;; Otherwise, enter sub-menu.
6295 (t (org-export--dispatch-ui options key expertp)))))
6299 (provide 'ox)
6301 ;; Local variables:
6302 ;; generated-autoload-file: "org-loaddefs.el"
6303 ;; End:
6305 ;;; ox.el ends here