| blob | fcf6aab20698f6049c48f03c5725aa3f7caaa85a |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists in a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place. The exhaustive list
35 ;; of properties is given in "The Communication Channel" section of
36 ;; this file.
37 ;;
38 ;; - The transcoder walks the parse tree, ignores or treat as plain
39 ;; text elements and objects according to export options, and
40 ;; eventually calls back-end specific functions to do the real
41 ;; transcoding, concatenating their return value along the way.
42 ;;
43 ;; - The filter system is activated at the very beginning and the very
44 ;; end of the export process, and each time an element or an object
45 ;; has been converted. It is the entry point to fine-tune standard
46 ;; output from back-end transcoders. See "The Filter System"
47 ;; section for more information.
48 ;;
49 ;; The core function is `org-export-as'. It returns the transcoded
50 ;; buffer as a string.
51 ;;
52 ;; An export back-end is defined with `org-export-define-backend'.
53 ;; This function can also support specific buffer keywords, OPTION
54 ;; keyword's items and filters. Refer to function's documentation for
55 ;; more information.
56 ;;
57 ;; If the new back-end shares most properties with another one,
58 ;; `org-export-define-derived-backend' can be used to simplify the
59 ;; process.
60 ;;
61 ;; Any back-end can define its own variables. Among them, those
62 ;; customizable should belong to the `org-export-BACKEND' group.
63 ;;
64 ;; Tools for common tasks across back-ends are implemented in the
65 ;; following part of the file.
66 ;;
67 ;; Then, a wrapper macro for asynchronous export,
68 ;; `org-export-async-start', along with tools to display results. are
69 ;; given in the penultimate part.
70 ;;
71 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
72 ;; back-ends is provided in the last one.
74 ;;; Code:
93 \f
94 ;;; Internal Variables
95 ;;
96 ;; Among internal variables, the most important is
97 ;; `org-export-options-alist'. This variable define the global export
98 ;; options, shared between every exporter, and how they are acquired.
143 "Alist between export properties and ways to set them.
145 The CAR of the alist is the property name, and the CDR is a list
146 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
148 KEYWORD is a string representing a buffer keyword, or nil. Each
149 property defined this way can also be set, during subtree
150 export, through a headline property named after the keyword
152 property).
153 OPTION is a string that could be found in an #+OPTIONS: line.
154 DEFAULT is the default value for the property.
155 BEHAVIOR determines how Org should handle multiple keywords for
156 the same property. It is a symbol among:
157 nil Keep old value and discard the new one.
158 t Replace old value with the new one.
159 `space' Concatenate the values, separating them with a space.
160 `newline' Concatenate the values, separating them with
161 a newline.
162 `split' Split values at white spaces, and cons them to the
163 previous list.
165 Values set through KEYWORD and OPTION have precedence over
166 DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
262 "Non-nil means asynchronous export process should leave data behind.
266 located in `temporary-file-directory'.
268 When non-nil, it will also set `debug-on-error' to a non-nil
272 "Record asynchronously generated export results and processes.
273 This is an alist: its CAR is the source of the
274 result (destination file or buffer for a finished process,
275 original buffer for a running one) and its CDR is a list
276 containing the back-end used, as a symbol, and either a process
277 or the time at which it finished. It is used to build the menu
281 "List of backends currently available in the exporter.
282 This variable is set with `org-export-define-backend' and
286 "Last command called from the dispatcher.
287 The value should be a list. Its CAR is the action, as a symbol,
291 "The position where the last export command was created using the dispatcher.
292 This marker will be used with `C-u C-c C-e' to make sure export repetition
295 ;; For compatibility with Org < 8
297 "Name, if any, of the back-end used during an export process.
299 Its value is a symbol such as `html', `latex', `ascii', or nil if
300 the back-end is anonymous (see `org-export-create-backend') or if
301 there is no export process in progress.
303 It can be used to teach Babel blocks how to act differently
306 \f
307 ;;; User-configurable Variables
308 ;;
309 ;; Configuration for the masses.
310 ;;
311 ;; They should never be accessed directly, as their value is to be
312 ;; stored in a property list (cf. `org-export-options-alist').
313 ;; Back-ends will read their value from there instead.
316 "Options for exporting Org mode files."
321 "General options for export engine."
326 "Whether sub-trees with the ARCHIVE tag should be exported.
328 This can have three different values:
329 nil Do not export, pretend this tree is not present.
330 t Do export the entire tree.
331 `headline' Only export the headline, but skip the tree below it.
333 This option can also be set with the OPTIONS keyword,
342 "Non-nil means insert author name into the exported file.
343 This option can also be set with the OPTIONS keyword,
349 "Non-nil means export CLOCK keywords.
350 This option can also be set with the OPTIONS keyword,
356 "Non-nil means the postamble should contain a creator sentence.
358 The sentence can be set in `org-export-creator-string' and
361 If the value is `comment' insert it as a comment."
369 "Non-nil means insert date in the exported document.
370 This option can also be set with the OPTIONS keyword,
376 "Time-stamp format string to use for DATE keyword.
378 The format string, when specified, only applies if date consists
379 in a single time-stamp. Otherwise its value will be ignored.
381 See `format-time-string' for details on how to build this
382 string."
390 emacs-version
392 "Information about the creator of the document.
393 This option can also be set on with the CREATOR keyword."
398 "Non-nil means export contents of standard drawers.
400 When t, all drawers are exported. This may also be a list of
401 drawer names to export. If that list starts with `not', only
402 drawers with such names will be ignored.
404 This variable doesn't apply to properties drawers.
406 This option can also be set with the OPTIONS keyword,
419 :inline t
423 "Non-nil means insert author email into the exported file.
424 This option can also be set with the OPTIONS keyword,
430 "Non-nil means interpret *word*, /word/, _word_ and +word+.
432 If the export target supports emphasizing text, the word will be
433 typeset in bold, italic, with an underline or strike-through,
434 respectively.
436 This option can also be set with the OPTIONS keyword,
442 "Tags that exclude a tree from export.
444 All trees carrying any of these tags will be excluded from
445 export. This is without condition, so even subtrees inside that
446 carry one of the `org-export-select-tags' will be removed.
448 This option can also be set with the EXCLUDE_TAGS keyword."
455 This can be used to have pre-formatted text, fragments of code
456 etc. For example:
457 : ;; Some Lisp examples
458 : (while (defc cnt)
459 : (ding))
460 will be looking just like this in also HTML. See also the QUOTE
461 keyword. Not all export backends support this.
463 This option can also be set with the OPTIONS keyword,
469 "Non-nil means Org footnotes should be exported.
470 This option can also be set with the OPTIONS keyword,
476 "Non-nil means process LaTeX environments and fragments.
478 This option can also be set with the OPTIONS line,
481 nil Ignore math snippets.
482 `verbatim' Keep everything in verbatim.
483 t Allow export of math snippets."
493 "The last level which is still exported as a headline.
495 Inferior levels will usually produce itemize or enumerate lists
496 when exported, but back-end behaviour may differ.
498 This option can also be set with the OPTIONS keyword,
504 "The default language for export and clocktable translations, as a string.
505 This may have an association in
506 `org-clock-clocktable-language-setup',
507 `org-export-smart-quotes-alist' and `org-export-dictionary'.
508 This option can also be set with the LANGUAGE keyword."
513 "Non-nil means preserve all line breaks when exporting.
514 This option can also be set with the OPTIONS keyword,
520 "Non-nil means interpret entities when exporting.
523 Å.
525 For a list of supported names, see the constant `org-entities'
526 and the user option `org-entities-user'.
528 This option can also be set with the OPTIONS keyword,
534 "Non-nil means inlinetasks should be exported.
535 This option can also be set with the OPTIONS keyword,
543 "Non-nil means include planning info in export.
545 Planning info is the line containing either SCHEDULED:,
546 DEADLINE:, CLOSED: time-stamps, or a combination of them.
548 This option can also be set with the OPTIONS keyword,
556 "Non-nil means include priority cookies in export.
557 This option can also be set with the OPTIONS keyword,
563 "Non-nil means add section numbers to headlines when exporting.
565 When set to an integer n, numbering will only happen for
566 headlines whose relative level is higher or equal to n.
568 This option can also be set with the OPTIONS keyword,
574 "Tags that select a tree for export.
576 If any such tag is found in a buffer, all trees that do not carry
577 one of these tags will be ignored during export. Inside trees
578 that are selected like this, you can still deselect a subtree by
579 tagging it with one of the `org-export-exclude-tags'.
581 This option can also be set with the SELECT_TAGS keyword."
586 "Non-nil means activate smart quotes during export.
587 This option can also be set with the OPTIONS keyword,
590 When setting this to non-nil, you need to take care of
591 using the correct Babel package when exporting to LaTeX.
592 E.g., you can load Babel for french like this:
603 When this option is turned on, these strings will be exported as:
605 Org HTML LaTeX UTF-8
606 -----+----------+--------+-------
608 -- – -- –
609 --- — --- —
612 This option can also be set with the OPTIONS keyword,
618 "Non-nil means include statistics cookies in export.
619 This option can also be set with the OPTIONS keyword,
629 If you want to control how Org displays those characters, see
630 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
631 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
632 it is not anymore.
634 When this option is turned on, you can use TeX-like syntax for
635 sub- and superscripts and see them exported correctly.
637 You can also set the option with #+OPTIONS: ^:t
640 single item - so grouping with {} is normally not needed. For
641 example, the following things will be parsed as single sub- or
642 superscripts:
644 10^24 or 10^tau several digits will be considered 1 item.
645 10^-12 or 10^-tau a leading sign with digits or a word
646 x^2-y^3 will be read as x^2 - y^3, because items are
647 terminated by almost any nonword/nondigit char.
648 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
650 Still, ambiguity is possible. So when in doubt, use {} to enclose
651 the sub/superscript. If you set this variable to the symbol `{}',
652 the braces are *required* in order to trigger interpretations as
654 frequently in plain text."
664 "Non-nil means create a table of contents in exported files.
666 The TOC contains headlines with levels up
667 to`org-export-headline-levels'. When an integer, include levels
668 up to N in the toc, this may then be different from
669 `org-export-headline-levels', but it will not be allowed to be
670 larger than the number of headline levels. When nil, no table of
671 contents is made.
673 This option can also be set with the OPTIONS keyword,
683 For example:
685 | Name | Address | Birthday |
686 |-------------+----------+-----------|
687 | Arthur Dent | England | 29.2.2100 |
689 This option can also be set with the OPTIONS keyword,
695 "If nil, do not export tags, just remove them from headlines.
697 If this is the symbol `not-in-toc', tags will be removed from
698 table of contents entries, but still be shown in the headlines of
699 the document.
701 This option can also be set with the OPTIONS keyword,
710 "Non-nil means include TODO items for export.
712 This may have the following values:
713 t include tasks independent of state.
714 `todo' include only tasks that are not yet done.
715 `done' include only tasks that are already done.
716 nil ignore all tasks.
717 list of keywords include tasks with these keywords.
719 This option can also be set with the OPTIONS keyword,
731 "Non-nil means insert a time stamp into the exported file.
732 The time stamp shows when the file was created. This option can
738 "Non nil means allow timestamps in export.
740 It can be set to any of the following values:
741 t export all timestamps.
742 `active' export active timestamps only.
743 `inactive' export inactive timestamps only.
744 nil do not export timestamps
746 This only applies to timestamps isolated in a paragraph
747 containing only timestamps. Other timestamps are always
748 exported.
750 This option can also be set with the OPTIONS keyword, e.g.
760 "Non-nil means include TODO keywords in export.
761 When nil, remove all these keywords from the export. This option
767 "Non-nil means BIND keywords can define local variable values.
768 This is a potential security risk, which is why the default value
769 is nil. You can also allow them through local buffer variables."
776 "Alist between export snippets back-ends and exporter back-ends.
778 This variable allows to provide shortcuts for export snippets.
782 HTML code while every other back-end will ignore it."
791 "Coding system for the exported file."
798 "Should we push exported content to the kill ring?"
807 "The initial scope when exporting with `org-export-dispatch'.
808 This variable can be either set to `buffer' or `subtree'."
815 "Non-nil means show buffer after exporting to temp buffer.
816 When Org exports to a file, the buffer visiting that file is ever
817 shown, but remains buried. However, when exporting to
818 a temporary buffer, that buffer is popped up in a second window.
819 When this variable is nil, the buffer remains buried also in
820 these cases."
825 "Non-nil means export and publishing commands will run in background.
826 Results from an asynchronous export are never displayed
834 "File used to initialize external export process.
835 Value must be an absolute file name. It defaults to user's
836 initialization file. Though, a specific configuration makes the
837 process faster and the export more portable."
844 "Non-nil means using a non-intrusive `org-export-dispatch'.
845 In that case, no help buffer is displayed. Though, an indicator
851 asynchronous). Also, \[?] allows to switch back to standard
852 mode."
859 \f
860 ;;; Defining Back-ends
861 ;;
862 ;; An export back-end is a structure with `org-export-backend' type
863 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
864 ;; and `menu' slots.
865 ;;
866 ;; At the lowest level, a back-end is created with
867 ;; `org-export-create-backend' function.
868 ;;
869 ;; A named back-end can be registered with
870 ;; `org-export-register-backend' function. A registered back-end can
871 ;; later be referred to by its name, with `org-export-get-backend'
872 ;; function. Also, such a back-end can become the parent of a derived
873 ;; back-end from which slot values will be inherited by default.
874 ;; `org-export-derived-backend-p' can check if a given back-end is
875 ;; derived from a list of back-end names.
876 ;;
877 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
878 ;; `org-export-get-all-filters' return the full alist of transcoders,
879 ;; options and filters, including those inherited from ancestors.
880 ;;
881 ;; At a higher level, `org-export-define-backend' is the standard way
882 ;; to define an export back-end. If the new back-end is similar to
883 ;; a registered back-end, `org-export-define-derived-backend' may be
884 ;; used instead.
885 ;;
886 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
887 ;; when a given back-end hasn't been registered yet.
891 name parent transcoders options filters blocks menu)
894 "Return export back-end named after NAME.
895 NAME is a symbol. Return nil if no such back-end is found."
902 "Register BACKEND as a known export back-end.
903 BACKEND is a structure with `org-export-backend' type."
904 ;; Refuse to register an unnamed back-end.
907 ;; Refuse to register a back-end with an unknown parent.
911 ;; Register dedicated export blocks in the parser.
915 ;; If a back-end with the same name as BACKEND is already
916 ;; registered, replace it with BACKEND. Otherwise, simply add
917 ;; BACKEND to the list of registered back-ends.
923 "Signal an error if BACKEND isn't defined."
928 "Non-nil if BACKEND is derived from one of BACKENDS.
929 BACKEND is an export back-end, as returned by, e.g.,
930 `org-export-create-backend', or a symbol referring to
931 a registered back-end. BACKENDS is constituted of symbols."
943 "Return full translation table for BACKEND.
945 BACKEND is an export back-end, as return by, e.g,,
946 `org-export-create-backend'. Return value is an alist where
947 keys are element or object types, as symbols, and values are
948 transcoders.
950 Unlike to `org-export-backend-transcoders', this function
951 also returns transcoders inherited from parent back-ends,
952 if any."
956 parent)
961 transcoders)))
964 "Return export options for BACKEND.
966 BACKEND is an export back-end, as return by, e.g,,
967 `org-export-create-backend'. See `org-export-options-alist'
968 for the shape of the return value.
970 Unlike to `org-export-backend-options', this function also
971 returns options inherited from parent back-ends, if any."
975 parent)
979 options)))
982 "Return complete list of filters for BACKEND.
984 BACKEND is an export back-end, as return by, e.g,,
985 `org-export-create-backend'. Return value is an alist where
986 keys are symbols and values lists of functions.
988 Unlike to `org-export-backend-filters', this function also
989 returns filters inherited from parent back-ends, if any."
993 parent)
997 filters)))
1000 "Define a new back-end BACKEND.
1002 TRANSCODERS is an alist between object or element types and
1003 functions handling them.
1005 These functions should return a string without any trailing
1006 space, or nil. They must accept three arguments: the object or
1007 element itself, its contents or nil when it isn't recursive and
1008 the property list used as a communication channel.
1010 Contents, when not nil, are stripped from any global indentation
1011 \(although the relative one is preserved). They also always end
1012 with a single newline character.
1014 If, for a given type, no function is found, that element or
1015 object type will simply be ignored, along with any blank line or
1016 white space at its end. The same will happen if the function
1017 returns the nil value. If that function returns the empty
1018 string, the type will be ignored, but the blank lines or white
1019 spaces will be kept.
1021 In addition to element and object types, one function can be
1022 associated to the `template' (or `inner-template') symbol and
1023 another one to the `plain-text' symbol.
1025 The former returns the final transcoded string, and can be used
1026 to add a preamble and a postamble to document's body. It must
1027 accept two arguments: the transcoded string and the property list
1028 containing export options. A function associated to `template'
1030 A function associated to `inner-template' is always applied.
1032 The latter, when defined, is to be called on every text not
1033 recognized as an element or an object. It must accept two
1034 arguments: the text string and the information channel. It is an
1035 appropriate place to protect special chars relative to the
1036 back-end.
1038 BODY can start with pre-defined keyword arguments. The following
1039 keywords are understood:
1041 :export-block
1043 String, or list of strings, representing block names that
1044 will not be parsed. This is used to specify blocks that will
1045 contain raw code specific to the back-end. These blocks
1046 still have to be handled by the relative `export-block' type
1047 translator.
1049 :filters-alist
1051 Alist between filters and function, or list of functions,
1052 specific to the back-end. See `org-export-filters-alist' for
1053 a list of all allowed filters. Filters defined here
1054 shouldn't make a back-end test, as it may prevent back-ends
1055 derived from this one to behave properly.
1057 :menu-entry
1059 Menu entry for the export dispatcher. It should be a list
1060 like:
1062 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1064 where :
1066 KEY is a free character selecting the back-end.
1068 DESCRIPTION-OR-ORDINAL is either a string or a number.
1070 If it is a string, is will be used to name the back-end in
1071 its menu entry. If it is a number, the following menu will
1072 be displayed as a sub-menu of the back-end with the same
1073 KEY. Also, the number will be used to determine in which
1074 order such sub-menus will appear (lowest first).
1076 ACTION-OR-MENU is either a function or an alist.
1078 If it is an action, it will be called with four
1079 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1080 BODY-ONLY. See `org-export-as' for further explanations on
1081 some of them.
1083 If it is an alist, associations should follow the
1084 pattern:
1086 '(KEY DESCRIPTION ACTION)
1088 where KEY, DESCRIPTION and ACTION are described above.
1090 Valid values include:
1094 or
1099 \(lambda (a s v b)
1100 \(if a (org-latex-export-to-pdf t s v b)
1101 \(org-open-file
1102 \(org-latex-export-to-pdf nil s v b)))))))
1104 or the following, which will be added to the previous
1105 sub-menu,
1107 '(?l 1
1111 :options-alist
1113 Alist between back-end specific properties introduced in
1114 communication channel and how their value are acquired. See
1115 `org-export-options-alist' for more information about
1116 structure of the values."
1130 :transcoders transcoders
1131 :options options
1132 :filters filters
1133 :blocks blocks
1137 "Create a new back-end as a variant of an existing one.
1139 CHILD is the name of the derived back-end. PARENT is the name of
1140 the parent back-end.
1142 BODY can start with pre-defined keyword arguments. The following
1143 keywords are understood:
1145 :export-block
1147 String, or list of strings, representing block names that
1148 will not be parsed. This is used to specify blocks that will
1149 contain raw code specific to the back-end. These blocks
1150 still have to be handled by the relative `export-block' type
1151 translator.
1153 :filters-alist
1155 Alist of filters that will overwrite or complete filters
1156 defined in PARENT back-end. See `org-export-filters-alist'
1157 for a list of allowed filters.
1159 :menu-entry
1161 Menu entry for the export dispatcher. See
1162 `org-export-define-backend' for more information about the
1163 expected value.
1165 :options-alist
1167 Alist of back-end specific properties that will overwrite or
1168 complete those defined in PARENT back-end. Refer to
1169 `org-export-options-alist' for more information about
1170 structure of the values.
1172 :translate-alist
1174 Alist of element and object types and transcoders that will
1175 overwrite or complete transcode table from PARENT back-end.
1176 Refer to `org-export-define-backend' for detailed information
1177 about transcoders.
1180 as a variant of `latex' back-end with a custom template function:
1182 \(org-export-define-derived-backend 'my-latex 'latex
1183 :translate-alist '((template . my-latex-template-fun)))
1185 The back-end could then be called with, for example:
1202 :parent parent
1203 :transcoders transcoders
1204 :options options
1205 :filters filters
1206 :blocks blocks
1210 \f
1211 ;;; The Communication Channel
1212 ;;
1213 ;; During export process, every function has access to a number of
1214 ;; properties. They are of two types:
1215 ;;
1216 ;; 1. Environment options are collected once at the very beginning of
1217 ;; the process, out of the original buffer and configuration.
1218 ;; Collecting them is handled by `org-export-get-environment'
1219 ;; function.
1220 ;;
1221 ;; Most environment options are defined through the
1222 ;; `org-export-options-alist' variable.
1223 ;;
1224 ;; 2. Tree properties are extracted directly from the parsed tree,
1225 ;; just before export, by `org-export-collect-tree-properties'.
1226 ;;
1227 ;; Here is the full list of properties available during transcode
1228 ;; process, with their category and their value type.
1229 ;;
1230 ;; + `:author' :: Author's name.
1231 ;; - category :: option
1232 ;; - type :: string
1233 ;;
1234 ;; + `:back-end' :: Current back-end used for transcoding.
1235 ;; - category :: tree
1236 ;; - type :: symbol
1237 ;;
1238 ;; + `:creator' :: String to write as creation information.
1239 ;; - category :: option
1240 ;; - type :: string
1241 ;;
1242 ;; + `:date' :: String to use as date.
1243 ;; - category :: option
1244 ;; - type :: string
1245 ;;
1246 ;; + `:description' :: Description text for the current data.
1247 ;; - category :: option
1248 ;; - type :: string
1249 ;;
1250 ;; + `:email' :: Author's email.
1251 ;; - category :: option
1252 ;; - type :: string
1253 ;;
1254 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1255 ;; process.
1256 ;; - category :: option
1257 ;; - type :: list of strings
1258 ;;
1259 ;; + `:export-options' :: List of export options available for current
1260 ;; process.
1261 ;; - category :: none
1262 ;; - type :: list of symbols, among `subtree', `body-only' and
1263 ;; `visible-only'.
1264 ;;
1265 ;; + `:exported-data' :: Hash table used for memoizing
1266 ;; `org-export-data'.
1267 ;; - category :: tree
1268 ;; - type :: hash table
1269 ;;
1270 ;; + `:filetags' :: List of global tags for buffer. Used by
1271 ;; `org-export-get-tags' to get tags with inheritance.
1272 ;; - category :: option
1273 ;; - type :: list of strings
1274 ;;
1275 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1276 ;; their definition, as parsed data. Only non-inlined footnotes
1277 ;; are represented in this alist. Also, every definition isn't
1278 ;; guaranteed to be referenced in the parse tree. The purpose of
1279 ;; this property is to preserve definitions from oblivion
1280 ;; (i.e. when the parse tree comes from a part of the original
1281 ;; buffer), it isn't meant for direct use in a back-end. To
1282 ;; retrieve a definition relative to a reference, use
1283 ;; `org-export-get-footnote-definition' instead.
1284 ;; - category :: option
1285 ;; - type :: alist (STRING . LIST)
1286 ;;
1287 ;; + `:headline-levels' :: Maximum level being exported as an
1288 ;; headline. Comparison is done with the relative level of
1289 ;; headlines in the parse tree, not necessarily with their
1290 ;; actual level.
1291 ;; - category :: option
1292 ;; - type :: integer
1293 ;;
1294 ;; + `:headline-offset' :: Difference between relative and real level
1295 ;; of headlines in the parse tree. For example, a value of -1
1296 ;; means a level 2 headline should be considered as level
1297 ;; 1 (cf. `org-export-get-relative-level').
1298 ;; - category :: tree
1299 ;; - type :: integer
1300 ;;
1301 ;; + `:headline-numbering' :: Alist between headlines and their
1302 ;; numbering, as a list of numbers
1303 ;; (cf. `org-export-get-headline-number').
1304 ;; - category :: tree
1305 ;; - type :: alist (INTEGER . LIST)
1306 ;;
1307 ;; + `:id-alist' :: Alist between ID strings and destination file's
1308 ;; path, relative to current directory. It is used by
1309 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1310 ;; external file.
1311 ;; - category :: option
1312 ;; - type :: alist (STRING . STRING)
1313 ;;
1314 ;; + `:ignore-list' :: List of elements and objects that should be
1315 ;; ignored during export.
1316 ;; - category :: tree
1317 ;; - type :: list of elements and objects
1318 ;;
1319 ;; + `:input-file' :: Full path to input file, if any.
1320 ;; - category :: option
1321 ;; - type :: string or nil
1322 ;;
1323 ;; + `:keywords' :: List of keywords attached to data.
1324 ;; - category :: option
1325 ;; - type :: string
1326 ;;
1327 ;; + `:language' :: Default language used for translations.
1328 ;; - category :: option
1329 ;; - type :: string
1330 ;;
1331 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1332 ;; transcoding.
1333 ;; - category :: option
1334 ;; - type :: list (as returned by `org-element-parse-buffer')
1335 ;;
1336 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1337 ;; all line breaks.
1338 ;; - category :: option
1339 ;; - type :: symbol (nil, t)
1340 ;;
1341 ;; + `:section-numbers' :: Non-nil means transcoding should add
1342 ;; section numbers to headlines.
1343 ;; - category :: option
1344 ;; - type :: symbol (nil, t)
1345 ;;
1346 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1347 ;; in transcoding. When such a tag is present, subtrees without
1348 ;; it are de facto excluded from the process. See
1349 ;; `use-select-tags'.
1350 ;; - category :: option
1351 ;; - type :: list of strings
1352 ;;
1353 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1354 ;; a time stamp in the output.
1355 ;; - category :: option
1356 ;; - type :: symbol (nil, t)
1357 ;;
1358 ;; + `:translate-alist' :: Alist between element and object types and
1359 ;; transcoding functions relative to the current back-end.
1360 ;; Special keys `inner-template', `template' and `plain-text' are
1361 ;; also possible.
1362 ;; - category :: option
1363 ;; - type :: alist (SYMBOL . FUNCTION)
1364 ;;
1365 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1366 ;; also be transcoded. If it is set to the `headline' symbol,
1367 ;; only the archived headline's name is retained.
1368 ;; - category :: option
1369 ;; - type :: symbol (nil, t, `headline')
1370 ;;
1371 ;; + `:with-author' :: Non-nil means author's name should be included
1372 ;; in the output.
1373 ;; - category :: option
1374 ;; - type :: symbol (nil, t)
1375 ;;
1376 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1377 ;; - category :: option
1378 ;; - type :: symbol (nil, t)
1379 ;;
1380 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1381 ;; inserted at the end of the transcoded string. If the value
1382 ;; is `comment', it should be commented.
1383 ;; - category :: option
1384 ;; - type :: symbol (`comment', nil, t)
1385 ;;
1386 ;; + `:with-date' :: Non-nil means output should contain a date.
1387 ;; - category :: option
1388 ;; - type :. symbol (nil, t)
1389 ;;
1390 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1391 ;; its value is a list of names, only drawers with such names
1392 ;; will be transcoded. If that list starts with `not', drawer
1393 ;; with these names will be skipped.
1394 ;; - category :: option
1395 ;; - type :: symbol (nil, t) or list of strings
1396 ;;
1397 ;; + `:with-email' :: Non-nil means output should contain author's
1398 ;; email.
1399 ;; - category :: option
1400 ;; - type :: symbol (nil, t)
1401 ;;
1402 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1403 ;; interpreted.
1404 ;; - category :: option
1405 ;; - type :: symbol (nil, t)
1406 ;;
1407 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1408 ;; strings starting with a colon as a fixed-with (verbatim) area.
1409 ;; - category :: option
1410 ;; - type :: symbol (nil, t)
1411 ;;
1412 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1413 ;; footnotes.
1414 ;; - category :: option
1415 ;; - type :: symbol (nil, t)
1416 ;;
1417 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1418 ;; `latex-fragment' objects should appear in export output. When
1419 ;; this property is set to `verbatim', they will be left as-is.
1420 ;; - category :: option
1421 ;; - type :: symbol (`verbatim', nil, t)
1422 ;;
1423 ;; + `:with-planning' :: Non-nil means transcoding should include
1424 ;; planning info.
1425 ;; - category :: option
1426 ;; - type :: symbol (nil, t)
1427 ;;
1428 ;; + `:with-priority' :: Non-nil means transcoding should include
1429 ;; priority cookies.
1430 ;; - category :: option
1431 ;; - type :: symbol (nil, t)
1432 ;;
1433 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1434 ;; plain text.
1435 ;; - category :: option
1436 ;; - type :: symbol (nil, t)
1437 ;;
1438 ;; + `:with-special-strings' :: Non-nil means transcoding should
1439 ;; interpret special strings in plain text.
1440 ;; - category :: option
1441 ;; - type :: symbol (nil, t)
1442 ;;
1443 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1444 ;; interpret subscript and superscript. With a value of "{}",
1445 ;; only interpret those using curly brackets.
1446 ;; - category :: option
1447 ;; - type :: symbol (nil, {}, t)
1448 ;;
1449 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1450 ;; tables.
1451 ;; - category :: option
1452 ;; - type :: symbol (nil, t)
1453 ;;
1454 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1455 ;; headlines. A `not-in-toc' value will remove them from the
1456 ;; table of contents, if any, nonetheless.
1457 ;; - category :: option
1458 ;; - type :: symbol (nil, t, `not-in-toc')
1459 ;;
1460 ;; + `:with-tasks' :: Non-nil means transcoding should include
1461 ;; headlines with a TODO keyword. A `todo' value will only
1462 ;; include headlines with a todo type keyword while a `done'
1463 ;; value will do the contrary. If a list of strings is provided,
1464 ;; only tasks with keywords belonging to that list will be kept.
1465 ;; - category :: option
1466 ;; - type :: symbol (t, todo, done, nil) or list of strings
1467 ;;
1468 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1469 ;; time stamps. Special value `active' (resp. `inactive') ask to
1470 ;; export only active (resp. inactive) timestamps. Otherwise,
1471 ;; completely remove them.
1472 ;; - category :: option
1473 ;; - type :: symbol: (`active', `inactive', t, nil)
1474 ;;
1475 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1476 ;; added to the output. An integer value limits its depth.
1477 ;; - category :: option
1478 ;; - type :: symbol (nil, t or integer)
1479 ;;
1480 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1481 ;; include TODO keywords.
1482 ;; - category :: option
1483 ;; - type :: symbol (nil, t)
1486 ;;;; Environment Options
1487 ;;
1488 ;; Environment options encompass all parameters defined outside the
1489 ;; scope of the parsed data. They come from five sources, in
1490 ;; increasing precedence order:
1491 ;;
1492 ;; - Global variables,
1493 ;; - Buffer's attributes,
1494 ;; - Options keyword symbols,
1495 ;; - Buffer keywords,
1496 ;; - Subtree properties.
1497 ;;
1498 ;; The central internal function with regards to environment options
1499 ;; is `org-export-get-environment'. It updates global variables with
1500 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1501 ;; the different sources.
1502 ;;
1503 ;; The internal functions doing the retrieval are:
1504 ;; `org-export--get-global-options',
1505 ;; `org-export--get-buffer-attributes',
1506 ;; `org-export--parse-option-keyword',
1507 ;; `org-export--get-subtree-options' and
1508 ;; `org-export--get-inbuffer-options'
1509 ;;
1510 ;; Also, `org-export--list-bound-variables' collects bound variables
1511 ;; along with their value in order to set them as buffer local
1512 ;; variables later in the process.
1515 "Collect export options from the current buffer.
1517 Optional argument BACKEND is an export back-end, as returned by
1518 `org-export-create-backend'.
1520 When optional argument SUBTREEP is non-nil, assume the export is
1521 done against the current sub-tree.
1523 Third optional argument EXT-PLIST is a property list with
1524 external parameters overriding Org default settings, but still
1525 inferior to file-local settings."
1526 ;; First install #+BIND variables since these must be set before
1527 ;; global options are read.
1530 ;; Get and prioritize export options...
1532 ;; ... from global variables...
1534 ;; ... from an external property list...
1535 ext-plist
1536 ;; ... from in-buffer settings...
1538 ;; ... and from subtree, when appropriate.
1540 ;; Eventually add misc. properties.
1542 :back-end
1543 backend
1545 :footnote-definition-alist
1546 ;; Footnotes definitions must be collected in the original
1547 ;; buffer, as there's no insurance that they will still be in
1548 ;; the parse tree, due to possible narrowing.
1562 alist))))
1563 alist))
1564 :id-alist
1565 ;; Collect id references.
1576 alist))))
1579 "Parse an OPTIONS line and return values as a plist.
1580 Optional argument BACKEND is an export back-end, as returned by,
1581 e.g., `org-export-create-backend'. It specifies which back-end
1582 specific items to read, if any."
1584 ;; Priority is given to back-end specific options.
1586 org-export-options-alist))
1587 plist)
1596 options))
1598 property
1601 plist))
1604 "Get export options in subtree at point.
1605 Optional argument BACKEND is an export back-end, as returned by,
1606 e.g., `org-export-create-backend'. It specifies back-end used
1607 for export. Return options as a plist."
1608 ;; For each buffer keyword, create a headline property setting the
1609 ;; same property in communication channel. The name for the property
1610 ;; is the keyword with "EXPORT_" appended to it.
1613 ;; Make sure point is at a heading.
1615 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1616 ;; title as its fallback value.
1622 plist :title
1625 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1629 ;; Handle other keywords. TITLE keyword is excluded as it has
1630 ;; been handled already.
1638 ;; Export properties are not case-sensitive.
1645 plist
1646 property
1648 ;; Parse VALUE if required.
1652 ;; If BEHAVIOR is `split' expected value is
1653 ;; a list of strings, not a string.
1656 ;; Look for both general keywords and back-end specific
1657 ;; options, with priority given to the latter.
1659 org-export-options-alist)))
1660 ;; Return value.
1661 plist)))
1664 "Return current buffer export options, as a plist.
1666 Optional argument BACKEND, when non-nil, is an export back-end,
1667 as returned by, e.g., `org-export-create-backend'. It specifies
1668 which back-end specific options should also be read in the
1669 process.
1671 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1673 get-options ; For byte-compiler.
1676 ;; Priority is given to back-end specific options.
1678 org-export-options-alist))
1681 org-export-special-keywords))))
1684 ;; Return all properties associated to KEYWORD.
1691 ;; Recursively read keywords in buffer. FILES is a list
1692 ;; of files read so far. PLIST is the current property
1693 ;; list obtained.
1702 ;; Options in `org-export-special-keywords'.
1706 ;; Avoid circular dependencies.
1716 plist
1721 plist
1727 ;; Options in `org-export-options-alist'.
1732 plist property
1733 ;; Handle value depending on specified
1734 ;; BEHAVIOR.
1740 " "
1753 ;; Return final value.
1754 plist))))
1755 ;; Read options in the current buffer.
1758 ;; Parse keywords specified in `org-element-document-properties'
1759 ;; and return PLIST.
1770 "Return properties related to buffer attributes, as a plist."
1771 ;; Store full path of input file name, or nil. For internal use.
1779 "Return global export options as a plist.
1780 Optional argument BACKEND, if non-nil, is an export back-end, as
1781 returned by, e.g., `org-export-create-backend'. It specifies
1782 which back-end specific export options should also be read in the
1783 process."
1785 ;; Priority is given to back-end specific options.
1787 org-export-options-alist)))
1794 plist
1795 prop
1796 ;; Eval default value provided. If keyword is
1797 ;; a member of `org-element-document-properties',
1798 ;; parse it as a secondary string before storing it.
1805 value)))))))))))
1808 "Return variables bound from BIND keywords in current buffer.
1809 Also look for BIND keywords in setup files. The return value is
1810 an alist where associations are (VARIABLE-NAME VALUE)."
1815 ;; Return an alist between variable names and their
1816 ;; value. FILES is a list of setup files names read so
1817 ;; far, used to avoid circular dependencies. ALIST is
1818 ;; the alist collected so far.
1829 ;; Enter setup file.
1839 alist))))))))))
1840 alist)))))
1841 ;; Return value in appropriate order of appearance.
1845 ;;;; Tree Properties
1846 ;;
1847 ;; Tree properties are information extracted from parse tree. They
1848 ;; are initialized at the beginning of the transcoding process by
1849 ;; `org-export-collect-tree-properties'.
1850 ;;
1851 ;; Dedicated functions focus on computing the value of specific tree
1852 ;; properties during initialization. Thus,
1853 ;; `org-export--populate-ignore-list' lists elements and objects that
1854 ;; should be skipped during export, `org-export--get-min-level' gets
1855 ;; the minimal exportable level, used as a basis to compute relative
1856 ;; level for headlines. Eventually
1857 ;; `org-export--collect-headline-numbering' builds an alist between
1858 ;; headlines and their numbering.
1861 "Extract tree properties from parse tree.
1863 DATA is the parse tree from which information is retrieved. INFO
1864 is a list holding export options.
1866 Following tree properties are set or updated:
1868 `:exported-data' Hash table used to memoize results from
1869 `org-export-data'.
1871 `:footnote-definition-alist' List of footnotes definitions in
1872 original buffer and current parse tree.
1874 `:headline-offset' Offset between true level of headlines and
1875 local level. An offset of -1 means a headline
1876 of level 2 should be considered as a level
1877 1 headline in the context.
1879 `:headline-numbering' Alist of all headlines as key an the
1880 associated numbering as value.
1882 `:ignore-list' List of elements that should be ignored during
1883 export.
1885 Return updated plist."
1886 ;; Install the parse tree in the communication channel, in order to
1887 ;; use `org-export-get-genealogy' and al.
1889 ;; Get the list of elements and objects to ignore, and put it into
1890 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1891 ;; been done during parse tree filtering.
1894 :ignore-list
1897 ;; Compute `:headline-offset' in order to be able to use
1898 ;; `org-export-get-relative-level'.
1901 :headline-offset
1903 ;; Update footnotes definitions list with definitions in parse tree.
1904 ;; This is required since buffer expansion might have modified
1905 ;; boundaries of footnote definitions contained in the parse tree.
1906 ;; This way, definitions in `footnote-definition-alist' are bound to
1907 ;; match those in the parse tree.
1913 defs)))
1915 ;; Properties order doesn't matter: get the rest of the tree
1916 ;; properties.
1920 info))
1923 "Return minimum exportable headline's level in DATA.
1924 DATA is parsed tree as returned by `org-element-parse-buffer'.
1925 OPTIONS is a plist holding export options."
1936 ;; If no headline was found, for the sake of consistency, set
1937 ;; minimum level to 1 nonetheless.
1941 "Return numbering of all exportable headlines in a parse tree.
1943 DATA is the parse tree. OPTIONS is the plist holding export
1944 options.
1946 Return an alist whose key is a headline and value is its
1947 associated numbering \(in the shape of a list of numbers\) or nil
1948 for a footnotes section."
1956 headline
1958 for idx from 0 to org-export-max-depth
1962 options)))
1965 "Return list of elements and objects to ignore during export.
1966 DATA is the parse tree to traverse. OPTIONS is the plist holding
1967 export options."
1969 walk-data
1970 ;; First find trees containing a select tag, if any.
1974 ;; Collect ignored elements or objects into IGNORE-LIST.
1980 ;; If headline is archived but tree below has
1981 ;; to be skipped, add it to ignore list.
1984 ;; Move into secondary string, if any.
1989 ;; Move into recursive objects/elements.
1991 ;; Main call.
1993 ;; Return value.
1994 ignore))
1997 "Return list of headlines and inlinetasks with a select tag in their tree.
1998 DATA is parsed data as returned by `org-element-parse-buffer'.
1999 INFO is a plist holding export options."
2001 walk-data ; For byte-compiler.
2011 ;; When a select tag is found, mark full
2012 ;; genealogy and every headline within the tree
2013 ;; as acceptable.
2016 genealogy
2019 selected-trees))
2020 ;; If at a headline, continue searching in tree,
2021 ;; recursively.
2031 selected-trees))
2034 "Non-nil when element or object BLOB should be skipped during export.
2035 OPTIONS is the plist holding export options. SELECTED, when
2036 non-nil, is a list of headlines or inlinetasks belonging to
2037 a tree with a select tag."
2044 ;; If `:with-drawers' value starts with `not', ignore
2045 ;; every drawer whose name belong to that list.
2046 ;; Otherwise, ignore drawers whose name isn't in that
2047 ;; list.
2063 ;; Ignore subtrees with an exclude tag.
2066 ;; When a select tag is present in the buffer, ignore any tree
2067 ;; without it.
2069 ;; Ignore commented sub-trees.
2071 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2073 ;; Ignore tasks, if specified by `:with-tasks' property.
2088 ;; `:with-timestamps' only applies to isolated timestamps
2089 ;; objects, i.e. timestamp objects in a paragraph containing only
2090 ;; timestamps and whitespaces.
2098 options t))))
2107 \f
2108 ;;; The Transcoder
2109 ;;
2110 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2111 ;; `org-element-parse-buffer') and transcodes it into a specified
2112 ;; back-end output. It takes care of filtering out elements or
2113 ;; objects according to export options and organizing the output blank
2114 ;; lines and white space are preserved. The function memoizes its
2115 ;; results, so it is cheap to call it within transcoders.
2116 ;;
2117 ;; It is possible to modify locally the back-end used by
2118 ;; `org-export-data' or even use a temporary back-end by using
2119 ;; `org-export-data-with-backend'.
2120 ;;
2121 ;; Internally, three functions handle the filtering of objects and
2122 ;; elements during the export. In particular,
2123 ;; `org-export-ignore-element' marks an element or object so future
2124 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2125 ;; elements or objects should be seen as real Org syntax and
2126 ;; `org-export-expand' transforms the others back into their original
2127 ;; shape
2128 ;;
2129 ;; `org-export-transcoder' is an accessor returning appropriate
2130 ;; translator function for a given element or object.
2133 "Return appropriate transcoder for BLOB.
2134 INFO is a plist containing export directives."
2136 ;; Return contents only for complete parse trees.
2142 "Convert DATA into current back-end format.
2144 DATA is a parse tree, an element or an object or a secondary
2145 string. INFO is a plist holding export options.
2147 Return transcoded string."
2153 ;; Ignored element/object.
2155 ;; Plain text.
2161 info))
2162 ;; Uninterpreted element/object: change it back to Org
2163 ;; syntax and export again resulting raw string.
2167 data
2171 info))
2172 ;; Secondary string.
2175 ;; Element/Object without contents or, as a special case,
2176 ;; headline with archive tag and archived trees restricted
2177 ;; to title only.
2185 ;; Export snippets never return a nil value so
2186 ;; that white spaces following them are never
2187 ;; ignored.
2189 ;; Element/Object with contents.
2202 ;; Elements directly containing objects
2203 ;; must have their indentation normalized
2204 ;; first.
2206 data
2207 ;; When normalizing contents of the first
2208 ;; paragraph in an item or a footnote
2209 ;; definition, ignore first line's
2210 ;; indentation: there is none and it
2211 ;; might be misleading.
2216 data)
2223 info))))))))
2224 ;; Final result will be memoized before being returned.
2226 data
2230 ;; Append the same white space between elements or objects as in
2231 ;; the original buffer, and call appropriate filters.
2242 info)))
2243 results)))
2247 "Convert DATA into BACKEND format.
2249 DATA is an element, an object, a secondary string or a string.
2250 BACKEND is a symbol. INFO is a plist used as a communication
2251 channel.
2253 Unlike to `org-export-with-backend', this function will
2254 recursively convert DATA using BACKEND translation table."
2257 data
2258 ;; Set-up a new communication channel with translations defined in
2259 ;; BACKEND as the translate table and a new hash table for
2260 ;; memoization.
2262 info
2265 ;; Size of the hash table is reduced since this function
2266 ;; will probably be used on small trees.
2270 "Non-nil if element or object BLOB should be interpreted during export.
2271 If nil, BLOB will appear as raw Org syntax. Check is done
2272 according to export options INFO, stored as a plist."
2274 ;; ... entities...
2276 ;; ... emphasis...
2279 ;; ... fixed-width areas.
2281 ;; ... LaTeX environments and fragments...
2285 ;; ... sub/superscripts...
2291 ;; ... tables...
2296 "Expand a parsed element or object to its original state.
2298 BLOB is either an element or an object. CONTENTS is its
2299 contents, as a string or nil.
2301 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2302 keywords before output."
2307 blob contents))))
2310 "Add ELEMENT to `:ignore-list' in INFO.
2312 Any element in `:ignore-list' will be skipped when using
2313 `org-element-map'. INFO is modified by side effects."
2317 \f
2318 ;;; The Filter System
2319 ;;
2320 ;; Filters allow end-users to tweak easily the transcoded output.
2321 ;; They are the functional counterpart of hooks, as every filter in
2322 ;; a set is applied to the return value of the previous one.
2323 ;;
2324 ;; Every set is back-end agnostic. Although, a filter is always
2325 ;; called, in addition to the string it applies to, with the back-end
2326 ;; used as argument, so it's easy for the end-user to add back-end
2327 ;; specific filters in the set. The communication channel, as
2328 ;; a plist, is required as the third argument.
2329 ;;
2330 ;; From the developer side, filters sets can be installed in the
2331 ;; process with the help of `org-export-define-backend', which
2332 ;; internally stores filters as an alist. Each association has a key
2333 ;; among the following symbols and a function or a list of functions
2334 ;; as value.
2335 ;;
2336 ;; - `:filter-options' applies to the property list containing export
2337 ;; options. Unlike to other filters, functions in this list accept
2338 ;; two arguments instead of three: the property list containing
2339 ;; export options and the back-end. Users can set its value through
2340 ;; `org-export-filter-options-functions' variable.
2341 ;;
2342 ;; - `:filter-parse-tree' applies directly to the complete parsed
2343 ;; tree. Users can set it through
2344 ;; `org-export-filter-parse-tree-functions' variable.
2345 ;;
2346 ;; - `:filter-final-output' applies to the final transcoded string.
2347 ;; Users can set it with `org-export-filter-final-output-functions'
2348 ;; variable
2349 ;;
2350 ;; - `:filter-plain-text' applies to any string not recognized as Org
2351 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2352 ;; configure it.
2353 ;;
2354 ;; - `:filter-TYPE' applies on the string returned after an element or
2355 ;; object of type TYPE has been transcoded. A user can modify
2356 ;; `org-export-filter-TYPE-functions'
2357 ;;
2358 ;; All filters sets are applied with
2359 ;; `org-export-filter-apply-functions' function. Filters in a set are
2360 ;; applied in a LIFO fashion. It allows developers to be sure that
2361 ;; their filters will be applied first.
2362 ;;
2363 ;; Filters properties are installed in communication channel with
2364 ;; `org-export-install-filters' function.
2365 ;;
2366 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2367 ;; `org-export-before-parsing-hook') are run at the beginning of the
2368 ;; export process and just before parsing to allow for heavy structure
2369 ;; modifications.
2372 ;;;; Hooks
2375 "Hook run at the beginning of the export process.
2377 This is run before include keywords and macros are expanded and
2378 Babel code blocks executed, on a copy of the original buffer
2379 being exported. Visibility and narrowing are preserved. Point
2380 is at the beginning of the buffer.
2382 Every function in this hook will be called with one argument: the
2386 "Hook run before parsing an export buffer.
2388 This is run after include keywords and macros have been expanded
2389 and Babel code blocks executed, on a copy of the original buffer
2390 being exported. Visibility and narrowing are preserved. Point
2391 is at the beginning of the buffer.
2393 Every function in this hook will be called with one argument: the
2397 ;;;; Special Filters
2400 "List of functions applied to the export options.
2401 Each filter is called with two arguments: the export options, as
2402 a plist, and the back-end, as a symbol. It must return
2406 "List of functions applied to the parsed tree.
2407 Each filter is called with three arguments: the parse tree, as
2408 returned by `org-element-parse-buffer', the back-end, as
2409 a symbol, and the communication channel, as a plist. It must
2413 "List of functions applied to plain text.
2414 Each filter is called with three arguments: a string which
2415 contains no Org syntax, the back-end, as a symbol, and the
2416 communication channel, as a plist. It must return a string or
2420 "List of functions applied to the transcoded string.
2421 Each filter is called with three arguments: the full transcoded
2422 string, the back-end, as a symbol, and the communication channel,
2423 as a plist. It must return a string that will be used as the
2427 ;;;; Elements Filters
2430 "List of functions applied to a transcoded babel-call.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2436 "List of functions applied to a transcoded center block.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2442 "List of functions applied to a transcoded clock.
2443 Each filter is called with three arguments: the transcoded data,
2444 as a string, the back-end, as a symbol, and the communication
2448 "List of functions applied to a transcoded comment.
2449 Each filter is called with three arguments: the transcoded data,
2450 as a string, the back-end, as a symbol, and the communication
2454 "List of functions applied to a transcoded comment-block.
2455 Each filter is called with three arguments: the transcoded data,
2456 as a string, the back-end, as a symbol, and the communication
2460 "List of functions applied to a transcoded diary-sexp.
2461 Each filter is called with three arguments: the transcoded data,
2462 as a string, the back-end, as a symbol, and the communication
2466 "List of functions applied to a transcoded drawer.
2467 Each filter is called with three arguments: the transcoded data,
2468 as a string, the back-end, as a symbol, and the communication
2472 "List of functions applied to a transcoded dynamic-block.
2473 Each filter is called with three arguments: the transcoded data,
2474 as a string, the back-end, as a symbol, and the communication
2478 "List of functions applied to a transcoded example-block.
2479 Each filter is called with three arguments: the transcoded data,
2480 as a string, the back-end, as a symbol, and the communication
2484 "List of functions applied to a transcoded export-block.
2485 Each filter is called with three arguments: the transcoded data,
2486 as a string, the back-end, as a symbol, and the communication
2490 "List of functions applied to a transcoded fixed-width.
2491 Each filter is called with three arguments: the transcoded data,
2492 as a string, the back-end, as a symbol, and the communication
2496 "List of functions applied to a transcoded footnote-definition.
2497 Each filter is called with three arguments: the transcoded data,
2498 as a string, the back-end, as a symbol, and the communication
2502 "List of functions applied to a transcoded headline.
2503 Each filter is called with three arguments: the transcoded data,
2504 as a string, the back-end, as a symbol, and the communication
2508 "List of functions applied to a transcoded horizontal-rule.
2509 Each filter is called with three arguments: the transcoded data,
2510 as a string, the back-end, as a symbol, and the communication
2514 "List of functions applied to a transcoded inlinetask.
2515 Each filter is called with three arguments: the transcoded data,
2516 as a string, the back-end, as a symbol, and the communication
2520 "List of functions applied to a transcoded item.
2521 Each filter is called with three arguments: the transcoded data,
2522 as a string, the back-end, as a symbol, and the communication
2526 "List of functions applied to a transcoded keyword.
2527 Each filter is called with three arguments: the transcoded data,
2528 as a string, the back-end, as a symbol, and the communication
2532 "List of functions applied to a transcoded latex-environment.
2533 Each filter is called with three arguments: the transcoded data,
2534 as a string, the back-end, as a symbol, and the communication
2538 "List of functions applied to a transcoded node-property.
2539 Each filter is called with three arguments: the transcoded data,
2540 as a string, the back-end, as a symbol, and the communication
2544 "List of functions applied to a transcoded paragraph.
2545 Each filter is called with three arguments: the transcoded data,
2546 as a string, the back-end, as a symbol, and the communication
2550 "List of functions applied to a transcoded plain-list.
2551 Each filter is called with three arguments: the transcoded data,
2552 as a string, the back-end, as a symbol, and the communication
2556 "List of functions applied to a transcoded planning.
2557 Each filter is called with three arguments: the transcoded data,
2558 as a string, the back-end, as a symbol, and the communication
2562 "List of functions applied to a transcoded property-drawer.
2563 Each filter is called with three arguments: the transcoded data,
2564 as a string, the back-end, as a symbol, and the communication
2568 "List of functions applied to a transcoded quote block.
2569 Each filter is called with three arguments: the transcoded quote
2570 data, as a string, the back-end, as a symbol, and the
2571 communication channel, as a plist. It must return a string or
2575 "List of functions applied to a transcoded quote-section.
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 section.
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 special block.
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 src-block.
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 table.
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 table-cell.
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 table-row.
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 verse block.
2618 Each filter is called with three arguments: the transcoded data,
2619 as a string, the back-end, as a symbol, and the communication
2623 ;;;; Objects Filters
2626 "List of functions applied to transcoded bold text.
2627 Each filter is called with three arguments: the transcoded data,
2628 as a string, the back-end, as a symbol, and the communication
2632 "List of functions applied to transcoded code text.
2633 Each filter is called with three arguments: the transcoded data,
2634 as a string, the back-end, as a symbol, and the communication
2638 "List of functions applied to a transcoded entity.
2639 Each filter is called with three arguments: the transcoded data,
2640 as a string, the back-end, as a symbol, and the communication
2644 "List of functions applied to a transcoded export-snippet.
2645 Each filter is called with three arguments: the transcoded data,
2646 as a string, the back-end, as a symbol, and the communication
2650 "List of functions applied to a transcoded footnote-reference.
2651 Each filter is called with three arguments: the transcoded data,
2652 as a string, the back-end, as a symbol, and the communication
2656 "List of functions applied to a transcoded inline-babel-call.
2657 Each filter is called with three arguments: the transcoded data,
2658 as a string, the back-end, as a symbol, and the communication
2662 "List of functions applied to a transcoded inline-src-block.
2663 Each filter is called with three arguments: the transcoded data,
2664 as a string, the back-end, as a symbol, and the communication
2668 "List of functions applied to transcoded italic text.
2669 Each filter is called with three arguments: the transcoded data,
2670 as a string, the back-end, as a symbol, and the communication
2674 "List of functions applied to a transcoded latex-fragment.
2675 Each filter is called with three arguments: the transcoded data,
2676 as a string, the back-end, as a symbol, and the communication
2680 "List of functions applied to a transcoded line-break.
2681 Each filter is called with three arguments: the transcoded data,
2682 as a string, the back-end, as a symbol, and the communication
2686 "List of functions applied to a transcoded link.
2687 Each filter is called with three arguments: the transcoded data,
2688 as a string, the back-end, as a symbol, and the communication
2692 "List of functions applied to a transcoded radio-target.
2693 Each filter is called with three arguments: the transcoded data,
2694 as a string, the back-end, as a symbol, and the communication
2698 "List of functions applied to a transcoded statistics-cookie.
2699 Each filter is called with three arguments: the transcoded data,
2700 as a string, the back-end, as a symbol, and the communication
2704 "List of functions applied to transcoded strike-through text.
2705 Each filter is called with three arguments: the transcoded data,
2706 as a string, the back-end, as a symbol, and the communication
2710 "List of functions applied to a transcoded subscript.
2711 Each filter is called with three arguments: the transcoded data,
2712 as a string, the back-end, as a symbol, and the communication
2716 "List of functions applied to a transcoded superscript.
2717 Each filter is called with three arguments: the transcoded data,
2718 as a string, the back-end, as a symbol, and the communication
2722 "List of functions applied to a transcoded target.
2723 Each filter is called with three arguments: the transcoded data,
2724 as a string, the back-end, as a symbol, and the communication
2728 "List of functions applied to a transcoded timestamp.
2729 Each filter is called with three arguments: the transcoded data,
2730 as a string, the back-end, as a symbol, and the communication
2734 "List of functions applied to transcoded underline text.
2735 Each filter is called with three arguments: the transcoded data,
2736 as a string, the back-end, as a symbol, and the communication
2740 "List of functions applied to transcoded verbatim text.
2741 Each filter is called with three arguments: the transcoded data,
2742 as a string, the back-end, as a symbol, and the communication
2746 ;;;; Filters Tools
2747 ;;
2748 ;; Internal function `org-export-install-filters' installs filters
2749 ;; hard-coded in back-ends (developer filters) and filters from global
2750 ;; variables (user filters) in the communication channel.
2751 ;;
2752 ;; Internal function `org-export-filter-apply-functions' takes care
2753 ;; about applying each filter in order to a given data. It ignores
2754 ;; filters returning a nil value but stops whenever a filter returns
2755 ;; an empty string.
2758 "Call every function in FILTERS.
2760 Functions are called with arguments VALUE, current export
2761 back-end's name and INFO. A function returning a nil value will
2762 be skipped. If it returns the empty string, the process ends and
2763 VALUE is ignored.
2765 Call is done in a LIFO fashion, to be sure that developer
2766 specified filters, if any, are called first."
2777 "Install filters properties in communication channel.
2778 INFO is a plist containing the current communication channel.
2779 Return the updated communication channel."
2781 ;; Install user-defined filters with `org-export-filters-alist'
2782 ;; and filters already in INFO (through ext-plist mechanism).
2789 ;; Filters in INFO will be called
2790 ;; before those user provided.
2793 default-value)))))
2794 org-export-filters-alist)
2795 ;; Prepend back-end specific filters to that list.
2797 ;; Single values get consed, lists are appended.
2802 plist key
2806 ;; Return new communication channel.
2810 \f
2811 ;;; Core functions
2812 ;;
2813 ;; This is the room for the main function, `org-export-as', along with
2814 ;; its derivative, `org-export-string-as'.
2815 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2816 ;; function should be added to kill ring.
2817 ;;
2818 ;; Note that `org-export-as' doesn't really parse the current buffer,
2819 ;; but a copy of it (with the same buffer-local variables and
2820 ;; visibility), where macros and include keywords are expanded and
2821 ;; Babel blocks are executed, if appropriate.
2822 ;; `org-export-with-buffer-copy' macro prepares that copy.
2823 ;;
2824 ;; File inclusion is taken care of by
2825 ;; `org-export-expand-include-keyword' and
2826 ;; `org-export--prepare-file-contents'. Structure wise, including
2827 ;; a whole Org file in a buffer often makes little sense. For
2828 ;; example, if the file contains a headline and the include keyword
2829 ;; was within an item, the item should contain the headline. That's
2830 ;; why file inclusion should be done before any structure can be
2831 ;; associated to the file, that is before parsing.
2832 ;;
2833 ;; `org-export-insert-default-template' is a command to insert
2834 ;; a default template (or a back-end specific template) at point or in
2835 ;; current subtree.
2838 "Return a copy of the current buffer.
2839 The copy preserves Org buffer-local variables, visibility and
2840 narrowing."
2846 new-buf))
2849 "Apply BODY in a copy of the current buffer.
2850 The copy preserves local variables, visibility and contents of
2851 the original buffer. Point is at the beginning of the buffer
2852 when BODY is applied."
2861 ;; Kill copy without confirmation.
2867 "Generate a function duplicating BUFFER.
2869 The copy will preserve local variables, visibility, contents and
2870 narrowing of the original buffer. If a region was active in
2871 BUFFER, contents will be narrowed to that region instead.
2873 The resulting function can be evaluated at a later time, from
2874 another buffer, effectively cloning the original buffer there.
2876 The function assumes BUFFER's major mode is `org-mode'."
2880 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2881 ;; already in BUFFER.
2883 ;; Copy specific buffer local variables and variables set
2884 ;; through BIND keywords.
2886 vars)
2894 buffer-file-name
2895 buffer-file-coding-system))
2899 ;; Skip unreadable values, as they cannot be
2900 ;; sent to external process.
2904 vars))))))
2905 ;; Whole buffer contents.
2910 ;; Narrowing.
2914 ;; Current position of point.
2916 ;; Overlays with invisible property.
2926 ov-set))))
2928 ov-set)))))
2930 ;;;###autoload
2933 "Transcode current Org buffer into BACKEND code.
2935 BACKEND is either an export back-end, as returned by, e.g.,
2936 `org-export-create-backend', or a symbol referring to
2937 a registered back-end.
2939 If narrowing is active in the current buffer, only transcode its
2940 narrowed part.
2942 If a region is active, transcode that region.
2944 When optional argument SUBTREEP is non-nil, transcode the
2945 sub-tree at point, extracting information from the headline
2946 properties first.
2948 When optional argument VISIBLE-ONLY is non-nil, don't export
2949 contents of hidden elements.
2951 When optional argument BODY-ONLY is non-nil, only return body
2952 code, without surrounding template.
2954 Optional argument EXT-PLIST, when provided, is a property list
2955 with external parameters overriding Org default settings, but
2956 still inferior to file-local settings.
2958 Return code as a string."
2963 ;; Narrow buffer to an appropriate region or subtree for
2964 ;; parsing. If parsing subtree, be sure to remove main headline
2965 ;; too.
2973 ;; Initialize communication channel with original buffer
2974 ;; attributes, unavailable in its copy.
2983 tree)
2984 ;; Update communication channel and get parse tree. Buffer
2985 ;; isn't parsed directly. Instead, a temporary copy is
2986 ;; created, where include keywords, macros are expanded and
2987 ;; code blocks are evaluated.
2989 ;; Run first hook with current back-end's name as argument.
2993 ;; Update macro templates since #+INCLUDE keywords might have
2994 ;; added some new ones.
2998 ;; Update radio targets since keyword inclusion might have
2999 ;; added some more.
3001 ;; Run last hook with current back-end's name as argument.
3006 ;; Update communication channel with environment. Also
3007 ;; install user's and developer's filters.
3012 ;; Expand export-specific set of macros: {{{author}}},
3013 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3014 ;; once regular macros have been expanded, since document
3015 ;; keywords may contain one of them.
3021 ;; EMAIL is not a parsed keyword: store it as-is.
3025 ;; Call options filters and update export options. We do not
3026 ;; use `org-export-filter-apply-functions' here since the
3027 ;; arity of such filters is different.
3032 ;; Parse buffer and call parse-tree filter on it.
3037 ;; Now tree is complete, compute its properties and add them
3038 ;; to communication channel.
3042 ;; Eventually transcode TREE. Wrap the resulting string into
3043 ;; a template.
3052 ;; Remove all text properties since they cannot be
3053 ;; retrieved from an external process. Finally call
3054 ;; final-output filter and return result.
3060 info))))))))
3062 ;;;###autoload
3064 "Transcode STRING into BACKEND code.
3066 BACKEND is either an export back-end, as returned by, e.g.,
3067 `org-export-create-backend', or a symbol referring to
3068 a registered back-end.
3070 When optional argument BODY-ONLY is non-nil, only return body
3071 code, without preamble nor postamble.
3073 Optional argument EXT-PLIST, when provided, is a property list
3074 with external parameters overriding Org default settings, but
3075 still inferior to file-local settings.
3077 Return code as a string."
3083 ;;;###autoload
3085 "Replace the active region by its export to BACKEND.
3086 BACKEND is either an export back-end, as returned by, e.g.,
3087 `org-export-create-backend', or a symbol referring to
3088 a registered back-end."
3098 ;;;###autoload
3100 "Insert all export keywords with default values at beginning of line.
3102 BACKEND is a symbol referring to the name of a registered export
3103 back-end, for which specific export options should be added to
3104 the template, or `default' for default template. When it is nil,
3105 the user will be prompted for a category.
3107 If SUBTREEP is non-nil, export configuration will be set up
3108 locally for the subtree through node properties."
3118 "Options category: "
3122 org-export--registered-backends))))))
3123 options keywords)
3124 ;; Populate OPTIONS and KEYWORDS.
3141 ;; Move to an appropriate location in order to insert options.
3143 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3144 ;; list of available keywords.
3172 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3190 ;; And the rest of keywords.
3201 "Expand every include keyword in buffer.
3202 Optional argument INCLUDED is a list of included file names along
3203 with their line restriction, when appropriate. It is used to
3204 avoid infinite recursion. Optional argument DIR is the current
3205 working directory. It is used to properly resolve relative
3206 paths."
3213 ;; Extract arguments from keyword's value.
3221 dir)
3226 value)
3232 ;; Minimal level of included file defaults to the child
3233 ;; level of the current headline, if any, or one. It
3234 ;; only applies is the file is meant to be included as
3235 ;; an Org one.
3243 ;; Remove keyword.
3249 ;; Check if files has already been parsed. Look after
3250 ;; inclusion lines too, as different parts of the same file
3251 ;; can be included too.
3263 ind-str contents ind-str))))
3271 ind-str env contents ind-str))))
3284 "Prepare the contents of FILE for inclusion and return them as a string.
3286 When optional argument LINES is a string specifying a range of
3287 lines, include only those lines.
3289 Optional argument IND, when non-nil, is an integer specifying the
3290 global indentation of returned contents. Since its purpose is to
3291 allow an included file to stay in the same environment it was
3292 created \(i.e. a list item), it doesn't apply past the first
3293 headline encountered.
3295 Optional argument MINLEVEL, when non-nil, is an integer
3296 specifying the level that any top-level headline in the included
3297 file should have."
3313 ;; Remove blank lines at beginning and end of contents. The logic
3314 ;; behind that removal is that blank lines around include keyword
3315 ;; override blank lines in included file.
3324 ;; If IND is set, preserve indentation of include keyword until
3325 ;; the first headline encountered.
3332 ;; Do not move footnote definitions out of column 0.
3338 ;; When MINLEVEL is specified, compute minimal level for headlines
3339 ;; in the file (CUR-MIN), and remove stars to each headline so
3340 ;; that headlines with minimal level have a level of MINLEVEL.
3351 ;; Only change stars, don't bother moving whole
3352 ;; sections.
3359 "Execute every Babel code in the visible part of current buffer."
3360 ;; Get a pristine copy of current buffer so Babel references can be
3361 ;; properly resolved.
3368 "Return a non-nil value when output should be added to the kill ring.
3369 See also `org-export-copy-to-kill-ring'."
3375 \f
3376 ;;; Tools For Back-Ends
3377 ;;
3378 ;; A whole set of tools is available to help build new exporters. Any
3379 ;; function general enough to have its use across many back-ends
3380 ;; should be added here.
3382 ;;;; For Affiliated Keywords
3383 ;;
3384 ;; `org-export-read-attribute' reads a property from a given element
3385 ;; as a plist. It can be used to normalize affiliated keywords'
3386 ;; syntax.
3387 ;;
3388 ;; Since captions can span over multiple lines and accept dual values,
3389 ;; their internal representation is a bit tricky. Therefore,
3390 ;; `org-export-get-caption' transparently returns a given element's
3391 ;; caption as a secondary string.
3394 "Turn ATTRIBUTE property from ELEMENT into a plist.
3396 When optional argument PROPERTY is non-nil, return the value of
3397 that property within attributes.
3401 properties.
3403 All values will become strings except the empty string and
3406 will become the empty string."
3420 s)
3425 ;; Ignore any string before first property with `cdr'.
3430 "Return caption from ELEMENT as a secondary string.
3432 When optional argument SHORTP is non-nil, return short caption,
3433 as a secondary string, instead.
3435 Caption lines are separated by a white space."
3443 ;;;; For Derived Back-ends
3444 ;;
3445 ;; `org-export-with-backend' is a function allowing to locally use
3446 ;; another back-end to transcode some object or element. In a derived
3447 ;; back-end, it may be used as a fall-back function once all specific
3448 ;; cases have been treated.
3451 "Call a transcoder from BACKEND on DATA.
3452 BACKEND is an export back-end, as returned by, e.g.,
3453 `org-export-create-backend', or a symbol referring to
3454 a registered back-end. DATA is an Org element, object, secondary
3455 string or string. CONTENTS, when non-nil, is the transcoded
3456 contents of DATA element, as a string. INFO, when non-nil, is
3457 the communication channel used for export, as a plist."
3467 transcoder data contents
3470 :translate-alist all-transcoders
3474 ;;;; For Export Snippets
3475 ;;
3476 ;; Every export snippet is transmitted to the back-end. Though, the
3477 ;; latter will only retain one type of export-snippet, ignoring
3478 ;; others, based on the former's target back-end. The function
3479 ;; `org-export-snippet-backend' returns that back-end for a given
3480 ;; export-snippet.
3483 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3484 Translation, with `org-export-snippet-translation-alist', is
3485 applied."
3489 back-end))))
3492 ;;;; For Footnotes
3493 ;;
3494 ;; `org-export-collect-footnote-definitions' is a tool to list
3495 ;; actually used footnotes definitions in the whole parse tree, or in
3496 ;; a headline, in order to add footnote listings throughout the
3497 ;; transcoded data.
3498 ;;
3499 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3500 ;; back-ends, when they need to attach the footnote definition only to
3501 ;; the first occurrence of the corresponding label.
3502 ;;
3503 ;; `org-export-get-footnote-definition' and
3504 ;; `org-export-get-footnote-number' provide easier access to
3505 ;; additional information relative to a footnote reference.
3508 "Return an alist between footnote numbers, labels and definitions.
3510 DATA is the parse tree from which definitions are collected.
3511 INFO is the plist used as a communication channel.
3513 Definitions are sorted by order of references. They either
3514 appear as Org data or as a secondary string for inlined
3515 footnotes. Unreferenced definitions are ignored."
3517 collect-fn ; for byte-compiler.
3521 ;; Collect footnote number, label and definition in DATA.
3529 def)
3530 num-alist)
3531 ;; Also search in definition for nested footnotes.
3534 ;; Don't enter footnote definitions since it will happen
3535 ;; when their first reference is found.
3541 "Non-nil when a footnote reference is the first one for its label.
3543 FOOTNOTE-REFERENCE is the footnote reference being considered.
3544 INFO is the plist used as a communication channel."
3546 ;; Anonymous footnotes are always a first reference.
3548 ;; Otherwise, return the first footnote with the same LABEL and
3549 ;; test if it is equal to FOOTNOTE-REFERENCE.
3559 ;; If FN isn't inlined, be sure to traverse its
3560 ;; definition before resuming search. See
3561 ;; comments in `org-export-get-footnote-number'
3562 ;; for more information.
3566 ;; Don't enter footnote definitions since it will
3567 ;; happen when their first reference is found.
3570 footnote-reference)))))
3573 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3574 INFO is the plist used as a communication channel. If no such
3576 string."
3583 "Return number associated to a footnote.
3585 FOOTNOTE is either a footnote reference or a footnote definition.
3586 INFO is the plist used as a communication channel."
3588 seen-refs
3589 search-ref ; For byte-compiler.
3593 ;; Search footnote references through DATA, filling
3594 ;; SEEN-REFS along the way.
3599 ;; Anonymous footnote match: return number.
3602 ;; Labels match: return number.
3605 ;; Anonymous footnote: it's always a new one.
3606 ;; Also, be sure to return nil from the `cond' so
3607 ;; `first-match' doesn't get us out of the loop.
3609 ;; Label not seen so far: add it so SEEN-REFS.
3610 ;;
3611 ;; Also search for subsequent references in
3612 ;; footnote definition so numbering follows
3613 ;; reading logic. Note that we don't have to care
3614 ;; about inline definitions, since
3615 ;; `org-element-map' already traverses them at the
3616 ;; right time.
3617 ;;
3618 ;; Once again, return nil to stay in the loop.
3623 nil))))
3624 ;; Don't enter footnote definitions since it will
3625 ;; happen when their first reference is found.
3630 ;;;; For Headlines
3631 ;;
3632 ;; `org-export-get-relative-level' is a shortcut to get headline
3633 ;; level, relatively to the lower headline level in the parsed tree.
3634 ;;
3635 ;; `org-export-get-headline-number' returns the section number of an
3636 ;; headline, while `org-export-number-to-roman' allows to convert it
3637 ;; to roman numbers.
3638 ;;
3639 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3640 ;; `org-export-last-sibling-p' are three useful predicates when it
3641 ;; comes to fulfill the `:headline-levels' property.
3642 ;;
3643 ;; `org-export-get-tags', `org-export-get-category' and
3644 ;; `org-export-get-node-property' extract useful information from an
3645 ;; headline or a parent headline. They all handle inheritance.
3646 ;;
3647 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3648 ;; as a secondary string, suitable for table of contents. It falls
3649 ;; back onto default title.
3652 "Return HEADLINE relative level within current parsed tree.
3653 INFO is a plist holding contextual information."
3658 "Non-nil when HEADLINE is considered as low level.
3660 INFO is a plist used as a communication channel.
3662 A low level headlines has a relative level greater than
3663 `:headline-levels' property value.
3665 Return value is the difference between HEADLINE relative level
3666 and the last level being considered as high enough, or nil."
3673 "Return HEADLINE numbering as a list of numbers.
3674 INFO is a plist holding contextual information."
3678 "Return a non-nil value if HEADLINE element should be numbered.
3679 INFO is a plist used as a communication channel."
3685 "Convert integer N into a roman numeral."
3698 res)))
3701 "Return list of tags associated to ELEMENT.
3703 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3704 is a plist used as a communication channel.
3706 Select tags (see `org-export-select-tags') and exclude tags (see
3707 `org-export-exclude-tags') are removed from the list.
3709 When non-nil, optional argument TAGS should be a list of strings.
3710 Any tag belonging to this list will also be removed.
3712 When optional argument INHERITED is non-nil, tags can also be
3713 inherited from parent headlines and FILETAGS keywords."
3719 ;; Build complete list of inherited tags.
3730 ;; Add FILETAGS keywords and return results.
3734 "Return node PROPERTY value for BLOB.
3736 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3737 element or object.
3739 If optional argument INHERITED is non-nil, the value can be
3740 inherited from a parent headline.
3742 Return value is a string or nil."
3754 "Return category for element or object BLOB.
3756 INFO is a plist used as a communication channel.
3758 CATEGORY is automatically inherited from a parent headline, from
3759 #+CATEGORY: keyword or created out of original file name. If all
3763 ;; Almost like `org-export-node-property', but we cannot trust
3764 ;; `plist-member' as every headline has a `:CATEGORY'
3765 ;; property, would it be nil or equal to "???" (which has the
3766 ;; same meaning).
3784 "Return alternative title for HEADLINE, as a secondary string.
3785 INFO is a plist used as a communication channel. If no optional
3786 title is defined, fall-back to the regular title."
3791 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3792 INFO is a plist used as a communication channel."
3797 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3798 INFO is a plist used as a communication channel."
3802 ;;;; For Keywords
3803 ;;
3804 ;; `org-export-get-date' returns a date appropriate for the document
3805 ;; to about to be exported. In particular, it takes care of
3806 ;; `org-export-date-timestamp-format'.
3809 "Return date value for the current document.
3811 INFO is a plist used as a communication channel. FMT, when
3812 non-nil, is a time format string that will be applied on the date
3813 if it consists in a single timestamp object. It defaults to
3814 `org-export-date-timestamp-format' when nil.
3816 A proper date can be a secondary string, a string or nil. It is
3817 meant to be translated with `org-export-data' or alike."
3828 ;;;; For Links
3829 ;;
3830 ;; `org-export-solidify-link-text' turns a string into a safer version
3831 ;; for links, replacing most non-standard characters with hyphens.
3832 ;;
3833 ;; `org-export-get-coderef-format' returns an appropriate format
3834 ;; string for coderefs.
3835 ;;
3836 ;; `org-export-inline-image-p' returns a non-nil value when the link
3837 ;; provided should be considered as an inline image.
3838 ;;
3839 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3840 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3841 ;; returns an appropriate unique identifier when found, or nil.
3842 ;;
3843 ;; `org-export-resolve-id-link' returns the first headline with
3844 ;; specified id or custom-id in parse tree, the path to the external
3845 ;; file with the id or nil when neither was found.
3846 ;;
3847 ;; `org-export-resolve-coderef' associates a reference to a line
3848 ;; number in the element it belongs, or returns the reference itself
3849 ;; when the element isn't numbered.
3852 "Take link text S and make a safe target out of it."
3857 "Return format string for code reference link.
3858 PATH is the link path. DESC is its description."
3866 "Non-nil if LINK object points to an inline image.
3868 Optional argument is a set of RULES defining inline images. It
3869 is an alist where associations have the following shape:
3871 \(TYPE . REGEXP)
3873 Applying a rule means apply REGEXP against LINK's path when its
3874 type is TYPE. The function will return a non-nil value if any of
3875 the provided rules is non-nil. The default rule is
3876 `org-export-default-inline-image-rule'.
3878 This only applies to links without a description."
3889 rules)
3890 ;; Return nil if no rule matched.
3891 nil))))
3894 "Resolve a code reference REF.
3896 INFO is a plist used as a communication channel.
3898 Return associated line number in source code, or REF itself,
3899 depending on src-block or example element's switches."
3906 org-coderef-label-format)))
3910 ;; Element containing REF is found. Resolve it to either
3911 ;; a label or a line number, as needed.
3921 "Return LINK destination.
3923 INFO is a plist holding contextual information.
3925 Return value can be an object, an element, or nil:
3927 - If LINK path matches a target object (i.e. <<path>>) return it.
3929 - If LINK path exactly matches the name affiliated keyword
3930 \(i.e. #+NAME: path) of an element, return that element.
3932 - If LINK path exactly matches any headline name, return that
3933 element. If more than one headline share that name, priority
3934 will be given to the one with the closest common ancestor, if
3935 any, or the first one in the parse tree otherwise.
3937 - Otherwise, return nil.
3940 significant."
3943 ;; Split PATH at white spaces so matches are space
3944 ;; insensitive.
3947 ;; Cache for destinations that are not position dependent.
3955 ;; Destination is not position dependent: use cached value.
3957 ;; First try to find a matching "<<path>>" unless user specified
3958 ;; he was looking for a headline (path starts with a "*"
3959 ;; character).
3965 path)
3966 blob))
3969 ;; Then try to find an element with a matching "#+NAME: path"
3970 ;; affiliated keyword.
3973 org-element-all-elements
3978 el)))
3981 ;; Last case: link either points to a headline or to nothingness.
3982 ;; Try to find the source, with priority given to headlines with
3983 ;; the closest common ancestor. If such candidate is found,
3984 ;; return it, otherwise return nil.
3988 ;; Return first headline whose `:raw-value' property is
3989 ;; NAME in parse tree DATA, or nil. Statistics cookies
3990 ;; are ignored.
3998 name)
3999 headline))
4001 ;; Search among headlines sharing an ancestor with link, from
4002 ;; closest to farthest.
4011 ;; No destination found: return nil.
4015 "Return headline referenced as LINK destination.
4017 INFO is a plist used as a communication channel.
4019 Return value can be the headline element matched in current parse
4023 ;; First check if id is within the current parse tree.
4028 headline))
4030 ;; Otherwise, look for external files.
4034 "Return radio-target object referenced as LINK destination.
4036 INFO is a plist used as a communication channel.
4038 Return value can be a radio-target object or nil. Assume LINK
4047 nil nil path nil nil t)
4048 t)
4049 radio))
4053 ;;;; For References
4054 ;;
4055 ;; `org-export-get-ordinal' associates a sequence number to any object
4056 ;; or element.
4059 "Return ordinal number of an element or object.
4061 ELEMENT is the element or object considered. INFO is the plist
4062 used as a communication channel.
4064 Optional argument TYPES, when non-nil, is a list of element or
4065 object types, as symbols, that should also be counted in.
4066 Otherwise, only provided element's type is considered.
4068 Optional argument PREDICATE is a function returning a non-nil
4069 value if the current element or object should be counted in. It
4070 accepts two arguments: the element or object being considered and
4071 the plist used as a communication channel. This allows to count
4072 only a certain type of objects (i.e. inline images).
4074 Return value is a list of numbers if ELEMENT is a headline or an
4075 item. It is nil for keywords. It represents the footnote number
4076 for footnote definitions and footnote references. If ELEMENT is
4077 a target, return the same value as if ELEMENT was the closest
4078 table, item or headline containing the target. In any other
4079 case, return the sequence number of ELEMENT among elements or
4080 objects of the same type."
4081 ;; Ordinal of a target object refer to the ordinal of the closest
4082 ;; table, item, or headline containing the object.
4086 when
4090 table))
4091 return parent)))
4093 ;; Special case 1: A headline returns its number as a list.
4095 ;; Special case 2: An item returns its number as a list.
4099 struct
4106 ;; Increment counter until ELEMENT is found again.
4117 ;;;; For Src-Blocks
4118 ;;
4119 ;; `org-export-get-loc' counts number of code lines accumulated in
4120 ;; src-block or example-block elements with a "+n" switch until
4121 ;; a given element, excluded. Note: "-n" switches reset that count.
4122 ;;
4123 ;; `org-export-unravel-code' extracts source code (along with a code
4124 ;; references alist) from an `element-block' or `src-block' type
4125 ;; element.
4126 ;;
4127 ;; `org-export-format-code' applies a formatting function to each line
4128 ;; of code, providing relative line number and code reference when
4129 ;; appropriate. Since it doesn't access the original element from
4130 ;; which the source code is coming, it expects from the code calling
4131 ;; it to know if lines should be numbered and if code references
4132 ;; should appear.
4133 ;;
4134 ;; Eventually, `org-export-format-code-default' is a higher-level
4135 ;; function (it makes use of the two previous functions) which handles
4136 ;; line numbering and code references inclusion, and returns source
4137 ;; code in a format suitable for plain text or verbatim output.
4140 "Return accumulated lines of code up to ELEMENT.
4142 INFO is the plist used as a communication channel.
4144 ELEMENT is excluded from count."
4150 ;; ELEMENT is reached: Quit the loop.
4152 ;; Only count lines from src-block and example-block elements
4153 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4157 ;; Accumulate locs or reset them.
4161 ;; Return nil to stay in the loop.
4162 nil)))
4164 ;; Return value.
4165 loc))
4168 "Clean source code and extract references out of it.
4170 ELEMENT has either a `src-block' an `example-block' type.
4172 Return a cons cell whose CAR is the source code, cleaned from any
4173 reference and protective comma and CDR is an alist between
4174 relative line number (integer) and name of code reference on that
4175 line (string)."
4177 ;; Get code and clean it. Remove blank lines at its
4178 ;; beginning and end.
4184 ;; Get format used for references.
4187 org-coderef-label-format)))
4188 ;; Build a regexp matching a loc with a reference.
4193 ;; Return value.
4195 ;; Code with references removed.
4201 ;; Ref line: remove ref, and signal its position in REFS.
4205 ;; Reference alist.
4206 refs)))
4209 "Format CODE by applying FUN line-wise and return it.
4211 CODE is a string representing the code to format. FUN is
4212 a function. It must accept three arguments: a line of
4213 code (string), the current line number (integer) or nil and the
4214 reference associated to the current line (string) or nil.
4216 Optional argument NUM-LINES can be an integer representing the
4217 number of code lines accumulated until the current code. Line
4218 numbers passed to FUN will take it into account. If it is nil,
4219 FUN's second argument will always be nil. This number can be
4220 obtained with `org-export-get-loc' function.
4222 Optional argument REF-ALIST can be an alist between relative line
4223 number (i.e. ignoring NUM-LINES) and the name of the code
4224 reference on it. If it is nil, FUN's third argument will always
4225 be nil. It can be obtained through the use of
4226 `org-export-unravel-code' function."
4238 "Return source code from ELEMENT, formatted in a standard way.
4240 ELEMENT is either a `src-block' or `example-block' element. INFO
4241 is a plist used as a communication channel.
4243 This function takes care of line numbering and code references
4244 inclusion. Line numbers, when applicable, appear at the
4245 beginning of the line, separated from the code by two white
4246 spaces. Code references, on the other hand, appear flushed to
4247 the right, separated by six white spaces from the widest line of
4248 code."
4249 ;; Extract code and references.
4256 ;; Handle line numbering.
4265 ;; Prepare references display, if required. Any reference
4266 ;; should start six columns after the widest line of code,
4267 ;; wrapped with parenthesis.
4272 code
4276 number-str
4277 loc
4283 num-start refs)))))
4286 ;;;; For Tables
4287 ;;
4288 ;; `org-export-table-has-special-column-p' and and
4289 ;; `org-export-table-row-is-special-p' are predicates used to look for
4290 ;; meta-information about the table structure.
4291 ;;
4292 ;; `org-table-has-header-p' tells when the rows before the first rule
4293 ;; should be considered as table's header.
4294 ;;
4295 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4296 ;; and `org-export-table-cell-borders' extract information from
4297 ;; a table-cell element.
4298 ;;
4299 ;; `org-export-table-dimensions' gives the number on rows and columns
4300 ;; in the table, ignoring horizontal rules and special columns.
4301 ;; `org-export-table-cell-address', given a table-cell object, returns
4302 ;; the absolute address of a cell. On the other hand,
4303 ;; `org-export-get-table-cell-at' does the contrary.
4304 ;;
4305 ;; `org-export-table-cell-starts-colgroup-p',
4306 ;; `org-export-table-cell-ends-colgroup-p',
4307 ;; `org-export-table-row-starts-rowgroup-p',
4308 ;; `org-export-table-row-ends-rowgroup-p',
4309 ;; `org-export-table-row-starts-header-p' and
4310 ;; `org-export-table-row-ends-header-p' indicate position of current
4311 ;; row or cell within the table.
4314 "Non-nil when TABLE has a special column.
4315 All special columns will be ignored during export."
4316 ;; The table has a special column when every first cell of every row
4317 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4318 ;; "*" "_" and "^". Though, do not consider a first row containing
4319 ;; only empty cells as special.
4335 "Non-nil when TABLE has a header.
4337 INFO is a plist used as a communication channel.
4339 A table has a header when it contains at least two row groups."
4348 table
4359 cache)))))
4362 "Non-nil if TABLE-ROW is considered special.
4364 INFO is a plist used as the communication channel.
4366 All special rows will be ignored during export."
4370 ;; A row is special either when...
4372 ;; ... it starts with a field only containing "/",
4374 ;; ... the table contains a special column and the row start
4375 ;; with a marking character among, "^", "_", "$" or "!",
4379 ;; ... it contains only alignment cookies and empty cells.
4385 ;; Since VALUE is a secondary string, the following
4386 ;; checks avoid expanding it with `org-export-data'.
4398 "Return TABLE-ROW's group number, as an integer.
4400 INFO is a plist used as the communication channel.
4402 Return value is the group number, as an integer, or nil for
4403 special rows and rows separators. First group is also table's
4404 header."
4422 "Return TABLE-CELL contents width.
4424 INFO is a plist used as the communication channel.
4426 Return value is the width given by the last width cookie in the
4427 same column as TABLE-CELL, or nil."
4446 ;; In a special row, try to find a width cookie at COLUMN.
4450 ;; The following checks avoid expanding unnecessarily
4451 ;; the cell with `org-export-data'.
4461 "Return TABLE-CELL contents alignment.
4463 INFO is a plist used as the communication channel.
4465 Return alignment as specified by the last alignment cookie in the
4466 same column as TABLE-CELL. If no such cookie is found, a default
4467 alignment value will be deduced from fraction of numbers in the
4468 column (see `org-table-number-fraction' for more information).
4469 Possible values are `left', `right' and `center'."
4470 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4487 cookie-align
4488 previous-cell-number-p)
4491 ;; In a special row, try to find an alignment cookie at
4492 ;; COLUMN.
4496 ;; Since VALUE is a secondary string, the following
4497 ;; checks avoid useless expansion through
4498 ;; `org-export-data'.
4506 ;; Ignore table rules.
4508 ;; In a standard row, check if cell's contents are
4509 ;; expressing some kind of number. Increase NUMBER-CELLS
4510 ;; accordingly. Though, don't bother if an alignment
4511 ;; cookie has already defined cell's alignment.
4516 info)))
4518 ;; Treat an empty cell as a number if it follows
4519 ;; a number.
4525 ;; Return value. Alignment specified by cookies has
4526 ;; precedence over alignment deduced from cell's contents.
4528 column
4533 org-table-number-fraction)
4538 "Return TABLE-CELL borders.
4540 INFO is a plist used as a communication channel.
4542 Return value is a list of symbols, or nil. Possible values are:
4543 `top', `bottom', `above', `below', `left' and `right'. Note:
4544 `top' (resp. `bottom') only happen for a cell in the first
4545 row (resp. last row) of the table, ignoring table rules, if any.
4547 Returned borders ignore special rows."
4550 borders)
4551 ;; Top/above border? TABLE-CELL has a border above when a rule
4552 ;; used to demarcate row groups can be found above. Hence,
4553 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4554 ;; another regular row has to be found above that rule.
4563 ;; Look at every row before the current one.
4565 ;; No rule above, or rule found starts the table (ignoring any
4566 ;; special row): TABLE-CELL is at the top of the table.
4569 ;; Bottom/below border? TABLE-CELL has a border below when next
4570 ;; non-regular row below is a rule.
4579 ;; Look at every row after the current one.
4581 ;; No rule below, or rule found ends the table (modulo some
4582 ;; special row): TABLE-CELL is at the bottom of the table.
4585 ;; Right/left borders? They can only be specified by column
4586 ;; groups. Column groups are defined in a row starting with "/".
4587 ;; Also a column groups row only contains "<", "<>", ">" or blank
4588 ;; cells.
4605 ;; There's a left border when previous cell, if
4606 ;; any, ends a group, or current one starts one.
4612 ;; There's a right border when next cell, if any,
4613 ;; starts a group, or current one ends one.
4620 ;; Table rows are read in reverse order so last column groups
4621 ;; row has precedence over any previous one.
4623 ;; Return value.
4624 borders))
4627 "Non-nil when TABLE-CELL is at the beginning of a row group.
4628 INFO is a plist used as a communication channel."
4629 ;; A cell starts a column group either when it is at the beginning
4630 ;; of a row (or after the special column, if any) or when it has
4631 ;; a left border.
4634 table-cell)
4638 "Non-nil when TABLE-CELL is at the end of a row group.
4639 INFO is a plist used as a communication channel."
4640 ;; A cell ends a column group either when it is at the end of a row
4641 ;; or when it has a right border.
4644 table-cell)
4648 "Non-nil when TABLE-ROW is at the beginning of a column group.
4649 INFO is a plist used as a communication channel."
4657 "Non-nil when TABLE-ROW is at the end of a column group.
4658 INFO is a plist used as a communication channel."
4666 "Non-nil when TABLE-ROW is the first table header's row.
4667 INFO is a plist used as a communication channel."
4674 "Non-nil when TABLE-ROW is the last table header's row.
4675 INFO is a plist used as a communication channel."
4682 "Return TABLE-ROW number.
4683 INFO is a plist used as a communication channel. Return value is
4684 zero-based and ignores separators. The function returns nil for
4685 special columns and separators."
4697 "Return TABLE dimensions.
4699 INFO is a plist used as a communication channel.
4701 Return value is a CONS like (ROWS . COLUMNS) where
4702 ROWS (resp. COLUMNS) is the number of exportable
4703 rows (resp. columns)."
4705 ;; Set number of rows, and extract first one.
4711 ;; Set number of columns.
4713 ;; Return value.
4717 "Return address of a regular TABLE-CELL object.
4719 TABLE-CELL is the cell considered. INFO is a plist used as
4720 a communication channel.
4722 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4723 zero-based index. Only exportable cells are considered. The
4724 function returns nil for other cells."
4736 "Return regular table-cell object at ADDRESS in TABLE.
4738 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4739 zero-based index. TABLE is a table type element. INFO is
4740 a plist used as a communication channel.
4742 If no table-cell, among exportable cells, is found at ADDRESS,
4743 return nil."
4746 ;; Row at (car address) or nil.
4754 'table-cell
4761 ;;;; For Tables Of Contents
4762 ;;
4763 ;; `org-export-collect-headlines' builds a list of all exportable
4764 ;; headline elements, maybe limited to a certain depth. One can then
4765 ;; easily parse it and transcode it.
4766 ;;
4767 ;; Building lists of tables, figures or listings is quite similar.
4768 ;; Once the generic function `org-export-collect-elements' is defined,
4769 ;; `org-export-collect-tables', `org-export-collect-figures' and
4770 ;; `org-export-collect-listings' can be derived from it.
4773 "Collect headlines in order to build a table of contents.
4775 INFO is a plist used as a communication channel.
4777 When optional argument N is an integer, it specifies the depth of
4778 the table of contents. Otherwise, it is set to the value of the
4779 last headline level. See `org-export-headline-levels' for more
4780 information.
4782 Return a list of all exportable headlines as parsed elements.
4783 Footnote sections, if any, will be ignored."
4791 info)))
4794 "Collect referenceable elements of a determined type.
4796 TYPE can be a symbol or a list of symbols specifying element
4797 types to search. Only elements with a caption are collected.
4799 INFO is a plist used as a communication channel.
4801 When non-nil, optional argument PREDICATE is a function accepting
4802 one argument, an element of type TYPE. It returns a non-nil
4803 value when that element should be collected.
4805 Return a list of all elements found, in order of appearance."
4810 element))
4811 info))
4814 "Build a list of tables.
4815 INFO is a plist used as a communication channel.
4817 Return a list of table elements with a caption."
4821 "Build a list of figures.
4823 INFO is a plist used as a communication channel. PREDICATE is
4824 a function which accepts one argument: a paragraph element and
4825 whose return value is non-nil when that element should be
4826 collected.
4828 A figure is a paragraph type element, with a caption, verifying
4830 a vague concept that may depend on back-end.
4832 Return a list of elements recognized as figures."
4836 "Build a list of src blocks.
4838 INFO is a plist used as a communication channel.
4840 Return a list of src-block elements with a caption."
4844 ;;;; Smart Quotes
4845 ;;
4846 ;; The main function for the smart quotes sub-system is
4847 ;; `org-export-activate-smart-quotes', which replaces every quote in
4848 ;; a given string from the parse tree with its "smart" counterpart.
4849 ;;
4850 ;; Dictionary for smart quotes is stored in
4851 ;; `org-export-smart-quotes-alist'.
4852 ;;
4853 ;; Internally, regexps matching potential smart quotes (checks at
4854 ;; string boundaries are also necessary) are defined in
4855 ;; `org-export-smart-quotes-regexps'.
4859 ;; one may use: »...«, "...", ›...‹, or '...'.
4860 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4861 ;; LaTeX quotes require Babel!
4906 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4915 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4924 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4933 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4939 )
4940 "Smart quotes translations.
4942 Alist whose CAR is a language string and CDR is an alist with
4943 quote type as key and a plist associating various encodings to
4944 their translation as value.
4946 A quote type can be any symbol among `opening-double-quote',
4947 `closing-double-quote', `opening-single-quote',
4948 `closing-single-quote' and `apostrophe'.
4950 Valid encodings include `:utf-8', `:html', `:latex' and
4951 `:texinfo'.
4957 ;; Possible opening quote at beginning of string.
4959 ;; Possible closing quote at beginning of string.
4961 ;; Possible apostrophe at beginning of string.
4963 ;; Opening single and double quotes.
4965 ;; Closing single and double quotes.
4967 ;; Apostrophe.
4969 ;; Possible opening quote at end of string.
4971 ;; Possible closing quote at end of string.
4973 ;; Possible apostrophe at end of string.
4975 "List of regexps matching a quote or an apostrophe.
4981 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4982 `:utf-8'. INFO is a plist used as a communication channel.
4984 The function has to retrieve information about string
4985 surroundings in parse tree. It can only happen with an
4986 unmodified string. Thus, if S has already been through another
4987 process, a non-nil ORIGINAL optional argument will provide that
4988 original string.
4990 Return the new string."
4993 ;; Try to be flexible when computing number of blanks
4994 ;; before object. The previous object may be a string
4995 ;; introduced by the back-end and not completely parsed.
4998 ;; A string with missing `:post-blank'
4999 ;; property.
5003 ;; Fallback value.
5008 ;; Return smart quote associated to a give quote Q, as
5009 ;; a string. TYPE is a symbol among `open', `close' and
5010 ;; `apostrophe'.
5020 org-export-smart-quotes-alist))))
5021 encoding)
5022 q)))))
5024 ;; Only a quote: no regexp can match. We have to check both
5025 ;; sides and decide what to do.
5033 ;; 1. Replace quote character at the beginning of S.
5035 ;; Apostrophe?
5041 ;; Closing quote?
5047 ;; Opening quote?
5053 ;; 2. Replace quotes in the middle of the string.
5055 ;; Opening quotes.
5061 ;; Closing quotes.
5067 ;; Apostrophes.
5072 ;; 3. Replace quote character at the end of S.
5074 ;; Apostrophe?
5079 ;; Closing quote?
5085 ;; Opening quote?
5090 ;; Return string with smart quotes.
5091 s))))
5093 ;;;; Topology
5094 ;;
5095 ;; Here are various functions to retrieve information about the
5096 ;; neighbourhood of a given element or object. Neighbours of interest
5097 ;; are direct parent (`org-export-get-parent'), parent headline
5098 ;; (`org-export-get-parent-headline'), first element containing an
5099 ;; object, (`org-export-get-parent-element'), parent table
5100 ;; (`org-export-get-parent-table'), previous element or object
5101 ;; (`org-export-get-previous-element') and next element or object
5102 ;; (`org-export-get-next-element').
5103 ;;
5104 ;; `org-export-get-genealogy' returns the full genealogy of a given
5105 ;; element or object, from closest parent to full parse tree.
5108 "Return BLOB parent or nil.
5109 BLOB is the element or object considered."
5113 "Return full genealogy relative to a given element or object.
5115 BLOB is the element or object being considered.
5117 Ancestors are returned from closest to farthest, the last one
5118 being the full parse tree."
5125 "Return BLOB parent headline or nil.
5126 BLOB is the element or object being considered."
5130 parent))
5133 "Return first element containing OBJECT or nil.
5134 OBJECT is the object to consider."
5138 parent))
5141 "Return OBJECT parent table or nil.
5142 OBJECT is either a `table-cell' or `table-element' type object."
5146 parent))
5149 "Return previous element or object.
5151 BLOB is an element or object. INFO is a plist used as
5152 a communication channel. Return previous exportable element or
5153 object, a string, or nil.
5155 When optional argument N is a positive integer, return a list
5156 containing up to N siblings before BLOB, from farthest to
5157 closest. With any other non-nil value, return a list containing
5158 all of them."
5160 ;; An object can belong to the contents of its parent or
5161 ;; to a secondary string. We check the latter option
5162 ;; first.
5166 org-element-secondary-value-alist))
5167 parent)))
5170 prev)
5179 prev)))
5182 "Return next element or object.
5184 BLOB is an element or object. INFO is a plist used as
5185 a communication channel. Return next exportable element or
5186 object, a string, or nil.
5188 When optional argument N is a positive integer, return a list
5189 containing up to N siblings after BLOB, from closest to farthest.
5190 With any other non-nil value, return a list containing all of
5191 them."
5193 ;; An object can belong to the contents of its parent or to
5194 ;; a secondary string. We check the latter option first.
5198 org-element-secondary-value-alist))
5199 parent)))
5202 next)
5210 siblings)
5214 ;;;; Translation
5215 ;;
5216 ;; `org-export-translate' translates a string according to the language
5217 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5218 ;; the dictionary used for the translation.
5402 "Dictionary for export engine.
5404 Alist whose CAR is the string to translate and CDR is an alist
5405 whose CAR is the language string and CDR is a plist whose
5406 properties are possible charsets and values translated terms.
5408 It is used as a database for `org-export-translate'. Since this
5409 function returns the string as-is if no translation was found,
5410 the variable only needs to record values different from the
5414 "Translate string S according to language specification.
5416 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5417 and `:utf-8'. INFO is a plist used as a communication channel.
5419 Translation depends on `:language' property. Return the
5420 translated string. If no translation is found, try to fall back
5421 to `:default' encoding. If it fails, return S."
5427 s)))
5430 \f
5431 ;;; Asynchronous Export
5432 ;;
5433 ;; `org-export-async-start' is the entry point for asynchronous
5434 ;; export. It recreates current buffer (including visibility,
5435 ;; narrowing and visited file) in an external Emacs process, and
5436 ;; evaluates a command there. It then applies a function on the
5437 ;; returned results in the current process.
5438 ;;
5439 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5440 ;; allow to export to a buffer or a file, asynchronously or not.
5441 ;;
5442 ;; `org-export-output-file-name' is an auxiliary function meant to be
5443 ;; used with `org-export-to-file'. With a given extension, it tries
5444 ;; to provide a canonical file name to write export output to.
5445 ;;
5446 ;; Asynchronously generated results are never displayed directly.
5447 ;; Instead, they are stored in `org-export-stack-contents'. They can
5448 ;; then be retrieved by calling `org-export-stack'.
5449 ;;
5450 ;; Export Stack is viewed through a dedicated major mode
5451 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5452 ;;`org-export-stack-delete', `org-export-stack-view' and
5453 ;;`org-export-stack-clear'.
5454 ;;
5455 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5456 ;; It should be used whenever `org-export-async-start' is called.
5459 "Call function FUN on the results returned by BODY evaluation.
5461 BODY evaluation happens in an asynchronous process, from a buffer
5462 which is an exact copy of the current one.
5464 Use `org-export-add-to-stack' in FUN in order to register results
5465 in the stack.
5467 This is a low level function. See also `org-export-to-buffer'
5468 and `org-export-to-file' for more specialized functions."
5471 ;; Write the full sexp evaluating BODY in a copy of the current
5472 ;; buffer to a temporary file, as it may be too long for program
5473 ;; args in `start-process'.
5480 ;; Null characters (from variable values) are inserted
5481 ;; within the file. As a consequence, coding system for
5482 ;; buffer contents will not be recognized properly. So,
5483 ;; we make sure it is the same as the one used to display
5484 ;; the original buffer.
5486 ,coding
5489 ;; Ignore `kill-emacs-hook' and code evaluation
5490 ;; queries from Babel as we need a truly
5491 ;; non-interactive process.
5493 org-babel-confirm-evaluate-answer-no t)
5494 ;; Initialize export framework.
5496 ;; Re-create current buffer there.
5499 ;; Sexp to evaluate in the buffer.
5501 ;; Start external process.
5504 (,process
5509 "-l" org-export-async-init-file
5511 ;; Register running process in stack.
5513 ;; Set-up sentinel in order to catch results.
5516 ,process
5538 ;;;###autoload
5541 &optional async subtreep visible-only body-only ext-plist
5542 post-process)
5543 "Call `org-export-as' with output to a specified buffer.
5545 BACKEND is either an export back-end, as returned by, e.g.,
5546 `org-export-create-backend', or a symbol referring to
5547 a registered back-end.
5549 BUFFER is the name of the output buffer. If it already exists,
5550 it will be erased first, otherwise, it will be created.
5552 A non-nil optional argument ASYNC means the process should happen
5553 asynchronously. The resulting buffer should then be accessible
5554 through the `org-export-stack' interface. When ASYNC is nil, the
5555 buffer is displayed if `org-export-show-temporary-export-buffer'
5556 is non-nil.
5558 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5559 EXT-PLIST are similar to those used in `org-export-as', which
5560 see.
5562 Optional argument POST-PROCESS is a function which should accept
5563 no argument. It is always called within the current process,
5564 from BUFFER, with point at its beginning. Export back-ends can
5565 use it to set a major mode there, e.g,
5567 \(defun org-latex-export-as-latex
5568 \(&optional async subtreep visible-only body-only ext-plist)
5569 \(interactive)
5571 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5573 This function returns BUFFER."
5601 buffer)))
5603 ;;;###autoload
5606 post-process)
5607 "Call `org-export-as' with output to a specified file.
5609 BACKEND is either an export back-end, as returned by, e.g.,
5610 `org-export-create-backend', or a symbol referring to
5611 a registered back-end. FILE is the name of the output file, as
5612 a string.
5614 A non-nil optional argument ASYNC means the process should happen
5615 asynchronously. The resulting buffer will then be accessible
5616 through the `org-export-stack' interface.
5618 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5619 EXT-PLIST are similar to those used in `org-export-as', which
5620 see.
5622 Optional argument POST-PROCESS is called with FILE as its
5623 argument and happens asynchronously when ASYNC is non-nil. It
5624 has to return a file name, or nil. Export back-ends can use this
5625 to send the output file through additional processing, e.g,
5627 \(defun org-latex-export-to-latex
5628 \(&optional async subtreep visible-only body-only ext-plist)
5629 \(interactive)
5631 \(org-export-to-file 'latex outfile
5632 async subtreep visible-only body-only ext-plist
5633 \(lambda (file) (org-latex-compile file)))
5635 The function returns either a file name returned by POST-PROCESS,
5636 or FILE."
5654 backend subtreep visible-only body-only ext-plist)))
5661 ;; Get proper return value.
5663 file))))))
5666 "Return output file's name according to buffer specifications.
5668 EXTENSION is a string representing the output file extension,
5669 with the leading dot.
5671 With a non-nil optional argument SUBTREEP, try to determine
5673 of subtree at point.
5675 When optional argument PUB-DIR is set, use it as the publishing
5676 directory.
5678 When optional argument VISIBLE-ONLY is non-nil, don't export
5679 contents of hidden elements.
5681 Return file name as a string."
5684 ;; File name may come from EXPORT_FILE_NAME subtree
5685 ;; property, assuming point is at beginning of said
5686 ;; sub-tree.
5693 ;; File name may be extracted from buffer's associated
5694 ;; file, if any.
5696 ;; Can't determine file name on our own: Ask user.
5700 "Output file: " pub-dir nil nil nil
5704 ;; Build file name. Enforce EXTENSION over whatever user
5705 ;; may have come up with. PUB-DIR, if defined, always has
5706 ;; precedence over any provided path.
5711 extension))
5714 ;; If writing to OUTPUT-FILE would overwrite original file, append
5715 ;; EXTENSION another time to final name.
5718 output-file)))
5721 "Add a new result to export stack if not present already.
5723 SOURCE is a buffer or a file name containing export results.
5724 BACKEND is a symbol representing export back-end used to generate
5725 it.
5727 Entries already pointing to SOURCE and unavailable entries are
5728 removed beforehand. Return the new stack."
5734 "Menu for asynchronous export results and running processes."
5744 "Return source from export results at point in stack."
5751 source
5752 ;; SOURCE is not consistent with current line. The stack
5753 ;; view is outdated.
5757 "Remove all entries from export stack."
5762 "Refresh the asynchronous export stack.
5763 DUMMY is ignored. Unavailable sources are removed from the list.
5764 Return the new stack."
5774 ;; Back-end.
5776 ;; Age.
5779 ;; Compute age of the results.
5781 "%4h:%.2m "
5783 ;; Source.
5788 ;; Clear stack from exited processes, dead buffers or
5789 ;; non-existent files.
5801 "Remove export results at point from stack.
5802 If optional argument SOURCE is non-nil, remove it instead."
5807 org-export-stack-contents))))
5810 "View export results at point in stack.
5811 With an optional prefix argument IN-EMACS, force viewing files
5812 within Emacs."
5826 (define-key km "p" 'previous-line)
5827 (define-key km "\C-p" 'previous-line)
5828 (define-key km "\C-?" 'previous-line)
5829 (define-key km [up] 'previous-line)
5830 (define-key km "C" 'org-export-stack-clear)
5831 (define-key km "v" 'org-export-stack-view)
5832 (define-key km (kbd "RET") 'org-export-stack-view)
5833 (define-key km "d" 'org-export-stack-remove)
5834 km)
5835 "Keymap for Org Export Stack.")
5837 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5838 "Mode for displaying asynchronous export stack.
5841 stack.
5843 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5844 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5845 stack completely.
5847 Removing entries in an Org Export Stack buffer doesn't affect
5848 files or buffers, only the display.
5851 (abbrev-mode 0)
5852 (auto-fill-mode 0)
5853 (setq buffer-read-only t
5854 buffer-undo-list t
5855 truncate-lines t
5856 header-line-format
5857 '(:eval
5858 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5859 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5860 (set (make-local-variable 'revert-buffer-function)
5861 'org-export-stack-refresh))
5864 \f
5865 ;;; The Dispatcher
5866 ;;
5867 ;; `org-export-dispatch' is the standard interactive way to start an
5868 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5869 ;; for its interface, which, in turn, delegates response to key
5870 ;; pressed to `org-export--dispatch-action'.
5872 ;;;###autoload
5873 (defun org-export-dispatch (&optional arg)
5874 "Export dispatcher for Org mode.
5876 It provides an access to common export related tasks in a buffer.
5877 Its interface comes in two flavors: standard and expert.
5879 While both share the same set of bindings, only the former
5880 displays the valid keys associations in a dedicated buffer.
5881 Scrolling (resp. line-wise motion) in this buffer is done with
5882 SPC and DEL (resp. C-n and C-p) keys.
5884 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5885 flavor or the other.
5888 of options used back then, on the current buffer.
5890 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5891 (interactive "P")
5892 (let* ((input
5893 (cond ((equal arg '(16)) '(stack))
5894 ((and arg org-export-dispatch-last-action))
5895 (t (save-window-excursion
5896 (unwind-protect
5897 (progn
5898 ;; Remember where we are
5899 (move-marker org-export-dispatch-last-position
5900 (point)
5901 (org-base-buffer (current-buffer)))
5902 ;; Get and store an export command
5903 (setq org-export-dispatch-last-action
5904 (org-export--dispatch-ui
5905 (list org-export-initial-scope
5906 (and org-export-in-background 'async))
5907 nil
5908 org-export-dispatch-use-expert-ui)))
5909 (and (get-buffer "*Org Export Dispatcher*")
5910 (kill-buffer "*Org Export Dispatcher*")))))))
5911 (action (car input))
5912 (optns (cdr input)))
5913 (unless (memq 'subtree optns)
5914 (move-marker org-export-dispatch-last-position nil))
5915 (case action
5916 ;; First handle special hard-coded actions.
5917 (template (org-export-insert-default-template nil optns))
5918 (stack (org-export-stack))
5919 (publish-current-file
5920 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5921 (publish-current-project
5922 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5923 (publish-choose-project
5924 (org-publish (assoc (org-icompleting-read
5925 "Publish project: "
5926 org-publish-project-alist nil t)
5927 org-publish-project-alist)
5928 (memq 'force optns)
5929 (memq 'async optns)))
5930 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5931 (otherwise
5932 (save-excursion
5933 (when arg
5934 ;; Repeating command, maybe move cursor to restore subtree
5935 ;; context.
5936 (if (eq (marker-buffer org-export-dispatch-last-position)
5937 (org-base-buffer (current-buffer)))
5938 (goto-char org-export-dispatch-last-position)
5939 ;; We are in a different buffer, forget position.
5940 (move-marker org-export-dispatch-last-position nil)))
5941 (funcall action
5942 ;; Return a symbol instead of a list to ease
5943 ;; asynchronous export macro use.
5944 (and (memq 'async optns) t)
5945 (and (memq 'subtree optns) t)
5946 (and (memq 'visible optns) t)
5947 (and (memq 'body optns) t)))))))
5949 (defun org-export--dispatch-ui (options first-key expertp)
5950 "Handle interface for `org-export-dispatch'.
5952 OPTIONS is a list containing current interactive options set for
5953 export. It can contain any of the following symbols:
5954 `body' toggles a body-only export
5955 `subtree' restricts export to current subtree
5956 `visible' restricts export to visible part of buffer.
5957 `force' force publishing files.
5958 `async' use asynchronous export process
5960 FIRST-KEY is the key pressed to select the first level menu. It
5961 is nil when this menu hasn't been selected yet.
5963 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5964 buffer is provided, but indications about currently active
5965 options are given in the prompt. Moreover, \[?] allows to switch
5966 back to standard interface."
5967 (let* ((fontify-key
5968 (lambda (key &optional access-key)
5969 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5970 ;; non-nil is the required first-level key to activate
5971 ;; KEY. When its value is t, activate KEY independently
5972 ;; on the first key, if any. A nil value means KEY will
5973 ;; only be activated at first level.
5974 (if (or (eq access-key t) (eq access-key first-key))
5975 (org-propertize key 'face 'org-warning)
5976 key)))
5977 (fontify-value
5978 (lambda (value)
5979 ;; Fontify VALUE string.
5980 (org-propertize value 'face 'font-lock-variable-name-face)))
5981 ;; Prepare menu entries by extracting them from registered
5982 ;; back-ends and sorting them by access key and by ordinal,
5983 ;; if any.
5984 (entries
5985 (sort (sort (delq nil
5986 (mapcar 'org-export-backend-menu
5987 org-export--registered-backends))
5988 (lambda (a b)
5989 (let ((key-a (nth 1 a))
5990 (key-b (nth 1 b)))
5991 (cond ((and (numberp key-a) (numberp key-b))
5992 (< key-a key-b))
5993 ((numberp key-b) t)))))
5994 'car-less-than-car))
5995 ;; Compute a list of allowed keys based on the first key
5996 ;; pressed, if any. Some keys
5997 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
5998 ;; available.
5999 (allowed-keys
6000 (nconc (list 2 22 19 6 1)
6001 (if (not first-key) (org-uniquify (mapcar 'car entries))
6002 (let (sub-menu)
6003 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6004 (when (eq (car entry) first-key)
6005 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6006 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6007 ((not first-key) (list ?P)))
6008 (list ?& ?#)
6009 (when expertp (list ??))
6010 (list ?q)))
6011 ;; Build the help menu for standard UI.
6012 (help
6013 (unless expertp
6014 (concat
6015 ;; Options are hard-coded.
6016 (format "[%s] Body only: %s [%s] Visible only: %s
6017 \[%s] Export scope: %s [%s] Force publishing: %s
6019 (funcall fontify-key "C-b" t)
6020 (funcall fontify-value
6021 (if (memq 'body options) "On " "Off"))
6022 (funcall fontify-key "C-v" t)
6023 (funcall fontify-value
6024 (if (memq 'visible options) "On " "Off"))
6025 (funcall fontify-key "C-s" t)
6026 (funcall fontify-value
6027 (if (memq 'subtree options) "Subtree" "Buffer "))
6028 (funcall fontify-key "C-f" t)
6029 (funcall fontify-value
6030 (if (memq 'force options) "On " "Off"))
6031 (funcall fontify-key "C-a" t)
6032 (funcall fontify-value
6033 (if (memq 'async options) "On " "Off")))
6034 ;; Display registered back-end entries. When a key
6035 ;; appears for the second time, do not create another
6036 ;; entry, but append its sub-menu to existing menu.
6037 (let (last-key)
6038 (mapconcat
6039 (lambda (entry)
6040 (let ((top-key (car entry)))
6041 (concat
6042 (unless (eq top-key last-key)
6043 (setq last-key top-key)
6045 (funcall fontify-key (char-to-string top-key))
6046 (nth 1 entry)))
6047 (let ((sub-menu (nth 2 entry)))
6048 (unless (functionp sub-menu)
6049 ;; Split sub-menu into two columns.
6050 (let ((index -1))
6051 (concat
6052 (mapconcat
6053 (lambda (sub-entry)
6054 (incf index)
6055 (format
6056 (if (zerop (mod index 2)) " [%s] %-26s"
6058 (funcall fontify-key
6059 (char-to-string (car sub-entry))
6060 top-key)
6061 (nth 1 sub-entry)))
6062 sub-menu "")
6064 entries ""))
6065 ;; Publishing menu is hard-coded.
6067 [%s] Current file [%s] Current project
6069 (funcall fontify-key "P")
6070 (funcall fontify-key "f" ?P)
6071 (funcall fontify-key "p" ?P)
6072 (funcall fontify-key "x" ?P)
6073 (funcall fontify-key "a" ?P))
6075 (funcall fontify-key "&" t)
6076 (funcall fontify-key "#" t))
6077 (format "[%s] %s"
6078 (funcall fontify-key "q" t)
6079 (if first-key "Main menu" "Exit")))))
6080 ;; Build prompts for both standard and expert UI.
6081 (standard-prompt (unless expertp "Export command: "))
6082 (expert-prompt
6083 (when expertp
6084 (format
6085 "Export command (C-%s%s%s%s%s) [%s]: "
6086 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6087 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6088 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6089 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6090 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6091 (mapconcat (lambda (k)
6092 ;; Strip control characters.
6093 (unless (< k 27) (char-to-string k)))
6094 allowed-keys "")))))
6095 ;; With expert UI, just read key with a fancy prompt. In standard
6096 ;; UI, display an intrusive help buffer.
6097 (if expertp
6098 (org-export--dispatch-action
6099 expert-prompt allowed-keys entries options first-key expertp)
6100 ;; At first call, create frame layout in order to display menu.
6101 (unless (get-buffer "*Org Export Dispatcher*")
6102 (delete-other-windows)
6103 (org-switch-to-buffer-other-window
6104 (get-buffer-create "*Org Export Dispatcher*"))
6105 (setq cursor-type nil
6106 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6107 ;; Make sure that invisible cursor will not highlight square
6108 ;; brackets.
6109 (set-syntax-table (copy-syntax-table))
6110 (modify-syntax-entry ?\[ "w"))
6111 ;; At this point, the buffer containing the menu exists and is
6112 ;; visible in the current window. So, refresh it.
6113 (with-current-buffer "*Org Export Dispatcher*"
6114 ;; Refresh help. Maintain display continuity by re-visiting
6115 ;; previous window position.
6116 (let ((pos (window-start)))
6117 (erase-buffer)
6118 (insert help)
6119 (set-window-start nil pos)))
6120 (org-fit-window-to-buffer)
6121 (org-export--dispatch-action
6122 standard-prompt allowed-keys entries options first-key expertp))))
6124 (defun org-export--dispatch-action
6125 (prompt allowed-keys entries options first-key expertp)
6126 "Read a character from command input and act accordingly.
6128 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6129 a list of characters available at a given step in the process.
6130 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6131 EXPERTP are the same as defined in `org-export--dispatch-ui',
6132 which see.
6134 Toggle export options when required. Otherwise, return value is
6135 a list with action as CAR and a list of interactive export
6136 options as CDR."
6137 (let (key)
6138 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6139 ;; C-p, SPC, DEL).
6140 (while (and (setq key (read-char-exclusive prompt))
6141 (not expertp)
6142 (memq key '(14 16 ?\s ?\d)))
6143 (case key
6144 (14 (if (not (pos-visible-in-window-p (point-max)))
6145 (ignore-errors (scroll-up 1))
6146 (message "End of buffer")
6147 (sit-for 1)))
6148 (16 (if (not (pos-visible-in-window-p (point-min)))
6149 (ignore-errors (scroll-down 1))
6150 (message "Beginning of buffer")
6151 (sit-for 1)))
6152 (?\s (if (not (pos-visible-in-window-p (point-max)))
6153 (scroll-up nil)
6154 (message "End of buffer")
6155 (sit-for 1)))
6156 (?\d (if (not (pos-visible-in-window-p (point-min)))
6157 (scroll-down nil)
6158 (message "Beginning of buffer")
6159 (sit-for 1)))))
6160 (cond
6161 ;; Ignore undefined associations.
6162 ((not (memq key allowed-keys))
6163 (ding)
6164 (unless expertp (message "Invalid key") (sit-for 1))
6165 (org-export--dispatch-ui options first-key expertp))
6166 ;; q key at first level aborts export. At second level, cancel
6167 ;; first key instead.
6168 ((eq key ?q) (if (not first-key) (error "Export aborted")
6169 (org-export--dispatch-ui options nil expertp)))
6170 ;; Help key: Switch back to standard interface if expert UI was
6171 ;; active.
6172 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6173 ;; Send request for template insertion along with export scope.
6174 ((eq key ?#) (cons 'template (memq 'subtree options)))
6175 ;; Switch to asynchronous export stack.
6176 ((eq key ?&) '(stack))
6177 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6178 ((memq key '(2 22 19 6 1))
6179 (org-export--dispatch-ui
6180 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6181 (6 'force) (1 'async))))
6182 (if (memq option options) (remq option options)
6183 (cons option options)))
6184 first-key expertp))
6185 ;; Action selected: Send key and options back to
6186 ;; `org-export-dispatch'.
6187 ((or first-key (functionp (nth 2 (assq key entries))))
6188 (cons (cond
6189 ((not first-key) (nth 2 (assq key entries)))
6190 ;; Publishing actions are hard-coded. Send a special
6191 ;; signal to `org-export-dispatch'.
6192 ((eq first-key ?P)
6193 (case key
6194 (?f 'publish-current-file)
6195 (?p 'publish-current-project)
6196 (?x 'publish-choose-project)
6197 (?a 'publish-all)))
6198 ;; Return first action associated to FIRST-KEY + KEY
6199 ;; path. Indeed, derived backends can share the same
6200 ;; FIRST-KEY.
6201 (t (catch 'found
6202 (mapc (lambda (entry)
6203 (let ((match (assq key (nth 2 entry))))
6204 (when match (throw 'found (nth 2 match)))))
6205 (member (assq first-key entries) entries)))))
6206 options))
6207 ;; Otherwise, enter sub-menu.
6208 (t (org-export--dispatch-ui options key expertp)))))
6212 (provide 'ox)
6214 ;; Local variables:
6215 ;; generated-autoload-file: "org-loaddefs.el"
6216 ;; End:
6218 ;;; ox.el ends here