| blob | ff9b9f744d826fe0aa64dd13952f7591ba5cf7f0 |
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:
94 "Return BLOB parent or nil.
95 BLOB is the element or object considered."
98 \f
99 ;;; Internal Variables
100 ;;
101 ;; Among internal variables, the most important is
102 ;; `org-export-options-alist'. This variable define the global export
103 ;; options, shared between every exporter, and how they are acquired.
149 "Alist between export properties and ways to set them.
151 The CAR of the alist is the property name, and the CDR is a list
152 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
154 KEYWORD is a string representing a buffer keyword, or nil. Each
155 property defined this way can also be set, during subtree
156 export, through a headline property named after the keyword
158 property).
159 OPTION is a string that could be found in an #+OPTIONS: line.
160 DEFAULT is the default value for the property.
161 BEHAVIOUR determines how Org should handle multiple keywords for
162 the same property. It is a symbol among:
163 nil Keep old value and discard the new one.
164 t Replace old value with the new one.
165 `space' Concatenate the values, separating them with a space.
166 `newline' Concatenate the values, separating them with
167 a newline.
168 `split' Split values at white spaces, and cons them to the
169 previous list.
171 Values set through KEYWORD and OPTION have precedence over
172 DEFAULT.
174 All these properties should be back-end agnostic. Back-end
175 specific properties are set through `org-export-define-backend'.
179 "List of in-buffer keywords that require special treatment.
180 These keywords are not directly associated to a property. The
181 way they are handled must be hard-coded into
241 "Alist between filters properties and initial values.
243 The key of each association is a property name accessible through
244 the communication channel. Its value is a configurable global
245 variable defining initial filters.
247 This list is meant to install user specified filters. Back-end
248 developers may install their own filters using
249 `org-export-define-backend'. Filters defined there will always
250 be prepended to the current list, so they always get applied
259 "Default rule for link matching an inline image.
260 This rule applies to links with no description. By default, it
261 will be considered as an inline image if it targets a local file
264 See `org-export-inline-image-p' for more information about
268 "Non-nil means asynchronous export process should leave data behind.
272 located in `temporary-file-directory'.
274 When non-nil, it will also set `debug-on-error' to a non-nil
278 "Record asynchronously generated export results and processes.
279 This is an alist: its CAR is the source of the
280 result (destination file or buffer for a finished process,
281 original buffer for a running one) and its CDR is a list
282 containing the back-end used, as a symbol, and either a process
283 or the time at which it finished. It is used to build the menu
287 "List of backends currently available in the exporter.
288 This variable is set with `org-export-define-backend' and
292 "Last command called from the dispatcher.
293 The value should be a list. Its CAR is the action, as a symbol,
297 "The position where the last export command was created using the dispatcher.
298 This marker will be used with `C-u C-c C-e' to make sure export repetition
301 ;; For compatibility with Org < 8
303 "Name, if any, of the back-end used during an export process.
305 Its value is a symbol such as `html', `latex', `ascii', or nil if
306 the back-end is anonymous (see `org-export-create-backend') or if
307 there is no export process in progress.
309 It can be used to teach Babel blocks how to act differently
312 \f
313 ;;; User-configurable Variables
314 ;;
315 ;; Configuration for the masses.
316 ;;
317 ;; They should never be accessed directly, as their value is to be
318 ;; stored in a property list (cf. `org-export-options-alist').
319 ;; Back-ends will read their value from there instead.
322 "Options for exporting Org mode files."
327 "General options for export engine."
332 "Whether sub-trees with the ARCHIVE tag should be exported.
334 This can have three different values:
335 nil Do not export, pretend this tree is not present.
336 t Do export the entire tree.
337 `headline' Only export the headline, but skip the tree below it.
339 This option can also be set with the OPTIONS keyword,
348 "Non-nil means insert author name into the exported file.
349 This option can also be set with the OPTIONS keyword,
355 "Non-nil means export CLOCK keywords.
356 This option can also be set with the OPTIONS keyword,
362 "Non-nil means the postamble should contain a creator sentence.
364 The sentence can be set in `org-export-creator-string' and
367 If the value is `comment' insert it as a comment."
375 "Non-nil means insert date in the exported document.
376 This option can also be set with the OPTIONS keyword,
382 "Time-stamp format string to use for DATE keyword.
384 The format string, when specified, only applies if date consists
385 in a single time-stamp. Otherwise its value will be ignored.
387 See `format-time-string' for details on how to build this
388 string."
396 emacs-version
398 "Information about the creator of the document.
399 This option can also be set on with the CREATOR keyword."
404 "Non-nil means export contents of standard drawers.
406 When t, all drawers are exported. This may also be a list of
407 drawer names to export, as strings. If that list starts with
408 `not', only drawers with such names will be ignored.
410 This variable doesn't apply to properties drawers. See
411 `org-export-with-properties' instead.
413 This option can also be set with the OPTIONS keyword,
426 :inline t
430 "Non-nil means insert author email into the exported file.
431 This option can also be set with the OPTIONS keyword,
437 "Non-nil means interpret *word*, /word/, _word_ and +word+.
439 If the export target supports emphasizing text, the word will be
440 typeset in bold, italic, with an underline or strike-through,
441 respectively.
443 This option can also be set with the OPTIONS keyword,
449 "Tags that exclude a tree from export.
451 All trees carrying any of these tags will be excluded from
452 export. This is without condition, so even subtrees inside that
453 carry one of the `org-export-select-tags' will be removed.
455 This option can also be set with the EXCLUDE_TAGS keyword."
462 This can be used to have pre-formatted text, fragments of code
463 etc. For example:
464 : ;; Some Lisp examples
465 : (while (defc cnt)
466 : (ding))
467 will be looking just like this in also HTML. See also the QUOTE
468 keyword. Not all export backends support this.
470 This option can also be set with the OPTIONS keyword,
476 "Non-nil means Org footnotes should be exported.
477 This option can also be set with the OPTIONS keyword,
483 "Non-nil means process LaTeX environments and fragments.
485 This option can also be set with the OPTIONS line,
488 nil Ignore math snippets.
489 `verbatim' Keep everything in verbatim.
490 t Allow export of math snippets."
500 "The last level which is still exported as a headline.
502 Inferior levels will usually produce itemize or enumerate lists
503 when exported, but back-end behaviour may differ.
505 This option can also be set with the OPTIONS keyword,
511 "The default language for export and clocktable translations, as a string.
512 This may have an association in
513 `org-clock-clocktable-language-setup',
514 `org-export-smart-quotes-alist' and `org-export-dictionary'.
515 This option can also be set with the LANGUAGE keyword."
520 "Non-nil means preserve all line breaks when exporting.
521 This option can also be set with the OPTIONS keyword,
527 "Non-nil means interpret entities when exporting.
530 Å.
532 For a list of supported names, see the constant `org-entities'
533 and the user option `org-entities-user'.
535 This option can also be set with the OPTIONS keyword,
541 "Non-nil means inlinetasks should be exported.
542 This option can also be set with the OPTIONS keyword,
550 "Non-nil means include planning info in export.
552 Planning info is the line containing either SCHEDULED:,
553 DEADLINE:, CLOSED: time-stamps, or a combination of them.
555 This option can also be set with the OPTIONS keyword,
563 "Non-nil means include priority cookies in export.
564 This option can also be set with the OPTIONS keyword,
570 "Non-nil means export contents of properties drawers.
572 When t, all properties are exported. This may also be a list of
573 properties to export, as strings.
575 This option can also be set with the OPTIONS keyword,
587 "Non-nil means add section numbers to headlines when exporting.
589 When set to an integer n, numbering will only happen for
590 headlines whose relative level is higher or equal to n.
592 This option can also be set with the OPTIONS keyword,
598 "Tags that select a tree for export.
600 If any such tag is found in a buffer, all trees that do not carry
601 one of these tags will be ignored during export. Inside trees
602 that are selected like this, you can still deselect a subtree by
603 tagging it with one of the `org-export-exclude-tags'.
605 This option can also be set with the SELECT_TAGS keyword."
610 "Non-nil means activate smart quotes during export.
611 This option can also be set with the OPTIONS keyword,
614 When setting this to non-nil, you need to take care of
615 using the correct Babel package when exporting to LaTeX.
616 E.g., you can load Babel for french like this:
627 When this option is turned on, these strings will be exported as:
629 Org HTML LaTeX UTF-8
630 -----+----------+--------+-------
632 -- – -- –
633 --- — --- —
636 This option can also be set with the OPTIONS keyword,
642 "Non-nil means include statistics cookies in export.
643 This option can also be set with the OPTIONS keyword,
653 If you want to control how Org displays those characters, see
654 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
655 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
656 it is not anymore.
658 When this option is turned on, you can use TeX-like syntax for
659 sub- and superscripts and see them exported correctly.
661 You can also set the option with #+OPTIONS: ^:t
664 single item - so grouping with {} is normally not needed. For
665 example, the following things will be parsed as single sub- or
666 superscripts:
668 10^24 or 10^tau several digits will be considered 1 item.
669 10^-12 or 10^-tau a leading sign with digits or a word
670 x^2-y^3 will be read as x^2 - y^3, because items are
671 terminated by almost any nonword/nondigit char.
672 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
674 Still, ambiguity is possible. So when in doubt, use {} to enclose
675 the sub/superscript. If you set this variable to the symbol `{}',
676 the braces are *required* in order to trigger interpretations as
678 frequently in plain text."
688 "Non-nil means create a table of contents in exported files.
690 The TOC contains headlines with levels up
691 to`org-export-headline-levels'. When an integer, include levels
692 up to N in the toc, this may then be different from
693 `org-export-headline-levels', but it will not be allowed to be
694 larger than the number of headline levels. When nil, no table of
695 contents is made.
697 This option can also be set with the OPTIONS keyword,
707 For example:
709 | Name | Address | Birthday |
710 |-------------+----------+-----------|
711 | Arthur Dent | England | 29.2.2100 |
713 This option can also be set with the OPTIONS keyword,
719 "If nil, do not export tags, just remove them from headlines.
721 If this is the symbol `not-in-toc', tags will be removed from
722 table of contents entries, but still be shown in the headlines of
723 the document.
725 This option can also be set with the OPTIONS keyword,
734 "Non-nil means include TODO items for export.
736 This may have the following values:
737 t include tasks independent of state.
738 `todo' include only tasks that are not yet done.
739 `done' include only tasks that are already done.
740 nil ignore all tasks.
741 list of keywords include tasks with these keywords.
743 This option can also be set with the OPTIONS keyword,
755 "Non-nil means insert a time stamp into the exported file.
756 The time stamp shows when the file was created. This option can
762 "Non nil means allow timestamps in export.
764 It can be set to any of the following values:
765 t export all timestamps.
766 `active' export active timestamps only.
767 `inactive' export inactive timestamps only.
768 nil do not export timestamps
770 This only applies to timestamps isolated in a paragraph
771 containing only timestamps. Other timestamps are always
772 exported.
774 This option can also be set with the OPTIONS keyword, e.g.
784 "Non-nil means include TODO keywords in export.
785 When nil, remove all these keywords from the export. This option
791 "Non-nil means BIND keywords can define local variable values.
792 This is a potential security risk, which is why the default value
793 is nil. You can also allow them through local buffer variables."
800 "Alist between export snippets back-ends and exporter back-ends.
802 This variable allows to provide shortcuts for export snippets.
806 HTML code while every other back-end will ignore it."
815 "Coding system for the exported file."
822 "Should we push exported content to the kill ring?"
831 "The initial scope when exporting with `org-export-dispatch'.
832 This variable can be either set to `buffer' or `subtree'."
839 "Non-nil means show buffer after exporting to temp buffer.
840 When Org exports to a file, the buffer visiting that file is ever
841 shown, but remains buried. However, when exporting to
842 a temporary buffer, that buffer is popped up in a second window.
843 When this variable is nil, the buffer remains buried also in
844 these cases."
849 "Non-nil means export and publishing commands will run in background.
850 Results from an asynchronous export are never displayed
858 "File used to initialize external export process.
860 Value must be either nil or an absolute file name. When nil, the
861 external process is launched like a regular Emacs session,
862 loading user's initialization file and any site specific
863 configuration. If a file is provided, it, and only it, is loaded
864 at start-up.
866 Therefore, using a specific configuration makes the process to
867 load faster and the export more portable."
876 "Non-nil means using a non-intrusive `org-export-dispatch'.
877 In that case, no help buffer is displayed. Though, an indicator
883 asynchronous). Also, \[?] allows to switch back to standard
884 mode."
891 \f
892 ;;; Defining Back-ends
893 ;;
894 ;; An export back-end is a structure with `org-export-backend' type
895 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
896 ;; and `menu' slots.
897 ;;
898 ;; At the lowest level, a back-end is created with
899 ;; `org-export-create-backend' function.
900 ;;
901 ;; A named back-end can be registered with
902 ;; `org-export-register-backend' function. A registered back-end can
903 ;; later be referred to by its name, with `org-export-get-backend'
904 ;; function. Also, such a back-end can become the parent of a derived
905 ;; back-end from which slot values will be inherited by default.
906 ;; `org-export-derived-backend-p' can check if a given back-end is
907 ;; derived from a list of back-end names.
908 ;;
909 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
910 ;; `org-export-get-all-filters' return the full alist of transcoders,
911 ;; options and filters, including those inherited from ancestors.
912 ;;
913 ;; At a higher level, `org-export-define-backend' is the standard way
914 ;; to define an export back-end. If the new back-end is similar to
915 ;; a registered back-end, `org-export-define-derived-backend' may be
916 ;; used instead.
917 ;;
918 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
919 ;; when a given back-end hasn't been registered yet.
923 name parent transcoders options filters blocks menu)
926 "Return export back-end named after NAME.
927 NAME is a symbol. Return nil if no such back-end is found."
934 "Register BACKEND as a known export back-end.
935 BACKEND is a structure with `org-export-backend' type."
936 ;; Refuse to register an unnamed back-end.
939 ;; Refuse to register a back-end with an unknown parent.
943 ;; Register dedicated export blocks in the parser.
947 ;; If a back-end with the same name as BACKEND is already
948 ;; registered, replace it with BACKEND. Otherwise, simply add
949 ;; BACKEND to the list of registered back-ends.
955 "Signal an error if BACKEND isn't defined."
960 "Non-nil if BACKEND is derived from one of BACKENDS.
961 BACKEND is an export back-end, as returned by, e.g.,
962 `org-export-create-backend', or a symbol referring to
963 a registered back-end. BACKENDS is constituted of symbols."
975 "Return full translation table for BACKEND.
977 BACKEND is an export back-end, as return by, e.g,,
978 `org-export-create-backend'. Return value is an alist where
979 keys are element or object types, as symbols, and values are
980 transcoders.
982 Unlike to `org-export-backend-transcoders', this function
983 also returns transcoders inherited from parent back-ends,
984 if any."
988 parent)
993 transcoders)))
996 "Return export options for BACKEND.
998 BACKEND is an export back-end, as return by, e.g,,
999 `org-export-create-backend'. See `org-export-options-alist'
1000 for the shape of the return value.
1002 Unlike to `org-export-backend-options', this function also
1003 returns options inherited from parent back-ends, if any."
1007 parent)
1011 options)))
1014 "Return complete list of filters for BACKEND.
1016 BACKEND is an export back-end, as return by, e.g,,
1017 `org-export-create-backend'. Return value is an alist where
1018 keys are symbols and values lists of functions.
1020 Unlike to `org-export-backend-filters', this function also
1021 returns filters inherited from parent back-ends, if any."
1025 parent)
1029 filters)))
1032 "Define a new back-end BACKEND.
1034 TRANSCODERS is an alist between object or element types and
1035 functions handling them.
1037 These functions should return a string without any trailing
1038 space, or nil. They must accept three arguments: the object or
1039 element itself, its contents or nil when it isn't recursive and
1040 the property list used as a communication channel.
1042 Contents, when not nil, are stripped from any global indentation
1043 \(although the relative one is preserved). They also always end
1044 with a single newline character.
1046 If, for a given type, no function is found, that element or
1047 object type will simply be ignored, along with any blank line or
1048 white space at its end. The same will happen if the function
1049 returns the nil value. If that function returns the empty
1050 string, the type will be ignored, but the blank lines or white
1051 spaces will be kept.
1053 In addition to element and object types, one function can be
1054 associated to the `template' (or `inner-template') symbol and
1055 another one to the `plain-text' symbol.
1057 The former returns the final transcoded string, and can be used
1058 to add a preamble and a postamble to document's body. It must
1059 accept two arguments: the transcoded string and the property list
1060 containing export options. A function associated to `template'
1062 A function associated to `inner-template' is always applied.
1064 The latter, when defined, is to be called on every text not
1065 recognized as an element or an object. It must accept two
1066 arguments: the text string and the information channel. It is an
1067 appropriate place to protect special chars relative to the
1068 back-end.
1070 BODY can start with pre-defined keyword arguments. The following
1071 keywords are understood:
1073 :export-block
1075 String, or list of strings, representing block names that
1076 will not be parsed. This is used to specify blocks that will
1077 contain raw code specific to the back-end. These blocks
1078 still have to be handled by the relative `export-block' type
1079 translator.
1081 :filters-alist
1083 Alist between filters and function, or list of functions,
1084 specific to the back-end. See `org-export-filters-alist' for
1085 a list of all allowed filters. Filters defined here
1086 shouldn't make a back-end test, as it may prevent back-ends
1087 derived from this one to behave properly.
1089 :menu-entry
1091 Menu entry for the export dispatcher. It should be a list
1092 like:
1094 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1096 where :
1098 KEY is a free character selecting the back-end.
1100 DESCRIPTION-OR-ORDINAL is either a string or a number.
1102 If it is a string, is will be used to name the back-end in
1103 its menu entry. If it is a number, the following menu will
1104 be displayed as a sub-menu of the back-end with the same
1105 KEY. Also, the number will be used to determine in which
1106 order such sub-menus will appear (lowest first).
1108 ACTION-OR-MENU is either a function or an alist.
1110 If it is an action, it will be called with four
1111 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1112 BODY-ONLY. See `org-export-as' for further explanations on
1113 some of them.
1115 If it is an alist, associations should follow the
1116 pattern:
1118 '(KEY DESCRIPTION ACTION)
1120 where KEY, DESCRIPTION and ACTION are described above.
1122 Valid values include:
1126 or
1131 \(lambda (a s v b)
1132 \(if a (org-latex-export-to-pdf t s v b)
1133 \(org-open-file
1134 \(org-latex-export-to-pdf nil s v b)))))))
1136 or the following, which will be added to the previous
1137 sub-menu,
1139 '(?l 1
1143 :options-alist
1145 Alist between back-end specific properties introduced in
1146 communication channel and how their value are acquired. See
1147 `org-export-options-alist' for more information about
1148 structure of the values."
1162 :transcoders transcoders
1163 :options options
1164 :filters filters
1165 :blocks blocks
1169 "Create a new back-end as a variant of an existing one.
1171 CHILD is the name of the derived back-end. PARENT is the name of
1172 the parent back-end.
1174 BODY can start with pre-defined keyword arguments. The following
1175 keywords are understood:
1177 :export-block
1179 String, or list of strings, representing block names that
1180 will not be parsed. This is used to specify blocks that will
1181 contain raw code specific to the back-end. These blocks
1182 still have to be handled by the relative `export-block' type
1183 translator.
1185 :filters-alist
1187 Alist of filters that will overwrite or complete filters
1188 defined in PARENT back-end. See `org-export-filters-alist'
1189 for a list of allowed filters.
1191 :menu-entry
1193 Menu entry for the export dispatcher. See
1194 `org-export-define-backend' for more information about the
1195 expected value.
1197 :options-alist
1199 Alist of back-end specific properties that will overwrite or
1200 complete those defined in PARENT back-end. Refer to
1201 `org-export-options-alist' for more information about
1202 structure of the values.
1204 :translate-alist
1206 Alist of element and object types and transcoders that will
1207 overwrite or complete transcode table from PARENT back-end.
1208 Refer to `org-export-define-backend' for detailed information
1209 about transcoders.
1212 as a variant of `latex' back-end with a custom template function:
1214 \(org-export-define-derived-backend 'my-latex 'latex
1215 :translate-alist '((template . my-latex-template-fun)))
1217 The back-end could then be called with, for example:
1234 :parent parent
1235 :transcoders transcoders
1236 :options options
1237 :filters filters
1238 :blocks blocks
1242 \f
1243 ;;; The Communication Channel
1244 ;;
1245 ;; During export process, every function has access to a number of
1246 ;; properties. They are of two types:
1247 ;;
1248 ;; 1. Environment options are collected once at the very beginning of
1249 ;; the process, out of the original buffer and configuration.
1250 ;; Collecting them is handled by `org-export-get-environment'
1251 ;; function.
1252 ;;
1253 ;; Most environment options are defined through the
1254 ;; `org-export-options-alist' variable.
1255 ;;
1256 ;; 2. Tree properties are extracted directly from the parsed tree,
1257 ;; just before export, by `org-export-collect-tree-properties'.
1258 ;;
1259 ;; Here is the full list of properties available during transcode
1260 ;; process, with their category and their value type.
1261 ;;
1262 ;; + `:author' :: Author's name.
1263 ;; - category :: option
1264 ;; - type :: string
1265 ;;
1266 ;; + `:back-end' :: Current back-end used for transcoding.
1267 ;; - category :: tree
1268 ;; - type :: structure
1269 ;;
1270 ;; + `:creator' :: String to write as creation information.
1271 ;; - category :: option
1272 ;; - type :: string
1273 ;;
1274 ;; + `:date' :: String to use as date.
1275 ;; - category :: option
1276 ;; - type :: string
1277 ;;
1278 ;; + `:description' :: Description text for the current data.
1279 ;; - category :: option
1280 ;; - type :: string
1281 ;;
1282 ;; + `:email' :: Author's email.
1283 ;; - category :: option
1284 ;; - type :: string
1285 ;;
1286 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1287 ;; process.
1288 ;; - category :: option
1289 ;; - type :: list of strings
1290 ;;
1291 ;; + `:export-options' :: List of export options available for current
1292 ;; process.
1293 ;; - category :: none
1294 ;; - type :: list of symbols, among `subtree', `body-only' and
1295 ;; `visible-only'.
1296 ;;
1297 ;; + `:exported-data' :: Hash table used for memoizing
1298 ;; `org-export-data'.
1299 ;; - category :: tree
1300 ;; - type :: hash table
1301 ;;
1302 ;; + `:filetags' :: List of global tags for buffer. Used by
1303 ;; `org-export-get-tags' to get tags with inheritance.
1304 ;; - category :: option
1305 ;; - type :: list of strings
1306 ;;
1307 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1308 ;; their definition, as parsed data. Only non-inlined footnotes
1309 ;; are represented in this alist. Also, every definition isn't
1310 ;; guaranteed to be referenced in the parse tree. The purpose of
1311 ;; this property is to preserve definitions from oblivion
1312 ;; (i.e. when the parse tree comes from a part of the original
1313 ;; buffer), it isn't meant for direct use in a back-end. To
1314 ;; retrieve a definition relative to a reference, use
1315 ;; `org-export-get-footnote-definition' instead.
1316 ;; - category :: option
1317 ;; - type :: alist (STRING . LIST)
1318 ;;
1319 ;; + `:headline-levels' :: Maximum level being exported as an
1320 ;; headline. Comparison is done with the relative level of
1321 ;; headlines in the parse tree, not necessarily with their
1322 ;; actual level.
1323 ;; - category :: option
1324 ;; - type :: integer
1325 ;;
1326 ;; + `:headline-offset' :: Difference between relative and real level
1327 ;; of headlines in the parse tree. For example, a value of -1
1328 ;; means a level 2 headline should be considered as level
1329 ;; 1 (cf. `org-export-get-relative-level').
1330 ;; - category :: tree
1331 ;; - type :: integer
1332 ;;
1333 ;; + `:headline-numbering' :: Alist between headlines and their
1334 ;; numbering, as a list of numbers
1335 ;; (cf. `org-export-get-headline-number').
1336 ;; - category :: tree
1337 ;; - type :: alist (INTEGER . LIST)
1338 ;;
1339 ;; + `:id-alist' :: Alist between ID strings and destination file's
1340 ;; path, relative to current directory. It is used by
1341 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1342 ;; external file.
1343 ;; - category :: option
1344 ;; - type :: alist (STRING . STRING)
1345 ;;
1346 ;; + `:ignore-list' :: List of elements and objects that should be
1347 ;; ignored during export.
1348 ;; - category :: tree
1349 ;; - type :: list of elements and objects
1350 ;;
1351 ;; + `:input-buffer' :: Original buffer name.
1352 ;; - category :: option
1353 ;; - type :: string
1354 ;;
1355 ;; + `:input-file' :: Full path to input file, if any.
1356 ;; - category :: option
1357 ;; - type :: string or nil
1358 ;;
1359 ;; + `:keywords' :: List of keywords attached to data.
1360 ;; - category :: option
1361 ;; - type :: string
1362 ;;
1363 ;; + `:language' :: Default language used for translations.
1364 ;; - category :: option
1365 ;; - type :: string
1366 ;;
1367 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1368 ;; transcoding.
1369 ;; - category :: option
1370 ;; - type :: list (as returned by `org-element-parse-buffer')
1371 ;;
1372 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1373 ;; all line breaks.
1374 ;; - category :: option
1375 ;; - type :: symbol (nil, t)
1376 ;;
1377 ;; + `:section-numbers' :: Non-nil means transcoding should add
1378 ;; section numbers to headlines.
1379 ;; - category :: option
1380 ;; - type :: symbol (nil, t)
1381 ;;
1382 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1383 ;; in transcoding. When such a tag is present, subtrees without
1384 ;; it are de facto excluded from the process. See
1385 ;; `use-select-tags'.
1386 ;; - category :: option
1387 ;; - type :: list of strings
1388 ;;
1389 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1390 ;; a time stamp in the output.
1391 ;; - category :: option
1392 ;; - type :: symbol (nil, t)
1393 ;;
1394 ;; + `:translate-alist' :: Alist between element and object types and
1395 ;; transcoding functions relative to the current back-end.
1396 ;; Special keys `inner-template', `template' and `plain-text' are
1397 ;; also possible.
1398 ;; - category :: option
1399 ;; - type :: alist (SYMBOL . FUNCTION)
1400 ;;
1401 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1402 ;; also be transcoded. If it is set to the `headline' symbol,
1403 ;; only the archived headline's name is retained.
1404 ;; - category :: option
1405 ;; - type :: symbol (nil, t, `headline')
1406 ;;
1407 ;; + `:with-author' :: Non-nil means author's name should be included
1408 ;; in the output.
1409 ;; - category :: option
1410 ;; - type :: symbol (nil, t)
1411 ;;
1412 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1413 ;; - category :: option
1414 ;; - type :: symbol (nil, t)
1415 ;;
1416 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1417 ;; inserted at the end of the transcoded string. If the value
1418 ;; is `comment', it should be commented.
1419 ;; - category :: option
1420 ;; - type :: symbol (`comment', nil, t)
1421 ;;
1422 ;; + `:with-date' :: Non-nil means output should contain a date.
1423 ;; - category :: option
1424 ;; - type :. symbol (nil, t)
1425 ;;
1426 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1427 ;; its value is a list of names, only drawers with such names
1428 ;; will be transcoded. If that list starts with `not', drawer
1429 ;; with these names will be skipped.
1430 ;; - category :: option
1431 ;; - type :: symbol (nil, t) or list of strings
1432 ;;
1433 ;; + `:with-email' :: Non-nil means output should contain author's
1434 ;; email.
1435 ;; - category :: option
1436 ;; - type :: symbol (nil, t)
1437 ;;
1438 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1439 ;; interpreted.
1440 ;; - category :: option
1441 ;; - type :: symbol (nil, t)
1442 ;;
1443 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1444 ;; strings starting with a colon as a fixed-with (verbatim) area.
1445 ;; - category :: option
1446 ;; - type :: symbol (nil, t)
1447 ;;
1448 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1449 ;; footnotes.
1450 ;; - category :: option
1451 ;; - type :: symbol (nil, t)
1452 ;;
1453 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1454 ;; `latex-fragment' objects should appear in export output. When
1455 ;; this property is set to `verbatim', they will be left as-is.
1456 ;; - category :: option
1457 ;; - type :: symbol (`verbatim', nil, t)
1458 ;;
1459 ;; + `:with-planning' :: Non-nil means transcoding should include
1460 ;; planning info.
1461 ;; - category :: option
1462 ;; - type :: symbol (nil, t)
1463 ;;
1464 ;; + `:with-priority' :: Non-nil means transcoding should include
1465 ;; priority cookies.
1466 ;; - category :: option
1467 ;; - type :: symbol (nil, t)
1468 ;;
1469 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1470 ;; plain text.
1471 ;; - category :: option
1472 ;; - type :: symbol (nil, t)
1473 ;;
1474 ;; + `:with-special-strings' :: Non-nil means transcoding should
1475 ;; interpret special strings in plain text.
1476 ;; - category :: option
1477 ;; - type :: symbol (nil, t)
1478 ;;
1479 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1480 ;; interpret subscript and superscript. With a value of "{}",
1481 ;; only interpret those using curly brackets.
1482 ;; - category :: option
1483 ;; - type :: symbol (nil, {}, t)
1484 ;;
1485 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1486 ;; tables.
1487 ;; - category :: option
1488 ;; - type :: symbol (nil, t)
1489 ;;
1490 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1491 ;; headlines. A `not-in-toc' value will remove them from the
1492 ;; table of contents, if any, nonetheless.
1493 ;; - category :: option
1494 ;; - type :: symbol (nil, t, `not-in-toc')
1495 ;;
1496 ;; + `:with-tasks' :: Non-nil means transcoding should include
1497 ;; headlines with a TODO keyword. A `todo' value will only
1498 ;; include headlines with a todo type keyword while a `done'
1499 ;; value will do the contrary. If a list of strings is provided,
1500 ;; only tasks with keywords belonging to that list will be kept.
1501 ;; - category :: option
1502 ;; - type :: symbol (t, todo, done, nil) or list of strings
1503 ;;
1504 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1505 ;; time stamps. Special value `active' (resp. `inactive') ask to
1506 ;; export only active (resp. inactive) timestamps. Otherwise,
1507 ;; completely remove them.
1508 ;; - category :: option
1509 ;; - type :: symbol: (`active', `inactive', t, nil)
1510 ;;
1511 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1512 ;; added to the output. An integer value limits its depth.
1513 ;; - category :: option
1514 ;; - type :: symbol (nil, t or integer)
1515 ;;
1516 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1517 ;; include TODO keywords.
1518 ;; - category :: option
1519 ;; - type :: symbol (nil, t)
1522 ;;;; Environment Options
1523 ;;
1524 ;; Environment options encompass all parameters defined outside the
1525 ;; scope of the parsed data. They come from five sources, in
1526 ;; increasing precedence order:
1527 ;;
1528 ;; - Global variables,
1529 ;; - Buffer's attributes,
1530 ;; - Options keyword symbols,
1531 ;; - Buffer keywords,
1532 ;; - Subtree properties.
1533 ;;
1534 ;; The central internal function with regards to environment options
1535 ;; is `org-export-get-environment'. It updates global variables with
1536 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1537 ;; the different sources.
1538 ;;
1539 ;; The internal functions doing the retrieval are:
1540 ;; `org-export--get-global-options',
1541 ;; `org-export--get-buffer-attributes',
1542 ;; `org-export--parse-option-keyword',
1543 ;; `org-export--get-subtree-options' and
1544 ;; `org-export--get-inbuffer-options'
1545 ;;
1546 ;; Also, `org-export--list-bound-variables' collects bound variables
1547 ;; along with their value in order to set them as buffer local
1548 ;; variables later in the process.
1551 "Collect export options from the current buffer.
1553 Optional argument BACKEND is an export back-end, as returned by
1554 `org-export-create-backend'.
1556 When optional argument SUBTREEP is non-nil, assume the export is
1557 done against the current sub-tree.
1559 Third optional argument EXT-PLIST is a property list with
1560 external parameters overriding Org default settings, but still
1561 inferior to file-local settings."
1562 ;; First install #+BIND variables since these must be set before
1563 ;; global options are read.
1566 ;; Get and prioritize export options...
1568 ;; ... from global variables...
1570 ;; ... from an external property list...
1571 ext-plist
1572 ;; ... from in-buffer settings...
1574 ;; ... and from subtree, when appropriate.
1576 ;; Eventually add misc. properties.
1578 :back-end
1579 backend
1581 :footnote-definition-alist
1582 ;; Footnotes definitions must be collected in the original
1583 ;; buffer, as there's no insurance that they will still be in
1584 ;; the parse tree, due to possible narrowing.
1598 alist))))
1599 alist))
1600 :id-alist
1601 ;; Collect id references.
1612 alist))))
1615 "Parse an OPTIONS line and return values as a plist.
1616 Optional argument BACKEND is an export back-end, as returned by,
1617 e.g., `org-export-create-backend'. It specifies which back-end
1618 specific items to read, if any."
1620 ;; Priority is given to back-end specific options.
1622 org-export-options-alist))
1623 plist)
1632 options))
1634 property
1637 plist))
1640 "Get export options in subtree at point.
1641 Optional argument BACKEND is an export back-end, as returned by,
1642 e.g., `org-export-create-backend'. It specifies back-end used
1643 for export. Return options as a plist."
1644 ;; For each buffer keyword, create a headline property setting the
1645 ;; same property in communication channel. The name for the property
1646 ;; is the keyword with "EXPORT_" appended to it.
1649 ;; Make sure point is at a heading.
1651 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1652 ;; title as its fallback value.
1658 plist :title
1661 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1665 ;; Handle other keywords. TITLE keyword is excluded as it has
1666 ;; been handled already.
1674 ;; Export properties are not case-sensitive.
1681 plist
1682 property
1684 ;; Parse VALUE if required.
1688 ;; If BEHAVIOUR is `split' expected value is
1689 ;; a list of strings, not a string.
1692 ;; Look for both general keywords and back-end specific
1693 ;; options, with priority given to the latter.
1695 org-export-options-alist)))
1696 ;; Return value.
1697 plist)))
1700 "Return current buffer export options, as a plist.
1702 Optional argument BACKEND, when non-nil, is an export back-end,
1703 as returned by, e.g., `org-export-create-backend'. It specifies
1704 which back-end specific options should also be read in the
1705 process.
1707 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1709 get-options ; For byte-compiler.
1712 ;; Priority is given to back-end specific options.
1714 org-export-options-alist))
1717 org-export-special-keywords))))
1720 ;; Return all properties associated to KEYWORD.
1727 ;; Recursively read keywords in buffer. FILES is a list
1728 ;; of files read so far. PLIST is the current property
1729 ;; list obtained.
1738 ;; Options in `org-export-special-keywords'.
1742 ;; Avoid circular dependencies.
1752 plist
1757 plist
1763 ;; Options in `org-export-options-alist'.
1768 plist property
1769 ;; Handle value depending on specified
1770 ;; BEHAVIOUR.
1776 " "
1789 ;; Return final value.
1790 plist))))
1791 ;; Read options in the current buffer.
1794 ;; Parse keywords specified in `org-element-document-properties'
1795 ;; and return PLIST.
1806 "Return properties related to buffer attributes, as a plist."
1807 ;; Store full path of input file name, or nil. For internal use.
1810 :input-file visited-file
1816 "Return global export options as a plist.
1817 Optional argument BACKEND, if non-nil, is an export back-end, as
1818 returned by, e.g., `org-export-create-backend'. It specifies
1819 which back-end specific export options should also be read in the
1820 process."
1822 ;; Priority is given to back-end specific options.
1824 org-export-options-alist)))
1831 plist
1832 prop
1833 ;; Eval default value provided. If keyword is
1834 ;; a member of `org-element-document-properties',
1835 ;; parse it as a secondary string before storing it.
1842 value)))))))))))
1845 "Return variables bound from BIND keywords in current buffer.
1846 Also look for BIND keywords in setup files. The return value is
1847 an alist where associations are (VARIABLE-NAME VALUE)."
1852 ;; Return an alist between variable names and their
1853 ;; value. FILES is a list of setup files names read so
1854 ;; far, used to avoid circular dependencies. ALIST is
1855 ;; the alist collected so far.
1866 ;; Enter setup file.
1876 alist))))))))))
1877 alist)))))
1878 ;; Return value in appropriate order of appearance.
1882 ;;;; Tree Properties
1883 ;;
1884 ;; Tree properties are information extracted from parse tree. They
1885 ;; are initialized at the beginning of the transcoding process by
1886 ;; `org-export-collect-tree-properties'.
1887 ;;
1888 ;; Dedicated functions focus on computing the value of specific tree
1889 ;; properties during initialization. Thus,
1890 ;; `org-export--populate-ignore-list' lists elements and objects that
1891 ;; should be skipped during export, `org-export--get-min-level' gets
1892 ;; the minimal exportable level, used as a basis to compute relative
1893 ;; level for headlines. Eventually
1894 ;; `org-export--collect-headline-numbering' builds an alist between
1895 ;; headlines and their numbering.
1898 "Extract tree properties from parse tree.
1900 DATA is the parse tree from which information is retrieved. INFO
1901 is a list holding export options.
1903 Following tree properties are set or updated:
1905 `:exported-data' Hash table used to memoize results from
1906 `org-export-data'.
1908 `:footnote-definition-alist' List of footnotes definitions in
1909 original buffer and current parse tree.
1911 `:headline-offset' Offset between true level of headlines and
1912 local level. An offset of -1 means a headline
1913 of level 2 should be considered as a level
1914 1 headline in the context.
1916 `:headline-numbering' Alist of all headlines as key an the
1917 associated numbering as value.
1919 `:ignore-list' List of elements that should be ignored during
1920 export.
1922 Return updated plist."
1923 ;; Install the parse tree in the communication channel, in order to
1924 ;; use `org-export-get-genealogy' and al.
1926 ;; Get the list of elements and objects to ignore, and put it into
1927 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1928 ;; been done during parse tree filtering.
1931 :ignore-list
1934 ;; Compute `:headline-offset' in order to be able to use
1935 ;; `org-export-get-relative-level'.
1938 :headline-offset
1940 ;; Update footnotes definitions list with definitions in parse tree.
1941 ;; This is required since buffer expansion might have modified
1942 ;; boundaries of footnote definitions contained in the parse tree.
1943 ;; This way, definitions in `footnote-definition-alist' are bound to
1944 ;; match those in the parse tree.
1950 defs)))
1952 ;; Properties order doesn't matter: get the rest of the tree
1953 ;; properties.
1957 info))
1960 "Return minimum exportable headline's level in DATA.
1961 DATA is parsed tree as returned by `org-element-parse-buffer'.
1962 OPTIONS is a plist holding export options."
1973 ;; If no headline was found, for the sake of consistency, set
1974 ;; minimum level to 1 nonetheless.
1978 "Return numbering of all exportable headlines in a parse tree.
1980 DATA is the parse tree. OPTIONS is the plist holding export
1981 options.
1983 Return an alist whose key is a headline and value is its
1984 associated numbering \(in the shape of a list of numbers\) or nil
1985 for a footnotes section."
1993 headline
1995 for idx from 0 to org-export-max-depth
1999 options)))
2002 "Return list of elements and objects to ignore during export.
2003 DATA is the parse tree to traverse. OPTIONS is the plist holding
2004 export options."
2006 ;; First find trees containing a select tag, if any.
2008 ;; If a select tag is active, also ignore the section before
2009 ;; the first headline, if any.
2013 first-element))))
2016 ;; Collect ignored elements or objects into IGNORE-LIST.
2022 ;; If headline is archived but tree below has
2023 ;; to be skipped, add it to ignore list.
2026 ;; Move into secondary string, if any.
2031 ;; Move into recursive objects/elements.
2033 ;; Main call.
2035 ;; Return value.
2036 ignore))
2039 "Return list of headlines and inlinetasks with a select tag in their tree.
2040 DATA is parsed data as returned by `org-element-parse-buffer'.
2041 INFO is a plist holding export options."
2043 walk-data ; For byte-compiler.
2053 ;; When a select tag is found, mark full
2054 ;; genealogy and every headline within the tree
2055 ;; as acceptable.
2058 genealogy
2061 selected-trees))
2062 ;; If at a headline, continue searching in tree,
2063 ;; recursively.
2073 selected-trees))
2076 "Non-nil when element or object BLOB should be skipped during export.
2077 OPTIONS is the plist holding export options. SELECTED, when
2078 non-nil, is a list of headlines or inlinetasks belonging to
2079 a tree with a select tag."
2086 ;; If `:with-drawers' value starts with `not', ignore
2087 ;; every drawer whose name belong to that list.
2088 ;; Otherwise, ignore drawers whose name isn't in that
2089 ;; list.
2105 ;; Ignore subtrees with an exclude tag.
2108 ;; When a select tag is present in the buffer, ignore any tree
2109 ;; without it.
2111 ;; Ignore commented sub-trees.
2113 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2115 ;; Ignore tasks, if specified by `:with-tasks' property.
2127 properties-set))))))
2137 ;; `:with-timestamps' only applies to isolated timestamps
2138 ;; objects, i.e. timestamp objects in a paragraph containing only
2139 ;; timestamps and whitespaces.
2147 options t))))
2156 \f
2157 ;;; The Transcoder
2158 ;;
2159 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2160 ;; `org-element-parse-buffer') and transcodes it into a specified
2161 ;; back-end output. It takes care of filtering out elements or
2162 ;; objects according to export options and organizing the output blank
2163 ;; lines and white space are preserved. The function memoizes its
2164 ;; results, so it is cheap to call it within transcoders.
2165 ;;
2166 ;; It is possible to modify locally the back-end used by
2167 ;; `org-export-data' or even use a temporary back-end by using
2168 ;; `org-export-data-with-backend'.
2169 ;;
2170 ;; Internally, three functions handle the filtering of objects and
2171 ;; elements during the export. In particular,
2172 ;; `org-export-ignore-element' marks an element or object so future
2173 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2174 ;; elements or objects should be seen as real Org syntax and
2175 ;; `org-export-expand' transforms the others back into their original
2176 ;; shape
2177 ;;
2178 ;; `org-export-transcoder' is an accessor returning appropriate
2179 ;; translator function for a given element or object.
2182 "Return appropriate transcoder for BLOB.
2183 INFO is a plist containing export directives."
2185 ;; Return contents only for complete parse trees.
2191 "Convert DATA into current back-end format.
2193 DATA is a parse tree, an element or an object or a secondary
2194 string. INFO is a plist holding export options.
2196 Return transcoded string."
2202 ;; Ignored element/object.
2204 ;; Plain text.
2210 info))
2211 ;; Uninterpreted element/object: change it back to Org
2212 ;; syntax and export again resulting raw string.
2216 data
2220 info))
2221 ;; Secondary string.
2224 ;; Element/Object without contents or, as a special case,
2225 ;; headline with archive tag and archived trees restricted
2226 ;; to title only.
2234 ;; Export snippets never return a nil value so
2235 ;; that white spaces following them are never
2236 ;; ignored.
2238 ;; Element/Object with contents.
2251 ;; Elements directly containing objects
2252 ;; must have their indentation normalized
2253 ;; first.
2255 data
2256 ;; When normalizing contents of the first
2257 ;; paragraph in an item or a footnote
2258 ;; definition, ignore first line's
2259 ;; indentation: there is none and it
2260 ;; might be misleading.
2265 data)
2272 info))))))))
2273 ;; Final result will be memoized before being returned.
2275 data
2279 ;; Append the same white space between elements or objects as in
2280 ;; the original buffer, and call appropriate filters.
2291 info)))
2292 results)))
2296 "Convert DATA into BACKEND format.
2298 DATA is an element, an object, a secondary string or a string.
2299 BACKEND is a symbol. INFO is a plist used as a communication
2300 channel.
2302 Unlike to `org-export-with-backend', this function will
2303 recursively convert DATA using BACKEND translation table."
2306 data
2307 ;; Set-up a new communication channel with translations defined in
2308 ;; BACKEND as the translate table and a new hash table for
2309 ;; memoization.
2311 info
2314 ;; Size of the hash table is reduced since this function
2315 ;; will probably be used on small trees.
2319 "Non-nil if element or object BLOB should be interpreted during export.
2320 If nil, BLOB will appear as raw Org syntax. Check is done
2321 according to export options INFO, stored as a plist."
2323 ;; ... entities...
2325 ;; ... emphasis...
2328 ;; ... fixed-width areas.
2330 ;; ... LaTeX environments and fragments...
2334 ;; ... sub/superscripts...
2340 ;; ... tables...
2345 "Expand a parsed element or object to its original state.
2347 BLOB is either an element or an object. CONTENTS is its
2348 contents, as a string or nil.
2350 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2351 keywords before output."
2356 blob contents))))
2359 "Add ELEMENT to `:ignore-list' in INFO.
2361 Any element in `:ignore-list' will be skipped when using
2362 `org-element-map'. INFO is modified by side effects."
2366 \f
2367 ;;; The Filter System
2368 ;;
2369 ;; Filters allow end-users to tweak easily the transcoded output.
2370 ;; They are the functional counterpart of hooks, as every filter in
2371 ;; a set is applied to the return value of the previous one.
2372 ;;
2373 ;; Every set is back-end agnostic. Although, a filter is always
2374 ;; called, in addition to the string it applies to, with the back-end
2375 ;; used as argument, so it's easy for the end-user to add back-end
2376 ;; specific filters in the set. The communication channel, as
2377 ;; a plist, is required as the third argument.
2378 ;;
2379 ;; From the developer side, filters sets can be installed in the
2380 ;; process with the help of `org-export-define-backend', which
2381 ;; internally stores filters as an alist. Each association has a key
2382 ;; among the following symbols and a function or a list of functions
2383 ;; as value.
2384 ;;
2385 ;; - `:filter-options' applies to the property list containing export
2386 ;; options. Unlike to other filters, functions in this list accept
2387 ;; two arguments instead of three: the property list containing
2388 ;; export options and the back-end. Users can set its value through
2389 ;; `org-export-filter-options-functions' variable.
2390 ;;
2391 ;; - `:filter-parse-tree' applies directly to the complete parsed
2392 ;; tree. Users can set it through
2393 ;; `org-export-filter-parse-tree-functions' variable.
2394 ;;
2395 ;; - `:filter-final-output' applies to the final transcoded string.
2396 ;; Users can set it with `org-export-filter-final-output-functions'
2397 ;; variable
2398 ;;
2399 ;; - `:filter-plain-text' applies to any string not recognized as Org
2400 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2401 ;; configure it.
2402 ;;
2403 ;; - `:filter-TYPE' applies on the string returned after an element or
2404 ;; object of type TYPE has been transcoded. A user can modify
2405 ;; `org-export-filter-TYPE-functions'
2406 ;;
2407 ;; All filters sets are applied with
2408 ;; `org-export-filter-apply-functions' function. Filters in a set are
2409 ;; applied in a LIFO fashion. It allows developers to be sure that
2410 ;; their filters will be applied first.
2411 ;;
2412 ;; Filters properties are installed in communication channel with
2413 ;; `org-export-install-filters' function.
2414 ;;
2415 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2416 ;; `org-export-before-parsing-hook') are run at the beginning of the
2417 ;; export process and just before parsing to allow for heavy structure
2418 ;; modifications.
2421 ;;;; Hooks
2424 "Hook run at the beginning of the export process.
2426 This is run before include keywords and macros are expanded and
2427 Babel code blocks executed, on a copy of the original buffer
2428 being exported. Visibility and narrowing are preserved. Point
2429 is at the beginning of the buffer.
2431 Every function in this hook will be called with one argument: the
2435 "Hook run before parsing an export buffer.
2437 This is run after include keywords and macros have been expanded
2438 and Babel code blocks executed, on a copy of the original buffer
2439 being exported. Visibility and narrowing are preserved. Point
2440 is at the beginning of the buffer.
2442 Every function in this hook will be called with one argument: the
2446 ;;;; Special Filters
2449 "List of functions applied to the export options.
2450 Each filter is called with two arguments: the export options, as
2451 a plist, and the back-end, as a symbol. It must return
2455 "List of functions applied to the parsed tree.
2456 Each filter is called with three arguments: the parse tree, as
2457 returned by `org-element-parse-buffer', the back-end, as
2458 a symbol, and the communication channel, as a plist. It must
2462 "List of functions applied to plain text.
2463 Each filter is called with three arguments: a string which
2464 contains no Org syntax, the back-end, as a symbol, and the
2465 communication channel, as a plist. It must return a string or
2469 "List of functions applied to the transcoded string.
2470 Each filter is called with three arguments: the full transcoded
2471 string, the back-end, as a symbol, and the communication channel,
2472 as a plist. It must return a string that will be used as the
2476 ;;;; Elements Filters
2479 "List of functions applied to a transcoded babel-call.
2480 Each filter is called with three arguments: the transcoded data,
2481 as a string, the back-end, as a symbol, and the communication
2485 "List of functions applied to a transcoded center block.
2486 Each filter is called with three arguments: the transcoded data,
2487 as a string, the back-end, as a symbol, and the communication
2491 "List of functions applied to a transcoded clock.
2492 Each filter is called with three arguments: the transcoded data,
2493 as a string, the back-end, as a symbol, and the communication
2497 "List of functions applied to a transcoded comment.
2498 Each filter is called with three arguments: the transcoded data,
2499 as a string, the back-end, as a symbol, and the communication
2503 "List of functions applied to a transcoded comment-block.
2504 Each filter is called with three arguments: the transcoded data,
2505 as a string, the back-end, as a symbol, and the communication
2509 "List of functions applied to a transcoded diary-sexp.
2510 Each filter is called with three arguments: the transcoded data,
2511 as a string, the back-end, as a symbol, and the communication
2515 "List of functions applied to a transcoded drawer.
2516 Each filter is called with three arguments: the transcoded data,
2517 as a string, the back-end, as a symbol, and the communication
2521 "List of functions applied to a transcoded dynamic-block.
2522 Each filter is called with three arguments: the transcoded data,
2523 as a string, the back-end, as a symbol, and the communication
2527 "List of functions applied to a transcoded example-block.
2528 Each filter is called with three arguments: the transcoded data,
2529 as a string, the back-end, as a symbol, and the communication
2533 "List of functions applied to a transcoded export-block.
2534 Each filter is called with three arguments: the transcoded data,
2535 as a string, the back-end, as a symbol, and the communication
2539 "List of functions applied to a transcoded fixed-width.
2540 Each filter is called with three arguments: the transcoded data,
2541 as a string, the back-end, as a symbol, and the communication
2545 "List of functions applied to a transcoded footnote-definition.
2546 Each filter is called with three arguments: the transcoded data,
2547 as a string, the back-end, as a symbol, and the communication
2551 "List of functions applied to a transcoded headline.
2552 Each filter is called with three arguments: the transcoded data,
2553 as a string, the back-end, as a symbol, and the communication
2557 "List of functions applied to a transcoded horizontal-rule.
2558 Each filter is called with three arguments: the transcoded data,
2559 as a string, the back-end, as a symbol, and the communication
2563 "List of functions applied to a transcoded inlinetask.
2564 Each filter is called with three arguments: the transcoded data,
2565 as a string, the back-end, as a symbol, and the communication
2569 "List of functions applied to a transcoded item.
2570 Each filter is called with three arguments: the transcoded data,
2571 as a string, the back-end, as a symbol, and the communication
2575 "List of functions applied to a transcoded keyword.
2576 Each filter is called with three arguments: the transcoded data,
2577 as a string, the back-end, as a symbol, and the communication
2581 "List of functions applied to a transcoded latex-environment.
2582 Each filter is called with three arguments: the transcoded data,
2583 as a string, the back-end, as a symbol, and the communication
2587 "List of functions applied to a transcoded node-property.
2588 Each filter is called with three arguments: the transcoded data,
2589 as a string, the back-end, as a symbol, and the communication
2593 "List of functions applied to a transcoded paragraph.
2594 Each filter is called with three arguments: the transcoded data,
2595 as a string, the back-end, as a symbol, and the communication
2599 "List of functions applied to a transcoded plain-list.
2600 Each filter is called with three arguments: the transcoded data,
2601 as a string, the back-end, as a symbol, and the communication
2605 "List of functions applied to a transcoded planning.
2606 Each filter is called with three arguments: the transcoded data,
2607 as a string, the back-end, as a symbol, and the communication
2611 "List of functions applied to a transcoded property-drawer.
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 quote block.
2618 Each filter is called with three arguments: the transcoded quote
2619 data, as a string, the back-end, as a symbol, and the
2620 communication channel, as a plist. It must return a string or
2624 "List of functions applied to a transcoded quote-section.
2625 Each filter is called with three arguments: the transcoded data,
2626 as a string, the back-end, as a symbol, and the communication
2630 "List of functions applied to a transcoded section.
2631 Each filter is called with three arguments: the transcoded data,
2632 as a string, the back-end, as a symbol, and the communication
2636 "List of functions applied to a transcoded special block.
2637 Each filter is called with three arguments: the transcoded data,
2638 as a string, the back-end, as a symbol, and the communication
2642 "List of functions applied to a transcoded src-block.
2643 Each filter is called with three arguments: the transcoded data,
2644 as a string, the back-end, as a symbol, and the communication
2648 "List of functions applied to a transcoded table.
2649 Each filter is called with three arguments: the transcoded data,
2650 as a string, the back-end, as a symbol, and the communication
2654 "List of functions applied to a transcoded table-cell.
2655 Each filter is called with three arguments: the transcoded data,
2656 as a string, the back-end, as a symbol, and the communication
2660 "List of functions applied to a transcoded table-row.
2661 Each filter is called with three arguments: the transcoded data,
2662 as a string, the back-end, as a symbol, and the communication
2666 "List of functions applied to a transcoded verse block.
2667 Each filter is called with three arguments: the transcoded data,
2668 as a string, the back-end, as a symbol, and the communication
2672 ;;;; Objects Filters
2675 "List of functions applied to transcoded bold text.
2676 Each filter is called with three arguments: the transcoded data,
2677 as a string, the back-end, as a symbol, and the communication
2681 "List of functions applied to transcoded code text.
2682 Each filter is called with three arguments: the transcoded data,
2683 as a string, the back-end, as a symbol, and the communication
2687 "List of functions applied to a transcoded entity.
2688 Each filter is called with three arguments: the transcoded data,
2689 as a string, the back-end, as a symbol, and the communication
2693 "List of functions applied to a transcoded export-snippet.
2694 Each filter is called with three arguments: the transcoded data,
2695 as a string, the back-end, as a symbol, and the communication
2699 "List of functions applied to a transcoded footnote-reference.
2700 Each filter is called with three arguments: the transcoded data,
2701 as a string, the back-end, as a symbol, and the communication
2705 "List of functions applied to a transcoded inline-babel-call.
2706 Each filter is called with three arguments: the transcoded data,
2707 as a string, the back-end, as a symbol, and the communication
2711 "List of functions applied to a transcoded inline-src-block.
2712 Each filter is called with three arguments: the transcoded data,
2713 as a string, the back-end, as a symbol, and the communication
2717 "List of functions applied to transcoded italic text.
2718 Each filter is called with three arguments: the transcoded data,
2719 as a string, the back-end, as a symbol, and the communication
2723 "List of functions applied to a transcoded latex-fragment.
2724 Each filter is called with three arguments: the transcoded data,
2725 as a string, the back-end, as a symbol, and the communication
2729 "List of functions applied to a transcoded line-break.
2730 Each filter is called with three arguments: the transcoded data,
2731 as a string, the back-end, as a symbol, and the communication
2735 "List of functions applied to a transcoded link.
2736 Each filter is called with three arguments: the transcoded data,
2737 as a string, the back-end, as a symbol, and the communication
2741 "List of functions applied to a transcoded radio-target.
2742 Each filter is called with three arguments: the transcoded data,
2743 as a string, the back-end, as a symbol, and the communication
2747 "List of functions applied to a transcoded statistics-cookie.
2748 Each filter is called with three arguments: the transcoded data,
2749 as a string, the back-end, as a symbol, and the communication
2753 "List of functions applied to transcoded strike-through text.
2754 Each filter is called with three arguments: the transcoded data,
2755 as a string, the back-end, as a symbol, and the communication
2759 "List of functions applied to a transcoded subscript.
2760 Each filter is called with three arguments: the transcoded data,
2761 as a string, the back-end, as a symbol, and the communication
2765 "List of functions applied to a transcoded superscript.
2766 Each filter is called with three arguments: the transcoded data,
2767 as a string, the back-end, as a symbol, and the communication
2771 "List of functions applied to a transcoded target.
2772 Each filter is called with three arguments: the transcoded data,
2773 as a string, the back-end, as a symbol, and the communication
2777 "List of functions applied to a transcoded timestamp.
2778 Each filter is called with three arguments: the transcoded data,
2779 as a string, the back-end, as a symbol, and the communication
2783 "List of functions applied to transcoded underline text.
2784 Each filter is called with three arguments: the transcoded data,
2785 as a string, the back-end, as a symbol, and the communication
2789 "List of functions applied to transcoded verbatim text.
2790 Each filter is called with three arguments: the transcoded data,
2791 as a string, the back-end, as a symbol, and the communication
2795 ;;;; Filters Tools
2796 ;;
2797 ;; Internal function `org-export-install-filters' installs filters
2798 ;; hard-coded in back-ends (developer filters) and filters from global
2799 ;; variables (user filters) in the communication channel.
2800 ;;
2801 ;; Internal function `org-export-filter-apply-functions' takes care
2802 ;; about applying each filter in order to a given data. It ignores
2803 ;; filters returning a nil value but stops whenever a filter returns
2804 ;; an empty string.
2807 "Call every function in FILTERS.
2809 Functions are called with arguments VALUE, current export
2810 back-end's name and INFO. A function returning a nil value will
2811 be skipped. If it returns the empty string, the process ends and
2812 VALUE is ignored.
2814 Call is done in a LIFO fashion, to be sure that developer
2815 specified filters, if any, are called first."
2826 "Install filters properties in communication channel.
2827 INFO is a plist containing the current communication channel.
2828 Return the updated communication channel."
2830 ;; Install user-defined filters with `org-export-filters-alist'
2831 ;; and filters already in INFO (through ext-plist mechanism).
2838 ;; Filters in INFO will be called
2839 ;; before those user provided.
2842 default-value)))))
2843 org-export-filters-alist)
2844 ;; Prepend back-end specific filters to that list.
2846 ;; Single values get consed, lists are appended.
2851 plist key
2855 ;; Return new communication channel.
2859 \f
2860 ;;; Core functions
2861 ;;
2862 ;; This is the room for the main function, `org-export-as', along with
2863 ;; its derivative, `org-export-string-as'.
2864 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2865 ;; function should be added to kill ring.
2866 ;;
2867 ;; Note that `org-export-as' doesn't really parse the current buffer,
2868 ;; but a copy of it (with the same buffer-local variables and
2869 ;; visibility), where macros and include keywords are expanded and
2870 ;; Babel blocks are executed, if appropriate.
2871 ;; `org-export-with-buffer-copy' macro prepares that copy.
2872 ;;
2873 ;; File inclusion is taken care of by
2874 ;; `org-export-expand-include-keyword' and
2875 ;; `org-export--prepare-file-contents'. Structure wise, including
2876 ;; a whole Org file in a buffer often makes little sense. For
2877 ;; example, if the file contains a headline and the include keyword
2878 ;; was within an item, the item should contain the headline. That's
2879 ;; why file inclusion should be done before any structure can be
2880 ;; associated to the file, that is before parsing.
2881 ;;
2882 ;; `org-export-insert-default-template' is a command to insert
2883 ;; a default template (or a back-end specific template) at point or in
2884 ;; current subtree.
2887 "Return a copy of the current buffer.
2888 The copy preserves Org buffer-local variables, visibility and
2889 narrowing."
2895 new-buf))
2898 "Apply BODY in a copy of the current buffer.
2899 The copy preserves local variables, visibility and contents of
2900 the original buffer. Point is at the beginning of the buffer
2901 when BODY is applied."
2910 ;; Kill copy without confirmation.
2916 "Generate a function duplicating BUFFER.
2918 The copy will preserve local variables, visibility, contents and
2919 narrowing of the original buffer. If a region was active in
2920 BUFFER, contents will be narrowed to that region instead.
2922 The resulting function can be evaluated at a later time, from
2923 another buffer, effectively cloning the original buffer there.
2925 The function assumes BUFFER's major mode is `org-mode'."
2929 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2930 ;; already in BUFFER.
2932 ;; Copy specific buffer local variables and variables set
2933 ;; through BIND keywords.
2935 vars)
2943 buffer-file-name
2944 buffer-file-coding-system))
2948 ;; Skip unreadable values, as they cannot be
2949 ;; sent to external process.
2953 vars))))))
2954 ;; Whole buffer contents.
2959 ;; Narrowing.
2963 ;; Current position of point.
2965 ;; Overlays with invisible property.
2975 ov-set))))
2977 ov-set)))))
2979 ;;;###autoload
2982 "Transcode current Org buffer into BACKEND code.
2984 BACKEND is either an export back-end, as returned by, e.g.,
2985 `org-export-create-backend', or a symbol referring to
2986 a registered back-end.
2988 If narrowing is active in the current buffer, only transcode its
2989 narrowed part.
2991 If a region is active, transcode that region.
2993 When optional argument SUBTREEP is non-nil, transcode the
2994 sub-tree at point, extracting information from the headline
2995 properties first.
2997 When optional argument VISIBLE-ONLY is non-nil, don't export
2998 contents of hidden elements.
3000 When optional argument BODY-ONLY is non-nil, only return body
3001 code, without surrounding template.
3003 Optional argument EXT-PLIST, when provided, is a property list
3004 with external parameters overriding Org default settings, but
3005 still inferior to file-local settings.
3007 Return code as a string."
3012 ;; Narrow buffer to an appropriate region or subtree for
3013 ;; parsing. If parsing subtree, be sure to remove main headline
3014 ;; too.
3022 ;; Initialize communication channel with original buffer
3023 ;; attributes, unavailable in its copy.
3032 tree)
3033 ;; Update communication channel and get parse tree. Buffer
3034 ;; isn't parsed directly. Instead, a temporary copy is
3035 ;; created, where include keywords, macros are expanded and
3036 ;; code blocks are evaluated.
3038 ;; Run first hook with current back-end's name as argument.
3042 ;; Update macro templates since #+INCLUDE keywords might have
3043 ;; added some new ones.
3047 ;; Update radio targets since keyword inclusion might have
3048 ;; added some more.
3050 ;; Run last hook with current back-end's name as argument.
3055 ;; Update communication channel with environment. Also
3056 ;; install user's and developer's filters.
3061 ;; Expand export-specific set of macros: {{{author}}},
3062 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3063 ;; once regular macros have been expanded, since document
3064 ;; keywords may contain one of them.
3070 ;; EMAIL is not a parsed keyword: store it as-is.
3074 ;; Call options filters and update export options. We do not
3075 ;; use `org-export-filter-apply-functions' here since the
3076 ;; arity of such filters is different.
3081 ;; Parse buffer and call parse-tree filter on it.
3086 ;; Now tree is complete, compute its properties and add them
3087 ;; to communication channel.
3091 ;; Eventually transcode TREE. Wrap the resulting string into
3092 ;; a template.
3101 ;; Remove all text properties since they cannot be
3102 ;; retrieved from an external process. Finally call
3103 ;; final-output filter and return result.
3109 info))))))))
3111 ;;;###autoload
3113 "Transcode STRING into BACKEND code.
3115 BACKEND is either an export back-end, as returned by, e.g.,
3116 `org-export-create-backend', or a symbol referring to
3117 a registered back-end.
3119 When optional argument BODY-ONLY is non-nil, only return body
3120 code, without preamble nor postamble.
3122 Optional argument EXT-PLIST, when provided, is a property list
3123 with external parameters overriding Org default settings, but
3124 still inferior to file-local settings.
3126 Return code as a string."
3132 ;;;###autoload
3134 "Replace the active region by its export to BACKEND.
3135 BACKEND is either an export back-end, as returned by, e.g.,
3136 `org-export-create-backend', or a symbol referring to
3137 a registered back-end."
3147 ;;;###autoload
3149 "Insert all export keywords with default values at beginning of line.
3151 BACKEND is a symbol referring to the name of a registered export
3152 back-end, for which specific export options should be added to
3153 the template, or `default' for default template. When it is nil,
3154 the user will be prompted for a category.
3156 If SUBTREEP is non-nil, export configuration will be set up
3157 locally for the subtree through node properties."
3167 "Options category: "
3171 org-export--registered-backends))))))
3172 options keywords)
3173 ;; Populate OPTIONS and KEYWORDS.
3190 ;; Move to an appropriate location in order to insert options.
3192 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3193 ;; list of available keywords.
3221 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3239 ;; And the rest of keywords.
3250 "Expand every include keyword in buffer.
3251 Optional argument INCLUDED is a list of included file names along
3252 with their line restriction, when appropriate. It is used to
3253 avoid infinite recursion. Optional argument DIR is the current
3254 working directory. It is used to properly resolve relative
3255 paths."
3262 ;; Extract arguments from keyword's value.
3270 dir)
3275 value)
3281 ;; Minimal level of included file defaults to the child
3282 ;; level of the current headline, if any, or one. It
3283 ;; only applies is the file is meant to be included as
3284 ;; an Org one.
3292 ;; Remove keyword.
3298 ;; Check if files has already been parsed. Look after
3299 ;; inclusion lines too, as different parts of the same file
3300 ;; can be included too.
3312 ind-str contents ind-str))))
3320 ind-str env contents ind-str))))
3333 "Prepare the contents of FILE for inclusion and return them as a string.
3335 When optional argument LINES is a string specifying a range of
3336 lines, include only those lines.
3338 Optional argument IND, when non-nil, is an integer specifying the
3339 global indentation of returned contents. Since its purpose is to
3340 allow an included file to stay in the same environment it was
3341 created \(i.e. a list item), it doesn't apply past the first
3342 headline encountered.
3344 Optional argument MINLEVEL, when non-nil, is an integer
3345 specifying the level that any top-level headline in the included
3346 file should have."
3362 ;; Remove blank lines at beginning and end of contents. The logic
3363 ;; behind that removal is that blank lines around include keyword
3364 ;; override blank lines in included file.
3373 ;; If IND is set, preserve indentation of include keyword until
3374 ;; the first headline encountered.
3381 ;; Do not move footnote definitions out of column 0.
3387 ;; When MINLEVEL is specified, compute minimal level for headlines
3388 ;; in the file (CUR-MIN), and remove stars to each headline so
3389 ;; that headlines with minimal level have a level of MINLEVEL.
3400 ;; Only change stars, don't bother moving whole
3401 ;; sections.
3408 "Execute every Babel code in the visible part of current buffer."
3409 ;; Get a pristine copy of current buffer so Babel references can be
3410 ;; properly resolved.
3417 "Return a non-nil value when output should be added to the kill ring.
3418 See also `org-export-copy-to-kill-ring'."
3424 \f
3425 ;;; Tools For Back-Ends
3426 ;;
3427 ;; A whole set of tools is available to help build new exporters. Any
3428 ;; function general enough to have its use across many back-ends
3429 ;; should be added here.
3431 ;;;; For Affiliated Keywords
3432 ;;
3433 ;; `org-export-read-attribute' reads a property from a given element
3434 ;; as a plist. It can be used to normalize affiliated keywords'
3435 ;; syntax.
3436 ;;
3437 ;; Since captions can span over multiple lines and accept dual values,
3438 ;; their internal representation is a bit tricky. Therefore,
3439 ;; `org-export-get-caption' transparently returns a given element's
3440 ;; caption as a secondary string.
3443 "Turn ATTRIBUTE property from ELEMENT into a plist.
3445 When optional argument PROPERTY is non-nil, return the value of
3446 that property within attributes.
3450 properties.
3452 All values will become strings except the empty string and
3455 will become the empty string."
3469 s)
3474 ;; Ignore any string before first property with `cdr'.
3479 "Return caption from ELEMENT as a secondary string.
3481 When optional argument SHORTP is non-nil, return short caption,
3482 as a secondary string, instead.
3484 Caption lines are separated by a white space."
3492 ;;;; For Derived Back-ends
3493 ;;
3494 ;; `org-export-with-backend' is a function allowing to locally use
3495 ;; another back-end to transcode some object or element. In a derived
3496 ;; back-end, it may be used as a fall-back function once all specific
3497 ;; cases have been treated.
3500 "Call a transcoder from BACKEND on DATA.
3501 BACKEND is an export back-end, as returned by, e.g.,
3502 `org-export-create-backend', or a symbol referring to
3503 a registered back-end. DATA is an Org element, object, secondary
3504 string or string. CONTENTS, when non-nil, is the transcoded
3505 contents of DATA element, as a string. INFO, when non-nil, is
3506 the communication channel used for export, as a plist."
3516 transcoder data contents
3519 :translate-alist all-transcoders
3523 ;;;; For Export Snippets
3524 ;;
3525 ;; Every export snippet is transmitted to the back-end. Though, the
3526 ;; latter will only retain one type of export-snippet, ignoring
3527 ;; others, based on the former's target back-end. The function
3528 ;; `org-export-snippet-backend' returns that back-end for a given
3529 ;; export-snippet.
3532 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3533 Translation, with `org-export-snippet-translation-alist', is
3534 applied."
3538 back-end))))
3541 ;;;; For Footnotes
3542 ;;
3543 ;; `org-export-collect-footnote-definitions' is a tool to list
3544 ;; actually used footnotes definitions in the whole parse tree, or in
3545 ;; a headline, in order to add footnote listings throughout the
3546 ;; transcoded data.
3547 ;;
3548 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3549 ;; back-ends, when they need to attach the footnote definition only to
3550 ;; the first occurrence of the corresponding label.
3551 ;;
3552 ;; `org-export-get-footnote-definition' and
3553 ;; `org-export-get-footnote-number' provide easier access to
3554 ;; additional information relative to a footnote reference.
3557 "Return an alist between footnote numbers, labels and definitions.
3559 DATA is the parse tree from which definitions are collected.
3560 INFO is the plist used as a communication channel.
3562 Definitions are sorted by order of references. They either
3563 appear as Org data or as a secondary string for inlined
3564 footnotes. Unreferenced definitions are ignored."
3566 collect-fn ; for byte-compiler.
3570 ;; Collect footnote number, label and definition in DATA.
3578 def)
3579 num-alist)
3580 ;; Also search in definition for nested footnotes.
3583 ;; Don't enter footnote definitions since it will happen
3584 ;; when their first reference is found.
3590 "Non-nil when a footnote reference is the first one for its label.
3592 FOOTNOTE-REFERENCE is the footnote reference being considered.
3593 INFO is the plist used as a communication channel."
3595 ;; Anonymous footnotes are always a first reference.
3597 ;; Otherwise, return the first footnote with the same LABEL and
3598 ;; test if it is equal to FOOTNOTE-REFERENCE.
3608 ;; If FN isn't inlined, be sure to traverse its
3609 ;; definition before resuming search. See
3610 ;; comments in `org-export-get-footnote-number'
3611 ;; for more information.
3615 ;; Don't enter footnote definitions since it will
3616 ;; happen when their first reference is found.
3619 footnote-reference)))))
3622 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3623 INFO is the plist used as a communication channel. If no such
3625 string."
3632 "Return number associated to a footnote.
3634 FOOTNOTE is either a footnote reference or a footnote definition.
3635 INFO is the plist used as a communication channel."
3637 seen-refs
3638 search-ref ; For byte-compiler.
3642 ;; Search footnote references through DATA, filling
3643 ;; SEEN-REFS along the way.
3648 ;; Anonymous footnote match: return number.
3651 ;; Labels match: return number.
3654 ;; Anonymous footnote: it's always a new one.
3655 ;; Also, be sure to return nil from the `cond' so
3656 ;; `first-match' doesn't get us out of the loop.
3658 ;; Label not seen so far: add it so SEEN-REFS.
3659 ;;
3660 ;; Also search for subsequent references in
3661 ;; footnote definition so numbering follows
3662 ;; reading logic. Note that we don't have to care
3663 ;; about inline definitions, since
3664 ;; `org-element-map' already traverses them at the
3665 ;; right time.
3666 ;;
3667 ;; Once again, return nil to stay in the loop.
3672 nil))))
3673 ;; Don't enter footnote definitions since it will
3674 ;; happen when their first reference is found.
3679 ;;;; For Headlines
3680 ;;
3681 ;; `org-export-get-relative-level' is a shortcut to get headline
3682 ;; level, relatively to the lower headline level in the parsed tree.
3683 ;;
3684 ;; `org-export-get-headline-number' returns the section number of an
3685 ;; headline, while `org-export-number-to-roman' allows to convert it
3686 ;; to roman numbers.
3687 ;;
3688 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3689 ;; `org-export-last-sibling-p' are three useful predicates when it
3690 ;; comes to fulfill the `:headline-levels' property.
3691 ;;
3692 ;; `org-export-get-tags', `org-export-get-category' and
3693 ;; `org-export-get-node-property' extract useful information from an
3694 ;; headline or a parent headline. They all handle inheritance.
3695 ;;
3696 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3697 ;; as a secondary string, suitable for table of contents. It falls
3698 ;; back onto default title.
3701 "Return HEADLINE relative level within current parsed tree.
3702 INFO is a plist holding contextual information."
3707 "Non-nil when HEADLINE is considered as low level.
3709 INFO is a plist used as a communication channel.
3711 A low level headlines has a relative level greater than
3712 `:headline-levels' property value.
3714 Return value is the difference between HEADLINE relative level
3715 and the last level being considered as high enough, or nil."
3722 "Return HEADLINE numbering as a list of numbers.
3723 INFO is a plist holding contextual information."
3727 "Return a non-nil value if HEADLINE element should be numbered.
3728 INFO is a plist used as a communication channel."
3734 "Convert integer N into a roman numeral."
3747 res)))
3750 "Return list of tags associated to ELEMENT.
3752 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3753 is a plist used as a communication channel.
3755 Select tags (see `org-export-select-tags') and exclude tags (see
3756 `org-export-exclude-tags') are removed from the list.
3758 When non-nil, optional argument TAGS should be a list of strings.
3759 Any tag belonging to this list will also be removed.
3761 When optional argument INHERITED is non-nil, tags can also be
3762 inherited from parent headlines and FILETAGS keywords."
3768 ;; Build complete list of inherited tags.
3779 ;; Add FILETAGS keywords and return results.
3783 "Return node PROPERTY value for BLOB.
3785 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3786 element or object.
3788 If optional argument INHERITED is non-nil, the value can be
3789 inherited from a parent headline.
3791 Return value is a string or nil."
3803 "Return category for element or object BLOB.
3805 INFO is a plist used as a communication channel.
3807 CATEGORY is automatically inherited from a parent headline, from
3808 #+CATEGORY: keyword or created out of original file name. If all
3812 ;; Almost like `org-export-node-property', but we cannot trust
3813 ;; `plist-member' as every headline has a `:CATEGORY'
3814 ;; property, would it be nil or equal to "???" (which has the
3815 ;; same meaning).
3833 "Return alternative title for HEADLINE, as a secondary string.
3834 INFO is a plist used as a communication channel. If no optional
3835 title is defined, fall-back to the regular title."
3840 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3841 INFO is a plist used as a communication channel."
3846 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3847 INFO is a plist used as a communication channel."
3851 ;;;; For Keywords
3852 ;;
3853 ;; `org-export-get-date' returns a date appropriate for the document
3854 ;; to about to be exported. In particular, it takes care of
3855 ;; `org-export-date-timestamp-format'.
3858 "Return date value for the current document.
3860 INFO is a plist used as a communication channel. FMT, when
3861 non-nil, is a time format string that will be applied on the date
3862 if it consists in a single timestamp object. It defaults to
3863 `org-export-date-timestamp-format' when nil.
3865 A proper date can be a secondary string, a string or nil. It is
3866 meant to be translated with `org-export-data' or alike."
3877 ;;;; For Links
3878 ;;
3879 ;; `org-export-solidify-link-text' turns a string into a safer version
3880 ;; for links, replacing most non-standard characters with hyphens.
3881 ;;
3882 ;; `org-export-get-coderef-format' returns an appropriate format
3883 ;; string for coderefs.
3884 ;;
3885 ;; `org-export-inline-image-p' returns a non-nil value when the link
3886 ;; provided should be considered as an inline image.
3887 ;;
3888 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3889 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3890 ;; returns an appropriate unique identifier when found, or nil.
3891 ;;
3892 ;; `org-export-resolve-id-link' returns the first headline with
3893 ;; specified id or custom-id in parse tree, the path to the external
3894 ;; file with the id or nil when neither was found.
3895 ;;
3896 ;; `org-export-resolve-coderef' associates a reference to a line
3897 ;; number in the element it belongs, or returns the reference itself
3898 ;; when the element isn't numbered.
3901 "Take link text S and make a safe target out of it."
3906 "Return format string for code reference link.
3907 PATH is the link path. DESC is its description."
3915 "Non-nil if LINK object points to an inline image.
3917 Optional argument is a set of RULES defining inline images. It
3918 is an alist where associations have the following shape:
3920 \(TYPE . REGEXP)
3922 Applying a rule means apply REGEXP against LINK's path when its
3923 type is TYPE. The function will return a non-nil value if any of
3924 the provided rules is non-nil. The default rule is
3925 `org-export-default-inline-image-rule'.
3927 This only applies to links without a description."
3938 rules)
3939 ;; Return nil if no rule matched.
3940 nil))))
3943 "Resolve a code reference REF.
3945 INFO is a plist used as a communication channel.
3947 Return associated line number in source code, or REF itself,
3948 depending on src-block or example element's switches."
3955 org-coderef-label-format)))
3959 ;; Element containing REF is found. Resolve it to either
3960 ;; a label or a line number, as needed.
3970 "Return LINK destination.
3972 INFO is a plist holding contextual information.
3974 Return value can be an object, an element, or nil:
3976 - If LINK path matches a target object (i.e. <<path>>) return it.
3978 - If LINK path exactly matches the name affiliated keyword
3979 \(i.e. #+NAME: path) of an element, return that element.
3981 - If LINK path exactly matches any headline name, return that
3982 element. If more than one headline share that name, priority
3983 will be given to the one with the closest common ancestor, if
3984 any, or the first one in the parse tree otherwise.
3986 - Otherwise, return nil.
3989 significant."
3992 ;; Split PATH at white spaces so matches are space
3993 ;; insensitive.
3996 ;; Cache for destinations that are not position dependent.
4004 ;; Destination is not position dependent: use cached value.
4006 ;; First try to find a matching "<<path>>" unless user specified
4007 ;; he was looking for a headline (path starts with a "*"
4008 ;; character).
4014 path)
4015 blob))
4018 ;; Then try to find an element with a matching "#+NAME: path"
4019 ;; affiliated keyword.
4022 org-element-all-elements
4027 el)))
4030 ;; Last case: link either points to a headline or to nothingness.
4031 ;; Try to find the source, with priority given to headlines with
4032 ;; the closest common ancestor. If such candidate is found,
4033 ;; return it, otherwise return nil.
4037 ;; Return first headline whose `:raw-value' property is
4038 ;; NAME in parse tree DATA, or nil. Statistics cookies
4039 ;; are ignored.
4047 name)
4048 headline))
4050 ;; Search among headlines sharing an ancestor with link, from
4051 ;; closest to farthest.
4060 ;; No destination found: return nil.
4064 "Return headline referenced as LINK destination.
4066 INFO is a plist used as a communication channel.
4068 Return value can be the headline element matched in current parse
4072 ;; First check if id is within the current parse tree.
4077 headline))
4079 ;; Otherwise, look for external files.
4083 "Return radio-target object referenced as LINK destination.
4085 INFO is a plist used as a communication channel.
4087 Return value can be a radio-target object or nil. Assume LINK
4096 nil nil path nil nil t)
4097 t)
4098 radio))
4102 ;;;; For References
4103 ;;
4104 ;; `org-export-get-ordinal' associates a sequence number to any object
4105 ;; or element.
4108 "Return ordinal number of an element or object.
4110 ELEMENT is the element or object considered. INFO is the plist
4111 used as a communication channel.
4113 Optional argument TYPES, when non-nil, is a list of element or
4114 object types, as symbols, that should also be counted in.
4115 Otherwise, only provided element's type is considered.
4117 Optional argument PREDICATE is a function returning a non-nil
4118 value if the current element or object should be counted in. It
4119 accepts two arguments: the element or object being considered and
4120 the plist used as a communication channel. This allows to count
4121 only a certain type of objects (i.e. inline images).
4123 Return value is a list of numbers if ELEMENT is a headline or an
4124 item. It is nil for keywords. It represents the footnote number
4125 for footnote definitions and footnote references. If ELEMENT is
4126 a target, return the same value as if ELEMENT was the closest
4127 table, item or headline containing the target. In any other
4128 case, return the sequence number of ELEMENT among elements or
4129 objects of the same type."
4130 ;; Ordinal of a target object refer to the ordinal of the closest
4131 ;; table, item, or headline containing the object.
4135 when
4139 table))
4140 return parent)))
4142 ;; Special case 1: A headline returns its number as a list.
4144 ;; Special case 2: An item returns its number as a list.
4148 struct
4155 ;; Increment counter until ELEMENT is found again.
4166 ;;;; For Src-Blocks
4167 ;;
4168 ;; `org-export-get-loc' counts number of code lines accumulated in
4169 ;; src-block or example-block elements with a "+n" switch until
4170 ;; a given element, excluded. Note: "-n" switches reset that count.
4171 ;;
4172 ;; `org-export-unravel-code' extracts source code (along with a code
4173 ;; references alist) from an `element-block' or `src-block' type
4174 ;; element.
4175 ;;
4176 ;; `org-export-format-code' applies a formatting function to each line
4177 ;; of code, providing relative line number and code reference when
4178 ;; appropriate. Since it doesn't access the original element from
4179 ;; which the source code is coming, it expects from the code calling
4180 ;; it to know if lines should be numbered and if code references
4181 ;; should appear.
4182 ;;
4183 ;; Eventually, `org-export-format-code-default' is a higher-level
4184 ;; function (it makes use of the two previous functions) which handles
4185 ;; line numbering and code references inclusion, and returns source
4186 ;; code in a format suitable for plain text or verbatim output.
4189 "Return accumulated lines of code up to ELEMENT.
4191 INFO is the plist used as a communication channel.
4193 ELEMENT is excluded from count."
4199 ;; ELEMENT is reached: Quit the loop.
4201 ;; Only count lines from src-block and example-block elements
4202 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4206 ;; Accumulate locs or reset them.
4210 ;; Return nil to stay in the loop.
4211 nil)))
4213 ;; Return value.
4214 loc))
4217 "Clean source code and extract references out of it.
4219 ELEMENT has either a `src-block' an `example-block' type.
4221 Return a cons cell whose CAR is the source code, cleaned from any
4222 reference, protective commas and spurious indentation, and CDR is
4223 an alist between relative line number (integer) and name of code
4224 reference on that line (string)."
4227 ;; Get code and clean it. Remove blank lines at its
4228 ;; beginning and end.
4235 value
4237 ;; Get format used for references.
4240 org-coderef-label-format)))
4241 ;; Build a regexp matching a loc with a reference.
4246 ;; Return value.
4248 ;; Code with references removed.
4254 ;; Ref line: remove ref, and signal its position in REFS.
4258 ;; Reference alist.
4259 refs)))
4262 "Format CODE by applying FUN line-wise and return it.
4264 CODE is a string representing the code to format. FUN is
4265 a function. It must accept three arguments: a line of
4266 code (string), the current line number (integer) or nil and the
4267 reference associated to the current line (string) or nil.
4269 Optional argument NUM-LINES can be an integer representing the
4270 number of code lines accumulated until the current code. Line
4271 numbers passed to FUN will take it into account. If it is nil,
4272 FUN's second argument will always be nil. This number can be
4273 obtained with `org-export-get-loc' function.
4275 Optional argument REF-ALIST can be an alist between relative line
4276 number (i.e. ignoring NUM-LINES) and the name of the code
4277 reference on it. If it is nil, FUN's third argument will always
4278 be nil. It can be obtained through the use of
4279 `org-export-unravel-code' function."
4291 "Return source code from ELEMENT, formatted in a standard way.
4293 ELEMENT is either a `src-block' or `example-block' element. INFO
4294 is a plist used as a communication channel.
4296 This function takes care of line numbering and code references
4297 inclusion. Line numbers, when applicable, appear at the
4298 beginning of the line, separated from the code by two white
4299 spaces. Code references, on the other hand, appear flushed to
4300 the right, separated by six white spaces from the widest line of
4301 code."
4302 ;; Extract code and references.
4309 ;; Handle line numbering.
4318 ;; Prepare references display, if required. Any reference
4319 ;; should start six columns after the widest line of code,
4320 ;; wrapped with parenthesis.
4325 code
4329 number-str
4330 loc
4336 num-start refs)))))
4339 ;;;; For Tables
4340 ;;
4341 ;; `org-export-table-has-special-column-p' and and
4342 ;; `org-export-table-row-is-special-p' are predicates used to look for
4343 ;; meta-information about the table structure.
4344 ;;
4345 ;; `org-table-has-header-p' tells when the rows before the first rule
4346 ;; should be considered as table's header.
4347 ;;
4348 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4349 ;; and `org-export-table-cell-borders' extract information from
4350 ;; a table-cell element.
4351 ;;
4352 ;; `org-export-table-dimensions' gives the number on rows and columns
4353 ;; in the table, ignoring horizontal rules and special columns.
4354 ;; `org-export-table-cell-address', given a table-cell object, returns
4355 ;; the absolute address of a cell. On the other hand,
4356 ;; `org-export-get-table-cell-at' does the contrary.
4357 ;;
4358 ;; `org-export-table-cell-starts-colgroup-p',
4359 ;; `org-export-table-cell-ends-colgroup-p',
4360 ;; `org-export-table-row-starts-rowgroup-p',
4361 ;; `org-export-table-row-ends-rowgroup-p',
4362 ;; `org-export-table-row-starts-header-p' and
4363 ;; `org-export-table-row-ends-header-p' indicate position of current
4364 ;; row or cell within the table.
4367 "Non-nil when TABLE has a special column.
4368 All special columns will be ignored during export."
4369 ;; The table has a special column when every first cell of every row
4370 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4371 ;; "*" "_" and "^". Though, do not consider a first row containing
4372 ;; only empty cells as special.
4388 "Non-nil when TABLE has a header.
4390 INFO is a plist used as a communication channel.
4392 A table has a header when it contains at least two row groups."
4401 table
4412 cache)))))
4415 "Non-nil if TABLE-ROW is considered special.
4417 INFO is a plist used as the communication channel.
4419 All special rows will be ignored during export."
4423 ;; A row is special either when...
4425 ;; ... it starts with a field only containing "/",
4427 ;; ... the table contains a special column and the row start
4428 ;; with a marking character among, "^", "_", "$" or "!",
4432 ;; ... it contains only alignment cookies and empty cells.
4438 ;; Since VALUE is a secondary string, the following
4439 ;; checks avoid expanding it with `org-export-data'.
4451 "Return TABLE-ROW's group number, as an integer.
4453 INFO is a plist used as the communication channel.
4455 Return value is the group number, as an integer, or nil for
4456 special rows and rows separators. First group is also table's
4457 header."
4475 "Return TABLE-CELL contents width.
4477 INFO is a plist used as the communication channel.
4479 Return value is the width given by the last width cookie in the
4480 same column as TABLE-CELL, or nil."
4499 ;; In a special row, try to find a width cookie at COLUMN.
4503 ;; The following checks avoid expanding unnecessarily
4504 ;; the cell with `org-export-data'.
4514 "Return TABLE-CELL contents alignment.
4516 INFO is a plist used as the communication channel.
4518 Return alignment as specified by the last alignment cookie in the
4519 same column as TABLE-CELL. If no such cookie is found, a default
4520 alignment value will be deduced from fraction of numbers in the
4521 column (see `org-table-number-fraction' for more information).
4522 Possible values are `left', `right' and `center'."
4523 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4540 cookie-align
4541 previous-cell-number-p)
4544 ;; In a special row, try to find an alignment cookie at
4545 ;; COLUMN.
4549 ;; Since VALUE is a secondary string, the following
4550 ;; checks avoid useless expansion through
4551 ;; `org-export-data'.
4559 ;; Ignore table rules.
4561 ;; In a standard row, check if cell's contents are
4562 ;; expressing some kind of number. Increase NUMBER-CELLS
4563 ;; accordingly. Though, don't bother if an alignment
4564 ;; cookie has already defined cell's alignment.
4569 info)))
4571 ;; Treat an empty cell as a number if it follows
4572 ;; a number.
4578 ;; Return value. Alignment specified by cookies has
4579 ;; precedence over alignment deduced from cell's contents.
4581 column
4586 org-table-number-fraction)
4591 "Return TABLE-CELL borders.
4593 INFO is a plist used as a communication channel.
4595 Return value is a list of symbols, or nil. Possible values are:
4596 `top', `bottom', `above', `below', `left' and `right'. Note:
4597 `top' (resp. `bottom') only happen for a cell in the first
4598 row (resp. last row) of the table, ignoring table rules, if any.
4600 Returned borders ignore special rows."
4603 borders)
4604 ;; Top/above border? TABLE-CELL has a border above when a rule
4605 ;; used to demarcate row groups can be found above. Hence,
4606 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4607 ;; another regular row has to be found above that rule.
4616 ;; Look at every row before the current one.
4618 ;; No rule above, or rule found starts the table (ignoring any
4619 ;; special row): TABLE-CELL is at the top of the table.
4622 ;; Bottom/below border? TABLE-CELL has a border below when next
4623 ;; non-regular row below is a rule.
4632 ;; Look at every row after the current one.
4634 ;; No rule below, or rule found ends the table (modulo some
4635 ;; special row): TABLE-CELL is at the bottom of the table.
4638 ;; Right/left borders? They can only be specified by column
4639 ;; groups. Column groups are defined in a row starting with "/".
4640 ;; Also a column groups row only contains "<", "<>", ">" or blank
4641 ;; cells.
4658 ;; There's a left border when previous cell, if
4659 ;; any, ends a group, or current one starts one.
4665 ;; There's a right border when next cell, if any,
4666 ;; starts a group, or current one ends one.
4673 ;; Table rows are read in reverse order so last column groups
4674 ;; row has precedence over any previous one.
4676 ;; Return value.
4677 borders))
4680 "Non-nil when TABLE-CELL is at the beginning of a column group.
4681 INFO is a plist used as a communication channel."
4682 ;; A cell starts a column group either when it is at the beginning
4683 ;; of a row (or after the special column, if any) or when it has
4684 ;; a left border.
4687 table-cell)
4691 "Non-nil when TABLE-CELL is at the end of a column group.
4692 INFO is a plist used as a communication channel."
4693 ;; A cell ends a column group either when it is at the end of a row
4694 ;; or when it has a right border.
4697 table-cell)
4701 "Non-nil when TABLE-ROW is at the beginning of a row group.
4702 INFO is a plist used as a communication channel."
4710 "Non-nil when TABLE-ROW is at the end of a row group.
4711 INFO is a plist used as a communication channel."
4719 "Non-nil when TABLE-ROW is the first table header's row.
4720 INFO is a plist used as a communication channel."
4727 "Non-nil when TABLE-ROW is the last table header's row.
4728 INFO is a plist used as a communication channel."
4735 "Return TABLE-ROW number.
4736 INFO is a plist used as a communication channel. Return value is
4737 zero-based and ignores separators. The function returns nil for
4738 special columns and separators."
4750 "Return TABLE dimensions.
4752 INFO is a plist used as a communication channel.
4754 Return value is a CONS like (ROWS . COLUMNS) where
4755 ROWS (resp. COLUMNS) is the number of exportable
4756 rows (resp. columns)."
4758 ;; Set number of rows, and extract first one.
4764 ;; Set number of columns.
4766 ;; Return value.
4770 "Return address of a regular TABLE-CELL object.
4772 TABLE-CELL is the cell considered. INFO is a plist used as
4773 a communication channel.
4775 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4776 zero-based index. Only exportable cells are considered. The
4777 function returns nil for other cells."
4789 "Return regular table-cell object at ADDRESS in TABLE.
4791 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4792 zero-based index. TABLE is a table type element. INFO is
4793 a plist used as a communication channel.
4795 If no table-cell, among exportable cells, is found at ADDRESS,
4796 return nil."
4799 ;; Row at (car address) or nil.
4807 'table-cell
4814 ;;;; For Tables Of Contents
4815 ;;
4816 ;; `org-export-collect-headlines' builds a list of all exportable
4817 ;; headline elements, maybe limited to a certain depth. One can then
4818 ;; easily parse it and transcode it.
4819 ;;
4820 ;; Building lists of tables, figures or listings is quite similar.
4821 ;; Once the generic function `org-export-collect-elements' is defined,
4822 ;; `org-export-collect-tables', `org-export-collect-figures' and
4823 ;; `org-export-collect-listings' can be derived from it.
4826 "Collect headlines in order to build a table of contents.
4828 INFO is a plist used as a communication channel.
4830 When optional argument N is an integer, it specifies the depth of
4831 the table of contents. Otherwise, it is set to the value of the
4832 last headline level. See `org-export-headline-levels' for more
4833 information.
4835 Return a list of all exportable headlines as parsed elements.
4836 Footnote sections, if any, will be ignored."
4844 info)))
4847 "Collect referenceable elements of a determined type.
4849 TYPE can be a symbol or a list of symbols specifying element
4850 types to search. Only elements with a caption are collected.
4852 INFO is a plist used as a communication channel.
4854 When non-nil, optional argument PREDICATE is a function accepting
4855 one argument, an element of type TYPE. It returns a non-nil
4856 value when that element should be collected.
4858 Return a list of all elements found, in order of appearance."
4863 element))
4864 info))
4867 "Build a list of tables.
4868 INFO is a plist used as a communication channel.
4870 Return a list of table elements with a caption."
4874 "Build a list of figures.
4876 INFO is a plist used as a communication channel. PREDICATE is
4877 a function which accepts one argument: a paragraph element and
4878 whose return value is non-nil when that element should be
4879 collected.
4881 A figure is a paragraph type element, with a caption, verifying
4883 a vague concept that may depend on back-end.
4885 Return a list of elements recognized as figures."
4889 "Build a list of src blocks.
4891 INFO is a plist used as a communication channel.
4893 Return a list of src-block elements with a caption."
4897 ;;;; Smart Quotes
4898 ;;
4899 ;; The main function for the smart quotes sub-system is
4900 ;; `org-export-activate-smart-quotes', which replaces every quote in
4901 ;; a given string from the parse tree with its "smart" counterpart.
4902 ;;
4903 ;; Dictionary for smart quotes is stored in
4904 ;; `org-export-smart-quotes-alist'.
4905 ;;
4906 ;; Internally, regexps matching potential smart quotes (checks at
4907 ;; string boundaries are also necessary) are defined in
4908 ;; `org-export-smart-quotes-regexps'.
4912 ;; one may use: »...«, "...", ›...‹, or '...'.
4913 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4914 ;; LaTeX quotes require Babel!
4959 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4968 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4977 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4986 ;; 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
4987 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
4998 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5004 )
5005 "Smart quotes translations.
5007 Alist whose CAR is a language string and CDR is an alist with
5008 quote type as key and a plist associating various encodings to
5009 their translation as value.
5011 A quote type can be any symbol among `opening-double-quote',
5012 `closing-double-quote', `opening-single-quote',
5013 `closing-single-quote' and `apostrophe'.
5015 Valid encodings include `:utf-8', `:html', `:latex' and
5016 `:texinfo'.
5022 ;; Possible opening quote at beginning of string.
5024 ;; Possible closing quote at beginning of string.
5026 ;; Possible apostrophe at beginning of string.
5028 ;; Opening single and double quotes.
5030 ;; Closing single and double quotes.
5032 ;; Apostrophe.
5034 ;; Possible opening quote at end of string.
5036 ;; Possible closing quote at end of string.
5038 ;; Possible apostrophe at end of string.
5040 "List of regexps matching a quote or an apostrophe.
5046 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5047 `:utf-8'. INFO is a plist used as a communication channel.
5049 The function has to retrieve information about string
5050 surroundings in parse tree. It can only happen with an
5051 unmodified string. Thus, if S has already been through another
5052 process, a non-nil ORIGINAL optional argument will provide that
5053 original string.
5055 Return the new string."
5058 ;; Try to be flexible when computing number of blanks
5059 ;; before object. The previous object may be a string
5060 ;; introduced by the back-end and not completely parsed.
5063 ;; A string with missing `:post-blank'
5064 ;; property.
5068 ;; Fallback value.
5073 ;; Return smart quote associated to a give quote Q, as
5074 ;; a string. TYPE is a symbol among `open', `close' and
5075 ;; `apostrophe'.
5085 org-export-smart-quotes-alist))))
5086 encoding)
5087 q)))))
5089 ;; Only a quote: no regexp can match. We have to check both
5090 ;; sides and decide what to do.
5098 ;; 1. Replace quote character at the beginning of S.
5100 ;; Apostrophe?
5106 ;; Closing quote?
5112 ;; Opening quote?
5118 ;; 2. Replace quotes in the middle of the string.
5120 ;; Opening quotes.
5126 ;; Closing quotes.
5132 ;; Apostrophes.
5137 ;; 3. Replace quote character at the end of S.
5139 ;; Apostrophe?
5144 ;; Closing quote?
5150 ;; Opening quote?
5155 ;; Return string with smart quotes.
5156 s))))
5158 ;;;; Topology
5159 ;;
5160 ;; Here are various functions to retrieve information about the
5161 ;; neighbourhood of a given element or object. Neighbours of interest
5162 ;; are direct parent (`org-export-get-parent'), parent headline
5163 ;; (`org-export-get-parent-headline'), first element containing an
5164 ;; object, (`org-export-get-parent-element'), parent table
5165 ;; (`org-export-get-parent-table'), previous element or object
5166 ;; (`org-export-get-previous-element') and next element or object
5167 ;; (`org-export-get-next-element').
5168 ;;
5169 ;; `org-export-get-genealogy' returns the full genealogy of a given
5170 ;; element or object, from closest parent to full parse tree.
5173 "Return full genealogy relative to a given element or object.
5175 BLOB is the element or object being considered.
5177 Ancestors are returned from closest to farthest, the last one
5178 being the full parse tree."
5185 "Return BLOB parent headline or nil.
5186 BLOB is the element or object being considered."
5190 parent))
5193 "Return first element containing OBJECT or nil.
5194 OBJECT is the object to consider."
5198 parent))
5201 "Return OBJECT parent table or nil.
5202 OBJECT is either a `table-cell' or `table-element' type object."
5206 parent))
5209 "Return previous element or object.
5211 BLOB is an element or object. INFO is a plist used as
5212 a communication channel. Return previous exportable element or
5213 object, a string, or nil.
5215 When optional argument N is a positive integer, return a list
5216 containing up to N siblings before BLOB, from farthest to
5217 closest. With any other non-nil value, return a list containing
5218 all of them."
5220 ;; An object can belong to the contents of its parent or
5221 ;; to a secondary string. We check the latter option
5222 ;; first.
5226 org-element-secondary-value-alist))
5227 parent)))
5230 prev)
5239 prev)))
5242 "Return next element or object.
5244 BLOB is an element or object. INFO is a plist used as
5245 a communication channel. Return next exportable element or
5246 object, a string, or nil.
5248 When optional argument N is a positive integer, return a list
5249 containing up to N siblings after BLOB, from closest to farthest.
5250 With any other non-nil value, return a list containing all of
5251 them."
5253 ;; An object can belong to the contents of its parent or to
5254 ;; a secondary string. We check the latter option first.
5258 org-element-secondary-value-alist))
5259 parent)))
5262 next)
5270 siblings)
5274 ;;;; Translation
5275 ;;
5276 ;; `org-export-translate' translates a string according to the language
5277 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5278 ;; the dictionary used for the translation.
5492 "Dictionary for export engine.
5494 Alist whose CAR is the string to translate and CDR is an alist
5495 whose CAR is the language string and CDR is a plist whose
5496 properties are possible charsets and values translated terms.
5498 It is used as a database for `org-export-translate'. Since this
5499 function returns the string as-is if no translation was found,
5500 the variable only needs to record values different from the
5504 "Translate string S according to language specification.
5506 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5507 and `:utf-8'. INFO is a plist used as a communication channel.
5509 Translation depends on `:language' property. Return the
5510 translated string. If no translation is found, try to fall back
5511 to `:default' encoding. If it fails, return S."
5517 s)))
5520 \f
5521 ;;; Asynchronous Export
5522 ;;
5523 ;; `org-export-async-start' is the entry point for asynchronous
5524 ;; export. It recreates current buffer (including visibility,
5525 ;; narrowing and visited file) in an external Emacs process, and
5526 ;; evaluates a command there. It then applies a function on the
5527 ;; returned results in the current process.
5528 ;;
5529 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5530 ;; allow to export to a buffer or a file, asynchronously or not.
5531 ;;
5532 ;; `org-export-output-file-name' is an auxiliary function meant to be
5533 ;; used with `org-export-to-file'. With a given extension, it tries
5534 ;; to provide a canonical file name to write export output to.
5535 ;;
5536 ;; Asynchronously generated results are never displayed directly.
5537 ;; Instead, they are stored in `org-export-stack-contents'. They can
5538 ;; then be retrieved by calling `org-export-stack'.
5539 ;;
5540 ;; Export Stack is viewed through a dedicated major mode
5541 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5542 ;;`org-export-stack-delete', `org-export-stack-view' and
5543 ;;`org-export-stack-clear'.
5544 ;;
5545 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5546 ;; It should be used whenever `org-export-async-start' is called.
5549 "Call function FUN on the results returned by BODY evaluation.
5551 BODY evaluation happens in an asynchronous process, from a buffer
5552 which is an exact copy of the current one.
5554 Use `org-export-add-to-stack' in FUN in order to register results
5555 in the stack.
5557 This is a low level function. See also `org-export-to-buffer'
5558 and `org-export-to-file' for more specialized functions."
5561 ;; Write the full sexp evaluating BODY in a copy of the current
5562 ;; buffer to a temporary file, as it may be too long for program
5563 ;; args in `start-process'.
5570 ;; Null characters (from variable values) are inserted
5571 ;; within the file. As a consequence, coding system for
5572 ;; buffer contents will not be recognized properly. So,
5573 ;; we make sure it is the same as the one used to display
5574 ;; the original buffer.
5576 ,coding
5579 ;; Ignore `kill-emacs-hook' and code evaluation
5580 ;; queries from Babel as we need a truly
5581 ;; non-interactive process.
5583 org-babel-confirm-evaluate-answer-no t)
5584 ;; Initialize export framework.
5586 ;; Re-create current buffer there.
5589 ;; Sexp to evaluate in the buffer.
5591 ;; Start external process.
5594 (,process
5596 #'start-process
5599 ,proc-buffer
5606 ;; Register running process in stack.
5608 ;; Set-up sentinel in order to catch results.
5611 ,process
5633 ;;;###autoload
5636 &optional async subtreep visible-only body-only ext-plist
5637 post-process)
5638 "Call `org-export-as' with output to a specified buffer.
5640 BACKEND is either an export back-end, as returned by, e.g.,
5641 `org-export-create-backend', or a symbol referring to
5642 a registered back-end.
5644 BUFFER is the name of the output buffer. If it already exists,
5645 it will be erased first, otherwise, it will be created.
5647 A non-nil optional argument ASYNC means the process should happen
5648 asynchronously. The resulting buffer should then be accessible
5649 through the `org-export-stack' interface. When ASYNC is nil, the
5650 buffer is displayed if `org-export-show-temporary-export-buffer'
5651 is non-nil.
5653 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5654 EXT-PLIST are similar to those used in `org-export-as', which
5655 see.
5657 Optional argument POST-PROCESS is a function which should accept
5658 no argument. It is always called within the current process,
5659 from BUFFER, with point at its beginning. Export back-ends can
5660 use it to set a major mode there, e.g,
5662 \(defun org-latex-export-as-latex
5663 \(&optional async subtreep visible-only body-only ext-plist)
5664 \(interactive)
5666 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5668 This function returns BUFFER."
5696 buffer)))
5698 ;;;###autoload
5701 post-process)
5702 "Call `org-export-as' with output to a specified file.
5704 BACKEND is either an export back-end, as returned by, e.g.,
5705 `org-export-create-backend', or a symbol referring to
5706 a registered back-end. FILE is the name of the output file, as
5707 a string.
5709 A non-nil optional argument ASYNC means the process should happen
5710 asynchronously. The resulting buffer file then be accessible
5711 through the `org-export-stack' interface.
5713 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5714 EXT-PLIST are similar to those used in `org-export-as', which
5715 see.
5717 Optional argument POST-PROCESS is called with FILE as its
5718 argument and happens asynchronously when ASYNC is non-nil. It
5719 has to return a file name, or nil. Export back-ends can use this
5720 to send the output file through additional processing, e.g,
5722 \(defun org-latex-export-to-latex
5723 \(&optional async subtreep visible-only body-only ext-plist)
5724 \(interactive)
5726 \(org-export-to-file 'latex outfile
5727 async subtreep visible-only body-only ext-plist
5728 \(lambda (file) (org-latex-compile file)))
5730 The function returns either a file name returned by POST-PROCESS,
5731 or FILE."
5749 backend subtreep visible-only body-only ext-plist)))
5756 ;; Get proper return value.
5758 file))))))
5761 "Return output file's name according to buffer specifications.
5763 EXTENSION is a string representing the output file extension,
5764 with the leading dot.
5766 With a non-nil optional argument SUBTREEP, try to determine
5768 of subtree at point.
5770 When optional argument PUB-DIR is set, use it as the publishing
5771 directory.
5773 When optional argument VISIBLE-ONLY is non-nil, don't export
5774 contents of hidden elements.
5776 Return file name as a string."
5779 ;; File name may come from EXPORT_FILE_NAME subtree
5780 ;; property, assuming point is at beginning of said
5781 ;; sub-tree.
5788 ;; File name may be extracted from buffer's associated
5789 ;; file, if any.
5791 ;; Can't determine file name on our own: Ask user.
5795 "Output file: " pub-dir nil nil nil
5799 ;; Build file name. Enforce EXTENSION over whatever user
5800 ;; may have come up with. PUB-DIR, if defined, always has
5801 ;; precedence over any provided path.
5806 extension))
5809 ;; If writing to OUTPUT-FILE would overwrite original file, append
5810 ;; EXTENSION another time to final name.
5813 output-file)))
5816 "Add a new result to export stack if not present already.
5818 SOURCE is a buffer or a file name containing export results.
5819 BACKEND is a symbol representing export back-end used to generate
5820 it.
5822 Entries already pointing to SOURCE and unavailable entries are
5823 removed beforehand. Return the new stack."
5829 "Menu for asynchronous export results and running processes."
5839 "Return source from export results at point in stack."
5846 source
5847 ;; SOURCE is not consistent with current line. The stack
5848 ;; view is outdated.
5852 "Remove all entries from export stack."
5857 "Refresh the asynchronous export stack.
5858 DUMMY is ignored. Unavailable sources are removed from the list.
5859 Return the new stack."
5869 ;; Back-end.
5871 ;; Age.
5874 ;; Compute age of the results.
5876 "%4h:%.2m "
5878 ;; Source.
5883 ;; Clear stack from exited processes, dead buffers or
5884 ;; non-existent files.
5896 "Remove export results at point from stack.
5897 If optional argument SOURCE is non-nil, remove it instead."
5902 org-export-stack-contents))))
5905 "View export results at point in stack.
5906 With an optional prefix argument IN-EMACS, force viewing files
5907 within Emacs."
5921 (define-key km "p" 'previous-line)
5922 (define-key km "\C-p" 'previous-line)
5923 (define-key km "\C-?" 'previous-line)
5924 (define-key km [up] 'previous-line)
5925 (define-key km "C" 'org-export-stack-clear)
5926 (define-key km "v" 'org-export-stack-view)
5927 (define-key km (kbd "RET") 'org-export-stack-view)
5928 (define-key km "d" 'org-export-stack-remove)
5929 km)
5930 "Keymap for Org Export Stack.")
5932 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5933 "Mode for displaying asynchronous export stack.
5936 stack.
5938 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5939 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5940 stack completely.
5942 Removing entries in an Org Export Stack buffer doesn't affect
5943 files or buffers, only the display.
5946 (abbrev-mode 0)
5947 (auto-fill-mode 0)
5948 (setq buffer-read-only t
5949 buffer-undo-list t
5950 truncate-lines t
5951 header-line-format
5952 '(:eval
5953 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5954 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5955 (set (make-local-variable 'revert-buffer-function)
5956 'org-export-stack-refresh))
5959 \f
5960 ;;; The Dispatcher
5961 ;;
5962 ;; `org-export-dispatch' is the standard interactive way to start an
5963 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5964 ;; for its interface, which, in turn, delegates response to key
5965 ;; pressed to `org-export--dispatch-action'.
5967 ;;;###autoload
5968 (defun org-export-dispatch (&optional arg)
5969 "Export dispatcher for Org mode.
5971 It provides an access to common export related tasks in a buffer.
5972 Its interface comes in two flavors: standard and expert.
5974 While both share the same set of bindings, only the former
5975 displays the valid keys associations in a dedicated buffer.
5976 Scrolling (resp. line-wise motion) in this buffer is done with
5977 SPC and DEL (resp. C-n and C-p) keys.
5979 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5980 flavor or the other.
5983 of options used back then, on the current buffer.
5985 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5986 (interactive "P")
5987 (let* ((input
5988 (cond ((equal arg '(16)) '(stack))
5989 ((and arg org-export-dispatch-last-action))
5990 (t (save-window-excursion
5991 (unwind-protect
5992 (progn
5993 ;; Remember where we are
5994 (move-marker org-export-dispatch-last-position
5995 (point)
5996 (org-base-buffer (current-buffer)))
5997 ;; Get and store an export command
5998 (setq org-export-dispatch-last-action
5999 (org-export--dispatch-ui
6000 (list org-export-initial-scope
6001 (and org-export-in-background 'async))
6002 nil
6003 org-export-dispatch-use-expert-ui)))
6004 (and (get-buffer "*Org Export Dispatcher*")
6005 (kill-buffer "*Org Export Dispatcher*")))))))
6006 (action (car input))
6007 (optns (cdr input)))
6008 (unless (memq 'subtree optns)
6009 (move-marker org-export-dispatch-last-position nil))
6010 (case action
6011 ;; First handle special hard-coded actions.
6012 (template (org-export-insert-default-template nil optns))
6013 (stack (org-export-stack))
6014 (publish-current-file
6015 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6016 (publish-current-project
6017 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6018 (publish-choose-project
6019 (org-publish (assoc (org-icompleting-read
6020 "Publish project: "
6021 org-publish-project-alist nil t)
6022 org-publish-project-alist)
6023 (memq 'force optns)
6024 (memq 'async optns)))
6025 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6026 (otherwise
6027 (save-excursion
6028 (when arg
6029 ;; Repeating command, maybe move cursor to restore subtree
6030 ;; context.
6031 (if (eq (marker-buffer org-export-dispatch-last-position)
6032 (org-base-buffer (current-buffer)))
6033 (goto-char org-export-dispatch-last-position)
6034 ;; We are in a different buffer, forget position.
6035 (move-marker org-export-dispatch-last-position nil)))
6036 (funcall action
6037 ;; Return a symbol instead of a list to ease
6038 ;; asynchronous export macro use.
6039 (and (memq 'async optns) t)
6040 (and (memq 'subtree optns) t)
6041 (and (memq 'visible optns) t)
6042 (and (memq 'body optns) t)))))))
6044 (defun org-export--dispatch-ui (options first-key expertp)
6045 "Handle interface for `org-export-dispatch'.
6047 OPTIONS is a list containing current interactive options set for
6048 export. It can contain any of the following symbols:
6049 `body' toggles a body-only export
6050 `subtree' restricts export to current subtree
6051 `visible' restricts export to visible part of buffer.
6052 `force' force publishing files.
6053 `async' use asynchronous export process
6055 FIRST-KEY is the key pressed to select the first level menu. It
6056 is nil when this menu hasn't been selected yet.
6058 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6059 buffer is provided, but indications about currently active
6060 options are given in the prompt. Moreover, \[?] allows to switch
6061 back to standard interface."
6062 (let* ((fontify-key
6063 (lambda (key &optional access-key)
6064 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6065 ;; non-nil is the required first-level key to activate
6066 ;; KEY. When its value is t, activate KEY independently
6067 ;; on the first key, if any. A nil value means KEY will
6068 ;; only be activated at first level.
6069 (if (or (eq access-key t) (eq access-key first-key))
6070 (org-propertize key 'face 'org-warning)
6071 key)))
6072 (fontify-value
6073 (lambda (value)
6074 ;; Fontify VALUE string.
6075 (org-propertize value 'face 'font-lock-variable-name-face)))
6076 ;; Prepare menu entries by extracting them from registered
6077 ;; back-ends and sorting them by access key and by ordinal,
6078 ;; if any.
6079 (entries
6080 (sort (sort (delq nil
6081 (mapcar 'org-export-backend-menu
6082 org-export--registered-backends))
6083 (lambda (a b)
6084 (let ((key-a (nth 1 a))
6085 (key-b (nth 1 b)))
6086 (cond ((and (numberp key-a) (numberp key-b))
6087 (< key-a key-b))
6088 ((numberp key-b) t)))))
6089 'car-less-than-car))
6090 ;; Compute a list of allowed keys based on the first key
6091 ;; pressed, if any. Some keys
6092 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6093 ;; available.
6094 (allowed-keys
6095 (nconc (list 2 22 19 6 1)
6096 (if (not first-key) (org-uniquify (mapcar 'car entries))
6097 (let (sub-menu)
6098 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6099 (when (eq (car entry) first-key)
6100 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6101 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6102 ((not first-key) (list ?P)))
6103 (list ?& ?#)
6104 (when expertp (list ??))
6105 (list ?q)))
6106 ;; Build the help menu for standard UI.
6107 (help
6108 (unless expertp
6109 (concat
6110 ;; Options are hard-coded.
6111 (format "[%s] Body only: %s [%s] Visible only: %s
6112 \[%s] Export scope: %s [%s] Force publishing: %s
6114 (funcall fontify-key "C-b" t)
6115 (funcall fontify-value
6116 (if (memq 'body options) "On " "Off"))
6117 (funcall fontify-key "C-v" t)
6118 (funcall fontify-value
6119 (if (memq 'visible options) "On " "Off"))
6120 (funcall fontify-key "C-s" t)
6121 (funcall fontify-value
6122 (if (memq 'subtree options) "Subtree" "Buffer "))
6123 (funcall fontify-key "C-f" t)
6124 (funcall fontify-value
6125 (if (memq 'force options) "On " "Off"))
6126 (funcall fontify-key "C-a" t)
6127 (funcall fontify-value
6128 (if (memq 'async options) "On " "Off")))
6129 ;; Display registered back-end entries. When a key
6130 ;; appears for the second time, do not create another
6131 ;; entry, but append its sub-menu to existing menu.
6132 (let (last-key)
6133 (mapconcat
6134 (lambda (entry)
6135 (let ((top-key (car entry)))
6136 (concat
6137 (unless (eq top-key last-key)
6138 (setq last-key top-key)
6140 (funcall fontify-key (char-to-string top-key))
6141 (nth 1 entry)))
6142 (let ((sub-menu (nth 2 entry)))
6143 (unless (functionp sub-menu)
6144 ;; Split sub-menu into two columns.
6145 (let ((index -1))
6146 (concat
6147 (mapconcat
6148 (lambda (sub-entry)
6149 (incf index)
6150 (format
6151 (if (zerop (mod index 2)) " [%s] %-26s"
6153 (funcall fontify-key
6154 (char-to-string (car sub-entry))
6155 top-key)
6156 (nth 1 sub-entry)))
6157 sub-menu "")
6159 entries ""))
6160 ;; Publishing menu is hard-coded.
6162 [%s] Current file [%s] Current project
6164 (funcall fontify-key "P")
6165 (funcall fontify-key "f" ?P)
6166 (funcall fontify-key "p" ?P)
6167 (funcall fontify-key "x" ?P)
6168 (funcall fontify-key "a" ?P))
6170 (funcall fontify-key "&" t)
6171 (funcall fontify-key "#" t))
6172 (format "[%s] %s"
6173 (funcall fontify-key "q" t)
6174 (if first-key "Main menu" "Exit")))))
6175 ;; Build prompts for both standard and expert UI.
6176 (standard-prompt (unless expertp "Export command: "))
6177 (expert-prompt
6178 (when expertp
6179 (format
6180 "Export command (C-%s%s%s%s%s) [%s]: "
6181 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6182 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6183 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6184 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6185 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6186 (mapconcat (lambda (k)
6187 ;; Strip control characters.
6188 (unless (< k 27) (char-to-string k)))
6189 allowed-keys "")))))
6190 ;; With expert UI, just read key with a fancy prompt. In standard
6191 ;; UI, display an intrusive help buffer.
6192 (if expertp
6193 (org-export--dispatch-action
6194 expert-prompt allowed-keys entries options first-key expertp)
6195 ;; At first call, create frame layout in order to display menu.
6196 (unless (get-buffer "*Org Export Dispatcher*")
6197 (delete-other-windows)
6198 (org-switch-to-buffer-other-window
6199 (get-buffer-create "*Org Export Dispatcher*"))
6200 (setq cursor-type nil
6201 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6202 ;; Make sure that invisible cursor will not highlight square
6203 ;; brackets.
6204 (set-syntax-table (copy-syntax-table))
6205 (modify-syntax-entry ?\[ "w"))
6206 ;; At this point, the buffer containing the menu exists and is
6207 ;; visible in the current window. So, refresh it.
6208 (with-current-buffer "*Org Export Dispatcher*"
6209 ;; Refresh help. Maintain display continuity by re-visiting
6210 ;; previous window position.
6211 (let ((pos (window-start)))
6212 (erase-buffer)
6213 (insert help)
6214 (set-window-start nil pos)))
6215 (org-fit-window-to-buffer)
6216 (org-export--dispatch-action
6217 standard-prompt allowed-keys entries options first-key expertp))))
6219 (defun org-export--dispatch-action
6220 (prompt allowed-keys entries options first-key expertp)
6221 "Read a character from command input and act accordingly.
6223 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6224 a list of characters available at a given step in the process.
6225 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6226 EXPERTP are the same as defined in `org-export--dispatch-ui',
6227 which see.
6229 Toggle export options when required. Otherwise, return value is
6230 a list with action as CAR and a list of interactive export
6231 options as CDR."
6232 (let (key)
6233 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6234 ;; C-p, SPC, DEL).
6235 (while (and (setq key (read-char-exclusive prompt))
6236 (not expertp)
6237 (memq key '(14 16 ?\s ?\d)))
6238 (case key
6239 (14 (if (not (pos-visible-in-window-p (point-max)))
6240 (ignore-errors (scroll-up 1))
6241 (message "End of buffer")
6242 (sit-for 1)))
6243 (16 (if (not (pos-visible-in-window-p (point-min)))
6244 (ignore-errors (scroll-down 1))
6245 (message "Beginning of buffer")
6246 (sit-for 1)))
6247 (?\s (if (not (pos-visible-in-window-p (point-max)))
6248 (scroll-up nil)
6249 (message "End of buffer")
6250 (sit-for 1)))
6251 (?\d (if (not (pos-visible-in-window-p (point-min)))
6252 (scroll-down nil)
6253 (message "Beginning of buffer")
6254 (sit-for 1)))))
6255 (cond
6256 ;; Ignore undefined associations.
6257 ((not (memq key allowed-keys))
6258 (ding)
6259 (unless expertp (message "Invalid key") (sit-for 1))
6260 (org-export--dispatch-ui options first-key expertp))
6261 ;; q key at first level aborts export. At second level, cancel
6262 ;; first key instead.
6263 ((eq key ?q) (if (not first-key) (error "Export aborted")
6264 (org-export--dispatch-ui options nil expertp)))
6265 ;; Help key: Switch back to standard interface if expert UI was
6266 ;; active.
6267 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6268 ;; Send request for template insertion along with export scope.
6269 ((eq key ?#) (cons 'template (memq 'subtree options)))
6270 ;; Switch to asynchronous export stack.
6271 ((eq key ?&) '(stack))
6272 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6273 ((memq key '(2 22 19 6 1))
6274 (org-export--dispatch-ui
6275 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6276 (6 'force) (1 'async))))
6277 (if (memq option options) (remq option options)
6278 (cons option options)))
6279 first-key expertp))
6280 ;; Action selected: Send key and options back to
6281 ;; `org-export-dispatch'.
6282 ((or first-key (functionp (nth 2 (assq key entries))))
6283 (cons (cond
6284 ((not first-key) (nth 2 (assq key entries)))
6285 ;; Publishing actions are hard-coded. Send a special
6286 ;; signal to `org-export-dispatch'.
6287 ((eq first-key ?P)
6288 (case key
6289 (?f 'publish-current-file)
6290 (?p 'publish-current-project)
6291 (?x 'publish-choose-project)
6292 (?a 'publish-all)))
6293 ;; Return first action associated to FIRST-KEY + KEY
6294 ;; path. Indeed, derived backends can share the same
6295 ;; FIRST-KEY.
6296 (t (catch 'found
6297 (mapc (lambda (entry)
6298 (let ((match (assq key (nth 2 entry))))
6299 (when match (throw 'found (nth 2 match)))))
6300 (member (assq first-key entries) entries)))))
6301 options))
6302 ;; Otherwise, enter sub-menu.
6303 (t (org-export--dispatch-ui options key expertp)))))
6307 (provide 'ox)
6309 ;; Local variables:
6310 ;; generated-autoload-file: "org-loaddefs.el"
6311 ;; End:
6313 ;;; ox.el ends here