| blob | 3c83006cab581b948892a24462bef7a9d1f60c50 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists of a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place.
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 functions is `org-export-as'. It returns the transcoded
48 ;; buffer as a string. Its derivatives are `org-export-to-buffer' and
49 ;; `org-export-to-file'.
50 ;;
51 ;; An export back-end is defined with `org-export-define-backend'.
52 ;; This function can also support specific buffer keywords, OPTION
53 ;; keyword's items and filters. Refer to function's documentation for
54 ;; more information.
55 ;;
56 ;; If the new back-end shares most properties with another one,
57 ;; `org-export-define-derived-backend' can be used to simplify the
58 ;; process.
59 ;;
60 ;; Any back-end can define its own variables. Among them, those
61 ;; customizable should belong to the `org-export-BACKEND' group.
62 ;;
63 ;; Tools for common tasks across back-ends are implemented in the
64 ;; following part of the file.
65 ;;
66 ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
67 ;; last one.
68 ;;
69 ;; See <http://orgmode.org/worg/dev/org-export-reference.html> for
70 ;; more information.
72 ;;; Code:
90 \f
91 ;;; Internal Variables
92 ;;
93 ;; Among internal variables, the most important is
94 ;; `org-export-options-alist'. This variable define the global export
95 ;; 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 BEHAVIOR) 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 BEHAVIOR 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
182 org-export-options-alist))
242 "Alist between filters properties and initial values.
244 The key of each association is a property name accessible through
245 the communication channel. Its value is a configurable global
246 variable defining initial filters.
248 This list is meant to install user specified filters. Back-end
249 developers may install their own filters using
250 `org-export-define-backend'. Filters defined there will always
251 be prepended to the current list, so they always get applied
260 "Default rule for link matching an inline image.
261 This rule applies to links with no description. By default, it
262 will be considered as an inline image if it targets a local file
265 See `org-export-inline-image-p' for more information about
270 org-element--cache org-element--cache-objects org-element--cache-sync-keys
271 org-element--cache-sync-requests org-element--cache-sync-timer)
272 "List of variables not copied through upon buffer duplication.
273 Export process takes place on a copy of the original buffer.
274 When this copy is created, all Org related local variables not in
275 this list are copied to the new buffer. Variables with an
279 "Non-nil means asynchronous export process should leave data behind.
283 located in `temporary-file-directory'.
285 When non-nil, it will also set `debug-on-error' to a non-nil
289 "Record asynchronously generated export results and processes.
290 This is an alist: its CAR is the source of the
291 result (destination file or buffer for a finished process,
292 original buffer for a running one) and its CDR is a list
293 containing the back-end used, as a symbol, and either a process
294 or the time at which it finished. It is used to build the menu
298 "List of backends currently available in the exporter.
299 This variable is set with `org-export-define-backend' and
303 "Last command called from the dispatcher.
304 The value should be a list. Its CAR is the action, as a symbol,
308 "The position where the last export command was created using the dispatcher.
309 This marker will be used with `C-u C-c C-e' to make sure export repetition
312 ;; For compatibility with Org < 8
314 "Name, if any, of the back-end used during an export process.
316 Its value is a symbol such as `html', `latex', `ascii', or nil if
317 the back-end is anonymous (see `org-export-create-backend') or if
318 there is no export process in progress.
320 It can be used to teach Babel blocks how to act differently
324 \f
325 ;;; User-configurable Variables
326 ;;
327 ;; Configuration for the masses.
328 ;;
329 ;; They should never be accessed directly, as their value is to be
330 ;; stored in a property list (cf. `org-export-options-alist').
331 ;; Back-ends will read their value from there instead.
334 "Options for exporting Org mode files."
339 "General options for export engine."
344 "Whether sub-trees with the ARCHIVE tag should be exported.
346 This can have three different values:
347 nil Do not export, pretend this tree is not present.
348 t Do export the entire tree.
349 `headline' Only export the headline, but skip the tree below it.
351 This option can also be set with the OPTIONS keyword,
360 "Non-nil means insert author name into the exported file.
361 This option can also be set with the OPTIONS keyword,
367 "Non-nil means export CLOCK keywords.
368 This option can also be set with the OPTIONS keyword,
374 "Non-nil means the postamble should contain a creator sentence.
376 The sentence can be set in `org-export-creator-string', which
377 see.
379 This option can also be set with the OPTIONS keyword, e.g.,
387 "Non-nil means insert date in the exported document.
388 This option can also be set with the OPTIONS keyword,
394 "Time-stamp format string to use for DATE keyword.
396 The format string, when specified, only applies if date consists
397 in a single time-stamp. Otherwise its value will be ignored.
399 See `format-time-string' for details on how to build this
400 string."
408 emacs-version
410 "Information about the creator of the document.
411 This option can also be set on with the CREATOR keyword."
416 "Non-nil means export contents of standard drawers.
418 When t, all drawers are exported. This may also be a list of
419 drawer names to export, as strings. If that list starts with
420 `not', only drawers with such names will be ignored.
422 This variable doesn't apply to properties drawers. See
423 `org-export-with-properties' instead.
425 This option can also be set with the OPTIONS keyword,
438 :inline t
442 "Non-nil means insert author email into the exported file.
443 This option can also be set with the OPTIONS keyword,
449 "Non-nil means interpret *word*, /word/, _word_ and +word+.
451 If the export target supports emphasizing text, the word will be
452 typeset in bold, italic, with an underline or strike-through,
453 respectively.
455 This option can also be set with the OPTIONS keyword,
461 "Tags that exclude a tree from export.
463 All trees carrying any of these tags will be excluded from
464 export. This is without condition, so even subtrees inside that
465 carry one of the `org-export-select-tags' will be removed.
467 This option can also be set with the EXCLUDE_TAGS keyword."
473 This option can also be set with the OPTIONS keyword,
481 "Non-nil means Org footnotes should be exported.
482 This option can also be set with the OPTIONS keyword,
488 "Non-nil means process LaTeX environments and fragments.
490 This option can also be set with the OPTIONS line,
493 nil Ignore math snippets.
494 `verbatim' Keep everything in verbatim.
495 t Allow export of math snippets."
505 "The last level which is still exported as a headline.
507 Inferior levels will usually produce itemize or enumerate lists
508 when exported, but back-end behaviour may differ.
510 This option can also be set with the OPTIONS keyword,
516 "The default language for export and clocktable translations, as a string.
517 This may have an association in
518 `org-clock-clocktable-language-setup',
519 `org-export-smart-quotes-alist' and `org-export-dictionary'.
520 This option can also be set with the LANGUAGE keyword."
525 "Non-nil means preserve all line breaks when exporting.
526 This option can also be set with the OPTIONS keyword,
532 "Non-nil means interpret entities when exporting.
535 Å.
537 For a list of supported names, see the constant `org-entities'
538 and the user option `org-entities-user'.
540 This option can also be set with the OPTIONS keyword,
546 "Non-nil means inlinetasks should be exported.
547 This option can also be set with the OPTIONS keyword,
555 "Non-nil means include planning info in export.
557 Planning info is the line containing either SCHEDULED:,
558 DEADLINE:, CLOSED: time-stamps, or a combination of them.
560 This option can also be set with the OPTIONS keyword,
568 "Non-nil means include priority cookies in export.
569 This option can also be set with the OPTIONS keyword,
575 "Non-nil means export contents of properties drawers.
577 When t, all properties are exported. This may also be a list of
578 properties to export, as strings.
580 This option can also be set with the OPTIONS keyword,
592 "Non-nil means add section numbers to headlines when exporting.
594 When set to an integer n, numbering will only happen for
595 headlines whose relative level is higher or equal to n.
597 This option can also be set with the OPTIONS keyword,
603 "Tags that select a tree for export.
605 If any such tag is found in a buffer, all trees that do not carry
606 one of these tags will be ignored during export. Inside trees
607 that are selected like this, you can still deselect a subtree by
608 tagging it with one of the `org-export-exclude-tags'.
610 This option can also be set with the SELECT_TAGS keyword."
615 "Non-nil means activate smart quotes during export.
616 This option can also be set with the OPTIONS keyword,
619 When setting this to non-nil, you need to take care of
620 using the correct Babel package when exporting to LaTeX.
621 E.g., you can load Babel for french like this:
632 When this option is turned on, these strings will be exported as:
634 Org HTML LaTeX UTF-8
635 -----+----------+--------+-------
637 -- – -- –
638 --- — --- —
641 This option can also be set with the OPTIONS keyword,
647 "Non-nil means include statistics cookies in export.
648 This option can also be set with the OPTIONS keyword,
658 If you want to control how Org displays those characters, see
659 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
660 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
661 it is not anymore.
663 When this option is turned on, you can use TeX-like syntax for
664 sub- and superscripts and see them exported correctly.
666 You can also set the option with #+OPTIONS: ^:t
669 single item - so grouping with {} is normally not needed. For
670 example, the following things will be parsed as single sub- or
671 superscripts:
673 10^24 or 10^tau several digits will be considered 1 item.
674 10^-12 or 10^-tau a leading sign with digits or a word
675 x^2-y^3 will be read as x^2 - y^3, because items are
676 terminated by almost any nonword/nondigit char.
677 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
679 Still, ambiguity is possible. So when in doubt, use {} to enclose
680 the sub/superscript. If you set this variable to the symbol `{}',
681 the braces are *required* in order to trigger interpretations as
683 frequently in plain text."
693 "Non-nil means create a table of contents in exported files.
695 The TOC contains headlines with levels up
696 to`org-export-headline-levels'. When an integer, include levels
697 up to N in the toc, this may then be different from
698 `org-export-headline-levels', but it will not be allowed to be
699 larger than the number of headline levels. When nil, no table of
700 contents is made.
702 This option can also be set with the OPTIONS keyword,
711 "Non-nil means export tables.
712 This option can also be set with the OPTIONS keyword,
720 "If nil, do not export tags, just remove them from headlines.
722 If this is the symbol `not-in-toc', tags will be removed from
723 table of contents entries, but still be shown in the headlines of
724 the document.
726 This option can also be set with the OPTIONS keyword,
735 "Non-nil means include TODO items for export.
737 This may have the following values:
738 t include tasks independent of state.
739 `todo' include only tasks that are not yet done.
740 `done' include only tasks that are already done.
741 nil ignore all tasks.
742 list of keywords include tasks with these keywords.
744 This option can also be set with the OPTIONS keyword,
756 "Non-nil means print title into the exported file.
757 This option can also be set with the OPTIONS keyword,
765 "Non-nil means insert a time stamp into the exported file.
766 The time stamp shows when the file was created. This option can
772 "Non nil means allow timestamps in export.
774 It can be set to any of the following values:
775 t export all timestamps.
776 `active' export active timestamps only.
777 `inactive' export inactive timestamps only.
778 nil do not export timestamps
780 This only applies to timestamps isolated in a paragraph
781 containing only timestamps. Other timestamps are always
782 exported.
784 This option can also be set with the OPTIONS keyword, e.g.
794 "Non-nil means include TODO keywords in export.
795 When nil, remove all these keywords from the export. This option
801 "Non-nil means BIND keywords can define local variable values.
802 This is a potential security risk, which is why the default value
803 is nil. You can also allow them through local buffer variables."
810 "Alist between export snippets back-ends and exporter back-ends.
812 This variable allows to provide shortcuts for export snippets.
816 HTML code while every other back-end will ignore it."
825 "Coding system for the exported file."
832 "Non-nil means pushing export output to the kill ring.
833 This variable is ignored during asynchronous export."
843 "The initial scope when exporting with `org-export-dispatch'.
844 This variable can be either set to `buffer' or `subtree'."
851 "Non-nil means show buffer after exporting to temp buffer.
852 When Org exports to a file, the buffer visiting that file is never
853 shown, but remains buried. However, when exporting to
854 a temporary buffer, that buffer is popped up in a second window.
855 When this variable is nil, the buffer remains buried also in
856 these cases."
861 "Non-nil means export and publishing commands will run in background.
862 Results from an asynchronous export are never displayed
870 "File used to initialize external export process.
872 Value must be either nil or an absolute file name. When nil, the
873 external process is launched like a regular Emacs session,
874 loading user's initialization file and any site specific
875 configuration. If a file is provided, it, and only it, is loaded
876 at start-up.
878 Therefore, using a specific configuration makes the process to
879 load faster and the export more portable."
888 "Non-nil means using a non-intrusive `org-export-dispatch'.
889 In that case, no help buffer is displayed. Though, an indicator
895 asynchronous). Also, \[?] allows to switch back to standard
896 mode."
903 \f
904 ;;; Defining Back-ends
905 ;;
906 ;; An export back-end is a structure with `org-export-backend' type
907 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
908 ;; and `menu' slots.
909 ;;
910 ;; At the lowest level, a back-end is created with
911 ;; `org-export-create-backend' function.
912 ;;
913 ;; A named back-end can be registered with
914 ;; `org-export-register-backend' function. A registered back-end can
915 ;; later be referred to by its name, with `org-export-get-backend'
916 ;; function. Also, such a back-end can become the parent of a derived
917 ;; back-end from which slot values will be inherited by default.
918 ;; `org-export-derived-backend-p' can check if a given back-end is
919 ;; derived from a list of back-end names.
920 ;;
921 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
922 ;; `org-export-get-all-filters' return the full alist of transcoders,
923 ;; options and filters, including those inherited from ancestors.
924 ;;
925 ;; At a higher level, `org-export-define-backend' is the standard way
926 ;; to define an export back-end. If the new back-end is similar to
927 ;; a registered back-end, `org-export-define-derived-backend' may be
928 ;; used instead.
929 ;;
930 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
931 ;; when a given back-end hasn't been registered yet.
935 name parent transcoders options filters blocks menu)
938 "Return export back-end named after NAME.
939 NAME is a symbol. Return nil if no such back-end is found."
946 "Register BACKEND as a known export back-end.
947 BACKEND is a structure with `org-export-backend' type."
948 ;; Refuse to register an unnamed back-end.
951 ;; Refuse to register a back-end with an unknown parent.
955 ;; Register dedicated export blocks in the parser.
959 ;; If a back-end with the same name as BACKEND is already
960 ;; registered, replace it with BACKEND. Otherwise, simply add
961 ;; BACKEND to the list of registered back-ends.
967 "Signal an error if BACKEND isn't defined."
972 "Non-nil if BACKEND is derived from one of BACKENDS.
973 BACKEND is an export back-end, as returned by, e.g.,
974 `org-export-create-backend', or a symbol referring to
975 a registered back-end. BACKENDS is constituted of symbols."
987 "Return full translation table for BACKEND.
989 BACKEND is an export back-end, as return by, e.g,,
990 `org-export-create-backend'. Return value is an alist where
991 keys are element or object types, as symbols, and values are
992 transcoders.
994 Unlike to `org-export-backend-transcoders', this function
995 also returns transcoders inherited from parent back-ends,
996 if any."
1000 parent)
1005 transcoders)))
1008 "Return export options for BACKEND.
1010 BACKEND is an export back-end, as return by, e.g,,
1011 `org-export-create-backend'. See `org-export-options-alist'
1012 for the shape of the return value.
1014 Unlike to `org-export-backend-options', this function also
1015 returns options inherited from parent back-ends, if any."
1019 parent)
1023 options)))
1026 "Return complete list of filters for BACKEND.
1028 BACKEND is an export back-end, as return by, e.g,,
1029 `org-export-create-backend'. Return value is an alist where
1030 keys are symbols and values lists of functions.
1032 Unlike to `org-export-backend-filters', this function also
1033 returns filters inherited from parent back-ends, if any."
1037 parent)
1041 filters)))
1044 "Define a new back-end BACKEND.
1046 TRANSCODERS is an alist between object or element types and
1047 functions handling them.
1049 These functions should return a string without any trailing
1050 space, or nil. They must accept three arguments: the object or
1051 element itself, its contents or nil when it isn't recursive and
1052 the property list used as a communication channel.
1054 Contents, when not nil, are stripped from any global indentation
1055 \(although the relative one is preserved). They also always end
1056 with a single newline character.
1058 If, for a given type, no function is found, that element or
1059 object type will simply be ignored, along with any blank line or
1060 white space at its end. The same will happen if the function
1061 returns the nil value. If that function returns the empty
1062 string, the type will be ignored, but the blank lines or white
1063 spaces will be kept.
1065 In addition to element and object types, one function can be
1066 associated to the `template' (or `inner-template') symbol and
1067 another one to the `plain-text' symbol.
1069 The former returns the final transcoded string, and can be used
1070 to add a preamble and a postamble to document's body. It must
1071 accept two arguments: the transcoded string and the property list
1072 containing export options. A function associated to `template'
1074 A function associated to `inner-template' is always applied.
1076 The latter, when defined, is to be called on every text not
1077 recognized as an element or an object. It must accept two
1078 arguments: the text string and the information channel. It is an
1079 appropriate place to protect special chars relative to the
1080 back-end.
1082 BODY can start with pre-defined keyword arguments. The following
1083 keywords are understood:
1085 :export-block
1087 String, or list of strings, representing block names that
1088 will not be parsed. This is used to specify blocks that will
1089 contain raw code specific to the back-end. These blocks
1090 still have to be handled by the relative `export-block' type
1091 translator.
1093 :filters-alist
1095 Alist between filters and function, or list of functions,
1096 specific to the back-end. See `org-export-filters-alist' for
1097 a list of all allowed filters. Filters defined here
1098 shouldn't make a back-end test, as it may prevent back-ends
1099 derived from this one to behave properly.
1101 :menu-entry
1103 Menu entry for the export dispatcher. It should be a list
1104 like:
1106 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1108 where :
1110 KEY is a free character selecting the back-end.
1112 DESCRIPTION-OR-ORDINAL is either a string or a number.
1114 If it is a string, is will be used to name the back-end in
1115 its menu entry. If it is a number, the following menu will
1116 be displayed as a sub-menu of the back-end with the same
1117 KEY. Also, the number will be used to determine in which
1118 order such sub-menus will appear (lowest first).
1120 ACTION-OR-MENU is either a function or an alist.
1122 If it is an action, it will be called with four
1123 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1124 BODY-ONLY. See `org-export-as' for further explanations on
1125 some of them.
1127 If it is an alist, associations should follow the
1128 pattern:
1130 '(KEY DESCRIPTION ACTION)
1132 where KEY, DESCRIPTION and ACTION are described above.
1134 Valid values include:
1138 or
1143 \(lambda (a s v b)
1144 \(if a (org-latex-export-to-pdf t s v b)
1145 \(org-open-file
1146 \(org-latex-export-to-pdf nil s v b)))))))
1148 or the following, which will be added to the previous
1149 sub-menu,
1151 '(?l 1
1155 :options-alist
1157 Alist between back-end specific properties introduced in
1158 communication channel and how their value are acquired. See
1159 `org-export-options-alist' for more information about
1160 structure of the values."
1175 :transcoders transcoders
1176 :options options
1177 :filters filters
1178 :blocks blocks
1182 "Create a new back-end as a variant of an existing one.
1184 CHILD is the name of the derived back-end. PARENT is the name of
1185 the parent back-end.
1187 BODY can start with pre-defined keyword arguments. The following
1188 keywords are understood:
1190 :export-block
1192 String, or list of strings, representing block names that
1193 will not be parsed. This is used to specify blocks that will
1194 contain raw code specific to the back-end. These blocks
1195 still have to be handled by the relative `export-block' type
1196 translator.
1198 :filters-alist
1200 Alist of filters that will overwrite or complete filters
1201 defined in PARENT back-end. See `org-export-filters-alist'
1202 for a list of allowed filters.
1204 :menu-entry
1206 Menu entry for the export dispatcher. See
1207 `org-export-define-backend' for more information about the
1208 expected value.
1210 :options-alist
1212 Alist of back-end specific properties that will overwrite or
1213 complete those defined in PARENT back-end. Refer to
1214 `org-export-options-alist' for more information about
1215 structure of the values.
1217 :translate-alist
1219 Alist of element and object types and transcoders that will
1220 overwrite or complete transcode table from PARENT back-end.
1221 Refer to `org-export-define-backend' for detailed information
1222 about transcoders.
1225 as a variant of `latex' back-end with a custom template function:
1227 \(org-export-define-derived-backend 'my-latex 'latex
1228 :translate-alist '((template . my-latex-template-fun)))
1230 The back-end could then be called with, for example:
1248 :parent parent
1249 :transcoders transcoders
1250 :options options
1251 :filters filters
1252 :blocks blocks
1256 \f
1257 ;;; The Communication Channel
1258 ;;
1259 ;; During export process, every function has access to a number of
1260 ;; properties. They are of two types:
1261 ;;
1262 ;; 1. Environment options are collected once at the very beginning of
1263 ;; the process, out of the original buffer and configuration.
1264 ;; Collecting them is handled by `org-export-get-environment'
1265 ;; function.
1266 ;;
1267 ;; Most environment options are defined through the
1268 ;; `org-export-options-alist' variable.
1269 ;;
1270 ;; 2. Tree properties are extracted directly from the parsed tree,
1271 ;; just before export, by `org-export-collect-tree-properties'.
1273 ;;;; Environment Options
1274 ;;
1275 ;; Environment options encompass all parameters defined outside the
1276 ;; scope of the parsed data. They come from five sources, in
1277 ;; increasing precedence order:
1278 ;;
1279 ;; - Global variables,
1280 ;; - Buffer's attributes,
1281 ;; - Options keyword symbols,
1282 ;; - Buffer keywords,
1283 ;; - Subtree properties.
1284 ;;
1285 ;; The central internal function with regards to environment options
1286 ;; is `org-export-get-environment'. It updates global variables with
1287 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1288 ;; the different sources.
1289 ;;
1290 ;; The internal functions doing the retrieval are:
1291 ;; `org-export--get-global-options',
1292 ;; `org-export--get-buffer-attributes',
1293 ;; `org-export--parse-option-keyword',
1294 ;; `org-export--get-subtree-options' and
1295 ;; `org-export--get-inbuffer-options'
1296 ;;
1297 ;; Also, `org-export--list-bound-variables' collects bound variables
1298 ;; along with their value in order to set them as buffer local
1299 ;; variables later in the process.
1302 "Collect export options from the current buffer.
1304 Optional argument BACKEND is an export back-end, as returned by
1305 `org-export-create-backend'.
1307 When optional argument SUBTREEP is non-nil, assume the export is
1308 done against the current sub-tree.
1310 Third optional argument EXT-PLIST is a property list with
1311 external parameters overriding Org default settings, but still
1312 inferior to file-local settings."
1313 ;; First install #+BIND variables since these must be set before
1314 ;; global options are read.
1317 ;; Get and prioritize export options...
1319 ;; ... from global variables...
1321 ;; ... from an external property list...
1322 ext-plist
1323 ;; ... from in-buffer settings...
1325 ;; ... and from subtree, when appropriate.
1327 ;; Eventually add misc. properties.
1329 :back-end
1330 backend
1332 :footnote-definition-alist
1333 ;; Footnotes definitions must be collected in the original
1334 ;; buffer, as there's no insurance that they will still be in
1335 ;; the parse tree, due to possible narrowing.
1351 alist))
1363 alist)))))))
1364 alist))
1365 :id-alist
1366 ;; Collect id references.
1377 alist))))
1380 "Parse an OPTIONS line and return values as a plist.
1381 Optional argument BACKEND is an export back-end, as returned by,
1382 e.g., `org-export-create-backend'. It specifies which back-end
1383 specific items to read, if any."
1385 ;; Priority is given to back-end specific options.
1387 org-export-options-alist))
1388 plist)
1397 options))
1399 property
1402 plist))
1405 "Get export options in subtree at point.
1406 Optional argument BACKEND is an export back-end, as returned by,
1407 e.g., `org-export-create-backend'. It specifies back-end used
1408 for export. Return options as a plist."
1409 ;; For each buffer keyword, create a headline property setting the
1410 ;; same property in communication channel. The name for the property
1411 ;; is the keyword with "EXPORT_" appended to it.
1414 ;; Make sure point is at a heading.
1416 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1417 ;; title (with no todo keyword, priority cookie or tag) as its
1418 ;; fallback value.
1424 plist :title
1427 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1431 ;; Handle other keywords. TITLE keyword is excluded as it has
1432 ;; been handled already.
1440 ;; Export properties are not case-sensitive.
1447 plist
1448 property
1450 ;; Parse VALUE if required.
1454 ;; If BEHAVIOR is `split' expected value is
1455 ;; a list of strings, not a string.
1458 ;; Look for both general keywords and back-end specific
1459 ;; options, with priority given to the latter.
1461 org-export-options-alist)))
1462 ;; Return value.
1463 plist)))
1466 "Return current buffer export options, as a plist.
1468 Optional argument BACKEND, when non-nil, is an export back-end,
1469 as returned by, e.g., `org-export-create-backend'. It specifies
1470 which back-end specific options should also be read in the
1471 process.
1473 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1475 get-options ; For byte-compiler.
1478 ;; Priority is given to back-end specific options.
1480 org-export-options-alist))
1483 org-export-special-keywords))))
1486 ;; Return all properties associated to KEYWORD.
1493 ;; Recursively read keywords in buffer. FILES is a list
1494 ;; of files read so far. PLIST is the current property
1495 ;; list obtained.
1504 ;; Options in `org-export-special-keywords'.
1508 ;; Avoid circular dependencies.
1518 plist
1523 plist
1529 ;; Options in `org-export-options-alist'.
1534 plist property
1535 ;; Handle value depending on specified
1536 ;; BEHAVIOR.
1542 " "
1555 ;; Return final value.
1556 plist))))
1557 ;; Read options in the current buffer.
1560 ;; Parse keywords specified in `org-element-document-properties'
1561 ;; and return PLIST.
1572 "Return properties related to buffer attributes, as a plist."
1577 "Return global export options as a plist.
1578 Optional argument BACKEND, if non-nil, is an export back-end, as
1579 returned by, e.g., `org-export-create-backend'. It specifies
1580 which back-end specific export options should also be read in the
1581 process."
1583 ;; Priority is given to back-end specific options.
1585 org-export-options-alist)))
1591 plist
1592 prop
1593 ;; Evaluate default value provided. If keyword is
1594 ;; a member of `org-element-document-properties',
1595 ;; parse it as a secondary string before storing it.
1599 org-element-document-properties))
1602 value)))))))))
1605 "Return variables bound from BIND keywords in current buffer.
1606 Also look for BIND keywords in setup files. The return value is
1607 an alist where associations are (VARIABLE-NAME VALUE)."
1612 ;; Return an alist between variable names and their
1613 ;; value. FILES is a list of setup files names read so
1614 ;; far, used to avoid circular dependencies. ALIST is
1615 ;; the alist collected so far.
1626 ;; Enter setup file.
1636 alist))))))))))
1637 alist)))))
1638 ;; Return value in appropriate order of appearance.
1641 ;; defsubst org-export-get-parent must be defined before first use,
1642 ;; was originally defined in the topology section
1645 "Return BLOB parent or nil.
1646 BLOB is the element or object considered."
1649 ;;;; Tree Properties
1650 ;;
1651 ;; Tree properties are information extracted from parse tree. They
1652 ;; are initialized at the beginning of the transcoding process by
1653 ;; `org-export-collect-tree-properties'.
1654 ;;
1655 ;; Dedicated functions focus on computing the value of specific tree
1656 ;; properties during initialization. Thus,
1657 ;; `org-export--populate-ignore-list' lists elements and objects that
1658 ;; should be skipped during export, `org-export--get-min-level' gets
1659 ;; the minimal exportable level, used as a basis to compute relative
1660 ;; level for headlines. Eventually
1661 ;; `org-export--collect-headline-numbering' builds an alist between
1662 ;; headlines and their numbering.
1665 "Extract tree properties from parse tree.
1667 DATA is the parse tree from which information is retrieved. INFO
1668 is a list holding export options.
1670 Following tree properties are set or updated:
1672 `:exported-data' Hash table used to memoize results from
1673 `org-export-data'.
1675 `:footnote-definition-alist' List of footnotes definitions in
1676 original buffer and current parse tree.
1678 `:headline-offset' Offset between true level of headlines and
1679 local level. An offset of -1 means a headline
1680 of level 2 should be considered as a level
1681 1 headline in the context.
1683 `:headline-numbering' Alist of all headlines as key an the
1684 associated numbering as value.
1686 Return updated plist."
1687 ;; Install the parse tree in the communication channel.
1689 ;; Compute `:headline-offset' in order to be able to use
1690 ;; `org-export-get-relative-level'.
1693 :headline-offset
1695 ;; Footnote definitions in parse tree override those stored in
1696 ;; `:footnote-definition-alist'. This way, any change to
1697 ;; a definition in the parse tree (e.g., through a parse tree
1698 ;; filter) propagates into the alist.
1705 defs))
1709 defs)))))
1711 ;; Properties order doesn't matter: get the rest of the tree
1712 ;; properties.
1717 info))
1720 "Return minimum exportable headline's level in DATA.
1721 DATA is parsed tree as returned by `org-element-parse-buffer'.
1722 OPTIONS is a plist holding export options."
1733 ;; If no headline was found, for the sake of consistency, set
1734 ;; minimum level to 1 nonetheless.
1738 "Return numbering of all exportable, numbered headlines in a parse tree.
1740 DATA is the parse tree. OPTIONS is the plist holding export
1741 options.
1743 Return an alist whose key is a headline and value is its
1744 associated numbering \(in the shape of a list of numbers\) or nil
1745 for a footnotes section."
1754 headline
1756 for idx from 0 to org-export-max-depth
1760 options)))
1763 "Return numbering of all exportable, unnumbered headlines.
1764 DATA is the parse tree. OPTIONS is the plist holding export
1765 options. Unnumbered headlines are numbered as a function of
1766 occurrence."
1774 "List headlines and inlinetasks with a select tag in their tree.
1775 DATA is parsed data as returned by `org-element-parse-buffer'.
1776 INFO is a plist holding export options."
1778 walk-data ; For byte-compiler.
1788 ;; When a select tag is found, mark full
1789 ;; genealogy and every headline within the tree
1790 ;; as acceptable.
1793 genealogy
1796 selected-trees))
1797 ;; If at a headline, continue searching in tree,
1798 ;; recursively.
1807 selected-trees))
1810 "Non-nil when element or object BLOB should be skipped during export.
1811 OPTIONS is the plist holding export options. SELECTED, when
1812 non-nil, is a list of headlines or inlinetasks belonging to
1813 a tree with a select tag."
1820 ;; If `:with-drawers' value starts with `not', ignore
1821 ;; every drawer whose name belong to that list.
1822 ;; Otherwise, ignore drawers whose name isn't in that
1823 ;; list.
1840 ;; Ignore subtrees with an exclude tag.
1843 ;; When a select tag is present in the buffer, ignore any tree
1844 ;; without it.
1846 ;; Ignore commented sub-trees.
1848 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1850 ;; Ignore tasks, if specified by `:with-tasks' property.
1862 properties-set))))))
1873 ;; `:with-timestamps' only applies to isolated timestamps
1874 ;; objects, i.e. timestamp objects in a paragraph containing only
1875 ;; timestamps and whitespaces.
1883 options t))))
1892 \f
1893 ;;; The Transcoder
1894 ;;
1895 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1896 ;; `org-element-parse-buffer') and transcodes it into a specified
1897 ;; back-end output. It takes care of filtering out elements or
1898 ;; objects according to export options and organizing the output blank
1899 ;; lines and white space are preserved. The function memoizes its
1900 ;; results, so it is cheap to call it within transcoders.
1901 ;;
1902 ;; It is possible to modify locally the back-end used by
1903 ;; `org-export-data' or even use a temporary back-end by using
1904 ;; `org-export-data-with-backend'.
1905 ;;
1906 ;; `org-export-transcoder' is an accessor returning appropriate
1907 ;; translator function for a given element or object.
1910 "Return appropriate transcoder for BLOB.
1911 INFO is a plist containing export directives."
1913 ;; Return contents only for complete parse trees.
1919 "Convert DATA into current back-end format.
1921 DATA is a parse tree, an element or an object or a secondary
1922 string. INFO is a plist holding export options.
1924 Return a string."
1929 ;; Ignored element/object.
1931 ;; Plain text.
1937 info))
1938 ;; Secondary string.
1941 ;; Element/Object without contents or, as a special
1942 ;; case, headline with archive tag and archived trees
1943 ;; restricted to title only.
1951 ;; Export snippets never return a nil value so
1952 ;; that white spaces following them are never
1953 ;; ignored.
1955 ;; Element/Object with contents.
1968 ;; Elements directly containing
1969 ;; objects must have their indentation
1970 ;; normalized first.
1972 data
1973 ;; When normalizing contents of the
1974 ;; first paragraph in an item or
1975 ;; a footnote definition, ignore
1976 ;; first line's indentation: there is
1977 ;; none and it might be misleading.
1982 data)
1989 info))))))))
1990 ;; Final result will be memoized before being returned.
1992 data
1996 ;; Append the same white space between elements or objects
1997 ;; as in the original buffer, and call appropriate filters.
2008 info)))
2009 results)))
2013 "Convert DATA into BACKEND format.
2015 DATA is an element, an object, a secondary string or a string.
2016 BACKEND is a symbol. INFO is a plist used as a communication
2017 channel.
2019 Unlike to `org-export-with-backend', this function will
2020 recursively convert DATA using BACKEND translation table."
2023 data
2024 ;; Set-up a new communication channel with translations defined in
2025 ;; BACKEND as the translate table and a new hash table for
2026 ;; memoization.
2028 info
2031 ;; Size of the hash table is reduced since this function
2032 ;; will probably be used on small trees.
2036 "Prune non exportable elements from DATA.
2037 DATA is the parse tree to traverse. INFO is the plist holding
2038 export info. Also set `:ignore-list' in INFO to a list of
2039 objects which should be ignored during export, but not removed
2040 from tree."
2042 ignore
2043 ;; First find trees containing a select tag, if any.
2047 ;; Prune non-exportable elements and objects from tree.
2048 ;; As a special case, special rows and cells from tables
2049 ;; are stored in IGNORE, as they still need to be accessed
2050 ;; during export.
2058 ;; If headline is archived but tree below has to
2059 ;; be skipped, remove contents.
2061 ;; Move into secondary string, if any.
2066 ;; Move into recursive objects/elements.
2068 ;; If a select tag is active, also ignore the section before the
2069 ;; first headline, if any.
2074 ;; Prune tree and communication channel.
2078 ;; Eventually set `:ignore-list'.
2082 "Change uninterpreted elements back into Org syntax.
2083 DATA is the parse tree. INFO is a plist containing export
2084 options. Each uninterpreted element or object is changed back
2085 into a string. Contents, if any, are not modified. The parse
2086 tree is modified by side effect."
2090 prop
2093 info))))
2096 "Change uninterpreted elements back into Org syntax.
2097 DATA is a parse tree or a secondary string. INFO is a plist
2098 containing export options. It is modified by side effect and
2099 returned by the function."
2102 subscript superscript underline)
2106 ;; ... entities...
2113 ?\s)))))
2114 ;; ... emphasis...
2126 marker
2130 ?\s)))))))
2131 ;; ... LaTeX environments and fragments...
2135 ;; ... sub/superscripts...
2144 "_"
2153 ?\s)))))))))))
2155 ;; Splice NEW at BLOB location in parse tree.
2158 info)
2159 ;; Return modified parse tree.
2160 data)
2163 "Expand a parsed element or object to its original state.
2165 BLOB is either an element or an object. CONTENTS is its
2166 contents, as a string or nil.
2168 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2169 keywords before output."
2174 blob contents))))
2177 \f
2178 ;;; The Filter System
2179 ;;
2180 ;; Filters allow end-users to tweak easily the transcoded output.
2181 ;; They are the functional counterpart of hooks, as every filter in
2182 ;; a set is applied to the return value of the previous one.
2183 ;;
2184 ;; Every set is back-end agnostic. Although, a filter is always
2185 ;; called, in addition to the string it applies to, with the back-end
2186 ;; used as argument, so it's easy for the end-user to add back-end
2187 ;; specific filters in the set. The communication channel, as
2188 ;; a plist, is required as the third argument.
2189 ;;
2190 ;; From the developer side, filters sets can be installed in the
2191 ;; process with the help of `org-export-define-backend', which
2192 ;; internally stores filters as an alist. Each association has a key
2193 ;; among the following symbols and a function or a list of functions
2194 ;; as value.
2195 ;;
2196 ;; - `:filter-options' applies to the property list containing export
2197 ;; options. Unlike to other filters, functions in this list accept
2198 ;; two arguments instead of three: the property list containing
2199 ;; export options and the back-end. Users can set its value through
2200 ;; `org-export-filter-options-functions' variable.
2201 ;;
2202 ;; - `:filter-parse-tree' applies directly to the complete parsed
2203 ;; tree. Users can set it through
2204 ;; `org-export-filter-parse-tree-functions' variable.
2205 ;;
2206 ;; - `:filter-body' applies to the body of the output, before template
2207 ;; translator chimes in. Users can set it through
2208 ;; `org-export-filter-body-functions' variable.
2209 ;;
2210 ;; - `:filter-final-output' applies to the final transcoded string.
2211 ;; Users can set it with `org-export-filter-final-output-functions'
2212 ;; variable.
2213 ;;
2214 ;; - `:filter-plain-text' applies to any string not recognized as Org
2215 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2216 ;; configure it.
2217 ;;
2218 ;; - `:filter-TYPE' applies on the string returned after an element or
2219 ;; object of type TYPE has been transcoded. A user can modify
2220 ;; `org-export-filter-TYPE-functions' to install these filters.
2221 ;;
2222 ;; All filters sets are applied with
2223 ;; `org-export-filter-apply-functions' function. Filters in a set are
2224 ;; applied in a LIFO fashion. It allows developers to be sure that
2225 ;; their filters will be applied first.
2226 ;;
2227 ;; Filters properties are installed in communication channel with
2228 ;; `org-export-install-filters' function.
2229 ;;
2230 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2231 ;; `org-export-before-parsing-hook') are run at the beginning of the
2232 ;; export process and just before parsing to allow for heavy structure
2233 ;; modifications.
2236 ;;;; Hooks
2239 "Hook run at the beginning of the export process.
2241 This is run before include keywords and macros are expanded and
2242 Babel code blocks executed, on a copy of the original buffer
2243 being exported. Visibility and narrowing are preserved. Point
2244 is at the beginning of the buffer.
2246 Every function in this hook will be called with one argument: the
2250 "Hook run before parsing an export buffer.
2252 This is run after include keywords and macros have been expanded
2253 and Babel code blocks executed, on a copy of the original buffer
2254 being exported. Visibility and narrowing are preserved. Point
2255 is at the beginning of the buffer.
2257 Every function in this hook will be called with one argument: the
2261 ;;;; Special Filters
2264 "List of functions applied to the export options.
2265 Each filter is called with two arguments: the export options, as
2266 a plist, and the back-end, as a symbol. It must return
2270 "List of functions applied to the parsed tree.
2271 Each filter is called with three arguments: the parse tree, as
2272 returned by `org-element-parse-buffer', the back-end, as
2273 a symbol, and the communication channel, as a plist. It must
2277 "List of functions applied to plain text.
2278 Each filter is called with three arguments: a string which
2279 contains no Org syntax, the back-end, as a symbol, and the
2280 communication channel, as a plist. It must return a string or
2284 "List of functions applied to transcoded body.
2285 Each filter is called with three arguments: a string which
2286 contains no Org syntax, the back-end, as a symbol, and the
2287 communication channel, as a plist. It must return a string or
2291 "List of functions applied to the transcoded string.
2292 Each filter is called with three arguments: the full transcoded
2293 string, the back-end, as a symbol, and the communication channel,
2294 as a plist. It must return a string that will be used as the
2298 ;;;; Elements Filters
2301 "List of functions applied to a transcoded babel-call.
2302 Each filter is called with three arguments: the transcoded data,
2303 as a string, the back-end, as a symbol, and the communication
2307 "List of functions applied to a transcoded center block.
2308 Each filter is called with three arguments: the transcoded data,
2309 as a string, the back-end, as a symbol, and the communication
2313 "List of functions applied to a transcoded clock.
2314 Each filter is called with three arguments: the transcoded data,
2315 as a string, the back-end, as a symbol, and the communication
2319 "List of functions applied to a transcoded comment.
2320 Each filter is called with three arguments: the transcoded data,
2321 as a string, the back-end, as a symbol, and the communication
2325 "List of functions applied to a transcoded comment-block.
2326 Each filter is called with three arguments: the transcoded data,
2327 as a string, the back-end, as a symbol, and the communication
2331 "List of functions applied to a transcoded diary-sexp.
2332 Each filter is called with three arguments: the transcoded data,
2333 as a string, the back-end, as a symbol, and the communication
2337 "List of functions applied to a transcoded drawer.
2338 Each filter is called with three arguments: the transcoded data,
2339 as a string, the back-end, as a symbol, and the communication
2343 "List of functions applied to a transcoded dynamic-block.
2344 Each filter is called with three arguments: the transcoded data,
2345 as a string, the back-end, as a symbol, and the communication
2349 "List of functions applied to a transcoded example-block.
2350 Each filter is called with three arguments: the transcoded data,
2351 as a string, the back-end, as a symbol, and the communication
2355 "List of functions applied to a transcoded export-block.
2356 Each filter is called with three arguments: the transcoded data,
2357 as a string, the back-end, as a symbol, and the communication
2361 "List of functions applied to a transcoded fixed-width.
2362 Each filter is called with three arguments: the transcoded data,
2363 as a string, the back-end, as a symbol, and the communication
2367 "List of functions applied to a transcoded footnote-definition.
2368 Each filter is called with three arguments: the transcoded data,
2369 as a string, the back-end, as a symbol, and the communication
2373 "List of functions applied to a transcoded headline.
2374 Each filter is called with three arguments: the transcoded data,
2375 as a string, the back-end, as a symbol, and the communication
2379 "List of functions applied to a transcoded horizontal-rule.
2380 Each filter is called with three arguments: the transcoded data,
2381 as a string, the back-end, as a symbol, and the communication
2385 "List of functions applied to a transcoded inlinetask.
2386 Each filter is called with three arguments: the transcoded data,
2387 as a string, the back-end, as a symbol, and the communication
2391 "List of functions applied to a transcoded item.
2392 Each filter is called with three arguments: the transcoded data,
2393 as a string, the back-end, as a symbol, and the communication
2397 "List of functions applied to a transcoded keyword.
2398 Each filter is called with three arguments: the transcoded data,
2399 as a string, the back-end, as a symbol, and the communication
2403 "List of functions applied to a transcoded latex-environment.
2404 Each filter is called with three arguments: the transcoded data,
2405 as a string, the back-end, as a symbol, and the communication
2409 "List of functions applied to a transcoded node-property.
2410 Each filter is called with three arguments: the transcoded data,
2411 as a string, the back-end, as a symbol, and the communication
2415 "List of functions applied to a transcoded paragraph.
2416 Each filter is called with three arguments: the transcoded data,
2417 as a string, the back-end, as a symbol, and the communication
2421 "List of functions applied to a transcoded plain-list.
2422 Each filter is called with three arguments: the transcoded data,
2423 as a string, the back-end, as a symbol, and the communication
2427 "List of functions applied to a transcoded planning.
2428 Each filter is called with three arguments: the transcoded data,
2429 as a string, the back-end, as a symbol, and the communication
2433 "List of functions applied to a transcoded property-drawer.
2434 Each filter is called with three arguments: the transcoded data,
2435 as a string, the back-end, as a symbol, and the communication
2439 "List of functions applied to a transcoded quote block.
2440 Each filter is called with three arguments: the transcoded quote
2441 data, as a string, the back-end, as a symbol, and the
2442 communication channel, as a plist. It must return a string or
2446 "List of functions applied to a transcoded section.
2447 Each filter is called with three arguments: the transcoded data,
2448 as a string, the back-end, as a symbol, and the communication
2452 "List of functions applied to a transcoded special block.
2453 Each filter is called with three arguments: the transcoded data,
2454 as a string, the back-end, as a symbol, and the communication
2458 "List of functions applied to a transcoded src-block.
2459 Each filter is called with three arguments: the transcoded data,
2460 as a string, the back-end, as a symbol, and the communication
2464 "List of functions applied to a transcoded table.
2465 Each filter is called with three arguments: the transcoded data,
2466 as a string, the back-end, as a symbol, and the communication
2470 "List of functions applied to a transcoded table-cell.
2471 Each filter is called with three arguments: the transcoded data,
2472 as a string, the back-end, as a symbol, and the communication
2476 "List of functions applied to a transcoded table-row.
2477 Each filter is called with three arguments: the transcoded data,
2478 as a string, the back-end, as a symbol, and the communication
2482 "List of functions applied to a transcoded verse block.
2483 Each filter is called with three arguments: the transcoded data,
2484 as a string, the back-end, as a symbol, and the communication
2488 ;;;; Objects Filters
2491 "List of functions applied to transcoded bold text.
2492 Each filter is called with three arguments: the transcoded data,
2493 as a string, the back-end, as a symbol, and the communication
2497 "List of functions applied to transcoded code text.
2498 Each filter is called with three arguments: the transcoded data,
2499 as a string, the back-end, as a symbol, and the communication
2503 "List of functions applied to a transcoded entity.
2504 Each filter is called with three arguments: the transcoded data,
2505 as a string, the back-end, as a symbol, and the communication
2509 "List of functions applied to a transcoded export-snippet.
2510 Each filter is called with three arguments: the transcoded data,
2511 as a string, the back-end, as a symbol, and the communication
2515 "List of functions applied to a transcoded footnote-reference.
2516 Each filter is called with three arguments: the transcoded data,
2517 as a string, the back-end, as a symbol, and the communication
2521 "List of functions applied to a transcoded inline-babel-call.
2522 Each filter is called with three arguments: the transcoded data,
2523 as a string, the back-end, as a symbol, and the communication
2527 "List of functions applied to a transcoded inline-src-block.
2528 Each filter is called with three arguments: the transcoded data,
2529 as a string, the back-end, as a symbol, and the communication
2533 "List of functions applied to transcoded italic text.
2534 Each filter is called with three arguments: the transcoded data,
2535 as a string, the back-end, as a symbol, and the communication
2539 "List of functions applied to a transcoded latex-fragment.
2540 Each filter is called with three arguments: the transcoded data,
2541 as a string, the back-end, as a symbol, and the communication
2545 "List of functions applied to a transcoded line-break.
2546 Each filter is called with three arguments: the transcoded data,
2547 as a string, the back-end, as a symbol, and the communication
2551 "List of functions applied to a transcoded link.
2552 Each filter is called with three arguments: the transcoded data,
2553 as a string, the back-end, as a symbol, and the communication
2557 "List of functions applied to a transcoded radio-target.
2558 Each filter is called with three arguments: the transcoded data,
2559 as a string, the back-end, as a symbol, and the communication
2563 "List of functions applied to a transcoded statistics-cookie.
2564 Each filter is called with three arguments: the transcoded data,
2565 as a string, the back-end, as a symbol, and the communication
2569 "List of functions applied to transcoded strike-through text.
2570 Each filter is called with three arguments: the transcoded data,
2571 as a string, the back-end, as a symbol, and the communication
2575 "List of functions applied to a transcoded subscript.
2576 Each filter is called with three arguments: the transcoded data,
2577 as a string, the back-end, as a symbol, and the communication
2581 "List of functions applied to a transcoded superscript.
2582 Each filter is called with three arguments: the transcoded data,
2583 as a string, the back-end, as a symbol, and the communication
2587 "List of functions applied to a transcoded target.
2588 Each filter is called with three arguments: the transcoded data,
2589 as a string, the back-end, as a symbol, and the communication
2593 "List of functions applied to a transcoded timestamp.
2594 Each filter is called with three arguments: the transcoded data,
2595 as a string, the back-end, as a symbol, and the communication
2599 "List of functions applied to transcoded underline text.
2600 Each filter is called with three arguments: the transcoded data,
2601 as a string, the back-end, as a symbol, and the communication
2605 "List of functions applied to transcoded verbatim text.
2606 Each filter is called with three arguments: the transcoded data,
2607 as a string, the back-end, as a symbol, and the communication
2611 ;;;; Filters Tools
2612 ;;
2613 ;; Internal function `org-export-install-filters' installs filters
2614 ;; hard-coded in back-ends (developer filters) and filters from global
2615 ;; variables (user filters) in the communication channel.
2616 ;;
2617 ;; Internal function `org-export-filter-apply-functions' takes care
2618 ;; about applying each filter in order to a given data. It ignores
2619 ;; filters returning a nil value but stops whenever a filter returns
2620 ;; an empty string.
2623 "Call every function in FILTERS.
2625 Functions are called with arguments VALUE, current export
2626 back-end's name and INFO. A function returning a nil value will
2627 be skipped. If it returns the empty string, the process ends and
2628 VALUE is ignored.
2630 Call is done in a LIFO fashion, to be sure that developer
2631 specified filters, if any, are called first."
2642 "Install filters properties in communication channel.
2643 INFO is a plist containing the current communication channel.
2644 Return the updated communication channel."
2646 ;; Install user-defined filters with `org-export-filters-alist'
2647 ;; and filters already in INFO (through ext-plist mechanism).
2654 ;; Filters in INFO will be called
2655 ;; before those user provided.
2658 default-value)))))
2659 org-export-filters-alist)
2660 ;; Prepend back-end specific filters to that list.
2662 ;; Single values get consed, lists are appended.
2667 plist key
2671 ;; Return new communication channel.
2675 \f
2676 ;;; Core functions
2677 ;;
2678 ;; This is the room for the main function, `org-export-as', along with
2679 ;; its derivative, `org-export-string-as'.
2680 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2681 ;; function should be added to kill ring.
2682 ;;
2683 ;; Note that `org-export-as' doesn't really parse the current buffer,
2684 ;; but a copy of it (with the same buffer-local variables and
2685 ;; visibility), where macros and include keywords are expanded and
2686 ;; Babel blocks are executed, if appropriate.
2687 ;; `org-export-with-buffer-copy' macro prepares that copy.
2688 ;;
2689 ;; File inclusion is taken care of by
2690 ;; `org-export-expand-include-keyword' and
2691 ;; `org-export--prepare-file-contents'. Structure wise, including
2692 ;; a whole Org file in a buffer often makes little sense. For
2693 ;; example, if the file contains a headline and the include keyword
2694 ;; was within an item, the item should contain the headline. That's
2695 ;; why file inclusion should be done before any structure can be
2696 ;; associated to the file, that is before parsing.
2697 ;;
2698 ;; `org-export-insert-default-template' is a command to insert
2699 ;; a default template (or a back-end specific template) at point or in
2700 ;; current subtree.
2703 "Return a copy of the current buffer.
2704 The copy preserves Org buffer-local variables, visibility and
2705 narrowing."
2711 new-buf))
2714 "Apply BODY in a copy of the current buffer.
2715 The copy preserves local variables, visibility and contents of
2716 the original buffer. Point is at the beginning of the buffer
2717 when BODY is applied."
2726 ;; Kill copy without confirmation.
2732 "Generate a function duplicating BUFFER.
2734 The copy will preserve local variables, visibility, contents and
2735 narrowing of the original buffer. If a region was active in
2736 BUFFER, contents will be narrowed to that region instead.
2738 The resulting function can be evaluated at a later time, from
2739 another buffer, effectively cloning the original buffer there.
2741 The function assumes BUFFER's major mode is `org-mode'."
2745 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2746 ;; already in BUFFER.
2748 ;; Copy specific buffer local variables and variables set
2749 ;; through BIND keywords.
2751 vars)
2759 buffer-file-name
2760 buffer-file-coding-system))
2764 ;; Skip unreadable values, as they cannot be
2765 ;; sent to external process.
2769 vars))))))
2770 ;; Whole buffer contents.
2775 ;; Narrowing.
2779 ;; Current position of point.
2781 ;; Overlays with invisible property.
2791 ov-set))))
2793 ov-set)))))
2795 ;;;###autoload
2798 "Transcode current Org buffer into BACKEND code.
2800 BACKEND is either an export back-end, as returned by, e.g.,
2801 `org-export-create-backend', or a symbol referring to
2802 a registered back-end.
2804 If narrowing is active in the current buffer, only transcode its
2805 narrowed part.
2807 If a region is active, transcode that region.
2809 When optional argument SUBTREEP is non-nil, transcode the
2810 sub-tree at point, extracting information from the headline
2811 properties first.
2813 When optional argument VISIBLE-ONLY is non-nil, don't export
2814 contents of hidden elements.
2816 When optional argument BODY-ONLY is non-nil, only return body
2817 code, without surrounding template.
2819 Optional argument EXT-PLIST, when provided, is a property list
2820 with external parameters overriding Org default settings, but
2821 still inferior to file-local settings.
2823 Return code as a string."
2828 ;; Narrow buffer to an appropriate region or subtree for
2829 ;; parsing. If parsing subtree, be sure to remove main headline
2830 ;; too.
2838 ;; Initialize communication channel with original buffer
2839 ;; attributes, unavailable in its copy.
2848 tree)
2849 ;; Update communication channel and get parse tree. Buffer
2850 ;; isn't parsed directly. Instead, a temporary copy is
2851 ;; created, where include keywords, macros are expanded and
2852 ;; code blocks are evaluated.
2854 ;; Run first hook with current back-end's name as argument.
2858 ;; Update macro templates since #+INCLUDE keywords might have
2859 ;; added some new ones.
2863 ;; Update radio targets since keyword inclusion might have
2864 ;; added some more.
2866 ;; Run last hook with current back-end's name as argument.
2871 ;; Update communication channel with environment. Also
2872 ;; install user's and developer's filters.
2877 ;; Call options filters and update export options. We do not
2878 ;; use `org-export-filter-apply-functions' here since the
2879 ;; arity of such filters is different.
2884 ;; Expand export-specific set of macros: {{{author}}},
2885 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2886 ;; be done once regular macros have been expanded, since
2887 ;; document keywords may contain one of them.
2899 value)
2900 value)))
2901 ;; EMAIL is not a parsed keyword: store it as-is.
2907 ;; Parse buffer.
2909 ;; Prune tree from non-exported elements and transform
2910 ;; uninterpreted elements or objects in both parse tree and
2911 ;; communication channel.
2914 ;; Parse buffer, handle uninterpreted elements or objects,
2915 ;; then call parse-tree filters.
2919 ;; Now tree is complete, compute its properties and add them
2920 ;; to communication channel.
2924 ;; Eventually transcode TREE. Wrap the resulting string into
2925 ;; a template.
2934 info))
2937 ;; Remove all text properties since they cannot be
2938 ;; retrieved from an external process. Finally call
2939 ;; final-output filter and return result.
2945 info))))))))
2947 ;;;###autoload
2949 "Transcode STRING into BACKEND code.
2951 BACKEND is either an export back-end, as returned by, e.g.,
2952 `org-export-create-backend', or a symbol referring to
2953 a registered back-end.
2955 When optional argument BODY-ONLY is non-nil, only return body
2956 code, without preamble nor postamble.
2958 Optional argument EXT-PLIST, when provided, is a property list
2959 with external parameters overriding Org default settings, but
2960 still inferior to file-local settings.
2962 Return code as a string."
2968 ;;;###autoload
2970 "Replace the active region by its export to BACKEND.
2971 BACKEND is either an export back-end, as returned by, e.g.,
2972 `org-export-create-backend', or a symbol referring to
2973 a registered back-end."
2983 ;;;###autoload
2985 "Insert all export keywords with default values at beginning of line.
2987 BACKEND is a symbol referring to the name of a registered export
2988 back-end, for which specific export options should be added to
2989 the template, or `default' for default template. When it is nil,
2990 the user will be prompted for a category.
2992 If SUBTREEP is non-nil, export configuration will be set up
2993 locally for the subtree through node properties."
3003 "Options category: "
3007 org-export--registered-backends))
3008 nil t))))
3009 options keywords)
3010 ;; Populate OPTIONS and KEYWORDS.
3027 ;; Move to an appropriate location in order to insert options.
3029 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3047 ;; Then the rest of keywords, in the order specified in either
3048 ;; `org-export-options-alist' or respective export back-ends.
3069 "Expand every include keyword in buffer.
3070 Optional argument INCLUDED is a list of included file names along
3071 with their line restriction, when appropriate. It is used to
3072 avoid infinite recursion. Optional argument DIR is the current
3073 working directory. It is used to properly resolve relative
3074 paths. Optional argument FOOTNOTES is a hash-table used for
3075 storing and resolving footnotes. It is created automatically."
3081 ;; If :minlevel is not set the text-property
3082 ;; `:org-include-induced-level' will be used to determine the
3083 ;; relative level when expanding INCLUDE.
3084 ;; Only affects included Org documents.
3088 :org-include-induced-level
3090 ;; Expand INCLUDE keywords.
3096 ;; Extract arguments from keyword's value.
3099 location
3111 matched)
3112 dir)))
3121 value)
3128 ;; Minimal level of included file defaults to the child
3129 ;; level of the current headline, if any, or one. It
3130 ;; only applies is the file is meant to be included as
3131 ;; an Org one.
3142 ;; Remove keyword.
3148 ;; Check if files has already been parsed. Look after
3149 ;; inclusion lines too, as different parts of the same file
3150 ;; can be included too.
3165 ind-str block arg-str contents ind-str block))))
3172 ind-str block contents ind-str block))))
3180 file location only-contents lines)
3181 lines)))
3184 file lines ind minlevel
3187 footnotes)))
3191 footnotes)
3193 ;; Expand footnotes after all files have been
3194 ;; included. Footnotes are stored at end of buffer.
3199 footnotes)))))))))))
3202 "Resolve absolute lines for an included file with file-link.
3204 FILE is string file-name of the file to include. LOCATION is a
3205 string name within FILE to be included (located via
3206 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3207 contents of the named element will be included, as determined
3208 Org-Element. If LINES is non-nil only those lines are included.
3210 Return a string of lines to be included in the format expected by
3211 `org-export--prepare-file-contents'."
3217 ;; Enforce consistent search.
3230 ;; Skip planning line and property-drawer.
3256 start-line
3258 (+ start-line
3261 counter))))))))
3264 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3266 REF-BEGIN corresponds to the property `:begin' of objects of type
3267 footnote-definition and footnote-reference.
3269 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3270 \[N] where N is one or more numbers.
3272 Return the new label."
3282 "Prepare contents of FILE for inclusion and return it as a string.
3284 When optional argument LINES is a string specifying a range of
3285 lines, include only those lines.
3287 Optional argument IND, when non-nil, is an integer specifying the
3288 global indentation of returned contents. Since its purpose is to
3289 allow an included file to stay in the same environment it was
3290 created \(i.e. a list item), it doesn't apply past the first
3291 headline encountered.
3293 Optional argument MINLEVEL, when non-nil, is an integer
3294 specifying the level that any top-level headline in the included
3295 file should have.
3296 Optional argument ID is an integer that will be inserted before
3297 each footnote definition and reference if FILE is an Org file.
3298 This is useful to avoid conflicts when more than one Org file
3299 with footnotes is included in a document.
3301 Optional argument FOOTNOTES is a hash-table to store footnotes in
3302 the included document.
3303 "
3319 ;; Remove blank lines at beginning and end of contents. The logic
3320 ;; behind that removal is that blank lines around include keyword
3321 ;; override blank lines in included file.
3330 ;; If IND is set, preserve indentation of include keyword until
3331 ;; the first headline encountered.
3338 ;; Do not move footnote definitions out of column 0.
3344 ;; When MINLEVEL is specified, compute minimal level for headlines
3345 ;; in the file (CUR-MIN), and remove stars to each headline so
3346 ;; that headlines with minimal level have a level of MINLEVEL.
3357 ;; Only change stars, don't bother moving whole
3358 ;; sections.
3362 ;; Append ID to all footnote references and definitions, so they
3363 ;; become file specific and cannot collide with footnotes in other
3364 ;; included files. Further, collect relevant footnotes outside of
3365 ;; LINES.
3375 ;; Update the footnote-reference at point and collect
3376 ;; the new label, which is only used for footnotes
3377 ;; outsides LINES.
3379 ;; If label is akin to [1] convert it to [fn:ID-1].
3380 ;; Otherwise add "ID-" after "fn:".
3390 ;; Store since footnote-definition is outside of LINES.
3393 footnotes)
3394 ;; Update label of definition since it is included directly.
3401 "Execute every Babel code in the visible part of current buffer."
3402 ;; Get a pristine copy of current buffer so Babel references can be
3403 ;; properly resolved.
3409 "Return a non-nil value when output should be added to the kill ring.
3410 See also `org-export-copy-to-kill-ring'."
3416 \f
3417 ;;; Tools For Back-Ends
3418 ;;
3419 ;; A whole set of tools is available to help build new exporters. Any
3420 ;; function general enough to have its use across many back-ends
3421 ;; should be added here.
3423 ;;;; For Affiliated Keywords
3424 ;;
3425 ;; `org-export-read-attribute' reads a property from a given element
3426 ;; as a plist. It can be used to normalize affiliated keywords'
3427 ;; syntax.
3428 ;;
3429 ;; Since captions can span over multiple lines and accept dual values,
3430 ;; their internal representation is a bit tricky. Therefore,
3431 ;; `org-export-get-caption' transparently returns a given element's
3432 ;; caption as a secondary string.
3435 "Turn ATTRIBUTE property from ELEMENT into a plist.
3437 When optional argument PROPERTY is non-nil, return the value of
3438 that property within attributes.
3442 properties.
3444 All values will become strings except the empty string and
3447 will become the empty string."
3461 s)
3466 ;; Ignore any string before first property with `cdr'.
3471 "Return caption from ELEMENT as a secondary string.
3473 When optional argument SHORTP is non-nil, return short caption,
3474 as a secondary string, instead.
3476 Caption lines are separated by a white space."
3484 ;;;; For Derived Back-ends
3485 ;;
3486 ;; `org-export-with-backend' is a function allowing to locally use
3487 ;; another back-end to transcode some object or element. In a derived
3488 ;; back-end, it may be used as a fall-back function once all specific
3489 ;; cases have been treated.
3492 "Call a transcoder from BACKEND on DATA.
3493 BACKEND is an export back-end, as returned by, e.g.,
3494 `org-export-create-backend', or a symbol referring to
3495 a registered back-end. DATA is an Org element, object, secondary
3496 string or string. CONTENTS, when non-nil, is the transcoded
3497 contents of DATA element, as a string. INFO, when non-nil, is
3498 the communication channel used for export, as a plist."
3508 transcoder data contents
3511 :translate-alist all-transcoders
3515 ;;;; For Export Snippets
3516 ;;
3517 ;; Every export snippet is transmitted to the back-end. Though, the
3518 ;; latter will only retain one type of export-snippet, ignoring
3519 ;; others, based on the former's target back-end. The function
3520 ;; `org-export-snippet-backend' returns that back-end for a given
3521 ;; export-snippet.
3524 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3525 Translation, with `org-export-snippet-translation-alist', is
3526 applied."
3530 back-end))))
3533 ;;;; For Footnotes
3534 ;;
3535 ;; `org-export-collect-footnote-definitions' is a tool to list
3536 ;; actually used footnotes definitions in the whole parse tree, or in
3537 ;; a headline, in order to add footnote listings throughout the
3538 ;; transcoded data.
3539 ;;
3540 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3541 ;; back-ends, when they need to attach the footnote definition only to
3542 ;; the first occurrence of the corresponding label.
3543 ;;
3544 ;; `org-export-get-footnote-definition' and
3545 ;; `org-export-get-footnote-number' provide easier access to
3546 ;; additional information relative to a footnote reference.
3549 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3550 INFO is the plist used as a communication channel. If no such
3551 definition can be found, raise an error."
3560 "Apply FUNCTION on every footnote reference in DATA.
3561 INFO is a plist containing export state. By default, as soon as
3562 a new footnote reference is encountered, FUNCTION is called onto
3563 its definition. However, if BODY-FIRST is non-nil, this step is
3564 delayed until the end of the process."
3570 ;; Search footnote references through DATA, filling
3571 ;; SEEN-REFS along the way. When DELAYP is non-nil, store
3572 ;; footnote definitions so they can be entered later.
3579 ;; Search for subsequent references in footnote
3580 ;; definition so numbering follows reading logic,
3581 ;; unless DELAYP in non-nil.
3585 definitions))
3586 ;; Do not force entering inline definitions,
3587 ;; since `org-element-map' already traverses them
3588 ;; at the right time.
3592 nil))))))
3593 info nil
3594 ;; Don't enter footnote definitions since it will happen
3595 ;; when their first reference is found. Moreover, if
3596 ;; DELAYP is non-nil, make sure we postpone entering
3597 ;; definitions of inline references.
3604 "Return an alist between footnote numbers, labels and definitions.
3606 INFO is the current export state, as a plist.
3608 Definitions are collected throughout the whole parse tree, or
3609 DATA when non-nil.
3611 Sorting is done by order of references. As soon as a new
3612 reference is encountered, other references are searched within
3613 its definition. However, if BODY-FIRST is non-nil, this step is
3614 delayed after the whole tree is checked. This alters results
3615 when references are found in footnote definitions.
3617 Definitions either appear as Org data or as a secondary string
3618 for inlined footnotes. Unreferenced definitions are ignored."
3622 ;; Collect footnote number, label and definition.
3633 "Non-nil when a footnote reference is the first one for its label.
3635 FOOTNOTE-REFERENCE is the footnote reference being considered.
3636 INFO is a plist containing current export state.
3638 Search is done throughout the whole parse tree, or DATA when
3639 non-nil.
3641 By default, as soon as a new footnote reference is encountered,
3642 other references are searched within its definition. However, if
3643 BODY-FIRST is non-nil, this step is delayed after the whole tree
3644 is checked. This alters results when references are found in
3645 footnote definitions."
3647 ;; Anonymous footnotes are always a first reference.
3658 "Return number associated to a footnote.
3660 FOOTNOTE is either a footnote reference or a footnote definition.
3661 INFO is the plist containing export state.
3663 Number is unique throughout the whole parse tree, or DATA, when
3664 non-nil.
3666 By default, as soon as a new footnote reference is encountered,
3667 counting process moves into its definition. However, if
3668 BODY-FIRST is non-nil, this step is delayed until the end of the
3669 process, leading to a different order when footnotes are nested."
3678 ;; Anonymous footnote match: return number.
3680 ;; Labels match: return number.
3682 ;; Otherwise store label and increase counter if label
3683 ;; wasn't encountered yet.
3689 ;;;; For Headlines
3690 ;;
3691 ;; `org-export-get-relative-level' is a shortcut to get headline
3692 ;; level, relatively to the lower headline level in the parsed tree.
3693 ;;
3694 ;; `org-export-get-headline-number' returns the section number of an
3695 ;; headline, while `org-export-number-to-roman' allows to convert it
3696 ;; to roman numbers. With an optional argument,
3697 ;; `org-export-get-headline-number' returns a number to unnumbered
3698 ;; headlines (used for internal id).
3699 ;;
3700 ;; `org-export-get-headline-id' returns the unique internal id of a
3701 ;; headline.
3702 ;;
3703 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3704 ;; `org-export-last-sibling-p' are three useful predicates when it
3705 ;; comes to fulfill the `:headline-levels' property.
3706 ;;
3707 ;; `org-export-get-tags', `org-export-get-category' and
3708 ;; `org-export-get-node-property' extract useful information from an
3709 ;; headline or a parent headline. They all handle inheritance.
3710 ;;
3711 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3712 ;; as a secondary string, suitable for table of contents. It falls
3713 ;; back onto default title.
3716 "Return HEADLINE relative level within current parsed tree.
3717 INFO is a plist holding contextual information."
3722 "Non-nil when HEADLINE is considered as low level.
3724 INFO is a plist used as a communication channel.
3726 A low level headlines has a relative level greater than
3727 `:headline-levels' property value.
3729 Return value is the difference between HEADLINE relative level
3730 and the last level being considered as high enough, or nil."
3737 "Return a unique ID for HEADLINE.
3738 INFO is a plist holding contextual information."
3748 "Return numbered HEADLINE numbering as a list of numbers.
3749 INFO is a plist holding contextual information."
3754 "Return a non-nil value if HEADLINE element should be numbered.
3755 INFO is a plist used as a communication channel."
3764 "Convert integer N into a roman numeral."
3777 res)))
3780 "Return list of tags associated to ELEMENT.
3782 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3783 is a plist used as a communication channel.
3785 Select tags (see `org-export-select-tags') and exclude tags (see
3786 `org-export-exclude-tags') are removed from the list.
3788 When non-nil, optional argument TAGS should be a list of strings.
3789 Any tag belonging to this list will also be removed.
3791 When optional argument INHERITED is non-nil, tags can also be
3792 inherited from parent headlines and FILETAGS keywords."
3798 ;; Build complete list of inherited tags.
3805 ;; Add FILETAGS keywords and return results.
3809 "Return node PROPERTY value for BLOB.
3811 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3812 element or object.
3814 If optional argument INHERITED is non-nil, the value can be
3815 inherited from a parent headline.
3817 Return value is a string or nil."
3829 "Return category for element or object BLOB.
3831 INFO is a plist used as a communication channel.
3833 CATEGORY is automatically inherited from a parent headline, from
3834 #+CATEGORY: keyword or created out of original file name. If all
3847 "Return alternative title for HEADLINE, as a secondary string.
3848 INFO is a plist used as a communication channel. If no optional
3849 title is defined, fall-back to the regular title."
3856 "Non-nil when BLOB is the first sibling in its parent.
3857 BLOB is an element or an object. If BLOB is a headline, non-nil
3858 means it is the first sibling in the sub-tree. INFO is a plist
3859 used as a communication channel."
3864 "Non-nil when BLOB is the last sibling in its parent.
3865 BLOB is an element or an object. INFO is a plist used as
3866 a communication channel."
3870 ;;;; For Keywords
3871 ;;
3872 ;; `org-export-get-date' returns a date appropriate for the document
3873 ;; to about to be exported. In particular, it takes care of
3874 ;; `org-export-date-timestamp-format'.
3877 "Return date value for the current document.
3879 INFO is a plist used as a communication channel. FMT, when
3880 non-nil, is a time format string that will be applied on the date
3881 if it consists in a single timestamp object. It defaults to
3882 `org-export-date-timestamp-format' when nil.
3884 A proper date can be a secondary string, a string or nil. It is
3885 meant to be translated with `org-export-data' or alike."
3896 ;;;; For Links
3897 ;;
3898 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3899 ;; with `org-add-link-type', which see.
3900 ;;
3901 ;; `org-export-solidify-link-text' turns a string into a safer version
3902 ;; for links, replacing most non-standard characters with hyphens.
3903 ;;
3904 ;; `org-export-get-coderef-format' returns an appropriate format
3905 ;; string for coderefs.
3906 ;;
3907 ;; `org-export-inline-image-p' returns a non-nil value when the link
3908 ;; provided should be considered as an inline image.
3909 ;;
3910 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3911 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3912 ;; returns an appropriate unique identifier when found, or nil.
3913 ;;
3914 ;; `org-export-resolve-id-link' returns the first headline with
3915 ;; specified id or custom-id in parse tree, the path to the external
3916 ;; file with the id or nil when neither was found.
3917 ;;
3918 ;; `org-export-resolve-coderef' associates a reference to a line
3919 ;; number in the element it belongs, or returns the reference itself
3920 ;; when the element isn't numbered.
3923 "Take link text S and make a safe target out of it."
3928 "Try exporting LINK with a dedicated function.
3930 DESC is its description, as a string, or nil. BACKEND is the
3931 back-end used for export, as a symbol.
3933 Return output as a string, or nil if no protocol handles LINK.
3935 A custom protocol has precedence over regular back-end export.
3936 The function ignores links with an implicit type (e.g.,
3945 desc
3946 backend))))))
3949 "Return format string for code reference link.
3950 PATH is the link path. DESC is its description."
3958 "Non-nil if LINK object points to an inline image.
3960 Optional argument is a set of RULES defining inline images. It
3961 is an alist where associations have the following shape:
3963 \(TYPE . REGEXP)
3965 Applying a rule means apply REGEXP against LINK's path when its
3966 type is TYPE. The function will return a non-nil value if any of
3967 the provided rules is non-nil. The default rule is
3968 `org-export-default-inline-image-rule'.
3970 This only applies to links without a description."
3981 "Resolve a code reference REF.
3983 INFO is a plist used as a communication channel.
3985 Return associated line number in source code, or REF itself,
3986 depending on src-block or example element's switches."
3993 org-coderef-label-format)))
3997 ;; Element containing REF is found. Resolve it to either
3998 ;; a label or a line number, as needed.
4008 "Return LINK destination.
4010 INFO is a plist holding contextual information.
4012 Return value can be an object, an element, or nil:
4014 - If LINK path matches a target object (i.e. <<path>>) return it.
4016 - If LINK path exactly matches the name affiliated keyword
4017 \(i.e. #+NAME: path) of an element, return that element.
4019 - If LINK path exactly matches any headline name, return that
4020 element. If more than one headline share that name, priority
4021 will be given to the one with the closest common ancestor, if
4022 any, or the first one in the parse tree otherwise.
4024 - Otherwise, return nil.
4027 significant."
4030 ;; Split PATH at white spaces so matches are space
4031 ;; insensitive.
4034 ;; Cache for destinations that are not position dependent.
4042 ;; Destination is not position dependent: use cached value.
4044 ;; First try to find a matching "<<path>>" unless user specified
4045 ;; he was looking for a headline (path starts with a "*"
4046 ;; character).
4052 path)
4053 blob))
4056 ;; Then try to find an element with a matching "#+NAME: path"
4057 ;; affiliated keyword.
4060 org-element-all-elements
4065 el)))
4068 ;; Last case: link either points to a headline or to nothingness.
4069 ;; Try to find the source, with priority given to headlines with
4070 ;; the closest common ancestor. If such candidate is found,
4071 ;; return it, otherwise return nil.
4075 ;; Return first headline whose `:raw-value' property is
4076 ;; NAME in parse tree DATA, or nil. Statistics cookies
4077 ;; are ignored.
4085 name)
4086 headline))
4088 ;; Search among headlines sharing an ancestor with link, from
4089 ;; closest to farthest.
4097 ;; No destination found: return nil.
4101 "Return headline referenced as LINK destination.
4103 INFO is a plist used as a communication channel.
4105 Return value can be the headline element matched in current parse
4109 ;; First check if id is within the current parse tree.
4114 headline))
4116 ;; Otherwise, look for external files.
4120 "Return radio-target object referenced as LINK destination.
4122 INFO is a plist used as a communication channel.
4124 Return value can be a radio-target object or nil. Assume LINK
4133 nil nil path nil nil t)
4134 t)
4135 radio))
4139 ;;;; For References
4140 ;;
4141 ;; `org-export-get-ordinal' associates a sequence number to any object
4142 ;; or element.
4145 "Return ordinal number of an element or object.
4147 ELEMENT is the element or object considered. INFO is the plist
4148 used as a communication channel.
4150 Optional argument TYPES, when non-nil, is a list of element or
4151 object types, as symbols, that should also be counted in.
4152 Otherwise, only provided element's type is considered.
4154 Optional argument PREDICATE is a function returning a non-nil
4155 value if the current element or object should be counted in. It
4156 accepts two arguments: the element or object being considered and
4157 the plist used as a communication channel. This allows to count
4158 only a certain type of objects (i.e. inline images).
4160 Return value is a list of numbers if ELEMENT is a headline or an
4161 item. It is nil for keywords. It represents the footnote number
4162 for footnote definitions and footnote references. If ELEMENT is
4163 a target, return the same value as if ELEMENT was the closest
4164 table, item or headline containing the target. In any other
4165 case, return the sequence number of ELEMENT among elements or
4166 objects of the same type."
4167 ;; Ordinal of a target object refer to the ordinal of the closest
4168 ;; table, item, or headline containing the object.
4172 element
4175 ;; Special case 1: A headline returns its number as a list.
4177 ;; Special case 2: An item returns its number as a list.
4181 struct
4188 ;; Increment counter until ELEMENT is found again.
4199 ;;;; For Src-Blocks
4200 ;;
4201 ;; `org-export-get-loc' counts number of code lines accumulated in
4202 ;; src-block or example-block elements with a "+n" switch until
4203 ;; a given element, excluded. Note: "-n" switches reset that count.
4204 ;;
4205 ;; `org-export-unravel-code' extracts source code (along with a code
4206 ;; references alist) from an `element-block' or `src-block' type
4207 ;; element.
4208 ;;
4209 ;; `org-export-format-code' applies a formatting function to each line
4210 ;; of code, providing relative line number and code reference when
4211 ;; appropriate. Since it doesn't access the original element from
4212 ;; which the source code is coming, it expects from the code calling
4213 ;; it to know if lines should be numbered and if code references
4214 ;; should appear.
4215 ;;
4216 ;; Eventually, `org-export-format-code-default' is a higher-level
4217 ;; function (it makes use of the two previous functions) which handles
4218 ;; line numbering and code references inclusion, and returns source
4219 ;; code in a format suitable for plain text or verbatim output.
4222 "Return accumulated lines of code up to ELEMENT.
4224 INFO is the plist used as a communication channel.
4226 ELEMENT is excluded from count."
4232 ;; ELEMENT is reached: Quit the loop.
4234 ;; Only count lines from src-block and example-block elements
4235 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4239 ;; Accumulate locs or reset them.
4243 ;; Return nil to stay in the loop.
4244 nil)))
4246 ;; Return value.
4247 loc))
4250 "Clean source code and extract references out of it.
4252 ELEMENT has either a `src-block' an `example-block' type.
4254 Return a cons cell whose CAR is the source code, cleaned from any
4255 reference, protective commas and spurious indentation, and CDR is
4256 an alist between relative line number (integer) and name of code
4257 reference on that line (string)."
4260 ;; Get code and clean it. Remove blank lines at its
4261 ;; beginning and end.
4268 value
4270 ;; Get format used for references.
4273 org-coderef-label-format)))
4274 ;; Build a regexp matching a loc with a reference.
4279 ;; Return value.
4281 ;; Code with references removed.
4287 ;; Ref line: remove ref, and signal its position in REFS.
4291 ;; Reference alist.
4292 refs)))
4295 "Format CODE by applying FUN line-wise and return it.
4297 CODE is a string representing the code to format. FUN is
4298 a function. It must accept three arguments: a line of
4299 code (string), the current line number (integer) or nil and the
4300 reference associated to the current line (string) or nil.
4302 Optional argument NUM-LINES can be an integer representing the
4303 number of code lines accumulated until the current code. Line
4304 numbers passed to FUN will take it into account. If it is nil,
4305 FUN's second argument will always be nil. This number can be
4306 obtained with `org-export-get-loc' function.
4308 Optional argument REF-ALIST can be an alist between relative line
4309 number (i.e. ignoring NUM-LINES) and the name of the code
4310 reference on it. If it is nil, FUN's third argument will always
4311 be nil. It can be obtained through the use of
4312 `org-export-unravel-code' function."
4324 "Return source code from ELEMENT, formatted in a standard way.
4326 ELEMENT is either a `src-block' or `example-block' element. INFO
4327 is a plist used as a communication channel.
4329 This function takes care of line numbering and code references
4330 inclusion. Line numbers, when applicable, appear at the
4331 beginning of the line, separated from the code by two white
4332 spaces. Code references, on the other hand, appear flushed to
4333 the right, separated by six white spaces from the widest line of
4334 code."
4335 ;; Extract code and references.
4342 ;; Handle line numbering.
4351 ;; Prepare references display, if required. Any reference
4352 ;; should start six columns after the widest line of code,
4353 ;; wrapped with parenthesis.
4358 code
4362 number-str
4363 loc
4369 num-start refs)))))
4372 ;;;; For Tables
4373 ;;
4374 ;; `org-export-table-has-special-column-p' and and
4375 ;; `org-export-table-row-is-special-p' are predicates used to look for
4376 ;; meta-information about the table structure.
4377 ;;
4378 ;; `org-table-has-header-p' tells when the rows before the first rule
4379 ;; should be considered as table's header.
4380 ;;
4381 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4382 ;; and `org-export-table-cell-borders' extract information from
4383 ;; a table-cell element.
4384 ;;
4385 ;; `org-export-table-dimensions' gives the number on rows and columns
4386 ;; in the table, ignoring horizontal rules and special columns.
4387 ;; `org-export-table-cell-address', given a table-cell object, returns
4388 ;; the absolute address of a cell. On the other hand,
4389 ;; `org-export-get-table-cell-at' does the contrary.
4390 ;;
4391 ;; `org-export-table-cell-starts-colgroup-p',
4392 ;; `org-export-table-cell-ends-colgroup-p',
4393 ;; `org-export-table-row-starts-rowgroup-p',
4394 ;; `org-export-table-row-ends-rowgroup-p',
4395 ;; `org-export-table-row-starts-header-p',
4396 ;; `org-export-table-row-ends-header-p' and
4397 ;; `org-export-table-row-in-header-p' indicate position of current row
4398 ;; or cell within the table.
4401 "Non-nil when TABLE has a special column.
4402 All special columns will be ignored during export."
4403 ;; The table has a special column when every first cell of every row
4404 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4405 ;; "*" "_" and "^". Though, do not consider a first row containing
4406 ;; only empty cells as special.
4422 "Non-nil when TABLE has a header.
4424 INFO is a plist used as a communication channel.
4426 A table has a header when it contains at least two row groups."
4435 table
4446 cache)))))
4449 "Non-nil if TABLE-ROW is considered special.
4451 INFO is a plist used as the communication channel.
4453 All special rows will be ignored during export."
4457 ;; A row is special either when...
4459 ;; ... it starts with a field only containing "/",
4461 ;; ... the table contains a special column and the row start
4462 ;; with a marking character among, "^", "_", "$" or "!",
4466 ;; ... it contains only alignment cookies and empty cells.
4472 ;; Since VALUE is a secondary string, the following
4473 ;; checks avoid expanding it with `org-export-data'.
4485 "Return TABLE-ROW's group number, as an integer.
4487 INFO is a plist used as the communication channel.
4489 Return value is the group number, as an integer, or nil for
4490 special rows and rows separators. First group is also table's
4491 header."
4509 "Return TABLE-CELL contents width.
4511 INFO is a plist used as the communication channel.
4513 Return value is the width given by the last width cookie in the
4514 same column as TABLE-CELL, or nil."
4533 ;; In a special row, try to find a width cookie at COLUMN.
4537 ;; The following checks avoid expanding unnecessarily
4538 ;; the cell with `org-export-data'.
4548 "Return TABLE-CELL contents alignment.
4550 INFO is a plist used as the communication channel.
4552 Return alignment as specified by the last alignment cookie in the
4553 same column as TABLE-CELL. If no such cookie is found, a default
4554 alignment value will be deduced from fraction of numbers in the
4555 column (see `org-table-number-fraction' for more information).
4556 Possible values are `left', `right' and `center'."
4557 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4574 cookie-align
4575 previous-cell-number-p)
4578 ;; In a special row, try to find an alignment cookie at
4579 ;; COLUMN.
4583 ;; Since VALUE is a secondary string, the following
4584 ;; checks avoid useless expansion through
4585 ;; `org-export-data'.
4593 ;; Ignore table rules.
4595 ;; In a standard row, check if cell's contents are
4596 ;; expressing some kind of number. Increase NUMBER-CELLS
4597 ;; accordingly. Though, don't bother if an alignment
4598 ;; cookie has already defined cell's alignment.
4603 info)))
4605 ;; Treat an empty cell as a number if it follows
4606 ;; a number.
4612 ;; Return value. Alignment specified by cookies has
4613 ;; precedence over alignment deduced from cell's contents.
4615 column
4620 org-table-number-fraction)
4625 "Return TABLE-CELL borders.
4627 INFO is a plist used as a communication channel.
4629 Return value is a list of symbols, or nil. Possible values are:
4630 `top', `bottom', `above', `below', `left' and `right'. Note:
4631 `top' (resp. `bottom') only happen for a cell in the first
4632 row (resp. last row) of the table, ignoring table rules, if any.
4634 Returned borders ignore special rows."
4637 borders)
4638 ;; Top/above border? TABLE-CELL has a border above when a rule
4639 ;; used to demarcate row groups can be found above. Hence,
4640 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4641 ;; another regular row has to be found above that rule.
4650 ;; Look at every row before the current one.
4652 ;; No rule above, or rule found starts the table (ignoring any
4653 ;; special row): TABLE-CELL is at the top of the table.
4656 ;; Bottom/below border? TABLE-CELL has a border below when next
4657 ;; non-regular row below is a rule.
4666 ;; Look at every row after the current one.
4668 ;; No rule below, or rule found ends the table (modulo some
4669 ;; special row): TABLE-CELL is at the bottom of the table.
4672 ;; Right/left borders? They can only be specified by column
4673 ;; groups. Column groups are defined in a row starting with "/".
4674 ;; Also a column groups row only contains "<", "<>", ">" or blank
4675 ;; cells.
4692 ;; There's a left border when previous cell, if
4693 ;; any, ends a group, or current one starts one.
4699 ;; There's a right border when next cell, if any,
4700 ;; starts a group, or current one ends one.
4707 ;; Table rows are read in reverse order so last column groups
4708 ;; row has precedence over any previous one.
4710 ;; Return value.
4711 borders))
4714 "Non-nil when TABLE-CELL is at the beginning of a column group.
4715 INFO is a plist used as a communication channel."
4716 ;; A cell starts a column group either when it is at the beginning
4717 ;; of a row (or after the special column, if any) or when it has
4718 ;; a left border.
4721 table-cell)
4725 "Non-nil when TABLE-CELL is at the end of a column group.
4726 INFO is a plist used as a communication channel."
4727 ;; A cell ends a column group either when it is at the end of a row
4728 ;; or when it has a right border.
4731 table-cell)
4735 "Non-nil when TABLE-ROW is at the beginning of a row group.
4736 INFO is a plist used as a communication channel."
4744 "Non-nil when TABLE-ROW is at the end of a row group.
4745 INFO is a plist used as a communication channel."
4753 "Non-nil when TABLE-ROW is located within table's header.
4754 INFO is a plist used as a communication channel. Always return
4755 nil for special rows and rows separators."
4761 "Non-nil when TABLE-ROW is the first table header's row.
4762 INFO is a plist used as a communication channel."
4767 "Non-nil when TABLE-ROW is the last table header's row.
4768 INFO is a plist used as a communication channel."
4773 "Return TABLE-ROW number.
4774 INFO is a plist used as a communication channel. Return value is
4775 zero-based and ignores separators. The function returns nil for
4776 special columns and separators."
4788 "Return TABLE dimensions.
4790 INFO is a plist used as a communication channel.
4792 Return value is a CONS like (ROWS . COLUMNS) where
4793 ROWS (resp. COLUMNS) is the number of exportable
4794 rows (resp. columns)."
4796 ;; Set number of rows, and extract first one.
4802 ;; Set number of columns.
4804 ;; Return value.
4808 "Return address of a regular TABLE-CELL object.
4810 TABLE-CELL is the cell considered. INFO is a plist used as
4811 a communication channel.
4813 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4814 zero-based index. Only exportable cells are considered. The
4815 function returns nil for other cells."
4827 "Return regular table-cell object at ADDRESS in TABLE.
4829 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4830 zero-based index. TABLE is a table type element. INFO is
4831 a plist used as a communication channel.
4833 If no table-cell, among exportable cells, is found at ADDRESS,
4834 return nil."
4837 ;; Row at (car address) or nil.
4845 'table-cell
4852 ;;;; For Tables Of Contents
4853 ;;
4854 ;; `org-export-collect-headlines' builds a list of all exportable
4855 ;; headline elements, maybe limited to a certain depth. One can then
4856 ;; easily parse it and transcode it.
4857 ;;
4858 ;; Building lists of tables, figures or listings is quite similar.
4859 ;; Once the generic function `org-export-collect-elements' is defined,
4860 ;; `org-export-collect-tables', `org-export-collect-figures' and
4861 ;; `org-export-collect-listings' can be derived from it.
4864 "Collect headlines in order to build a table of contents.
4866 INFO is a plist used as a communication channel.
4868 When optional argument N is an integer, it specifies the depth of
4869 the table of contents. Otherwise, it is set to the value of the
4870 last headline level. See `org-export-headline-levels' for more
4871 information.
4873 Optional argument SCOPE, when non-nil, is an element. If it is
4874 a headline, only children of SCOPE are collected. Otherwise,
4875 collect children of the headline containing provided element. If
4876 there is no such headline, collect all headlines. In any case,
4877 argument N becomes relative to the level of that headline.
4879 Return a list of all exportable headlines as parsed elements.
4880 Footnote sections are ignored."
4889 limit))))
4895 info)))
4898 "Collect referenceable elements of a determined type.
4900 TYPE can be a symbol or a list of symbols specifying element
4901 types to search. Only elements with a caption are collected.
4903 INFO is a plist used as a communication channel.
4905 When non-nil, optional argument PREDICATE is a function accepting
4906 one argument, an element of type TYPE. It returns a non-nil
4907 value when that element should be collected.
4909 Return a list of all elements found, in order of appearance."
4914 element))
4915 info))
4918 "Build a list of tables.
4919 INFO is a plist used as a communication channel.
4921 Return a list of table elements with a caption."
4925 "Build a list of figures.
4927 INFO is a plist used as a communication channel. PREDICATE is
4928 a function which accepts one argument: a paragraph element and
4929 whose return value is non-nil when that element should be
4930 collected.
4932 A figure is a paragraph type element, with a caption, verifying
4934 a vague concept that may depend on back-end.
4936 Return a list of elements recognized as figures."
4940 "Build a list of src blocks.
4942 INFO is a plist used as a communication channel.
4944 Return a list of src-block elements with a caption."
4948 ;;;; Smart Quotes
4949 ;;
4950 ;; The main function for the smart quotes sub-system is
4951 ;; `org-export-activate-smart-quotes', which replaces every quote in
4952 ;; a given string from the parse tree with its "smart" counterpart.
4953 ;;
4954 ;; Dictionary for smart quotes is stored in
4955 ;; `org-export-smart-quotes-alist'.
4956 ;;
4957 ;; Internally, regexps matching potential smart quotes (checks at
4958 ;; string boundaries are also necessary) are defined in
4959 ;; `org-export-smart-quotes-regexps'.
4963 ;; one may use: »...«, "...", ›...‹, or '...'.
4964 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4965 ;; LaTeX quotes require Babel!
5010 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5019 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5028 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5037 ;; http://ru.wikipedia.org/wiki/%D0%9A%D0%B0%D0%B2%D1%8B%D1%87%D0%BA%D0%B8#.D0.9A.D0.B0.D0.B2.D1.8B.D1.87.D0.BA.D0.B8.2C_.D0.B8.D1.81.D0.BF.D0.BE.D0.BB.D1.8C.D0.B7.D1.83.D0.B5.D0.BC.D1.8B.D0.B5_.D0.B2_.D1.80.D1.83.D1.81.D1.81.D0.BA.D0.BE.D0.BC_.D1.8F.D0.B7.D1.8B.D0.BA.D0.B5
5038 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5049 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5055 )
5056 "Smart quotes translations.
5058 Alist whose CAR is a language string and CDR is an alist with
5059 quote type as key and a plist associating various encodings to
5060 their translation as value.
5062 A quote type can be any symbol among `opening-double-quote',
5063 `closing-double-quote', `opening-single-quote',
5064 `closing-single-quote' and `apostrophe'.
5066 Valid encodings include `:utf-8', `:html', `:latex' and
5067 `:texinfo'.
5073 ;; Possible opening quote at beginning of string.
5075 ;; Possible closing quote at beginning of string.
5077 ;; Possible apostrophe at beginning of string.
5079 ;; Opening single and double quotes.
5081 ;; Closing single and double quotes.
5083 ;; Apostrophe.
5085 ;; Possible opening quote at end of string.
5087 ;; Possible closing quote at end of string.
5089 ;; Possible apostrophe at end of string.
5091 "List of regexps matching a quote or an apostrophe.
5097 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5098 `:utf-8'. INFO is a plist used as a communication channel.
5100 The function has to retrieve information about string
5101 surroundings in parse tree. It can only happen with an
5102 unmodified string. Thus, if S has already been through another
5103 process, a non-nil ORIGINAL optional argument will provide that
5104 original string.
5106 Return the new string."
5109 ;; Try to be flexible when computing number of blanks
5110 ;; before object. The previous object may be a string
5111 ;; introduced by the back-end and not completely parsed.
5114 ;; A string with missing `:post-blank'
5115 ;; property.
5119 ;; Fallback value.
5124 ;; Return smart quote associated to a give quote Q, as
5125 ;; a string. TYPE is a symbol among `open', `close' and
5126 ;; `apostrophe'.
5136 org-export-smart-quotes-alist))))
5137 encoding)
5138 q)))))
5140 ;; Only a quote: no regexp can match. We have to check both
5141 ;; sides and decide what to do.
5149 ;; 1. Replace quote character at the beginning of S.
5151 ;; Apostrophe?
5157 ;; Closing quote?
5163 ;; Opening quote?
5169 ;; 2. Replace quotes in the middle of the string.
5171 ;; Opening quotes.
5177 ;; Closing quotes.
5183 ;; Apostrophes.
5188 ;; 3. Replace quote character at the end of S.
5190 ;; Apostrophe?
5195 ;; Closing quote?
5201 ;; Opening quote?
5206 ;; Return string with smart quotes.
5207 s))))
5209 ;;;; Topology
5210 ;;
5211 ;; Here are various functions to retrieve information about the
5212 ;; neighborhood of a given element or object. Neighbors of interest
5213 ;; are direct parent (`org-export-get-parent'), parent headline
5214 ;; (`org-export-get-parent-headline'), first element containing an
5215 ;; object, (`org-export-get-parent-element'), parent table
5216 ;; (`org-export-get-parent-table'), previous element or object
5217 ;; (`org-export-get-previous-element') and next element or object
5218 ;; (`org-export-get-next-element').
5220 ;; defsubst org-export-get-parent must be defined before first use
5226 "Return BLOB parent headline or nil.
5227 BLOB is the element or object being considered."
5231 "Return first element containing OBJECT or nil.
5232 OBJECT is the object to consider."
5236 "Return OBJECT parent table or nil.
5237 OBJECT is either a `table-cell' or `table-element' type object."
5241 "Return previous element or object.
5243 BLOB is an element or object. INFO is a plist used as
5244 a communication channel. Return previous exportable element or
5245 object, a string, or nil.
5247 When optional argument N is a positive integer, return a list
5248 containing up to N siblings before BLOB, from farthest to
5249 closest. With any other non-nil value, return a list containing
5250 all of them."
5256 prev)
5266 "Return next element or object.
5268 BLOB is an element or object. INFO is a plist used as
5269 a communication channel. Return next exportable element or
5270 object, a string, or nil.
5272 When optional argument N is a positive integer, return a list
5273 containing up to N siblings after BLOB, from closest to farthest.
5274 With any other non-nil value, return a list containing all of
5275 them."
5282 next)
5292 ;;;; Translation
5293 ;;
5294 ;; `org-export-translate' translates a string according to the language
5295 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5296 ;; the dictionary used for the translation.
5344 ("ru" :html "(Продолжение следует)"
5447 ("ru" :html "Список распечаток"
5461 ("ru" :html "Список таблиц"
5553 ("ru" :html "Неизвестная ссылка"
5556 "Dictionary for export engine.
5558 Alist whose car is the string to translate and cdr is an alist
5559 whose car is the language string and cdr is a plist whose
5560 properties are possible charsets and values translated terms.
5562 It is used as a database for `org-export-translate'. Since this
5563 function returns the string as-is if no translation was found,
5564 the variable only needs to record values different from the
5568 "Translate string S according to language specification.
5570 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5571 and `:utf-8'. INFO is a plist used as a communication channel.
5573 Translation depends on `:language' property. Return the
5574 translated string. If no translation is found, try to fall back
5575 to `:default' encoding. If it fails, return S."
5581 s)))
5584 \f
5585 ;;; Asynchronous Export
5586 ;;
5587 ;; `org-export-async-start' is the entry point for asynchronous
5588 ;; export. It recreates current buffer (including visibility,
5589 ;; narrowing and visited file) in an external Emacs process, and
5590 ;; evaluates a command there. It then applies a function on the
5591 ;; returned results in the current process.
5592 ;;
5593 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5594 ;; allow to export to a buffer or a file, asynchronously or not.
5595 ;;
5596 ;; `org-export-output-file-name' is an auxiliary function meant to be
5597 ;; used with `org-export-to-file'. With a given extension, it tries
5598 ;; to provide a canonical file name to write export output to.
5599 ;;
5600 ;; Asynchronously generated results are never displayed directly.
5601 ;; Instead, they are stored in `org-export-stack-contents'. They can
5602 ;; then be retrieved by calling `org-export-stack'.
5603 ;;
5604 ;; Export Stack is viewed through a dedicated major mode
5605 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5606 ;;`org-export-stack-delete', `org-export-stack-view' and
5607 ;;`org-export-stack-clear'.
5608 ;;
5609 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5610 ;; It should be used whenever `org-export-async-start' is called.
5613 "Call function FUN on the results returned by BODY evaluation.
5615 FUN is an anonymous function of one argument. BODY evaluation
5616 happens in an asynchronous process, from a buffer which is an
5617 exact copy of the current one.
5619 Use `org-export-add-to-stack' in FUN in order to register results
5620 in the stack.
5622 This is a low level function. See also `org-export-to-buffer'
5623 and `org-export-to-file' for more specialized functions."
5626 ;; Write the full sexp evaluating BODY in a copy of the current
5627 ;; buffer to a temporary file, as it may be too long for program
5628 ;; args in `start-process'.
5635 ;; Null characters (from variable values) are inserted
5636 ;; within the file. As a consequence, coding system for
5637 ;; buffer contents will not be recognized properly. So,
5638 ;; we make sure it is the same as the one used to display
5639 ;; the original buffer.
5641 ,coding
5644 ;; Ignore `kill-emacs-hook' and code evaluation
5645 ;; queries from Babel as we need a truly
5646 ;; non-interactive process.
5648 org-babel-confirm-evaluate-answer-no t)
5649 ;; Initialize export framework.
5651 ;; Re-create current buffer there.
5654 ;; Sexp to evaluate in the buffer.
5656 ;; Start external process.
5659 (,process
5661 #'start-process
5664 ,proc-buffer
5671 ;; Register running process in stack.
5673 ;; Set-up sentinel in order to catch results.
5676 ,process
5698 ;;;###autoload
5701 &optional async subtreep visible-only body-only ext-plist
5702 post-process)
5703 "Call `org-export-as' with output to a specified buffer.
5705 BACKEND is either an export back-end, as returned by, e.g.,
5706 `org-export-create-backend', or a symbol referring to
5707 a registered back-end.
5709 BUFFER is the name of the output buffer. If it already exists,
5710 it will be erased first, otherwise, it will be created.
5712 A non-nil optional argument ASYNC means the process should happen
5713 asynchronously. The resulting buffer should then be accessible
5714 through the `org-export-stack' interface. When ASYNC is nil, the
5715 buffer is displayed if `org-export-show-temporary-export-buffer'
5716 is non-nil.
5718 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5719 EXT-PLIST are similar to those used in `org-export-as', which
5720 see.
5722 Optional argument POST-PROCESS is a function which should accept
5723 no argument. It is always called within the current process,
5724 from BUFFER, with point at its beginning. Export back-ends can
5725 use it to set a major mode there, e.g,
5727 \(defun org-latex-export-as-latex
5728 \(&optional async subtreep visible-only body-only ext-plist)
5729 \(interactive)
5731 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5733 This function returns BUFFER."
5761 buffer)))
5763 ;;;###autoload
5766 post-process)
5767 "Call `org-export-as' with output to a specified file.
5769 BACKEND is either an export back-end, as returned by, e.g.,
5770 `org-export-create-backend', or a symbol referring to
5771 a registered back-end. FILE is the name of the output file, as
5772 a string.
5774 A non-nil optional argument ASYNC means the process should happen
5775 asynchronously. The resulting buffer will then be accessible
5776 through the `org-export-stack' interface.
5778 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5779 EXT-PLIST are similar to those used in `org-export-as', which
5780 see.
5782 Optional argument POST-PROCESS is called with FILE as its
5783 argument and happens asynchronously when ASYNC is non-nil. It
5784 has to return a file name, or nil. Export back-ends can use this
5785 to send the output file through additional processing, e.g,
5787 \(defun org-latex-export-to-latex
5788 \(&optional async subtreep visible-only body-only ext-plist)
5789 \(interactive)
5791 \(org-export-to-file 'latex outfile
5792 async subtreep visible-only body-only ext-plist
5793 \(lambda (file) (org-latex-compile file)))
5795 The function returns either a file name returned by POST-PROCESS,
5796 or FILE."
5815 backend subtreep visible-only body-only ext-plist)))
5822 ;; Get proper return value.
5824 file))))))
5827 "Return output file's name according to buffer specifications.
5829 EXTENSION is a string representing the output file extension,
5830 with the leading dot.
5832 With a non-nil optional argument SUBTREEP, try to determine
5834 of subtree at point.
5836 When optional argument PUB-DIR is set, use it as the publishing
5837 directory.
5839 When optional argument VISIBLE-ONLY is non-nil, don't export
5840 contents of hidden elements.
5842 Return file name as a string."
5845 ;; File name may come from EXPORT_FILE_NAME subtree
5846 ;; property, assuming point is at beginning of said
5847 ;; sub-tree.
5854 ;; File name may be extracted from buffer's associated
5855 ;; file, if any.
5857 ;; Can't determine file name on our own: Ask user.
5861 "Output file: " pub-dir nil nil nil
5865 ;; Build file name. Enforce EXTENSION over whatever user
5866 ;; may have come up with. PUB-DIR, if defined, always has
5867 ;; precedence over any provided path.
5872 extension))
5875 ;; If writing to OUTPUT-FILE would overwrite original file, append
5876 ;; EXTENSION another time to final name.
5879 output-file)))
5882 "Add a new result to export stack if not present already.
5884 SOURCE is a buffer or a file name containing export results.
5885 BACKEND is a symbol representing export back-end used to generate
5886 it.
5888 Entries already pointing to SOURCE and unavailable entries are
5889 removed beforehand. Return the new stack."
5895 "Menu for asynchronous export results and running processes."
5905 "Return source from export results at point in stack."
5912 source
5913 ;; SOURCE is not consistent with current line. The stack
5914 ;; view is outdated.
5918 "Remove all entries from export stack."
5923 "Refresh the asynchronous export stack.
5924 DUMMY is ignored. Unavailable sources are removed from the list.
5925 Return the new stack."
5935 ;; Back-end.
5937 ;; Age.
5940 ;; Compute age of the results.
5942 "%4h:%.2m "
5944 ;; Source.
5949 ;; Clear stack from exited processes, dead buffers or
5950 ;; non-existent files.
5962 "Remove export results at point from stack.
5963 If optional argument SOURCE is non-nil, remove it instead."
5968 org-export-stack-contents))))
5971 "View export results at point in stack.
5972 With an optional prefix argument IN-EMACS, force viewing files
5973 within Emacs."
5987 (define-key km "p" 'previous-line)
5988 (define-key km "\C-p" 'previous-line)
5989 (define-key km "\C-?" 'previous-line)
5990 (define-key km [up] 'previous-line)
5991 (define-key km "C" 'org-export-stack-clear)
5992 (define-key km "v" 'org-export-stack-view)
5993 (define-key km (kbd "RET") 'org-export-stack-view)
5994 (define-key km "d" 'org-export-stack-remove)
5995 km)
5996 "Keymap for Org Export Stack.")
5998 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5999 "Mode for displaying asynchronous export stack.
6002 stack.
6004 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6005 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6006 stack completely.
6008 Removing entries in an Org Export Stack buffer doesn't affect
6009 files or buffers, only the display.
6012 (abbrev-mode 0)
6013 (auto-fill-mode 0)
6014 (setq buffer-read-only t
6015 buffer-undo-list t
6016 truncate-lines t
6017 header-line-format
6018 '(:eval
6019 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6020 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6021 (set (make-local-variable 'revert-buffer-function)
6022 'org-export-stack-refresh))
6025 \f
6026 ;;; The Dispatcher
6027 ;;
6028 ;; `org-export-dispatch' is the standard interactive way to start an
6029 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6030 ;; for its interface, which, in turn, delegates response to key
6031 ;; pressed to `org-export--dispatch-action'.
6033 ;;;###autoload
6034 (defun org-export-dispatch (&optional arg)
6035 "Export dispatcher for Org mode.
6037 It provides an access to common export related tasks in a buffer.
6038 Its interface comes in two flavors: standard and expert.
6040 While both share the same set of bindings, only the former
6041 displays the valid keys associations in a dedicated buffer.
6042 Scrolling (resp. line-wise motion) in this buffer is done with
6043 SPC and DEL (resp. C-n and C-p) keys.
6045 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6046 flavor or the other.
6049 of options used back then, on the current buffer.
6051 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6052 (interactive "P")
6053 (let* ((input
6054 (cond ((equal arg '(16)) '(stack))
6055 ((and arg org-export-dispatch-last-action))
6056 (t (save-window-excursion
6057 (unwind-protect
6058 (progn
6059 ;; Remember where we are
6060 (move-marker org-export-dispatch-last-position
6061 (point)
6062 (org-base-buffer (current-buffer)))
6063 ;; Get and store an export command
6064 (setq org-export-dispatch-last-action
6065 (org-export--dispatch-ui
6066 (list org-export-initial-scope
6067 (and org-export-in-background 'async))
6068 nil
6069 org-export-dispatch-use-expert-ui)))
6070 (and (get-buffer "*Org Export Dispatcher*")
6071 (kill-buffer "*Org Export Dispatcher*")))))))
6072 (action (car input))
6073 (optns (cdr input)))
6074 (unless (memq 'subtree optns)
6075 (move-marker org-export-dispatch-last-position nil))
6076 (case action
6077 ;; First handle special hard-coded actions.
6078 (template (org-export-insert-default-template nil optns))
6079 (stack (org-export-stack))
6080 (publish-current-file
6081 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6082 (publish-current-project
6083 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6084 (publish-choose-project
6085 (org-publish (assoc (org-icompleting-read
6086 "Publish project: "
6087 org-publish-project-alist nil t)
6088 org-publish-project-alist)
6089 (memq 'force optns)
6090 (memq 'async optns)))
6091 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6092 (otherwise
6093 (save-excursion
6094 (when arg
6095 ;; Repeating command, maybe move cursor to restore subtree
6096 ;; context.
6097 (if (eq (marker-buffer org-export-dispatch-last-position)
6098 (org-base-buffer (current-buffer)))
6099 (goto-char org-export-dispatch-last-position)
6100 ;; We are in a different buffer, forget position.
6101 (move-marker org-export-dispatch-last-position nil)))
6102 (funcall action
6103 ;; Return a symbol instead of a list to ease
6104 ;; asynchronous export macro use.
6105 (and (memq 'async optns) t)
6106 (and (memq 'subtree optns) t)
6107 (and (memq 'visible optns) t)
6108 (and (memq 'body optns) t)))))))
6110 (defun org-export--dispatch-ui (options first-key expertp)
6111 "Handle interface for `org-export-dispatch'.
6113 OPTIONS is a list containing current interactive options set for
6114 export. It can contain any of the following symbols:
6115 `body' toggles a body-only export
6116 `subtree' restricts export to current subtree
6117 `visible' restricts export to visible part of buffer.
6118 `force' force publishing files.
6119 `async' use asynchronous export process
6121 FIRST-KEY is the key pressed to select the first level menu. It
6122 is nil when this menu hasn't been selected yet.
6124 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6125 buffer is provided, but indications about currently active
6126 options are given in the prompt. Moreover, \[?] allows to switch
6127 back to standard interface."
6128 (let* ((fontify-key
6129 (lambda (key &optional access-key)
6130 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6131 ;; non-nil is the required first-level key to activate
6132 ;; KEY. When its value is t, activate KEY independently
6133 ;; on the first key, if any. A nil value means KEY will
6134 ;; only be activated at first level.
6135 (if (or (eq access-key t) (eq access-key first-key))
6136 (org-propertize key 'face 'org-warning)
6137 key)))
6138 (fontify-value
6139 (lambda (value)
6140 ;; Fontify VALUE string.
6141 (org-propertize value 'face 'font-lock-variable-name-face)))
6142 ;; Prepare menu entries by extracting them from registered
6143 ;; back-ends and sorting them by access key and by ordinal,
6144 ;; if any.
6145 (entries
6146 (sort (sort (delq nil
6147 (mapcar 'org-export-backend-menu
6148 org-export--registered-backends))
6149 (lambda (a b)
6150 (let ((key-a (nth 1 a))
6151 (key-b (nth 1 b)))
6152 (cond ((and (numberp key-a) (numberp key-b))
6153 (< key-a key-b))
6154 ((numberp key-b) t)))))
6155 'car-less-than-car))
6156 ;; Compute a list of allowed keys based on the first key
6157 ;; pressed, if any. Some keys
6158 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6159 ;; available.
6160 (allowed-keys
6161 (nconc (list 2 22 19 6 1)
6162 (if (not first-key) (org-uniquify (mapcar 'car entries))
6163 (let (sub-menu)
6164 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6165 (when (eq (car entry) first-key)
6166 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6167 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6168 ((not first-key) (list ?P)))
6169 (list ?& ?#)
6170 (when expertp (list ??))
6171 (list ?q)))
6172 ;; Build the help menu for standard UI.
6173 (help
6174 (unless expertp
6175 (concat
6176 ;; Options are hard-coded.
6177 (format "[%s] Body only: %s [%s] Visible only: %s
6178 \[%s] Export scope: %s [%s] Force publishing: %s
6180 (funcall fontify-key "C-b" t)
6181 (funcall fontify-value
6182 (if (memq 'body options) "On " "Off"))
6183 (funcall fontify-key "C-v" t)
6184 (funcall fontify-value
6185 (if (memq 'visible options) "On " "Off"))
6186 (funcall fontify-key "C-s" t)
6187 (funcall fontify-value
6188 (if (memq 'subtree options) "Subtree" "Buffer "))
6189 (funcall fontify-key "C-f" t)
6190 (funcall fontify-value
6191 (if (memq 'force options) "On " "Off"))
6192 (funcall fontify-key "C-a" t)
6193 (funcall fontify-value
6194 (if (memq 'async options) "On " "Off")))
6195 ;; Display registered back-end entries. When a key
6196 ;; appears for the second time, do not create another
6197 ;; entry, but append its sub-menu to existing menu.
6198 (let (last-key)
6199 (mapconcat
6200 (lambda (entry)
6201 (let ((top-key (car entry)))
6202 (concat
6203 (unless (eq top-key last-key)
6204 (setq last-key top-key)
6206 (funcall fontify-key (char-to-string top-key))
6207 (nth 1 entry)))
6208 (let ((sub-menu (nth 2 entry)))
6209 (unless (functionp sub-menu)
6210 ;; Split sub-menu into two columns.
6211 (let ((index -1))
6212 (concat
6213 (mapconcat
6214 (lambda (sub-entry)
6215 (incf index)
6216 (format
6217 (if (zerop (mod index 2)) " [%s] %-26s"
6219 (funcall fontify-key
6220 (char-to-string (car sub-entry))
6221 top-key)
6222 (nth 1 sub-entry)))
6223 sub-menu "")
6225 entries ""))
6226 ;; Publishing menu is hard-coded.
6228 [%s] Current file [%s] Current project
6230 (funcall fontify-key "P")
6231 (funcall fontify-key "f" ?P)
6232 (funcall fontify-key "p" ?P)
6233 (funcall fontify-key "x" ?P)
6234 (funcall fontify-key "a" ?P))
6236 (funcall fontify-key "&" t)
6237 (funcall fontify-key "#" t))
6238 (format "[%s] %s"
6239 (funcall fontify-key "q" t)
6240 (if first-key "Main menu" "Exit")))))
6241 ;; Build prompts for both standard and expert UI.
6242 (standard-prompt (unless expertp "Export command: "))
6243 (expert-prompt
6244 (when expertp
6245 (format
6246 "Export command (C-%s%s%s%s%s) [%s]: "
6247 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6248 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6249 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6250 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6251 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6252 (mapconcat (lambda (k)
6253 ;; Strip control characters.
6254 (unless (< k 27) (char-to-string k)))
6255 allowed-keys "")))))
6256 ;; With expert UI, just read key with a fancy prompt. In standard
6257 ;; UI, display an intrusive help buffer.
6258 (if expertp
6259 (org-export--dispatch-action
6260 expert-prompt allowed-keys entries options first-key expertp)
6261 ;; At first call, create frame layout in order to display menu.
6262 (unless (get-buffer "*Org Export Dispatcher*")
6263 (delete-other-windows)
6264 (org-switch-to-buffer-other-window
6265 (get-buffer-create "*Org Export Dispatcher*"))
6266 (setq cursor-type nil
6267 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6268 ;; Make sure that invisible cursor will not highlight square
6269 ;; brackets.
6270 (set-syntax-table (copy-syntax-table))
6271 (modify-syntax-entry ?\[ "w"))
6272 ;; At this point, the buffer containing the menu exists and is
6273 ;; visible in the current window. So, refresh it.
6274 (with-current-buffer "*Org Export Dispatcher*"
6275 ;; Refresh help. Maintain display continuity by re-visiting
6276 ;; previous window position.
6277 (let ((pos (window-start)))
6278 (erase-buffer)
6279 (insert help)
6280 (set-window-start nil pos)))
6281 (org-fit-window-to-buffer)
6282 (org-export--dispatch-action
6283 standard-prompt allowed-keys entries options first-key expertp))))
6285 (defun org-export--dispatch-action
6286 (prompt allowed-keys entries options first-key expertp)
6287 "Read a character from command input and act accordingly.
6289 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6290 a list of characters available at a given step in the process.
6291 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6292 EXPERTP are the same as defined in `org-export--dispatch-ui',
6293 which see.
6295 Toggle export options when required. Otherwise, return value is
6296 a list with action as CAR and a list of interactive export
6297 options as CDR."
6298 (let (key)
6299 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6300 ;; C-p, SPC, DEL).
6301 (while (and (setq key (read-char-exclusive prompt))
6302 (not expertp)
6303 (memq key '(14 16 ?\s ?\d)))
6304 (case key
6305 (14 (if (not (pos-visible-in-window-p (point-max)))
6306 (ignore-errors (scroll-up 1))
6307 (message "End of buffer")
6308 (sit-for 1)))
6309 (16 (if (not (pos-visible-in-window-p (point-min)))
6310 (ignore-errors (scroll-down 1))
6311 (message "Beginning of buffer")
6312 (sit-for 1)))
6313 (?\s (if (not (pos-visible-in-window-p (point-max)))
6314 (scroll-up nil)
6315 (message "End of buffer")
6316 (sit-for 1)))
6317 (?\d (if (not (pos-visible-in-window-p (point-min)))
6318 (scroll-down nil)
6319 (message "Beginning of buffer")
6320 (sit-for 1)))))
6321 (cond
6322 ;; Ignore undefined associations.
6323 ((not (memq key allowed-keys))
6324 (ding)
6325 (unless expertp (message "Invalid key") (sit-for 1))
6326 (org-export--dispatch-ui options first-key expertp))
6327 ;; q key at first level aborts export. At second level, cancel
6328 ;; first key instead.
6329 ((eq key ?q) (if (not first-key) (error "Export aborted")
6330 (org-export--dispatch-ui options nil expertp)))
6331 ;; Help key: Switch back to standard interface if expert UI was
6332 ;; active.
6333 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6334 ;; Send request for template insertion along with export scope.
6335 ((eq key ?#) (cons 'template (memq 'subtree options)))
6336 ;; Switch to asynchronous export stack.
6337 ((eq key ?&) '(stack))
6338 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6339 ((memq key '(2 22 19 6 1))
6340 (org-export--dispatch-ui
6341 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6342 (6 'force) (1 'async))))
6343 (if (memq option options) (remq option options)
6344 (cons option options)))
6345 first-key expertp))
6346 ;; Action selected: Send key and options back to
6347 ;; `org-export-dispatch'.
6348 ((or first-key (functionp (nth 2 (assq key entries))))
6349 (cons (cond
6350 ((not first-key) (nth 2 (assq key entries)))
6351 ;; Publishing actions are hard-coded. Send a special
6352 ;; signal to `org-export-dispatch'.
6353 ((eq first-key ?P)
6354 (case key
6355 (?f 'publish-current-file)
6356 (?p 'publish-current-project)
6357 (?x 'publish-choose-project)
6358 (?a 'publish-all)))
6359 ;; Return first action associated to FIRST-KEY + KEY
6360 ;; path. Indeed, derived backends can share the same
6361 ;; FIRST-KEY.
6362 (t (catch 'found
6363 (mapc (lambda (entry)
6364 (let ((match (assq key (nth 2 entry))))
6365 (when match (throw 'found (nth 2 match)))))
6366 (member (assq first-key entries) entries)))))
6367 options))
6368 ;; Otherwise, enter sub-menu.
6369 (t (org-export--dispatch-ui options key expertp)))))
6373 (provide 'ox)
6375 ;; Local variables:
6376 ;; generated-autoload-file: "org-loaddefs.el"
6377 ;; End:
6379 ;;; ox.el ends here