| blob | ccccd1b44565e0ed3f5a0c97a117ac50b5b49e10 |
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.
1505 ;; Options in `org-export-special-keywords'.
1510 ;; Avoid circular dependencies.
1521 plist
1523 val backend))))
1527 plist
1533 ;; Options in `org-export-options-alist'.
1538 plist property
1539 ;; Handle value depending on
1540 ;; specified BEHAVIOUR.
1546 " "
1559 val))))))))))))))
1560 ;; Return final value.
1561 plist))))
1562 ;; Read options in the current buffer.
1565 ;; Parse keywords specified in `org-element-document-properties'
1566 ;; and return PLIST.
1577 "Return properties related to buffer attributes, as a plist."
1582 "Return global export options as a plist.
1583 Optional argument BACKEND, if non-nil, is an export back-end, as
1584 returned by, e.g., `org-export-create-backend'. It specifies
1585 which back-end specific export options should also be read in the
1586 process."
1588 ;; Priority is given to back-end specific options.
1590 org-export-options-alist)))
1596 plist
1597 prop
1598 ;; Evaluate default value provided. If keyword is
1599 ;; a member of `org-element-document-properties',
1600 ;; parse it as a secondary string before storing it.
1604 org-element-document-properties))
1607 value)))))))))
1610 "Return variables bound from BIND keywords in current buffer.
1611 Also look for BIND keywords in setup files. The return value is
1612 an alist where associations are (VARIABLE-NAME VALUE)."
1617 ;; Return an alist between variable names and their
1618 ;; value. FILES is a list of setup files names read so
1619 ;; far, used to avoid circular dependencies. ALIST is
1620 ;; the alist collected so far.
1631 ;; Enter setup file.
1641 alist))))))))))
1642 alist)))))
1643 ;; Return value in appropriate order of appearance.
1646 ;; defsubst org-export-get-parent must be defined before first use,
1647 ;; was originally defined in the topology section
1650 "Return BLOB parent or nil.
1651 BLOB is the element or object considered."
1654 ;;;; Tree Properties
1655 ;;
1656 ;; Tree properties are information extracted from parse tree. They
1657 ;; are initialized at the beginning of the transcoding process by
1658 ;; `org-export-collect-tree-properties'.
1659 ;;
1660 ;; Dedicated functions focus on computing the value of specific tree
1661 ;; properties during initialization. Thus,
1662 ;; `org-export--populate-ignore-list' lists elements and objects that
1663 ;; should be skipped during export, `org-export--get-min-level' gets
1664 ;; the minimal exportable level, used as a basis to compute relative
1665 ;; level for headlines. Eventually
1666 ;; `org-export--collect-headline-numbering' builds an alist between
1667 ;; headlines and their numbering.
1670 "Extract tree properties from parse tree.
1672 DATA is the parse tree from which information is retrieved. INFO
1673 is a list holding export options.
1675 Following tree properties are set or updated:
1677 `:exported-data' Hash table used to memoize results from
1678 `org-export-data'.
1680 `:footnote-definition-alist' List of footnotes definitions in
1681 original buffer and current parse tree.
1683 `:headline-offset' Offset between true level of headlines and
1684 local level. An offset of -1 means a headline
1685 of level 2 should be considered as a level
1686 1 headline in the context.
1688 `:headline-numbering' Alist of all headlines as key an the
1689 associated numbering as value.
1691 Return updated plist."
1692 ;; Install the parse tree in the communication channel.
1694 ;; Compute `:headline-offset' in order to be able to use
1695 ;; `org-export-get-relative-level'.
1698 :headline-offset
1700 ;; Footnote definitions in parse tree override those stored in
1701 ;; `:footnote-definition-alist'. This way, any change to
1702 ;; a definition in the parse tree (e.g., through a parse tree
1703 ;; filter) propagates into the alist.
1710 defs))
1714 defs)))))
1716 ;; Properties order doesn't matter: get the rest of the tree
1717 ;; properties.
1722 info))
1725 "Return minimum exportable headline's level in DATA.
1726 DATA is parsed tree as returned by `org-element-parse-buffer'.
1727 OPTIONS is a plist holding export options."
1738 ;; If no headline was found, for the sake of consistency, set
1739 ;; minimum level to 1 nonetheless.
1743 "Return numbering of all exportable, numbered headlines in a parse tree.
1745 DATA is the parse tree. OPTIONS is the plist holding export
1746 options.
1748 Return an alist whose key is a headline and value is its
1749 associated numbering \(in the shape of a list of numbers\) or nil
1750 for a footnotes section."
1759 headline
1761 for idx from 0 to org-export-max-depth
1765 options)))
1768 "Return numbering of all exportable, unnumbered headlines.
1769 DATA is the parse tree. OPTIONS is the plist holding export
1770 options. Unnumbered headlines are numbered as a function of
1771 occurrence."
1779 "List headlines and inlinetasks with a select tag in their tree.
1780 DATA is parsed data as returned by `org-element-parse-buffer'.
1781 INFO is a plist holding export options."
1783 walk-data ; For byte-compiler.
1793 ;; When a select tag is found, mark full
1794 ;; genealogy and every headline within the tree
1795 ;; as acceptable.
1798 genealogy
1801 selected-trees))
1802 ;; If at a headline, continue searching in tree,
1803 ;; recursively.
1812 selected-trees))
1815 "Non-nil when element or object BLOB should be skipped during export.
1816 OPTIONS is the plist holding export options. SELECTED, when
1817 non-nil, is a list of headlines or inlinetasks belonging to
1818 a tree with a select tag."
1825 ;; If `:with-drawers' value starts with `not', ignore
1826 ;; every drawer whose name belong to that list.
1827 ;; Otherwise, ignore drawers whose name isn't in that
1828 ;; list.
1845 ;; Ignore subtrees with an exclude tag.
1848 ;; When a select tag is present in the buffer, ignore any tree
1849 ;; without it.
1851 ;; Ignore commented sub-trees.
1853 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1855 ;; Ignore tasks, if specified by `:with-tasks' property.
1867 properties-set))))))
1878 ;; `:with-timestamps' only applies to isolated timestamps
1879 ;; objects, i.e. timestamp objects in a paragraph containing only
1880 ;; timestamps and whitespaces.
1888 options t))))
1897 \f
1898 ;;; The Transcoder
1899 ;;
1900 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1901 ;; `org-element-parse-buffer') and transcodes it into a specified
1902 ;; back-end output. It takes care of filtering out elements or
1903 ;; objects according to export options and organizing the output blank
1904 ;; lines and white space are preserved. The function memoizes its
1905 ;; results, so it is cheap to call it within transcoders.
1906 ;;
1907 ;; It is possible to modify locally the back-end used by
1908 ;; `org-export-data' or even use a temporary back-end by using
1909 ;; `org-export-data-with-backend'.
1910 ;;
1911 ;; `org-export-transcoder' is an accessor returning appropriate
1912 ;; translator function for a given element or object.
1915 "Return appropriate transcoder for BLOB.
1916 INFO is a plist containing export directives."
1918 ;; Return contents only for complete parse trees.
1924 "Convert DATA into current back-end format.
1926 DATA is a parse tree, an element or an object or a secondary
1927 string. INFO is a plist holding export options.
1929 Return a string."
1934 ;; Ignored element/object.
1936 ;; Plain text.
1942 info))
1943 ;; Secondary string.
1946 ;; Element/Object without contents or, as a special
1947 ;; case, headline with archive tag and archived trees
1948 ;; restricted to title only.
1956 ;; Export snippets never return a nil value so
1957 ;; that white spaces following them are never
1958 ;; ignored.
1960 ;; Element/Object with contents.
1973 ;; Elements directly containing
1974 ;; objects must have their indentation
1975 ;; normalized first.
1977 data
1978 ;; When normalizing contents of the
1979 ;; first paragraph in an item or
1980 ;; a footnote definition, ignore
1981 ;; first line's indentation: there is
1982 ;; none and it might be misleading.
1987 data)
1994 info))))))))
1995 ;; Final result will be memoized before being returned.
1997 data
2001 ;; Append the same white space between elements or objects
2002 ;; as in the original buffer, and call appropriate filters.
2013 info)))
2014 results)))
2018 "Convert DATA into BACKEND format.
2020 DATA is an element, an object, a secondary string or a string.
2021 BACKEND is a symbol. INFO is a plist used as a communication
2022 channel.
2024 Unlike to `org-export-with-backend', this function will
2025 recursively convert DATA using BACKEND translation table."
2028 data
2029 ;; Set-up a new communication channel with translations defined in
2030 ;; BACKEND as the translate table and a new hash table for
2031 ;; memoization.
2033 info
2036 ;; Size of the hash table is reduced since this function
2037 ;; will probably be used on small trees.
2041 "Expand a parsed element or object to its original state.
2043 BLOB is either an element or an object. CONTENTS is its
2044 contents, as a string or nil.
2046 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2047 keywords before output."
2052 blob contents))))
2055 \f
2056 ;;; The Filter System
2057 ;;
2058 ;; Filters allow end-users to tweak easily the transcoded output.
2059 ;; They are the functional counterpart of hooks, as every filter in
2060 ;; a set is applied to the return value of the previous one.
2061 ;;
2062 ;; Every set is back-end agnostic. Although, a filter is always
2063 ;; called, in addition to the string it applies to, with the back-end
2064 ;; used as argument, so it's easy for the end-user to add back-end
2065 ;; specific filters in the set. The communication channel, as
2066 ;; a plist, is required as the third argument.
2067 ;;
2068 ;; From the developer side, filters sets can be installed in the
2069 ;; process with the help of `org-export-define-backend', which
2070 ;; internally stores filters as an alist. Each association has a key
2071 ;; among the following symbols and a function or a list of functions
2072 ;; as value.
2073 ;;
2074 ;; - `:filter-options' applies to the property list containing export
2075 ;; options. Unlike to other filters, functions in this list accept
2076 ;; two arguments instead of three: the property list containing
2077 ;; export options and the back-end. Users can set its value through
2078 ;; `org-export-filter-options-functions' variable.
2079 ;;
2080 ;; - `:filter-parse-tree' applies directly to the complete parsed
2081 ;; tree. Users can set it through
2082 ;; `org-export-filter-parse-tree-functions' variable.
2083 ;;
2084 ;; - `:filter-body' applies to the body of the output, before template
2085 ;; translator chimes in. Users can set it through
2086 ;; `org-export-filter-body-functions' variable.
2087 ;;
2088 ;; - `:filter-final-output' applies to the final transcoded string.
2089 ;; Users can set it with `org-export-filter-final-output-functions'
2090 ;; variable.
2091 ;;
2092 ;; - `:filter-plain-text' applies to any string not recognized as Org
2093 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2094 ;; configure it.
2095 ;;
2096 ;; - `:filter-TYPE' applies on the string returned after an element or
2097 ;; object of type TYPE has been transcoded. A user can modify
2098 ;; `org-export-filter-TYPE-functions' to install these filters.
2099 ;;
2100 ;; All filters sets are applied with
2101 ;; `org-export-filter-apply-functions' function. Filters in a set are
2102 ;; applied in a LIFO fashion. It allows developers to be sure that
2103 ;; their filters will be applied first.
2104 ;;
2105 ;; Filters properties are installed in communication channel with
2106 ;; `org-export-install-filters' function.
2107 ;;
2108 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2109 ;; `org-export-before-parsing-hook') are run at the beginning of the
2110 ;; export process and just before parsing to allow for heavy structure
2111 ;; modifications.
2114 ;;;; Hooks
2117 "Hook run at the beginning of the export process.
2119 This is run before include keywords and macros are expanded and
2120 Babel code blocks executed, on a copy of the original buffer
2121 being exported. Visibility and narrowing are preserved. Point
2122 is at the beginning of the buffer.
2124 Every function in this hook will be called with one argument: the
2128 "Hook run before parsing an export buffer.
2130 This is run after include keywords and macros have been expanded
2131 and Babel code blocks executed, on a copy of the original buffer
2132 being exported. Visibility and narrowing are preserved. Point
2133 is at the beginning of the buffer.
2135 Every function in this hook will be called with one argument: the
2139 ;;;; Special Filters
2142 "List of functions applied to the export options.
2143 Each filter is called with two arguments: the export options, as
2144 a plist, and the back-end, as a symbol. It must return
2148 "List of functions applied to the parsed tree.
2149 Each filter is called with three arguments: the parse tree, as
2150 returned by `org-element-parse-buffer', the back-end, as
2151 a symbol, and the communication channel, as a plist. It must
2155 "List of functions applied to plain text.
2156 Each filter is called with three arguments: a string which
2157 contains no Org syntax, the back-end, as a symbol, and the
2158 communication channel, as a plist. It must return a string or
2162 "List of functions applied to transcoded body.
2163 Each filter is called with three arguments: a string which
2164 contains no Org syntax, the back-end, as a symbol, and the
2165 communication channel, as a plist. It must return a string or
2169 "List of functions applied to the transcoded string.
2170 Each filter is called with three arguments: the full transcoded
2171 string, the back-end, as a symbol, and the communication channel,
2172 as a plist. It must return a string that will be used as the
2176 ;;;; Elements Filters
2179 "List of functions applied to a transcoded babel-call.
2180 Each filter is called with three arguments: the transcoded data,
2181 as a string, the back-end, as a symbol, and the communication
2185 "List of functions applied to a transcoded center block.
2186 Each filter is called with three arguments: the transcoded data,
2187 as a string, the back-end, as a symbol, and the communication
2191 "List of functions applied to a transcoded clock.
2192 Each filter is called with three arguments: the transcoded data,
2193 as a string, the back-end, as a symbol, and the communication
2197 "List of functions applied to a transcoded comment.
2198 Each filter is called with three arguments: the transcoded data,
2199 as a string, the back-end, as a symbol, and the communication
2203 "List of functions applied to a transcoded comment-block.
2204 Each filter is called with three arguments: the transcoded data,
2205 as a string, the back-end, as a symbol, and the communication
2209 "List of functions applied to a transcoded diary-sexp.
2210 Each filter is called with three arguments: the transcoded data,
2211 as a string, the back-end, as a symbol, and the communication
2215 "List of functions applied to a transcoded drawer.
2216 Each filter is called with three arguments: the transcoded data,
2217 as a string, the back-end, as a symbol, and the communication
2221 "List of functions applied to a transcoded dynamic-block.
2222 Each filter is called with three arguments: the transcoded data,
2223 as a string, the back-end, as a symbol, and the communication
2227 "List of functions applied to a transcoded example-block.
2228 Each filter is called with three arguments: the transcoded data,
2229 as a string, the back-end, as a symbol, and the communication
2233 "List of functions applied to a transcoded export-block.
2234 Each filter is called with three arguments: the transcoded data,
2235 as a string, the back-end, as a symbol, and the communication
2239 "List of functions applied to a transcoded fixed-width.
2240 Each filter is called with three arguments: the transcoded data,
2241 as a string, the back-end, as a symbol, and the communication
2245 "List of functions applied to a transcoded footnote-definition.
2246 Each filter is called with three arguments: the transcoded data,
2247 as a string, the back-end, as a symbol, and the communication
2251 "List of functions applied to a transcoded headline.
2252 Each filter is called with three arguments: the transcoded data,
2253 as a string, the back-end, as a symbol, and the communication
2257 "List of functions applied to a transcoded horizontal-rule.
2258 Each filter is called with three arguments: the transcoded data,
2259 as a string, the back-end, as a symbol, and the communication
2263 "List of functions applied to a transcoded inlinetask.
2264 Each filter is called with three arguments: the transcoded data,
2265 as a string, the back-end, as a symbol, and the communication
2269 "List of functions applied to a transcoded item.
2270 Each filter is called with three arguments: the transcoded data,
2271 as a string, the back-end, as a symbol, and the communication
2275 "List of functions applied to a transcoded keyword.
2276 Each filter is called with three arguments: the transcoded data,
2277 as a string, the back-end, as a symbol, and the communication
2281 "List of functions applied to a transcoded latex-environment.
2282 Each filter is called with three arguments: the transcoded data,
2283 as a string, the back-end, as a symbol, and the communication
2287 "List of functions applied to a transcoded node-property.
2288 Each filter is called with three arguments: the transcoded data,
2289 as a string, the back-end, as a symbol, and the communication
2293 "List of functions applied to a transcoded paragraph.
2294 Each filter is called with three arguments: the transcoded data,
2295 as a string, the back-end, as a symbol, and the communication
2299 "List of functions applied to a transcoded plain-list.
2300 Each filter is called with three arguments: the transcoded data,
2301 as a string, the back-end, as a symbol, and the communication
2305 "List of functions applied to a transcoded planning.
2306 Each filter is called with three arguments: the transcoded data,
2307 as a string, the back-end, as a symbol, and the communication
2311 "List of functions applied to a transcoded property-drawer.
2312 Each filter is called with three arguments: the transcoded data,
2313 as a string, the back-end, as a symbol, and the communication
2317 "List of functions applied to a transcoded quote block.
2318 Each filter is called with three arguments: the transcoded quote
2319 data, as a string, the back-end, as a symbol, and the
2320 communication channel, as a plist. It must return a string or
2324 "List of functions applied to a transcoded section.
2325 Each filter is called with three arguments: the transcoded data,
2326 as a string, the back-end, as a symbol, and the communication
2330 "List of functions applied to a transcoded special block.
2331 Each filter is called with three arguments: the transcoded data,
2332 as a string, the back-end, as a symbol, and the communication
2336 "List of functions applied to a transcoded src-block.
2337 Each filter is called with three arguments: the transcoded data,
2338 as a string, the back-end, as a symbol, and the communication
2342 "List of functions applied to a transcoded table.
2343 Each filter is called with three arguments: the transcoded data,
2344 as a string, the back-end, as a symbol, and the communication
2348 "List of functions applied to a transcoded table-cell.
2349 Each filter is called with three arguments: the transcoded data,
2350 as a string, the back-end, as a symbol, and the communication
2354 "List of functions applied to a transcoded table-row.
2355 Each filter is called with three arguments: the transcoded data,
2356 as a string, the back-end, as a symbol, and the communication
2360 "List of functions applied to a transcoded verse block.
2361 Each filter is called with three arguments: the transcoded data,
2362 as a string, the back-end, as a symbol, and the communication
2366 ;;;; Objects Filters
2369 "List of functions applied to transcoded bold text.
2370 Each filter is called with three arguments: the transcoded data,
2371 as a string, the back-end, as a symbol, and the communication
2375 "List of functions applied to transcoded code text.
2376 Each filter is called with three arguments: the transcoded data,
2377 as a string, the back-end, as a symbol, and the communication
2381 "List of functions applied to a transcoded entity.
2382 Each filter is called with three arguments: the transcoded data,
2383 as a string, the back-end, as a symbol, and the communication
2387 "List of functions applied to a transcoded export-snippet.
2388 Each filter is called with three arguments: the transcoded data,
2389 as a string, the back-end, as a symbol, and the communication
2393 "List of functions applied to a transcoded footnote-reference.
2394 Each filter is called with three arguments: the transcoded data,
2395 as a string, the back-end, as a symbol, and the communication
2399 "List of functions applied to a transcoded inline-babel-call.
2400 Each filter is called with three arguments: the transcoded data,
2401 as a string, the back-end, as a symbol, and the communication
2405 "List of functions applied to a transcoded inline-src-block.
2406 Each filter is called with three arguments: the transcoded data,
2407 as a string, the back-end, as a symbol, and the communication
2411 "List of functions applied to transcoded italic text.
2412 Each filter is called with three arguments: the transcoded data,
2413 as a string, the back-end, as a symbol, and the communication
2417 "List of functions applied to a transcoded latex-fragment.
2418 Each filter is called with three arguments: the transcoded data,
2419 as a string, the back-end, as a symbol, and the communication
2423 "List of functions applied to a transcoded line-break.
2424 Each filter is called with three arguments: the transcoded data,
2425 as a string, the back-end, as a symbol, and the communication
2429 "List of functions applied to a transcoded link.
2430 Each filter is called with three arguments: the transcoded data,
2431 as a string, the back-end, as a symbol, and the communication
2435 "List of functions applied to a transcoded radio-target.
2436 Each filter is called with three arguments: the transcoded data,
2437 as a string, the back-end, as a symbol, and the communication
2441 "List of functions applied to a transcoded statistics-cookie.
2442 Each filter is called with three arguments: the transcoded data,
2443 as a string, the back-end, as a symbol, and the communication
2447 "List of functions applied to transcoded strike-through text.
2448 Each filter is called with three arguments: the transcoded data,
2449 as a string, the back-end, as a symbol, and the communication
2453 "List of functions applied to a transcoded subscript.
2454 Each filter is called with three arguments: the transcoded data,
2455 as a string, the back-end, as a symbol, and the communication
2459 "List of functions applied to a transcoded superscript.
2460 Each filter is called with three arguments: the transcoded data,
2461 as a string, the back-end, as a symbol, and the communication
2465 "List of functions applied to a transcoded target.
2466 Each filter is called with three arguments: the transcoded data,
2467 as a string, the back-end, as a symbol, and the communication
2471 "List of functions applied to a transcoded timestamp.
2472 Each filter is called with three arguments: the transcoded data,
2473 as a string, the back-end, as a symbol, and the communication
2477 "List of functions applied to transcoded underline text.
2478 Each filter is called with three arguments: the transcoded data,
2479 as a string, the back-end, as a symbol, and the communication
2483 "List of functions applied to transcoded verbatim text.
2484 Each filter is called with three arguments: the transcoded data,
2485 as a string, the back-end, as a symbol, and the communication
2489 ;;;; Filters Tools
2490 ;;
2491 ;; Internal function `org-export-install-filters' installs filters
2492 ;; hard-coded in back-ends (developer filters) and filters from global
2493 ;; variables (user filters) in the communication channel.
2494 ;;
2495 ;; Internal function `org-export-filter-apply-functions' takes care
2496 ;; about applying each filter in order to a given data. It ignores
2497 ;; filters returning a nil value but stops whenever a filter returns
2498 ;; an empty string.
2501 "Call every function in FILTERS.
2503 Functions are called with arguments VALUE, current export
2504 back-end's name and INFO. A function returning a nil value will
2505 be skipped. If it returns the empty string, the process ends and
2506 VALUE is ignored.
2508 Call is done in a LIFO fashion, to be sure that developer
2509 specified filters, if any, are called first."
2520 "Install filters properties in communication channel.
2521 INFO is a plist containing the current communication channel.
2522 Return the updated communication channel."
2524 ;; Install user-defined filters with `org-export-filters-alist'
2525 ;; and filters already in INFO (through ext-plist mechanism).
2532 ;; Filters in INFO will be called
2533 ;; before those user provided.
2536 default-value)))))
2537 org-export-filters-alist)
2538 ;; Prepend back-end specific filters to that list.
2540 ;; Single values get consed, lists are appended.
2545 plist key
2549 ;; Return new communication channel.
2553 \f
2554 ;;; Core functions
2555 ;;
2556 ;; This is the room for the main function, `org-export-as', along with
2557 ;; its derivative, `org-export-string-as'.
2558 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2559 ;; function should be added to kill ring.
2560 ;;
2561 ;; Note that `org-export-as' doesn't really parse the current buffer,
2562 ;; but a copy of it (with the same buffer-local variables and
2563 ;; visibility), where macros and include keywords are expanded and
2564 ;; Babel blocks are executed, if appropriate.
2565 ;; `org-export-with-buffer-copy' macro prepares that copy.
2566 ;;
2567 ;; File inclusion is taken care of by
2568 ;; `org-export-expand-include-keyword' and
2569 ;; `org-export--prepare-file-contents'. Structure wise, including
2570 ;; a whole Org file in a buffer often makes little sense. For
2571 ;; example, if the file contains a headline and the include keyword
2572 ;; was within an item, the item should contain the headline. That's
2573 ;; why file inclusion should be done before any structure can be
2574 ;; associated to the file, that is before parsing.
2575 ;;
2576 ;; `org-export-insert-default-template' is a command to insert
2577 ;; a default template (or a back-end specific template) at point or in
2578 ;; current subtree.
2581 "Return a copy of the current buffer.
2582 The copy preserves Org buffer-local variables, visibility and
2583 narrowing."
2589 new-buf))
2592 "Apply BODY in a copy of the current buffer.
2593 The copy preserves local variables, visibility and contents of
2594 the original buffer. Point is at the beginning of the buffer
2595 when BODY is applied."
2604 ;; Kill copy without confirmation.
2610 "Generate a function duplicating BUFFER.
2612 The copy will preserve local variables, visibility, contents and
2613 narrowing of the original buffer. If a region was active in
2614 BUFFER, contents will be narrowed to that region instead.
2616 The resulting function can be evaluated at a later time, from
2617 another buffer, effectively cloning the original buffer there.
2619 The function assumes BUFFER's major mode is `org-mode'."
2623 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2624 ;; already in BUFFER.
2626 ;; Copy specific buffer local variables and variables set
2627 ;; through BIND keywords.
2629 vars)
2637 buffer-file-name
2638 buffer-file-coding-system))
2642 ;; Skip unreadable values, as they cannot be
2643 ;; sent to external process.
2647 vars))))))
2648 ;; Whole buffer contents.
2653 ;; Narrowing.
2657 ;; Current position of point.
2659 ;; Overlays with invisible property.
2669 ov-set))))
2671 ov-set)))))
2674 "Prune non exportable elements from DATA.
2675 DATA is the parse tree to traverse. INFO is the plist holding
2676 export info. Also set `:ignore-list' in INFO to a list of
2677 objects which should be ignored during export, but not removed
2678 from tree."
2680 ignore
2681 ;; First find trees containing a select tag, if any.
2685 ;; Prune non-exportable elements and objects from tree.
2686 ;; As a special case, special rows and cells from tables
2687 ;; are stored in IGNORE, as they still need to be accessed
2688 ;; during export.
2696 ;; If headline is archived but tree below has to
2697 ;; be skipped, remove contents.
2699 ;; Move into secondary string, if any.
2704 ;; Move into recursive objects/elements.
2706 ;; If a select tag is active, also ignore the section before the
2707 ;; first headline, if any.
2712 ;; Prune tree and communication channel.
2716 ;; Eventually set `:ignore-list'.
2720 "Change uninterpreted elements back into Org syntax.
2721 DATA is the parse tree. INFO is a plist containing export
2722 options. Each uninterpreted element or object is changed back
2723 into a string. Contents, if any, are not modified. The parse
2724 tree is modified by side effect."
2728 prop
2731 info))))
2734 "Change uninterpreted elements back into Org syntax.
2735 DATA is a parse tree or a secondary string. INFO is a plist
2736 containing export options. It is modified by side effect and
2737 returned by the function."
2740 subscript superscript underline)
2744 ;; ... entities...
2751 ?\s)))))
2752 ;; ... emphasis...
2764 marker
2768 ?\s)))))))
2769 ;; ... LaTeX environments and fragments...
2773 ;; ... sub/superscripts...
2782 "_"
2791 ?\s)))))))))))
2793 ;; Splice NEW at BLOB location in parse tree.
2796 info)
2797 ;; Return modified parse tree.
2798 data)
2800 ;;;###autoload
2803 "Transcode current Org buffer into BACKEND code.
2805 BACKEND is either an export back-end, as returned by, e.g.,
2806 `org-export-create-backend', or a symbol referring to
2807 a registered back-end.
2809 If narrowing is active in the current buffer, only transcode its
2810 narrowed part.
2812 If a region is active, transcode that region.
2814 When optional argument SUBTREEP is non-nil, transcode the
2815 sub-tree at point, extracting information from the headline
2816 properties first.
2818 When optional argument VISIBLE-ONLY is non-nil, don't export
2819 contents of hidden elements.
2821 When optional argument BODY-ONLY is non-nil, only return body
2822 code, without surrounding template.
2824 Optional argument EXT-PLIST, when provided, is a property list
2825 with external parameters overriding Org default settings, but
2826 still inferior to file-local settings.
2828 Return code as a string."
2833 ;; Narrow buffer to an appropriate region or subtree for
2834 ;; parsing. If parsing subtree, be sure to remove main headline
2835 ;; too.
2843 ;; Initialize communication channel with original buffer
2844 ;; attributes, unavailable in its copy.
2853 tree)
2854 ;; Update communication channel and get parse tree. Buffer
2855 ;; isn't parsed directly. Instead, a temporary copy is
2856 ;; created, where include keywords, macros are expanded and
2857 ;; code blocks are evaluated.
2859 ;; Run first hook with current back-end's name as argument.
2863 ;; Update macro templates since #+INCLUDE keywords might have
2864 ;; added some new ones.
2868 ;; Update radio targets since keyword inclusion might have
2869 ;; added some more.
2871 ;; Run last hook with current back-end's name as argument.
2876 ;; Update communication channel with environment. Also
2877 ;; install user's and developer's filters.
2882 ;; Call options filters and update export options. We do not
2883 ;; use `org-export-filter-apply-functions' here since the
2884 ;; arity of such filters is different.
2889 ;; Expand export-specific set of macros: {{{author}}},
2890 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
2891 ;; be done once regular macros have been expanded, since
2892 ;; document keywords may contain one of them.
2904 value)
2905 value)))
2906 ;; EMAIL is not a parsed keyword: store it as-is.
2912 ;; Parse buffer.
2914 ;; Prune tree from non-exported elements and transform
2915 ;; uninterpreted elements or objects in both parse tree and
2916 ;; communication channel.
2919 ;; Parse buffer, handle uninterpreted elements or objects,
2920 ;; then call parse-tree filters.
2924 ;; Now tree is complete, compute its properties and add them
2925 ;; to communication channel.
2929 ;; Eventually transcode TREE. Wrap the resulting string into
2930 ;; a template.
2939 info))
2942 ;; Remove all text properties since they cannot be
2943 ;; retrieved from an external process. Finally call
2944 ;; final-output filter and return result.
2950 info))))))))
2952 ;;;###autoload
2954 "Transcode STRING into BACKEND code.
2956 BACKEND is either an export back-end, as returned by, e.g.,
2957 `org-export-create-backend', or a symbol referring to
2958 a registered back-end.
2960 When optional argument BODY-ONLY is non-nil, only return body
2961 code, without preamble nor postamble.
2963 Optional argument EXT-PLIST, when provided, is a property list
2964 with external parameters overriding Org default settings, but
2965 still inferior to file-local settings.
2967 Return code as a string."
2973 ;;;###autoload
2975 "Replace the active region by its export to BACKEND.
2976 BACKEND is either an export back-end, as returned by, e.g.,
2977 `org-export-create-backend', or a symbol referring to
2978 a registered back-end."
2988 ;;;###autoload
2990 "Insert all export keywords with default values at beginning of line.
2992 BACKEND is a symbol referring to the name of a registered export
2993 back-end, for which specific export options should be added to
2994 the template, or `default' for default template. When it is nil,
2995 the user will be prompted for a category.
2997 If SUBTREEP is non-nil, export configuration will be set up
2998 locally for the subtree through node properties."
3008 "Options category: "
3012 org-export--registered-backends))
3013 nil t))))
3014 options keywords)
3015 ;; Populate OPTIONS and KEYWORDS.
3032 ;; Move to an appropriate location in order to insert options.
3034 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3052 ;; Then the rest of keywords, in the order specified in either
3053 ;; `org-export-options-alist' or respective export back-ends.
3074 "Expand every include keyword in buffer.
3075 Optional argument INCLUDED is a list of included file names along
3076 with their line restriction, when appropriate. It is used to
3077 avoid infinite recursion. Optional argument DIR is the current
3078 working directory. It is used to properly resolve relative
3079 paths. Optional argument FOOTNOTES is a hash-table used for
3080 storing and resolving footnotes. It is created automatically."
3086 ;; If :minlevel is not set the text-property
3087 ;; `:org-include-induced-level' will be used to determine the
3088 ;; relative level when expanding INCLUDE.
3089 ;; Only affects included Org documents.
3093 :org-include-induced-level
3095 ;; Expand INCLUDE keywords.
3101 ;; Extract arguments from keyword's value.
3104 location
3116 matched)
3117 dir)))
3126 value)
3133 ;; Minimal level of included file defaults to the child
3134 ;; level of the current headline, if any, or one. It
3135 ;; only applies is the file is meant to be included as
3136 ;; an Org one.
3147 ;; Remove keyword.
3153 ;; Check if files has already been parsed. Look after
3154 ;; inclusion lines too, as different parts of the same file
3155 ;; can be included too.
3170 ind-str block arg-str contents ind-str block))))
3177 ind-str block contents ind-str block))))
3185 file location only-contents lines)
3186 lines)))
3189 file lines ind minlevel
3192 footnotes)))
3196 footnotes)
3198 ;; Expand footnotes after all files have been
3199 ;; included. Footnotes are stored at end of buffer.
3204 footnotes)))))))))))
3207 "Resolve absolute lines for an included file with file-link.
3209 FILE is string file-name of the file to include. LOCATION is a
3210 string name within FILE to be included (located via
3211 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3212 contents of the named element will be included, as determined
3213 Org-Element. If LINES is non-nil only those lines are included.
3215 Return a string of lines to be included in the format expected by
3216 `org-export--prepare-file-contents'."
3222 ;; Enforce consistent search.
3235 ;; Skip planning line and property-drawer.
3261 start-line
3263 (+ start-line
3266 counter))))))))
3269 "Prefix footnote-label at point REF-BEGIN in buffer with ID.
3271 REF-BEGIN corresponds to the property `:begin' of objects of type
3272 footnote-definition and footnote-reference.
3274 If DIGIT-LABEL is non-nil the label is assumed to be of the form
3275 \[N] where N is one or more numbers.
3277 Return the new label."
3287 "Prepare contents of FILE for inclusion and return it as a string.
3289 When optional argument LINES is a string specifying a range of
3290 lines, include only those lines.
3292 Optional argument IND, when non-nil, is an integer specifying the
3293 global indentation of returned contents. Since its purpose is to
3294 allow an included file to stay in the same environment it was
3295 created \(i.e. a list item), it doesn't apply past the first
3296 headline encountered.
3298 Optional argument MINLEVEL, when non-nil, is an integer
3299 specifying the level that any top-level headline in the included
3300 file should have.
3301 Optional argument ID is an integer that will be inserted before
3302 each footnote definition and reference if FILE is an Org file.
3303 This is useful to avoid conflicts when more than one Org file
3304 with footnotes is included in a document.
3306 Optional argument FOOTNOTES is a hash-table to store footnotes in
3307 the included document.
3308 "
3324 ;; Remove blank lines at beginning and end of contents. The logic
3325 ;; behind that removal is that blank lines around include keyword
3326 ;; override blank lines in included file.
3335 ;; If IND is set, preserve indentation of include keyword until
3336 ;; the first headline encountered.
3343 ;; Do not move footnote definitions out of column 0.
3349 ;; When MINLEVEL is specified, compute minimal level for headlines
3350 ;; in the file (CUR-MIN), and remove stars to each headline so
3351 ;; that headlines with minimal level have a level of MINLEVEL.
3362 ;; Only change stars, don't bother moving whole
3363 ;; sections.
3367 ;; Append ID to all footnote references and definitions, so they
3368 ;; become file specific and cannot collide with footnotes in other
3369 ;; included files. Further, collect relevant footnotes outside of
3370 ;; LINES.
3380 ;; Update the footnote-reference at point and collect
3381 ;; the new label, which is only used for footnotes
3382 ;; outsides LINES.
3384 ;; If label is akin to [1] convert it to [fn:ID-1].
3385 ;; Otherwise add "ID-" after "fn:".
3395 ;; Store since footnote-definition is outside of LINES.
3398 footnotes)
3399 ;; Update label of definition since it is included directly.
3406 "Execute every Babel code in the visible part of current buffer."
3407 ;; Get a pristine copy of current buffer so Babel references can be
3408 ;; properly resolved.
3414 "Return a non-nil value when output should be added to the kill ring.
3415 See also `org-export-copy-to-kill-ring'."
3421 \f
3422 ;;; Tools For Back-Ends
3423 ;;
3424 ;; A whole set of tools is available to help build new exporters. Any
3425 ;; function general enough to have its use across many back-ends
3426 ;; should be added here.
3428 ;;;; For Affiliated Keywords
3429 ;;
3430 ;; `org-export-read-attribute' reads a property from a given element
3431 ;; as a plist. It can be used to normalize affiliated keywords'
3432 ;; syntax.
3433 ;;
3434 ;; Since captions can span over multiple lines and accept dual values,
3435 ;; their internal representation is a bit tricky. Therefore,
3436 ;; `org-export-get-caption' transparently returns a given element's
3437 ;; caption as a secondary string.
3440 "Turn ATTRIBUTE property from ELEMENT into a plist.
3442 When optional argument PROPERTY is non-nil, return the value of
3443 that property within attributes.
3447 properties.
3449 All values will become strings except the empty string and
3452 will become the empty string."
3466 s)
3471 ;; Ignore any string before first property with `cdr'.
3476 "Return caption from ELEMENT as a secondary string.
3478 When optional argument SHORTP is non-nil, return short caption,
3479 as a secondary string, instead.
3481 Caption lines are separated by a white space."
3489 ;;;; For Derived Back-ends
3490 ;;
3491 ;; `org-export-with-backend' is a function allowing to locally use
3492 ;; another back-end to transcode some object or element. In a derived
3493 ;; back-end, it may be used as a fall-back function once all specific
3494 ;; cases have been treated.
3497 "Call a transcoder from BACKEND on DATA.
3498 BACKEND is an export back-end, as returned by, e.g.,
3499 `org-export-create-backend', or a symbol referring to
3500 a registered back-end. DATA is an Org element, object, secondary
3501 string or string. CONTENTS, when non-nil, is the transcoded
3502 contents of DATA element, as a string. INFO, when non-nil, is
3503 the communication channel used for export, as a plist."
3513 transcoder data contents
3516 :translate-alist all-transcoders
3520 ;;;; For Export Snippets
3521 ;;
3522 ;; Every export snippet is transmitted to the back-end. Though, the
3523 ;; latter will only retain one type of export-snippet, ignoring
3524 ;; others, based on the former's target back-end. The function
3525 ;; `org-export-snippet-backend' returns that back-end for a given
3526 ;; export-snippet.
3529 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3530 Translation, with `org-export-snippet-translation-alist', is
3531 applied."
3535 back-end))))
3538 ;;;; For Footnotes
3539 ;;
3540 ;; `org-export-collect-footnote-definitions' is a tool to list
3541 ;; actually used footnotes definitions in the whole parse tree, or in
3542 ;; a headline, in order to add footnote listings throughout the
3543 ;; transcoded data.
3544 ;;
3545 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3546 ;; back-ends, when they need to attach the footnote definition only to
3547 ;; the first occurrence of the corresponding label.
3548 ;;
3549 ;; `org-export-get-footnote-definition' and
3550 ;; `org-export-get-footnote-number' provide easier access to
3551 ;; additional information relative to a footnote reference.
3554 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3555 INFO is the plist used as a communication channel. If no such
3556 definition can be found, raise an error."
3565 "Apply FUNCTION on every footnote reference in DATA.
3566 INFO is a plist containing export state. By default, as soon as
3567 a new footnote reference is encountered, FUNCTION is called onto
3568 its definition. However, if BODY-FIRST is non-nil, this step is
3569 delayed until the end of the process."
3575 ;; Search footnote references through DATA, filling
3576 ;; SEEN-REFS along the way. When DELAYP is non-nil, store
3577 ;; footnote definitions so they can be entered later.
3584 ;; Search for subsequent references in footnote
3585 ;; definition so numbering follows reading logic,
3586 ;; unless DELAYP in non-nil.
3590 definitions))
3591 ;; Do not force entering inline definitions,
3592 ;; since `org-element-map' already traverses them
3593 ;; at the right time.
3597 nil))))))
3598 info nil
3599 ;; Don't enter footnote definitions since it will happen
3600 ;; when their first reference is found. Moreover, if
3601 ;; DELAYP is non-nil, make sure we postpone entering
3602 ;; definitions of inline references.
3609 "Return an alist between footnote numbers, labels and definitions.
3611 INFO is the current export state, as a plist.
3613 Definitions are collected throughout the whole parse tree, or
3614 DATA when non-nil.
3616 Sorting is done by order of references. As soon as a new
3617 reference is encountered, other references are searched within
3618 its definition. However, if BODY-FIRST is non-nil, this step is
3619 delayed after the whole tree is checked. This alters results
3620 when references are found in footnote definitions.
3622 Definitions either appear as Org data or as a secondary string
3623 for inlined footnotes. Unreferenced definitions are ignored."
3627 ;; Collect footnote number, label and definition.
3638 "Non-nil when a footnote reference is the first one for its label.
3640 FOOTNOTE-REFERENCE is the footnote reference being considered.
3641 INFO is a plist containing current export state.
3643 Search is done throughout the whole parse tree, or DATA when
3644 non-nil.
3646 By default, as soon as a new footnote reference is encountered,
3647 other references are searched within its definition. However, if
3648 BODY-FIRST is non-nil, this step is delayed after the whole tree
3649 is checked. This alters results when references are found in
3650 footnote definitions."
3652 ;; Anonymous footnotes are always a first reference.
3663 "Return number associated to a footnote.
3665 FOOTNOTE is either a footnote reference or a footnote definition.
3666 INFO is the plist containing export state.
3668 Number is unique throughout the whole parse tree, or DATA, when
3669 non-nil.
3671 By default, as soon as a new footnote reference is encountered,
3672 counting process moves into its definition. However, if
3673 BODY-FIRST is non-nil, this step is delayed until the end of the
3674 process, leading to a different order when footnotes are nested."
3683 ;; Anonymous footnote match: return number.
3685 ;; Labels match: return number.
3687 ;; Otherwise store label and increase counter if label
3688 ;; wasn't encountered yet.
3694 ;;;; For Headlines
3695 ;;
3696 ;; `org-export-get-relative-level' is a shortcut to get headline
3697 ;; level, relatively to the lower headline level in the parsed tree.
3698 ;;
3699 ;; `org-export-get-headline-number' returns the section number of an
3700 ;; headline, while `org-export-number-to-roman' allows to convert it
3701 ;; to roman numbers. With an optional argument,
3702 ;; `org-export-get-headline-number' returns a number to unnumbered
3703 ;; headlines (used for internal id).
3704 ;;
3705 ;; `org-export-get-headline-id' returns the unique internal id of a
3706 ;; headline.
3707 ;;
3708 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3709 ;; `org-export-last-sibling-p' are three useful predicates when it
3710 ;; comes to fulfill the `:headline-levels' property.
3711 ;;
3712 ;; `org-export-get-tags', `org-export-get-category' and
3713 ;; `org-export-get-node-property' extract useful information from an
3714 ;; headline or a parent headline. They all handle inheritance.
3715 ;;
3716 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3717 ;; as a secondary string, suitable for table of contents. It falls
3718 ;; back onto default title.
3721 "Return HEADLINE relative level within current parsed tree.
3722 INFO is a plist holding contextual information."
3727 "Non-nil when HEADLINE is considered as low level.
3729 INFO is a plist used as a communication channel.
3731 A low level headlines has a relative level greater than
3732 `:headline-levels' property value.
3734 Return value is the difference between HEADLINE relative level
3735 and the last level being considered as high enough, or nil."
3742 "Return a unique ID for HEADLINE.
3743 INFO is a plist holding contextual information."
3753 "Return numbered HEADLINE numbering as a list of numbers.
3754 INFO is a plist holding contextual information."
3759 "Return a non-nil value if HEADLINE element should be numbered.
3760 INFO is a plist used as a communication channel."
3769 "Convert integer N into a roman numeral."
3782 res)))
3785 "Return list of tags associated to ELEMENT.
3787 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3788 is a plist used as a communication channel.
3790 Select tags (see `org-export-select-tags') and exclude tags (see
3791 `org-export-exclude-tags') are removed from the list.
3793 When non-nil, optional argument TAGS should be a list of strings.
3794 Any tag belonging to this list will also be removed.
3796 When optional argument INHERITED is non-nil, tags can also be
3797 inherited from parent headlines and FILETAGS keywords."
3803 ;; Build complete list of inherited tags.
3810 ;; Add FILETAGS keywords and return results.
3814 "Return node PROPERTY value for BLOB.
3816 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3817 element or object.
3819 If optional argument INHERITED is non-nil, the value can be
3820 inherited from a parent headline.
3822 Return value is a string or nil."
3834 "Return category for element or object BLOB.
3836 INFO is a plist used as a communication channel.
3838 CATEGORY is automatically inherited from a parent headline, from
3839 #+CATEGORY: keyword or created out of original file name. If all
3852 "Return alternative title for HEADLINE, as a secondary string.
3853 INFO is a plist used as a communication channel. If no optional
3854 title is defined, fall-back to the regular title."
3861 "Non-nil when BLOB is the first sibling in its parent.
3862 BLOB is an element or an object. If BLOB is a headline, non-nil
3863 means it is the first sibling in the sub-tree. INFO is a plist
3864 used as a communication channel."
3869 "Non-nil when BLOB is the last sibling in its parent.
3870 BLOB is an element or an object. INFO is a plist used as
3871 a communication channel."
3875 ;;;; For Keywords
3876 ;;
3877 ;; `org-export-get-date' returns a date appropriate for the document
3878 ;; to about to be exported. In particular, it takes care of
3879 ;; `org-export-date-timestamp-format'.
3882 "Return date value for the current document.
3884 INFO is a plist used as a communication channel. FMT, when
3885 non-nil, is a time format string that will be applied on the date
3886 if it consists in a single timestamp object. It defaults to
3887 `org-export-date-timestamp-format' when nil.
3889 A proper date can be a secondary string, a string or nil. It is
3890 meant to be translated with `org-export-data' or alike."
3901 ;;;; For Links
3902 ;;
3903 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
3904 ;; with `org-add-link-type', which see.
3905 ;;
3906 ;; `org-export-solidify-link-text' turns a string into a safer version
3907 ;; for links, replacing most non-standard characters with hyphens.
3908 ;;
3909 ;; `org-export-get-coderef-format' returns an appropriate format
3910 ;; string for coderefs.
3911 ;;
3912 ;; `org-export-inline-image-p' returns a non-nil value when the link
3913 ;; provided should be considered as an inline image.
3914 ;;
3915 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3916 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3917 ;; returns an appropriate unique identifier when found, or nil.
3918 ;;
3919 ;; `org-export-resolve-id-link' returns the first headline with
3920 ;; specified id or custom-id in parse tree, the path to the external
3921 ;; file with the id or nil when neither was found.
3922 ;;
3923 ;; `org-export-resolve-coderef' associates a reference to a line
3924 ;; number in the element it belongs, or returns the reference itself
3925 ;; when the element isn't numbered.
3928 "Take link text S and make a safe target out of it."
3933 "Try exporting LINK with a dedicated function.
3935 DESC is its description, as a string, or nil. BACKEND is the
3936 back-end used for export, as a symbol.
3938 Return output as a string, or nil if no protocol handles LINK.
3940 A custom protocol has precedence over regular back-end export.
3941 The function ignores links with an implicit type (e.g.,
3950 desc
3951 backend))))))
3954 "Return format string for code reference link.
3955 PATH is the link path. DESC is its description."
3963 "Non-nil if LINK object points to an inline image.
3965 Optional argument is a set of RULES defining inline images. It
3966 is an alist where associations have the following shape:
3968 \(TYPE . REGEXP)
3970 Applying a rule means apply REGEXP against LINK's path when its
3971 type is TYPE. The function will return a non-nil value if any of
3972 the provided rules is non-nil. The default rule is
3973 `org-export-default-inline-image-rule'.
3975 This only applies to links without a description."
3986 "Resolve a code reference REF.
3988 INFO is a plist used as a communication channel.
3990 Return associated line number in source code, or REF itself,
3991 depending on src-block or example element's switches. Throw an
3992 error if no block contains REF."
3999 org-coderef-label-format)))
4003 ;; Element containing REF is found. Resolve it to
4004 ;; either a label or a line number, as needed.
4015 "Return LINK destination.
4017 INFO is a plist holding contextual information.
4019 Return value can be an object, an element, or nil:
4021 - If LINK path matches a target object (i.e. <<path>>) return it.
4023 - If LINK path exactly matches the name affiliated keyword
4024 \(i.e. #+NAME: path) of an element, return that element.
4026 - If LINK path exactly matches any headline name, return that
4027 element. If more than one headline share that name, priority
4028 will be given to the one with the closest common ancestor, if
4029 any, or the first one in the parse tree otherwise.
4031 - Otherwise, throw an error.
4034 significant."
4037 ;; Split PATH at white spaces so matches are space
4038 ;; insensitive.
4041 ;; Cache for destinations that are not position dependent.
4049 ;; Destination is not position dependent: use cached value.
4051 ;; First try to find a matching "<<path>>" unless user specified
4052 ;; he was looking for a headline (path starts with a "*"
4053 ;; character).
4059 path)
4060 blob))
4063 ;; Then try to find an element with a matching "#+NAME: path"
4064 ;; affiliated keyword.
4067 org-element-all-elements
4072 el)))
4075 ;; Last case: link either points to a headline or to nothingness.
4076 ;; Try to find the source, with priority given to headlines with
4077 ;; the closest common ancestor. If such candidate is found,
4078 ;; return it, otherwise signal an error.
4082 ;; Return first headline whose `:raw-value' property is
4083 ;; NAME in parse tree DATA, or nil. Statistics cookies
4084 ;; are ignored.
4092 name)
4093 headline))
4095 ;; Search among headlines sharing an ancestor with link, from
4096 ;; closest to farthest.
4104 ;; No destination found: error.
4108 "Return headline referenced as LINK destination.
4110 INFO is a plist used as a communication channel.
4112 Return value can be the headline element matched in current parse
4116 ;; First check if id is within the current parse tree.
4121 headline))
4123 ;; Otherwise, look for external files.
4128 "Return radio-target object referenced as LINK destination.
4130 INFO is a plist used as a communication channel.
4132 Return value can be a radio-target object or nil. Assume LINK
4141 nil nil path nil nil t)
4142 t)
4143 radio))
4147 ;;;; For References
4148 ;;
4149 ;; `org-export-get-ordinal' associates a sequence number to any object
4150 ;; or element.
4153 "Return ordinal number of an element or object.
4155 ELEMENT is the element or object considered. INFO is the plist
4156 used as a communication channel.
4158 Optional argument TYPES, when non-nil, is a list of element or
4159 object types, as symbols, that should also be counted in.
4160 Otherwise, only provided element's type is considered.
4162 Optional argument PREDICATE is a function returning a non-nil
4163 value if the current element or object should be counted in. It
4164 accepts two arguments: the element or object being considered and
4165 the plist used as a communication channel. This allows to count
4166 only a certain type of objects (i.e. inline images).
4168 Return value is a list of numbers if ELEMENT is a headline or an
4169 item. It is nil for keywords. It represents the footnote number
4170 for footnote definitions and footnote references. If ELEMENT is
4171 a target, return the same value as if ELEMENT was the closest
4172 table, item or headline containing the target. In any other
4173 case, return the sequence number of ELEMENT among elements or
4174 objects of the same type."
4175 ;; Ordinal of a target object refer to the ordinal of the closest
4176 ;; table, item, or headline containing the object.
4180 element
4183 ;; Special case 1: A headline returns its number as a list.
4185 ;; Special case 2: An item returns its number as a list.
4189 struct
4196 ;; Increment counter until ELEMENT is found again.
4207 ;;;; For Src-Blocks
4208 ;;
4209 ;; `org-export-get-loc' counts number of code lines accumulated in
4210 ;; src-block or example-block elements with a "+n" switch until
4211 ;; a given element, excluded. Note: "-n" switches reset that count.
4212 ;;
4213 ;; `org-export-unravel-code' extracts source code (along with a code
4214 ;; references alist) from an `element-block' or `src-block' type
4215 ;; element.
4216 ;;
4217 ;; `org-export-format-code' applies a formatting function to each line
4218 ;; of code, providing relative line number and code reference when
4219 ;; appropriate. Since it doesn't access the original element from
4220 ;; which the source code is coming, it expects from the code calling
4221 ;; it to know if lines should be numbered and if code references
4222 ;; should appear.
4223 ;;
4224 ;; Eventually, `org-export-format-code-default' is a higher-level
4225 ;; function (it makes use of the two previous functions) which handles
4226 ;; line numbering and code references inclusion, and returns source
4227 ;; code in a format suitable for plain text or verbatim output.
4230 "Return accumulated lines of code up to ELEMENT.
4232 INFO is the plist used as a communication channel.
4234 ELEMENT is excluded from count."
4240 ;; ELEMENT is reached: Quit the loop.
4242 ;; Only count lines from src-block and example-block elements
4243 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4247 ;; Accumulate locs or reset them.
4251 ;; Return nil to stay in the loop.
4252 nil)))
4254 ;; Return value.
4255 loc))
4258 "Clean source code and extract references out of it.
4260 ELEMENT has either a `src-block' an `example-block' type.
4262 Return a cons cell whose CAR is the source code, cleaned from any
4263 reference, protective commas and spurious indentation, and CDR is
4264 an alist between relative line number (integer) and name of code
4265 reference on that line (string)."
4268 ;; Get code and clean it. Remove blank lines at its
4269 ;; beginning and end.
4276 value
4278 ;; Get format used for references.
4281 org-coderef-label-format)))
4282 ;; Build a regexp matching a loc with a reference.
4287 ;; Return value.
4289 ;; Code with references removed.
4295 ;; Ref line: remove ref, and signal its position in REFS.
4299 ;; Reference alist.
4300 refs)))
4303 "Format CODE by applying FUN line-wise and return it.
4305 CODE is a string representing the code to format. FUN is
4306 a function. It must accept three arguments: a line of
4307 code (string), the current line number (integer) or nil and the
4308 reference associated to the current line (string) or nil.
4310 Optional argument NUM-LINES can be an integer representing the
4311 number of code lines accumulated until the current code. Line
4312 numbers passed to FUN will take it into account. If it is nil,
4313 FUN's second argument will always be nil. This number can be
4314 obtained with `org-export-get-loc' function.
4316 Optional argument REF-ALIST can be an alist between relative line
4317 number (i.e. ignoring NUM-LINES) and the name of the code
4318 reference on it. If it is nil, FUN's third argument will always
4319 be nil. It can be obtained through the use of
4320 `org-export-unravel-code' function."
4332 "Return source code from ELEMENT, formatted in a standard way.
4334 ELEMENT is either a `src-block' or `example-block' element. INFO
4335 is a plist used as a communication channel.
4337 This function takes care of line numbering and code references
4338 inclusion. Line numbers, when applicable, appear at the
4339 beginning of the line, separated from the code by two white
4340 spaces. Code references, on the other hand, appear flushed to
4341 the right, separated by six white spaces from the widest line of
4342 code."
4343 ;; Extract code and references.
4350 ;; Handle line numbering.
4359 ;; Prepare references display, if required. Any reference
4360 ;; should start six columns after the widest line of code,
4361 ;; wrapped with parenthesis.
4366 code
4370 number-str
4371 loc
4377 num-start refs)))))
4380 ;;;; For Tables
4381 ;;
4382 ;; `org-export-table-has-special-column-p' and and
4383 ;; `org-export-table-row-is-special-p' are predicates used to look for
4384 ;; meta-information about the table structure.
4385 ;;
4386 ;; `org-table-has-header-p' tells when the rows before the first rule
4387 ;; should be considered as table's header.
4388 ;;
4389 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4390 ;; and `org-export-table-cell-borders' extract information from
4391 ;; a table-cell element.
4392 ;;
4393 ;; `org-export-table-dimensions' gives the number on rows and columns
4394 ;; in the table, ignoring horizontal rules and special columns.
4395 ;; `org-export-table-cell-address', given a table-cell object, returns
4396 ;; the absolute address of a cell. On the other hand,
4397 ;; `org-export-get-table-cell-at' does the contrary.
4398 ;;
4399 ;; `org-export-table-cell-starts-colgroup-p',
4400 ;; `org-export-table-cell-ends-colgroup-p',
4401 ;; `org-export-table-row-starts-rowgroup-p',
4402 ;; `org-export-table-row-ends-rowgroup-p',
4403 ;; `org-export-table-row-starts-header-p',
4404 ;; `org-export-table-row-ends-header-p' and
4405 ;; `org-export-table-row-in-header-p' indicate position of current row
4406 ;; or cell within the table.
4409 "Non-nil when TABLE has a special column.
4410 All special columns will be ignored during export."
4411 ;; The table has a special column when every first cell of every row
4412 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4413 ;; "*" "_" and "^". Though, do not consider a first row containing
4414 ;; only empty cells as special.
4430 "Non-nil when TABLE has a header.
4432 INFO is a plist used as a communication channel.
4434 A table has a header when it contains at least two row groups."
4443 table
4454 cache)))))
4457 "Non-nil if TABLE-ROW is considered special.
4459 INFO is a plist used as the communication channel.
4461 All special rows will be ignored during export."
4465 ;; A row is special either when...
4467 ;; ... it starts with a field only containing "/",
4469 ;; ... the table contains a special column and the row start
4470 ;; with a marking character among, "^", "_", "$" or "!",
4474 ;; ... it contains only alignment cookies and empty cells.
4480 ;; Since VALUE is a secondary string, the following
4481 ;; checks avoid expanding it with `org-export-data'.
4493 "Return TABLE-ROW's group number, as an integer.
4495 INFO is a plist used as the communication channel.
4497 Return value is the group number, as an integer, or nil for
4498 special rows and rows separators. First group is also table's
4499 header."
4517 "Return TABLE-CELL contents width.
4519 INFO is a plist used as the communication channel.
4521 Return value is the width given by the last width cookie in the
4522 same column as TABLE-CELL, or nil."
4541 ;; In a special row, try to find a width cookie at COLUMN.
4545 ;; The following checks avoid expanding unnecessarily
4546 ;; the cell with `org-export-data'.
4556 "Return TABLE-CELL contents alignment.
4558 INFO is a plist used as the communication channel.
4560 Return alignment as specified by the last alignment cookie in the
4561 same column as TABLE-CELL. If no such cookie is found, a default
4562 alignment value will be deduced from fraction of numbers in the
4563 column (see `org-table-number-fraction' for more information).
4564 Possible values are `left', `right' and `center'."
4565 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4582 cookie-align
4583 previous-cell-number-p)
4586 ;; In a special row, try to find an alignment cookie at
4587 ;; COLUMN.
4591 ;; Since VALUE is a secondary string, the following
4592 ;; checks avoid useless expansion through
4593 ;; `org-export-data'.
4601 ;; Ignore table rules.
4603 ;; In a standard row, check if cell's contents are
4604 ;; expressing some kind of number. Increase NUMBER-CELLS
4605 ;; accordingly. Though, don't bother if an alignment
4606 ;; cookie has already defined cell's alignment.
4611 info)))
4613 ;; Treat an empty cell as a number if it follows
4614 ;; a number.
4620 ;; Return value. Alignment specified by cookies has
4621 ;; precedence over alignment deduced from cell's contents.
4623 column
4628 org-table-number-fraction)
4633 "Return TABLE-CELL borders.
4635 INFO is a plist used as a communication channel.
4637 Return value is a list of symbols, or nil. Possible values are:
4638 `top', `bottom', `above', `below', `left' and `right'. Note:
4639 `top' (resp. `bottom') only happen for a cell in the first
4640 row (resp. last row) of the table, ignoring table rules, if any.
4642 Returned borders ignore special rows."
4645 borders)
4646 ;; Top/above border? TABLE-CELL has a border above when a rule
4647 ;; used to demarcate row groups can be found above. Hence,
4648 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4649 ;; another regular row has to be found above that rule.
4658 ;; Look at every row before the current one.
4660 ;; No rule above, or rule found starts the table (ignoring any
4661 ;; special row): TABLE-CELL is at the top of the table.
4664 ;; Bottom/below border? TABLE-CELL has a border below when next
4665 ;; non-regular row below is a rule.
4674 ;; Look at every row after the current one.
4676 ;; No rule below, or rule found ends the table (modulo some
4677 ;; special row): TABLE-CELL is at the bottom of the table.
4680 ;; Right/left borders? They can only be specified by column
4681 ;; groups. Column groups are defined in a row starting with "/".
4682 ;; Also a column groups row only contains "<", "<>", ">" or blank
4683 ;; cells.
4700 ;; There's a left border when previous cell, if
4701 ;; any, ends a group, or current one starts one.
4707 ;; There's a right border when next cell, if any,
4708 ;; starts a group, or current one ends one.
4715 ;; Table rows are read in reverse order so last column groups
4716 ;; row has precedence over any previous one.
4718 ;; Return value.
4719 borders))
4722 "Non-nil when TABLE-CELL is at the beginning of a column group.
4723 INFO is a plist used as a communication channel."
4724 ;; A cell starts a column group either when it is at the beginning
4725 ;; of a row (or after the special column, if any) or when it has
4726 ;; a left border.
4729 table-cell)
4733 "Non-nil when TABLE-CELL is at the end of a column group.
4734 INFO is a plist used as a communication channel."
4735 ;; A cell ends a column group either when it is at the end of a row
4736 ;; or when it has a right border.
4739 table-cell)
4743 "Non-nil when TABLE-ROW is at the beginning of a row group.
4744 INFO is a plist used as a communication channel."
4752 "Non-nil when TABLE-ROW is at the end of a row group.
4753 INFO is a plist used as a communication channel."
4761 "Non-nil when TABLE-ROW is located within table's header.
4762 INFO is a plist used as a communication channel. Always return
4763 nil for special rows and rows separators."
4769 "Non-nil when TABLE-ROW is the first table header's row.
4770 INFO is a plist used as a communication channel."
4775 "Non-nil when TABLE-ROW is the last table header's row.
4776 INFO is a plist used as a communication channel."
4781 "Return TABLE-ROW number.
4782 INFO is a plist used as a communication channel. Return value is
4783 zero-based and ignores separators. The function returns nil for
4784 special columns and separators."
4796 "Return TABLE dimensions.
4798 INFO is a plist used as a communication channel.
4800 Return value is a CONS like (ROWS . COLUMNS) where
4801 ROWS (resp. COLUMNS) is the number of exportable
4802 rows (resp. columns)."
4804 ;; Set number of rows, and extract first one.
4810 ;; Set number of columns.
4812 ;; Return value.
4816 "Return address of a regular TABLE-CELL object.
4818 TABLE-CELL is the cell considered. INFO is a plist used as
4819 a communication channel.
4821 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4822 zero-based index. Only exportable cells are considered. The
4823 function returns nil for other cells."
4835 "Return regular table-cell object at ADDRESS in TABLE.
4837 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4838 zero-based index. TABLE is a table type element. INFO is
4839 a plist used as a communication channel.
4841 If no table-cell, among exportable cells, is found at ADDRESS,
4842 return nil."
4845 ;; Row at (car address) or nil.
4853 'table-cell
4860 ;;;; For Tables Of Contents
4861 ;;
4862 ;; `org-export-collect-headlines' builds a list of all exportable
4863 ;; headline elements, maybe limited to a certain depth. One can then
4864 ;; easily parse it and transcode it.
4865 ;;
4866 ;; Building lists of tables, figures or listings is quite similar.
4867 ;; Once the generic function `org-export-collect-elements' is defined,
4868 ;; `org-export-collect-tables', `org-export-collect-figures' and
4869 ;; `org-export-collect-listings' can be derived from it.
4872 "Collect headlines in order to build a table of contents.
4874 INFO is a plist used as a communication channel.
4876 When optional argument N is an integer, it specifies the depth of
4877 the table of contents. Otherwise, it is set to the value of the
4878 last headline level. See `org-export-headline-levels' for more
4879 information.
4881 Optional argument SCOPE, when non-nil, is an element. If it is
4882 a headline, only children of SCOPE are collected. Otherwise,
4883 collect children of the headline containing provided element. If
4884 there is no such headline, collect all headlines. In any case,
4885 argument N becomes relative to the level of that headline.
4887 Return a list of all exportable headlines as parsed elements.
4888 Footnote sections are ignored."
4897 limit))))
4903 info)))
4906 "Collect referenceable elements of a determined type.
4908 TYPE can be a symbol or a list of symbols specifying element
4909 types to search. Only elements with a caption are collected.
4911 INFO is a plist used as a communication channel.
4913 When non-nil, optional argument PREDICATE is a function accepting
4914 one argument, an element of type TYPE. It returns a non-nil
4915 value when that element should be collected.
4917 Return a list of all elements found, in order of appearance."
4922 element))
4923 info))
4926 "Build a list of tables.
4927 INFO is a plist used as a communication channel.
4929 Return a list of table elements with a caption."
4933 "Build a list of figures.
4935 INFO is a plist used as a communication channel. PREDICATE is
4936 a function which accepts one argument: a paragraph element and
4937 whose return value is non-nil when that element should be
4938 collected.
4940 A figure is a paragraph type element, with a caption, verifying
4942 a vague concept that may depend on back-end.
4944 Return a list of elements recognized as figures."
4948 "Build a list of src blocks.
4950 INFO is a plist used as a communication channel.
4952 Return a list of src-block elements with a caption."
4956 ;;;; Smart Quotes
4957 ;;
4958 ;; The main function for the smart quotes sub-system is
4959 ;; `org-export-activate-smart-quotes', which replaces every quote in
4960 ;; a given string from the parse tree with its "smart" counterpart.
4961 ;;
4962 ;; Dictionary for smart quotes is stored in
4963 ;; `org-export-smart-quotes-alist'.
4964 ;;
4965 ;; Internally, regexps matching potential smart quotes (checks at
4966 ;; string boundaries are also necessary) are defined in
4967 ;; `org-export-smart-quotes-regexps'.
4971 ;; one may use: »...«, "...", ›...‹, or '...'.
4972 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4973 ;; LaTeX quotes require Babel!
5018 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5027 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5036 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5045 ;; 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
5046 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5057 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5063 )
5064 "Smart quotes translations.
5066 Alist whose CAR is a language string and CDR is an alist with
5067 quote type as key and a plist associating various encodings to
5068 their translation as value.
5070 A quote type can be any symbol among `opening-double-quote',
5071 `closing-double-quote', `opening-single-quote',
5072 `closing-single-quote' and `apostrophe'.
5074 Valid encodings include `:utf-8', `:html', `:latex' and
5075 `:texinfo'.
5081 ;; Possible opening quote at beginning of string.
5083 ;; Possible closing quote at beginning of string.
5085 ;; Possible apostrophe at beginning of string.
5087 ;; Opening single and double quotes.
5089 ;; Closing single and double quotes.
5091 ;; Apostrophe.
5093 ;; Possible opening quote at end of string.
5095 ;; Possible closing quote at end of string.
5097 ;; Possible apostrophe at end of string.
5099 "List of regexps matching a quote or an apostrophe.
5105 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5106 `:utf-8'. INFO is a plist used as a communication channel.
5108 The function has to retrieve information about string
5109 surroundings in parse tree. It can only happen with an
5110 unmodified string. Thus, if S has already been through another
5111 process, a non-nil ORIGINAL optional argument will provide that
5112 original string.
5114 Return the new string."
5117 ;; Try to be flexible when computing number of blanks
5118 ;; before object. The previous object may be a string
5119 ;; introduced by the back-end and not completely parsed.
5122 ;; A string with missing `:post-blank'
5123 ;; property.
5127 ;; Fallback value.
5132 ;; Return smart quote associated to a give quote Q, as
5133 ;; a string. TYPE is a symbol among `open', `close' and
5134 ;; `apostrophe'.
5144 org-export-smart-quotes-alist))))
5145 encoding)
5146 q)))))
5148 ;; Only a quote: no regexp can match. We have to check both
5149 ;; sides and decide what to do.
5157 ;; 1. Replace quote character at the beginning of S.
5159 ;; Apostrophe?
5165 ;; Closing quote?
5171 ;; Opening quote?
5177 ;; 2. Replace quotes in the middle of the string.
5179 ;; Opening quotes.
5185 ;; Closing quotes.
5191 ;; Apostrophes.
5196 ;; 3. Replace quote character at the end of S.
5198 ;; Apostrophe?
5203 ;; Closing quote?
5209 ;; Opening quote?
5214 ;; Return string with smart quotes.
5215 s))))
5217 ;;;; Topology
5218 ;;
5219 ;; Here are various functions to retrieve information about the
5220 ;; neighborhood of a given element or object. Neighbors of interest
5221 ;; are direct parent (`org-export-get-parent'), parent headline
5222 ;; (`org-export-get-parent-headline'), first element containing an
5223 ;; object, (`org-export-get-parent-element'), parent table
5224 ;; (`org-export-get-parent-table'), previous element or object
5225 ;; (`org-export-get-previous-element') and next element or object
5226 ;; (`org-export-get-next-element').
5228 ;; defsubst org-export-get-parent must be defined before first use
5234 "Return BLOB parent headline or nil.
5235 BLOB is the element or object being considered."
5239 "Return first element containing OBJECT or nil.
5240 OBJECT is the object to consider."
5244 "Return OBJECT parent table or nil.
5245 OBJECT is either a `table-cell' or `table-element' type object."
5249 "Return previous element or object.
5251 BLOB is an element or object. INFO is a plist used as
5252 a communication channel. Return previous exportable element or
5253 object, a string, or nil.
5255 When optional argument N is a positive integer, return a list
5256 containing up to N siblings before BLOB, from farthest to
5257 closest. With any other non-nil value, return a list containing
5258 all of them."
5264 prev)
5274 "Return next element or object.
5276 BLOB is an element or object. INFO is a plist used as
5277 a communication channel. Return next exportable element or
5278 object, a string, or nil.
5280 When optional argument N is a positive integer, return a list
5281 containing up to N siblings after BLOB, from closest to farthest.
5282 With any other non-nil value, return a list containing all of
5283 them."
5290 next)
5300 ;;;; Translation
5301 ;;
5302 ;; `org-export-translate' translates a string according to the language
5303 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5304 ;; the dictionary used for the translation.
5352 ("ru" :html "(Продолжение следует)"
5455 ("ru" :html "Список распечаток"
5469 ("ru" :html "Список таблиц"
5561 ("ru" :html "Неизвестная ссылка"
5564 "Dictionary for export engine.
5566 Alist whose car is the string to translate and cdr is an alist
5567 whose car is the language string and cdr is a plist whose
5568 properties are possible charsets and values translated terms.
5570 It is used as a database for `org-export-translate'. Since this
5571 function returns the string as-is if no translation was found,
5572 the variable only needs to record values different from the
5576 "Translate string S according to language specification.
5578 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5579 and `:utf-8'. INFO is a plist used as a communication channel.
5581 Translation depends on `:language' property. Return the
5582 translated string. If no translation is found, try to fall back
5583 to `:default' encoding. If it fails, return S."
5589 s)))
5592 \f
5593 ;;; Asynchronous Export
5594 ;;
5595 ;; `org-export-async-start' is the entry point for asynchronous
5596 ;; export. It recreates current buffer (including visibility,
5597 ;; narrowing and visited file) in an external Emacs process, and
5598 ;; evaluates a command there. It then applies a function on the
5599 ;; returned results in the current process.
5600 ;;
5601 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5602 ;; allow to export to a buffer or a file, asynchronously or not.
5603 ;;
5604 ;; `org-export-output-file-name' is an auxiliary function meant to be
5605 ;; used with `org-export-to-file'. With a given extension, it tries
5606 ;; to provide a canonical file name to write export output to.
5607 ;;
5608 ;; Asynchronously generated results are never displayed directly.
5609 ;; Instead, they are stored in `org-export-stack-contents'. They can
5610 ;; then be retrieved by calling `org-export-stack'.
5611 ;;
5612 ;; Export Stack is viewed through a dedicated major mode
5613 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5614 ;;`org-export-stack-delete', `org-export-stack-view' and
5615 ;;`org-export-stack-clear'.
5616 ;;
5617 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5618 ;; It should be used whenever `org-export-async-start' is called.
5621 "Call function FUN on the results returned by BODY evaluation.
5623 FUN is an anonymous function of one argument. BODY evaluation
5624 happens in an asynchronous process, from a buffer which is an
5625 exact copy of the current one.
5627 Use `org-export-add-to-stack' in FUN in order to register results
5628 in the stack.
5630 This is a low level function. See also `org-export-to-buffer'
5631 and `org-export-to-file' for more specialized functions."
5634 ;; Write the full sexp evaluating BODY in a copy of the current
5635 ;; buffer to a temporary file, as it may be too long for program
5636 ;; args in `start-process'.
5643 ;; Null characters (from variable values) are inserted
5644 ;; within the file. As a consequence, coding system for
5645 ;; buffer contents will not be recognized properly. So,
5646 ;; we make sure it is the same as the one used to display
5647 ;; the original buffer.
5649 ,coding
5652 ;; Ignore `kill-emacs-hook' and code evaluation
5653 ;; queries from Babel as we need a truly
5654 ;; non-interactive process.
5656 org-babel-confirm-evaluate-answer-no t)
5657 ;; Initialize export framework.
5659 ;; Re-create current buffer there.
5662 ;; Sexp to evaluate in the buffer.
5664 ;; Start external process.
5667 (,process
5669 #'start-process
5672 ,proc-buffer
5679 ;; Register running process in stack.
5681 ;; Set-up sentinel in order to catch results.
5684 ,process
5706 ;;;###autoload
5709 &optional async subtreep visible-only body-only ext-plist
5710 post-process)
5711 "Call `org-export-as' with output to a specified buffer.
5713 BACKEND is either an export back-end, as returned by, e.g.,
5714 `org-export-create-backend', or a symbol referring to
5715 a registered back-end.
5717 BUFFER is the name of the output buffer. If it already exists,
5718 it will be erased first, otherwise, it will be created.
5720 A non-nil optional argument ASYNC means the process should happen
5721 asynchronously. The resulting buffer should then be accessible
5722 through the `org-export-stack' interface. When ASYNC is nil, the
5723 buffer is displayed if `org-export-show-temporary-export-buffer'
5724 is non-nil.
5726 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5727 EXT-PLIST are similar to those used in `org-export-as', which
5728 see.
5730 Optional argument POST-PROCESS is a function which should accept
5731 no argument. It is always called within the current process,
5732 from BUFFER, with point at its beginning. Export back-ends can
5733 use it to set a major mode there, e.g,
5735 \(defun org-latex-export-as-latex
5736 \(&optional async subtreep visible-only body-only ext-plist)
5737 \(interactive)
5739 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5741 This function returns BUFFER."
5769 buffer)))
5771 ;;;###autoload
5774 post-process)
5775 "Call `org-export-as' with output to a specified file.
5777 BACKEND is either an export back-end, as returned by, e.g.,
5778 `org-export-create-backend', or a symbol referring to
5779 a registered back-end. FILE is the name of the output file, as
5780 a string.
5782 A non-nil optional argument ASYNC means the process should happen
5783 asynchronously. The resulting buffer will then be accessible
5784 through the `org-export-stack' interface.
5786 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5787 EXT-PLIST are similar to those used in `org-export-as', which
5788 see.
5790 Optional argument POST-PROCESS is called with FILE as its
5791 argument and happens asynchronously when ASYNC is non-nil. It
5792 has to return a file name, or nil. Export back-ends can use this
5793 to send the output file through additional processing, e.g,
5795 \(defun org-latex-export-to-latex
5796 \(&optional async subtreep visible-only body-only ext-plist)
5797 \(interactive)
5799 \(org-export-to-file 'latex outfile
5800 async subtreep visible-only body-only ext-plist
5801 \(lambda (file) (org-latex-compile file)))
5803 The function returns either a file name returned by POST-PROCESS,
5804 or FILE."
5823 backend subtreep visible-only body-only ext-plist)))
5830 ;; Get proper return value.
5832 file))))))
5835 "Return output file's name according to buffer specifications.
5837 EXTENSION is a string representing the output file extension,
5838 with the leading dot.
5840 With a non-nil optional argument SUBTREEP, try to determine
5842 of subtree at point.
5844 When optional argument PUB-DIR is set, use it as the publishing
5845 directory.
5847 When optional argument VISIBLE-ONLY is non-nil, don't export
5848 contents of hidden elements.
5850 Return file name as a string."
5853 ;; File name may come from EXPORT_FILE_NAME subtree
5854 ;; property, assuming point is at beginning of said
5855 ;; sub-tree.
5862 ;; File name may be extracted from buffer's associated
5863 ;; file, if any.
5865 ;; Can't determine file name on our own: Ask user.
5869 "Output file: " pub-dir nil nil nil
5873 ;; Build file name. Enforce EXTENSION over whatever user
5874 ;; may have come up with. PUB-DIR, if defined, always has
5875 ;; precedence over any provided path.
5880 extension))
5883 ;; If writing to OUTPUT-FILE would overwrite original file, append
5884 ;; EXTENSION another time to final name.
5887 output-file)))
5890 "Add a new result to export stack if not present already.
5892 SOURCE is a buffer or a file name containing export results.
5893 BACKEND is a symbol representing export back-end used to generate
5894 it.
5896 Entries already pointing to SOURCE and unavailable entries are
5897 removed beforehand. Return the new stack."
5903 "Menu for asynchronous export results and running processes."
5913 "Return source from export results at point in stack."
5920 source
5921 ;; SOURCE is not consistent with current line. The stack
5922 ;; view is outdated.
5926 "Remove all entries from export stack."
5931 "Refresh the asynchronous export stack.
5932 DUMMY is ignored. Unavailable sources are removed from the list.
5933 Return the new stack."
5943 ;; Back-end.
5945 ;; Age.
5948 ;; Compute age of the results.
5950 "%4h:%.2m "
5952 ;; Source.
5957 ;; Clear stack from exited processes, dead buffers or
5958 ;; non-existent files.
5970 "Remove export results at point from stack.
5971 If optional argument SOURCE is non-nil, remove it instead."
5976 org-export-stack-contents))))
5979 "View export results at point in stack.
5980 With an optional prefix argument IN-EMACS, force viewing files
5981 within Emacs."
5995 (define-key km "p" 'previous-line)
5996 (define-key km "\C-p" 'previous-line)
5997 (define-key km "\C-?" 'previous-line)
5998 (define-key km [up] 'previous-line)
5999 (define-key km "C" 'org-export-stack-clear)
6000 (define-key km "v" 'org-export-stack-view)
6001 (define-key km (kbd "RET") 'org-export-stack-view)
6002 (define-key km "d" 'org-export-stack-remove)
6003 km)
6004 "Keymap for Org Export Stack.")
6006 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6007 "Mode for displaying asynchronous export stack.
6010 stack.
6012 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6013 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6014 stack completely.
6016 Removing entries in an Org Export Stack buffer doesn't affect
6017 files or buffers, only the display.
6020 (abbrev-mode 0)
6021 (auto-fill-mode 0)
6022 (setq buffer-read-only t
6023 buffer-undo-list t
6024 truncate-lines t
6025 header-line-format
6026 '(:eval
6027 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6028 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6029 (set (make-local-variable 'revert-buffer-function)
6030 'org-export-stack-refresh))
6033 \f
6034 ;;; The Dispatcher
6035 ;;
6036 ;; `org-export-dispatch' is the standard interactive way to start an
6037 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6038 ;; for its interface, which, in turn, delegates response to key
6039 ;; pressed to `org-export--dispatch-action'.
6041 ;;;###autoload
6042 (defun org-export-dispatch (&optional arg)
6043 "Export dispatcher for Org mode.
6045 It provides an access to common export related tasks in a buffer.
6046 Its interface comes in two flavors: standard and expert.
6048 While both share the same set of bindings, only the former
6049 displays the valid keys associations in a dedicated buffer.
6050 Scrolling (resp. line-wise motion) in this buffer is done with
6051 SPC and DEL (resp. C-n and C-p) keys.
6053 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6054 flavor or the other.
6057 of options used back then, on the current buffer.
6059 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6060 (interactive "P")
6061 (let* ((input
6062 (cond ((equal arg '(16)) '(stack))
6063 ((and arg org-export-dispatch-last-action))
6064 (t (save-window-excursion
6065 (unwind-protect
6066 (progn
6067 ;; Remember where we are
6068 (move-marker org-export-dispatch-last-position
6069 (point)
6070 (org-base-buffer (current-buffer)))
6071 ;; Get and store an export command
6072 (setq org-export-dispatch-last-action
6073 (org-export--dispatch-ui
6074 (list org-export-initial-scope
6075 (and org-export-in-background 'async))
6076 nil
6077 org-export-dispatch-use-expert-ui)))
6078 (and (get-buffer "*Org Export Dispatcher*")
6079 (kill-buffer "*Org Export Dispatcher*")))))))
6080 (action (car input))
6081 (optns (cdr input)))
6082 (unless (memq 'subtree optns)
6083 (move-marker org-export-dispatch-last-position nil))
6084 (case action
6085 ;; First handle special hard-coded actions.
6086 (template (org-export-insert-default-template nil optns))
6087 (stack (org-export-stack))
6088 (publish-current-file
6089 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6090 (publish-current-project
6091 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6092 (publish-choose-project
6093 (org-publish (assoc (org-icompleting-read
6094 "Publish project: "
6095 org-publish-project-alist nil t)
6096 org-publish-project-alist)
6097 (memq 'force optns)
6098 (memq 'async optns)))
6099 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6100 (otherwise
6101 (save-excursion
6102 (when arg
6103 ;; Repeating command, maybe move cursor to restore subtree
6104 ;; context.
6105 (if (eq (marker-buffer org-export-dispatch-last-position)
6106 (org-base-buffer (current-buffer)))
6107 (goto-char org-export-dispatch-last-position)
6108 ;; We are in a different buffer, forget position.
6109 (move-marker org-export-dispatch-last-position nil)))
6110 (funcall action
6111 ;; Return a symbol instead of a list to ease
6112 ;; asynchronous export macro use.
6113 (and (memq 'async optns) t)
6114 (and (memq 'subtree optns) t)
6115 (and (memq 'visible optns) t)
6116 (and (memq 'body optns) t)))))))
6118 (defun org-export--dispatch-ui (options first-key expertp)
6119 "Handle interface for `org-export-dispatch'.
6121 OPTIONS is a list containing current interactive options set for
6122 export. It can contain any of the following symbols:
6123 `body' toggles a body-only export
6124 `subtree' restricts export to current subtree
6125 `visible' restricts export to visible part of buffer.
6126 `force' force publishing files.
6127 `async' use asynchronous export process
6129 FIRST-KEY is the key pressed to select the first level menu. It
6130 is nil when this menu hasn't been selected yet.
6132 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6133 buffer is provided, but indications about currently active
6134 options are given in the prompt. Moreover, \[?] allows to switch
6135 back to standard interface."
6136 (let* ((fontify-key
6137 (lambda (key &optional access-key)
6138 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6139 ;; non-nil is the required first-level key to activate
6140 ;; KEY. When its value is t, activate KEY independently
6141 ;; on the first key, if any. A nil value means KEY will
6142 ;; only be activated at first level.
6143 (if (or (eq access-key t) (eq access-key first-key))
6144 (org-propertize key 'face 'org-warning)
6145 key)))
6146 (fontify-value
6147 (lambda (value)
6148 ;; Fontify VALUE string.
6149 (org-propertize value 'face 'font-lock-variable-name-face)))
6150 ;; Prepare menu entries by extracting them from registered
6151 ;; back-ends and sorting them by access key and by ordinal,
6152 ;; if any.
6153 (entries
6154 (sort (sort (delq nil
6155 (mapcar 'org-export-backend-menu
6156 org-export--registered-backends))
6157 (lambda (a b)
6158 (let ((key-a (nth 1 a))
6159 (key-b (nth 1 b)))
6160 (cond ((and (numberp key-a) (numberp key-b))
6161 (< key-a key-b))
6162 ((numberp key-b) t)))))
6163 'car-less-than-car))
6164 ;; Compute a list of allowed keys based on the first key
6165 ;; pressed, if any. Some keys
6166 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6167 ;; available.
6168 (allowed-keys
6169 (nconc (list 2 22 19 6 1)
6170 (if (not first-key) (org-uniquify (mapcar 'car entries))
6171 (let (sub-menu)
6172 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6173 (when (eq (car entry) first-key)
6174 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6175 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6176 ((not first-key) (list ?P)))
6177 (list ?& ?#)
6178 (when expertp (list ??))
6179 (list ?q)))
6180 ;; Build the help menu for standard UI.
6181 (help
6182 (unless expertp
6183 (concat
6184 ;; Options are hard-coded.
6185 (format "[%s] Body only: %s [%s] Visible only: %s
6186 \[%s] Export scope: %s [%s] Force publishing: %s
6188 (funcall fontify-key "C-b" t)
6189 (funcall fontify-value
6190 (if (memq 'body options) "On " "Off"))
6191 (funcall fontify-key "C-v" t)
6192 (funcall fontify-value
6193 (if (memq 'visible options) "On " "Off"))
6194 (funcall fontify-key "C-s" t)
6195 (funcall fontify-value
6196 (if (memq 'subtree options) "Subtree" "Buffer "))
6197 (funcall fontify-key "C-f" t)
6198 (funcall fontify-value
6199 (if (memq 'force options) "On " "Off"))
6200 (funcall fontify-key "C-a" t)
6201 (funcall fontify-value
6202 (if (memq 'async options) "On " "Off")))
6203 ;; Display registered back-end entries. When a key
6204 ;; appears for the second time, do not create another
6205 ;; entry, but append its sub-menu to existing menu.
6206 (let (last-key)
6207 (mapconcat
6208 (lambda (entry)
6209 (let ((top-key (car entry)))
6210 (concat
6211 (unless (eq top-key last-key)
6212 (setq last-key top-key)
6214 (funcall fontify-key (char-to-string top-key))
6215 (nth 1 entry)))
6216 (let ((sub-menu (nth 2 entry)))
6217 (unless (functionp sub-menu)
6218 ;; Split sub-menu into two columns.
6219 (let ((index -1))
6220 (concat
6221 (mapconcat
6222 (lambda (sub-entry)
6223 (incf index)
6224 (format
6225 (if (zerop (mod index 2)) " [%s] %-26s"
6227 (funcall fontify-key
6228 (char-to-string (car sub-entry))
6229 top-key)
6230 (nth 1 sub-entry)))
6231 sub-menu "")
6233 entries ""))
6234 ;; Publishing menu is hard-coded.
6236 [%s] Current file [%s] Current project
6238 (funcall fontify-key "P")
6239 (funcall fontify-key "f" ?P)
6240 (funcall fontify-key "p" ?P)
6241 (funcall fontify-key "x" ?P)
6242 (funcall fontify-key "a" ?P))
6244 (funcall fontify-key "&" t)
6245 (funcall fontify-key "#" t))
6246 (format "[%s] %s"
6247 (funcall fontify-key "q" t)
6248 (if first-key "Main menu" "Exit")))))
6249 ;; Build prompts for both standard and expert UI.
6250 (standard-prompt (unless expertp "Export command: "))
6251 (expert-prompt
6252 (when expertp
6253 (format
6254 "Export command (C-%s%s%s%s%s) [%s]: "
6255 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6256 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6257 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6258 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6259 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6260 (mapconcat (lambda (k)
6261 ;; Strip control characters.
6262 (unless (< k 27) (char-to-string k)))
6263 allowed-keys "")))))
6264 ;; With expert UI, just read key with a fancy prompt. In standard
6265 ;; UI, display an intrusive help buffer.
6266 (if expertp
6267 (org-export--dispatch-action
6268 expert-prompt allowed-keys entries options first-key expertp)
6269 ;; At first call, create frame layout in order to display menu.
6270 (unless (get-buffer "*Org Export Dispatcher*")
6271 (delete-other-windows)
6272 (org-switch-to-buffer-other-window
6273 (get-buffer-create "*Org Export Dispatcher*"))
6274 (setq cursor-type nil
6275 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6276 ;; Make sure that invisible cursor will not highlight square
6277 ;; brackets.
6278 (set-syntax-table (copy-syntax-table))
6279 (modify-syntax-entry ?\[ "w"))
6280 ;; At this point, the buffer containing the menu exists and is
6281 ;; visible in the current window. So, refresh it.
6282 (with-current-buffer "*Org Export Dispatcher*"
6283 ;; Refresh help. Maintain display continuity by re-visiting
6284 ;; previous window position.
6285 (let ((pos (window-start)))
6286 (erase-buffer)
6287 (insert help)
6288 (set-window-start nil pos)))
6289 (org-fit-window-to-buffer)
6290 (org-export--dispatch-action
6291 standard-prompt allowed-keys entries options first-key expertp))))
6293 (defun org-export--dispatch-action
6294 (prompt allowed-keys entries options first-key expertp)
6295 "Read a character from command input and act accordingly.
6297 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6298 a list of characters available at a given step in the process.
6299 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6300 EXPERTP are the same as defined in `org-export--dispatch-ui',
6301 which see.
6303 Toggle export options when required. Otherwise, return value is
6304 a list with action as CAR and a list of interactive export
6305 options as CDR."
6306 (let (key)
6307 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6308 ;; C-p, SPC, DEL).
6309 (while (and (setq key (read-char-exclusive prompt))
6310 (not expertp)
6311 (memq key '(14 16 ?\s ?\d)))
6312 (case key
6313 (14 (if (not (pos-visible-in-window-p (point-max)))
6314 (ignore-errors (scroll-up 1))
6315 (message "End of buffer")
6316 (sit-for 1)))
6317 (16 (if (not (pos-visible-in-window-p (point-min)))
6318 (ignore-errors (scroll-down 1))
6319 (message "Beginning of buffer")
6320 (sit-for 1)))
6321 (?\s (if (not (pos-visible-in-window-p (point-max)))
6322 (scroll-up nil)
6323 (message "End of buffer")
6324 (sit-for 1)))
6325 (?\d (if (not (pos-visible-in-window-p (point-min)))
6326 (scroll-down nil)
6327 (message "Beginning of buffer")
6328 (sit-for 1)))))
6329 (cond
6330 ;; Ignore undefined associations.
6331 ((not (memq key allowed-keys))
6332 (ding)
6333 (unless expertp (message "Invalid key") (sit-for 1))
6334 (org-export--dispatch-ui options first-key expertp))
6335 ;; q key at first level aborts export. At second level, cancel
6336 ;; first key instead.
6337 ((eq key ?q) (if (not first-key) (error "Export aborted")
6338 (org-export--dispatch-ui options nil expertp)))
6339 ;; Help key: Switch back to standard interface if expert UI was
6340 ;; active.
6341 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6342 ;; Send request for template insertion along with export scope.
6343 ((eq key ?#) (cons 'template (memq 'subtree options)))
6344 ;; Switch to asynchronous export stack.
6345 ((eq key ?&) '(stack))
6346 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6347 ((memq key '(2 22 19 6 1))
6348 (org-export--dispatch-ui
6349 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6350 (6 'force) (1 'async))))
6351 (if (memq option options) (remq option options)
6352 (cons option options)))
6353 first-key expertp))
6354 ;; Action selected: Send key and options back to
6355 ;; `org-export-dispatch'.
6356 ((or first-key (functionp (nth 2 (assq key entries))))
6357 (cons (cond
6358 ((not first-key) (nth 2 (assq key entries)))
6359 ;; Publishing actions are hard-coded. Send a special
6360 ;; signal to `org-export-dispatch'.
6361 ((eq first-key ?P)
6362 (case key
6363 (?f 'publish-current-file)
6364 (?p 'publish-current-project)
6365 (?x 'publish-choose-project)
6366 (?a 'publish-all)))
6367 ;; Return first action associated to FIRST-KEY + KEY
6368 ;; path. Indeed, derived backends can share the same
6369 ;; FIRST-KEY.
6370 (t (catch 'found
6371 (mapc (lambda (entry)
6372 (let ((match (assq key (nth 2 entry))))
6373 (when match (throw 'found (nth 2 match)))))
6374 (member (assq first-key entries) entries)))))
6375 options))
6376 ;; Otherwise, enter sub-menu.
6377 (t (org-export--dispatch-ui options key expertp)))))
6381 (provide 'ox)
6383 ;; Local variables:
6384 ;; generated-autoload-file: "org-loaddefs.el"
6385 ;; End:
6387 ;;; ox.el ends here