abc301207ee2afb95c825ab8041f4a89cc6a705a
| blob | abc301207ee2afb95c825ab8041f4a89cc6a705a |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012, 2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; GNU Emacs is free software: you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
22 ;;
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
25 ;;
26 ;; Besides that parser, the generic exporter is made of three distinct
27 ;; parts:
28 ;;
29 ;; - The communication channel consists in a property list, which is
30 ;; created and updated during the process. Its use is to offer
31 ;; every piece of information, would it be about initial environment
32 ;; or contextual data, all in a single place. The exhaustive list
33 ;; of properties is given in "The Communication Channel" section of
34 ;; this file.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core function is `org-export-as'. It returns the transcoded
48 ;; buffer as a string.
49 ;;
50 ;; An export back-end is defined with `org-export-define-backend'.
51 ;; This function can also support specific buffer keywords, OPTION
52 ;; keyword's items and filters. Refer to function's documentation for
53 ;; more information.
54 ;;
55 ;; If the new back-end shares most properties with another one,
56 ;; `org-export-define-derived-backend' can be used to simplify the
57 ;; process.
58 ;;
59 ;; Any back-end can define its own variables. Among them, those
60 ;; customizable should belong to the `org-export-BACKEND' group.
61 ;;
62 ;; Tools for common tasks across back-ends are implemented in the
63 ;; following part of the file.
64 ;;
65 ;; Then, a wrapper macro for asynchronous export,
66 ;; `org-export-async-start', along with tools to display results. are
67 ;; given in the penultimate part.
68 ;;
69 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
70 ;; back-ends is provided in the last one.
72 ;;; Code:
91 \f
92 ;;; Internal Variables
93 ;;
94 ;; Among internal variables, the most important is
95 ;; `org-export-options-alist'. This variable define the global export
96 ;; options, shared between every exporter, and how they are acquired.
142 "Alist between export properties and ways to set them.
144 The CAR of the alist is the property name, and the CDR is a list
145 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
147 KEYWORD is a string representing a buffer keyword, or nil. Each
148 property defined this way can also be set, during subtree
149 export, through a headline property named after the keyword
151 property).
152 OPTION is a string that could be found in an #+OPTIONS: line.
153 DEFAULT is the default value for the property.
154 BEHAVIOUR determines how Org should handle multiple keywords for
155 the same property. It is a symbol among:
156 nil Keep old value and discard the new one.
157 t Replace old value with the new one.
158 `space' Concatenate the values, separating them with a space.
159 `newline' Concatenate the values, separating them with
160 a newline.
161 `split' Split values at white spaces, and cons them to the
162 previous list.
164 Values set through KEYWORD and OPTION have precedence over
165 DEFAULT.
167 All these properties should be back-end agnostic. Back-end
168 specific properties are set through `org-export-define-backend'.
172 "List of in-buffer keywords that require special treatment.
173 These keywords are not directly associated to a property. The
174 way they are handled must be hard-coded into
234 "Alist between filters properties and initial values.
236 The key of each association is a property name accessible through
237 the communication channel. Its value is a configurable global
238 variable defining initial filters.
240 This list is meant to install user specified filters. Back-end
241 developers may install their own filters using
242 `org-export-define-backend'. Filters defined there will always
243 be prepended to the current list, so they always get applied
252 "Default rule for link matching an inline image.
253 This rule applies to links with no description. By default, it
254 will be considered as an inline image if it targets a local file
257 See `org-export-inline-image-p' for more information about
261 "Non-nil means asynchronous export process should leave data behind.
265 located in `temporary-file-directory'.
267 When non-nil, it will also set `debug-on-error' to a non-nil
271 "Record asynchronously generated export results and processes.
272 This is an alist: its CAR is the source of the
273 result (destination file or buffer for a finished process,
274 original buffer for a running one) and its CDR is a list
275 containing the back-end used, as a symbol, and either a process
276 or the time at which it finished. It is used to build the menu
280 "List of backends currently available in the exporter.
281 This variable is set with `org-export-define-backend' and
285 "Last command called from the dispatcher.
286 The value should be a list. Its CAR is the action, as a symbol,
290 "The position where the last export command was created using the dispatcher.
291 This marker will be used with `C-u C-c C-e' to make sure export repetition
294 ;; For compatibility with Org < 8
296 "Name, if any, of the back-end used during an export process.
298 Its value is a symbol such as `html', `latex', `ascii', or nil if
299 the back-end is anonymous (see `org-export-create-backend') or if
300 there is no export process in progress.
302 It can be used to teach Babel blocks how to act differently
305 \f
306 ;;; User-configurable Variables
307 ;;
308 ;; Configuration for the masses.
309 ;;
310 ;; They should never be accessed directly, as their value is to be
311 ;; stored in a property list (cf. `org-export-options-alist').
312 ;; Back-ends will read their value from there instead.
315 "Options for exporting Org mode files."
320 "General options for export engine."
325 "Whether sub-trees with the ARCHIVE tag should be exported.
327 This can have three different values:
328 nil Do not export, pretend this tree is not present.
329 t Do export the entire tree.
330 `headline' Only export the headline, but skip the tree below it.
332 This option can also be set with the OPTIONS keyword,
341 "Non-nil means insert author name into the exported file.
342 This option can also be set with the OPTIONS keyword,
348 "Non-nil means export CLOCK keywords.
349 This option can also be set with the OPTIONS keyword,
355 "Non-nil means the postamble should contain a creator sentence.
357 The sentence can be set in `org-export-creator-string' and
360 If the value is `comment' insert it as a comment."
368 "Non-nil means insert date in the exported document.
369 This option can also be set with the OPTIONS keyword,
375 "Time-stamp format string to use for DATE keyword.
377 The format string, when specified, only applies if date consists
378 in a single time-stamp. Otherwise its value will be ignored.
380 See `format-time-string' for details on how to build this
381 string."
389 emacs-version
391 "Information about the creator of the document.
392 This option can also be set on with the CREATOR keyword."
397 "Non-nil means export contents of standard drawers.
399 When t, all drawers are exported. This may also be a list of
400 drawer names to export, as strings. If that list starts with
401 `not', only drawers with such names will be ignored.
403 This variable doesn't apply to properties drawers. See
404 `org-export-with-properties' instead.
406 This option can also be set with the OPTIONS keyword,
419 :inline t
423 "Non-nil means insert author email into the exported file.
424 This option can also be set with the OPTIONS keyword,
430 "Non-nil means interpret *word*, /word/, _word_ and +word+.
432 If the export target supports emphasizing text, the word will be
433 typeset in bold, italic, with an underline or strike-through,
434 respectively.
436 This option can also be set with the OPTIONS keyword,
442 "Tags that exclude a tree from export.
444 All trees carrying any of these tags will be excluded from
445 export. This is without condition, so even subtrees inside that
446 carry one of the `org-export-select-tags' will be removed.
448 This option can also be set with the EXCLUDE_TAGS keyword."
455 This can be used to have pre-formatted text, fragments of code
456 etc. For example:
457 : ;; Some Lisp examples
458 : (while (defc cnt)
459 : (ding))
460 will be looking just like this in also HTML. See also the QUOTE
461 keyword. Not all export backends support this.
463 This option can also be set with the OPTIONS keyword,
469 "Non-nil means Org footnotes should be exported.
470 This option can also be set with the OPTIONS keyword,
476 "Non-nil means process LaTeX environments and fragments.
478 This option can also be set with the OPTIONS line,
481 nil Ignore math snippets.
482 `verbatim' Keep everything in verbatim.
483 t Allow export of math snippets."
493 "The last level which is still exported as a headline.
495 Inferior levels will usually produce itemize or enumerate lists
496 when exported, but back-end behaviour may differ.
498 This option can also be set with the OPTIONS keyword,
504 "The default language for export and clocktable translations, as a string.
505 This may have an association in
506 `org-clock-clocktable-language-setup',
507 `org-export-smart-quotes-alist' and `org-export-dictionary'.
508 This option can also be set with the LANGUAGE keyword."
513 "Non-nil means preserve all line breaks when exporting.
514 This option can also be set with the OPTIONS keyword,
520 "Non-nil means interpret entities when exporting.
523 Å.
525 For a list of supported names, see the constant `org-entities'
526 and the user option `org-entities-user'.
528 This option can also be set with the OPTIONS keyword,
534 "Non-nil means inlinetasks should be exported.
535 This option can also be set with the OPTIONS keyword,
543 "Non-nil means include planning info in export.
545 Planning info is the line containing either SCHEDULED:,
546 DEADLINE:, CLOSED: time-stamps, or a combination of them.
548 This option can also be set with the OPTIONS keyword,
556 "Non-nil means include priority cookies in export.
557 This option can also be set with the OPTIONS keyword,
563 "Non-nil means export contents of properties drawers.
565 When t, all properties are exported. This may also be a list of
566 properties to export, as strings.
568 This option can also be set with the OPTIONS keyword,
580 "Non-nil means add section numbers to headlines when exporting.
582 When set to an integer n, numbering will only happen for
583 headlines whose relative level is higher or equal to n.
585 This option can also be set with the OPTIONS keyword,
591 "Tags that select a tree for export.
593 If any such tag is found in a buffer, all trees that do not carry
594 one of these tags will be ignored during export. Inside trees
595 that are selected like this, you can still deselect a subtree by
596 tagging it with one of the `org-export-exclude-tags'.
598 This option can also be set with the SELECT_TAGS keyword."
603 "Non-nil means activate smart quotes during export.
604 This option can also be set with the OPTIONS keyword,
607 When setting this to non-nil, you need to take care of
608 using the correct Babel package when exporting to LaTeX.
609 E.g., you can load Babel for french like this:
620 When this option is turned on, these strings will be exported as:
622 Org HTML LaTeX UTF-8
623 -----+----------+--------+-------
625 -- – -- –
626 --- — --- —
629 This option can also be set with the OPTIONS keyword,
635 "Non-nil means include statistics cookies in export.
636 This option can also be set with the OPTIONS keyword,
646 When this option is turned on, you can use TeX-like syntax for
648 will be considered as a single item - so grouping with {} is
649 normally not needed. For example, the following things will be
650 parsed as single sub- or superscripts.
652 10^24 or 10^tau several digits will be considered 1 item.
653 10^-12 or 10^-tau a leading sign with digits or a word
654 x^2-y^3 will be read as x^2 - y^3, because items are
655 terminated by almost any nonword/nondigit char.
656 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
658 Still, ambiguity is possible - so when in doubt use {} to enclose
659 the sub/superscript. If you set this variable to the symbol
660 `{}', the braces are *required* in order to trigger
661 interpretations as sub/superscript. This can be helpful in
664 This option can also be set with the OPTIONS keyword,
673 "Non-nil means create a table of contents in exported files.
675 The TOC contains headlines with levels up
676 to`org-export-headline-levels'. When an integer, include levels
677 up to N in the toc, this may then be different from
678 `org-export-headline-levels', but it will not be allowed to be
679 larger than the number of headline levels. When nil, no table of
680 contents is made.
682 This option can also be set with the OPTIONS keyword,
692 For example:
694 | Name | Address | Birthday |
695 |-------------+----------+-----------|
696 | Arthur Dent | England | 29.2.2100 |
698 This option can also be set with the OPTIONS keyword,
704 "If nil, do not export tags, just remove them from headlines.
706 If this is the symbol `not-in-toc', tags will be removed from
707 table of contents entries, but still be shown in the headlines of
708 the document.
710 This option can also be set with the OPTIONS keyword,
719 "Non-nil means include TODO items for export.
721 This may have the following values:
722 t include tasks independent of state.
723 `todo' include only tasks that are not yet done.
724 `done' include only tasks that are already done.
725 nil ignore all tasks.
726 list of keywords include tasks with these keywords.
728 This option can also be set with the OPTIONS keyword,
740 "Non-nil means insert a time stamp into the exported file.
741 The time stamp shows when the file was created. This option can
747 "Non nil means allow timestamps in export.
749 It can be set to any of the following values:
750 t export all timestamps.
751 `active' export active timestamps only.
752 `inactive' export inactive timestamps only.
753 nil do not export timestamps
755 This only applies to timestamps isolated in a paragraph
756 containing only timestamps. Other timestamps are always
757 exported.
759 This option can also be set with the OPTIONS keyword, e.g.
769 "Non-nil means include TODO keywords in export.
770 When nil, remove all these keywords from the export. This option
776 "Non-nil means BIND keywords can define local variable values.
777 This is a potential security risk, which is why the default value
778 is nil. You can also allow them through local buffer variables."
785 "Alist between export snippets back-ends and exporter back-ends.
787 This variable allows to provide shortcuts for export snippets.
791 HTML code while every other back-end will ignore it."
800 "Coding system for the exported file."
807 "Should we push exported content to the kill ring?"
816 "The initial scope when exporting with `org-export-dispatch'.
817 This variable can be either set to `buffer' or `subtree'."
824 "Non-nil means show buffer after exporting to temp buffer.
825 When Org exports to a file, the buffer visiting that file is ever
826 shown, but remains buried. However, when exporting to
827 a temporary buffer, that buffer is popped up in a second window.
828 When this variable is nil, the buffer remains buried also in
829 these cases."
834 "Non-nil means export and publishing commands will run in background.
835 Results from an asynchronous export are never displayed
843 "File used to initialize external export process.
845 Value must be either nil or an absolute file name. When nil, the
846 external process is launched like a regular Emacs session,
847 loading user's initialization file and any site specific
848 configuration. If a file is provided, it, and only it, is loaded
849 at start-up.
851 Therefore, using a specific configuration makes the process to
852 load faster and the export more portable."
861 "Non-nil means using a non-intrusive `org-export-dispatch'.
862 In that case, no help buffer is displayed. Though, an indicator
868 asynchronous). Also, \[?] allows to switch back to standard
869 mode."
876 \f
877 ;;; Defining Back-ends
878 ;;
879 ;; An export back-end is a structure with `org-export-backend' type
880 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
881 ;; and `menu' slots.
882 ;;
883 ;; At the lowest level, a back-end is created with
884 ;; `org-export-create-backend' function.
885 ;;
886 ;; A named back-end can be registered with
887 ;; `org-export-register-backend' function. A registered back-end can
888 ;; later be referred to by its name, with `org-export-get-backend'
889 ;; function. Also, such a back-end can become the parent of a derived
890 ;; back-end from which slot values will be inherited by default.
891 ;; `org-export-derived-backend-p' can check if a given back-end is
892 ;; derived from a list of back-end names.
893 ;;
894 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
895 ;; `org-export-get-all-filters' return the full alist of transcoders,
896 ;; options and filters, including those inherited from ancestors.
897 ;;
898 ;; At a higher level, `org-export-define-backend' is the standard way
899 ;; to define an export back-end. If the new back-end is similar to
900 ;; a registered back-end, `org-export-define-derived-backend' may be
901 ;; used instead.
902 ;;
903 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
904 ;; when a given back-end hasn't been registered yet.
908 name parent transcoders options filters blocks menu)
911 "Return export back-end named after NAME.
912 NAME is a symbol. Return nil if no such back-end is found."
919 "Register BACKEND as a known export back-end.
920 BACKEND is a structure with `org-export-backend' type."
921 ;; Refuse to register an unnamed back-end.
924 ;; Refuse to register a back-end with an unknown parent.
928 ;; Register dedicated export blocks in the parser.
932 ;; If a back-end with the same name as BACKEND is already
933 ;; registered, replace it with BACKEND. Otherwise, simply add
934 ;; BACKEND to the list of registered back-ends.
940 "Signal an error if BACKEND isn't defined."
945 "Non-nil if BACKEND is derived from one of BACKENDS.
946 BACKEND is an export back-end, as returned by, e.g.,
947 `org-export-create-backend', or a symbol referring to
948 a registered back-end. BACKENDS is constituted of symbols."
960 "Return full translation table for BACKEND.
962 BACKEND is an export back-end, as return by, e.g,,
963 `org-export-create-backend'. Return value is an alist where
964 keys are element or object types, as symbols, and values are
965 transcoders.
967 Unlike to `org-export-backend-transcoders', this function
968 also returns transcoders inherited from parent back-ends,
969 if any."
973 parent)
978 transcoders)))
981 "Return export options for BACKEND.
983 BACKEND is an export back-end, as return by, e.g,,
984 `org-export-create-backend'. See `org-export-options-alist'
985 for the shape of the return value.
987 Unlike to `org-export-backend-options', this function also
988 returns options inherited from parent back-ends, if any."
992 parent)
996 options)))
999 "Return complete list of filters for BACKEND.
1001 BACKEND is an export back-end, as return by, e.g,,
1002 `org-export-create-backend'. Return value is an alist where
1003 keys are symbols and values lists of functions.
1005 Unlike to `org-export-backend-filters', this function also
1006 returns filters inherited from parent back-ends, if any."
1010 parent)
1014 filters)))
1017 "Define a new back-end BACKEND.
1019 TRANSCODERS is an alist between object or element types and
1020 functions handling them.
1022 These functions should return a string without any trailing
1023 space, or nil. They must accept three arguments: the object or
1024 element itself, its contents or nil when it isn't recursive and
1025 the property list used as a communication channel.
1027 Contents, when not nil, are stripped from any global indentation
1028 \(although the relative one is preserved). They also always end
1029 with a single newline character.
1031 If, for a given type, no function is found, that element or
1032 object type will simply be ignored, along with any blank line or
1033 white space at its end. The same will happen if the function
1034 returns the nil value. If that function returns the empty
1035 string, the type will be ignored, but the blank lines or white
1036 spaces will be kept.
1038 In addition to element and object types, one function can be
1039 associated to the `template' (or `inner-template') symbol and
1040 another one to the `plain-text' symbol.
1042 The former returns the final transcoded string, and can be used
1043 to add a preamble and a postamble to document's body. It must
1044 accept two arguments: the transcoded string and the property list
1045 containing export options. A function associated to `template'
1047 A function associated to `inner-template' is always applied.
1049 The latter, when defined, is to be called on every text not
1050 recognized as an element or an object. It must accept two
1051 arguments: the text string and the information channel. It is an
1052 appropriate place to protect special chars relative to the
1053 back-end.
1055 BODY can start with pre-defined keyword arguments. The following
1056 keywords are understood:
1058 :export-block
1060 String, or list of strings, representing block names that
1061 will not be parsed. This is used to specify blocks that will
1062 contain raw code specific to the back-end. These blocks
1063 still have to be handled by the relative `export-block' type
1064 translator.
1066 :filters-alist
1068 Alist between filters and function, or list of functions,
1069 specific to the back-end. See `org-export-filters-alist' for
1070 a list of all allowed filters. Filters defined here
1071 shouldn't make a back-end test, as it may prevent back-ends
1072 derived from this one to behave properly.
1074 :menu-entry
1076 Menu entry for the export dispatcher. It should be a list
1077 like:
1079 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1081 where :
1083 KEY is a free character selecting the back-end.
1085 DESCRIPTION-OR-ORDINAL is either a string or a number.
1087 If it is a string, is will be used to name the back-end in
1088 its menu entry. If it is a number, the following menu will
1089 be displayed as a sub-menu of the back-end with the same
1090 KEY. Also, the number will be used to determine in which
1091 order such sub-menus will appear (lowest first).
1093 ACTION-OR-MENU is either a function or an alist.
1095 If it is an action, it will be called with four
1096 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1097 BODY-ONLY. See `org-export-as' for further explanations on
1098 some of them.
1100 If it is an alist, associations should follow the
1101 pattern:
1103 '(KEY DESCRIPTION ACTION)
1105 where KEY, DESCRIPTION and ACTION are described above.
1107 Valid values include:
1111 or
1116 \(lambda (a s v b)
1117 \(if a (org-latex-export-to-pdf t s v b)
1118 \(org-open-file
1119 \(org-latex-export-to-pdf nil s v b)))))))
1121 or the following, which will be added to the previous
1122 sub-menu,
1124 '(?l 1
1128 :options-alist
1130 Alist between back-end specific properties introduced in
1131 communication channel and how their value are acquired. See
1132 `org-export-options-alist' for more information about
1133 structure of the values."
1147 :transcoders transcoders
1148 :options options
1149 :filters filters
1150 :blocks blocks
1154 "Create a new back-end as a variant of an existing one.
1156 CHILD is the name of the derived back-end. PARENT is the name of
1157 the parent back-end.
1159 BODY can start with pre-defined keyword arguments. The following
1160 keywords are understood:
1162 :export-block
1164 String, or list of strings, representing block names that
1165 will not be parsed. This is used to specify blocks that will
1166 contain raw code specific to the back-end. These blocks
1167 still have to be handled by the relative `export-block' type
1168 translator.
1170 :filters-alist
1172 Alist of filters that will overwrite or complete filters
1173 defined in PARENT back-end. See `org-export-filters-alist'
1174 for a list of allowed filters.
1176 :menu-entry
1178 Menu entry for the export dispatcher. See
1179 `org-export-define-backend' for more information about the
1180 expected value.
1182 :options-alist
1184 Alist of back-end specific properties that will overwrite or
1185 complete those defined in PARENT back-end. Refer to
1186 `org-export-options-alist' for more information about
1187 structure of the values.
1189 :translate-alist
1191 Alist of element and object types and transcoders that will
1192 overwrite or complete transcode table from PARENT back-end.
1193 Refer to `org-export-define-backend' for detailed information
1194 about transcoders.
1197 as a variant of `latex' back-end with a custom template function:
1199 \(org-export-define-derived-backend 'my-latex 'latex
1200 :translate-alist '((template . my-latex-template-fun)))
1202 The back-end could then be called with, for example:
1219 :parent parent
1220 :transcoders transcoders
1221 :options options
1222 :filters filters
1223 :blocks blocks
1227 \f
1228 ;;; The Communication Channel
1229 ;;
1230 ;; During export process, every function has access to a number of
1231 ;; properties. They are of two types:
1232 ;;
1233 ;; 1. Environment options are collected once at the very beginning of
1234 ;; the process, out of the original buffer and configuration.
1235 ;; Collecting them is handled by `org-export-get-environment'
1236 ;; function.
1237 ;;
1238 ;; Most environment options are defined through the
1239 ;; `org-export-options-alist' variable.
1240 ;;
1241 ;; 2. Tree properties are extracted directly from the parsed tree,
1242 ;; just before export, by `org-export-collect-tree-properties'.
1243 ;;
1244 ;; Here is the full list of properties available during transcode
1245 ;; process, with their category and their value type.
1246 ;;
1247 ;; + `:author' :: Author's name.
1248 ;; - category :: option
1249 ;; - type :: string
1250 ;;
1251 ;; + `:back-end' :: Current back-end used for transcoding.
1252 ;; - category :: tree
1253 ;; - type :: symbol
1254 ;;
1255 ;; + `:creator' :: String to write as creation information.
1256 ;; - category :: option
1257 ;; - type :: string
1258 ;;
1259 ;; + `:date' :: String to use as date.
1260 ;; - category :: option
1261 ;; - type :: string
1262 ;;
1263 ;; + `:description' :: Description text for the current data.
1264 ;; - category :: option
1265 ;; - type :: string
1266 ;;
1267 ;; + `:email' :: Author's email.
1268 ;; - category :: option
1269 ;; - type :: string
1270 ;;
1271 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1272 ;; process.
1273 ;; - category :: option
1274 ;; - type :: list of strings
1275 ;;
1276 ;; + `:export-options' :: List of export options available for current
1277 ;; process.
1278 ;; - category :: none
1279 ;; - type :: list of symbols, among `subtree', `body-only' and
1280 ;; `visible-only'.
1281 ;;
1282 ;; + `:exported-data' :: Hash table used for memoizing
1283 ;; `org-export-data'.
1284 ;; - category :: tree
1285 ;; - type :: hash table
1286 ;;
1287 ;; + `:filetags' :: List of global tags for buffer. Used by
1288 ;; `org-export-get-tags' to get tags with inheritance.
1289 ;; - category :: option
1290 ;; - type :: list of strings
1291 ;;
1292 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1293 ;; their definition, as parsed data. Only non-inlined footnotes
1294 ;; are represented in this alist. Also, every definition isn't
1295 ;; guaranteed to be referenced in the parse tree. The purpose of
1296 ;; this property is to preserve definitions from oblivion
1297 ;; (i.e. when the parse tree comes from a part of the original
1298 ;; buffer), it isn't meant for direct use in a back-end. To
1299 ;; retrieve a definition relative to a reference, use
1300 ;; `org-export-get-footnote-definition' instead.
1301 ;; - category :: option
1302 ;; - type :: alist (STRING . LIST)
1303 ;;
1304 ;; + `:headline-levels' :: Maximum level being exported as an
1305 ;; headline. Comparison is done with the relative level of
1306 ;; headlines in the parse tree, not necessarily with their
1307 ;; actual level.
1308 ;; - category :: option
1309 ;; - type :: integer
1310 ;;
1311 ;; + `:headline-offset' :: Difference between relative and real level
1312 ;; of headlines in the parse tree. For example, a value of -1
1313 ;; means a level 2 headline should be considered as level
1314 ;; 1 (cf. `org-export-get-relative-level').
1315 ;; - category :: tree
1316 ;; - type :: integer
1317 ;;
1318 ;; + `:headline-numbering' :: Alist between headlines and their
1319 ;; numbering, as a list of numbers
1320 ;; (cf. `org-export-get-headline-number').
1321 ;; - category :: tree
1322 ;; - type :: alist (INTEGER . LIST)
1323 ;;
1324 ;; + `:id-alist' :: Alist between ID strings and destination file's
1325 ;; path, relative to current directory. It is used by
1326 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1327 ;; external file.
1328 ;; - category :: option
1329 ;; - type :: alist (STRING . STRING)
1330 ;;
1331 ;; + `:ignore-list' :: List of elements and objects that should be
1332 ;; ignored during export.
1333 ;; - category :: tree
1334 ;; - type :: list of elements and objects
1335 ;;
1336 ;; + `:input-file' :: Full path to input file, if any.
1337 ;; - category :: option
1338 ;; - type :: string or nil
1339 ;;
1340 ;; + `:keywords' :: List of keywords attached to data.
1341 ;; - category :: option
1342 ;; - type :: string
1343 ;;
1344 ;; + `:language' :: Default language used for translations.
1345 ;; - category :: option
1346 ;; - type :: string
1347 ;;
1348 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1349 ;; transcoding.
1350 ;; - category :: option
1351 ;; - type :: list (as returned by `org-element-parse-buffer')
1352 ;;
1353 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1354 ;; all line breaks.
1355 ;; - category :: option
1356 ;; - type :: symbol (nil, t)
1357 ;;
1358 ;; + `:section-numbers' :: Non-nil means transcoding should add
1359 ;; section numbers to headlines.
1360 ;; - category :: option
1361 ;; - type :: symbol (nil, t)
1362 ;;
1363 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1364 ;; in transcoding. When such a tag is present, subtrees without
1365 ;; it are de facto excluded from the process. See
1366 ;; `use-select-tags'.
1367 ;; - category :: option
1368 ;; - type :: list of strings
1369 ;;
1370 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1371 ;; a time stamp in the output.
1372 ;; - category :: option
1373 ;; - type :: symbol (nil, t)
1374 ;;
1375 ;; + `:translate-alist' :: Alist between element and object types and
1376 ;; transcoding functions relative to the current back-end.
1377 ;; Special keys `inner-template', `template' and `plain-text' are
1378 ;; also possible.
1379 ;; - category :: option
1380 ;; - type :: alist (SYMBOL . FUNCTION)
1381 ;;
1382 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1383 ;; also be transcoded. If it is set to the `headline' symbol,
1384 ;; only the archived headline's name is retained.
1385 ;; - category :: option
1386 ;; - type :: symbol (nil, t, `headline')
1387 ;;
1388 ;; + `:with-author' :: Non-nil means author's name should be included
1389 ;; in the output.
1390 ;; - category :: option
1391 ;; - type :: symbol (nil, t)
1392 ;;
1393 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1394 ;; - category :: option
1395 ;; - type :: symbol (nil, t)
1396 ;;
1397 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1398 ;; inserted at the end of the transcoded string. If the value
1399 ;; is `comment', it should be commented.
1400 ;; - category :: option
1401 ;; - type :: symbol (`comment', nil, t)
1402 ;;
1403 ;; + `:with-date' :: Non-nil means output should contain a date.
1404 ;; - category :: option
1405 ;; - type :. symbol (nil, t)
1406 ;;
1407 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1408 ;; its value is a list of names, only drawers with such names
1409 ;; will be transcoded. If that list starts with `not', drawer
1410 ;; with these names will be skipped.
1411 ;; - category :: option
1412 ;; - type :: symbol (nil, t) or list of strings
1413 ;;
1414 ;; + `:with-email' :: Non-nil means output should contain author's
1415 ;; email.
1416 ;; - category :: option
1417 ;; - type :: symbol (nil, t)
1418 ;;
1419 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1420 ;; interpreted.
1421 ;; - category :: option
1422 ;; - type :: symbol (nil, t)
1423 ;;
1424 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1425 ;; strings starting with a colon as a fixed-with (verbatim) area.
1426 ;; - category :: option
1427 ;; - type :: symbol (nil, t)
1428 ;;
1429 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1430 ;; footnotes.
1431 ;; - category :: option
1432 ;; - type :: symbol (nil, t)
1433 ;;
1434 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1435 ;; `latex-fragment' objects should appear in export output. When
1436 ;; this property is set to `verbatim', they will be left as-is.
1437 ;; - category :: option
1438 ;; - type :: symbol (`verbatim', nil, t)
1439 ;;
1440 ;; + `:with-planning' :: Non-nil means transcoding should include
1441 ;; planning info.
1442 ;; - category :: option
1443 ;; - type :: symbol (nil, t)
1444 ;;
1445 ;; + `:with-priority' :: Non-nil means transcoding should include
1446 ;; priority cookies.
1447 ;; - category :: option
1448 ;; - type :: symbol (nil, t)
1449 ;;
1450 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1451 ;; plain text.
1452 ;; - category :: option
1453 ;; - type :: symbol (nil, t)
1454 ;;
1455 ;; + `:with-special-strings' :: Non-nil means transcoding should
1456 ;; interpret special strings in plain text.
1457 ;; - category :: option
1458 ;; - type :: symbol (nil, t)
1459 ;;
1460 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1461 ;; interpret subscript and superscript. With a value of "{}",
1462 ;; only interpret those using curly brackets.
1463 ;; - category :: option
1464 ;; - type :: symbol (nil, {}, t)
1465 ;;
1466 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1467 ;; tables.
1468 ;; - category :: option
1469 ;; - type :: symbol (nil, t)
1470 ;;
1471 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1472 ;; headlines. A `not-in-toc' value will remove them from the
1473 ;; table of contents, if any, nonetheless.
1474 ;; - category :: option
1475 ;; - type :: symbol (nil, t, `not-in-toc')
1476 ;;
1477 ;; + `:with-tasks' :: Non-nil means transcoding should include
1478 ;; headlines with a TODO keyword. A `todo' value will only
1479 ;; include headlines with a todo type keyword while a `done'
1480 ;; value will do the contrary. If a list of strings is provided,
1481 ;; only tasks with keywords belonging to that list will be kept.
1482 ;; - category :: option
1483 ;; - type :: symbol (t, todo, done, nil) or list of strings
1484 ;;
1485 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1486 ;; time stamps. Special value `active' (resp. `inactive') ask to
1487 ;; export only active (resp. inactive) timestamps. Otherwise,
1488 ;; completely remove them.
1489 ;; - category :: option
1490 ;; - type :: symbol: (`active', `inactive', t, nil)
1491 ;;
1492 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1493 ;; added to the output. An integer value limits its depth.
1494 ;; - category :: option
1495 ;; - type :: symbol (nil, t or integer)
1496 ;;
1497 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1498 ;; include TODO keywords.
1499 ;; - category :: option
1500 ;; - type :: symbol (nil, t)
1503 ;;;; Environment Options
1504 ;;
1505 ;; Environment options encompass all parameters defined outside the
1506 ;; scope of the parsed data. They come from five sources, in
1507 ;; increasing precedence order:
1508 ;;
1509 ;; - Global variables,
1510 ;; - Buffer's attributes,
1511 ;; - Options keyword symbols,
1512 ;; - Buffer keywords,
1513 ;; - Subtree properties.
1514 ;;
1515 ;; The central internal function with regards to environment options
1516 ;; is `org-export-get-environment'. It updates global variables with
1517 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1518 ;; the different sources.
1519 ;;
1520 ;; The internal functions doing the retrieval are:
1521 ;; `org-export--get-global-options',
1522 ;; `org-export--get-buffer-attributes',
1523 ;; `org-export--parse-option-keyword',
1524 ;; `org-export--get-subtree-options' and
1525 ;; `org-export--get-inbuffer-options'
1526 ;;
1527 ;; Also, `org-export--list-bound-variables' collects bound variables
1528 ;; along with their value in order to set them as buffer local
1529 ;; variables later in the process.
1532 "Collect export options from the current buffer.
1534 Optional argument BACKEND is an export back-end, as returned by
1535 `org-export-create-backend'.
1537 When optional argument SUBTREEP is non-nil, assume the export is
1538 done against the current sub-tree.
1540 Third optional argument EXT-PLIST is a property list with
1541 external parameters overriding Org default settings, but still
1542 inferior to file-local settings."
1543 ;; First install #+BIND variables since these must be set before
1544 ;; global options are read.
1547 ;; Get and prioritize export options...
1549 ;; ... from global variables...
1551 ;; ... from an external property list...
1552 ext-plist
1553 ;; ... from in-buffer settings...
1555 ;; ... and from subtree, when appropriate.
1557 ;; Eventually add misc. properties.
1559 :back-end
1560 backend
1562 :footnote-definition-alist
1563 ;; Footnotes definitions must be collected in the original
1564 ;; buffer, as there's no insurance that they will still be in
1565 ;; the parse tree, due to possible narrowing.
1579 alist))))
1580 alist))
1581 :id-alist
1582 ;; Collect id references.
1593 alist))))
1596 "Parse an OPTIONS line and return values as a plist.
1597 Optional argument BACKEND is an export back-end, as returned by,
1598 e.g., `org-export-create-backend'. It specifies which back-end
1599 specific items to read, if any."
1601 ;; Priority is given to back-end specific options.
1603 org-export-options-alist))
1604 plist)
1613 options))
1615 property
1618 plist))
1621 "Get export options in subtree at point.
1622 Optional argument BACKEND is an export back-end, as returned by,
1623 e.g., `org-export-create-backend'. It specifies back-end used
1624 for export. Return options as a plist."
1625 ;; For each buffer keyword, create a headline property setting the
1626 ;; same property in communication channel. The name for the property
1627 ;; is the keyword with "EXPORT_" appended to it.
1630 ;; Make sure point is at a heading.
1632 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1633 ;; title as its fallback value.
1639 plist :title
1642 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1646 ;; Handle other keywords. TITLE keyword is excluded as it has
1647 ;; been handled already.
1655 ;; Export properties are not case-sensitive.
1662 plist
1663 property
1665 ;; Parse VALUE if required.
1669 ;; If BEHAVIOUR is `split' expected value is
1670 ;; a list of strings, not a string.
1673 ;; Look for both general keywords and back-end specific
1674 ;; options, with priority given to the latter.
1676 org-export-options-alist)))
1677 ;; Return value.
1678 plist)))
1681 "Return current buffer export options, as a plist.
1683 Optional argument BACKEND, when non-nil, is an export back-end,
1684 as returned by, e.g., `org-export-create-backend'. It specifies
1685 which back-end specific options should also be read in the
1686 process.
1688 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1690 get-options ; For byte-compiler.
1693 ;; Priority is given to back-end specific options.
1695 org-export-options-alist))
1698 org-export-special-keywords))))
1701 ;; Return all properties associated to KEYWORD.
1708 ;; Recursively read keywords in buffer. FILES is a list
1709 ;; of files read so far. PLIST is the current property
1710 ;; list obtained.
1719 ;; Options in `org-export-special-keywords'.
1723 ;; Avoid circular dependencies.
1733 plist
1738 plist
1744 ;; Options in `org-export-options-alist'.
1749 plist property
1750 ;; Handle value depending on specified
1751 ;; BEHAVIOUR.
1757 " "
1770 ;; Return final value.
1771 plist))))
1772 ;; Read options in the current buffer.
1775 ;; Parse keywords specified in `org-element-document-properties'
1776 ;; and return PLIST.
1787 "Return properties related to buffer attributes, as a plist."
1788 ;; Store full path of input file name, or nil. For internal use.
1796 "Return global export options as a plist.
1797 Optional argument BACKEND, if non-nil, is an export back-end, as
1798 returned by, e.g., `org-export-create-backend'. It specifies
1799 which back-end specific export options should also be read in the
1800 process."
1802 ;; Priority is given to back-end specific options.
1804 org-export-options-alist)))
1811 plist
1812 prop
1813 ;; Eval default value provided. If keyword is
1814 ;; a member of `org-element-document-properties',
1815 ;; parse it as a secondary string before storing it.
1822 value)))))))))))
1825 "Return variables bound from BIND keywords in current buffer.
1826 Also look for BIND keywords in setup files. The return value is
1827 an alist where associations are (VARIABLE-NAME VALUE)."
1832 ;; Return an alist between variable names and their
1833 ;; value. FILES is a list of setup files names read so
1834 ;; far, used to avoid circular dependencies. ALIST is
1835 ;; the alist collected so far.
1846 ;; Enter setup file.
1856 alist))))))))))
1857 alist)))))
1858 ;; Return value in appropriate order of appearance.
1862 ;;;; Tree Properties
1863 ;;
1864 ;; Tree properties are information extracted from parse tree. They
1865 ;; are initialized at the beginning of the transcoding process by
1866 ;; `org-export-collect-tree-properties'.
1867 ;;
1868 ;; Dedicated functions focus on computing the value of specific tree
1869 ;; properties during initialization. Thus,
1870 ;; `org-export--populate-ignore-list' lists elements and objects that
1871 ;; should be skipped during export, `org-export--get-min-level' gets
1872 ;; the minimal exportable level, used as a basis to compute relative
1873 ;; level for headlines. Eventually
1874 ;; `org-export--collect-headline-numbering' builds an alist between
1875 ;; headlines and their numbering.
1878 "Extract tree properties from parse tree.
1880 DATA is the parse tree from which information is retrieved. INFO
1881 is a list holding export options.
1883 Following tree properties are set or updated:
1885 `:exported-data' Hash table used to memoize results from
1886 `org-export-data'.
1888 `:footnote-definition-alist' List of footnotes definitions in
1889 original buffer and current parse tree.
1891 `:headline-offset' Offset between true level of headlines and
1892 local level. An offset of -1 means a headline
1893 of level 2 should be considered as a level
1894 1 headline in the context.
1896 `:headline-numbering' Alist of all headlines as key an the
1897 associated numbering as value.
1899 `:ignore-list' List of elements that should be ignored during
1900 export.
1902 Return updated plist."
1903 ;; Install the parse tree in the communication channel, in order to
1904 ;; use `org-export-get-genealogy' and al.
1906 ;; Get the list of elements and objects to ignore, and put it into
1907 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1908 ;; been done during parse tree filtering.
1911 :ignore-list
1914 ;; Compute `:headline-offset' in order to be able to use
1915 ;; `org-export-get-relative-level'.
1918 :headline-offset
1920 ;; Update footnotes definitions list with definitions in parse tree.
1921 ;; This is required since buffer expansion might have modified
1922 ;; boundaries of footnote definitions contained in the parse tree.
1923 ;; This way, definitions in `footnote-definition-alist' are bound to
1924 ;; match those in the parse tree.
1930 defs)))
1932 ;; Properties order doesn't matter: get the rest of the tree
1933 ;; properties.
1937 info))
1940 "Return minimum exportable headline's level in DATA.
1941 DATA is parsed tree as returned by `org-element-parse-buffer'.
1942 OPTIONS is a plist holding export options."
1953 ;; If no headline was found, for the sake of consistency, set
1954 ;; minimum level to 1 nonetheless.
1958 "Return numbering of all exportable headlines in a parse tree.
1960 DATA is the parse tree. OPTIONS is the plist holding export
1961 options.
1963 Return an alist whose key is a headline and value is its
1964 associated numbering \(in the shape of a list of numbers\) or nil
1965 for a footnotes section."
1973 headline
1975 for idx from 0 to org-export-max-depth
1979 options)))
1982 "Return list of elements and objects to ignore during export.
1983 DATA is the parse tree to traverse. OPTIONS is the plist holding
1984 export options."
1986 ;; First find trees containing a select tag, if any.
1988 ;; If a select tag is active, also ignore the section before
1989 ;; the first headline, if any.
1993 first-element))))
1996 ;; Collect ignored elements or objects into IGNORE-LIST.
2002 ;; If headline is archived but tree below has
2003 ;; to be skipped, add it to ignore list.
2006 ;; Move into secondary string, if any.
2011 ;; Move into recursive objects/elements.
2013 ;; Main call.
2015 ;; Return value.
2016 ignore))
2019 "Return list of headlines and inlinetasks with a select tag in their tree.
2020 DATA is parsed data as returned by `org-element-parse-buffer'.
2021 INFO is a plist holding export options."
2023 walk-data ; For byte-compiler.
2033 ;; When a select tag is found, mark full
2034 ;; genealogy and every headline within the tree
2035 ;; as acceptable.
2038 genealogy
2041 selected-trees))
2042 ;; If at a headline, continue searching in tree,
2043 ;; recursively.
2053 selected-trees))
2056 "Non-nil when element or object BLOB should be skipped during export.
2057 OPTIONS is the plist holding export options. SELECTED, when
2058 non-nil, is a list of headlines or inlinetasks belonging to
2059 a tree with a select tag."
2066 ;; If `:with-drawers' value starts with `not', ignore
2067 ;; every drawer whose name belong to that list.
2068 ;; Otherwise, ignore drawers whose name isn't in that
2069 ;; list.
2085 ;; Ignore subtrees with an exclude tag.
2088 ;; When a select tag is present in the buffer, ignore any tree
2089 ;; without it.
2091 ;; Ignore commented sub-trees.
2093 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2095 ;; Ignore tasks, if specified by `:with-tasks' property.
2107 properties-set))))))
2117 ;; `:with-timestamps' only applies to isolated timestamps
2118 ;; objects, i.e. timestamp objects in a paragraph containing only
2119 ;; timestamps and whitespaces.
2127 options t))))
2136 \f
2137 ;;; The Transcoder
2138 ;;
2139 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2140 ;; `org-element-parse-buffer') and transcodes it into a specified
2141 ;; back-end output. It takes care of filtering out elements or
2142 ;; objects according to export options and organizing the output blank
2143 ;; lines and white space are preserved. The function memoizes its
2144 ;; results, so it is cheap to call it within transcoders.
2145 ;;
2146 ;; It is possible to modify locally the back-end used by
2147 ;; `org-export-data' or even use a temporary back-end by using
2148 ;; `org-export-data-with-backend'.
2149 ;;
2150 ;; Internally, three functions handle the filtering of objects and
2151 ;; elements during the export. In particular,
2152 ;; `org-export-ignore-element' marks an element or object so future
2153 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2154 ;; elements or objects should be seen as real Org syntax and
2155 ;; `org-export-expand' transforms the others back into their original
2156 ;; shape
2157 ;;
2158 ;; `org-export-transcoder' is an accessor returning appropriate
2159 ;; translator function for a given element or object.
2162 "Return appropriate transcoder for BLOB.
2163 INFO is a plist containing export directives."
2165 ;; Return contents only for complete parse trees.
2171 "Convert DATA into current back-end format.
2173 DATA is a parse tree, an element or an object or a secondary
2174 string. INFO is a plist holding export options.
2176 Return transcoded string."
2182 ;; Ignored element/object.
2184 ;; Plain text.
2190 info))
2191 ;; Uninterpreted element/object: change it back to Org
2192 ;; syntax and export again resulting raw string.
2196 data
2200 info))
2201 ;; Secondary string.
2204 ;; Element/Object without contents or, as a special case,
2205 ;; headline with archive tag and archived trees restricted
2206 ;; to title only.
2214 ;; Export snippets never return a nil value so
2215 ;; that white spaces following them are never
2216 ;; ignored.
2218 ;; Element/Object with contents.
2231 ;; Elements directly containing objects
2232 ;; must have their indentation normalized
2233 ;; first.
2235 data
2236 ;; When normalizing contents of the first
2237 ;; paragraph in an item or a footnote
2238 ;; definition, ignore first line's
2239 ;; indentation: there is none and it
2240 ;; might be misleading.
2245 data)
2252 info))))))))
2253 ;; Final result will be memoized before being returned.
2255 data
2259 ;; Append the same white space between elements or objects as in
2260 ;; the original buffer, and call appropriate filters.
2271 info)))
2272 results)))
2276 "Convert DATA into BACKEND format.
2278 DATA is an element, an object, a secondary string or a string.
2279 BACKEND is a symbol. INFO is a plist used as a communication
2280 channel.
2282 Unlike to `org-export-with-backend', this function will
2283 recursively convert DATA using BACKEND translation table."
2286 data
2287 ;; Set-up a new communication channel with translations defined in
2288 ;; BACKEND as the translate table and a new hash table for
2289 ;; memoization.
2291 info
2294 ;; Size of the hash table is reduced since this function
2295 ;; will probably be used on small trees.
2299 "Non-nil if element or object BLOB should be interpreted during export.
2300 If nil, BLOB will appear as raw Org syntax. Check is done
2301 according to export options INFO, stored as a plist."
2303 ;; ... entities...
2305 ;; ... emphasis...
2308 ;; ... fixed-width areas.
2310 ;; ... LaTeX environments and fragments...
2314 ;; ... sub/superscripts...
2320 ;; ... tables...
2325 "Expand a parsed element or object to its original state.
2327 BLOB is either an element or an object. CONTENTS is its
2328 contents, as a string or nil.
2330 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2331 keywords before output."
2336 blob contents))))
2339 "Add ELEMENT to `:ignore-list' in INFO.
2341 Any element in `:ignore-list' will be skipped when using
2342 `org-element-map'. INFO is modified by side effects."
2346 \f
2347 ;;; The Filter System
2348 ;;
2349 ;; Filters allow end-users to tweak easily the transcoded output.
2350 ;; They are the functional counterpart of hooks, as every filter in
2351 ;; a set is applied to the return value of the previous one.
2352 ;;
2353 ;; Every set is back-end agnostic. Although, a filter is always
2354 ;; called, in addition to the string it applies to, with the back-end
2355 ;; used as argument, so it's easy for the end-user to add back-end
2356 ;; specific filters in the set. The communication channel, as
2357 ;; a plist, is required as the third argument.
2358 ;;
2359 ;; From the developer side, filters sets can be installed in the
2360 ;; process with the help of `org-export-define-backend', which
2361 ;; internally stores filters as an alist. Each association has a key
2362 ;; among the following symbols and a function or a list of functions
2363 ;; as value.
2364 ;;
2365 ;; - `:filter-options' applies to the property list containing export
2366 ;; options. Unlike to other filters, functions in this list accept
2367 ;; two arguments instead of three: the property list containing
2368 ;; export options and the back-end. Users can set its value through
2369 ;; `org-export-filter-options-functions' variable.
2370 ;;
2371 ;; - `:filter-parse-tree' applies directly to the complete parsed
2372 ;; tree. Users can set it through
2373 ;; `org-export-filter-parse-tree-functions' variable.
2374 ;;
2375 ;; - `:filter-final-output' applies to the final transcoded string.
2376 ;; Users can set it with `org-export-filter-final-output-functions'
2377 ;; variable
2378 ;;
2379 ;; - `:filter-plain-text' applies to any string not recognized as Org
2380 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2381 ;; configure it.
2382 ;;
2383 ;; - `:filter-TYPE' applies on the string returned after an element or
2384 ;; object of type TYPE has been transcoded. A user can modify
2385 ;; `org-export-filter-TYPE-functions'
2386 ;;
2387 ;; All filters sets are applied with
2388 ;; `org-export-filter-apply-functions' function. Filters in a set are
2389 ;; applied in a LIFO fashion. It allows developers to be sure that
2390 ;; their filters will be applied first.
2391 ;;
2392 ;; Filters properties are installed in communication channel with
2393 ;; `org-export-install-filters' function.
2394 ;;
2395 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2396 ;; `org-export-before-parsing-hook') are run at the beginning of the
2397 ;; export process and just before parsing to allow for heavy structure
2398 ;; modifications.
2401 ;;;; Hooks
2404 "Hook run at the beginning of the export process.
2406 This is run before include keywords and macros are expanded and
2407 Babel code blocks executed, on a copy of the original buffer
2408 being exported. Visibility and narrowing are preserved. Point
2409 is at the beginning of the buffer.
2411 Every function in this hook will be called with one argument: the
2415 "Hook run before parsing an export buffer.
2417 This is run after include keywords and macros have been expanded
2418 and Babel code blocks executed, on a copy of the original buffer
2419 being exported. Visibility and narrowing are preserved. Point
2420 is at the beginning of the buffer.
2422 Every function in this hook will be called with one argument: the
2426 ;;;; Special Filters
2429 "List of functions applied to the export options.
2430 Each filter is called with two arguments: the export options, as
2431 a plist, and the back-end, as a symbol. It must return
2435 "List of functions applied to the parsed tree.
2436 Each filter is called with three arguments: the parse tree, as
2437 returned by `org-element-parse-buffer', the back-end, as
2438 a symbol, and the communication channel, as a plist. It must
2442 "List of functions applied to plain text.
2443 Each filter is called with three arguments: a string which
2444 contains no Org syntax, the back-end, as a symbol, and the
2445 communication channel, as a plist. It must return a string or
2449 "List of functions applied to the transcoded string.
2450 Each filter is called with three arguments: the full transcoded
2451 string, the back-end, as a symbol, and the communication channel,
2452 as a plist. It must return a string that will be used as the
2456 ;;;; Elements Filters
2459 "List of functions applied to a transcoded babel-call.
2460 Each filter is called with three arguments: the transcoded data,
2461 as a string, the back-end, as a symbol, and the communication
2465 "List of functions applied to a transcoded center block.
2466 Each filter is called with three arguments: the transcoded data,
2467 as a string, the back-end, as a symbol, and the communication
2471 "List of functions applied to a transcoded clock.
2472 Each filter is called with three arguments: the transcoded data,
2473 as a string, the back-end, as a symbol, and the communication
2477 "List of functions applied to a transcoded comment.
2478 Each filter is called with three arguments: the transcoded data,
2479 as a string, the back-end, as a symbol, and the communication
2483 "List of functions applied to a transcoded comment-block.
2484 Each filter is called with three arguments: the transcoded data,
2485 as a string, the back-end, as a symbol, and the communication
2489 "List of functions applied to a transcoded diary-sexp.
2490 Each filter is called with three arguments: the transcoded data,
2491 as a string, the back-end, as a symbol, and the communication
2495 "List of functions applied to a transcoded drawer.
2496 Each filter is called with three arguments: the transcoded data,
2497 as a string, the back-end, as a symbol, and the communication
2501 "List of functions applied to a transcoded dynamic-block.
2502 Each filter is called with three arguments: the transcoded data,
2503 as a string, the back-end, as a symbol, and the communication
2507 "List of functions applied to a transcoded example-block.
2508 Each filter is called with three arguments: the transcoded data,
2509 as a string, the back-end, as a symbol, and the communication
2513 "List of functions applied to a transcoded export-block.
2514 Each filter is called with three arguments: the transcoded data,
2515 as a string, the back-end, as a symbol, and the communication
2519 "List of functions applied to a transcoded fixed-width.
2520 Each filter is called with three arguments: the transcoded data,
2521 as a string, the back-end, as a symbol, and the communication
2525 "List of functions applied to a transcoded footnote-definition.
2526 Each filter is called with three arguments: the transcoded data,
2527 as a string, the back-end, as a symbol, and the communication
2531 "List of functions applied to a transcoded headline.
2532 Each filter is called with three arguments: the transcoded data,
2533 as a string, the back-end, as a symbol, and the communication
2537 "List of functions applied to a transcoded horizontal-rule.
2538 Each filter is called with three arguments: the transcoded data,
2539 as a string, the back-end, as a symbol, and the communication
2543 "List of functions applied to a transcoded inlinetask.
2544 Each filter is called with three arguments: the transcoded data,
2545 as a string, the back-end, as a symbol, and the communication
2549 "List of functions applied to a transcoded item.
2550 Each filter is called with three arguments: the transcoded data,
2551 as a string, the back-end, as a symbol, and the communication
2555 "List of functions applied to a transcoded keyword.
2556 Each filter is called with three arguments: the transcoded data,
2557 as a string, the back-end, as a symbol, and the communication
2561 "List of functions applied to a transcoded latex-environment.
2562 Each filter is called with three arguments: the transcoded data,
2563 as a string, the back-end, as a symbol, and the communication
2567 "List of functions applied to a transcoded node-property.
2568 Each filter is called with three arguments: the transcoded data,
2569 as a string, the back-end, as a symbol, and the communication
2573 "List of functions applied to a transcoded paragraph.
2574 Each filter is called with three arguments: the transcoded data,
2575 as a string, the back-end, as a symbol, and the communication
2579 "List of functions applied to a transcoded plain-list.
2580 Each filter is called with three arguments: the transcoded data,
2581 as a string, the back-end, as a symbol, and the communication
2585 "List of functions applied to a transcoded planning.
2586 Each filter is called with three arguments: the transcoded data,
2587 as a string, the back-end, as a symbol, and the communication
2591 "List of functions applied to a transcoded property-drawer.
2592 Each filter is called with three arguments: the transcoded data,
2593 as a string, the back-end, as a symbol, and the communication
2597 "List of functions applied to a transcoded quote block.
2598 Each filter is called with three arguments: the transcoded quote
2599 data, as a string, the back-end, as a symbol, and the
2600 communication channel, as a plist. It must return a string or
2604 "List of functions applied to a transcoded quote-section.
2605 Each filter is called with three arguments: the transcoded data,
2606 as a string, the back-end, as a symbol, and the communication
2610 "List of functions applied to a transcoded section.
2611 Each filter is called with three arguments: the transcoded data,
2612 as a string, the back-end, as a symbol, and the communication
2616 "List of functions applied to a transcoded special block.
2617 Each filter is called with three arguments: the transcoded data,
2618 as a string, the back-end, as a symbol, and the communication
2622 "List of functions applied to a transcoded src-block.
2623 Each filter is called with three arguments: the transcoded data,
2624 as a string, the back-end, as a symbol, and the communication
2628 "List of functions applied to a transcoded table.
2629 Each filter is called with three arguments: the transcoded data,
2630 as a string, the back-end, as a symbol, and the communication
2634 "List of functions applied to a transcoded table-cell.
2635 Each filter is called with three arguments: the transcoded data,
2636 as a string, the back-end, as a symbol, and the communication
2640 "List of functions applied to a transcoded table-row.
2641 Each filter is called with three arguments: the transcoded data,
2642 as a string, the back-end, as a symbol, and the communication
2646 "List of functions applied to a transcoded verse block.
2647 Each filter is called with three arguments: the transcoded data,
2648 as a string, the back-end, as a symbol, and the communication
2652 ;;;; Objects Filters
2655 "List of functions applied to transcoded bold text.
2656 Each filter is called with three arguments: the transcoded data,
2657 as a string, the back-end, as a symbol, and the communication
2661 "List of functions applied to transcoded code text.
2662 Each filter is called with three arguments: the transcoded data,
2663 as a string, the back-end, as a symbol, and the communication
2667 "List of functions applied to a transcoded entity.
2668 Each filter is called with three arguments: the transcoded data,
2669 as a string, the back-end, as a symbol, and the communication
2673 "List of functions applied to a transcoded export-snippet.
2674 Each filter is called with three arguments: the transcoded data,
2675 as a string, the back-end, as a symbol, and the communication
2679 "List of functions applied to a transcoded footnote-reference.
2680 Each filter is called with three arguments: the transcoded data,
2681 as a string, the back-end, as a symbol, and the communication
2685 "List of functions applied to a transcoded inline-babel-call.
2686 Each filter is called with three arguments: the transcoded data,
2687 as a string, the back-end, as a symbol, and the communication
2691 "List of functions applied to a transcoded inline-src-block.
2692 Each filter is called with three arguments: the transcoded data,
2693 as a string, the back-end, as a symbol, and the communication
2697 "List of functions applied to transcoded italic text.
2698 Each filter is called with three arguments: the transcoded data,
2699 as a string, the back-end, as a symbol, and the communication
2703 "List of functions applied to a transcoded latex-fragment.
2704 Each filter is called with three arguments: the transcoded data,
2705 as a string, the back-end, as a symbol, and the communication
2709 "List of functions applied to a transcoded line-break.
2710 Each filter is called with three arguments: the transcoded data,
2711 as a string, the back-end, as a symbol, and the communication
2715 "List of functions applied to a transcoded link.
2716 Each filter is called with three arguments: the transcoded data,
2717 as a string, the back-end, as a symbol, and the communication
2721 "List of functions applied to a transcoded radio-target.
2722 Each filter is called with three arguments: the transcoded data,
2723 as a string, the back-end, as a symbol, and the communication
2727 "List of functions applied to a transcoded statistics-cookie.
2728 Each filter is called with three arguments: the transcoded data,
2729 as a string, the back-end, as a symbol, and the communication
2733 "List of functions applied to transcoded strike-through text.
2734 Each filter is called with three arguments: the transcoded data,
2735 as a string, the back-end, as a symbol, and the communication
2739 "List of functions applied to a transcoded subscript.
2740 Each filter is called with three arguments: the transcoded data,
2741 as a string, the back-end, as a symbol, and the communication
2745 "List of functions applied to a transcoded superscript.
2746 Each filter is called with three arguments: the transcoded data,
2747 as a string, the back-end, as a symbol, and the communication
2751 "List of functions applied to a transcoded target.
2752 Each filter is called with three arguments: the transcoded data,
2753 as a string, the back-end, as a symbol, and the communication
2757 "List of functions applied to a transcoded timestamp.
2758 Each filter is called with three arguments: the transcoded data,
2759 as a string, the back-end, as a symbol, and the communication
2763 "List of functions applied to transcoded underline text.
2764 Each filter is called with three arguments: the transcoded data,
2765 as a string, the back-end, as a symbol, and the communication
2769 "List of functions applied to transcoded verbatim text.
2770 Each filter is called with three arguments: the transcoded data,
2771 as a string, the back-end, as a symbol, and the communication
2775 ;;;; Filters Tools
2776 ;;
2777 ;; Internal function `org-export-install-filters' installs filters
2778 ;; hard-coded in back-ends (developer filters) and filters from global
2779 ;; variables (user filters) in the communication channel.
2780 ;;
2781 ;; Internal function `org-export-filter-apply-functions' takes care
2782 ;; about applying each filter in order to a given data. It ignores
2783 ;; filters returning a nil value but stops whenever a filter returns
2784 ;; an empty string.
2787 "Call every function in FILTERS.
2789 Functions are called with arguments VALUE, current export
2790 back-end's name and INFO. A function returning a nil value will
2791 be skipped. If it returns the empty string, the process ends and
2792 VALUE is ignored.
2794 Call is done in a LIFO fashion, to be sure that developer
2795 specified filters, if any, are called first."
2806 "Install filters properties in communication channel.
2807 INFO is a plist containing the current communication channel.
2808 Return the updated communication channel."
2810 ;; Install user-defined filters with `org-export-filters-alist'
2811 ;; and filters already in INFO (through ext-plist mechanism).
2818 ;; Filters in INFO will be called
2819 ;; before those user provided.
2822 default-value)))))
2823 org-export-filters-alist)
2824 ;; Prepend back-end specific filters to that list.
2826 ;; Single values get consed, lists are appended.
2831 plist key
2835 ;; Return new communication channel.
2839 \f
2840 ;;; Core functions
2841 ;;
2842 ;; This is the room for the main function, `org-export-as', along with
2843 ;; its derivative, `org-export-string-as'.
2844 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2845 ;; function should be added to kill ring.
2846 ;;
2847 ;; Note that `org-export-as' doesn't really parse the current buffer,
2848 ;; but a copy of it (with the same buffer-local variables and
2849 ;; visibility), where macros and include keywords are expanded and
2850 ;; Babel blocks are executed, if appropriate.
2851 ;; `org-export-with-buffer-copy' macro prepares that copy.
2852 ;;
2853 ;; File inclusion is taken care of by
2854 ;; `org-export-expand-include-keyword' and
2855 ;; `org-export--prepare-file-contents'. Structure wise, including
2856 ;; a whole Org file in a buffer often makes little sense. For
2857 ;; example, if the file contains a headline and the include keyword
2858 ;; was within an item, the item should contain the headline. That's
2859 ;; why file inclusion should be done before any structure can be
2860 ;; associated to the file, that is before parsing.
2861 ;;
2862 ;; `org-export-insert-default-template' is a command to insert
2863 ;; a default template (or a back-end specific template) at point or in
2864 ;; current subtree.
2867 "Return a copy of the current buffer.
2868 The copy preserves Org buffer-local variables, visibility and
2869 narrowing."
2875 new-buf))
2878 "Apply BODY in a copy of the current buffer.
2879 The copy preserves local variables, visibility and contents of
2880 the original buffer. Point is at the beginning of the buffer
2881 when BODY is applied."
2890 ;; Kill copy without confirmation.
2896 "Generate a function duplicating BUFFER.
2898 The copy will preserve local variables, visibility, contents and
2899 narrowing of the original buffer. If a region was active in
2900 BUFFER, contents will be narrowed to that region instead.
2902 The resulting function can be evaled at a later time, from
2903 another buffer, effectively cloning the original buffer there.
2905 The function assumes BUFFER's major mode is `org-mode'."
2909 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2910 ;; already in BUFFER.
2912 ;; Copy specific buffer local variables and variables set
2913 ;; through BIND keywords.
2915 vars)
2923 buffer-file-name
2924 buffer-file-coding-system))
2928 ;; Skip unreadable values, as they cannot be
2929 ;; sent to external process.
2933 vars))))))
2934 ;; Whole buffer contents.
2939 ;; Narrowing.
2943 ;; Current position of point.
2945 ;; Overlays with invisible property.
2955 ov-set))))
2957 ov-set)))))
2959 ;;;###autoload
2962 "Transcode current Org buffer into BACKEND code.
2964 BACKEND is either an export back-end, as returned by, e.g.,
2965 `org-export-create-backend', or a symbol referring to
2966 a registered back-end.
2968 If narrowing is active in the current buffer, only transcode its
2969 narrowed part.
2971 If a region is active, transcode that region.
2973 When optional argument SUBTREEP is non-nil, transcode the
2974 sub-tree at point, extracting information from the headline
2975 properties first.
2977 When optional argument VISIBLE-ONLY is non-nil, don't export
2978 contents of hidden elements.
2980 When optional argument BODY-ONLY is non-nil, only return body
2981 code, without surrounding template.
2983 Optional argument EXT-PLIST, when provided, is a property list
2984 with external parameters overriding Org default settings, but
2985 still inferior to file-local settings.
2987 Return code as a string."
2992 ;; Narrow buffer to an appropriate region or subtree for
2993 ;; parsing. If parsing subtree, be sure to remove main headline
2994 ;; too.
3002 ;; Initialize communication channel with original buffer
3003 ;; attributes, unavailable in its copy.
3012 tree)
3013 ;; Update communication channel and get parse tree. Buffer
3014 ;; isn't parsed directly. Instead, a temporary copy is
3015 ;; created, where include keywords, macros are expanded and
3016 ;; code blocks are evaluated.
3018 ;; Run first hook with current back-end's name as argument.
3022 ;; Update macro templates since #+INCLUDE keywords might have
3023 ;; added some new ones.
3027 ;; Update radio targets since keyword inclusion might have
3028 ;; added some more.
3030 ;; Run last hook with current back-end's name as argument.
3035 ;; Update communication channel with environment. Also
3036 ;; install user's and developer's filters.
3041 ;; Expand export-specific set of macros: {{{author}}},
3042 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3043 ;; once regular macros have been expanded, since document
3044 ;; keywords may contain one of them.
3050 ;; EMAIL is not a parsed keyword: store it as-is.
3054 ;; Call options filters and update export options. We do not
3055 ;; use `org-export-filter-apply-functions' here since the
3056 ;; arity of such filters is different.
3061 ;; Parse buffer and call parse-tree filter on it.
3066 ;; Now tree is complete, compute its properties and add them
3067 ;; to communication channel.
3071 ;; Eventually transcode TREE. Wrap the resulting string into
3072 ;; a template.
3081 ;; Remove all text properties since they cannot be
3082 ;; retrieved from an external process. Finally call
3083 ;; final-output filter and return result.
3089 info))))))))
3091 ;;;###autoload
3093 "Transcode STRING into BACKEND code.
3095 BACKEND is either an export back-end, as returned by, e.g.,
3096 `org-export-create-backend', or a symbol referring to
3097 a registered back-end.
3099 When optional argument BODY-ONLY is non-nil, only return body
3100 code, without preamble nor postamble.
3102 Optional argument EXT-PLIST, when provided, is a property list
3103 with external parameters overriding Org default settings, but
3104 still inferior to file-local settings.
3106 Return code as a string."
3112 ;;;###autoload
3114 "Replace the active region by its export to BACKEND.
3115 BACKEND is either an export back-end, as returned by, e.g.,
3116 `org-export-create-backend', or a symbol referring to
3117 a registered back-end."
3127 ;;;###autoload
3129 "Insert all export keywords with default values at beginning of line.
3131 BACKEND is a symbol referring to the name of a registered export
3132 back-end, for which specific export options should be added to
3133 the template, or `default' for default template. When it is nil,
3134 the user will be prompted for a category.
3136 If SUBTREEP is non-nil, export configuration will be set up
3137 locally for the subtree through node properties."
3147 "Options category: "
3151 org-export--registered-backends))))))
3152 options keywords)
3153 ;; Populate OPTIONS and KEYWORDS.
3170 ;; Move to an appropriate location in order to insert options.
3172 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3173 ;; list of available keywords.
3201 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3220 ;; And the rest of keywords.
3231 "Expand every include keyword in buffer.
3232 Optional argument INCLUDED is a list of included file names along
3233 with their line restriction, when appropriate. It is used to
3234 avoid infinite recursion. Optional argument DIR is the current
3235 working directory. It is used to properly resolve relative
3236 paths."
3243 ;; Extract arguments from keyword's value.
3251 dir)
3256 value)
3262 ;; Minimal level of included file defaults to the child
3263 ;; level of the current headline, if any, or one. It
3264 ;; only applies is the file is meant to be included as
3265 ;; an Org one.
3273 ;; Remove keyword.
3279 ;; Check if files has already been parsed. Look after
3280 ;; inclusion lines too, as different parts of the same file
3281 ;; can be included too.
3293 ind-str contents ind-str))))
3301 ind-str env contents ind-str))))
3314 "Prepare the contents of FILE for inclusion and return them as a string.
3316 When optional argument LINES is a string specifying a range of
3317 lines, include only those lines.
3319 Optional argument IND, when non-nil, is an integer specifying the
3320 global indentation of returned contents. Since its purpose is to
3321 allow an included file to stay in the same environment it was
3322 created \(i.e. a list item), it doesn't apply past the first
3323 headline encountered.
3325 Optional argument MINLEVEL, when non-nil, is an integer
3326 specifying the level that any top-level headline in the included
3327 file should have."
3343 ;; Remove blank lines at beginning and end of contents. The logic
3344 ;; behind that removal is that blank lines around include keyword
3345 ;; override blank lines in included file.
3354 ;; If IND is set, preserve indentation of include keyword until
3355 ;; the first headline encountered.
3362 ;; Do not move footnote definitions out of column 0.
3368 ;; When MINLEVEL is specified, compute minimal level for headlines
3369 ;; in the file (CUR-MIN), and remove stars to each headline so
3370 ;; that headlines with minimal level have a level of MINLEVEL.
3381 ;; Only change stars, don't bother moving whole
3382 ;; sections.
3389 "Execute every Babel code in the visible part of current buffer."
3390 ;; Get a pristine copy of current buffer so Babel references can be
3391 ;; properly resolved.
3398 "Return a non-nil value when output should be added to the kill ring.
3399 See also `org-export-copy-to-kill-ring'."
3405 \f
3406 ;;; Tools For Back-Ends
3407 ;;
3408 ;; A whole set of tools is available to help build new exporters. Any
3409 ;; function general enough to have its use across many back-ends
3410 ;; should be added here.
3412 ;;;; For Affiliated Keywords
3413 ;;
3414 ;; `org-export-read-attribute' reads a property from a given element
3415 ;; as a plist. It can be used to normalize affiliated keywords'
3416 ;; syntax.
3417 ;;
3418 ;; Since captions can span over multiple lines and accept dual values,
3419 ;; their internal representation is a bit tricky. Therefore,
3420 ;; `org-export-get-caption' transparently returns a given element's
3421 ;; caption as a secondary string.
3424 "Turn ATTRIBUTE property from ELEMENT into a plist.
3426 When optional argument PROPERTY is non-nil, return the value of
3427 that property within attributes.
3431 properties.
3433 All values will become strings except the empty string and
3436 will become the empty string."
3450 s)
3455 ;; Ignore any string before first property with `cdr'.
3460 "Return caption from ELEMENT as a secondary string.
3462 When optional argument SHORTP is non-nil, return short caption,
3463 as a secondary string, instead.
3465 Caption lines are separated by a white space."
3473 ;;;; For Derived Back-ends
3474 ;;
3475 ;; `org-export-with-backend' is a function allowing to locally use
3476 ;; another back-end to transcode some object or element. In a derived
3477 ;; back-end, it may be used as a fall-back function once all specific
3478 ;; cases have been treated.
3481 "Call a transcoder from BACKEND on DATA.
3482 BACKEND is an export back-end, as returned by, e.g.,
3483 `org-export-create-backend', or a symbol referring to
3484 a registered back-end. DATA is an Org element, object, secondary
3485 string or string. CONTENTS, when non-nil, is the transcoded
3486 contents of DATA element, as a string. INFO, when non-nil, is
3487 the communication channel used for export, as a plist."
3497 transcoder data contents
3500 :translate-alist all-transcoders
3504 ;;;; For Export Snippets
3505 ;;
3506 ;; Every export snippet is transmitted to the back-end. Though, the
3507 ;; latter will only retain one type of export-snippet, ignoring
3508 ;; others, based on the former's target back-end. The function
3509 ;; `org-export-snippet-backend' returns that back-end for a given
3510 ;; export-snippet.
3513 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3514 Translation, with `org-export-snippet-translation-alist', is
3515 applied."
3519 back-end))))
3522 ;;;; For Footnotes
3523 ;;
3524 ;; `org-export-collect-footnote-definitions' is a tool to list
3525 ;; actually used footnotes definitions in the whole parse tree, or in
3526 ;; a headline, in order to add footnote listings throughout the
3527 ;; transcoded data.
3528 ;;
3529 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3530 ;; back-ends, when they need to attach the footnote definition only to
3531 ;; the first occurrence of the corresponding label.
3532 ;;
3533 ;; `org-export-get-footnote-definition' and
3534 ;; `org-export-get-footnote-number' provide easier access to
3535 ;; additional information relative to a footnote reference.
3538 "Return an alist between footnote numbers, labels and definitions.
3540 DATA is the parse tree from which definitions are collected.
3541 INFO is the plist used as a communication channel.
3543 Definitions are sorted by order of references. They either
3544 appear as Org data or as a secondary string for inlined
3545 footnotes. Unreferenced definitions are ignored."
3547 collect-fn ; for byte-compiler.
3551 ;; Collect footnote number, label and definition in DATA.
3559 def)
3560 num-alist)
3561 ;; Also search in definition for nested footnotes.
3564 ;; Don't enter footnote definitions since it will happen
3565 ;; when their first reference is found.
3571 "Non-nil when a footnote reference is the first one for its label.
3573 FOOTNOTE-REFERENCE is the footnote reference being considered.
3574 INFO is the plist used as a communication channel."
3576 ;; Anonymous footnotes are always a first reference.
3578 ;; Otherwise, return the first footnote with the same LABEL and
3579 ;; test if it is equal to FOOTNOTE-REFERENCE.
3589 ;; If FN isn't inlined, be sure to traverse its
3590 ;; definition before resuming search. See
3591 ;; comments in `org-export-get-footnote-number'
3592 ;; for more information.
3596 ;; Don't enter footnote definitions since it will
3597 ;; happen when their first reference is found.
3600 footnote-reference)))))
3603 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3604 INFO is the plist used as a communication channel. If no such
3606 string."
3613 "Return number associated to a footnote.
3615 FOOTNOTE is either a footnote reference or a footnote definition.
3616 INFO is the plist used as a communication channel."
3618 seen-refs
3619 search-ref ; For byte-compiler.
3623 ;; Search footnote references through DATA, filling
3624 ;; SEEN-REFS along the way.
3629 ;; Anonymous footnote match: return number.
3632 ;; Labels match: return number.
3635 ;; Anonymous footnote: it's always a new one.
3636 ;; Also, be sure to return nil from the `cond' so
3637 ;; `first-match' doesn't get us out of the loop.
3639 ;; Label not seen so far: add it so SEEN-REFS.
3640 ;;
3641 ;; Also search for subsequent references in
3642 ;; footnote definition so numbering follows
3643 ;; reading logic. Note that we don't have to care
3644 ;; about inline definitions, since
3645 ;; `org-element-map' already traverses them at the
3646 ;; right time.
3647 ;;
3648 ;; Once again, return nil to stay in the loop.
3653 nil))))
3654 ;; Don't enter footnote definitions since it will
3655 ;; happen when their first reference is found.
3660 ;;;; For Headlines
3661 ;;
3662 ;; `org-export-get-relative-level' is a shortcut to get headline
3663 ;; level, relatively to the lower headline level in the parsed tree.
3664 ;;
3665 ;; `org-export-get-headline-number' returns the section number of an
3666 ;; headline, while `org-export-number-to-roman' allows to convert it
3667 ;; to roman numbers.
3668 ;;
3669 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3670 ;; `org-export-last-sibling-p' are three useful predicates when it
3671 ;; comes to fulfill the `:headline-levels' property.
3672 ;;
3673 ;; `org-export-get-tags', `org-export-get-category' and
3674 ;; `org-export-get-node-property' extract useful information from an
3675 ;; headline or a parent headline. They all handle inheritance.
3676 ;;
3677 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3678 ;; as a secondary string, suitable for table of contents. It falls
3679 ;; back onto default title.
3682 "Return HEADLINE relative level within current parsed tree.
3683 INFO is a plist holding contextual information."
3688 "Non-nil when HEADLINE is considered as low level.
3690 INFO is a plist used as a communication channel.
3692 A low level headlines has a relative level greater than
3693 `:headline-levels' property value.
3695 Return value is the difference between HEADLINE relative level
3696 and the last level being considered as high enough, or nil."
3703 "Return HEADLINE numbering as a list of numbers.
3704 INFO is a plist holding contextual information."
3708 "Return a non-nil value if HEADLINE element should be numbered.
3709 INFO is a plist used as a communication channel."
3715 "Convert integer N into a roman numeral."
3728 res)))
3731 "Return list of tags associated to ELEMENT.
3733 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3734 is a plist used as a communication channel.
3736 Select tags (see `org-export-select-tags') and exclude tags (see
3737 `org-export-exclude-tags') are removed from the list.
3739 When non-nil, optional argument TAGS should be a list of strings.
3740 Any tag belonging to this list will also be removed.
3742 When optional argument INHERITED is non-nil, tags can also be
3743 inherited from parent headlines and FILETAGS keywords."
3749 ;; Build complete list of inherited tags.
3760 ;; Add FILETAGS keywords and return results.
3764 "Return node PROPERTY value for BLOB.
3766 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3767 element or object.
3769 If optional argument INHERITED is non-nil, the value can be
3770 inherited from a parent headline.
3772 Return value is a string or nil."
3784 "Return category for element or object BLOB.
3786 INFO is a plist used as a communication channel.
3788 CATEGORY is automatically inherited from a parent headline, from
3789 #+CATEGORY: keyword or created out of original file name. If all
3793 ;; Almost like `org-export-node-property', but we cannot trust
3794 ;; `plist-member' as every headline has a `:CATEGORY'
3795 ;; property, would it be nil or equal to "???" (which has the
3796 ;; same meaning).
3814 "Return alternative title for HEADLINE, as a secondary string.
3815 INFO is a plist used as a communication channel. If no optional
3816 title is defined, fall-back to the regular title."
3821 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3822 INFO is a plist used as a communication channel."
3827 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3828 INFO is a plist used as a communication channel."
3832 ;;;; For Keywords
3833 ;;
3834 ;; `org-export-get-date' returns a date appropriate for the document
3835 ;; to about to be exported. In particular, it takes care of
3836 ;; `org-export-date-timestamp-format'.
3839 "Return date value for the current document.
3841 INFO is a plist used as a communication channel. FMT, when
3842 non-nil, is a time format string that will be applied on the date
3843 if it consists in a single timestamp object. It defaults to
3844 `org-export-date-timestamp-format' when nil.
3846 A proper date can be a secondary string, a string or nil. It is
3847 meant to be translated with `org-export-data' or alike."
3858 ;;;; For Links
3859 ;;
3860 ;; `org-export-solidify-link-text' turns a string into a safer version
3861 ;; for links, replacing most non-standard characters with hyphens.
3862 ;;
3863 ;; `org-export-get-coderef-format' returns an appropriate format
3864 ;; string for coderefs.
3865 ;;
3866 ;; `org-export-inline-image-p' returns a non-nil value when the link
3867 ;; provided should be considered as an inline image.
3868 ;;
3869 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3870 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3871 ;; returns an appropriate unique identifier when found, or nil.
3872 ;;
3873 ;; `org-export-resolve-id-link' returns the first headline with
3874 ;; specified id or custom-id in parse tree, the path to the external
3875 ;; file with the id or nil when neither was found.
3876 ;;
3877 ;; `org-export-resolve-coderef' associates a reference to a line
3878 ;; number in the element it belongs, or returns the reference itself
3879 ;; when the element isn't numbered.
3882 "Take link text S and make a safe target out of it."
3887 "Return format string for code reference link.
3888 PATH is the link path. DESC is its description."
3896 "Non-nil if LINK object points to an inline image.
3898 Optional argument is a set of RULES defining inline images. It
3899 is an alist where associations have the following shape:
3901 \(TYPE . REGEXP)
3903 Applying a rule means apply REGEXP against LINK's path when its
3904 type is TYPE. The function will return a non-nil value if any of
3905 the provided rules is non-nil. The default rule is
3906 `org-export-default-inline-image-rule'.
3908 This only applies to links without a description."
3919 rules)
3920 ;; Return nil if no rule matched.
3921 nil))))
3924 "Resolve a code reference REF.
3926 INFO is a plist used as a communication channel.
3928 Return associated line number in source code, or REF itself,
3929 depending on src-block or example element's switches."
3936 org-coderef-label-format)))
3940 ;; Element containing REF is found. Resolve it to either
3941 ;; a label or a line number, as needed.
3951 "Return LINK destination.
3953 INFO is a plist holding contextual information.
3955 Return value can be an object, an element, or nil:
3957 - If LINK path matches a target object (i.e. <<path>>) return it.
3959 - If LINK path exactly matches the name affiliated keyword
3960 \(i.e. #+NAME: path) of an element, return that element.
3962 - If LINK path exactly matches any headline name, return that
3963 element. If more than one headline share that name, priority
3964 will be given to the one with the closest common ancestor, if
3965 any, or the first one in the parse tree otherwise.
3967 - Otherwise, return nil.
3970 significant."
3973 ;; Split PATH at white spaces so matches are space
3974 ;; insensitive.
3977 ;; Cache for destinations that are not position dependent.
3985 ;; Destination is not position dependent: use cached value.
3987 ;; First try to find a matching "<<path>>" unless user specified
3988 ;; he was looking for a headline (path starts with a "*"
3989 ;; character).
3995 path)
3996 blob))
3999 ;; Then try to find an element with a matching "#+NAME: path"
4000 ;; affiliated keyword.
4003 org-element-all-elements
4008 el)))
4011 ;; Last case: link either points to a headline or to nothingness.
4012 ;; Try to find the source, with priority given to headlines with
4013 ;; the closest common ancestor. If such candidate is found,
4014 ;; return it, otherwise return nil.
4018 ;; Return first headline whose `:raw-value' property is
4019 ;; NAME in parse tree DATA, or nil. Statistics cookies
4020 ;; are ignored.
4028 name)
4029 headline))
4031 ;; Search among headlines sharing an ancestor with link, from
4032 ;; closest to farthest.
4041 ;; No destination found: return nil.
4045 "Return headline referenced as LINK destination.
4047 INFO is a plist used as a communication channel.
4049 Return value can be the headline element matched in current parse
4053 ;; First check if id is within the current parse tree.
4058 headline))
4060 ;; Otherwise, look for external files.
4064 "Return radio-target object referenced as LINK destination.
4066 INFO is a plist used as a communication channel.
4068 Return value can be a radio-target object or nil. Assume LINK
4077 nil nil path nil nil t)
4078 t)
4079 radio))
4083 ;;;; For References
4084 ;;
4085 ;; `org-export-get-ordinal' associates a sequence number to any object
4086 ;; or element.
4089 "Return ordinal number of an element or object.
4091 ELEMENT is the element or object considered. INFO is the plist
4092 used as a communication channel.
4094 Optional argument TYPES, when non-nil, is a list of element or
4095 object types, as symbols, that should also be counted in.
4096 Otherwise, only provided element's type is considered.
4098 Optional argument PREDICATE is a function returning a non-nil
4099 value if the current element or object should be counted in. It
4100 accepts two arguments: the element or object being considered and
4101 the plist used as a communication channel. This allows to count
4102 only a certain type of objects (i.e. inline images).
4104 Return value is a list of numbers if ELEMENT is a headline or an
4105 item. It is nil for keywords. It represents the footnote number
4106 for footnote definitions and footnote references. If ELEMENT is
4107 a target, return the same value as if ELEMENT was the closest
4108 table, item or headline containing the target. In any other
4109 case, return the sequence number of ELEMENT among elements or
4110 objects of the same type."
4111 ;; Ordinal of a target object refer to the ordinal of the closest
4112 ;; table, item, or headline containing the object.
4116 when
4120 table))
4121 return parent)))
4123 ;; Special case 1: A headline returns its number as a list.
4125 ;; Special case 2: An item returns its number as a list.
4129 struct
4136 ;; Increment counter until ELEMENT is found again.
4147 ;;;; For Src-Blocks
4148 ;;
4149 ;; `org-export-get-loc' counts number of code lines accumulated in
4150 ;; src-block or example-block elements with a "+n" switch until
4151 ;; a given element, excluded. Note: "-n" switches reset that count.
4152 ;;
4153 ;; `org-export-unravel-code' extracts source code (along with a code
4154 ;; references alist) from an `element-block' or `src-block' type
4155 ;; element.
4156 ;;
4157 ;; `org-export-format-code' applies a formatting function to each line
4158 ;; of code, providing relative line number and code reference when
4159 ;; appropriate. Since it doesn't access the original element from
4160 ;; which the source code is coming, it expects from the code calling
4161 ;; it to know if lines should be numbered and if code references
4162 ;; should appear.
4163 ;;
4164 ;; Eventually, `org-export-format-code-default' is a higher-level
4165 ;; function (it makes use of the two previous functions) which handles
4166 ;; line numbering and code references inclusion, and returns source
4167 ;; code in a format suitable for plain text or verbatim output.
4170 "Return accumulated lines of code up to ELEMENT.
4172 INFO is the plist used as a communication channel.
4174 ELEMENT is excluded from count."
4180 ;; ELEMENT is reached: Quit the loop.
4182 ;; Only count lines from src-block and example-block elements
4183 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4187 ;; Accumulate locs or reset them.
4191 ;; Return nil to stay in the loop.
4192 nil)))
4194 ;; Return value.
4195 loc))
4198 "Clean source code and extract references out of it.
4200 ELEMENT has either a `src-block' an `example-block' type.
4202 Return a cons cell whose CAR is the source code, cleaned from any
4203 reference, protective commas and spurious indentation, and CDR is
4204 an alist between relative line number (integer) and name of code
4205 reference on that line (string)."
4208 ;; Get code and clean it. Remove blank lines at its
4209 ;; beginning and end.
4216 value
4218 ;; Get format used for references.
4221 org-coderef-label-format)))
4222 ;; Build a regexp matching a loc with a reference.
4227 ;; Return value.
4229 ;; Code with references removed.
4235 ;; Ref line: remove ref, and signal its position in REFS.
4239 ;; Reference alist.
4240 refs)))
4243 "Format CODE by applying FUN line-wise and return it.
4245 CODE is a string representing the code to format. FUN is
4246 a function. It must accept three arguments: a line of
4247 code (string), the current line number (integer) or nil and the
4248 reference associated to the current line (string) or nil.
4250 Optional argument NUM-LINES can be an integer representing the
4251 number of code lines accumulated until the current code. Line
4252 numbers passed to FUN will take it into account. If it is nil,
4253 FUN's second argument will always be nil. This number can be
4254 obtained with `org-export-get-loc' function.
4256 Optional argument REF-ALIST can be an alist between relative line
4257 number (i.e. ignoring NUM-LINES) and the name of the code
4258 reference on it. If it is nil, FUN's third argument will always
4259 be nil. It can be obtained through the use of
4260 `org-export-unravel-code' function."
4272 "Return source code from ELEMENT, formatted in a standard way.
4274 ELEMENT is either a `src-block' or `example-block' element. INFO
4275 is a plist used as a communication channel.
4277 This function takes care of line numbering and code references
4278 inclusion. Line numbers, when applicable, appear at the
4279 beginning of the line, separated from the code by two white
4280 spaces. Code references, on the other hand, appear flushed to
4281 the right, separated by six white spaces from the widest line of
4282 code."
4283 ;; Extract code and references.
4290 ;; Handle line numbering.
4299 ;; Prepare references display, if required. Any reference
4300 ;; should start six columns after the widest line of code,
4301 ;; wrapped with parenthesis.
4306 code
4310 number-str
4311 loc
4317 num-start refs)))))
4320 ;;;; For Tables
4321 ;;
4322 ;; `org-export-table-has-special-column-p' and and
4323 ;; `org-export-table-row-is-special-p' are predicates used to look for
4324 ;; meta-information about the table structure.
4325 ;;
4326 ;; `org-table-has-header-p' tells when the rows before the first rule
4327 ;; should be considered as table's header.
4328 ;;
4329 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4330 ;; and `org-export-table-cell-borders' extract information from
4331 ;; a table-cell element.
4332 ;;
4333 ;; `org-export-table-dimensions' gives the number on rows and columns
4334 ;; in the table, ignoring horizontal rules and special columns.
4335 ;; `org-export-table-cell-address', given a table-cell object, returns
4336 ;; the absolute address of a cell. On the other hand,
4337 ;; `org-export-get-table-cell-at' does the contrary.
4338 ;;
4339 ;; `org-export-table-cell-starts-colgroup-p',
4340 ;; `org-export-table-cell-ends-colgroup-p',
4341 ;; `org-export-table-row-starts-rowgroup-p',
4342 ;; `org-export-table-row-ends-rowgroup-p',
4343 ;; `org-export-table-row-starts-header-p' and
4344 ;; `org-export-table-row-ends-header-p' indicate position of current
4345 ;; row or cell within the table.
4348 "Non-nil when TABLE has a special column.
4349 All special columns will be ignored during export."
4350 ;; The table has a special column when every first cell of every row
4351 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4352 ;; "*" "_" and "^". Though, do not consider a first row containing
4353 ;; only empty cells as special.
4369 "Non-nil when TABLE has a header.
4371 INFO is a plist used as a communication channel.
4373 A table has a header when it contains at least two row groups."
4382 table
4393 cache)))))
4396 "Non-nil if TABLE-ROW is considered special.
4398 INFO is a plist used as the communication channel.
4400 All special rows will be ignored during export."
4404 ;; A row is special either when...
4406 ;; ... it starts with a field only containing "/",
4408 ;; ... the table contains a special column and the row start
4409 ;; with a marking character among, "^", "_", "$" or "!",
4413 ;; ... it contains only alignment cookies and empty cells.
4419 ;; Since VALUE is a secondary string, the following
4420 ;; checks avoid expanding it with `org-export-data'.
4432 "Return TABLE-ROW's group number, as an integer.
4434 INFO is a plist used as the communication channel.
4436 Return value is the group number, as an integer, or nil for
4437 special rows and rows separators. First group is also table's
4438 header."
4456 "Return TABLE-CELL contents width.
4458 INFO is a plist used as the communication channel.
4460 Return value is the width given by the last width cookie in the
4461 same column as TABLE-CELL, or nil."
4480 ;; In a special row, try to find a width cookie at COLUMN.
4484 ;; The following checks avoid expanding unnecessarily
4485 ;; the cell with `org-export-data'.
4495 "Return TABLE-CELL contents alignment.
4497 INFO is a plist used as the communication channel.
4499 Return alignment as specified by the last alignment cookie in the
4500 same column as TABLE-CELL. If no such cookie is found, a default
4501 alignment value will be deduced from fraction of numbers in the
4502 column (see `org-table-number-fraction' for more information).
4503 Possible values are `left', `right' and `center'."
4504 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4521 cookie-align
4522 previous-cell-number-p)
4525 ;; In a special row, try to find an alignment cookie at
4526 ;; COLUMN.
4530 ;; Since VALUE is a secondary string, the following
4531 ;; checks avoid useless expansion through
4532 ;; `org-export-data'.
4540 ;; Ignore table rules.
4542 ;; In a standard row, check if cell's contents are
4543 ;; expressing some kind of number. Increase NUMBER-CELLS
4544 ;; accordingly. Though, don't bother if an alignment
4545 ;; cookie has already defined cell's alignment.
4550 info)))
4552 ;; Treat an empty cell as a number if it follows
4553 ;; a number.
4559 ;; Return value. Alignment specified by cookies has
4560 ;; precedence over alignment deduced from cell's contents.
4562 column
4567 org-table-number-fraction)
4572 "Return TABLE-CELL borders.
4574 INFO is a plist used as a communication channel.
4576 Return value is a list of symbols, or nil. Possible values are:
4577 `top', `bottom', `above', `below', `left' and `right'. Note:
4578 `top' (resp. `bottom') only happen for a cell in the first
4579 row (resp. last row) of the table, ignoring table rules, if any.
4581 Returned borders ignore special rows."
4584 borders)
4585 ;; Top/above border? TABLE-CELL has a border above when a rule
4586 ;; used to demarcate row groups can be found above. Hence,
4587 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4588 ;; another regular row has to be found above that rule.
4597 ;; Look at every row before the current one.
4599 ;; No rule above, or rule found starts the table (ignoring any
4600 ;; special row): TABLE-CELL is at the top of the table.
4603 ;; Bottom/below border? TABLE-CELL has a border below when next
4604 ;; non-regular row below is a rule.
4613 ;; Look at every row after the current one.
4615 ;; No rule below, or rule found ends the table (modulo some
4616 ;; special row): TABLE-CELL is at the bottom of the table.
4619 ;; Right/left borders? They can only be specified by column
4620 ;; groups. Column groups are defined in a row starting with "/".
4621 ;; Also a column groups row only contains "<", "<>", ">" or blank
4622 ;; cells.
4639 ;; There's a left border when previous cell, if
4640 ;; any, ends a group, or current one starts one.
4646 ;; There's a right border when next cell, if any,
4647 ;; starts a group, or current one ends one.
4654 ;; Table rows are read in reverse order so last column groups
4655 ;; row has precedence over any previous one.
4657 ;; Return value.
4658 borders))
4661 "Non-nil when TABLE-CELL is at the beginning of a column group.
4662 INFO is a plist used as a communication channel."
4663 ;; A cell starts a column group either when it is at the beginning
4664 ;; of a row (or after the special column, if any) or when it has
4665 ;; a left border.
4668 table-cell)
4672 "Non-nil when TABLE-CELL is at the end of a column group.
4673 INFO is a plist used as a communication channel."
4674 ;; A cell ends a column group either when it is at the end of a row
4675 ;; or when it has a right border.
4678 table-cell)
4682 "Non-nil when TABLE-ROW is at the beginning of a row group.
4683 INFO is a plist used as a communication channel."
4691 "Non-nil when TABLE-ROW is at the end of a row group.
4692 INFO is a plist used as a communication channel."
4700 "Non-nil when TABLE-ROW is the first table header's row.
4701 INFO is a plist used as a communication channel."
4708 "Non-nil when TABLE-ROW is the last table header's row.
4709 INFO is a plist used as a communication channel."
4716 "Return TABLE-ROW number.
4717 INFO is a plist used as a communication channel. Return value is
4718 zero-based and ignores separators. The function returns nil for
4719 special colums and separators."
4731 "Return TABLE dimensions.
4733 INFO is a plist used as a communication channel.
4735 Return value is a CONS like (ROWS . COLUMNS) where
4736 ROWS (resp. COLUMNS) is the number of exportable
4737 rows (resp. columns)."
4739 ;; Set number of rows, and extract first one.
4745 ;; Set number of columns.
4747 ;; Return value.
4751 "Return address of a regular TABLE-CELL object.
4753 TABLE-CELL is the cell considered. INFO is a plist used as
4754 a communication channel.
4756 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4757 zero-based index. Only exportable cells are considered. The
4758 function returns nil for other cells."
4770 "Return regular table-cell object at ADDRESS in TABLE.
4772 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4773 zero-based index. TABLE is a table type element. INFO is
4774 a plist used as a communication channel.
4776 If no table-cell, among exportable cells, is found at ADDRESS,
4777 return nil."
4780 ;; Row at (car address) or nil.
4788 'table-cell
4795 ;;;; For Tables Of Contents
4796 ;;
4797 ;; `org-export-collect-headlines' builds a list of all exportable
4798 ;; headline elements, maybe limited to a certain depth. One can then
4799 ;; easily parse it and transcode it.
4800 ;;
4801 ;; Building lists of tables, figures or listings is quite similar.
4802 ;; Once the generic function `org-export-collect-elements' is defined,
4803 ;; `org-export-collect-tables', `org-export-collect-figures' and
4804 ;; `org-export-collect-listings' can be derived from it.
4807 "Collect headlines in order to build a table of contents.
4809 INFO is a plist used as a communication channel.
4811 When optional argument N is an integer, it specifies the depth of
4812 the table of contents. Otherwise, it is set to the value of the
4813 last headline level. See `org-export-headline-levels' for more
4814 information.
4816 Return a list of all exportable headlines as parsed elements.
4817 Footnote sections, if any, will be ignored."
4825 info)))
4828 "Collect referenceable elements of a determined type.
4830 TYPE can be a symbol or a list of symbols specifying element
4831 types to search. Only elements with a caption are collected.
4833 INFO is a plist used as a communication channel.
4835 When non-nil, optional argument PREDICATE is a function accepting
4836 one argument, an element of type TYPE. It returns a non-nil
4837 value when that element should be collected.
4839 Return a list of all elements found, in order of appearance."
4844 element))
4845 info))
4848 "Build a list of tables.
4849 INFO is a plist used as a communication channel.
4851 Return a list of table elements with a caption."
4855 "Build a list of figures.
4857 INFO is a plist used as a communication channel. PREDICATE is
4858 a function which accepts one argument: a paragraph element and
4859 whose return value is non-nil when that element should be
4860 collected.
4862 A figure is a paragraph type element, with a caption, verifying
4864 a vague concept that may depend on back-end.
4866 Return a list of elements recognized as figures."
4870 "Build a list of src blocks.
4872 INFO is a plist used as a communication channel.
4874 Return a list of src-block elements with a caption."
4878 ;;;; Smart Quotes
4879 ;;
4880 ;; The main function for the smart quotes sub-system is
4881 ;; `org-export-activate-smart-quotes', which replaces every quote in
4882 ;; a given string from the parse tree with its "smart" counterpart.
4883 ;;
4884 ;; Dictionary for smart quotes is stored in
4885 ;; `org-export-smart-quotes-alist'.
4886 ;;
4887 ;; Internally, regexps matching potential smart quotes (checks at
4888 ;; string boundaries are also necessary) are defined in
4889 ;; `org-export-smart-quotes-regexps'.
4893 ;; one may use: »...«, "...", ›...‹, or '...'.
4894 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4895 ;; LaTeX quotes require Babel!
4940 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4949 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4958 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4967 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4973 )
4974 "Smart quotes translations.
4976 Alist whose CAR is a language string and CDR is an alist with
4977 quote type as key and a plist associating various encodings to
4978 their translation as value.
4980 A quote type can be any symbol among `opening-double-quote',
4981 `closing-double-quote', `opening-single-quote',
4982 `closing-single-quote' and `apostrophe'.
4984 Valid encodings include `:utf-8', `:html', `:latex' and
4985 `:texinfo'.
4991 ;; Possible opening quote at beginning of string.
4993 ;; Possible closing quote at beginning of string.
4995 ;; Possible apostrophe at beginning of string.
4997 ;; Opening single and double quotes.
4999 ;; Closing single and double quotes.
5001 ;; Apostrophe.
5003 ;; Possible opening quote at end of string.
5005 ;; Possible closing quote at end of string.
5007 ;; Possible apostrophe at end of string.
5009 "List of regexps matching a quote or an apostrophe.
5015 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5016 `:utf-8'. INFO is a plist used as a communication channel.
5018 The function has to retrieve information about string
5019 surroundings in parse tree. It can only happen with an
5020 unmodified string. Thus, if S has already been through another
5021 process, a non-nil ORIGINAL optional argument will provide that
5022 original string.
5024 Return the new string."
5027 ;; Try to be flexible when computing number of blanks
5028 ;; before object. The previous object may be a string
5029 ;; introduced by the back-end and not completely parsed.
5032 ;; A string with missing `:post-blank'
5033 ;; property.
5037 ;; Fallback value.
5042 ;; Return smart quote associated to a give quote Q, as
5043 ;; a string. TYPE is a symbol among `open', `close' and
5044 ;; `apostrophe'.
5054 org-export-smart-quotes-alist))))
5055 encoding)
5056 q)))))
5058 ;; Only a quote: no regexp can match. We have to check both
5059 ;; sides and decide what to do.
5067 ;; 1. Replace quote character at the beginning of S.
5069 ;; Apostrophe?
5075 ;; Closing quote?
5081 ;; Opening quote?
5087 ;; 2. Replace quotes in the middle of the string.
5089 ;; Opening quotes.
5095 ;; Closing quotes.
5101 ;; Apostrophes.
5106 ;; 3. Replace quote character at the end of S.
5108 ;; Apostrophe?
5113 ;; Closing quote?
5119 ;; Opening quote?
5124 ;; Return string with smart quotes.
5125 s))))
5127 ;;;; Topology
5128 ;;
5129 ;; Here are various functions to retrieve information about the
5130 ;; neighbourhood of a given element or object. Neighbours of interest
5131 ;; are direct parent (`org-export-get-parent'), parent headline
5132 ;; (`org-export-get-parent-headline'), first element containing an
5133 ;; object, (`org-export-get-parent-element'), parent table
5134 ;; (`org-export-get-parent-table'), previous element or object
5135 ;; (`org-export-get-previous-element') and next element or object
5136 ;; (`org-export-get-next-element').
5137 ;;
5138 ;; `org-export-get-genealogy' returns the full genealogy of a given
5139 ;; element or object, from closest parent to full parse tree.
5142 "Return BLOB parent or nil.
5143 BLOB is the element or object considered."
5147 "Return full genealogy relative to a given element or object.
5149 BLOB is the element or object being considered.
5151 Ancestors are returned from closest to farthest, the last one
5152 being the full parse tree."
5159 "Return BLOB parent headline or nil.
5160 BLOB is the element or object being considered."
5164 parent))
5167 "Return first element containing OBJECT or nil.
5168 OBJECT is the object to consider."
5172 parent))
5175 "Return OBJECT parent table or nil.
5176 OBJECT is either a `table-cell' or `table-element' type object."
5180 parent))
5183 "Return previous element or object.
5185 BLOB is an element or object. INFO is a plist used as
5186 a communication channel. Return previous exportable element or
5187 object, a string, or nil.
5189 When optional argument N is a positive integer, return a list
5190 containing up to N siblings before BLOB, from farthest to
5191 closest. With any other non-nil value, return a list containing
5192 all of them."
5194 ;; An object can belong to the contents of its parent or
5195 ;; to a secondary string. We check the latter option
5196 ;; first.
5199 org-element-all-elements))
5203 org-element-secondary-value-alist))
5204 parent)))
5207 prev)
5216 prev)))
5219 "Return next element or object.
5221 BLOB is an element or object. INFO is a plist used as
5222 a communication channel. Return next exportable element or
5223 object, a string, or nil.
5225 When optional argument N is a positive integer, return a list
5226 containing up to N siblings after BLOB, from closest to farthest.
5227 With any other non-nil value, return a list containing all of
5228 them."
5230 ;; An object can belong to the contents of its parent or to
5231 ;; a secondary string. We check the latter option first.
5234 org-element-all-objects))
5238 org-element-secondary-value-alist))
5239 parent)))
5242 next)
5250 siblings)
5254 ;;;; Translation
5255 ;;
5256 ;; `org-export-translate' translates a string according to the language
5257 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5258 ;; the dictionary used for the translation.
5472 "Dictionary for export engine.
5474 Alist whose CAR is the string to translate and CDR is an alist
5475 whose CAR is the language string and CDR is a plist whose
5476 properties are possible charsets and values translated terms.
5478 It is used as a database for `org-export-translate'. Since this
5479 function returns the string as-is if no translation was found,
5480 the variable only needs to record values different from the
5484 "Translate string S according to language specification.
5486 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5487 and `:utf-8'. INFO is a plist used as a communication channel.
5489 Translation depends on `:language' property. Return the
5490 translated string. If no translation is found, try to fall back
5491 to `:default' encoding. If it fails, return S."
5497 s)))
5500 \f
5501 ;;; Asynchronous Export
5502 ;;
5503 ;; `org-export-async-start' is the entry point for asynchronous
5504 ;; export. It recreates current buffer (including visibility,
5505 ;; narrowing and visited file) in an external Emacs process, and
5506 ;; evaluates a command there. It then applies a function on the
5507 ;; returned results in the current process.
5508 ;;
5509 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5510 ;; allow to export to a buffer or a file, asynchronously or not.
5511 ;;
5512 ;; `org-export-output-file-name' is an auxiliary function meant to be
5513 ;; used with `org-export-to-file'. With a given extension, it tries
5514 ;; to provide a canonical file name to write export output to.
5515 ;;
5516 ;; Asynchronously generated results are never displayed directly.
5517 ;; Instead, they are stored in `org-export-stack-contents'. They can
5518 ;; then be retrieved by calling `org-export-stack'.
5519 ;;
5520 ;; Export Stack is viewed through a dedicated major mode
5521 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5522 ;;`org-export-stack-delete', `org-export-stack-view' and
5523 ;;`org-export-stack-clear'.
5524 ;;
5525 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5526 ;; It should be used whenever `org-export-async-start' is called.
5529 "Call function FUN on the results returned by BODY evaluation.
5531 BODY evaluation happens in an asynchronous process, from a buffer
5532 which is an exact copy of the current one.
5534 Use `org-export-add-to-stack' in FUN in order to register results
5535 in the stack.
5537 This is a low level function. See also `org-export-to-buffer'
5538 and `org-export-to-file' for more specialized functions."
5541 ;; Write the full sexp evaluating BODY in a copy of the current
5542 ;; buffer to a temporary file, as it may be too long for program
5543 ;; args in `start-process'.
5550 ;; Null characters (from variable values) are inserted
5551 ;; within the file. As a consequence, coding system for
5552 ;; buffer contents will not be recognized properly. So,
5553 ;; we make sure it is the same as the one used to display
5554 ;; the original buffer.
5556 ,coding
5559 ;; Ignore `kill-emacs-hook' and code evaluation
5560 ;; queries from Babel as we need a truly
5561 ;; non-interactive process.
5563 org-babel-confirm-evaluate-answer-no t)
5564 ;; Initialize export framework.
5566 ;; Re-create current buffer there.
5569 ;; Sexp to evaluate in the buffer.
5571 ;; Start external process.
5574 (,process
5576 #'start-process
5579 ,proc-buffer
5586 ;; Register running process in stack.
5588 ;; Set-up sentinel in order to catch results.
5591 ,process
5613 ;;;###autoload
5616 &optional async subtreep visible-only body-only ext-plist
5617 post-process)
5618 "Call `org-export-as' with output to a specified buffer.
5620 BACKEND is either an export back-end, as returned by, e.g.,
5621 `org-export-create-backend', or a symbol referring to
5622 a registered back-end.
5624 BUFFER is the name of the output buffer. If it already exists,
5625 it will be erased first, otherwise, it will be created.
5627 A non-nil optional argument ASYNC means the process should happen
5628 asynchronously. The resulting buffer should then be accessible
5629 through the `org-export-stack' interface. When ASYNC is nil, the
5630 buffer is displayed if `org-export-show-temporary-export-buffer'
5631 is non-nil.
5633 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5634 EXT-PLIST are similar to those used in `org-export-as', which
5635 see.
5637 Optional argument POST-PROCESS is a function which should accept
5638 no argument. It is always called within the current process,
5639 from BUFFER, with point at its beginning. Export back-ends can
5640 use it to set a major mode there, e.g,
5642 \(defun org-latex-export-as-latex
5643 \(&optional async subtreep visible-only body-only ext-plist)
5644 \(interactive)
5646 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5648 This function returns BUFFER."
5676 buffer)))
5678 ;;;###autoload
5681 post-process)
5682 "Call `org-export-as' with output to a specified file.
5684 BACKEND is either an export back-end, as returned by, e.g.,
5685 `org-export-create-backend', or a symbol referring to
5686 a registered back-end. FILE is the name of the output file, as
5687 a string.
5689 A non-nil optional argument ASYNC means the process should happen
5690 asynchronously. The resulting buffer file then be accessible
5691 through the `org-export-stack' interface.
5693 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5694 EXT-PLIST are similar to those used in `org-export-as', which
5695 see.
5697 Optional argument POST-PROCESS is called with FILE as its
5698 argument and happens asynchronously when ASYNC is non-nil. It
5699 has to return a file name, or nil. Export back-ends can use this
5700 to send the output file through additional processing, e.g,
5702 \(defun org-latex-export-to-latex
5703 \(&optional async subtreep visible-only body-only ext-plist)
5704 \(interactive)
5706 \(org-export-to-file 'latex outfile
5707 async subtreep visible-only body-only ext-plist
5708 \(lambda (file) (org-latex-compile file)))
5710 The function returns either a file name returned by POST-PROCESS,
5711 or FILE."
5729 backend subtreep visible-only body-only ext-plist)))
5736 ;; Get proper return value.
5738 file))))))
5741 "Return output file's name according to buffer specifications.
5743 EXTENSION is a string representing the output file extension,
5744 with the leading dot.
5746 With a non-nil optional argument SUBTREEP, try to determine
5748 of subtree at point.
5750 When optional argument PUB-DIR is set, use it as the publishing
5751 directory.
5753 When optional argument VISIBLE-ONLY is non-nil, don't export
5754 contents of hidden elements.
5756 Return file name as a string."
5759 ;; File name may come from EXPORT_FILE_NAME subtree
5760 ;; property, assuming point is at beginning of said
5761 ;; sub-tree.
5768 ;; File name may be extracted from buffer's associated
5769 ;; file, if any.
5771 ;; Can't determine file name on our own: Ask user.
5775 "Output file: " pub-dir nil nil nil
5779 ;; Build file name. Enforce EXTENSION over whatever user
5780 ;; may have come up with. PUB-DIR, if defined, always has
5781 ;; precedence over any provided path.
5786 extension))
5789 ;; If writing to OUTPUT-FILE would overwrite original file, append
5790 ;; EXTENSION another time to final name.
5793 output-file)))
5796 "Add a new result to export stack if not present already.
5798 SOURCE is a buffer or a file name containing export results.
5799 BACKEND is a symbol representing export back-end used to generate
5800 it.
5802 Entries already pointing to SOURCE and unavailable entries are
5803 removed beforehand. Return the new stack."
5809 "Menu for asynchronous export results and running processes."
5819 "Return source from export results at point in stack."
5826 source
5827 ;; SOURCE is not consistent with current line. The stack
5828 ;; view is outdated.
5832 "Remove all entries from export stack."
5837 "Refresh the asynchronous export stack.
5838 DUMMY is ignored. Unavailable sources are removed from the list.
5839 Return the new stack."
5849 ;; Back-end.
5851 ;; Age.
5854 ;; Compute age of the results.
5856 "%4h:%.2m "
5858 ;; Source.
5863 ;; Clear stack from exited processes, dead buffers or
5864 ;; non-existent files.
5876 "Remove export results at point from stack.
5877 If optional argument SOURCE is non-nil, remove it instead."
5882 org-export-stack-contents))))
5885 "View export results at point in stack.
5886 With an optional prefix argument IN-EMACS, force viewing files
5887 within Emacs."
5901 (define-key km "p" 'previous-line)
5902 (define-key km "\C-p" 'previous-line)
5903 (define-key km "\C-?" 'previous-line)
5904 (define-key km [up] 'previous-line)
5905 (define-key km "C" 'org-export-stack-clear)
5906 (define-key km "v" 'org-export-stack-view)
5907 (define-key km (kbd "RET") 'org-export-stack-view)
5908 (define-key km "d" 'org-export-stack-remove)
5909 km)
5910 "Keymap for Org Export Stack.")
5912 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5913 "Mode for displaying asynchronous export stack.
5916 stack.
5918 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5919 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5920 stack completely.
5922 Removing entries in an Org Export Stack buffer doesn't affect
5923 files or buffers, only the display.
5926 (abbrev-mode 0)
5927 (auto-fill-mode 0)
5928 (setq buffer-read-only t
5929 buffer-undo-list t
5930 truncate-lines t
5931 header-line-format
5932 '(:eval
5933 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5934 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5935 (set (make-local-variable 'revert-buffer-function)
5936 'org-export-stack-refresh))
5939 \f
5940 ;;; The Dispatcher
5941 ;;
5942 ;; `org-export-dispatch' is the standard interactive way to start an
5943 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5944 ;; for its interface, which, in turn, delegates response to key
5945 ;; pressed to `org-export--dispatch-action'.
5947 ;;;###autoload
5948 (defun org-export-dispatch (&optional arg)
5949 "Export dispatcher for Org mode.
5951 It provides an access to common export related tasks in a buffer.
5952 Its interface comes in two flavours: standard and expert.
5954 While both share the same set of bindings, only the former
5955 displays the valid keys associations in a dedicated buffer.
5956 Scrolling (resp. line-wise motion) in this buffer is done with
5957 SPC and DEL (resp. C-n and C-p) keys.
5959 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5960 flavour or the other.
5963 of options used back then, on the current buffer.
5965 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5966 (interactive "P")
5967 (let* ((input
5968 (cond ((equal arg '(16)) '(stack))
5969 ((and arg org-export-dispatch-last-action))
5970 (t (save-window-excursion
5971 (unwind-protect
5972 (progn
5973 ;; Remember where we are
5974 (move-marker org-export-dispatch-last-position
5975 (point)
5976 (org-base-buffer (current-buffer)))
5977 ;; Get and store an export command
5978 (setq org-export-dispatch-last-action
5979 (org-export--dispatch-ui
5980 (list org-export-initial-scope
5981 (and org-export-in-background 'async))
5982 nil
5983 org-export-dispatch-use-expert-ui)))
5984 (and (get-buffer "*Org Export Dispatcher*")
5985 (kill-buffer "*Org Export Dispatcher*")))))))
5986 (action (car input))
5987 (optns (cdr input)))
5988 (unless (memq 'subtree optns)
5989 (move-marker org-export-dispatch-last-position nil))
5990 (case action
5991 ;; First handle special hard-coded actions.
5992 (template (org-export-insert-default-template nil optns))
5993 (stack (org-export-stack))
5994 (publish-current-file
5995 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5996 (publish-current-project
5997 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5998 (publish-choose-project
5999 (org-publish (assoc (org-icompleting-read
6000 "Publish project: "
6001 org-publish-project-alist nil t)
6002 org-publish-project-alist)
6003 (memq 'force optns)
6004 (memq 'async optns)))
6005 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6006 (otherwise
6007 (save-excursion
6008 (when arg
6009 ;; Repeating command, maybe move cursor to restore subtree
6010 ;; context.
6011 (if (eq (marker-buffer org-export-dispatch-last-position)
6012 (org-base-buffer (current-buffer)))
6013 (goto-char org-export-dispatch-last-position)
6014 ;; We are in a different buffer, forget position.
6015 (move-marker org-export-dispatch-last-position nil)))
6016 (funcall action
6017 ;; Return a symbol instead of a list to ease
6018 ;; asynchronous export macro use.
6019 (and (memq 'async optns) t)
6020 (and (memq 'subtree optns) t)
6021 (and (memq 'visible optns) t)
6022 (and (memq 'body optns) t)))))))
6024 (defun org-export--dispatch-ui (options first-key expertp)
6025 "Handle interface for `org-export-dispatch'.
6027 OPTIONS is a list containing current interactive options set for
6028 export. It can contain any of the following symbols:
6029 `body' toggles a body-only export
6030 `subtree' restricts export to current subtree
6031 `visible' restricts export to visible part of buffer.
6032 `force' force publishing files.
6033 `async' use asynchronous export process
6035 FIRST-KEY is the key pressed to select the first level menu. It
6036 is nil when this menu hasn't been selected yet.
6038 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6039 buffer is provided, but indications about currently active
6040 options are given in the prompt. Moreover, \[?] allows to switch
6041 back to standard interface."
6042 (let* ((fontify-key
6043 (lambda (key &optional access-key)
6044 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6045 ;; non-nil is the required first-level key to activate
6046 ;; KEY. When its value is t, activate KEY independently
6047 ;; on the first key, if any. A nil value means KEY will
6048 ;; only be activated at first level.
6049 (if (or (eq access-key t) (eq access-key first-key))
6050 (org-propertize key 'face 'org-warning)
6051 key)))
6052 (fontify-value
6053 (lambda (value)
6054 ;; Fontify VALUE string.
6055 (org-propertize value 'face 'font-lock-variable-name-face)))
6056 ;; Prepare menu entries by extracting them from registered
6057 ;; back-ends and sorting them by access key and by ordinal,
6058 ;; if any.
6059 (entries
6060 (sort (sort (delq nil
6061 (mapcar 'org-export-backend-menu
6062 org-export--registered-backends))
6063 (lambda (a b)
6064 (let ((key-a (nth 1 a))
6065 (key-b (nth 1 b)))
6066 (cond ((and (numberp key-a) (numberp key-b))
6067 (< key-a key-b))
6068 ((numberp key-b) t)))))
6069 'car-less-than-car))
6070 ;; Compute a list of allowed keys based on the first key
6071 ;; pressed, if any. Some keys
6072 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6073 ;; available.
6074 (allowed-keys
6075 (nconc (list 2 22 19 6 1)
6076 (if (not first-key) (org-uniquify (mapcar 'car entries))
6077 (let (sub-menu)
6078 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6079 (when (eq (car entry) first-key)
6080 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6081 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6082 ((not first-key) (list ?P)))
6083 (list ?& ?#)
6084 (when expertp (list ??))
6085 (list ?q)))
6086 ;; Build the help menu for standard UI.
6087 (help
6088 (unless expertp
6089 (concat
6090 ;; Options are hard-coded.
6091 (format "[%s] Body only: %s [%s] Visible only: %s
6092 \[%s] Export scope: %s [%s] Force publishing: %s
6094 (funcall fontify-key "C-b" t)
6095 (funcall fontify-value
6096 (if (memq 'body options) "On " "Off"))
6097 (funcall fontify-key "C-v" t)
6098 (funcall fontify-value
6099 (if (memq 'visible options) "On " "Off"))
6100 (funcall fontify-key "C-s" t)
6101 (funcall fontify-value
6102 (if (memq 'subtree options) "Subtree" "Buffer "))
6103 (funcall fontify-key "C-f" t)
6104 (funcall fontify-value
6105 (if (memq 'force options) "On " "Off"))
6106 (funcall fontify-key "C-a" t)
6107 (funcall fontify-value
6108 (if (memq 'async options) "On " "Off")))
6109 ;; Display registered back-end entries. When a key
6110 ;; appears for the second time, do not create another
6111 ;; entry, but append its sub-menu to existing menu.
6112 (let (last-key)
6113 (mapconcat
6114 (lambda (entry)
6115 (let ((top-key (car entry)))
6116 (concat
6117 (unless (eq top-key last-key)
6118 (setq last-key top-key)
6120 (funcall fontify-key (char-to-string top-key))
6121 (nth 1 entry)))
6122 (let ((sub-menu (nth 2 entry)))
6123 (unless (functionp sub-menu)
6124 ;; Split sub-menu into two columns.
6125 (let ((index -1))
6126 (concat
6127 (mapconcat
6128 (lambda (sub-entry)
6129 (incf index)
6130 (format
6131 (if (zerop (mod index 2)) " [%s] %-26s"
6133 (funcall fontify-key
6134 (char-to-string (car sub-entry))
6135 top-key)
6136 (nth 1 sub-entry)))
6137 sub-menu "")
6139 entries ""))
6140 ;; Publishing menu is hard-coded.
6142 [%s] Current file [%s] Current project
6144 (funcall fontify-key "P")
6145 (funcall fontify-key "f" ?P)
6146 (funcall fontify-key "p" ?P)
6147 (funcall fontify-key "x" ?P)
6148 (funcall fontify-key "a" ?P))
6150 (funcall fontify-key "&" t)
6151 (funcall fontify-key "#" t))
6152 (format "[%s] %s"
6153 (funcall fontify-key "q" t)
6154 (if first-key "Main menu" "Exit")))))
6155 ;; Build prompts for both standard and expert UI.
6156 (standard-prompt (unless expertp "Export command: "))
6157 (expert-prompt
6158 (when expertp
6159 (format
6160 "Export command (C-%s%s%s%s%s) [%s]: "
6161 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6162 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6163 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6164 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6165 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6166 (mapconcat (lambda (k)
6167 ;; Strip control characters.
6168 (unless (< k 27) (char-to-string k)))
6169 allowed-keys "")))))
6170 ;; With expert UI, just read key with a fancy prompt. In standard
6171 ;; UI, display an intrusive help buffer.
6172 (if expertp
6173 (org-export--dispatch-action
6174 expert-prompt allowed-keys entries options first-key expertp)
6175 ;; At first call, create frame layout in order to display menu.
6176 (unless (get-buffer "*Org Export Dispatcher*")
6177 (delete-other-windows)
6178 (org-switch-to-buffer-other-window
6179 (get-buffer-create "*Org Export Dispatcher*"))
6180 (setq cursor-type nil
6181 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6182 ;; Make sure that invisible cursor will not highlight square
6183 ;; brackets.
6184 (set-syntax-table (copy-syntax-table))
6185 (modify-syntax-entry ?\[ "w"))
6186 ;; At this point, the buffer containing the menu exists and is
6187 ;; visible in the current window. So, refresh it.
6188 (with-current-buffer "*Org Export Dispatcher*"
6189 ;; Refresh help. Maintain display continuity by re-visiting
6190 ;; previous window position.
6191 (let ((pos (window-start)))
6192 (erase-buffer)
6193 (insert help)
6194 (set-window-start nil pos)))
6195 (org-fit-window-to-buffer)
6196 (org-export--dispatch-action
6197 standard-prompt allowed-keys entries options first-key expertp))))
6199 (defun org-export--dispatch-action
6200 (prompt allowed-keys entries options first-key expertp)
6201 "Read a character from command input and act accordingly.
6203 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6204 a list of characters available at a given step in the process.
6205 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6206 EXPERTP are the same as defined in `org-export--dispatch-ui',
6207 which see.
6209 Toggle export options when required. Otherwise, return value is
6210 a list with action as CAR and a list of interactive export
6211 options as CDR."
6212 (let (key)
6213 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6214 ;; C-p, SPC, DEL).
6215 (while (and (setq key (read-char-exclusive prompt))
6216 (not expertp)
6217 (memq key '(14 16 ?\s ?\d)))
6218 (case key
6219 (14 (if (not (pos-visible-in-window-p (point-max)))
6220 (ignore-errors (scroll-up 1))
6221 (message "End of buffer")
6222 (sit-for 1)))
6223 (16 (if (not (pos-visible-in-window-p (point-min)))
6224 (ignore-errors (scroll-down 1))
6225 (message "Beginning of buffer")
6226 (sit-for 1)))
6227 (?\s (if (not (pos-visible-in-window-p (point-max)))
6228 (scroll-up nil)
6229 (message "End of buffer")
6230 (sit-for 1)))
6231 (?\d (if (not (pos-visible-in-window-p (point-min)))
6232 (scroll-down nil)
6233 (message "Beginning of buffer")
6234 (sit-for 1)))))
6235 (cond
6236 ;; Ignore undefined associations.
6237 ((not (memq key allowed-keys))
6238 (ding)
6239 (unless expertp (message "Invalid key") (sit-for 1))
6240 (org-export--dispatch-ui options first-key expertp))
6241 ;; q key at first level aborts export. At second level, cancel
6242 ;; first key instead.
6243 ((eq key ?q) (if (not first-key) (error "Export aborted")
6244 (org-export--dispatch-ui options nil expertp)))
6245 ;; Help key: Switch back to standard interface if expert UI was
6246 ;; active.
6247 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6248 ;; Send request for template insertion along with export scope.
6249 ((eq key ?#) (cons 'template (memq 'subtree options)))
6250 ;; Switch to asynchronous export stack.
6251 ((eq key ?&) '(stack))
6252 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6253 ((memq key '(2 22 19 6 1))
6254 (org-export--dispatch-ui
6255 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6256 (6 'force) (1 'async))))
6257 (if (memq option options) (remq option options)
6258 (cons option options)))
6259 first-key expertp))
6260 ;; Action selected: Send key and options back to
6261 ;; `org-export-dispatch'.
6262 ((or first-key (functionp (nth 2 (assq key entries))))
6263 (cons (cond
6264 ((not first-key) (nth 2 (assq key entries)))
6265 ;; Publishing actions are hard-coded. Send a special
6266 ;; signal to `org-export-dispatch'.
6267 ((eq first-key ?P)
6268 (case key
6269 (?f 'publish-current-file)
6270 (?p 'publish-current-project)
6271 (?x 'publish-choose-project)
6272 (?a 'publish-all)))
6273 ;; Return first action associated to FIRST-KEY + KEY
6274 ;; path. Indeed, derived backends can share the same
6275 ;; FIRST-KEY.
6276 (t (catch 'found
6277 (mapc (lambda (entry)
6278 (let ((match (assq key (nth 2 entry))))
6279 (when match (throw 'found (nth 2 match)))))
6280 (member (assq first-key entries) entries)))))
6281 options))
6282 ;; Otherwise, enter sub-menu.
6283 (t (org-export--dispatch-ui options key expertp)))))
6287 (provide 'ox)
6289 ;; Local variables:
6290 ;; generated-autoload-file: "org-loaddefs.el"
6291 ;; End:
6293 ;;; ox.el ends here