| blob | 2d03fde049467dd081e1c476236039e0a6c1cb9c |
1 ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 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:
91 \f
92 ;;; Internal Variables
93 ;;
94 ;; Among internal variables, the most important is
95 ;; `org-export-options-alist'. This variable define the global export
96 ;; options, shared between every exporter, and how they are acquired.
142 "Alist between export properties and ways to set them.
144 The key of the alist is the property name, and the value 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.
163 `parse' Parse value as a list of strings and Org objects,
164 which can then be transcoded with, e.g.,
165 `org-export-data'. It implies `space' behavior.
167 Values set through KEYWORD and OPTION have precedence over
168 DEFAULT.
170 All these properties should be back-end agnostic. Back-end
171 specific properties are set through `org-export-define-backend'.
175 "List of in-buffer keywords that require special treatment.
176 These keywords are not directly associated to a property. The
177 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
263 org-element--cache org-element--cache-objects org-element--cache-sync-keys
264 org-element--cache-sync-requests org-element--cache-sync-timer)
265 "List of variables not copied through upon buffer duplication.
266 Export process takes place on a copy of the original buffer.
267 When this copy is created, all Org related local variables not in
268 this list are copied to the new buffer. Variables with an
272 "Non-nil means asynchronous export process should leave data behind.
276 located in `temporary-file-directory'.
278 When non-nil, it will also set `debug-on-error' to a non-nil
282 "Record asynchronously generated export results and processes.
283 This is an alist: its CAR is the source of the
284 result (destination file or buffer for a finished process,
285 original buffer for a running one) and its CDR is a list
286 containing the back-end used, as a symbol, and either a process
287 or the time at which it finished. It is used to build the menu
291 "List of backends currently available in the exporter.
292 This variable is set with `org-export-define-backend' and
296 "Last command called from the dispatcher.
297 The value should be a list. Its CAR is the action, as a symbol,
301 "The position where the last export command was created using the dispatcher.
302 This marker will be used with `C-u C-c C-e' to make sure export repetition
305 ;; For compatibility with Org < 8
307 "Name, if any, of the back-end used during an export process.
309 Its value is a symbol such as `html', `latex', `ascii', or nil if
310 the back-end is anonymous (see `org-export-create-backend') or if
311 there is no export process in progress.
313 It can be used to teach Babel blocks how to act differently
317 \f
318 ;;; User-configurable Variables
319 ;;
320 ;; Configuration for the masses.
321 ;;
322 ;; They should never be accessed directly, as their value is to be
323 ;; stored in a property list (cf. `org-export-options-alist').
324 ;; Back-ends will read their value from there instead.
327 "Options for exporting Org mode files."
332 "General options for export engine."
337 "Whether sub-trees with the ARCHIVE tag should be exported.
339 This can have three different values:
340 nil Do not export, pretend this tree is not present.
341 t Do export the entire tree.
342 `headline' Only export the headline, but skip the tree below it.
344 This option can also be set with the OPTIONS keyword,
354 "Non-nil means insert author name into the exported file.
355 This option can also be set with the OPTIONS keyword,
362 "Non-nil means export CLOCK keywords.
363 This option can also be set with the OPTIONS keyword,
370 "Non-nil means the postamble should contain a creator sentence.
372 The sentence can be set in `org-export-creator-string', which
373 see.
375 This option can also be set with the OPTIONS keyword, e.g.,
384 "Non-nil means insert date in the exported document.
385 This option can also be set with the OPTIONS keyword,
392 "Time-stamp format string to use for DATE keyword.
394 The format string, when specified, only applies if date consists
395 in a single time-stamp. Otherwise its value will be ignored.
397 See `format-time-string' for details on how to build this
398 string."
407 emacs-version
409 "Information about the creator of the document.
410 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
447 "Non-nil means insert author email into the exported file.
448 This option can also be set with the OPTIONS keyword,
455 "Non-nil means interpret *word*, /word/, _word_ and +word+.
457 If the export target supports emphasizing text, the word will be
458 typeset in bold, italic, with an underline or strike-through,
459 respectively.
461 This option can also be set with the OPTIONS keyword,
468 "Tags that exclude a tree from export.
470 All trees carrying any of these tags will be excluded from
471 export. This is without condition, so even subtrees inside that
472 carry one of the `org-export-select-tags' will be removed.
474 This option can also be set with the EXCLUDE_TAGS keyword."
481 This option can also be set with the OPTIONS keyword,
490 "Non-nil means Org footnotes should be exported.
491 This option can also be set with the OPTIONS keyword,
498 "Non-nil means process LaTeX environments and fragments.
500 This option can also be set with the OPTIONS line,
503 nil Ignore math snippets.
504 `verbatim' Keep everything in verbatim.
505 t Allow export of math snippets."
516 "The last level which is still exported as a headline.
518 Inferior levels will usually produce itemize or enumerate lists
519 when exported, but back-end behavior may differ.
521 This option can also be set with the OPTIONS keyword,
528 "The default language for export and clocktable translations, as a string.
529 This may have an association in
530 `org-clock-clocktable-language-setup',
531 `org-export-smart-quotes-alist' and `org-export-dictionary'.
532 This option can also be set with the LANGUAGE keyword."
538 "Non-nil means preserve all line breaks when exporting.
539 This option can also be set with the OPTIONS keyword,
546 "Non-nil means interpret entities when exporting.
549 Å.
551 For a list of supported names, see the constant `org-entities'
552 and the user option `org-entities-user'.
554 This option can also be set with the OPTIONS keyword,
561 "Non-nil means inlinetasks should be exported.
562 This option can also be set with the OPTIONS keyword,
571 "Non-nil means include planning info in export.
573 Planning info is the line containing either SCHEDULED:,
574 DEADLINE:, CLOSED: time-stamps, or a combination of them.
576 This option can also be set with the OPTIONS keyword,
585 "Non-nil means include priority cookies in export.
586 This option can also be set with the OPTIONS keyword,
593 "Non-nil means export contents of properties drawers.
595 When t, all properties are exported. This may also be a list of
596 properties to export, as strings.
598 This option can also be set with the OPTIONS keyword,
612 "Non-nil means add section numbers to headlines when exporting.
614 When set to an integer n, numbering will only happen for
615 headlines whose relative level is higher or equal to n.
617 This option can also be set with the OPTIONS keyword,
624 "Tags that select a tree for export.
626 If any such tag is found in a buffer, all trees that do not carry
627 one of these tags will be ignored during export. Inside trees
628 that are selected like this, you can still deselect a subtree by
629 tagging it with one of the `org-export-exclude-tags'.
631 This option can also be set with the SELECT_TAGS keyword."
637 "Non-nil means activate smart quotes during export.
638 This option can also be set with the OPTIONS keyword,
641 When setting this to non-nil, you need to take care of
642 using the correct Babel package when exporting to LaTeX.
643 E.g., you can load Babel for french like this:
655 When this option is turned on, these strings will be exported as:
657 Org HTML LaTeX UTF-8
658 -----+----------+--------+-------
660 -- – -- –
661 --- — --- —
664 This option can also be set with the OPTIONS keyword,
671 "Non-nil means include statistics cookies in export.
672 This option can also be set with the OPTIONS keyword,
683 If you want to control how Org displays those characters, see
684 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
685 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
686 it is not anymore.
688 When this option is turned on, you can use TeX-like syntax for
689 sub- and superscripts and see them exported correctly.
691 You can also set the option with #+OPTIONS: ^:t
694 single item - so grouping with {} is normally not needed. For
695 example, the following things will be parsed as single sub- or
696 superscripts:
698 10^24 or 10^tau several digits will be considered 1 item.
699 10^-12 or 10^-tau a leading sign with digits or a word
700 x^2-y^3 will be read as x^2 - y^3, because items are
701 terminated by almost any nonword/nondigit char.
702 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
704 Still, ambiguity is possible. So when in doubt, use {} to enclose
705 the sub/superscript. If you set this variable to the symbol `{}',
706 the braces are *required* in order to trigger interpretations as
708 frequently in plain text."
719 "Non-nil means create a table of contents in exported files.
721 The TOC contains headlines with levels up
722 to`org-export-headline-levels'. When an integer, include levels
723 up to N in the toc, this may then be different from
724 `org-export-headline-levels', but it will not be allowed to be
725 larger than the number of headline levels. When nil, no table of
726 contents is made.
728 This option can also be set with the OPTIONS keyword,
739 "Non-nil means export tables.
740 This option can also be set with the OPTIONS keyword,
749 "If nil, do not export tags, just remove them from headlines.
751 If this is the symbol `not-in-toc', tags will be removed from
752 table of contents entries, but still be shown in the headlines of
753 the document.
755 This option can also be set with the OPTIONS keyword,
765 "Non-nil means include TODO items for export.
767 This may have the following values:
768 t include tasks independent of state.
769 `todo' include only tasks that are not yet done.
770 `done' include only tasks that are already done.
771 nil ignore all tasks.
772 list of keywords include tasks with these keywords.
774 This option can also be set with the OPTIONS keyword,
789 "Non-nil means print title into the exported file.
790 This option can also be set with the OPTIONS keyword,
799 "Non-nil means insert a time stamp into the exported file.
800 The time stamp shows when the file was created. This option can
807 "Non nil means allow timestamps in export.
809 It can be set to any of the following values:
810 t export all timestamps.
811 `active' export active timestamps only.
812 `inactive' export inactive timestamps only.
813 nil do not export timestamps
815 This only applies to timestamps isolated in a paragraph
816 containing only timestamps. Other timestamps are always
817 exported.
819 This option can also be set with the OPTIONS keyword, e.g.
830 "Non-nil means include TODO keywords in export.
831 When nil, remove all these keywords from the export. This option
837 "Non-nil means BIND keywords can define local variable values.
838 This is a potential security risk, which is why the default value
839 is nil. You can also allow them through local buffer variables."
846 "Non-nil means do not raise an error on broken links.
848 When this variable is non-nil, broken links are ignored, without
849 stopping the export process. If it is set to `mark', broken
850 links are marked as such in the output, with a string like
852 [BROKEN LINK: path]
854 where PATH is the un-resolvable reference.
856 This option can also be set with the OPTIONS keyword, e.g.,
867 "Alist between export snippets back-ends and exporter back-ends.
869 This variable allows providing shortcuts for export snippets.
873 HTML code while every other back-end will ignore it."
887 "Coding system for the exported file."
894 "Non-nil means pushing export output to the kill ring.
895 This variable is ignored during asynchronous export."
905 "The initial scope when exporting with `org-export-dispatch'.
906 This variable can be either set to `buffer' or `subtree'."
913 "Non-nil means show buffer after exporting to temp buffer.
914 When Org exports to a file, the buffer visiting that file is never
915 shown, but remains buried. However, when exporting to
916 a temporary buffer, that buffer is popped up in a second window.
917 When this variable is nil, the buffer remains buried also in
918 these cases."
923 "Non-nil means export and publishing commands will run in background.
924 Results from an asynchronous export are never displayed
932 "File used to initialize external export process.
934 Value must be either nil or an absolute file name. When nil, the
935 external process is launched like a regular Emacs session,
936 loading user's initialization file and any site specific
937 configuration. If a file is provided, it, and only it, is loaded
938 at start-up.
940 Therefore, using a specific configuration makes the process to
941 load faster and the export more portable."
950 "Non-nil means using a non-intrusive `org-export-dispatch'.
951 In that case, no help buffer is displayed. Though, an indicator
957 asynchronous). Also, [?] allows switching back to standard
958 mode."
965 \f
966 ;;; Defining Back-ends
967 ;;
968 ;; An export back-end is a structure with `org-export-backend' type
969 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
970 ;; and `menu' slots.
971 ;;
972 ;; At the lowest level, a back-end is created with
973 ;; `org-export-create-backend' function.
974 ;;
975 ;; A named back-end can be registered with
976 ;; `org-export-register-backend' function. A registered back-end can
977 ;; later be referred to by its name, with `org-export-get-backend'
978 ;; function. Also, such a back-end can become the parent of a derived
979 ;; back-end from which slot values will be inherited by default.
980 ;; `org-export-derived-backend-p' can check if a given back-end is
981 ;; derived from a list of back-end names.
982 ;;
983 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
984 ;; `org-export-get-all-filters' return the full alist of transcoders,
985 ;; options and filters, including those inherited from ancestors.
986 ;;
987 ;; At a higher level, `org-export-define-backend' is the standard way
988 ;; to define an export back-end. If the new back-end is similar to
989 ;; a registered back-end, `org-export-define-derived-backend' may be
990 ;; used instead.
991 ;;
992 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
993 ;; when a given back-end hasn't been registered yet.
997 name parent transcoders options filters blocks menu)
1000 "Return export back-end named after NAME.
1001 NAME is a symbol. Return nil if no such back-end is found."
1008 "Register BACKEND as a known export back-end.
1009 BACKEND is a structure with `org-export-backend' type."
1010 ;; Refuse to register an unnamed back-end.
1013 ;; Refuse to register a back-end with an unknown parent.
1017 ;; If a back-end with the same name as BACKEND is already
1018 ;; registered, replace it with BACKEND. Otherwise, simply add
1019 ;; BACKEND to the list of registered back-ends.
1025 "Signal an error if BACKEND isn't defined."
1030 "Non-nil if BACKEND is derived from one of BACKENDS.
1031 BACKEND is an export back-end, as returned by, e.g.,
1032 `org-export-create-backend', or a symbol referring to
1033 a registered back-end. BACKENDS is constituted of symbols."
1045 "Return full translation table for BACKEND.
1047 BACKEND is an export back-end, as return by, e.g,,
1048 `org-export-create-backend'. Return value is an alist where
1049 keys are element or object types, as symbols, and values are
1050 transcoders.
1052 Unlike to `org-export-backend-transcoders', this function
1053 also returns transcoders inherited from parent back-ends,
1054 if any."
1058 parent)
1063 transcoders)))
1066 "Return export options for BACKEND.
1068 BACKEND is an export back-end, as return by, e.g,,
1069 `org-export-create-backend'. See `org-export-options-alist'
1070 for the shape of the return value.
1072 Unlike to `org-export-backend-options', this function also
1073 returns options inherited from parent back-ends, if any."
1077 parent)
1081 options)))
1084 "Return complete list of filters for BACKEND.
1086 BACKEND is an export back-end, as return by, e.g,,
1087 `org-export-create-backend'. Return value is an alist where
1088 keys are symbols and values lists of functions.
1090 Unlike to `org-export-backend-filters', this function also
1091 returns filters inherited from parent back-ends, if any."
1095 parent)
1099 filters)))
1102 "Define a new back-end BACKEND.
1104 TRANSCODERS is an alist between object or element types and
1105 functions handling them.
1107 These functions should return a string without any trailing
1108 space, or nil. They must accept three arguments: the object or
1109 element itself, its contents or nil when it isn't recursive and
1110 the property list used as a communication channel.
1112 Contents, when not nil, are stripped from any global indentation
1113 \(although the relative one is preserved). They also always end
1114 with a single newline character.
1116 If, for a given type, no function is found, that element or
1117 object type will simply be ignored, along with any blank line or
1118 white space at its end. The same will happen if the function
1119 returns the nil value. If that function returns the empty
1120 string, the type will be ignored, but the blank lines or white
1121 spaces will be kept.
1123 In addition to element and object types, one function can be
1124 associated to the `template' (or `inner-template') symbol and
1125 another one to the `plain-text' symbol.
1127 The former returns the final transcoded string, and can be used
1128 to add a preamble and a postamble to document's body. It must
1129 accept two arguments: the transcoded string and the property list
1130 containing export options. A function associated to `template'
1132 A function associated to `inner-template' is always applied.
1134 The latter, when defined, is to be called on every text not
1135 recognized as an element or an object. It must accept two
1136 arguments: the text string and the information channel. It is an
1137 appropriate place to protect special chars relative to the
1138 back-end.
1140 BODY can start with pre-defined keyword arguments. The following
1141 keywords are understood:
1143 :filters-alist
1145 Alist between filters and function, or list of functions,
1146 specific to the back-end. See `org-export-filters-alist' for
1147 a list of all allowed filters. Filters defined here
1148 shouldn't make a back-end test, as it may prevent back-ends
1149 derived from this one to behave properly.
1151 :menu-entry
1153 Menu entry for the export dispatcher. It should be a list
1154 like:
1158 where :
1160 KEY is a free character selecting the back-end.
1162 DESCRIPTION-OR-ORDINAL is either a string or a number.
1164 If it is a string, is will be used to name the back-end in
1165 its menu entry. If it is a number, the following menu will
1166 be displayed as a sub-menu of the back-end with the same
1167 KEY. Also, the number will be used to determine in which
1168 order such sub-menus will appear (lowest first).
1170 ACTION-OR-MENU is either a function or an alist.
1172 If it is an action, it will be called with four
1173 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1174 BODY-ONLY. See `org-export-as' for further explanations on
1175 some of them.
1177 If it is an alist, associations should follow the
1178 pattern:
1182 where KEY, DESCRIPTION and ACTION are described above.
1184 Valid values include:
1188 or
1193 (lambda (a s v b)
1194 (if a (org-latex-export-to-pdf t s v b)
1195 (org-open-file
1196 (org-latex-export-to-pdf nil s v b)))))))
1198 or the following, which will be added to the previous
1199 sub-menu,
1205 :options-alist
1207 Alist between back-end specific properties introduced in
1208 communication channel and how their value are acquired. See
1209 `org-export-options-alist' for more information about
1210 structure of the values."
1222 :transcoders transcoders
1223 :options options
1224 :filters filters
1228 "Create a new back-end as a variant of an existing one.
1230 CHILD is the name of the derived back-end. PARENT is the name of
1231 the parent back-end.
1233 BODY can start with pre-defined keyword arguments. The following
1234 keywords are understood:
1236 :filters-alist
1238 Alist of filters that will overwrite or complete filters
1239 defined in PARENT back-end. See `org-export-filters-alist'
1240 for a list of allowed filters.
1242 :menu-entry
1244 Menu entry for the export dispatcher. See
1245 `org-export-define-backend' for more information about the
1246 expected value.
1248 :options-alist
1250 Alist of back-end specific properties that will overwrite or
1251 complete those defined in PARENT back-end. Refer to
1252 `org-export-options-alist' for more information about
1253 structure of the values.
1255 :translate-alist
1257 Alist of element and object types and transcoders that will
1258 overwrite or complete transcode table from PARENT back-end.
1259 Refer to `org-export-define-backend' for detailed information
1260 about transcoders.
1263 as a variant of `latex' back-end with a custom template function:
1268 The back-end could then be called with, for example:
1283 :parent parent
1284 :transcoders transcoders
1285 :options options
1286 :filters filters
1290 \f
1291 ;;; The Communication Channel
1292 ;;
1293 ;; During export process, every function has access to a number of
1294 ;; properties. They are of two types:
1295 ;;
1296 ;; 1. Environment options are collected once at the very beginning of
1297 ;; the process, out of the original buffer and configuration.
1298 ;; Collecting them is handled by `org-export-get-environment'
1299 ;; function.
1300 ;;
1301 ;; Most environment options are defined through the
1302 ;; `org-export-options-alist' variable.
1303 ;;
1304 ;; 2. Tree properties are extracted directly from the parsed tree,
1305 ;; just before export, by `org-export--collect-tree-properties'.
1307 ;;;; Environment Options
1308 ;;
1309 ;; Environment options encompass all parameters defined outside the
1310 ;; scope of the parsed data. They come from five sources, in
1311 ;; increasing precedence order:
1312 ;;
1313 ;; - Global variables,
1314 ;; - Buffer's attributes,
1315 ;; - Options keyword symbols,
1316 ;; - Buffer keywords,
1317 ;; - Subtree properties.
1318 ;;
1319 ;; The central internal function with regards to environment options
1320 ;; is `org-export-get-environment'. It updates global variables with
1321 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1322 ;; the different sources.
1323 ;;
1324 ;; The internal functions doing the retrieval are:
1325 ;; `org-export--get-global-options',
1326 ;; `org-export--get-buffer-attributes',
1327 ;; `org-export--parse-option-keyword',
1328 ;; `org-export--get-subtree-options' and
1329 ;; `org-export--get-inbuffer-options'
1330 ;;
1331 ;; Also, `org-export--list-bound-variables' collects bound variables
1332 ;; along with their value in order to set them as buffer local
1333 ;; variables later in the process.
1336 "Collect export options from the current buffer.
1338 Optional argument BACKEND is an export back-end, as returned by
1339 `org-export-create-backend'.
1341 When optional argument SUBTREEP is non-nil, assume the export is
1342 done against the current sub-tree.
1344 Third optional argument EXT-PLIST is a property list with
1345 external parameters overriding Org default settings, but still
1346 inferior to file-local settings."
1347 ;; First install #+BIND variables since these must be set before
1348 ;; global options are read.
1351 ;; Get and prioritize export options...
1353 ;; ... from global variables...
1355 ;; ... from an external property list...
1356 ext-plist
1357 ;; ... from in-buffer settings...
1359 ;; ... and from subtree, when appropriate.
1363 "Parse an OPTIONS line and return values as a plist.
1364 Optional argument BACKEND is an export back-end, as returned by,
1365 e.g., `org-export-create-backend'. It specifies which back-end
1366 specific items to read, if any."
1373 alist))
1374 alist))
1375 ;; Priority is given to back-end specific options.
1377 org-export-options-alist))
1387 "Get export options in subtree at point.
1388 Optional argument BACKEND is an export back-end, as returned by,
1389 e.g., `org-export-create-backend'. It specifies back-end used
1390 for export. Return options as a plist."
1391 ;; For each buffer keyword, create a headline property setting the
1392 ;; same property in communication channel. The name for the
1393 ;; property is the keyword with "EXPORT_" appended to it.
1395 ;; Make sure point is at a heading.
1398 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1399 ;; care of them right from the start.
1402 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1403 ;; headline's title (with no todo keyword, priority cookie or
1404 ;; tag) as its fallback value.
1410 ;; Look for both general keywords and back-end specific
1411 ;; options, with priority given to the latter.
1413 org-export-options-alist)))
1414 ;; Handle other keywords. Then return PLIST.
1428 property
1437 "Return current buffer export options, as a plist.
1439 Optional argument BACKEND, when non-nil, is an export back-end,
1440 as returned by, e.g., `org-export-create-backend'. It specifies
1441 which back-end specific options should also be read in the
1442 process.
1444 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1447 ;; Priority is given to back-end specific options.
1449 org-export-options-alist))
1452 org-export-special-keywords))))
1453 plist to-parse)
1456 ;; Return all properties associated to KEYWORD.
1463 ;; Recursively read keywords in buffer. FILES is
1464 ;; a list of files read so far. PLIST is the current
1465 ;; property list obtained.
1474 ;; Options in `org-export-special-keywords'.
1479 ;; Avoid circular dependencies.
1490 plist
1492 val backend))))
1496 plist
1503 ;; Options in `org-export-options-alist'.
1506 plist
1508 plist property
1509 ;; Handle value depending on specified
1510 ;; BEHAVIOR.
1515 ;; Even if `parse' implies `space'
1516 ;; behavior, we separate line with
1517 ;; "\n" so as to preserve
1518 ;; line-breaks. However, empty
1519 ;; lines are forbidden since `parse'
1520 ;; doesn't allow more than one
1521 ;; paragraph.
1530 " "
1543 ;; Read options in the current buffer and return value.
1545 ;; Parse properties in TO-PARSE. Remove newline characters not
1546 ;; involved in line breaks to simulate `space' behavior.
1547 ;; Finally return options.
1560 "Return properties related to export process, as a plist.
1561 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1562 are like the arguments with the same names of function
1563 `org-export-as'."
1568 :back-end backend
1573 "Return properties related to buffer attributes, as a plist."
1578 "Return global export options as a plist.
1579 Optional argument BACKEND, if non-nil, is an export back-end, as
1580 returned by, e.g., `org-export-create-backend'. It specifies
1581 which back-end specific export options should also be read in the
1582 process."
1584 ;; Priority is given to back-end specific options.
1586 org-export-options-alist)))
1592 plist
1593 prop
1594 ;; Evaluate default value provided.
1599 value)))))))))
1602 "Return variables bound from BIND keywords in current buffer.
1603 Also look for BIND keywords in setup files. The return value is
1604 an alist where associations are (VARIABLE-NAME VALUE)."
1608 ;; Return an alist between variable names and their
1609 ;; value. FILES is a list of setup files names read
1610 ;; so far, used to avoid circular dependencies. ALIST
1611 ;; is the alist collected so far.
1623 ;; Enter setup file.
1635 alist))))))))))
1636 alist)))))
1637 ;; Return value in appropriate order of appearance.
1640 ;; defsubst org-export-get-parent must be defined before first use,
1641 ;; was originally defined in the topology section
1644 "Return BLOB parent or nil.
1645 BLOB is the element or object considered."
1648 ;;;; Tree Properties
1649 ;;
1650 ;; Tree properties are information extracted from parse tree. They
1651 ;; are initialized at the beginning of the transcoding process by
1652 ;; `org-export--collect-tree-properties'.
1653 ;;
1654 ;; Dedicated functions focus on computing the value of specific tree
1655 ;; properties during initialization. Thus,
1656 ;; `org-export--populate-ignore-list' lists elements and objects that
1657 ;; should be skipped during export, `org-export--get-min-level' gets
1658 ;; the minimal exportable level, used as a basis to compute relative
1659 ;; level for headlines. Eventually
1660 ;; `org-export--collect-headline-numbering' builds an alist between
1661 ;; headlines and their numbering.
1664 "Extract tree properties from parse tree.
1666 DATA is the parse tree from which information is retrieved. INFO
1667 is a list holding export options.
1669 Following tree properties are set or updated:
1671 `:headline-offset' Offset between true level of headlines and
1672 local level. An offset of -1 means a headline
1673 of level 2 should be considered as a level
1674 1 headline in the context.
1676 `:headline-numbering' Alist of all headlines as key and the
1677 associated numbering as value.
1679 `:id-alist' Alist of all ID references as key and associated file
1680 as value.
1682 Return updated plist."
1683 ;; Install the parse tree in the communication channel.
1685 ;; Compute `:headline-offset' in order to be able to use
1686 ;; `org-export-get-relative-level'.
1689 :headline-offset
1691 ;; From now on, properties order doesn't matter: get the rest of the
1692 ;; tree properties.
1694 info
1696 :id-alist
1705 "Return minimum exportable headline's level in DATA.
1706 DATA is parsed tree as returned by `org-element-parse-buffer'.
1707 OPTIONS is a plist holding export options."
1716 ;; If no headline was found, for the sake of consistency, set
1717 ;; minimum level to 1 nonetheless.
1721 "Return numbering of all exportable, numbered headlines in a parse tree.
1723 DATA is the parse tree. OPTIONS is the plist holding export
1724 options.
1726 Return an alist whose key is a headline and value is its
1727 associated numbering \(in the shape of a list of numbers) or nil
1728 for a footnotes section."
1737 headline
1739 for n across numbering
1740 for idx from 0 to org-export-max-depth
1744 options)))
1747 "List headlines and inlinetasks with a select tag in their tree.
1748 DATA is parsed data as returned by `org-element-parse-buffer'.
1749 INFO is a plist holding export options."
1752 ;; If FILETAGS contains a select tag, every headline or
1753 ;; inlinetask is returned.
1763 ;; When a select tag is found, mark full
1764 ;; genealogy and every headline within the
1765 ;; tree as acceptable.
1768 genealogy
1771 selected-trees))
1772 ;; If at a headline, continue searching in
1773 ;; tree, recursively.
1782 selected-trees))))
1785 "Non-nil when element or object BLOB should be skipped during export.
1786 OPTIONS is the plist holding export options. SELECTED, when
1787 non-nil, is a list of headlines or inlinetasks belonging to
1788 a tree with a select tag."
1795 ;; If `:with-drawers' value starts with `not', ignore
1796 ;; every drawer whose name belong to that list.
1797 ;; Otherwise, ignore drawers whose name isn't in that
1798 ;; list.
1815 ;; Ignore subtrees with an exclude tag.
1818 ;; When a select tag is present in the buffer, ignore any tree
1819 ;; without it.
1821 ;; Ignore commented sub-trees.
1823 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1825 ;; Ignore tasks, if specified by `:with-tasks' property.
1837 properties-set))))))
1848 ;; `:with-timestamps' only applies to isolated timestamps
1849 ;; objects, i.e. timestamp objects in a paragraph containing only
1850 ;; timestamps and whitespaces.
1858 options t))))
1867 \f
1868 ;;; The Transcoder
1869 ;;
1870 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1871 ;; `org-element-parse-buffer') and transcodes it into a specified
1872 ;; back-end output. It takes care of filtering out elements or
1873 ;; objects according to export options and organizing the output blank
1874 ;; lines and white space are preserved. The function memoizes its
1875 ;; results, so it is cheap to call it within transcoders.
1876 ;;
1877 ;; It is possible to modify locally the back-end used by
1878 ;; `org-export-data' or even use a temporary back-end by using
1879 ;; `org-export-data-with-backend'.
1880 ;;
1881 ;; `org-export-transcoder' is an accessor returning appropriate
1882 ;; translator function for a given element or object.
1885 "Return appropriate transcoder for BLOB.
1886 INFO is a plist containing export directives."
1888 ;; Return contents only for complete parse trees.
1894 "Convert DATA into current back-end format.
1896 DATA is a parse tree, an element or an object or a secondary
1897 string. INFO is a plist holding export options.
1899 Return a string."
1901 ;; Handle broken links according to
1902 ;; `org-export-with-broken-links'.
1917 ;; Ignored element/object.
1919 ;; Plain text.
1925 info))
1926 ;; Secondary string.
1929 ;; Element/Object without contents or, as a special
1930 ;; case, headline with archive tag and archived trees
1931 ;; restricted to title only.
1940 ;; Export snippets never return a nil value so
1941 ;; that white spaces following them are never
1942 ;; ignored.
1944 ;; Element/Object with contents.
1957 ;; Elements directly containing
1958 ;; objects must have their indentation
1959 ;; normalized first.
1961 data
1962 ;; When normalizing contents of the
1963 ;; first paragraph in an item or
1964 ;; a footnote definition, ignore
1965 ;; first line's indentation: there is
1966 ;; none and it might be misleading.
1971 data)
1979 info)))))))))
1980 ;; Final result will be memoized before being returned.
1982 data
1986 ;; Append the same white space between elements or objects
1987 ;; as in the original buffer, and call appropriate filters.
1998 info)))
1999 results)))
2003 "Convert DATA into BACKEND format.
2005 DATA is an element, an object, a secondary string or a string.
2006 BACKEND is a symbol. INFO is a plist used as a communication
2007 channel.
2009 Unlike to `org-export-with-backend', this function will
2010 recursively convert DATA using BACKEND translation table."
2013 data
2014 ;; Set-up a new communication channel with translations defined in
2015 ;; BACKEND as the translate table and a new hash table for
2016 ;; memoization.
2018 info
2021 ;; Size of the hash table is reduced since this function
2022 ;; will probably be used on small trees.
2026 "Expand a parsed element or object to its original state.
2028 BLOB is either an element or an object. CONTENTS is its
2029 contents, as a string or nil.
2031 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2032 keywords before output."
2037 blob contents))))
2040 \f
2041 ;;; The Filter System
2042 ;;
2043 ;; Filters allow end-users to tweak easily the transcoded output.
2044 ;; They are the functional counterpart of hooks, as every filter in
2045 ;; a set is applied to the return value of the previous one.
2046 ;;
2047 ;; Every set is back-end agnostic. Although, a filter is always
2048 ;; called, in addition to the string it applies to, with the back-end
2049 ;; used as argument, so it's easy for the end-user to add back-end
2050 ;; specific filters in the set. The communication channel, as
2051 ;; a plist, is required as the third argument.
2052 ;;
2053 ;; From the developer side, filters sets can be installed in the
2054 ;; process with the help of `org-export-define-backend', which
2055 ;; internally stores filters as an alist. Each association has a key
2056 ;; among the following symbols and a function or a list of functions
2057 ;; as value.
2058 ;;
2059 ;; - `:filter-options' applies to the property list containing export
2060 ;; options. Unlike to other filters, functions in this list accept
2061 ;; two arguments instead of three: the property list containing
2062 ;; export options and the back-end. Users can set its value through
2063 ;; `org-export-filter-options-functions' variable.
2064 ;;
2065 ;; - `:filter-parse-tree' applies directly to the complete parsed
2066 ;; tree. Users can set it through
2067 ;; `org-export-filter-parse-tree-functions' variable.
2068 ;;
2069 ;; - `:filter-body' applies to the body of the output, before template
2070 ;; translator chimes in. Users can set it through
2071 ;; `org-export-filter-body-functions' variable.
2072 ;;
2073 ;; - `:filter-final-output' applies to the final transcoded string.
2074 ;; Users can set it with `org-export-filter-final-output-functions'
2075 ;; variable.
2076 ;;
2077 ;; - `:filter-plain-text' applies to any string not recognized as Org
2078 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2079 ;; configure it.
2080 ;;
2081 ;; - `:filter-TYPE' applies on the string returned after an element or
2082 ;; object of type TYPE has been transcoded. A user can modify
2083 ;; `org-export-filter-TYPE-functions' to install these filters.
2084 ;;
2085 ;; All filters sets are applied with
2086 ;; `org-export-filter-apply-functions' function. Filters in a set are
2087 ;; applied in a LIFO fashion. It allows developers to be sure that
2088 ;; their filters will be applied first.
2089 ;;
2090 ;; Filters properties are installed in communication channel with
2091 ;; `org-export-install-filters' function.
2092 ;;
2093 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2094 ;; `org-export-before-parsing-hook') are run at the beginning of the
2095 ;; export process and just before parsing to allow for heavy structure
2096 ;; modifications.
2099 ;;;; Hooks
2102 "Hook run at the beginning of the export process.
2104 This is run before include keywords and macros are expanded and
2105 Babel code blocks executed, on a copy of the original buffer
2106 being exported. Visibility and narrowing are preserved. Point
2107 is at the beginning of the buffer.
2109 Every function in this hook will be called with one argument: the
2113 "Hook run before parsing an export buffer.
2115 This is run after include keywords and macros have been expanded
2116 and Babel code blocks executed, on a copy of the original buffer
2117 being exported. Visibility and narrowing are preserved. Point
2118 is at the beginning of the buffer.
2120 Every function in this hook will be called with one argument: the
2124 ;;;; Special Filters
2127 "List of functions applied to the export options.
2128 Each filter is called with two arguments: the export options, as
2129 a plist, and the back-end, as a symbol. It must return
2133 "List of functions applied to the parsed tree.
2134 Each filter is called with three arguments: the parse tree, as
2135 returned by `org-element-parse-buffer', the back-end, as
2136 a symbol, and the communication channel, as a plist. It must
2140 "List of functions applied to plain text.
2141 Each filter is called with three arguments: a string which
2142 contains no Org syntax, the back-end, as a symbol, and the
2143 communication channel, as a plist. It must return a string or
2147 "List of functions applied to transcoded body.
2148 Each filter is called with three arguments: a string which
2149 contains no Org syntax, the back-end, as a symbol, and the
2150 communication channel, as a plist. It must return a string or
2154 "List of functions applied to the transcoded string.
2155 Each filter is called with three arguments: the full transcoded
2156 string, the back-end, as a symbol, and the communication channel,
2157 as a plist. It must return a string that will be used as the
2161 ;;;; Elements Filters
2164 "List of functions applied to a transcoded babel-call.
2165 Each filter is called with three arguments: the transcoded data,
2166 as a string, the back-end, as a symbol, and the communication
2170 "List of functions applied to a transcoded center block.
2171 Each filter is called with three arguments: the transcoded data,
2172 as a string, the back-end, as a symbol, and the communication
2176 "List of functions applied to a transcoded clock.
2177 Each filter is called with three arguments: the transcoded data,
2178 as a string, the back-end, as a symbol, and the communication
2182 "List of functions applied to a transcoded diary-sexp.
2183 Each filter is called with three arguments: the transcoded data,
2184 as a string, the back-end, as a symbol, and the communication
2188 "List of functions applied to a transcoded drawer.
2189 Each filter is called with three arguments: the transcoded data,
2190 as a string, the back-end, as a symbol, and the communication
2194 "List of functions applied to a transcoded dynamic-block.
2195 Each filter is called with three arguments: the transcoded data,
2196 as a string, the back-end, as a symbol, and the communication
2200 "List of functions applied to a transcoded example-block.
2201 Each filter is called with three arguments: the transcoded data,
2202 as a string, the back-end, as a symbol, and the communication
2206 "List of functions applied to a transcoded export-block.
2207 Each filter is called with three arguments: the transcoded data,
2208 as a string, the back-end, as a symbol, and the communication
2212 "List of functions applied to a transcoded fixed-width.
2213 Each filter is called with three arguments: the transcoded data,
2214 as a string, the back-end, as a symbol, and the communication
2218 "List of functions applied to a transcoded footnote-definition.
2219 Each filter is called with three arguments: the transcoded data,
2220 as a string, the back-end, as a symbol, and the communication
2224 "List of functions applied to a transcoded headline.
2225 Each filter is called with three arguments: the transcoded data,
2226 as a string, the back-end, as a symbol, and the communication
2230 "List of functions applied to a transcoded horizontal-rule.
2231 Each filter is called with three arguments: the transcoded data,
2232 as a string, the back-end, as a symbol, and the communication
2236 "List of functions applied to a transcoded inlinetask.
2237 Each filter is called with three arguments: the transcoded data,
2238 as a string, the back-end, as a symbol, and the communication
2242 "List of functions applied to a transcoded item.
2243 Each filter is called with three arguments: the transcoded data,
2244 as a string, the back-end, as a symbol, and the communication
2248 "List of functions applied to a transcoded keyword.
2249 Each filter is called with three arguments: the transcoded data,
2250 as a string, the back-end, as a symbol, and the communication
2254 "List of functions applied to a transcoded latex-environment.
2255 Each filter is called with three arguments: the transcoded data,
2256 as a string, the back-end, as a symbol, and the communication
2260 "List of functions applied to a transcoded node-property.
2261 Each filter is called with three arguments: the transcoded data,
2262 as a string, the back-end, as a symbol, and the communication
2266 "List of functions applied to a transcoded paragraph.
2267 Each filter is called with three arguments: the transcoded data,
2268 as a string, the back-end, as a symbol, and the communication
2272 "List of functions applied to a transcoded plain-list.
2273 Each filter is called with three arguments: the transcoded data,
2274 as a string, the back-end, as a symbol, and the communication
2278 "List of functions applied to a transcoded planning.
2279 Each filter is called with three arguments: the transcoded data,
2280 as a string, the back-end, as a symbol, and the communication
2284 "List of functions applied to a transcoded property-drawer.
2285 Each filter is called with three arguments: the transcoded data,
2286 as a string, the back-end, as a symbol, and the communication
2290 "List of functions applied to a transcoded quote block.
2291 Each filter is called with three arguments: the transcoded quote
2292 data, as a string, the back-end, as a symbol, and the
2293 communication channel, as a plist. It must return a string or
2297 "List of functions applied to a transcoded section.
2298 Each filter is called with three arguments: the transcoded data,
2299 as a string, the back-end, as a symbol, and the communication
2303 "List of functions applied to a transcoded special block.
2304 Each filter is called with three arguments: the transcoded data,
2305 as a string, the back-end, as a symbol, and the communication
2309 "List of functions applied to a transcoded src-block.
2310 Each filter is called with three arguments: the transcoded data,
2311 as a string, the back-end, as a symbol, and the communication
2315 "List of functions applied to a transcoded table.
2316 Each filter is called with three arguments: the transcoded data,
2317 as a string, the back-end, as a symbol, and the communication
2321 "List of functions applied to a transcoded table-cell.
2322 Each filter is called with three arguments: the transcoded data,
2323 as a string, the back-end, as a symbol, and the communication
2327 "List of functions applied to a transcoded table-row.
2328 Each filter is called with three arguments: the transcoded data,
2329 as a string, the back-end, as a symbol, and the communication
2333 "List of functions applied to a transcoded verse block.
2334 Each filter is called with three arguments: the transcoded data,
2335 as a string, the back-end, as a symbol, and the communication
2339 ;;;; Objects Filters
2342 "List of functions applied to transcoded bold text.
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 transcoded code text.
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 entity.
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 export-snippet.
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 "List of functions applied to a transcoded footnote-reference.
2367 Each filter is called with three arguments: the transcoded data,
2368 as a string, the back-end, as a symbol, and the communication
2372 "List of functions applied to a transcoded inline-babel-call.
2373 Each filter is called with three arguments: the transcoded data,
2374 as a string, the back-end, as a symbol, and the communication
2378 "List of functions applied to a transcoded inline-src-block.
2379 Each filter is called with three arguments: the transcoded data,
2380 as a string, the back-end, as a symbol, and the communication
2384 "List of functions applied to transcoded italic text.
2385 Each filter is called with three arguments: the transcoded data,
2386 as a string, the back-end, as a symbol, and the communication
2390 "List of functions applied to a transcoded latex-fragment.
2391 Each filter is called with three arguments: the transcoded data,
2392 as a string, the back-end, as a symbol, and the communication
2396 "List of functions applied to a transcoded line-break.
2397 Each filter is called with three arguments: the transcoded data,
2398 as a string, the back-end, as a symbol, and the communication
2402 "List of functions applied to a transcoded link.
2403 Each filter is called with three arguments: the transcoded data,
2404 as a string, the back-end, as a symbol, and the communication
2408 "List of functions applied to a transcoded radio-target.
2409 Each filter is called with three arguments: the transcoded data,
2410 as a string, the back-end, as a symbol, and the communication
2414 "List of functions applied to a transcoded statistics-cookie.
2415 Each filter is called with three arguments: the transcoded data,
2416 as a string, the back-end, as a symbol, and the communication
2420 "List of functions applied to transcoded strike-through text.
2421 Each filter is called with three arguments: the transcoded data,
2422 as a string, the back-end, as a symbol, and the communication
2426 "List of functions applied to a transcoded subscript.
2427 Each filter is called with three arguments: the transcoded data,
2428 as a string, the back-end, as a symbol, and the communication
2432 "List of functions applied to a transcoded superscript.
2433 Each filter is called with three arguments: the transcoded data,
2434 as a string, the back-end, as a symbol, and the communication
2438 "List of functions applied to a transcoded target.
2439 Each filter is called with three arguments: the transcoded data,
2440 as a string, the back-end, as a symbol, and the communication
2444 "List of functions applied to a transcoded timestamp.
2445 Each filter is called with three arguments: the transcoded data,
2446 as a string, the back-end, as a symbol, and the communication
2450 "List of functions applied to transcoded underline text.
2451 Each filter is called with three arguments: the transcoded data,
2452 as a string, the back-end, as a symbol, and the communication
2456 "List of functions applied to transcoded verbatim text.
2457 Each filter is called with three arguments: the transcoded data,
2458 as a string, the back-end, as a symbol, and the communication
2462 ;;;; Filters Tools
2463 ;;
2464 ;; Internal function `org-export-install-filters' installs filters
2465 ;; hard-coded in back-ends (developer filters) and filters from global
2466 ;; variables (user filters) in the communication channel.
2467 ;;
2468 ;; Internal function `org-export-filter-apply-functions' takes care
2469 ;; about applying each filter in order to a given data. It ignores
2470 ;; filters returning a nil value but stops whenever a filter returns
2471 ;; an empty string.
2474 "Call every function in FILTERS.
2476 Functions are called with arguments VALUE, current export
2477 back-end's name and INFO. A function returning a nil value will
2478 be skipped. If it returns the empty string, the process ends and
2479 VALUE is ignored.
2481 Call is done in a LIFO fashion, to be sure that developer
2482 specified filters, if any, are called first."
2493 "Install filters properties in communication channel.
2494 INFO is a plist containing the current communication channel.
2495 Return the updated communication channel."
2497 ;; Install user-defined filters with `org-export-filters-alist'
2498 ;; and filters already in INFO (through ext-plist mechanism).
2505 ;; Filters in INFO will be called
2506 ;; before those user provided.
2509 default-value)))))
2510 ;; Prepend back-end specific filters to that list.
2512 ;; Single values get consed, lists are appended.
2517 plist key
2520 ;; Return new communication channel.
2524 \f
2525 ;;; Core functions
2526 ;;
2527 ;; This is the room for the main function, `org-export-as', along with
2528 ;; its derivative, `org-export-string-as'.
2529 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2530 ;; function should be added to kill ring.
2531 ;;
2532 ;; Note that `org-export-as' doesn't really parse the current buffer,
2533 ;; but a copy of it (with the same buffer-local variables and
2534 ;; visibility), where macros and include keywords are expanded and
2535 ;; Babel blocks are executed, if appropriate.
2536 ;; `org-export-with-buffer-copy' macro prepares that copy.
2537 ;;
2538 ;; File inclusion is taken care of by
2539 ;; `org-export-expand-include-keyword' and
2540 ;; `org-export--prepare-file-contents'. Structure wise, including
2541 ;; a whole Org file in a buffer often makes little sense. For
2542 ;; example, if the file contains a headline and the include keyword
2543 ;; was within an item, the item should contain the headline. That's
2544 ;; why file inclusion should be done before any structure can be
2545 ;; associated to the file, that is before parsing.
2546 ;;
2547 ;; `org-export-insert-default-template' is a command to insert
2548 ;; a default template (or a back-end specific template) at point or in
2549 ;; current subtree.
2552 "Return a copy of the current buffer.
2553 The copy preserves Org buffer-local variables, visibility and
2554 narrowing."
2560 new-buf))
2563 "Apply BODY in a copy of the current buffer.
2564 The copy preserves local variables, visibility and contents of
2565 the original buffer. Point is at the beginning of the buffer
2566 when BODY is applied."
2575 ;; Kill copy without confirmation.
2581 "Generate a function duplicating BUFFER.
2583 The copy will preserve local variables, visibility, contents and
2584 narrowing of the original buffer. If a region was active in
2585 BUFFER, contents will be narrowed to that region instead.
2587 The resulting function can be evaluated at a later time, from
2588 another buffer, effectively cloning the original buffer there.
2590 The function assumes BUFFER's major mode is `org-mode'."
2594 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2595 ;; already in BUFFER.
2597 ;; Copy specific buffer local variables and variables set
2598 ;; through BIND keywords.
2600 vars)
2608 buffer-file-name
2609 buffer-file-coding-system))
2613 ;; Skip unreadable values, as they cannot be
2614 ;; sent to external process.
2618 vars))))))
2619 ;; Whole buffer contents.
2624 ;; Narrowing.
2628 ;; Current position of point.
2630 ;; Overlays with invisible property.
2639 ov-set)))))))))
2642 "Delete commented areas in the buffer.
2643 Commented areas are comments, comment blocks, commented trees and
2644 inlinetasks. Trailing blank lines after a comment or a comment
2645 block are removed, as long as it doesn't alter the structure of
2646 the document. Narrowing, if any, is ignored."
2652 comment-re)))
2664 ;; We remove trailing blank lines. Doing so could
2665 ;; modify the structure of the document. Therefore
2666 ;; we ensure that any comment between elements is
2667 ;; replaced with one empty line, so as to keep them
2668 ;; separated.
2674 start)
2676 end)
2686 "Prune non exportable elements from DATA.
2687 DATA is the parse tree to traverse. INFO is the plist holding
2688 export info. Also set `:ignore-list' in INFO to a list of
2689 objects which should be ignored during export, but not removed
2690 from tree."
2692 ;; First find trees containing a select tag, if any.
2696 ;; Prune non-exportable elements and objects from tree.
2697 ;; As a special case, special rows and cells from tables
2698 ;; are stored in IGNORE, as they still need to be
2699 ;; accessed during export.
2709 ;; If headline is archived but tree below has
2710 ;; to be skipped, remove contents.
2712 ;; Move into recursive objects/elements.
2714 ;; Move into secondary string, if any.
2716 org-element-secondary-value-alist)))
2719 ;; Collect definitions before possibly pruning them so as
2720 ;; to avoid parsing them again if they are required.
2729 #'org-element-create
2732 ;; If a select tag is active, also ignore the section before the
2733 ;; first headline, if any.
2738 ;; Prune tree and communication channel.
2741 ;; Priority is given to back-end specific options.
2743 org-export-options-alist))
2749 ;; Eventually set `:ignore-list'.
2753 "List footnote definitions missing from TREE.
2754 Missing definitions are searched within DEFINITIONS, which is
2755 a list of footnote definitions or in the widened buffer."
2758 ;; List all footnote labels encountered in DATA. Inline
2759 ;; footnote references are ignored.
2764 defined undefined missing-definitions)
2765 ;; Partition DIRECT-REFERENCES between DEFINED and UNDEFINED
2766 ;; references.
2773 seen)
2778 ;; Complete MISSING-DEFINITIONS by finding the definition of every
2779 ;; undefined label, first by looking into DEFINITIONS, then by
2780 ;; searching the widened buffer. This is a recursive process
2781 ;; since definitions found can themselves contain an undefined
2782 ;; reference.
2789 d))
2790 definitions))
2797 datum
2798 ;; Parse definition with contents.
2809 ;; Look for footnote references within DEFINITION, since
2810 ;; we may need to also find their definition.
2815 ;; MISSING-DEFINITIONS may contain footnote references with inline
2816 ;; definitions. Make sure those are changed into real footnote
2817 ;; definitions.
2824 missing-definitions)))
2827 "Install footnote definitions in tree.
2829 DEFINITIONS is the list of footnote definitions to install. TREE
2830 is the parse tree.
2832 If there is a footnote section in TREE, definitions found are
2833 appended to it. If `org-footnote-section' is non-nil, a new
2834 footnote section containing all definitions is inserted in TREE.
2835 Otherwise, definitions are appended at the end of the section
2836 containing their first reference."
2839 ;; If there is a footnote section, insert definitions there.
2843 nil t)))
2846 footnote-section
2848 ;; If there should be a footnote section, create one containing all
2849 ;; the definitions at the end of the tree.
2852 tree
2858 'section
2859 nil
2861 ;; Otherwise add each definition at the end of the section where it
2862 ;; is first referenced.
2867 ;; Insert footnote definitions in the same section as
2868 ;; their first reference in DATA.
2879 label)
2880 d))
2881 definitions)))
2884 definition)
2885 ;; Also insert definitions for nested
2886 ;; references, if any.
2891 "Change uninterpreted elements back into Org syntax.
2892 DATA is the parse tree. INFO is a plist containing export
2893 options. Each uninterpreted element or object is changed back
2894 into a string. Contents, if any, are not modified. The parse
2895 tree is modified by side effect."
2901 p
2904 info))))))
2907 "Change uninterpreted elements back into Org syntax.
2908 DATA is a parse tree or a secondary string. INFO is a plist
2909 containing export options. It is modified by side effect and
2910 returned by the function."
2913 subscript superscript underline)
2917 ;; ... entities...
2924 ?\s)))))
2925 ;; ... emphasis...
2937 marker
2941 ?\s)))))))
2942 ;; ... LaTeX environments and fragments...
2946 ;; ... sub/superscripts...
2955 "_"
2964 ?\s)))))))))))
2966 ;; Splice NEW at BLOB location in parse tree.
2969 info nil nil t)
2970 ;; Return modified parse tree.
2971 data)
2973 ;;;###autoload
2976 "Transcode current Org buffer into BACKEND code.
2978 BACKEND is either an export back-end, as returned by, e.g.,
2979 `org-export-create-backend', or a symbol referring to
2980 a registered back-end.
2982 If narrowing is active in the current buffer, only transcode its
2983 narrowed part.
2985 If a region is active, transcode that region.
2987 When optional argument SUBTREEP is non-nil, transcode the
2988 sub-tree at point, extracting information from the headline
2989 properties first.
2991 When optional argument VISIBLE-ONLY is non-nil, don't export
2992 contents of hidden elements.
2994 When optional argument BODY-ONLY is non-nil, only return body
2995 code, without surrounding template.
2997 Optional argument EXT-PLIST, when provided, is a property list
2998 with external parameters overriding Org default settings, but
2999 still inferior to file-local settings.
3001 Return code as a string."
3006 ;; Narrow buffer to an appropriate region or subtree for
3007 ;; parsing. If parsing subtree, be sure to remove main headline
3008 ;; too.
3016 ;; Initialize communication channel with original buffer
3017 ;; attributes, unavailable in its copy.
3021 backend subtreep visible-only body-only)
3027 org-export-options-alist))))
3028 tree)
3029 ;; Update communication channel and get parse tree. Buffer
3030 ;; isn't parsed directly. Instead, all buffer modifications
3031 ;; and consequent parsing are undertaken in a temporary copy.
3033 ;; Run first hook with current back-end's name as argument.
3036 ;; Include files, delete comments and expand macros.
3041 ;; Refresh buffer properties and radio targets after
3042 ;; potentially invasive previous changes. Likewise, do it
3043 ;; again after executing Babel code.
3050 ;; Run last hook with current back-end's name as argument.
3051 ;; Update buffer properties and radio targets one last time
3052 ;; before parsing.
3059 ;; Update communication channel with environment. Also
3060 ;; install user's and developer's filters.
3065 ;; Call options filters and update export options. We do not
3066 ;; use `org-export-filter-apply-functions' here since the
3067 ;; arity of such filters is different.
3072 ;; Expand export-specific set of macros: {{{author}}},
3073 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
3074 ;; be done once regular macros have been expanded, since
3075 ;; parsed keywords may contain one of them.
3088 value)
3089 value)))
3093 'finalize
3094 parsed-keywords)
3095 ;; Parse buffer.
3097 ;; Prune tree from non-exported elements and transform
3098 ;; uninterpreted elements or objects in both parse tree and
3099 ;; communication channel.
3102 ;; Call parse tree filters.
3106 ;; Now tree is complete, compute its properties and add them
3107 ;; to communication channel.
3109 ;; Eventually transcode TREE. Wrap the resulting string into
3110 ;; a template.
3119 info))
3122 ;; Remove all text properties since they cannot be
3123 ;; retrieved from an external process. Finally call
3124 ;; final-output filter and return result.
3130 info))))))))
3132 ;;;###autoload
3134 "Transcode STRING into BACKEND code.
3136 BACKEND is either an export back-end, as returned by, e.g.,
3137 `org-export-create-backend', or a symbol referring to
3138 a registered back-end.
3140 When optional argument BODY-ONLY is non-nil, only return body
3141 code, without preamble nor postamble.
3143 Optional argument EXT-PLIST, when provided, is a property list
3144 with external parameters overriding Org default settings, but
3145 still inferior to file-local settings.
3147 Return code as a string."
3153 ;;;###autoload
3155 "Replace the active region by its export to BACKEND.
3156 BACKEND is either an export back-end, as returned by, e.g.,
3157 `org-export-create-backend', or a symbol referring to
3158 a registered back-end."
3164 ;;;###autoload
3166 "Insert all export keywords with default values at beginning of line.
3168 BACKEND is a symbol referring to the name of a registered export
3169 back-end, for which specific export options should be added to
3170 the template, or `default' for default template. When it is nil,
3171 the user will be prompted for a category.
3173 If SUBTREEP is non-nil, export configuration will be set up
3174 locally for the subtree through node properties."
3184 "Options category: "
3188 org-export-registered-backends))
3189 nil t))))
3190 options keywords)
3191 ;; Populate OPTIONS and KEYWORDS.
3208 ;; Move to an appropriate location in order to insert options.
3210 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3228 ;; Then the rest of keywords, in the order specified in either
3229 ;; `org-export-options-alist' or respective export back-ends.
3250 "Expand every include keyword in buffer.
3251 Optional argument INCLUDED is a list of included file names along
3252 with their line restriction, when appropriate. It is used to
3253 avoid infinite recursion. Optional argument DIR is the current
3254 working directory. It is used to properly resolve relative
3255 paths. Optional argument FOOTNOTES is a hash-table used for
3256 storing and resolving footnotes. It is created automatically."
3262 ;; If :minlevel is not set the text-property
3263 ;; `:org-include-induced-level' will be used to determine the
3264 ;; relative level when expanding INCLUDE.
3265 ;; Only affects included Org documents.
3269 :org-include-induced-level
3271 ;; Expand INCLUDE keywords.
3277 ;; Extract arguments from keyword's value.
3280 location
3288 matched)
3294 dir)))
3298 value)
3304 value)
3313 ;; Minimal level of included file defaults to the child
3314 ;; level of the current headline, if any, or one. It
3315 ;; only applies is the file is meant to be included as
3316 ;; an Org one.
3327 ;; Remove keyword.
3333 ;; Check if files has already been parsed. Look after
3334 ;; inclusion lines too, as different parts of the same file
3335 ;; can be included too.
3348 ind-str block arg-str contents ind-str block))))
3355 ind-str block contents ind-str block))))
3363 file location only-contents lines)
3364 lines)))
3368 file lines ind minlevel
3371 footnotes)))
3375 footnotes)
3377 ;; Expand footnotes after all files have been included.
3378 ;; Footnotes are stored at end of buffer.
3383 footnotes)))))))))))
3386 "Resolve absolute lines for an included file with file-link.
3388 FILE is string file-name of the file to include. LOCATION is a
3389 string name within FILE to be included (located via
3390 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3391 contents of the named element will be included, as determined
3392 Org-Element. If LINES is non-nil only those lines are included.
3394 Return a string of lines to be included in the format expected by
3395 `org-export--prepare-file-contents'."
3401 ;; Enforce consistent search.
3414 ;; Skip planning line and property-drawer.
3440 start-line
3442 (+ start-line
3445 counter))))))))
3449 "Prepare contents of FILE for inclusion and return it as a string.
3451 When optional argument LINES is a string specifying a range of
3452 lines, include only those lines.
3454 Optional argument IND, when non-nil, is an integer specifying the
3455 global indentation of returned contents. Since its purpose is to
3456 allow an included file to stay in the same environment it was
3457 created (e.g., a list item), it doesn't apply past the first
3458 headline encountered.
3460 Optional argument MINLEVEL, when non-nil, is an integer
3461 specifying the level that any top-level headline in the included
3462 file should have.
3464 Optional argument ID is an integer that will be inserted before
3465 each footnote definition and reference if FILE is an Org file.
3466 This is useful to avoid conflicts when more than one Org file
3467 with footnotes is included in a document.
3469 Optional argument FOOTNOTES is a hash-table to store footnotes in
3470 the included document."
3486 ;; Remove blank lines at beginning and end of contents. The logic
3487 ;; behind that removal is that blank lines around include keyword
3488 ;; override blank lines in included file.
3497 ;; If IND is set, preserve indentation of include keyword until
3498 ;; the first headline encountered.
3505 ;; Do not move footnote definitions out of column 0.
3511 ;; When MINLEVEL is specified, compute minimal level for headlines
3512 ;; in the file (CUR-MIN), and remove stars to each headline so
3513 ;; that headlines with minimal level have a level of MINLEVEL.
3524 ;; Only change stars, don't bother moving whole
3525 ;; sections.
3530 ;; Append ID to all footnote references and definitions, so they
3531 ;; become file specific and cannot collide with footnotes in other
3532 ;; included files. Further, collect relevant footnote definitions
3533 ;; outside of LINES, in order to reintroduce them later.
3539 ;; Generate new label from LABEL by prefixing it with
3540 ;; "-ID-".
3544 ;; Replace OLD label with NEW in footnote F.
3558 ;; Update the footnote-reference at point and collect
3559 ;; the new label, which is only used for footnotes
3560 ;; outsides LINES.
3572 ;; Store since footnote-definition is
3573 ;; outside of LINES.
3576 footnotes))))
3583 "Return a non-nil value when output should be added to the kill ring.
3584 See also `org-export-copy-to-kill-ring'."
3590 \f
3591 ;;; Tools For Back-Ends
3592 ;;
3593 ;; A whole set of tools is available to help build new exporters. Any
3594 ;; function general enough to have its use across many back-ends
3595 ;; should be added here.
3597 ;;;; For Affiliated Keywords
3598 ;;
3599 ;; `org-export-read-attribute' reads a property from a given element
3600 ;; as a plist. It can be used to normalize affiliated keywords'
3601 ;; syntax.
3602 ;;
3603 ;; Since captions can span over multiple lines and accept dual values,
3604 ;; their internal representation is a bit tricky. Therefore,
3605 ;; `org-export-get-caption' transparently returns a given element's
3606 ;; caption as a secondary string.
3609 "Turn ATTRIBUTE property from ELEMENT into a plist.
3611 When optional argument PROPERTY is non-nil, return the value of
3612 that property within attributes.
3616 properties.
3618 All values will become strings except the empty string and
3621 will become the empty string."
3635 s)
3640 ;; Ignore any string before first property with `cdr'.
3645 "Return caption from ELEMENT as a secondary string.
3647 When optional argument SHORTP is non-nil, return short caption,
3648 as a secondary string, instead.
3650 Caption lines are separated by a white space."
3658 ;;;; For Derived Back-ends
3659 ;;
3660 ;; `org-export-with-backend' is a function allowing to locally use
3661 ;; another back-end to transcode some object or element. In a derived
3662 ;; back-end, it may be used as a fall-back function once all specific
3663 ;; cases have been treated.
3666 "Call a transcoder from BACKEND on DATA.
3667 BACKEND is an export back-end, as returned by, e.g.,
3668 `org-export-create-backend', or a symbol referring to
3669 a registered back-end. DATA is an Org element, object, secondary
3670 string or string. CONTENTS, when non-nil, is the transcoded
3671 contents of DATA element, as a string. INFO, when non-nil, is
3672 the communication channel used for export, as a plist."
3682 transcoder data contents
3685 :back-end backend
3686 :translate-alist all-transcoders
3690 ;;;; For Export Snippets
3691 ;;
3692 ;; Every export snippet is transmitted to the back-end. Though, the
3693 ;; latter will only retain one type of export-snippet, ignoring
3694 ;; others, based on the former's target back-end. The function
3695 ;; `org-export-snippet-backend' returns that back-end for a given
3696 ;; export-snippet.
3699 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3700 Translation, with `org-export-snippet-translation-alist', is
3701 applied."
3705 back-end))))
3708 ;;;; For Footnotes
3709 ;;
3710 ;; `org-export-collect-footnote-definitions' is a tool to list
3711 ;; actually used footnotes definitions in the whole parse tree, or in
3712 ;; a headline, in order to add footnote listings throughout the
3713 ;; transcoded data.
3714 ;;
3715 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3716 ;; back-ends, when they need to attach the footnote definition only to
3717 ;; the first occurrence of the corresponding label.
3718 ;;
3719 ;; `org-export-get-footnote-definition' and
3720 ;; `org-export-get-footnote-number' provide easier access to
3721 ;; additional information relative to a footnote reference.
3724 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3725 INFO is the plist used as a communication channel. If no such
3726 definition can be found, raise an error."
3732 hash))))
3740 ;; Skip any footnote with a different label.
3741 ;; Also skip any standard footnote reference
3742 ;; with the same label since those cannot
3743 ;; contain a definition.
3747 ;; Even if the contents are empty, we can not
3748 ;; return nil since that would eventually raise
3749 ;; the error. Instead, return the equivalent
3750 ;; empty string.
3752 info t)
3753 cache)
3758 "Apply FUNCTION on every footnote reference in DATA.
3759 INFO is a plist containing export state. By default, as soon as
3760 a new footnote reference is encountered, FUNCTION is called onto
3761 its definition. However, if BODY-FIRST is non-nil, this step is
3762 delayed until the end of the process."
3767 ;; Search footnote references through DATA, filling
3768 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3769 ;; store footnote definitions so they can be entered
3770 ;; later.
3777 ;; Search for subsequent references in footnote
3778 ;; definition so numbering follows reading
3779 ;; logic, unless DELAYP in non-nil.
3783 definitions))
3784 ;; Do not force entering inline definitions,
3785 ;; since `org-element-map' already traverses
3786 ;; them at the right time.
3790 nil))))))
3791 info nil
3792 ;; Don't enter footnote definitions since it will
3793 ;; happen when their first reference is found.
3794 ;; Moreover, if DELAYP is non-nil, make sure we
3795 ;; postpone entering definitions of inline references.
3802 "Return an alist between footnote numbers, labels and definitions.
3804 INFO is the current export state, as a plist.
3806 Definitions are collected throughout the whole parse tree, or
3807 DATA when non-nil.
3809 Sorting is done by order of references. As soon as a new
3810 reference is encountered, other references are searched within
3811 its definition. However, if BODY-FIRST is non-nil, this step is
3812 delayed after the whole tree is checked. This alters results
3813 when references are found in footnote definitions.
3815 Definitions either appear as Org data or as a secondary string
3816 for inlined footnotes. Unreferenced definitions are ignored."
3820 ;; Collect footnote number, label and definition.
3831 "Non-nil when a footnote reference is the first one for its label.
3833 FOOTNOTE-REFERENCE is the footnote reference being considered.
3834 INFO is a plist containing current export state.
3836 Search is done throughout the whole parse tree, or DATA when
3837 non-nil.
3839 By default, as soon as a new footnote reference is encountered,
3840 other references are searched within its definition. However, if
3841 BODY-FIRST is non-nil, this step is delayed after the whole tree
3842 is checked. This alters results when references are found in
3843 footnote definitions."
3845 ;; Anonymous footnotes are always a first reference.
3856 "Return number associated to a footnote.
3858 FOOTNOTE is either a footnote reference or a footnote definition.
3859 INFO is the plist containing export state.
3861 Number is unique throughout the whole parse tree, or DATA, when
3862 non-nil.
3864 By default, as soon as a new footnote reference is encountered,
3865 counting process moves into its definition. However, if
3866 BODY-FIRST is non-nil, this step is delayed until the end of the
3867 process, leading to a different order when footnotes are nested."
3876 ;; Anonymous footnote match: return number.
3878 ;; Labels match: return number.
3880 ;; Otherwise store label and increase counter if label
3881 ;; wasn't encountered yet.
3887 ;;;; For Headlines
3888 ;;
3889 ;; `org-export-get-relative-level' is a shortcut to get headline
3890 ;; level, relatively to the lower headline level in the parsed tree.
3891 ;;
3892 ;; `org-export-get-headline-number' returns the section number of an
3893 ;; headline, while `org-export-number-to-roman' allows it to be
3894 ;; converted to roman numbers. With an optional argument,
3895 ;; `org-export-get-headline-number' returns a number to unnumbered
3896 ;; headlines (used for internal id).
3897 ;;
3898 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3899 ;; `org-export-last-sibling-p' are three useful predicates when it
3900 ;; comes to fulfill the `:headline-levels' property.
3901 ;;
3902 ;; `org-export-get-tags', `org-export-get-category' and
3903 ;; `org-export-get-node-property' extract useful information from an
3904 ;; headline or a parent headline. They all handle inheritance.
3905 ;;
3906 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3907 ;; as a secondary string, suitable for table of contents. It falls
3908 ;; back onto default title.
3911 "Return HEADLINE relative level within current parsed tree.
3912 INFO is a plist holding contextual information."
3917 "Non-nil when HEADLINE is considered as low level.
3919 INFO is a plist used as a communication channel.
3921 A low level headlines has a relative level greater than
3922 `:headline-levels' property value.
3924 Return value is the difference between HEADLINE relative level
3925 and the last level being considered as high enough, or nil."
3932 "Return numbered HEADLINE numbering as a list of numbers.
3933 INFO is a plist holding contextual information."
3938 "Return a non-nil value if HEADLINE element should be numbered.
3939 INFO is a plist used as a communication channel."
3948 "Convert integer N into a roman numeral."
3961 res)))
3964 "Return list of tags associated to ELEMENT.
3966 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3967 is a plist used as a communication channel.
3969 When non-nil, optional argument TAGS should be a list of strings.
3970 Any tag belonging to this list will also be removed.
3972 When optional argument INHERITED is non-nil, tags can also be
3973 inherited from parent headlines and FILETAGS keywords."
3977 ;; Build complete list of inherited tags.
3984 ;; Add FILETAGS keywords and return results.
3988 "Return node PROPERTY value for BLOB.
3990 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3991 element or object.
3993 If optional argument INHERITED is non-nil, the value can be
3994 inherited from a parent headline.
3996 Return value is a string or nil."
4008 "Return category for element or object BLOB.
4010 INFO is a plist used as a communication channel.
4012 CATEGORY is automatically inherited from a parent headline, from
4013 #+CATEGORY: keyword or created out of original file name. If all
4026 "Return alternative title for HEADLINE, as a secondary string.
4027 If no optional title is defined, fall-back to the regular title."
4034 "Non-nil when BLOB is the first sibling in its parent.
4035 BLOB is an element or an object. If BLOB is a headline, non-nil
4036 means it is the first sibling in the sub-tree. INFO is a plist
4037 used as a communication channel."
4042 "Non-nil when BLOB is the last sibling in its parent.
4043 BLOB is an element or an object. INFO is a plist used as
4044 a communication channel."
4048 ;;;; For Keywords
4049 ;;
4050 ;; `org-export-get-date' returns a date appropriate for the document
4051 ;; to about to be exported. In particular, it takes care of
4052 ;; `org-export-date-timestamp-format'.
4055 "Return date value for the current document.
4057 INFO is a plist used as a communication channel. FMT, when
4058 non-nil, is a time format string that will be applied on the date
4059 if it consists in a single timestamp object. It defaults to
4060 `org-export-date-timestamp-format' when nil.
4062 A proper date can be a secondary string, a string or nil. It is
4063 meant to be translated with `org-export-data' or alike."
4074 ;;;; For Links
4075 ;;
4076 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4077 ;; in `org-link-parameters'.
4078 ;;
4079 ;; `org-export-get-coderef-format' returns an appropriate format
4080 ;; string for coderefs.
4081 ;;
4082 ;; `org-export-inline-image-p' returns a non-nil value when the link
4083 ;; provided should be considered as an inline image.
4084 ;;
4085 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4086 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4087 ;; returns an appropriate unique identifier.
4088 ;;
4089 ;; `org-export-resolve-id-link' returns the first headline with
4090 ;; specified id or custom-id in parse tree, the path to the external
4091 ;; file with the id.
4092 ;;
4093 ;; `org-export-resolve-coderef' associates a reference to a line
4094 ;; number in the element it belongs, or returns the reference itself
4095 ;; when the element isn't numbered.
4096 ;;
4097 ;; `org-export-file-uri' expands a filename as stored in :path value
4098 ;; of a "file" link into a file URI.
4099 ;;
4100 ;; Broken links raise a `org-link-broken' error, which is caught by
4101 ;; `org-export-data' for further processing, depending on
4102 ;; `org-export-with-broken-links' value.
4107 "Try exporting LINK with a dedicated function.
4109 DESC is its description, as a string, or nil. BACKEND is the
4110 back-end used for export, as a symbol.
4112 Return output as a string, or nil if no protocol handles LINK.
4114 A custom protocol has precedence over regular back-end export.
4115 The function ignores links with an implicit type (e.g.,
4124 desc
4125 backend))))))
4128 "Return format string for code reference link.
4129 PATH is the link path. DESC is its description."
4137 "Non-nil if LINK object points to an inline image.
4139 Optional argument is a set of RULES defining inline images. It
4140 is an alist where associations have the following shape:
4142 (TYPE . REGEXP)
4144 Applying a rule means apply REGEXP against LINK's path when its
4145 type is TYPE. The function will return a non-nil value if any of
4146 the provided rules is non-nil. The default rule is
4147 `org-export-default-inline-image-rule'.
4149 This only applies to links without a description."
4160 "Resolve a code reference REF.
4162 INFO is a plist used as a communication channel.
4164 Return associated line number in source code, or REF itself,
4165 depending on src-block or example element's switches. Throw an
4166 error if no block contains REF."
4173 org-coderef-label-format)))
4177 ;; Element containing REF is found. Resolve it to
4178 ;; either a label or a line number, as needed.
4187 "List search cells for element or object DATUM.
4189 A search cell follows the pattern (TYPE . SEARCH) where
4191 TYPE is a symbol among `headline', `custom-id', `target' and
4192 `other'.
4194 SEARCH is the string a link is expected to match. More
4195 accurately, it is
4197 - headline's title, as a list of strings, if TYPE is
4198 `headline'.
4200 - CUSTOM_ID value, as a string, if TYPE is `custom-id'.
4202 - target's or radio-target's name as a list of strings if
4203 TYPE is `target'.
4205 - NAME affiliated keyword is TYPE is `other'.
4207 A search cell is the internal representation of a fuzzy link. It
4208 ignores white spaces and statistics cookies, if applicable."
4210 (`headline
4221 (`target
4229 "Return search cells associated to string S.
4230 S is either the path of a fuzzy link or a search option, i.e., it
4231 tries to match either a headline (through custom ID or title),
4232 a target or a named element."
4240 "Non-nil when DATUM matches search cells CELLS.
4241 DATUM is an element or object. CELLS is a list of search cells,
4242 as returned by `org-export-search-cells'."
4247 "Return LINK destination.
4249 INFO is a plist holding contextual information.
4251 Return value can be an object or an element:
4253 - If LINK path matches a target object (i.e. <<path>>) return it.
4255 - If LINK path exactly matches the name affiliated keyword
4256 (i.e. #+NAME: path) of an element, return that element.
4258 - If LINK path exactly matches any headline name, return that
4259 element.
4261 - Otherwise, throw an error.
4264 significant."
4270 :resolve-fuzzy-link-cache
4280 datum)))))
4285 search-cells
4286 ;; There can be multiple matches for un-typed searches, i.e.,
4287 ;; for searches not starting with # or *. In this case,
4288 ;; prioritize targets and names over headline titles.
4289 ;; Matching both a name and a target is not valid, and
4290 ;; therefore undefined.
4293 datum))
4294 matches)
4296 link-cache)))))
4299 "Return headline referenced as LINK destination.
4301 INFO is a plist used as a communication channel.
4303 Return value can be the headline element matched in current parse
4307 ;; First check if id is within the current parse tree.
4312 headline))
4314 ;; Otherwise, look for external files.
4319 "Return radio-target object referenced as LINK destination.
4321 INFO is a plist used as a communication channel.
4323 Return value can be a radio-target object or nil. Assume LINK
4332 nil nil path nil nil t)
4333 t)
4334 radio))
4338 "Return file URI associated to FILENAME."
4345 ;;;; For References
4346 ;;
4347 ;; `org-export-get-reference' associate a unique reference for any
4348 ;; object or element. It uses `org-export-new-reference' and
4349 ;; `org-export-format-reference' to, respectively, generate new
4350 ;; internal references and turn them into a string suitable for
4351 ;; output.
4352 ;;
4353 ;; `org-export-get-ordinal' associates a sequence number to any object
4354 ;; or element.
4357 "Return a unique reference, among REFERENCES.
4358 REFERENCES is an alist whose values are in-use references, as
4359 numbers. Returns a number, which is the internal representation
4360 of a reference. See also `org-export-format-reference'."
4361 ;; Generate random 7 digits hexadecimal numbers. Collisions
4362 ;; increase exponentially with the numbers of references. However,
4363 ;; the odds for encountering at least one collision with 1000 active
4364 ;; references in the same document are roughly 0.2%, so this
4365 ;; shouldn't be the bottleneck.
4368 new))
4371 "Format REFERENCE into a string.
4372 REFERENCE is a number representing a reference, as returned by
4373 `org-export-new-reference', which see."
4377 "Return a unique reference for DATUM, as a string.
4379 DATUM is either an element or an object. INFO is the current
4380 export state, as a plist.
4382 This function checks `:crossrefs' property in INFO for search
4383 cells matching DATUM before creating a new reference. Returned
4384 reference consists of alphanumeric characters only."
4389 ;; If any other published document relies on an
4390 ;; association between a search cell and a reference,
4391 ;; make sure to preserve it. See
4392 ;; `org-publish-resolve-external-link' for details.
4396 ;; Cache contains both data already associated to
4397 ;; a reference and in-use internal references, so as to make
4398 ;; unique references.
4400 ;; Keep an associated related to DATUM as not every object
4401 ;; and element can be associated to a search cell.
4404 reference-string))))
4407 "Return ordinal number of an element or object.
4409 ELEMENT is the element or object considered. INFO is the plist
4410 used as a communication channel.
4412 Optional argument TYPES, when non-nil, is a list of element or
4413 object types, as symbols, that should also be counted in.
4414 Otherwise, only provided element's type is considered.
4416 Optional argument PREDICATE is a function returning a non-nil
4417 value if the current element or object should be counted in. It
4418 accepts two arguments: the element or object being considered and
4419 the plist used as a communication channel. This allows counting
4420 only a certain type of object (i.e. inline images).
4422 Return value is a list of numbers if ELEMENT is a headline or an
4423 item. It is nil for keywords. It represents the footnote number
4424 for footnote definitions and footnote references. If ELEMENT is
4425 a target, return the same value as if ELEMENT was the closest
4426 table, item or headline containing the target. In any other
4427 case, return the sequence number of ELEMENT among elements or
4428 objects of the same type."
4429 ;; Ordinal of a target object refer to the ordinal of the closest
4430 ;; table, item, or headline containing the object.
4434 element
4437 ;; Special case 1: A headline returns its number as a list.
4439 ;; Special case 2: An item returns its number as a list.
4443 struct
4450 ;; Increment counter until ELEMENT is found again.
4461 ;;;; For Src-Blocks
4462 ;;
4463 ;; `org-export-get-loc' counts number of code lines accumulated in
4464 ;; src-block or example-block elements with a "+n" switch until
4465 ;; a given element, excluded. Note: "-n" switches reset that count.
4466 ;;
4467 ;; `org-export-unravel-code' extracts source code (along with a code
4468 ;; references alist) from an `element-block' or `src-block' type
4469 ;; element.
4470 ;;
4471 ;; `org-export-format-code' applies a formatting function to each line
4472 ;; of code, providing relative line number and code reference when
4473 ;; appropriate. Since it doesn't access the original element from
4474 ;; which the source code is coming, it expects from the code calling
4475 ;; it to know if lines should be numbered and if code references
4476 ;; should appear.
4477 ;;
4478 ;; Eventually, `org-export-format-code-default' is a higher-level
4479 ;; function (it makes use of the two previous functions) which handles
4480 ;; line numbering and code references inclusion, and returns source
4481 ;; code in a format suitable for plain text or verbatim output.
4484 "Return count of lines of code before ELEMENT.
4486 ELEMENT is an example-block or src-block element. INFO is the
4487 plist used as a communication channel.
4489 Count includes every line of code in example-block or src-block
4491 ELEMENT doesn't allow line numbering."
4498 ;; ELEMENT is reached: Quit loop and return locs.
4500 ;; Only count lines from src-block and example-block
4501 ;; elements with a "+n" or "-n" switch.
4506 ;; Accumulate locs or reset them.
4514 "Clean source code and extract references out of it.
4516 ELEMENT has either a `src-block' an `example-block' type.
4518 Return a cons cell whose CAR is the source code, cleaned from any
4519 reference, protective commas and spurious indentation, and CDR is
4520 an alist between relative line number (integer) and name of code
4521 reference on that line (string)."
4524 ;; Get code and clean it. Remove blank lines at its
4525 ;; beginning and end.
4532 value
4534 ;; Build a regexp matching a loc with a reference.
4536 ;; Return value.
4538 ;; Code with references removed.
4544 ;; Ref line: remove ref, and signal its position in REFS.
4548 ;; Reference alist.
4549 refs)))
4552 "Format CODE by applying FUN line-wise and return it.
4554 CODE is a string representing the code to format. FUN is
4555 a function. It must accept three arguments: a line of
4556 code (string), the current line number (integer) or nil and the
4557 reference associated to the current line (string) or nil.
4559 Optional argument NUM-LINES can be an integer representing the
4560 number of code lines accumulated until the current code. Line
4561 numbers passed to FUN will take it into account. If it is nil,
4562 FUN's second argument will always be nil. This number can be
4563 obtained with `org-export-get-loc' function.
4565 Optional argument REF-ALIST can be an alist between relative line
4566 number (i.e. ignoring NUM-LINES) and the name of the code
4567 reference on it. If it is nil, FUN's third argument will always
4568 be nil. It can be obtained through the use of
4569 `org-export-unravel-code' function."
4581 "Return source code from ELEMENT, formatted in a standard way.
4583 ELEMENT is either a `src-block' or `example-block' element. INFO
4584 is a plist used as a communication channel.
4586 This function takes care of line numbering and code references
4587 inclusion. Line numbers, when applicable, appear at the
4588 beginning of the line, separated from the code by two white
4589 spaces. Code references, on the other hand, appear flushed to
4590 the right, separated by six white spaces from the widest line of
4591 code."
4592 ;; Extract code and references.
4599 ;; Handle line numbering.
4606 ;; Prepare references display, if required. Any reference
4607 ;; should start six columns after the widest line of code,
4608 ;; wrapped with parenthesis.
4613 code
4617 number-str
4618 loc
4624 num-start refs)))))
4627 ;;;; For Tables
4628 ;;
4629 ;; `org-export-table-has-special-column-p' and and
4630 ;; `org-export-table-row-is-special-p' are predicates used to look for
4631 ;; meta-information about the table structure.
4632 ;;
4633 ;; `org-table-has-header-p' tells when the rows before the first rule
4634 ;; should be considered as table's header.
4635 ;;
4636 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4637 ;; and `org-export-table-cell-borders' extract information from
4638 ;; a table-cell element.
4639 ;;
4640 ;; `org-export-table-dimensions' gives the number on rows and columns
4641 ;; in the table, ignoring horizontal rules and special columns.
4642 ;; `org-export-table-cell-address', given a table-cell object, returns
4643 ;; the absolute address of a cell. On the other hand,
4644 ;; `org-export-get-table-cell-at' does the contrary.
4645 ;;
4646 ;; `org-export-table-cell-starts-colgroup-p',
4647 ;; `org-export-table-cell-ends-colgroup-p',
4648 ;; `org-export-table-row-starts-rowgroup-p',
4649 ;; `org-export-table-row-ends-rowgroup-p',
4650 ;; `org-export-table-row-starts-header-p',
4651 ;; `org-export-table-row-ends-header-p' and
4652 ;; `org-export-table-row-in-header-p' indicate position of current row
4653 ;; or cell within the table.
4656 "Non-nil when TABLE has a special column.
4657 All special columns will be ignored during export."
4658 ;; The table has a special column when every first cell of every row
4659 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4660 ;; "*" "_" and "^". Though, do not consider a first row containing
4661 ;; only empty cells as special.
4675 "Non-nil when TABLE has a header.
4677 INFO is a plist used as a communication channel.
4679 A table has a header when it contains at least two row groups."
4688 table
4699 cache)))))
4702 "Non-nil if TABLE-ROW is considered special.
4703 All special rows will be ignored during export."
4707 ;; A row is special either when...
4709 ;; ... it starts with a field only containing "/",
4711 ;; ... the table contains a special column and the row start
4712 ;; with a marking character among, "^", "_", "$" or "!",
4716 ;; ... it contains only alignment cookies and empty cells.
4721 ;; Since VALUE is a secondary string, the following
4722 ;; checks avoid expanding it with `org-export-data'.
4733 "Return TABLE-ROW's group number, as an integer.
4735 INFO is a plist used as the communication channel.
4737 Return value is the group number, as an integer, or nil for
4738 special rows and rows separators. First group is also table's
4739 header."
4757 "Return TABLE-CELL contents width.
4759 INFO is a plist used as the communication channel.
4761 Return value is the width given by the last width cookie in the
4762 same column as TABLE-CELL, or nil."
4781 ;; In a special row, try to find a width cookie at COLUMN.
4785 ;; The following checks avoid expanding unnecessarily
4786 ;; the cell with `org-export-data'.
4796 "Return TABLE-CELL contents alignment.
4798 INFO is a plist used as the communication channel.
4800 Return alignment as specified by the last alignment cookie in the
4801 same column as TABLE-CELL. If no such cookie is found, a default
4802 alignment value will be deduced from fraction of numbers in the
4803 column (see `org-table-number-fraction' for more information).
4804 Possible values are `left', `right' and `center'."
4805 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4822 cookie-align
4823 previous-cell-number-p)
4826 ;; In a special row, try to find an alignment cookie at
4827 ;; COLUMN.
4831 ;; Since VALUE is a secondary string, the following
4832 ;; checks avoid useless expansion through
4833 ;; `org-export-data'.
4841 ;; Ignore table rules.
4843 ;; In a standard row, check if cell's contents are
4844 ;; expressing some kind of number. Increase NUMBER-CELLS
4845 ;; accordingly. Though, don't bother if an alignment
4846 ;; cookie has already defined cell's alignment.
4851 info)))
4853 ;; Treat an empty cell as a number if it follows
4854 ;; a number.
4860 ;; Return value. Alignment specified by cookies has
4861 ;; precedence over alignment deduced from cell's contents.
4863 column
4868 org-table-number-fraction)
4873 "Return TABLE-CELL borders.
4875 INFO is a plist used as a communication channel.
4877 Return value is a list of symbols, or nil. Possible values are:
4878 `top', `bottom', `above', `below', `left' and `right'. Note:
4879 `top' (resp. `bottom') only happen for a cell in the first
4880 row (resp. last row) of the table, ignoring table rules, if any.
4882 Returned borders ignore special rows."
4885 borders)
4886 ;; Top/above border? TABLE-CELL has a border above when a rule
4887 ;; used to demarcate row groups can be found above. Hence,
4888 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4889 ;; another regular row has to be found above that rule.
4892 ;; Look at every row before the current one.
4899 ;; No rule above, or rule found starts the table (ignoring any
4900 ;; special row): TABLE-CELL is at the top of the table.
4903 ;; Bottom/below border? TABLE-CELL has a border below when next
4904 ;; non-regular row below is a rule.
4907 ;; Look at every row after the current one.
4914 ;; No rule below, or rule found ends the table (modulo some
4915 ;; special row): TABLE-CELL is at the bottom of the table.
4918 ;; Right/left borders? They can only be specified by column
4919 ;; groups. Column groups are defined in a row starting with "/".
4920 ;; Also a column groups row only contains "<", "<>", ">" or blank
4921 ;; cells.
4925 ;; Table rows are read in reverse order so last column groups
4926 ;; row has precedence over any previous one.
4939 ;; There's a left border when previous cell, if
4940 ;; any, ends a group, or current one starts one.
4946 ;; There's a right border when next cell, if any,
4947 ;; starts a group, or current one ends one.
4954 ;; Return value.
4955 borders))
4958 "Non-nil when TABLE-CELL is at the beginning of a column group.
4959 INFO is a plist used as a communication channel."
4960 ;; A cell starts a column group either when it is at the beginning
4961 ;; of a row (or after the special column, if any) or when it has
4962 ;; a left border.
4965 table-cell)
4969 "Non-nil when TABLE-CELL is at the end of a column group.
4970 INFO is a plist used as a communication channel."
4971 ;; A cell ends a column group either when it is at the end of a row
4972 ;; or when it has a right border.
4975 table-cell)
4979 "Non-nil when TABLE-ROW is at the beginning of a row group.
4980 INFO is a plist used as a communication channel."
4988 "Non-nil when TABLE-ROW is at the end of a row group.
4989 INFO is a plist used as a communication channel."
4997 "Non-nil when TABLE-ROW is located within table's header.
4998 INFO is a plist used as a communication channel. Always return
4999 nil for special rows and rows separators."
5005 "Non-nil when TABLE-ROW is the first table header's row.
5006 INFO is a plist used as a communication channel."
5011 "Non-nil when TABLE-ROW is the last table header's row.
5012 INFO is a plist used as a communication channel."
5017 "Return TABLE-ROW number.
5018 INFO is a plist used as a communication channel. Return value is
5019 zero-based and ignores separators. The function returns nil for
5020 special columns and separators."
5032 "Return TABLE dimensions.
5034 INFO is a plist used as a communication channel.
5036 Return value is a CONS like (ROWS . COLUMNS) where
5037 ROWS (resp. COLUMNS) is the number of exportable
5038 rows (resp. columns)."
5040 ;; Set number of rows, and extract first one.
5046 ;; Set number of columns.
5048 ;; Return value.
5052 "Return address of a regular TABLE-CELL object.
5054 TABLE-CELL is the cell considered. INFO is a plist used as
5055 a communication channel.
5057 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5058 zero-based index. Only exportable cells are considered. The
5059 function returns nil for other cells."
5071 "Return regular table-cell object at ADDRESS in TABLE.
5073 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5074 zero-based index. TABLE is a table type element. INFO is
5075 a plist used as a communication channel.
5077 If no table-cell, among exportable cells, is found at ADDRESS,
5078 return nil."
5081 ;; Row at (car address) or nil.
5089 'table-cell
5096 ;;;; For Tables Of Contents
5097 ;;
5098 ;; `org-export-collect-headlines' builds a list of all exportable
5099 ;; headline elements, maybe limited to a certain depth. One can then
5100 ;; easily parse it and transcode it.
5101 ;;
5102 ;; Building lists of tables, figures or listings is quite similar.
5103 ;; Once the generic function `org-export-collect-elements' is defined,
5104 ;; `org-export-collect-tables', `org-export-collect-figures' and
5105 ;; `org-export-collect-listings' can be derived from it.
5108 "Collect headlines in order to build a table of contents.
5110 INFO is a plist used as a communication channel.
5112 When optional argument N is an integer, it specifies the depth of
5113 the table of contents. Otherwise, it is set to the value of the
5114 last headline level. See `org-export-headline-levels' for more
5115 information.
5117 Optional argument SCOPE, when non-nil, is an element. If it is
5118 a headline, only children of SCOPE are collected. Otherwise,
5119 collect children of the headline containing provided element. If
5120 there is no such headline, collect all headlines. In any case,
5121 argument N becomes relative to the level of that headline.
5123 Return a list of all exportable headlines as parsed elements.
5124 Footnote sections are ignored."
5133 limit))))
5139 info)))
5142 "Collect referenceable elements of a determined type.
5144 TYPE can be a symbol or a list of symbols specifying element
5145 types to search. Only elements with a caption are collected.
5147 INFO is a plist used as a communication channel.
5149 When non-nil, optional argument PREDICATE is a function accepting
5150 one argument, an element of type TYPE. It returns a non-nil
5151 value when that element should be collected.
5153 Return a list of all elements found, in order of appearance."
5158 element))
5159 info))
5162 "Build a list of tables.
5163 INFO is a plist used as a communication channel.
5165 Return a list of table elements with a caption."
5169 "Build a list of figures.
5171 INFO is a plist used as a communication channel. PREDICATE is
5172 a function which accepts one argument: a paragraph element and
5173 whose return value is non-nil when that element should be
5174 collected.
5176 A figure is a paragraph type element, with a caption, verifying
5178 a vague concept that may depend on back-end.
5180 Return a list of elements recognized as figures."
5184 "Build a list of src blocks.
5186 INFO is a plist used as a communication channel.
5188 Return a list of src-block elements with a caption."
5192 ;;;; Smart Quotes
5193 ;;
5194 ;; The main function for the smart quotes sub-system is
5195 ;; `org-export-activate-smart-quotes', which replaces every quote in
5196 ;; a given string from the parse tree with its "smart" counterpart.
5197 ;;
5198 ;; Dictionary for smart quotes is stored in
5199 ;; `org-export-smart-quotes-alist'.
5203 ;; one may use: »...«, "...", ›...‹, or '...'.
5204 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5205 ;; LaTeX quotes require Babel!
5265 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5276 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5287 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5298 ;; 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
5299 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5310 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5316 "Smart quotes translations.
5318 Alist whose CAR is a language string and CDR is an alist with
5319 quote type as key and a plist associating various encodings to
5320 their translation as value.
5322 A quote type can be any symbol among `primary-opening',
5323 `primary-closing', `secondary-opening', `secondary-closing' and
5324 `apostrophe'.
5326 Valid encodings include `:utf-8', `:html', `:latex' and
5327 `:texinfo'.
5332 "Return smart quote status at the beginning of string S.
5333 INFO is the current export state, as a plist."
5338 table)))
5346 'plain-text
5355 ;; Not already in a level 1 quote: this is an
5356 ;; apostrophe.
5358 ;; Extract previous char and next char. As
5359 ;; a special case, they can also be set to `blank',
5360 ;; `no-blank' or nil. Then determine if current
5361 ;; match is allowed as an opening quote or a closing
5362 ;; quote.
5367 text info)))
5384 previous)
5395 next)
5402 current-status)
5406 info nil org-element-recursive-objects)
5413 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5414 `:utf-8'. INFO is a plist used as a communication channel.
5416 The function has to retrieve information about string
5417 surroundings in parse tree. It can only happen with an
5418 unmodified string. Thus, if S has already been through another
5419 process, a non-nil ORIGINAL optional argument will provide that
5420 original string.
5422 Return the new string."
5431 org-export-smart-quotes-alist))))
5432 encoding)
5433 match))
5434 s nil t)))
5436 ;;;; Topology
5437 ;;
5438 ;; Here are various functions to retrieve information about the
5439 ;; neighborhood of a given element or object. Neighbors of interest
5440 ;; are direct parent (`org-export-get-parent'), parent headline
5441 ;; (`org-export-get-parent-headline'), first element containing an
5442 ;; object, (`org-export-get-parent-element'), parent table
5443 ;; (`org-export-get-parent-table'), previous element or object
5444 ;; (`org-export-get-previous-element') and next element or object
5445 ;; (`org-export-get-next-element').
5447 ;; defsubst org-export-get-parent must be defined before first use
5450 "Return BLOB parent headline or nil.
5451 BLOB is the element or object being considered."
5455 "Return first element containing OBJECT or nil.
5456 OBJECT is the object to consider."
5460 "Return OBJECT parent table or nil.
5461 OBJECT is either a `table-cell' or `table-element' type object."
5465 "Return previous element or object.
5467 BLOB is an element or object. INFO is a plist used as
5468 a communication channel. Return previous exportable element or
5469 object, a string, or nil.
5471 When optional argument N is a positive integer, return a list
5472 containing up to N siblings before BLOB, from farthest to
5473 closest. With any other non-nil value, return a list containing
5474 all of them."
5480 prev)
5490 "Return next element or object.
5492 BLOB is an element or object. INFO is a plist used as
5493 a communication channel. Return next exportable element or
5494 object, a string, or nil.
5496 When optional argument N is a positive integer, return a list
5497 containing up to N siblings after BLOB, from closest to farthest.
5498 With any other non-nil value, return a list containing all of
5499 them."
5506 next)
5516 ;;;; Translation
5517 ;;
5518 ;; `org-export-translate' translates a string according to the language
5519 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5520 ;; the dictionary used for the translation.
5552 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5562 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5568 ("ru" :html "(Продолжение следует)"
5645 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5668 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5674 ("ru" :html "Список распечаток"
5689 ("ru" :html "Список таблиц"
5797 ("ru" :html "Неизвестная ссылка"
5800 "Dictionary for export engine.
5802 Alist whose car is the string to translate and cdr is an alist
5803 whose car is the language string and cdr is a plist whose
5804 properties are possible charsets and values translated terms.
5806 It is used as a database for `org-export-translate'. Since this
5807 function returns the string as-is if no translation was found,
5808 the variable only needs to record values different from the
5812 "Translate string S according to language specification.
5814 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5815 and `:utf-8'. INFO is a plist used as a communication channel.
5817 Translation depends on `:language' property. Return the
5818 translated string. If no translation is found, try to fall back
5819 to `:default' encoding. If it fails, return S."
5825 s)))
5828 \f
5829 ;;; Asynchronous Export
5830 ;;
5831 ;; `org-export-async-start' is the entry point for asynchronous
5832 ;; export. It recreates current buffer (including visibility,
5833 ;; narrowing and visited file) in an external Emacs process, and
5834 ;; evaluates a command there. It then applies a function on the
5835 ;; returned results in the current process.
5836 ;;
5837 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5838 ;; allow exporting to a buffer or a file, asynchronously or not.
5839 ;;
5840 ;; `org-export-output-file-name' is an auxiliary function meant to be
5841 ;; used with `org-export-to-file'. With a given extension, it tries
5842 ;; to provide a canonical file name to write export output to.
5843 ;;
5844 ;; Asynchronously generated results are never displayed directly.
5845 ;; Instead, they are stored in `org-export-stack-contents'. They can
5846 ;; then be retrieved by calling `org-export-stack'.
5847 ;;
5848 ;; Export Stack is viewed through a dedicated major mode
5849 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5850 ;;`org-export-stack-delete', `org-export-stack-view' and
5851 ;;`org-export-stack-clear'.
5852 ;;
5853 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5854 ;; It should be used whenever `org-export-async-start' is called.
5857 "Call function FUN on the results returned by BODY evaluation.
5859 FUN is an anonymous function of one argument. BODY evaluation
5860 happens in an asynchronous process, from a buffer which is an
5861 exact copy of the current one.
5863 Use `org-export-add-to-stack' in FUN in order to register results
5864 in the stack.
5866 This is a low level function. See also `org-export-to-buffer'
5867 and `org-export-to-file' for more specialized functions."
5870 ;; Write the full sexp evaluating BODY in a copy of the current
5871 ;; buffer to a temporary file, as it may be too long for program
5872 ;; args in `start-process'.
5879 ;; Null characters (from variable values) are inserted
5880 ;; within the file. As a consequence, coding system for
5881 ;; buffer contents will not be recognized properly. So,
5882 ;; we make sure it is the same as the one used to display
5883 ;; the original buffer.
5885 ,coding
5888 ;; Ignore `kill-emacs-hook' and code evaluation
5889 ;; queries from Babel as we need a truly
5890 ;; non-interactive process.
5892 org-babel-confirm-evaluate-answer-no t)
5893 ;; Initialize export framework.
5895 ;; Re-create current buffer there.
5898 ;; Sexp to evaluate in the buffer.
5900 ;; Start external process.
5903 (,process
5905 #'start-process
5908 ,proc-buffer
5915 ;; Register running process in stack.
5917 ;; Set-up sentinel in order to catch results.
5920 ,process
5942 ;;;###autoload
5945 &optional async subtreep visible-only body-only ext-plist
5946 post-process)
5947 "Call `org-export-as' with output to a specified buffer.
5949 BACKEND is either an export back-end, as returned by, e.g.,
5950 `org-export-create-backend', or a symbol referring to
5951 a registered back-end.
5953 BUFFER is the name of the output buffer. If it already exists,
5954 it will be erased first, otherwise, it will be created.
5956 A non-nil optional argument ASYNC means the process should happen
5957 asynchronously. The resulting buffer should then be accessible
5958 through the `org-export-stack' interface. When ASYNC is nil, the
5959 buffer is displayed if `org-export-show-temporary-export-buffer'
5960 is non-nil.
5962 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5963 EXT-PLIST are similar to those used in `org-export-as', which
5964 see.
5966 Optional argument POST-PROCESS is a function which should accept
5967 no argument. It is always called within the current process,
5968 from BUFFER, with point at its beginning. Export back-ends can
5969 use it to set a major mode there, e.g,
5971 (defun org-latex-export-as-latex
5972 (&optional async subtreep visible-only body-only ext-plist)
5973 (interactive)
5975 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5977 This function returns BUFFER."
6005 buffer)))
6007 ;;;###autoload
6010 post-process)
6011 "Call `org-export-as' with output to a specified file.
6013 BACKEND is either an export back-end, as returned by, e.g.,
6014 `org-export-create-backend', or a symbol referring to
6015 a registered back-end. FILE is the name of the output file, as
6016 a string.
6018 A non-nil optional argument ASYNC means the process should happen
6019 asynchronously. The resulting buffer will then be accessible
6020 through the `org-export-stack' interface.
6022 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
6023 EXT-PLIST are similar to those used in `org-export-as', which
6024 see.
6026 Optional argument POST-PROCESS is called with FILE as its
6027 argument and happens asynchronously when ASYNC is non-nil. It
6028 has to return a file name, or nil. Export back-ends can use this
6029 to send the output file through additional processing, e.g,
6031 (defun org-latex-export-to-latex
6032 (&optional async subtreep visible-only body-only ext-plist)
6033 (interactive)
6036 async subtreep visible-only body-only ext-plist
6037 (lambda (file) (org-latex-compile file)))
6039 The function returns either a file name returned by POST-PROCESS,
6040 or FILE."
6059 backend subtreep visible-only body-only ext-plist)))
6066 ;; Get proper return value.
6068 file))))))
6071 "Return output file's name according to buffer specifications.
6073 EXTENSION is a string representing the output file extension,
6074 with the leading dot.
6076 With a non-nil optional argument SUBTREEP, try to determine
6078 of subtree at point.
6080 When optional argument PUB-DIR is set, use it as the publishing
6081 directory.
6083 Return file name as a string."
6086 ;; File name may come from EXPORT_FILE_NAME subtree
6087 ;; property.
6090 ;; File name may be extracted from buffer's associated
6091 ;; file, if any.
6093 ;; Can't determine file name on our own: Ask user.
6095 "Output file: " pub-dir nil nil nil
6099 ;; Build file name. Enforce EXTENSION over whatever user
6100 ;; may have come up with. PUB-DIR, if defined, always has
6101 ;; precedence over any provided path.
6106 extension))
6109 ;; If writing to OUTPUT-FILE would overwrite original file, append
6110 ;; EXTENSION another time to final name.
6113 output-file)))
6116 "Add a new result to export stack if not present already.
6118 SOURCE is a buffer or a file name containing export results.
6119 BACKEND is a symbol representing export back-end used to generate
6120 it.
6122 Entries already pointing to SOURCE and unavailable entries are
6123 removed beforehand. Return the new stack."
6129 "Menu for asynchronous export results and running processes."
6139 "Remove all entries from export stack."
6144 "Refresh the export stack."
6149 "Remove export results at point from stack.
6150 If optional argument SOURCE is non-nil, remove it instead."
6155 org-export-stack-contents))))
6158 "View export results at point in stack.
6159 With an optional prefix argument IN-EMACS, force viewing files
6160 within Emacs."
6174 (define-key km "\C-p" 'previous-line)
6175 (define-key km "\C-?" 'previous-line)
6176 (define-key km [up] 'previous-line)
6177 (define-key km "C" 'org-export-stack-clear)
6178 (define-key km "v" 'org-export-stack-view)
6179 (define-key km (kbd "RET") 'org-export-stack-view)
6180 (define-key km "d" 'org-export-stack-remove)
6181 km)
6182 "Keymap for Org Export Stack.")
6184 (define-derived-mode org-export-stack-mode tabulated-list-mode "Org-Stack"
6185 "Mode for displaying asynchronous export stack.
6188 stack.
6190 In an Org Export Stack buffer, use \
6194 stack completely.
6196 Removing entries in a stack buffer does not affect files
6197 or buffers, only display.
6200 (setq tabulated-list-format
6201 (vector (list "#" 4 #'org-export--stack-num-predicate)
6202 (list "Back-End" 12 t)
6203 (list "Age" 6 nil)
6204 (list "Source" 0 nil)))
6205 (setq tabulated-list-sort-key (cons "#" nil))
6206 (setq tabulated-list-entries #'org-export--stack-generate)
6207 (add-hook 'tabulated-list-revert-hook #'org-export--stack-generate nil t)
6208 (add-hook 'post-command-hook #'org-export-stack-refresh nil t)
6209 (tabulated-list-init-header))
6211 (defun org-export--stack-generate ()
6212 "Generate the asynchronous export stack for display.
6213 Unavailable sources are removed from the list. Return a list
6214 appropriate for `tabulated-list-print'."
6215 ;; Clear stack from exited processes, dead buffers or non-existent
6216 ;; files.
6217 (setq org-export-stack-contents
6218 (cl-remove-if-not
6219 (lambda (el)
6220 (if (processp (nth 2 el))
6221 (buffer-live-p (process-buffer (nth 2 el)))
6222 (let ((source (car el)))
6223 (if (bufferp source) (buffer-live-p source)
6224 (file-exists-p source)))))
6225 org-export-stack-contents))
6226 ;; Update `tabulated-list-entries'.
6227 (let ((counter 0))
6228 (mapcar
6229 (lambda (entry)
6230 (let ((source (car entry)))
6231 (list source
6232 (vector
6233 ;; Counter.
6234 (number-to-string (cl-incf counter))
6235 ;; Back-End.
6236 (if (nth 1 entry) (symbol-name (nth 1 entry)) "")
6237 ;; Age.
6238 (let ((info (nth 2 entry)))
6239 (if (processp info) (symbol-name (process-status info))
6240 (format-seconds "%h:%.2m" (float-time (time-since info)))))
6241 ;; Source.
6242 (if (stringp source) source (buffer-name source))))))
6243 org-export-stack-contents)))
6245 (defun org-export--stack-num-predicate (a b)
6246 (< (string-to-number (aref (nth 1 a) 0))
6247 (string-to-number (aref (nth 1 b) 0))))
6249 (defun org-export--stack-source-at-point ()
6250 "Return source from export results at point in stack."
6251 (let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
6252 (if (not source) (error "Source unavailable, please refresh buffer")
6253 (let ((source-name (if (stringp source) source (buffer-name source))))
6254 (if (save-excursion
6255 (beginning-of-line)
6256 (looking-at-p (concat ".* +" (regexp-quote source-name) "$")))
6257 source
6258 ;; SOURCE is not consistent with current line. The stack
6259 ;; view is outdated.
6260 (error (substitute-command-keys
6262 to refresh buffer")))))))
6265 \f
6266 ;;; The Dispatcher
6267 ;;
6268 ;; `org-export-dispatch' is the standard interactive way to start an
6269 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6270 ;; for its interface, which, in turn, delegates response to key
6271 ;; pressed to `org-export--dispatch-action'.
6273 ;;;###autoload
6274 (defun org-export-dispatch (&optional arg)
6275 "Export dispatcher for Org mode.
6277 It provides an access to common export related tasks in a buffer.
6278 Its interface comes in two flavors: standard and expert.
6280 While both share the same set of bindings, only the former
6281 displays the valid keys associations in a dedicated buffer.
6282 Scrolling (resp. line-wise motion) in this buffer is done with
6283 SPC and DEL (resp. C-n and C-p) keys.
6285 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6286 flavor or the other.
6289 same
6290 set of options used back then, on the current buffer.
6293 asynchronous export stack."
6294 (interactive "P")
6295 (let* ((input
6296 (cond ((equal arg '(16)) '(stack))
6297 ((and arg org-export-dispatch-last-action))
6298 (t (save-window-excursion
6299 (unwind-protect
6300 (progn
6301 ;; Remember where we are
6302 (move-marker org-export-dispatch-last-position
6303 (point)
6304 (org-base-buffer (current-buffer)))
6305 ;; Get and store an export command
6306 (setq org-export-dispatch-last-action
6307 (org-export--dispatch-ui
6308 (list org-export-initial-scope
6309 (and org-export-in-background 'async))
6310 nil
6311 org-export-dispatch-use-expert-ui)))
6312 (and (get-buffer "*Org Export Dispatcher*")
6313 (kill-buffer "*Org Export Dispatcher*")))))))
6314 (action (car input))
6315 (optns (cdr input)))
6316 (unless (memq 'subtree optns)
6317 (move-marker org-export-dispatch-last-position nil))
6318 (cl-case action
6319 ;; First handle special hard-coded actions.
6320 (template (org-export-insert-default-template nil optns))
6321 (stack (org-export-stack))
6322 (publish-current-file
6323 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6324 (publish-current-project
6325 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6326 (publish-choose-project
6327 (org-publish (assoc (completing-read
6328 "Publish project: "
6329 org-publish-project-alist nil t)
6330 org-publish-project-alist)
6331 (memq 'force optns)
6332 (memq 'async optns)))
6333 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6334 (otherwise
6335 (save-excursion
6336 (when arg
6337 ;; Repeating command, maybe move cursor to restore subtree
6338 ;; context.
6339 (if (eq (marker-buffer org-export-dispatch-last-position)
6340 (org-base-buffer (current-buffer)))
6341 (goto-char org-export-dispatch-last-position)
6342 ;; We are in a different buffer, forget position.
6343 (move-marker org-export-dispatch-last-position nil)))
6344 (funcall action
6345 ;; Return a symbol instead of a list to ease
6346 ;; asynchronous export macro use.
6347 (and (memq 'async optns) t)
6348 (and (memq 'subtree optns) t)
6349 (and (memq 'visible optns) t)
6350 (and (memq 'body optns) t)))))))
6352 (defun org-export--dispatch-ui (options first-key expertp)
6353 "Handle interface for `org-export-dispatch'.
6355 OPTIONS is a list containing current interactive options set for
6356 export. It can contain any of the following symbols:
6357 `body' toggles a body-only export
6358 `subtree' restricts export to current subtree
6359 `visible' restricts export to visible part of buffer.
6360 `force' force publishing files.
6361 `async' use asynchronous export process
6363 FIRST-KEY is the key pressed to select the first level menu. It
6364 is nil when this menu hasn't been selected yet.
6366 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6367 buffer is provided, but indications about currently active
6368 options are given in the prompt. Moreover, [?] allows switching
6369 back to standard interface."
6370 (let* ((fontify-key
6371 (lambda (key &optional access-key)
6372 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6373 ;; non-nil is the required first-level key to activate
6374 ;; KEY. When its value is t, activate KEY independently
6375 ;; on the first key, if any. A nil value means KEY will
6376 ;; only be activated at first level.
6377 (if (or (eq access-key t) (eq access-key first-key))
6378 (propertize key 'face 'org-warning)
6379 key)))
6380 (fontify-value
6381 (lambda (value)
6382 ;; Fontify VALUE string.
6383 (propertize value 'face 'font-lock-variable-name-face)))
6384 ;; Prepare menu entries by extracting them from registered
6385 ;; back-ends and sorting them by access key and by ordinal,
6386 ;; if any.
6387 (entries
6388 (sort (sort (delq nil
6389 (mapcar #'org-export-backend-menu
6390 org-export-registered-backends))
6391 (lambda (a b)
6392 (let ((key-a (nth 1 a))
6393 (key-b (nth 1 b)))
6394 (cond ((and (numberp key-a) (numberp key-b))
6395 (< key-a key-b))
6396 ((numberp key-b) t)))))
6397 'car-less-than-car))
6398 ;; Compute a list of allowed keys based on the first key
6399 ;; pressed, if any. Some keys
6400 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6401 ;; available.
6402 (allowed-keys
6403 (nconc (list 2 22 19 6 1)
6404 (if (not first-key) (org-uniquify (mapcar 'car entries))
6405 (let (sub-menu)
6406 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6407 (when (eq (car entry) first-key)
6408 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6409 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6410 ((not first-key) (list ?P)))
6411 (list ?& ?#)
6412 (when expertp (list ??))
6413 (list ?q)))
6414 ;; Build the help menu for standard UI.
6415 (help
6416 (unless expertp
6417 (concat
6418 ;; Options are hard-coded.
6419 (format "[%s] Body only: %s [%s] Visible only: %s
6420 \[%s] Export scope: %s [%s] Force publishing: %s
6422 (funcall fontify-key "C-b" t)
6423 (funcall fontify-value
6424 (if (memq 'body options) "On " "Off"))
6425 (funcall fontify-key "C-v" t)
6426 (funcall fontify-value
6427 (if (memq 'visible options) "On " "Off"))
6428 (funcall fontify-key "C-s" t)
6429 (funcall fontify-value
6430 (if (memq 'subtree options) "Subtree" "Buffer "))
6431 (funcall fontify-key "C-f" t)
6432 (funcall fontify-value
6433 (if (memq 'force options) "On " "Off"))
6434 (funcall fontify-key "C-a" t)
6435 (funcall fontify-value
6436 (if (memq 'async options) "On " "Off")))
6437 ;; Display registered back-end entries. When a key
6438 ;; appears for the second time, do not create another
6439 ;; entry, but append its sub-menu to existing menu.
6440 (let (last-key)
6441 (mapconcat
6442 (lambda (entry)
6443 (let ((top-key (car entry)))
6444 (concat
6445 (unless (eq top-key last-key)
6446 (setq last-key top-key)
6448 (funcall fontify-key (char-to-string top-key))
6449 (nth 1 entry)))
6450 (let ((sub-menu (nth 2 entry)))
6451 (unless (functionp sub-menu)
6452 ;; Split sub-menu into two columns.
6453 (let ((index -1))
6454 (concat
6455 (mapconcat
6456 (lambda (sub-entry)
6457 (cl-incf index)
6458 (format
6459 (if (zerop (mod index 2)) " [%s] %-26s"
6461 (funcall fontify-key
6462 (char-to-string (car sub-entry))
6463 top-key)
6464 (nth 1 sub-entry)))
6465 sub-menu "")
6467 entries ""))
6468 ;; Publishing menu is hard-coded.
6470 [%s] Current file [%s] Current project
6472 (funcall fontify-key "P")
6473 (funcall fontify-key "f" ?P)
6474 (funcall fontify-key "p" ?P)
6475 (funcall fontify-key "x" ?P)
6476 (funcall fontify-key "a" ?P))
6478 (funcall fontify-key "&" t)
6479 (funcall fontify-key "#" t))
6480 (format "[%s] %s"
6481 (funcall fontify-key "q" t)
6482 (if first-key "Main menu" "Exit")))))
6483 ;; Build prompts for both standard and expert UI.
6484 (standard-prompt (unless expertp "Export command: "))
6485 (expert-prompt
6486 (when expertp
6487 (format
6488 "Export command (C-%s%s%s%s%s) [%s]: "
6489 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6490 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6491 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6492 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6493 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6494 (mapconcat (lambda (k)
6495 ;; Strip control characters.
6496 (unless (< k 27) (char-to-string k)))
6497 allowed-keys "")))))
6498 ;; With expert UI, just read key with a fancy prompt. In standard
6499 ;; UI, display an intrusive help buffer.
6500 (if expertp
6501 (org-export--dispatch-action
6502 expert-prompt allowed-keys entries options first-key expertp)
6503 ;; At first call, create frame layout in order to display menu.
6504 (unless (get-buffer "*Org Export Dispatcher*")
6505 (delete-other-windows)
6506 (org-switch-to-buffer-other-window
6507 (get-buffer-create "*Org Export Dispatcher*"))
6508 (setq cursor-type nil
6509 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6510 ;; Make sure that invisible cursor will not highlight square
6511 ;; brackets.
6512 (set-syntax-table (copy-syntax-table))
6513 (modify-syntax-entry ?\[ "w"))
6514 ;; At this point, the buffer containing the menu exists and is
6515 ;; visible in the current window. So, refresh it.
6516 (with-current-buffer "*Org Export Dispatcher*"
6517 ;; Refresh help. Maintain display continuity by re-visiting
6518 ;; previous window position.
6519 (let ((pos (window-start)))
6520 (erase-buffer)
6521 (insert help)
6522 (set-window-start nil pos)))
6523 (org-fit-window-to-buffer)
6524 (org-export--dispatch-action
6525 standard-prompt allowed-keys entries options first-key expertp))))
6527 (defun org-export--dispatch-action
6528 (prompt allowed-keys entries options first-key expertp)
6529 "Read a character from command input and act accordingly.
6531 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6532 a list of characters available at a given step in the process.
6533 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6534 EXPERTP are the same as defined in `org-export--dispatch-ui',
6535 which see.
6537 Toggle export options when required. Otherwise, return value is
6538 a list with action as CAR and a list of interactive export
6539 options as CDR."
6540 (let (key)
6541 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6542 ;; C-p, SPC, DEL).
6543 (while (and (setq key (read-char-exclusive prompt))
6544 (not expertp)
6545 (memq key '(14 16 ?\s ?\d)))
6546 (cl-case key
6547 (14 (if (not (pos-visible-in-window-p (point-max)))
6548 (ignore-errors (scroll-up 1))
6549 (message "End of buffer")
6550 (sit-for 1)))
6551 (16 (if (not (pos-visible-in-window-p (point-min)))
6552 (ignore-errors (scroll-down 1))
6553 (message "Beginning of buffer")
6554 (sit-for 1)))
6555 (?\s (if (not (pos-visible-in-window-p (point-max)))
6556 (scroll-up nil)
6557 (message "End of buffer")
6558 (sit-for 1)))
6559 (?\d (if (not (pos-visible-in-window-p (point-min)))
6560 (scroll-down nil)
6561 (message "Beginning of buffer")
6562 (sit-for 1)))))
6563 (cond
6564 ;; Ignore undefined associations.
6565 ((not (memq key allowed-keys))
6566 (ding)
6567 (unless expertp (message "Invalid key") (sit-for 1))
6568 (org-export--dispatch-ui options first-key expertp))
6569 ;; q key at first level aborts export. At second level, cancel
6570 ;; first key instead.
6571 ((eq key ?q) (if (not first-key) (error "Export aborted")
6572 (org-export--dispatch-ui options nil expertp)))
6573 ;; Help key: Switch back to standard interface if expert UI was
6574 ;; active.
6575 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6576 ;; Send request for template insertion along with export scope.
6577 ((eq key ?#) (cons 'template (memq 'subtree options)))
6578 ;; Switch to asynchronous export stack.
6579 ((eq key ?&) '(stack))
6580 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6581 ((memq key '(2 22 19 6 1))
6582 (org-export--dispatch-ui
6583 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6584 (6 'force) (1 'async))))
6585 (if (memq option options) (remq option options)
6586 (cons option options)))
6587 first-key expertp))
6588 ;; Action selected: Send key and options back to
6589 ;; `org-export-dispatch'.
6590 ((or first-key (functionp (nth 2 (assq key entries))))
6591 (cons (cond
6592 ((not first-key) (nth 2 (assq key entries)))
6593 ;; Publishing actions are hard-coded. Send a special
6594 ;; signal to `org-export-dispatch'.
6595 ((eq first-key ?P)
6596 (cl-case key
6597 (?f 'publish-current-file)
6598 (?p 'publish-current-project)
6599 (?x 'publish-choose-project)
6600 (?a 'publish-all)))
6601 ;; Return first action associated to FIRST-KEY + KEY
6602 ;; path. Indeed, derived backends can share the same
6603 ;; FIRST-KEY.
6604 (t (catch 'found
6605 (dolist (entry (member (assq first-key entries) entries))
6606 (let ((match (assq key (nth 2 entry))))
6607 (when match (throw 'found (nth 2 match))))))))
6608 options))
6609 ;; Otherwise, enter sub-menu.
6610 (t (org-export--dispatch-ui options key expertp)))))
6614 (provide 'ox)
6616 ;; Local variables:
6617 ;; generated-autoload-file: "org-loaddefs.el"
6618 ;; End:
6620 ;;; ox.el ends here