| blob | 499badc9c77986bca1a58952d13b1bf48ae7dbc6 |
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:
90 \f
91 ;;; Internal Variables
92 ;;
93 ;; Among internal variables, the most important is
94 ;; `org-export-options-alist'. This variable define the global export
95 ;; options, shared between every exporter, and how they are acquired.
141 "Alist between export properties and ways to set them.
143 The key of the alist is the property name, and the value is a list
144 like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
146 KEYWORD is a string representing a buffer keyword, or nil. Each
147 property defined this way can also be set, during subtree
148 export, through a headline property named after the keyword
150 property).
151 OPTION is a string that could be found in an #+OPTIONS: line.
152 DEFAULT is the default value for the property.
153 BEHAVIOR determines how Org should handle multiple keywords for
154 the same property. It is a symbol among:
155 nil Keep old value and discard the new one.
156 t Replace old value with the new one.
157 `space' Concatenate the values, separating them with a space.
158 `newline' Concatenate the values, separating them with
159 a newline.
160 `split' Split values at white spaces, and cons them to the
161 previous list.
162 `parse' Parse value as a list of strings and Org objects,
163 which can then be transcoded with, e.g.,
164 `org-export-data'. It implies `space' behavior.
166 Values set through KEYWORD and OPTION have precedence over
167 DEFAULT.
169 All these properties should be back-end agnostic. Back-end
170 specific properties are set through `org-export-define-backend'.
174 "List of in-buffer keywords that require special treatment.
175 These keywords are not directly associated to a property. The
176 way they are handled must be hard-coded into
234 "Alist between filters properties and initial values.
236 The key of each association is a property name accessible through
237 the communication channel. Its value is a configurable global
238 variable defining initial filters.
240 This list is meant to install user specified filters. Back-end
241 developers may install their own filters using
242 `org-export-define-backend'. Filters defined there will always
243 be prepended to the current list, so they always get applied
252 "Default rule for link matching an inline image.
253 This rule applies to links with no description. By default, it
254 will be considered as an inline image if it targets a local file
257 See `org-export-inline-image-p' for more information about
262 org-element--cache org-element--cache-objects org-element--cache-sync-keys
263 org-element--cache-sync-requests org-element--cache-sync-timer)
264 "List of variables not copied through upon buffer duplication.
265 Export process takes place on a copy of the original buffer.
266 When this copy is created, all Org related local variables not in
267 this list are copied to the new buffer. Variables with an
271 "Non-nil means asynchronous export process should leave data behind.
275 located in `temporary-file-directory'.
277 When non-nil, it will also set `debug-on-error' to a non-nil
281 "Record asynchronously generated export results and processes.
282 This is an alist: its CAR is the source of the
283 result (destination file or buffer for a finished process,
284 original buffer for a running one) and its CDR is a list
285 containing the back-end used, as a symbol, and either a process
286 or the time at which it finished. It is used to build the menu
290 "List of backends currently available in the exporter.
291 This variable is set with `org-export-define-backend' and
295 "Last command called from the dispatcher.
296 The value should be a list. Its CAR is the action, as a symbol,
300 "The position where the last export command was created using the dispatcher.
301 This marker will be used with `C-u C-c C-e' to make sure export repetition
304 ;; For compatibility with Org < 8
306 "Name, if any, of the back-end used during an export process.
308 Its value is a symbol such as `html', `latex', `ascii', or nil if
309 the back-end is anonymous (see `org-export-create-backend') or if
310 there is no export process in progress.
312 It can be used to teach Babel blocks how to act differently
316 \f
317 ;;; User-configurable Variables
318 ;;
319 ;; Configuration for the masses.
320 ;;
321 ;; They should never be accessed directly, as their value is to be
322 ;; stored in a property list (cf. `org-export-options-alist').
323 ;; Back-ends will read their value from there instead.
326 "Options for exporting Org mode files."
331 "General options for export engine."
336 "Whether sub-trees with the ARCHIVE tag should be exported.
338 This can have three different values:
339 nil Do not export, pretend this tree is not present.
340 t Do export the entire tree.
341 `headline' Only export the headline, but skip the tree below it.
343 This option can also be set with the OPTIONS keyword,
353 "Non-nil means insert author name into the exported file.
354 This option can also be set with the OPTIONS keyword,
361 "Non-nil means export CLOCK keywords.
362 This option can also be set with the OPTIONS keyword,
369 "Non-nil means the postamble should contain a creator sentence.
371 The sentence can be set in `org-export-creator-string', which
372 see.
374 This option can also be set with the OPTIONS keyword, e.g.,
383 "Non-nil means insert date in the exported document.
384 This option can also be set with the OPTIONS keyword,
391 "Time-stamp format string to use for DATE keyword.
393 The format string, when specified, only applies if date consists
394 in a single time-stamp. Otherwise its value will be ignored.
396 See `format-time-string' for details on how to build this
397 string."
406 emacs-version
408 "Information about the creator of the document.
409 This option can also be set on with the CREATOR keyword."
415 "Non-nil means export contents of standard drawers.
417 When t, all drawers are exported. This may also be a list of
418 drawer names to export, as strings. If that list starts with
419 `not', only drawers with such names will be ignored.
421 This variable doesn't apply to properties drawers. See
422 `org-export-with-properties' instead.
424 This option can also be set with the OPTIONS keyword,
437 :inline t
446 "Non-nil means insert author email into the exported file.
447 This option can also be set with the OPTIONS keyword,
454 "Non-nil means interpret *word*, /word/, _word_ and +word+.
456 If the export target supports emphasizing text, the word will be
457 typeset in bold, italic, with an underline or strike-through,
458 respectively.
460 This option can also be set with the OPTIONS keyword,
467 "Tags that exclude a tree from export.
469 All trees carrying any of these tags will be excluded from
470 export. This is without condition, so even subtrees inside that
471 carry one of the `org-export-select-tags' will be removed.
473 This option can also be set with the EXCLUDE_TAGS keyword."
480 This option can also be set with the OPTIONS keyword,
489 "Non-nil means Org footnotes should be exported.
490 This option can also be set with the OPTIONS keyword,
497 "Non-nil means process LaTeX environments and fragments.
499 This option can also be set with the OPTIONS line,
502 nil Ignore math snippets.
503 `verbatim' Keep everything in verbatim.
504 t Allow export of math snippets."
515 "The last level which is still exported as a headline.
517 Inferior levels will usually produce itemize or enumerate lists
518 when exported, but back-end behavior may differ.
520 This option can also be set with the OPTIONS keyword,
527 "The default language for export and clocktable translations, as a string.
528 This may have an association in
529 `org-clock-clocktable-language-setup',
530 `org-export-smart-quotes-alist' and `org-export-dictionary'.
531 This option can also be set with the LANGUAGE keyword."
537 "Non-nil means preserve all line breaks when exporting.
538 This option can also be set with the OPTIONS keyword,
545 "Non-nil means interpret entities when exporting.
548 Å.
550 For a list of supported names, see the constant `org-entities'
551 and the user option `org-entities-user'.
553 This option can also be set with the OPTIONS keyword,
560 "Non-nil means inlinetasks should be exported.
561 This option can also be set with the OPTIONS keyword,
570 "Non-nil means include planning info in export.
572 Planning info is the line containing either SCHEDULED:,
573 DEADLINE:, CLOSED: time-stamps, or a combination of them.
575 This option can also be set with the OPTIONS keyword,
584 "Non-nil means include priority cookies in export.
585 This option can also be set with the OPTIONS keyword,
592 "Non-nil means export contents of properties drawers.
594 When t, all properties are exported. This may also be a list of
595 properties to export, as strings.
597 This option can also be set with the OPTIONS keyword,
611 "Non-nil means add section numbers to headlines when exporting.
613 When set to an integer n, numbering will only happen for
614 headlines whose relative level is higher or equal to n.
616 This option can also be set with the OPTIONS keyword,
623 "Tags that select a tree for export.
625 If any such tag is found in a buffer, all trees that do not carry
626 one of these tags will be ignored during export. Inside trees
627 that are selected like this, you can still deselect a subtree by
628 tagging it with one of the `org-export-exclude-tags'.
630 This option can also be set with the SELECT_TAGS keyword."
636 "Non-nil means activate smart quotes during export.
637 This option can also be set with the OPTIONS keyword,
640 When setting this to non-nil, you need to take care of
641 using the correct Babel package when exporting to LaTeX.
642 E.g., you can load Babel for french like this:
654 When this option is turned on, these strings will be exported as:
656 Org HTML LaTeX UTF-8
657 -----+----------+--------+-------
659 -- – -- –
660 --- — --- —
663 This option can also be set with the OPTIONS keyword,
670 "Non-nil means include statistics cookies in export.
671 This option can also be set with the OPTIONS keyword,
682 If you want to control how Org displays those characters, see
683 `org-use-sub-superscripts'. `org-export-with-sub-superscripts'
684 used to be an alias for `org-use-sub-superscripts' in Org <8.0,
685 it is not anymore.
687 When this option is turned on, you can use TeX-like syntax for
688 sub- and superscripts and see them exported correctly.
690 You can also set the option with #+OPTIONS: ^:t
693 single item - so grouping with {} is normally not needed. For
694 example, the following things will be parsed as single sub- or
695 superscripts:
697 10^24 or 10^tau several digits will be considered 1 item.
698 10^-12 or 10^-tau a leading sign with digits or a word
699 x^2-y^3 will be read as x^2 - y^3, because items are
700 terminated by almost any nonword/nondigit char.
701 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
703 Still, ambiguity is possible. So when in doubt, use {} to enclose
704 the sub/superscript. If you set this variable to the symbol `{}',
705 the braces are *required* in order to trigger interpretations as
707 frequently in plain text."
718 "Non-nil means create a table of contents in exported files.
720 The TOC contains headlines with levels up
721 to`org-export-headline-levels'. When an integer, include levels
722 up to N in the toc, this may then be different from
723 `org-export-headline-levels', but it will not be allowed to be
724 larger than the number of headline levels. When nil, no table of
725 contents is made.
727 This option can also be set with the OPTIONS keyword,
738 "Non-nil means export tables.
739 This option can also be set with the OPTIONS keyword,
748 "If nil, do not export tags, just remove them from headlines.
750 If this is the symbol `not-in-toc', tags will be removed from
751 table of contents entries, but still be shown in the headlines of
752 the document.
754 This option can also be set with the OPTIONS keyword,
764 "Non-nil means include TODO items for export.
766 This may have the following values:
767 t include tasks independent of state.
768 `todo' include only tasks that are not yet done.
769 `done' include only tasks that are already done.
770 nil ignore all tasks.
771 list of keywords include tasks with these keywords.
773 This option can also be set with the OPTIONS keyword,
788 "Non-nil means print title into the exported file.
789 This option can also be set with the OPTIONS keyword,
798 "Non-nil means insert a time stamp into the exported file.
799 The time stamp shows when the file was created. This option can
806 "Non nil means allow timestamps in export.
808 It can be set to any of the following values:
809 t export all timestamps.
810 `active' export active timestamps only.
811 `inactive' export inactive timestamps only.
812 nil do not export timestamps
814 This only applies to timestamps isolated in a paragraph
815 containing only timestamps. Other timestamps are always
816 exported.
818 This option can also be set with the OPTIONS keyword, e.g.
829 "Non-nil means include TODO keywords in export.
830 When nil, remove all these keywords from the export. This option
836 "Non-nil means BIND keywords can define local variable values.
837 This is a potential security risk, which is why the default value
838 is nil. You can also allow them through local buffer variables."
845 "Non-nil means do not raise an error on broken links.
847 When this variable is non-nil, broken links are ignored, without
848 stopping the export process. If it is set to `mark', broken
849 links are marked as such in the output, with a string like
851 [BROKEN LINK: path]
853 where PATH is the un-resolvable reference.
855 This option can also be set with the OPTIONS keyword, e.g.,
866 "Alist between export snippets back-ends and exporter back-ends.
868 This variable allows providing shortcuts for export snippets.
872 HTML code while every other back-end will ignore it."
886 "Coding system for the exported file."
893 "Non-nil means pushing export output to the kill ring.
894 This variable is ignored during asynchronous export."
904 "The initial scope when exporting with `org-export-dispatch'.
905 This variable can be either set to `buffer' or `subtree'."
912 "Non-nil means show buffer after exporting to temp buffer.
913 When Org exports to a file, the buffer visiting that file is never
914 shown, but remains buried. However, when exporting to
915 a temporary buffer, that buffer is popped up in a second window.
916 When this variable is nil, the buffer remains buried also in
917 these cases."
922 "Non-nil means export and publishing commands will run in background.
923 Results from an asynchronous export are never displayed
931 "File used to initialize external export process.
933 Value must be either nil or an absolute file name. When nil, the
934 external process is launched like a regular Emacs session,
935 loading user's initialization file and any site specific
936 configuration. If a file is provided, it, and only it, is loaded
937 at start-up.
939 Therefore, using a specific configuration makes the process to
940 load faster and the export more portable."
949 "Non-nil means using a non-intrusive `org-export-dispatch'.
950 In that case, no help buffer is displayed. Though, an indicator
956 asynchronous). Also, [?] allows switching back to standard
957 mode."
964 \f
965 ;;; Defining Back-ends
966 ;;
967 ;; An export back-end is a structure with `org-export-backend' type
968 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
969 ;; and `menu' slots.
970 ;;
971 ;; At the lowest level, a back-end is created with
972 ;; `org-export-create-backend' function.
973 ;;
974 ;; A named back-end can be registered with
975 ;; `org-export-register-backend' function. A registered back-end can
976 ;; later be referred to by its name, with `org-export-get-backend'
977 ;; function. Also, such a back-end can become the parent of a derived
978 ;; back-end from which slot values will be inherited by default.
979 ;; `org-export-derived-backend-p' can check if a given back-end is
980 ;; derived from a list of back-end names.
981 ;;
982 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
983 ;; `org-export-get-all-filters' return the full alist of transcoders,
984 ;; options and filters, including those inherited from ancestors.
985 ;;
986 ;; At a higher level, `org-export-define-backend' is the standard way
987 ;; to define an export back-end. If the new back-end is similar to
988 ;; a registered back-end, `org-export-define-derived-backend' may be
989 ;; used instead.
990 ;;
991 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
992 ;; when a given back-end hasn't been registered yet.
996 name parent transcoders options filters blocks menu)
999 "Return export back-end named after NAME.
1000 NAME is a symbol. Return nil if no such back-end is found."
1007 "Register BACKEND as a known export back-end.
1008 BACKEND is a structure with `org-export-backend' type."
1009 ;; Refuse to register an unnamed back-end.
1012 ;; Refuse to register a back-end with an unknown parent.
1016 ;; If a back-end with the same name as BACKEND is already
1017 ;; registered, replace it with BACKEND. Otherwise, simply add
1018 ;; BACKEND to the list of registered back-ends.
1024 "Signal an error if BACKEND isn't defined."
1029 "Non-nil if BACKEND is derived from one of BACKENDS.
1030 BACKEND is an export back-end, as returned by, e.g.,
1031 `org-export-create-backend', or a symbol referring to
1032 a registered back-end. BACKENDS is constituted of symbols."
1044 "Return full translation table for BACKEND.
1046 BACKEND is an export back-end, as return by, e.g,,
1047 `org-export-create-backend'. Return value is an alist where
1048 keys are element or object types, as symbols, and values are
1049 transcoders.
1051 Unlike to `org-export-backend-transcoders', this function
1052 also returns transcoders inherited from parent back-ends,
1053 if any."
1057 parent)
1062 transcoders)))
1065 "Return export options for BACKEND.
1067 BACKEND is an export back-end, as return by, e.g,,
1068 `org-export-create-backend'. See `org-export-options-alist'
1069 for the shape of the return value.
1071 Unlike to `org-export-backend-options', this function also
1072 returns options inherited from parent back-ends, if any."
1076 parent)
1080 options)))
1083 "Return complete list of filters for BACKEND.
1085 BACKEND is an export back-end, as return by, e.g,,
1086 `org-export-create-backend'. Return value is an alist where
1087 keys are symbols and values lists of functions.
1089 Unlike to `org-export-backend-filters', this function also
1090 returns filters inherited from parent back-ends, if any."
1094 parent)
1098 filters)))
1101 "Define a new back-end BACKEND.
1103 TRANSCODERS is an alist between object or element types and
1104 functions handling them.
1106 These functions should return a string without any trailing
1107 space, or nil. They must accept three arguments: the object or
1108 element itself, its contents or nil when it isn't recursive and
1109 the property list used as a communication channel.
1111 Contents, when not nil, are stripped from any global indentation
1112 \(although the relative one is preserved). They also always end
1113 with a single newline character.
1115 If, for a given type, no function is found, that element or
1116 object type will simply be ignored, along with any blank line or
1117 white space at its end. The same will happen if the function
1118 returns the nil value. If that function returns the empty
1119 string, the type will be ignored, but the blank lines or white
1120 spaces will be kept.
1122 In addition to element and object types, one function can be
1123 associated to the `template' (or `inner-template') symbol and
1124 another one to the `plain-text' symbol.
1126 The former returns the final transcoded string, and can be used
1127 to add a preamble and a postamble to document's body. It must
1128 accept two arguments: the transcoded string and the property list
1129 containing export options. A function associated to `template'
1131 A function associated to `inner-template' is always applied.
1133 The latter, when defined, is to be called on every text not
1134 recognized as an element or an object. It must accept two
1135 arguments: the text string and the information channel. It is an
1136 appropriate place to protect special chars relative to the
1137 back-end.
1139 BODY can start with pre-defined keyword arguments. The following
1140 keywords are understood:
1142 :filters-alist
1144 Alist between filters and function, or list of functions,
1145 specific to the back-end. See `org-export-filters-alist' for
1146 a list of all allowed filters. Filters defined here
1147 shouldn't make a back-end test, as it may prevent back-ends
1148 derived from this one to behave properly.
1150 :menu-entry
1152 Menu entry for the export dispatcher. It should be a list
1153 like:
1157 where :
1159 KEY is a free character selecting the back-end.
1161 DESCRIPTION-OR-ORDINAL is either a string or a number.
1163 If it is a string, is will be used to name the back-end in
1164 its menu entry. If it is a number, the following menu will
1165 be displayed as a sub-menu of the back-end with the same
1166 KEY. Also, the number will be used to determine in which
1167 order such sub-menus will appear (lowest first).
1169 ACTION-OR-MENU is either a function or an alist.
1171 If it is an action, it will be called with four
1172 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1173 BODY-ONLY. See `org-export-as' for further explanations on
1174 some of them.
1176 If it is an alist, associations should follow the
1177 pattern:
1181 where KEY, DESCRIPTION and ACTION are described above.
1183 Valid values include:
1187 or
1192 (lambda (a s v b)
1193 (if a (org-latex-export-to-pdf t s v b)
1194 (org-open-file
1195 (org-latex-export-to-pdf nil s v b)))))))
1197 or the following, which will be added to the previous
1198 sub-menu,
1204 :options-alist
1206 Alist between back-end specific properties introduced in
1207 communication channel and how their value are acquired. See
1208 `org-export-options-alist' for more information about
1209 structure of the values."
1221 :transcoders transcoders
1222 :options options
1223 :filters filters
1227 "Create a new back-end as a variant of an existing one.
1229 CHILD is the name of the derived back-end. PARENT is the name of
1230 the parent back-end.
1232 BODY can start with pre-defined keyword arguments. The following
1233 keywords are understood:
1235 :filters-alist
1237 Alist of filters that will overwrite or complete filters
1238 defined in PARENT back-end. See `org-export-filters-alist'
1239 for a list of allowed filters.
1241 :menu-entry
1243 Menu entry for the export dispatcher. See
1244 `org-export-define-backend' for more information about the
1245 expected value.
1247 :options-alist
1249 Alist of back-end specific properties that will overwrite or
1250 complete those defined in PARENT back-end. Refer to
1251 `org-export-options-alist' for more information about
1252 structure of the values.
1254 :translate-alist
1256 Alist of element and object types and transcoders that will
1257 overwrite or complete transcode table from PARENT back-end.
1258 Refer to `org-export-define-backend' for detailed information
1259 about transcoders.
1262 as a variant of `latex' back-end with a custom template function:
1267 The back-end could then be called with, for example:
1282 :parent parent
1283 :transcoders transcoders
1284 :options options
1285 :filters filters
1289 \f
1290 ;;; The Communication Channel
1291 ;;
1292 ;; During export process, every function has access to a number of
1293 ;; properties. They are of two types:
1294 ;;
1295 ;; 1. Environment options are collected once at the very beginning of
1296 ;; the process, out of the original buffer and configuration.
1297 ;; Collecting them is handled by `org-export-get-environment'
1298 ;; function.
1299 ;;
1300 ;; Most environment options are defined through the
1301 ;; `org-export-options-alist' variable.
1302 ;;
1303 ;; 2. Tree properties are extracted directly from the parsed tree,
1304 ;; just before export, by `org-export--collect-tree-properties'.
1306 ;;;; Environment Options
1307 ;;
1308 ;; Environment options encompass all parameters defined outside the
1309 ;; scope of the parsed data. They come from five sources, in
1310 ;; increasing precedence order:
1311 ;;
1312 ;; - Global variables,
1313 ;; - Buffer's attributes,
1314 ;; - Options keyword symbols,
1315 ;; - Buffer keywords,
1316 ;; - Subtree properties.
1317 ;;
1318 ;; The central internal function with regards to environment options
1319 ;; is `org-export-get-environment'. It updates global variables with
1320 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1321 ;; the different sources.
1322 ;;
1323 ;; The internal functions doing the retrieval are:
1324 ;; `org-export--get-global-options',
1325 ;; `org-export--get-buffer-attributes',
1326 ;; `org-export--parse-option-keyword',
1327 ;; `org-export--get-subtree-options' and
1328 ;; `org-export--get-inbuffer-options'
1329 ;;
1330 ;; Also, `org-export--list-bound-variables' collects bound variables
1331 ;; along with their value in order to set them as buffer local
1332 ;; variables later in the process.
1335 "Collect export options from the current buffer.
1337 Optional argument BACKEND is an export back-end, as returned by
1338 `org-export-create-backend'.
1340 When optional argument SUBTREEP is non-nil, assume the export is
1341 done against the current sub-tree.
1343 Third optional argument EXT-PLIST is a property list with
1344 external parameters overriding Org default settings, but still
1345 inferior to file-local settings."
1346 ;; First install #+BIND variables since these must be set before
1347 ;; global options are read.
1350 ;; Get and prioritize export options...
1352 ;; ... from global variables...
1354 ;; ... from an external property list...
1355 ext-plist
1356 ;; ... from in-buffer settings...
1358 ;; ... and from subtree, when appropriate.
1362 "Parse an OPTIONS line and return values as a plist.
1363 Optional argument BACKEND is an export back-end, as returned by,
1364 e.g., `org-export-create-backend'. It specifies which back-end
1365 specific items to read, if any."
1372 alist))
1373 alist))
1374 ;; Priority is given to back-end specific options.
1376 org-export-options-alist))
1386 "Get export options in subtree at point.
1387 Optional argument BACKEND is an export back-end, as returned by,
1388 e.g., `org-export-create-backend'. It specifies back-end used
1389 for export. Return options as a plist."
1390 ;; For each buffer keyword, create a headline property setting the
1391 ;; same property in communication channel. The name for the
1392 ;; property is the keyword with "EXPORT_" appended to it.
1394 ;; Make sure point is at a heading.
1397 ;; EXPORT_OPTIONS are parsed in a non-standard way. Take
1398 ;; care of them right from the start.
1401 ;; Take care of EXPORT_TITLE. If it isn't defined, use
1402 ;; headline's title (with no todo keyword, priority cookie or
1403 ;; tag) as its fallback value.
1409 ;; Look for both general keywords and back-end specific
1410 ;; options, with priority given to the latter.
1412 org-export-options-alist)))
1413 ;; Handle other keywords. Then return PLIST.
1427 property
1436 "Return current buffer export options, as a plist.
1438 Optional argument BACKEND, when non-nil, is an export back-end,
1439 as returned by, e.g., `org-export-create-backend'. It specifies
1440 which back-end specific options should also be read in the
1441 process.
1443 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1446 ;; Priority is given to back-end specific options.
1448 org-export-options-alist))
1451 org-export-special-keywords))))
1452 plist to-parse)
1455 ;; Return all properties associated to KEYWORD.
1462 ;; Recursively read keywords in buffer. FILES is
1463 ;; a list of files read so far. PLIST is the current
1464 ;; property list obtained.
1473 ;; Options in `org-export-special-keywords'.
1478 ;; Avoid circular dependencies.
1489 plist
1491 val backend))))
1495 plist
1502 ;; Options in `org-export-options-alist'.
1505 plist
1507 plist property
1508 ;; Handle value depending on specified
1509 ;; BEHAVIOR.
1514 ;; Even if `parse' implies `space'
1515 ;; behavior, we separate line with
1516 ;; "\n" so as to preserve
1517 ;; line-breaks. However, empty
1518 ;; lines are forbidden since `parse'
1519 ;; doesn't allow more than one
1520 ;; paragraph.
1529 " "
1542 ;; Read options in the current buffer and return value.
1544 ;; Parse properties in TO-PARSE. Remove newline characters not
1545 ;; involved in line breaks to simulate `space' behavior.
1546 ;; Finally return options.
1559 "Return properties related to export process, as a plist.
1560 Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
1561 are like the arguments with the same names of function
1562 `org-export-as'."
1567 :back-end backend
1572 "Return properties related to buffer attributes, as a plist."
1577 "Return global export options as a plist.
1578 Optional argument BACKEND, if non-nil, is an export back-end, as
1579 returned by, e.g., `org-export-create-backend'. It specifies
1580 which back-end specific export options should also be read in the
1581 process."
1583 ;; Priority is given to back-end specific options.
1585 org-export-options-alist)))
1591 plist
1592 prop
1593 ;; Evaluate default value provided.
1598 value)))))))))
1601 "Return variables bound from BIND keywords in current buffer.
1602 Also look for BIND keywords in setup files. The return value is
1603 an alist where associations are (VARIABLE-NAME VALUE)."
1607 ;; Return an alist between variable names and their
1608 ;; value. FILES is a list of setup files names read
1609 ;; so far, used to avoid circular dependencies. ALIST
1610 ;; is the alist collected so far.
1622 ;; Enter setup file.
1634 alist))))))))))
1635 alist)))))
1636 ;; Return value in appropriate order of appearance.
1639 ;; defsubst org-export-get-parent must be defined before first use,
1640 ;; was originally defined in the topology section
1643 "Return BLOB parent or nil.
1644 BLOB is the element or object considered."
1647 ;;;; Tree Properties
1648 ;;
1649 ;; Tree properties are information extracted from parse tree. They
1650 ;; are initialized at the beginning of the transcoding process by
1651 ;; `org-export--collect-tree-properties'.
1652 ;;
1653 ;; Dedicated functions focus on computing the value of specific tree
1654 ;; properties during initialization. Thus,
1655 ;; `org-export--populate-ignore-list' lists elements and objects that
1656 ;; should be skipped during export, `org-export--get-min-level' gets
1657 ;; the minimal exportable level, used as a basis to compute relative
1658 ;; level for headlines. Eventually
1659 ;; `org-export--collect-headline-numbering' builds an alist between
1660 ;; headlines and their numbering.
1663 "Extract tree properties from parse tree.
1665 DATA is the parse tree from which information is retrieved. INFO
1666 is a list holding export options.
1668 Following tree properties are set or updated:
1670 `:headline-offset' Offset between true level of headlines and
1671 local level. An offset of -1 means a headline
1672 of level 2 should be considered as a level
1673 1 headline in the context.
1675 `:headline-numbering' Alist of all headlines as key and the
1676 associated numbering as value.
1678 `:id-alist' Alist of all ID references as key and associated file
1679 as value.
1681 Return updated plist."
1682 ;; Install the parse tree in the communication channel.
1684 ;; Compute `:headline-offset' in order to be able to use
1685 ;; `org-export-get-relative-level'.
1688 :headline-offset
1690 ;; From now on, properties order doesn't matter: get the rest of the
1691 ;; tree properties.
1693 info
1695 :id-alist
1704 "Return minimum exportable headline's level in DATA.
1705 DATA is parsed tree as returned by `org-element-parse-buffer'.
1706 OPTIONS is a plist holding export options."
1715 ;; If no headline was found, for the sake of consistency, set
1716 ;; minimum level to 1 nonetheless.
1720 "Return numbering of all exportable, numbered headlines in a parse tree.
1722 DATA is the parse tree. OPTIONS is the plist holding export
1723 options.
1725 Return an alist whose key is a headline and value is its
1726 associated numbering \(in the shape of a list of numbers) or nil
1727 for a footnotes section."
1736 headline
1738 for n across numbering
1739 for idx from 0 to org-export-max-depth
1743 options)))
1746 "List headlines and inlinetasks with a select tag in their tree.
1747 DATA is parsed data as returned by `org-element-parse-buffer'.
1748 INFO is a plist holding export options."
1751 ;; If FILETAGS contains a select tag, every headline or
1752 ;; inlinetask is returned.
1762 ;; When a select tag is found, mark full
1763 ;; genealogy and every headline within the
1764 ;; tree as acceptable.
1767 genealogy
1770 selected-trees))
1771 ;; If at a headline, continue searching in
1772 ;; tree, recursively.
1781 selected-trees))))
1784 "Non-nil when element or object BLOB should be skipped during export.
1785 OPTIONS is the plist holding export options. SELECTED, when
1786 non-nil, is a list of headlines or inlinetasks belonging to
1787 a tree with a select tag."
1794 ;; If `:with-drawers' value starts with `not', ignore
1795 ;; every drawer whose name belong to that list.
1796 ;; Otherwise, ignore drawers whose name isn't in that
1797 ;; list.
1814 ;; Ignore subtrees with an exclude tag.
1817 ;; When a select tag is present in the buffer, ignore any tree
1818 ;; without it.
1820 ;; Ignore commented sub-trees.
1822 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1824 ;; Ignore tasks, if specified by `:with-tasks' property.
1836 properties-set))))))
1847 ;; `:with-timestamps' only applies to isolated timestamps
1848 ;; objects, i.e. timestamp objects in a paragraph containing only
1849 ;; timestamps and whitespaces.
1857 options t))))
1866 \f
1867 ;;; The Transcoder
1868 ;;
1869 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1870 ;; `org-element-parse-buffer') and transcodes it into a specified
1871 ;; back-end output. It takes care of filtering out elements or
1872 ;; objects according to export options and organizing the output blank
1873 ;; lines and white space are preserved. The function memoizes its
1874 ;; results, so it is cheap to call it within transcoders.
1875 ;;
1876 ;; It is possible to modify locally the back-end used by
1877 ;; `org-export-data' or even use a temporary back-end by using
1878 ;; `org-export-data-with-backend'.
1879 ;;
1880 ;; `org-export-transcoder' is an accessor returning appropriate
1881 ;; translator function for a given element or object.
1884 "Return appropriate transcoder for BLOB.
1885 INFO is a plist containing export directives."
1887 ;; Return contents only for complete parse trees.
1893 "Convert DATA into current back-end format.
1895 DATA is a parse tree, an element or an object or a secondary
1896 string. INFO is a plist holding export options.
1898 Return a string."
1900 ;; Handle broken links according to
1901 ;; `org-export-with-broken-links'.
1916 ;; Ignored element/object.
1918 ;; Plain text.
1924 info))
1925 ;; Secondary string.
1928 ;; Element/Object without contents or, as a special
1929 ;; case, headline with archive tag and archived trees
1930 ;; restricted to title only.
1939 ;; Export snippets never return a nil value so
1940 ;; that white spaces following them are never
1941 ;; ignored.
1943 ;; Element/Object with contents.
1956 ;; Elements directly containing
1957 ;; objects must have their indentation
1958 ;; normalized first.
1960 data
1961 ;; When normalizing contents of the
1962 ;; first paragraph in an item or
1963 ;; a footnote definition, ignore
1964 ;; first line's indentation: there is
1965 ;; none and it might be misleading.
1970 data)
1978 info)))))))))
1979 ;; Final result will be memoized before being returned.
1981 data
1985 ;; Append the same white space between elements or objects
1986 ;; as in the original buffer, and call appropriate filters.
1997 info)))
1998 results)))
2002 "Convert DATA into BACKEND format.
2004 DATA is an element, an object, a secondary string or a string.
2005 BACKEND is a symbol. INFO is a plist used as a communication
2006 channel.
2008 Unlike to `org-export-with-backend', this function will
2009 recursively convert DATA using BACKEND translation table."
2012 data
2013 ;; Set-up a new communication channel with translations defined in
2014 ;; BACKEND as the translate table and a new hash table for
2015 ;; memoization.
2017 info
2020 ;; Size of the hash table is reduced since this function
2021 ;; will probably be used on small trees.
2025 "Expand a parsed element or object to its original state.
2027 BLOB is either an element or an object. CONTENTS is its
2028 contents, as a string or nil.
2030 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2031 keywords before output."
2036 blob contents))))
2039 \f
2040 ;;; The Filter System
2041 ;;
2042 ;; Filters allow end-users to tweak easily the transcoded output.
2043 ;; They are the functional counterpart of hooks, as every filter in
2044 ;; a set is applied to the return value of the previous one.
2045 ;;
2046 ;; Every set is back-end agnostic. Although, a filter is always
2047 ;; called, in addition to the string it applies to, with the back-end
2048 ;; used as argument, so it's easy for the end-user to add back-end
2049 ;; specific filters in the set. The communication channel, as
2050 ;; a plist, is required as the third argument.
2051 ;;
2052 ;; From the developer side, filters sets can be installed in the
2053 ;; process with the help of `org-export-define-backend', which
2054 ;; internally stores filters as an alist. Each association has a key
2055 ;; among the following symbols and a function or a list of functions
2056 ;; as value.
2057 ;;
2058 ;; - `:filter-options' applies to the property list containing export
2059 ;; options. Unlike to other filters, functions in this list accept
2060 ;; two arguments instead of three: the property list containing
2061 ;; export options and the back-end. Users can set its value through
2062 ;; `org-export-filter-options-functions' variable.
2063 ;;
2064 ;; - `:filter-parse-tree' applies directly to the complete parsed
2065 ;; tree. Users can set it through
2066 ;; `org-export-filter-parse-tree-functions' variable.
2067 ;;
2068 ;; - `:filter-body' applies to the body of the output, before template
2069 ;; translator chimes in. Users can set it through
2070 ;; `org-export-filter-body-functions' variable.
2071 ;;
2072 ;; - `:filter-final-output' applies to the final transcoded string.
2073 ;; Users can set it with `org-export-filter-final-output-functions'
2074 ;; variable.
2075 ;;
2076 ;; - `:filter-plain-text' applies to any string not recognized as Org
2077 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2078 ;; configure it.
2079 ;;
2080 ;; - `:filter-TYPE' applies on the string returned after an element or
2081 ;; object of type TYPE has been transcoded. A user can modify
2082 ;; `org-export-filter-TYPE-functions' to install these filters.
2083 ;;
2084 ;; All filters sets are applied with
2085 ;; `org-export-filter-apply-functions' function. Filters in a set are
2086 ;; applied in a LIFO fashion. It allows developers to be sure that
2087 ;; their filters will be applied first.
2088 ;;
2089 ;; Filters properties are installed in communication channel with
2090 ;; `org-export-install-filters' function.
2091 ;;
2092 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2093 ;; `org-export-before-parsing-hook') are run at the beginning of the
2094 ;; export process and just before parsing to allow for heavy structure
2095 ;; modifications.
2098 ;;;; Hooks
2101 "Hook run at the beginning of the export process.
2103 This is run before include keywords and macros are expanded and
2104 Babel code blocks executed, on a copy of the original buffer
2105 being exported. Visibility and narrowing are preserved. Point
2106 is at the beginning of the buffer.
2108 Every function in this hook will be called with one argument: the
2112 "Hook run before parsing an export buffer.
2114 This is run after include keywords and macros have been expanded
2115 and Babel code blocks executed, on a copy of the original buffer
2116 being exported. Visibility and narrowing are preserved. Point
2117 is at the beginning of the buffer.
2119 Every function in this hook will be called with one argument: the
2123 ;;;; Special Filters
2126 "List of functions applied to the export options.
2127 Each filter is called with two arguments: the export options, as
2128 a plist, and the back-end, as a symbol. It must return
2132 "List of functions applied to the parsed tree.
2133 Each filter is called with three arguments: the parse tree, as
2134 returned by `org-element-parse-buffer', the back-end, as
2135 a symbol, and the communication channel, as a plist. It must
2139 "List of functions applied to plain text.
2140 Each filter is called with three arguments: a string which
2141 contains no Org syntax, the back-end, as a symbol, and the
2142 communication channel, as a plist. It must return a string or
2146 "List of functions applied to transcoded body.
2147 Each filter is called with three arguments: a string which
2148 contains no Org syntax, the back-end, as a symbol, and the
2149 communication channel, as a plist. It must return a string or
2153 "List of functions applied to the transcoded string.
2154 Each filter is called with three arguments: the full transcoded
2155 string, the back-end, as a symbol, and the communication channel,
2156 as a plist. It must return a string that will be used as the
2160 ;;;; Elements Filters
2163 "List of functions applied to a transcoded babel-call.
2164 Each filter is called with three arguments: the transcoded data,
2165 as a string, the back-end, as a symbol, and the communication
2169 "List of functions applied to a transcoded center block.
2170 Each filter is called with three arguments: the transcoded data,
2171 as a string, the back-end, as a symbol, and the communication
2175 "List of functions applied to a transcoded clock.
2176 Each filter is called with three arguments: the transcoded data,
2177 as a string, the back-end, as a symbol, and the communication
2181 "List of functions applied to a transcoded diary-sexp.
2182 Each filter is called with three arguments: the transcoded data,
2183 as a string, the back-end, as a symbol, and the communication
2187 "List of functions applied to a transcoded drawer.
2188 Each filter is called with three arguments: the transcoded data,
2189 as a string, the back-end, as a symbol, and the communication
2193 "List of functions applied to a transcoded dynamic-block.
2194 Each filter is called with three arguments: the transcoded data,
2195 as a string, the back-end, as a symbol, and the communication
2199 "List of functions applied to a transcoded example-block.
2200 Each filter is called with three arguments: the transcoded data,
2201 as a string, the back-end, as a symbol, and the communication
2205 "List of functions applied to a transcoded export-block.
2206 Each filter is called with three arguments: the transcoded data,
2207 as a string, the back-end, as a symbol, and the communication
2211 "List of functions applied to a transcoded fixed-width.
2212 Each filter is called with three arguments: the transcoded data,
2213 as a string, the back-end, as a symbol, and the communication
2217 "List of functions applied to a transcoded footnote-definition.
2218 Each filter is called with three arguments: the transcoded data,
2219 as a string, the back-end, as a symbol, and the communication
2223 "List of functions applied to a transcoded headline.
2224 Each filter is called with three arguments: the transcoded data,
2225 as a string, the back-end, as a symbol, and the communication
2229 "List of functions applied to a transcoded horizontal-rule.
2230 Each filter is called with three arguments: the transcoded data,
2231 as a string, the back-end, as a symbol, and the communication
2235 "List of functions applied to a transcoded inlinetask.
2236 Each filter is called with three arguments: the transcoded data,
2237 as a string, the back-end, as a symbol, and the communication
2241 "List of functions applied to a transcoded item.
2242 Each filter is called with three arguments: the transcoded data,
2243 as a string, the back-end, as a symbol, and the communication
2247 "List of functions applied to a transcoded keyword.
2248 Each filter is called with three arguments: the transcoded data,
2249 as a string, the back-end, as a symbol, and the communication
2253 "List of functions applied to a transcoded latex-environment.
2254 Each filter is called with three arguments: the transcoded data,
2255 as a string, the back-end, as a symbol, and the communication
2259 "List of functions applied to a transcoded node-property.
2260 Each filter is called with three arguments: the transcoded data,
2261 as a string, the back-end, as a symbol, and the communication
2265 "List of functions applied to a transcoded paragraph.
2266 Each filter is called with three arguments: the transcoded data,
2267 as a string, the back-end, as a symbol, and the communication
2271 "List of functions applied to a transcoded plain-list.
2272 Each filter is called with three arguments: the transcoded data,
2273 as a string, the back-end, as a symbol, and the communication
2277 "List of functions applied to a transcoded planning.
2278 Each filter is called with three arguments: the transcoded data,
2279 as a string, the back-end, as a symbol, and the communication
2283 "List of functions applied to a transcoded property-drawer.
2284 Each filter is called with three arguments: the transcoded data,
2285 as a string, the back-end, as a symbol, and the communication
2289 "List of functions applied to a transcoded quote block.
2290 Each filter is called with three arguments: the transcoded quote
2291 data, as a string, the back-end, as a symbol, and the
2292 communication channel, as a plist. It must return a string or
2296 "List of functions applied to a transcoded section.
2297 Each filter is called with three arguments: the transcoded data,
2298 as a string, the back-end, as a symbol, and the communication
2302 "List of functions applied to a transcoded special block.
2303 Each filter is called with three arguments: the transcoded data,
2304 as a string, the back-end, as a symbol, and the communication
2308 "List of functions applied to a transcoded src-block.
2309 Each filter is called with three arguments: the transcoded data,
2310 as a string, the back-end, as a symbol, and the communication
2314 "List of functions applied to a transcoded table.
2315 Each filter is called with three arguments: the transcoded data,
2316 as a string, the back-end, as a symbol, and the communication
2320 "List of functions applied to a transcoded table-cell.
2321 Each filter is called with three arguments: the transcoded data,
2322 as a string, the back-end, as a symbol, and the communication
2326 "List of functions applied to a transcoded table-row.
2327 Each filter is called with three arguments: the transcoded data,
2328 as a string, the back-end, as a symbol, and the communication
2332 "List of functions applied to a transcoded verse block.
2333 Each filter is called with three arguments: the transcoded data,
2334 as a string, the back-end, as a symbol, and the communication
2338 ;;;; Objects Filters
2341 "List of functions applied to transcoded bold text.
2342 Each filter is called with three arguments: the transcoded data,
2343 as a string, the back-end, as a symbol, and the communication
2347 "List of functions applied to transcoded code text.
2348 Each filter is called with three arguments: the transcoded data,
2349 as a string, the back-end, as a symbol, and the communication
2353 "List of functions applied to a transcoded entity.
2354 Each filter is called with three arguments: the transcoded data,
2355 as a string, the back-end, as a symbol, and the communication
2359 "List of functions applied to a transcoded export-snippet.
2360 Each filter is called with three arguments: the transcoded data,
2361 as a string, the back-end, as a symbol, and the communication
2365 "List of functions applied to a transcoded footnote-reference.
2366 Each filter is called with three arguments: the transcoded data,
2367 as a string, the back-end, as a symbol, and the communication
2371 "List of functions applied to a transcoded inline-babel-call.
2372 Each filter is called with three arguments: the transcoded data,
2373 as a string, the back-end, as a symbol, and the communication
2377 "List of functions applied to a transcoded inline-src-block.
2378 Each filter is called with three arguments: the transcoded data,
2379 as a string, the back-end, as a symbol, and the communication
2383 "List of functions applied to transcoded italic text.
2384 Each filter is called with three arguments: the transcoded data,
2385 as a string, the back-end, as a symbol, and the communication
2389 "List of functions applied to a transcoded latex-fragment.
2390 Each filter is called with three arguments: the transcoded data,
2391 as a string, the back-end, as a symbol, and the communication
2395 "List of functions applied to a transcoded line-break.
2396 Each filter is called with three arguments: the transcoded data,
2397 as a string, the back-end, as a symbol, and the communication
2401 "List of functions applied to a transcoded link.
2402 Each filter is called with three arguments: the transcoded data,
2403 as a string, the back-end, as a symbol, and the communication
2407 "List of functions applied to a transcoded radio-target.
2408 Each filter is called with three arguments: the transcoded data,
2409 as a string, the back-end, as a symbol, and the communication
2413 "List of functions applied to a transcoded statistics-cookie.
2414 Each filter is called with three arguments: the transcoded data,
2415 as a string, the back-end, as a symbol, and the communication
2419 "List of functions applied to transcoded strike-through text.
2420 Each filter is called with three arguments: the transcoded data,
2421 as a string, the back-end, as a symbol, and the communication
2425 "List of functions applied to a transcoded subscript.
2426 Each filter is called with three arguments: the transcoded data,
2427 as a string, the back-end, as a symbol, and the communication
2431 "List of functions applied to a transcoded superscript.
2432 Each filter is called with three arguments: the transcoded data,
2433 as a string, the back-end, as a symbol, and the communication
2437 "List of functions applied to a transcoded target.
2438 Each filter is called with three arguments: the transcoded data,
2439 as a string, the back-end, as a symbol, and the communication
2443 "List of functions applied to a transcoded timestamp.
2444 Each filter is called with three arguments: the transcoded data,
2445 as a string, the back-end, as a symbol, and the communication
2449 "List of functions applied to transcoded underline text.
2450 Each filter is called with three arguments: the transcoded data,
2451 as a string, the back-end, as a symbol, and the communication
2455 "List of functions applied to transcoded verbatim text.
2456 Each filter is called with three arguments: the transcoded data,
2457 as a string, the back-end, as a symbol, and the communication
2461 ;;;; Filters Tools
2462 ;;
2463 ;; Internal function `org-export-install-filters' installs filters
2464 ;; hard-coded in back-ends (developer filters) and filters from global
2465 ;; variables (user filters) in the communication channel.
2466 ;;
2467 ;; Internal function `org-export-filter-apply-functions' takes care
2468 ;; about applying each filter in order to a given data. It ignores
2469 ;; filters returning a nil value but stops whenever a filter returns
2470 ;; an empty string.
2473 "Call every function in FILTERS.
2475 Functions are called with arguments VALUE, current export
2476 back-end's name and INFO. A function returning a nil value will
2477 be skipped. If it returns the empty string, the process ends and
2478 VALUE is ignored.
2480 Call is done in a LIFO fashion, to be sure that developer
2481 specified filters, if any, are called first."
2492 "Install filters properties in communication channel.
2493 INFO is a plist containing the current communication channel.
2494 Return the updated communication channel."
2496 ;; Install user-defined filters with `org-export-filters-alist'
2497 ;; and filters already in INFO (through ext-plist mechanism).
2504 ;; Filters in INFO will be called
2505 ;; before those user provided.
2508 default-value)))))
2509 ;; Prepend back-end specific filters to that list.
2511 ;; Single values get consed, lists are appended.
2516 plist key
2519 ;; Return new communication channel.
2523 \f
2524 ;;; Core functions
2525 ;;
2526 ;; This is the room for the main function, `org-export-as', along with
2527 ;; its derivative, `org-export-string-as'.
2528 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2529 ;; function should be added to kill ring.
2530 ;;
2531 ;; Note that `org-export-as' doesn't really parse the current buffer,
2532 ;; but a copy of it (with the same buffer-local variables and
2533 ;; visibility), where macros and include keywords are expanded and
2534 ;; Babel blocks are executed, if appropriate.
2535 ;; `org-export-with-buffer-copy' macro prepares that copy.
2536 ;;
2537 ;; File inclusion is taken care of by
2538 ;; `org-export-expand-include-keyword' and
2539 ;; `org-export--prepare-file-contents'. Structure wise, including
2540 ;; a whole Org file in a buffer often makes little sense. For
2541 ;; example, if the file contains a headline and the include keyword
2542 ;; was within an item, the item should contain the headline. That's
2543 ;; why file inclusion should be done before any structure can be
2544 ;; associated to the file, that is before parsing.
2545 ;;
2546 ;; `org-export-insert-default-template' is a command to insert
2547 ;; a default template (or a back-end specific template) at point or in
2548 ;; current subtree.
2551 "Return a copy of the current buffer.
2552 The copy preserves Org buffer-local variables, visibility and
2553 narrowing."
2559 new-buf))
2562 "Apply BODY in a copy of the current buffer.
2563 The copy preserves local variables, visibility and contents of
2564 the original buffer. Point is at the beginning of the buffer
2565 when BODY is applied."
2574 ;; Kill copy without confirmation.
2580 "Generate a function duplicating BUFFER.
2582 The copy will preserve local variables, visibility, contents and
2583 narrowing of the original buffer. If a region was active in
2584 BUFFER, contents will be narrowed to that region instead.
2586 The resulting function can be evaluated at a later time, from
2587 another buffer, effectively cloning the original buffer there.
2589 The function assumes BUFFER's major mode is `org-mode'."
2593 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2594 ;; already in BUFFER.
2596 ;; Copy specific buffer local variables and variables set
2597 ;; through BIND keywords.
2599 vars)
2607 buffer-file-name
2608 buffer-file-coding-system))
2612 ;; Skip unreadable values, as they cannot be
2613 ;; sent to external process.
2617 vars))))))
2618 ;; Whole buffer contents.
2623 ;; Narrowing.
2627 ;; Current position of point.
2629 ;; Overlays with invisible property.
2638 ov-set)))))))))
2641 "Delete commented areas in the buffer.
2642 Commented areas are comments, comment blocks, commented trees and
2643 inlinetasks. Trailing blank lines after a comment or a comment
2644 block are removed, as long as it doesn't alter the structure of
2645 the document. Narrowing, if any, is ignored."
2651 comment-re)))
2663 ;; We remove trailing blank lines. Doing so could
2664 ;; modify the structure of the document. Therefore
2665 ;; we ensure that any comment between elements is
2666 ;; replaced with one empty line, so as to keep them
2667 ;; separated.
2673 start)
2675 end)
2685 "Prune non exportable elements from DATA.
2686 DATA is the parse tree to traverse. INFO is the plist holding
2687 export info. Also set `:ignore-list' in INFO to a list of
2688 objects which should be ignored during export, but not removed
2689 from tree."
2691 ;; First find trees containing a select tag, if any.
2695 ;; Prune non-exportable elements and objects from tree.
2696 ;; As a special case, special rows and cells from tables
2697 ;; are stored in IGNORE, as they still need to be
2698 ;; accessed during export.
2708 ;; If headline is archived but tree below has
2709 ;; to be skipped, remove contents.
2711 ;; Move into recursive objects/elements.
2713 ;; Move into secondary string, if any.
2715 org-element-secondary-value-alist)))
2717 ;; If a select tag is active, also ignore the section before the
2718 ;; first headline, if any.
2723 ;; Prune tree and communication channel.
2727 ;; Priority is given to back-end specific options.
2729 org-export-options-alist))
2732 ;; Eventually set `:ignore-list'.
2736 "Change uninterpreted elements back into Org syntax.
2737 DATA is the parse tree. INFO is a plist containing export
2738 options. Each uninterpreted element or object is changed back
2739 into a string. Contents, if any, are not modified. The parse
2740 tree is modified by side effect."
2746 p
2749 info))))))
2752 "Change uninterpreted elements back into Org syntax.
2753 DATA is a parse tree or a secondary string. INFO is a plist
2754 containing export options. It is modified by side effect and
2755 returned by the function."
2758 subscript superscript underline)
2762 ;; ... entities...
2769 ?\s)))))
2770 ;; ... emphasis...
2782 marker
2786 ?\s)))))))
2787 ;; ... LaTeX environments and fragments...
2791 ;; ... sub/superscripts...
2800 "_"
2809 ?\s)))))))))))
2811 ;; Splice NEW at BLOB location in parse tree.
2814 info nil nil t)
2815 ;; Return modified parse tree.
2816 data)
2819 "Insert footnote definitions outside parsing scope in TREE.
2821 If there is a footnote section in TREE, definitions found are
2822 appended to it. If `org-footnote-section' is non-nil, a new
2823 footnote section containing all definitions is inserted in TREE.
2824 Otherwise, definitions are appended at the end of the section
2825 containing their first reference.
2827 Only definitions actually referred to within TREE, directly or
2828 not, are considered."
2847 definitions))
2855 'footnote-definition
2861 definitions))))))))
2862 ;; Collect all out of scope definitions.
2872 ;; Filter out definitions referenced neither in the original
2873 ;; tree nor in the external definitions.
2878 definitions))
2881 referenced-labels)))
2886 definitions)))
2887 ;; Install definitions in subtree.
2890 ;; If there is a footnote section, insert them here.
2895 nil t)))
2898 ;; If there should be a footnote section, create one containing
2899 ;; all the definitions at the end of the tree.
2902 tree
2908 'section
2909 nil
2911 ;; Otherwise add each definition at the end of the section where
2912 ;; it is first referenced.
2917 ;; Insert definitions in the same section as
2918 ;; their first reference in DATA.
2930 d)
2931 label)
2938 definition)
2940 definition)))))))))))
2943 ;;;###autoload
2946 "Transcode current Org buffer into BACKEND code.
2948 BACKEND is either an export back-end, as returned by, e.g.,
2949 `org-export-create-backend', or a symbol referring to
2950 a registered back-end.
2952 If narrowing is active in the current buffer, only transcode its
2953 narrowed part.
2955 If a region is active, transcode that region.
2957 When optional argument SUBTREEP is non-nil, transcode the
2958 sub-tree at point, extracting information from the headline
2959 properties first.
2961 When optional argument VISIBLE-ONLY is non-nil, don't export
2962 contents of hidden elements.
2964 When optional argument BODY-ONLY is non-nil, only return body
2965 code, without surrounding template.
2967 Optional argument EXT-PLIST, when provided, is a property list
2968 with external parameters overriding Org default settings, but
2969 still inferior to file-local settings.
2971 Return code as a string."
2976 ;; Narrow buffer to an appropriate region or subtree for
2977 ;; parsing. If parsing subtree, be sure to remove main headline
2978 ;; too.
2986 ;; Initialize communication channel with original buffer
2987 ;; attributes, unavailable in its copy.
2991 backend subtreep visible-only body-only)
2997 org-export-options-alist))))
2998 tree)
2999 ;; Update communication channel and get parse tree. Buffer
3000 ;; isn't parsed directly. Instead, all buffer modifications
3001 ;; and consequent parsing are undertaken in a temporary copy.
3003 ;; Run first hook with current back-end's name as argument.
3006 ;; Include files, delete comments and expand macros.
3011 ;; Refresh buffer properties and radio targets after
3012 ;; potentially invasive previous changes. Likewise, do it
3013 ;; again after executing Babel code.
3020 ;; Run last hook with current back-end's name as argument.
3021 ;; Update buffer properties and radio targets one last time
3022 ;; before parsing.
3029 ;; Update communication channel with environment. Also
3030 ;; install user's and developer's filters.
3035 ;; Call options filters and update export options. We do not
3036 ;; use `org-export-filter-apply-functions' here since the
3037 ;; arity of such filters is different.
3042 ;; Expand export-specific set of macros: {{{author}}},
3043 ;; {{{date(FORMAT)}}}, {{{email}}} and {{{title}}}. It must
3044 ;; be done once regular macros have been expanded, since
3045 ;; parsed keywords may contain one of them.
3058 value)
3059 value)))
3063 'finalize
3064 parsed-keywords)
3065 ;; Parse buffer.
3067 ;; Merge footnote definitions outside scope into parse tree.
3069 ;; Prune tree from non-exported elements and transform
3070 ;; uninterpreted elements or objects in both parse tree and
3071 ;; communication channel.
3074 ;; Call parse tree filters.
3078 ;; Now tree is complete, compute its properties and add them
3079 ;; to communication channel.
3081 ;; Eventually transcode TREE. Wrap the resulting string into
3082 ;; a template.
3091 info))
3094 ;; Remove all text properties since they cannot be
3095 ;; retrieved from an external process. Finally call
3096 ;; final-output filter and return result.
3102 info))))))))
3104 ;;;###autoload
3106 "Transcode STRING into BACKEND code.
3108 BACKEND is either an export back-end, as returned by, e.g.,
3109 `org-export-create-backend', or a symbol referring to
3110 a registered back-end.
3112 When optional argument BODY-ONLY is non-nil, only return body
3113 code, without preamble nor postamble.
3115 Optional argument EXT-PLIST, when provided, is a property list
3116 with external parameters overriding Org default settings, but
3117 still inferior to file-local settings.
3119 Return code as a string."
3125 ;;;###autoload
3127 "Replace the active region by its export to BACKEND.
3128 BACKEND is either an export back-end, as returned by, e.g.,
3129 `org-export-create-backend', or a symbol referring to
3130 a registered back-end."
3136 ;;;###autoload
3138 "Insert all export keywords with default values at beginning of line.
3140 BACKEND is a symbol referring to the name of a registered export
3141 back-end, for which specific export options should be added to
3142 the template, or `default' for default template. When it is nil,
3143 the user will be prompted for a category.
3145 If SUBTREEP is non-nil, export configuration will be set up
3146 locally for the subtree through node properties."
3156 "Options category: "
3160 org-export-registered-backends))
3161 nil t))))
3162 options keywords)
3163 ;; Populate OPTIONS and KEYWORDS.
3180 ;; Move to an appropriate location in order to insert options.
3182 ;; First (multiple) OPTIONS lines. Never go past fill-column.
3200 ;; Then the rest of keywords, in the order specified in either
3201 ;; `org-export-options-alist' or respective export back-ends.
3222 "Expand every include keyword in buffer.
3223 Optional argument INCLUDED is a list of included file names along
3224 with their line restriction, when appropriate. It is used to
3225 avoid infinite recursion. Optional argument DIR is the current
3226 working directory. It is used to properly resolve relative
3227 paths. Optional argument FOOTNOTES is a hash-table used for
3228 storing and resolving footnotes. It is created automatically."
3234 ;; If :minlevel is not set the text-property
3235 ;; `:org-include-induced-level' will be used to determine the
3236 ;; relative level when expanding INCLUDE.
3237 ;; Only affects included Org documents.
3241 :org-include-induced-level
3243 ;; Expand INCLUDE keywords.
3249 ;; Extract arguments from keyword's value.
3252 location
3260 matched)
3266 matched)
3267 dir)))
3271 value)
3277 value)
3286 ;; Minimal level of included file defaults to the child
3287 ;; level of the current headline, if any, or one. It
3288 ;; only applies is the file is meant to be included as
3289 ;; an Org one.
3300 ;; Remove keyword.
3306 ;; Check if files has already been parsed. Look after
3307 ;; inclusion lines too, as different parts of the same file
3308 ;; can be included too.
3321 ind-str block arg-str contents ind-str block))))
3328 ind-str block contents ind-str block))))
3336 file location only-contents lines)
3337 lines)))
3341 file lines ind minlevel
3344 footnotes)))
3348 footnotes)
3350 ;; Expand footnotes after all files have been included.
3351 ;; Footnotes are stored at end of buffer.
3356 footnotes)))))))))))
3359 "Resolve absolute lines for an included file with file-link.
3361 FILE is string file-name of the file to include. LOCATION is a
3362 string name within FILE to be included (located via
3363 `org-link-search'). If ONLY-CONTENTS is non-nil only the
3364 contents of the named element will be included, as determined
3365 Org-Element. If LINES is non-nil only those lines are included.
3367 Return a string of lines to be included in the format expected by
3368 `org-export--prepare-file-contents'."
3374 ;; Enforce consistent search.
3387 ;; Skip planning line and property-drawer.
3413 start-line
3415 (+ start-line
3418 counter))))))))
3422 "Prepare contents of FILE for inclusion and return it as a string.
3424 When optional argument LINES is a string specifying a range of
3425 lines, include only those lines.
3427 Optional argument IND, when non-nil, is an integer specifying the
3428 global indentation of returned contents. Since its purpose is to
3429 allow an included file to stay in the same environment it was
3430 created (e.g., a list item), it doesn't apply past the first
3431 headline encountered.
3433 Optional argument MINLEVEL, when non-nil, is an integer
3434 specifying the level that any top-level headline in the included
3435 file should have.
3437 Optional argument ID is an integer that will be inserted before
3438 each footnote definition and reference if FILE is an Org file.
3439 This is useful to avoid conflicts when more than one Org file
3440 with footnotes is included in a document.
3442 Optional argument FOOTNOTES is a hash-table to store footnotes in
3443 the included document."
3459 ;; Remove blank lines at beginning and end of contents. The logic
3460 ;; behind that removal is that blank lines around include keyword
3461 ;; override blank lines in included file.
3470 ;; If IND is set, preserve indentation of include keyword until
3471 ;; the first headline encountered.
3478 ;; Do not move footnote definitions out of column 0.
3484 ;; When MINLEVEL is specified, compute minimal level for headlines
3485 ;; in the file (CUR-MIN), and remove stars to each headline so
3486 ;; that headlines with minimal level have a level of MINLEVEL.
3497 ;; Only change stars, don't bother moving whole
3498 ;; sections.
3503 ;; Append ID to all footnote references and definitions, so they
3504 ;; become file specific and cannot collide with footnotes in other
3505 ;; included files. Further, collect relevant footnote definitions
3506 ;; outside of LINES, in order to reintroduce them later.
3512 ;; Generate new label from LABEL by prefixing it with
3513 ;; "-ID-".
3517 ;; Replace OLD label with NEW in footnote F.
3531 ;; Update the footnote-reference at point and collect
3532 ;; the new label, which is only used for footnotes
3533 ;; outsides LINES.
3545 ;; Store since footnote-definition is
3546 ;; outside of LINES.
3549 footnotes))))
3556 "Execute every Babel code in the visible part of current buffer."
3557 ;; Get a pristine copy of current buffer so Babel references can be
3558 ;; properly resolved.
3564 "Return a non-nil value when output should be added to the kill ring.
3565 See also `org-export-copy-to-kill-ring'."
3571 \f
3572 ;;; Tools For Back-Ends
3573 ;;
3574 ;; A whole set of tools is available to help build new exporters. Any
3575 ;; function general enough to have its use across many back-ends
3576 ;; should be added here.
3578 ;;;; For Affiliated Keywords
3579 ;;
3580 ;; `org-export-read-attribute' reads a property from a given element
3581 ;; as a plist. It can be used to normalize affiliated keywords'
3582 ;; syntax.
3583 ;;
3584 ;; Since captions can span over multiple lines and accept dual values,
3585 ;; their internal representation is a bit tricky. Therefore,
3586 ;; `org-export-get-caption' transparently returns a given element's
3587 ;; caption as a secondary string.
3590 "Turn ATTRIBUTE property from ELEMENT into a plist.
3592 When optional argument PROPERTY is non-nil, return the value of
3593 that property within attributes.
3597 properties.
3599 All values will become strings except the empty string and
3602 will become the empty string."
3616 s)
3621 ;; Ignore any string before first property with `cdr'.
3626 "Return caption from ELEMENT as a secondary string.
3628 When optional argument SHORTP is non-nil, return short caption,
3629 as a secondary string, instead.
3631 Caption lines are separated by a white space."
3639 ;;;; For Derived Back-ends
3640 ;;
3641 ;; `org-export-with-backend' is a function allowing to locally use
3642 ;; another back-end to transcode some object or element. In a derived
3643 ;; back-end, it may be used as a fall-back function once all specific
3644 ;; cases have been treated.
3647 "Call a transcoder from BACKEND on DATA.
3648 BACKEND is an export back-end, as returned by, e.g.,
3649 `org-export-create-backend', or a symbol referring to
3650 a registered back-end. DATA is an Org element, object, secondary
3651 string or string. CONTENTS, when non-nil, is the transcoded
3652 contents of DATA element, as a string. INFO, when non-nil, is
3653 the communication channel used for export, as a plist."
3663 transcoder data contents
3666 :back-end backend
3667 :translate-alist all-transcoders
3671 ;;;; For Export Snippets
3672 ;;
3673 ;; Every export snippet is transmitted to the back-end. Though, the
3674 ;; latter will only retain one type of export-snippet, ignoring
3675 ;; others, based on the former's target back-end. The function
3676 ;; `org-export-snippet-backend' returns that back-end for a given
3677 ;; export-snippet.
3680 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3681 Translation, with `org-export-snippet-translation-alist', is
3682 applied."
3686 back-end))))
3689 ;;;; For Footnotes
3690 ;;
3691 ;; `org-export-collect-footnote-definitions' is a tool to list
3692 ;; actually used footnotes definitions in the whole parse tree, or in
3693 ;; a headline, in order to add footnote listings throughout the
3694 ;; transcoded data.
3695 ;;
3696 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3697 ;; back-ends, when they need to attach the footnote definition only to
3698 ;; the first occurrence of the corresponding label.
3699 ;;
3700 ;; `org-export-get-footnote-definition' and
3701 ;; `org-export-get-footnote-number' provide easier access to
3702 ;; additional information relative to a footnote reference.
3705 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3706 INFO is the plist used as a communication channel. If no such
3707 definition can be found, raise an error."
3713 hash))))
3721 info t)
3722 cache)
3727 "Apply FUNCTION on every footnote reference in DATA.
3728 INFO is a plist containing export state. By default, as soon as
3729 a new footnote reference is encountered, FUNCTION is called onto
3730 its definition. However, if BODY-FIRST is non-nil, this step is
3731 delayed until the end of the process."
3736 ;; Search footnote references through DATA, filling
3737 ;; SEEN-REFS along the way. When DELAYP is non-nil,
3738 ;; store footnote definitions so they can be entered
3739 ;; later.
3746 ;; Search for subsequent references in footnote
3747 ;; definition so numbering follows reading
3748 ;; logic, unless DELAYP in non-nil.
3752 definitions))
3753 ;; Do not force entering inline definitions,
3754 ;; since `org-element-map' already traverses
3755 ;; them at the right time.
3759 nil))))))
3760 info nil
3761 ;; Don't enter footnote definitions since it will
3762 ;; happen when their first reference is found.
3763 ;; Moreover, if DELAYP is non-nil, make sure we
3764 ;; postpone entering definitions of inline references.
3771 "Return an alist between footnote numbers, labels and definitions.
3773 INFO is the current export state, as a plist.
3775 Definitions are collected throughout the whole parse tree, or
3776 DATA when non-nil.
3778 Sorting is done by order of references. As soon as a new
3779 reference is encountered, other references are searched within
3780 its definition. However, if BODY-FIRST is non-nil, this step is
3781 delayed after the whole tree is checked. This alters results
3782 when references are found in footnote definitions.
3784 Definitions either appear as Org data or as a secondary string
3785 for inlined footnotes. Unreferenced definitions are ignored."
3789 ;; Collect footnote number, label and definition.
3800 "Non-nil when a footnote reference is the first one for its label.
3802 FOOTNOTE-REFERENCE is the footnote reference being considered.
3803 INFO is a plist containing current export state.
3805 Search is done throughout the whole parse tree, or DATA when
3806 non-nil.
3808 By default, as soon as a new footnote reference is encountered,
3809 other references are searched within its definition. However, if
3810 BODY-FIRST is non-nil, this step is delayed after the whole tree
3811 is checked. This alters results when references are found in
3812 footnote definitions."
3814 ;; Anonymous footnotes are always a first reference.
3825 "Return number associated to a footnote.
3827 FOOTNOTE is either a footnote reference or a footnote definition.
3828 INFO is the plist containing export state.
3830 Number is unique throughout the whole parse tree, or DATA, when
3831 non-nil.
3833 By default, as soon as a new footnote reference is encountered,
3834 counting process moves into its definition. However, if
3835 BODY-FIRST is non-nil, this step is delayed until the end of the
3836 process, leading to a different order when footnotes are nested."
3845 ;; Anonymous footnote match: return number.
3847 ;; Labels match: return number.
3849 ;; Otherwise store label and increase counter if label
3850 ;; wasn't encountered yet.
3856 ;;;; For Headlines
3857 ;;
3858 ;; `org-export-get-relative-level' is a shortcut to get headline
3859 ;; level, relatively to the lower headline level in the parsed tree.
3860 ;;
3861 ;; `org-export-get-headline-number' returns the section number of an
3862 ;; headline, while `org-export-number-to-roman' allows it to be
3863 ;; converted to roman numbers. With an optional argument,
3864 ;; `org-export-get-headline-number' returns a number to unnumbered
3865 ;; headlines (used for internal id).
3866 ;;
3867 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3868 ;; `org-export-last-sibling-p' are three useful predicates when it
3869 ;; comes to fulfill the `:headline-levels' property.
3870 ;;
3871 ;; `org-export-get-tags', `org-export-get-category' and
3872 ;; `org-export-get-node-property' extract useful information from an
3873 ;; headline or a parent headline. They all handle inheritance.
3874 ;;
3875 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3876 ;; as a secondary string, suitable for table of contents. It falls
3877 ;; back onto default title.
3880 "Return HEADLINE relative level within current parsed tree.
3881 INFO is a plist holding contextual information."
3886 "Non-nil when HEADLINE is considered as low level.
3888 INFO is a plist used as a communication channel.
3890 A low level headlines has a relative level greater than
3891 `:headline-levels' property value.
3893 Return value is the difference between HEADLINE relative level
3894 and the last level being considered as high enough, or nil."
3901 "Return numbered HEADLINE numbering as a list of numbers.
3902 INFO is a plist holding contextual information."
3907 "Return a non-nil value if HEADLINE element should be numbered.
3908 INFO is a plist used as a communication channel."
3917 "Convert integer N into a roman numeral."
3930 res)))
3933 "Return list of tags associated to ELEMENT.
3935 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3936 is a plist used as a communication channel.
3938 When non-nil, optional argument TAGS should be a list of strings.
3939 Any tag belonging to this list will also be removed.
3941 When optional argument INHERITED is non-nil, tags can also be
3942 inherited from parent headlines and FILETAGS keywords."
3946 ;; Build complete list of inherited tags.
3953 ;; Add FILETAGS keywords and return results.
3957 "Return node PROPERTY value for BLOB.
3959 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3960 element or object.
3962 If optional argument INHERITED is non-nil, the value can be
3963 inherited from a parent headline.
3965 Return value is a string or nil."
3977 "Return category for element or object BLOB.
3979 INFO is a plist used as a communication channel.
3981 CATEGORY is automatically inherited from a parent headline, from
3982 #+CATEGORY: keyword or created out of original file name. If all
3995 "Return alternative title for HEADLINE, as a secondary string.
3996 If no optional title is defined, fall-back to the regular title."
4003 "Non-nil when BLOB is the first sibling in its parent.
4004 BLOB is an element or an object. If BLOB is a headline, non-nil
4005 means it is the first sibling in the sub-tree. INFO is a plist
4006 used as a communication channel."
4011 "Non-nil when BLOB is the last sibling in its parent.
4012 BLOB is an element or an object. INFO is a plist used as
4013 a communication channel."
4017 ;;;; For Keywords
4018 ;;
4019 ;; `org-export-get-date' returns a date appropriate for the document
4020 ;; to about to be exported. In particular, it takes care of
4021 ;; `org-export-date-timestamp-format'.
4024 "Return date value for the current document.
4026 INFO is a plist used as a communication channel. FMT, when
4027 non-nil, is a time format string that will be applied on the date
4028 if it consists in a single timestamp object. It defaults to
4029 `org-export-date-timestamp-format' when nil.
4031 A proper date can be a secondary string, a string or nil. It is
4032 meant to be translated with `org-export-data' or alike."
4043 ;;;; For Links
4044 ;;
4045 ;; `org-export-custom-protocol-maybe' handles custom protocol defined
4046 ;; with `org-add-link-type', which see.
4047 ;;
4048 ;; `org-export-get-coderef-format' returns an appropriate format
4049 ;; string for coderefs.
4050 ;;
4051 ;; `org-export-inline-image-p' returns a non-nil value when the link
4052 ;; provided should be considered as an inline image.
4053 ;;
4054 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
4055 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
4056 ;; returns an appropriate unique identifier.
4057 ;;
4058 ;; `org-export-resolve-id-link' returns the first headline with
4059 ;; specified id or custom-id in parse tree, the path to the external
4060 ;; file with the id.
4061 ;;
4062 ;; `org-export-resolve-coderef' associates a reference to a line
4063 ;; number in the element it belongs, or returns the reference itself
4064 ;; when the element isn't numbered.
4065 ;;
4066 ;; `org-export-file-uri' expands a filename as stored in :path value
4067 ;; of a "file" link into a file URI.
4068 ;;
4069 ;; Broken links raise a `org-link-broken' error, which is caught by
4070 ;; `org-export-data' for further processing, depending on
4071 ;; `org-export-with-broken-links' value.
4076 "Try exporting LINK with a dedicated function.
4078 DESC is its description, as a string, or nil. BACKEND is the
4079 back-end used for export, as a symbol.
4081 Return output as a string, or nil if no protocol handles LINK.
4083 A custom protocol has precedence over regular back-end export.
4084 The function ignores links with an implicit type (e.g.,
4093 desc
4094 backend))))))
4097 "Return format string for code reference link.
4098 PATH is the link path. DESC is its description."
4106 "Non-nil if LINK object points to an inline image.
4108 Optional argument is a set of RULES defining inline images. It
4109 is an alist where associations have the following shape:
4111 (TYPE . REGEXP)
4113 Applying a rule means apply REGEXP against LINK's path when its
4114 type is TYPE. The function will return a non-nil value if any of
4115 the provided rules is non-nil. The default rule is
4116 `org-export-default-inline-image-rule'.
4118 This only applies to links without a description."
4129 "Resolve a code reference REF.
4131 INFO is a plist used as a communication channel.
4133 Return associated line number in source code, or REF itself,
4134 depending on src-block or example element's switches. Throw an
4135 error if no block contains REF."
4142 org-coderef-label-format)))
4146 ;; Element containing REF is found. Resolve it to
4147 ;; either a label or a line number, as needed.
4156 "List search cells for element or object DATUM.
4158 A search cell follows the pattern (TYPE . SEARCH) where
4160 TYPE is a symbol among `headline', `custom-id', `target' and
4161 `other'.
4163 SEARCH is the string a link is expected to match. More
4164 accurately, it is
4166 - headline's title, as a list of strings, if TYPE is
4167 `headline'.
4169 - CUSTOM_ID value, as a string, if TYPE is `custom-id'.
4171 - target's or radio-target's name as a list of strings if
4172 TYPE is `target'.
4174 - NAME affiliated keyword is TYPE is `other'.
4176 A search cell is the internal representation of a fuzzy link. It
4177 ignores white spaces and statistics cookies, if applicable."
4179 (`headline
4190 (`target
4198 "Return search cells associated to string S.
4199 S is either the path of a fuzzy link or a search option, i.e., it
4200 tries to match either a headline (through custom ID or title),
4201 a target or a named element."
4209 "Non-nil when DATUM matches search cells CELLS.
4210 DATUM is an element or object. CELLS is a list of search cells,
4211 as returned by `org-export-search-cells'."
4216 "Return LINK destination.
4218 INFO is a plist holding contextual information.
4220 Return value can be an object or an element:
4222 - If LINK path matches a target object (i.e. <<path>>) return it.
4224 - If LINK path exactly matches the name affiliated keyword
4225 (i.e. #+NAME: path) of an element, return that element.
4227 - If LINK path exactly matches any headline name, return that
4228 element.
4230 - Otherwise, throw an error.
4233 significant."
4239 :resolve-fuzzy-link-cache
4249 datum)))))
4254 search-cells
4255 ;; There can be multiple matches for un-typed searches, i.e.,
4256 ;; for searches not starting with # or *. In this case,
4257 ;; prioritize targets and names over headline titles.
4258 ;; Matching both a name and a target is not valid, and
4259 ;; therefore undefined.
4262 datum))
4263 matches)
4265 link-cache)))))
4268 "Return headline referenced as LINK destination.
4270 INFO is a plist used as a communication channel.
4272 Return value can be the headline element matched in current parse
4276 ;; First check if id is within the current parse tree.
4281 headline))
4283 ;; Otherwise, look for external files.
4288 "Return radio-target object referenced as LINK destination.
4290 INFO is a plist used as a communication channel.
4292 Return value can be a radio-target object or nil. Assume LINK
4301 nil nil path nil nil t)
4302 t)
4303 radio))
4307 "Return file URI associated to FILENAME."
4314 ;;;; For References
4315 ;;
4316 ;; `org-export-get-reference' associate a unique reference for any
4317 ;; object or element. It uses `org-export-new-reference' and
4318 ;; `org-export-format-reference' to, respectively, generate new
4319 ;; internal references and turn them into a string suitable for
4320 ;; output.
4321 ;;
4322 ;; `org-export-get-ordinal' associates a sequence number to any object
4323 ;; or element.
4326 "Return a unique reference, among REFERENCES.
4327 REFERENCES is an alist whose values are in-use references, as
4328 numbers. Returns a number, which is the internal representation
4329 of a reference. See also `org-export-format-reference'."
4330 ;; Generate random 7 digits hexadecimal numbers. Collisions
4331 ;; increase exponentially with the numbers of references. However,
4332 ;; the odds for encountering at least one collision with 1000 active
4333 ;; references in the same document are roughly 0.2%, so this
4334 ;; shouldn't be the bottleneck.
4337 new))
4340 "Format REFERENCE into a string.
4341 REFERENCE is a number representing a reference, as returned by
4342 `org-export-new-reference', which see."
4346 "Return a unique reference for DATUM, as a string.
4348 DATUM is either an element or an object. INFO is the current
4349 export state, as a plist.
4351 This functions checks `:crossrefs' property in INFO for search
4352 cells matching DATUM before creating a new reference. Returned
4353 reference consists of alphanumeric characters only."
4358 ;; If any other published document relies on an
4359 ;; association between a search cell and a reference,
4360 ;; make sure to preserve it. See
4361 ;; `org-publish-resolve-external-link' for details.
4365 ;; Cache contains both data already associated to
4366 ;; a reference and in-use internal references, so as to make
4367 ;; unique references.
4369 ;; Keep an associated related to DATUM as not every object
4370 ;; and element can be associated to a search cell.
4373 reference-string))))
4376 "Return ordinal number of an element or object.
4378 ELEMENT is the element or object considered. INFO is the plist
4379 used as a communication channel.
4381 Optional argument TYPES, when non-nil, is a list of element or
4382 object types, as symbols, that should also be counted in.
4383 Otherwise, only provided element's type is considered.
4385 Optional argument PREDICATE is a function returning a non-nil
4386 value if the current element or object should be counted in. It
4387 accepts two arguments: the element or object being considered and
4388 the plist used as a communication channel. This allows counting
4389 only a certain type of object (i.e. inline images).
4391 Return value is a list of numbers if ELEMENT is a headline or an
4392 item. It is nil for keywords. It represents the footnote number
4393 for footnote definitions and footnote references. If ELEMENT is
4394 a target, return the same value as if ELEMENT was the closest
4395 table, item or headline containing the target. In any other
4396 case, return the sequence number of ELEMENT among elements or
4397 objects of the same type."
4398 ;; Ordinal of a target object refer to the ordinal of the closest
4399 ;; table, item, or headline containing the object.
4403 element
4406 ;; Special case 1: A headline returns its number as a list.
4408 ;; Special case 2: An item returns its number as a list.
4412 struct
4419 ;; Increment counter until ELEMENT is found again.
4430 ;;;; For Src-Blocks
4431 ;;
4432 ;; `org-export-get-loc' counts number of code lines accumulated in
4433 ;; src-block or example-block elements with a "+n" switch until
4434 ;; a given element, excluded. Note: "-n" switches reset that count.
4435 ;;
4436 ;; `org-export-unravel-code' extracts source code (along with a code
4437 ;; references alist) from an `element-block' or `src-block' type
4438 ;; element.
4439 ;;
4440 ;; `org-export-format-code' applies a formatting function to each line
4441 ;; of code, providing relative line number and code reference when
4442 ;; appropriate. Since it doesn't access the original element from
4443 ;; which the source code is coming, it expects from the code calling
4444 ;; it to know if lines should be numbered and if code references
4445 ;; should appear.
4446 ;;
4447 ;; Eventually, `org-export-format-code-default' is a higher-level
4448 ;; function (it makes use of the two previous functions) which handles
4449 ;; line numbering and code references inclusion, and returns source
4450 ;; code in a format suitable for plain text or verbatim output.
4453 "Return count of lines of code before ELEMENT.
4455 ELEMENT is an example-block or src-block element. INFO is the
4456 plist used as a communication channel.
4458 Count includes every line of code in example-block or src-block
4460 ELEMENT doesn't allow line numbering."
4467 ;; ELEMENT is reached: Quit loop and return locs.
4469 ;; Only count lines from src-block and example-block
4470 ;; elements with a "+n" or "-n" switch.
4475 ;; Accumulate locs or reset them.
4483 "Clean source code and extract references out of it.
4485 ELEMENT has either a `src-block' an `example-block' type.
4487 Return a cons cell whose CAR is the source code, cleaned from any
4488 reference, protective commas and spurious indentation, and CDR is
4489 an alist between relative line number (integer) and name of code
4490 reference on that line (string)."
4493 ;; Get code and clean it. Remove blank lines at its
4494 ;; beginning and end.
4501 value
4503 ;; Get format used for references.
4506 org-coderef-label-format)))
4507 ;; Build a regexp matching a loc with a reference.
4512 ;; Return value.
4514 ;; Code with references removed.
4520 ;; Ref line: remove ref, and signal its position in REFS.
4524 ;; Reference alist.
4525 refs)))
4528 "Format CODE by applying FUN line-wise and return it.
4530 CODE is a string representing the code to format. FUN is
4531 a function. It must accept three arguments: a line of
4532 code (string), the current line number (integer) or nil and the
4533 reference associated to the current line (string) or nil.
4535 Optional argument NUM-LINES can be an integer representing the
4536 number of code lines accumulated until the current code. Line
4537 numbers passed to FUN will take it into account. If it is nil,
4538 FUN's second argument will always be nil. This number can be
4539 obtained with `org-export-get-loc' function.
4541 Optional argument REF-ALIST can be an alist between relative line
4542 number (i.e. ignoring NUM-LINES) and the name of the code
4543 reference on it. If it is nil, FUN's third argument will always
4544 be nil. It can be obtained through the use of
4545 `org-export-unravel-code' function."
4557 "Return source code from ELEMENT, formatted in a standard way.
4559 ELEMENT is either a `src-block' or `example-block' element. INFO
4560 is a plist used as a communication channel.
4562 This function takes care of line numbering and code references
4563 inclusion. Line numbers, when applicable, appear at the
4564 beginning of the line, separated from the code by two white
4565 spaces. Code references, on the other hand, appear flushed to
4566 the right, separated by six white spaces from the widest line of
4567 code."
4568 ;; Extract code and references.
4575 ;; Handle line numbering.
4582 ;; Prepare references display, if required. Any reference
4583 ;; should start six columns after the widest line of code,
4584 ;; wrapped with parenthesis.
4589 code
4593 number-str
4594 loc
4600 num-start refs)))))
4603 ;;;; For Tables
4604 ;;
4605 ;; `org-export-table-has-special-column-p' and and
4606 ;; `org-export-table-row-is-special-p' are predicates used to look for
4607 ;; meta-information about the table structure.
4608 ;;
4609 ;; `org-table-has-header-p' tells when the rows before the first rule
4610 ;; should be considered as table's header.
4611 ;;
4612 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4613 ;; and `org-export-table-cell-borders' extract information from
4614 ;; a table-cell element.
4615 ;;
4616 ;; `org-export-table-dimensions' gives the number on rows and columns
4617 ;; in the table, ignoring horizontal rules and special columns.
4618 ;; `org-export-table-cell-address', given a table-cell object, returns
4619 ;; the absolute address of a cell. On the other hand,
4620 ;; `org-export-get-table-cell-at' does the contrary.
4621 ;;
4622 ;; `org-export-table-cell-starts-colgroup-p',
4623 ;; `org-export-table-cell-ends-colgroup-p',
4624 ;; `org-export-table-row-starts-rowgroup-p',
4625 ;; `org-export-table-row-ends-rowgroup-p',
4626 ;; `org-export-table-row-starts-header-p',
4627 ;; `org-export-table-row-ends-header-p' and
4628 ;; `org-export-table-row-in-header-p' indicate position of current row
4629 ;; or cell within the table.
4632 "Non-nil when TABLE has a special column.
4633 All special columns will be ignored during export."
4634 ;; The table has a special column when every first cell of every row
4635 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4636 ;; "*" "_" and "^". Though, do not consider a first row containing
4637 ;; only empty cells as special.
4651 "Non-nil when TABLE has a header.
4653 INFO is a plist used as a communication channel.
4655 A table has a header when it contains at least two row groups."
4664 table
4675 cache)))))
4678 "Non-nil if TABLE-ROW is considered special.
4679 All special rows will be ignored during export."
4683 ;; A row is special either when...
4685 ;; ... it starts with a field only containing "/",
4687 ;; ... the table contains a special column and the row start
4688 ;; with a marking character among, "^", "_", "$" or "!",
4692 ;; ... it contains only alignment cookies and empty cells.
4697 ;; Since VALUE is a secondary string, the following
4698 ;; checks avoid expanding it with `org-export-data'.
4709 "Return TABLE-ROW's group number, as an integer.
4711 INFO is a plist used as the communication channel.
4713 Return value is the group number, as an integer, or nil for
4714 special rows and rows separators. First group is also table's
4715 header."
4733 "Return TABLE-CELL contents width.
4735 INFO is a plist used as the communication channel.
4737 Return value is the width given by the last width cookie in the
4738 same column as TABLE-CELL, or nil."
4757 ;; In a special row, try to find a width cookie at COLUMN.
4761 ;; The following checks avoid expanding unnecessarily
4762 ;; the cell with `org-export-data'.
4772 "Return TABLE-CELL contents alignment.
4774 INFO is a plist used as the communication channel.
4776 Return alignment as specified by the last alignment cookie in the
4777 same column as TABLE-CELL. If no such cookie is found, a default
4778 alignment value will be deduced from fraction of numbers in the
4779 column (see `org-table-number-fraction' for more information).
4780 Possible values are `left', `right' and `center'."
4781 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4798 cookie-align
4799 previous-cell-number-p)
4802 ;; In a special row, try to find an alignment cookie at
4803 ;; COLUMN.
4807 ;; Since VALUE is a secondary string, the following
4808 ;; checks avoid useless expansion through
4809 ;; `org-export-data'.
4817 ;; Ignore table rules.
4819 ;; In a standard row, check if cell's contents are
4820 ;; expressing some kind of number. Increase NUMBER-CELLS
4821 ;; accordingly. Though, don't bother if an alignment
4822 ;; cookie has already defined cell's alignment.
4827 info)))
4829 ;; Treat an empty cell as a number if it follows
4830 ;; a number.
4836 ;; Return value. Alignment specified by cookies has
4837 ;; precedence over alignment deduced from cell's contents.
4839 column
4844 org-table-number-fraction)
4849 "Return TABLE-CELL borders.
4851 INFO is a plist used as a communication channel.
4853 Return value is a list of symbols, or nil. Possible values are:
4854 `top', `bottom', `above', `below', `left' and `right'. Note:
4855 `top' (resp. `bottom') only happen for a cell in the first
4856 row (resp. last row) of the table, ignoring table rules, if any.
4858 Returned borders ignore special rows."
4861 borders)
4862 ;; Top/above border? TABLE-CELL has a border above when a rule
4863 ;; used to demarcate row groups can be found above. Hence,
4864 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4865 ;; another regular row has to be found above that rule.
4868 ;; Look at every row before the current one.
4875 ;; No rule above, or rule found starts the table (ignoring any
4876 ;; special row): TABLE-CELL is at the top of the table.
4879 ;; Bottom/below border? TABLE-CELL has a border below when next
4880 ;; non-regular row below is a rule.
4883 ;; Look at every row after the current one.
4890 ;; No rule below, or rule found ends the table (modulo some
4891 ;; special row): TABLE-CELL is at the bottom of the table.
4894 ;; Right/left borders? They can only be specified by column
4895 ;; groups. Column groups are defined in a row starting with "/".
4896 ;; Also a column groups row only contains "<", "<>", ">" or blank
4897 ;; cells.
4901 ;; Table rows are read in reverse order so last column groups
4902 ;; row has precedence over any previous one.
4915 ;; There's a left border when previous cell, if
4916 ;; any, ends a group, or current one starts one.
4922 ;; There's a right border when next cell, if any,
4923 ;; starts a group, or current one ends one.
4930 ;; Return value.
4931 borders))
4934 "Non-nil when TABLE-CELL is at the beginning of a column group.
4935 INFO is a plist used as a communication channel."
4936 ;; A cell starts a column group either when it is at the beginning
4937 ;; of a row (or after the special column, if any) or when it has
4938 ;; a left border.
4941 table-cell)
4945 "Non-nil when TABLE-CELL is at the end of a column group.
4946 INFO is a plist used as a communication channel."
4947 ;; A cell ends a column group either when it is at the end of a row
4948 ;; or when it has a right border.
4951 table-cell)
4955 "Non-nil when TABLE-ROW is at the beginning of a row group.
4956 INFO is a plist used as a communication channel."
4964 "Non-nil when TABLE-ROW is at the end of a row group.
4965 INFO is a plist used as a communication channel."
4973 "Non-nil when TABLE-ROW is located within table's header.
4974 INFO is a plist used as a communication channel. Always return
4975 nil for special rows and rows separators."
4981 "Non-nil when TABLE-ROW is the first table header's row.
4982 INFO is a plist used as a communication channel."
4987 "Non-nil when TABLE-ROW is the last table header's row.
4988 INFO is a plist used as a communication channel."
4993 "Return TABLE-ROW number.
4994 INFO is a plist used as a communication channel. Return value is
4995 zero-based and ignores separators. The function returns nil for
4996 special columns and separators."
5008 "Return TABLE dimensions.
5010 INFO is a plist used as a communication channel.
5012 Return value is a CONS like (ROWS . COLUMNS) where
5013 ROWS (resp. COLUMNS) is the number of exportable
5014 rows (resp. columns)."
5016 ;; Set number of rows, and extract first one.
5022 ;; Set number of columns.
5024 ;; Return value.
5028 "Return address of a regular TABLE-CELL object.
5030 TABLE-CELL is the cell considered. INFO is a plist used as
5031 a communication channel.
5033 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5034 zero-based index. Only exportable cells are considered. The
5035 function returns nil for other cells."
5047 "Return regular table-cell object at ADDRESS in TABLE.
5049 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
5050 zero-based index. TABLE is a table type element. INFO is
5051 a plist used as a communication channel.
5053 If no table-cell, among exportable cells, is found at ADDRESS,
5054 return nil."
5057 ;; Row at (car address) or nil.
5065 'table-cell
5072 ;;;; For Tables Of Contents
5073 ;;
5074 ;; `org-export-collect-headlines' builds a list of all exportable
5075 ;; headline elements, maybe limited to a certain depth. One can then
5076 ;; easily parse it and transcode it.
5077 ;;
5078 ;; Building lists of tables, figures or listings is quite similar.
5079 ;; Once the generic function `org-export-collect-elements' is defined,
5080 ;; `org-export-collect-tables', `org-export-collect-figures' and
5081 ;; `org-export-collect-listings' can be derived from it.
5084 "Collect headlines in order to build a table of contents.
5086 INFO is a plist used as a communication channel.
5088 When optional argument N is an integer, it specifies the depth of
5089 the table of contents. Otherwise, it is set to the value of the
5090 last headline level. See `org-export-headline-levels' for more
5091 information.
5093 Optional argument SCOPE, when non-nil, is an element. If it is
5094 a headline, only children of SCOPE are collected. Otherwise,
5095 collect children of the headline containing provided element. If
5096 there is no such headline, collect all headlines. In any case,
5097 argument N becomes relative to the level of that headline.
5099 Return a list of all exportable headlines as parsed elements.
5100 Footnote sections are ignored."
5109 limit))))
5115 info)))
5118 "Collect referenceable elements of a determined type.
5120 TYPE can be a symbol or a list of symbols specifying element
5121 types to search. Only elements with a caption are collected.
5123 INFO is a plist used as a communication channel.
5125 When non-nil, optional argument PREDICATE is a function accepting
5126 one argument, an element of type TYPE. It returns a non-nil
5127 value when that element should be collected.
5129 Return a list of all elements found, in order of appearance."
5134 element))
5135 info))
5138 "Build a list of tables.
5139 INFO is a plist used as a communication channel.
5141 Return a list of table elements with a caption."
5145 "Build a list of figures.
5147 INFO is a plist used as a communication channel. PREDICATE is
5148 a function which accepts one argument: a paragraph element and
5149 whose return value is non-nil when that element should be
5150 collected.
5152 A figure is a paragraph type element, with a caption, verifying
5154 a vague concept that may depend on back-end.
5156 Return a list of elements recognized as figures."
5160 "Build a list of src blocks.
5162 INFO is a plist used as a communication channel.
5164 Return a list of src-block elements with a caption."
5168 ;;;; Smart Quotes
5169 ;;
5170 ;; The main function for the smart quotes sub-system is
5171 ;; `org-export-activate-smart-quotes', which replaces every quote in
5172 ;; a given string from the parse tree with its "smart" counterpart.
5173 ;;
5174 ;; Dictionary for smart quotes is stored in
5175 ;; `org-export-smart-quotes-alist'.
5179 ;; one may use: »...«, "...", ›...‹, or '...'.
5180 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
5181 ;; LaTeX quotes require Babel!
5231 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5242 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5253 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5264 ;; 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
5265 ;; http://www.artlebedev.ru/kovodstvo/sections/104/
5276 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5282 "Smart quotes translations.
5284 Alist whose CAR is a language string and CDR is an alist with
5285 quote type as key and a plist associating various encodings to
5286 their translation as value.
5288 A quote type can be any symbol among `primary-opening',
5289 `primary-closing', `secondary-opening', `secondary-closing' and
5290 `apostrophe'.
5292 Valid encodings include `:utf-8', `:html', `:latex' and
5293 `:texinfo'.
5298 "Return smart quote status at the beginning of string S.
5299 INFO is the current export state, as a plist."
5304 table)))
5312 'plain-text
5321 ;; Not already in a level 1 quote: this is an
5322 ;; apostrophe.
5324 ;; Extract previous char and next char. As
5325 ;; a special case, they can also be set to `blank',
5326 ;; `no-blank' or nil. Then determine if current
5327 ;; match is allowed as an opening quote or a closing
5328 ;; quote.
5333 text info)))
5350 previous)
5361 next)
5368 current-status)
5372 info nil org-element-recursive-objects)
5379 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5380 `:utf-8'. INFO is a plist used as a communication channel.
5382 The function has to retrieve information about string
5383 surroundings in parse tree. It can only happen with an
5384 unmodified string. Thus, if S has already been through another
5385 process, a non-nil ORIGINAL optional argument will provide that
5386 original string.
5388 Return the new string."
5397 org-export-smart-quotes-alist))))
5398 encoding)
5399 match))
5400 s nil t)))
5402 ;;;; Topology
5403 ;;
5404 ;; Here are various functions to retrieve information about the
5405 ;; neighborhood of a given element or object. Neighbors of interest
5406 ;; are direct parent (`org-export-get-parent'), parent headline
5407 ;; (`org-export-get-parent-headline'), first element containing an
5408 ;; object, (`org-export-get-parent-element'), parent table
5409 ;; (`org-export-get-parent-table'), previous element or object
5410 ;; (`org-export-get-previous-element') and next element or object
5411 ;; (`org-export-get-next-element').
5413 ;; defsubst org-export-get-parent must be defined before first use
5419 "Return BLOB parent headline or nil.
5420 BLOB is the element or object being considered."
5424 "Return first element containing OBJECT or nil.
5425 OBJECT is the object to consider."
5429 "Return OBJECT parent table or nil.
5430 OBJECT is either a `table-cell' or `table-element' type object."
5434 "Return previous element or object.
5436 BLOB is an element or object. INFO is a plist used as
5437 a communication channel. Return previous exportable element or
5438 object, a string, or nil.
5440 When optional argument N is a positive integer, return a list
5441 containing up to N siblings before BLOB, from farthest to
5442 closest. With any other non-nil value, return a list containing
5443 all of them."
5449 prev)
5459 "Return next element or object.
5461 BLOB is an element or object. INFO is a plist used as
5462 a communication channel. Return next exportable element or
5463 object, a string, or nil.
5465 When optional argument N is a positive integer, return a list
5466 containing up to N siblings after BLOB, from closest to farthest.
5467 With any other non-nil value, return a list containing all of
5468 them."
5475 next)
5485 ;;;; Translation
5486 ;;
5487 ;; `org-export-translate' translates a string according to the language
5488 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5489 ;; the dictionary used for the translation.
5521 ("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
5531 ("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
5537 ("ru" :html "(Продолжение следует)"
5611 ("es" :ascii "Nota al pie de pagina" :html "Nota al pie de página" :default "Nota al pie de página")
5634 ("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
5640 ("ru" :html "Список распечаток"
5654 ("ru" :html "Список таблиц"
5760 ("ru" :html "Неизвестная ссылка"
5763 "Dictionary for export engine.
5765 Alist whose car is the string to translate and cdr is an alist
5766 whose car is the language string and cdr is a plist whose
5767 properties are possible charsets and values translated terms.
5769 It is used as a database for `org-export-translate'. Since this
5770 function returns the string as-is if no translation was found,
5771 the variable only needs to record values different from the
5775 "Translate string S according to language specification.
5777 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5778 and `:utf-8'. INFO is a plist used as a communication channel.
5780 Translation depends on `:language' property. Return the
5781 translated string. If no translation is found, try to fall back
5782 to `:default' encoding. If it fails, return S."
5788 s)))
5791 \f
5792 ;;; Asynchronous Export
5793 ;;
5794 ;; `org-export-async-start' is the entry point for asynchronous
5795 ;; export. It recreates current buffer (including visibility,
5796 ;; narrowing and visited file) in an external Emacs process, and
5797 ;; evaluates a command there. It then applies a function on the
5798 ;; returned results in the current process.
5799 ;;
5800 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5801 ;; allow exporting to a buffer or a file, asynchronously or not.
5802 ;;
5803 ;; `org-export-output-file-name' is an auxiliary function meant to be
5804 ;; used with `org-export-to-file'. With a given extension, it tries
5805 ;; to provide a canonical file name to write export output to.
5806 ;;
5807 ;; Asynchronously generated results are never displayed directly.
5808 ;; Instead, they are stored in `org-export-stack-contents'. They can
5809 ;; then be retrieved by calling `org-export-stack'.
5810 ;;
5811 ;; Export Stack is viewed through a dedicated major mode
5812 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5813 ;;`org-export-stack-delete', `org-export-stack-view' and
5814 ;;`org-export-stack-clear'.
5815 ;;
5816 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5817 ;; It should be used whenever `org-export-async-start' is called.
5820 "Call function FUN on the results returned by BODY evaluation.
5822 FUN is an anonymous function of one argument. BODY evaluation
5823 happens in an asynchronous process, from a buffer which is an
5824 exact copy of the current one.
5826 Use `org-export-add-to-stack' in FUN in order to register results
5827 in the stack.
5829 This is a low level function. See also `org-export-to-buffer'
5830 and `org-export-to-file' for more specialized functions."
5833 ;; Write the full sexp evaluating BODY in a copy of the current
5834 ;; buffer to a temporary file, as it may be too long for program
5835 ;; args in `start-process'.
5842 ;; Null characters (from variable values) are inserted
5843 ;; within the file. As a consequence, coding system for
5844 ;; buffer contents will not be recognized properly. So,
5845 ;; we make sure it is the same as the one used to display
5846 ;; the original buffer.
5848 ,coding
5851 ;; Ignore `kill-emacs-hook' and code evaluation
5852 ;; queries from Babel as we need a truly
5853 ;; non-interactive process.
5855 org-babel-confirm-evaluate-answer-no t)
5856 ;; Initialize export framework.
5858 ;; Re-create current buffer there.
5861 ;; Sexp to evaluate in the buffer.
5863 ;; Start external process.
5866 (,process
5868 #'start-process
5871 ,proc-buffer
5878 ;; Register running process in stack.
5880 ;; Set-up sentinel in order to catch results.
5883 ,process
5905 ;;;###autoload
5908 &optional async subtreep visible-only body-only ext-plist
5909 post-process)
5910 "Call `org-export-as' with output to a specified buffer.
5912 BACKEND is either an export back-end, as returned by, e.g.,
5913 `org-export-create-backend', or a symbol referring to
5914 a registered back-end.
5916 BUFFER is the name of the output buffer. If it already exists,
5917 it will be erased first, otherwise, it will be created.
5919 A non-nil optional argument ASYNC means the process should happen
5920 asynchronously. The resulting buffer should then be accessible
5921 through the `org-export-stack' interface. When ASYNC is nil, the
5922 buffer is displayed if `org-export-show-temporary-export-buffer'
5923 is non-nil.
5925 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5926 EXT-PLIST are similar to those used in `org-export-as', which
5927 see.
5929 Optional argument POST-PROCESS is a function which should accept
5930 no argument. It is always called within the current process,
5931 from BUFFER, with point at its beginning. Export back-ends can
5932 use it to set a major mode there, e.g,
5934 (defun org-latex-export-as-latex
5935 (&optional async subtreep visible-only body-only ext-plist)
5936 (interactive)
5938 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5940 This function returns BUFFER."
5968 buffer)))
5970 ;;;###autoload
5973 post-process)
5974 "Call `org-export-as' with output to a specified file.
5976 BACKEND is either an export back-end, as returned by, e.g.,
5977 `org-export-create-backend', or a symbol referring to
5978 a registered back-end. FILE is the name of the output file, as
5979 a string.
5981 A non-nil optional argument ASYNC means the process should happen
5982 asynchronously. The resulting buffer will then be accessible
5983 through the `org-export-stack' interface.
5985 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5986 EXT-PLIST are similar to those used in `org-export-as', which
5987 see.
5989 Optional argument POST-PROCESS is called with FILE as its
5990 argument and happens asynchronously when ASYNC is non-nil. It
5991 has to return a file name, or nil. Export back-ends can use this
5992 to send the output file through additional processing, e.g,
5994 (defun org-latex-export-to-latex
5995 (&optional async subtreep visible-only body-only ext-plist)
5996 (interactive)
5999 async subtreep visible-only body-only ext-plist
6000 (lambda (file) (org-latex-compile file)))
6002 The function returns either a file name returned by POST-PROCESS,
6003 or FILE."
6022 backend subtreep visible-only body-only ext-plist)))
6029 ;; Get proper return value.
6031 file))))))
6034 "Return output file's name according to buffer specifications.
6036 EXTENSION is a string representing the output file extension,
6037 with the leading dot.
6039 With a non-nil optional argument SUBTREEP, try to determine
6041 of subtree at point.
6043 When optional argument PUB-DIR is set, use it as the publishing
6044 directory.
6046 Return file name as a string."
6049 ;; File name may come from EXPORT_FILE_NAME subtree
6050 ;; property.
6053 ;; File name may be extracted from buffer's associated
6054 ;; file, if any.
6056 ;; Can't determine file name on our own: Ask user.
6058 "Output file: " pub-dir nil nil nil
6062 ;; Build file name. Enforce EXTENSION over whatever user
6063 ;; may have come up with. PUB-DIR, if defined, always has
6064 ;; precedence over any provided path.
6069 extension))
6072 ;; If writing to OUTPUT-FILE would overwrite original file, append
6073 ;; EXTENSION another time to final name.
6076 output-file)))
6079 "Add a new result to export stack if not present already.
6081 SOURCE is a buffer or a file name containing export results.
6082 BACKEND is a symbol representing export back-end used to generate
6083 it.
6085 Entries already pointing to SOURCE and unavailable entries are
6086 removed beforehand. Return the new stack."
6092 "Menu for asynchronous export results and running processes."
6102 "Return source from export results at point in stack."
6109 source
6110 ;; SOURCE is not consistent with current line. The stack
6111 ;; view is outdated.
6115 "Remove all entries from export stack."
6120 "Refresh the asynchronous export stack.
6121 Unavailable sources are removed from the list. Return the new
6122 stack."
6131 ;; Back-end.
6133 ;; Age.
6136 ;; Compute age of the results.
6138 "%4h:%.2m "
6140 ;; Source.
6145 ;; Clear stack from exited processes, dead buffers or
6146 ;; non-existent files.
6158 "Remove export results at point from stack.
6159 If optional argument SOURCE is non-nil, remove it instead."
6164 org-export-stack-contents))))
6167 "View export results at point in stack.
6168 With an optional prefix argument IN-EMACS, force viewing files
6169 within Emacs."
6183 (define-key km "p" 'previous-line)
6184 (define-key km "\C-p" 'previous-line)
6185 (define-key km "\C-?" 'previous-line)
6186 (define-key km [up] 'previous-line)
6187 (define-key km "C" 'org-export-stack-clear)
6188 (define-key km "v" 'org-export-stack-view)
6189 (define-key km (kbd "RET") 'org-export-stack-view)
6190 (define-key km "d" 'org-export-stack-remove)
6191 km)
6192 "Keymap for Org Export Stack.")
6194 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
6195 "Mode for displaying asynchronous export stack.
6198 stack.
6200 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
6201 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
6202 stack completely.
6204 Removing entries in an Org Export Stack buffer doesn't affect
6205 files or buffers, only the display.
6208 (abbrev-mode 0)
6209 (auto-fill-mode 0)
6210 (setq buffer-read-only t
6211 buffer-undo-list t
6212 truncate-lines t
6213 header-line-format
6214 '(:eval
6215 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
6216 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
6217 (setq-local revert-buffer-function
6218 'org-export-stack-refresh))
6221 \f
6222 ;;; The Dispatcher
6223 ;;
6224 ;; `org-export-dispatch' is the standard interactive way to start an
6225 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
6226 ;; for its interface, which, in turn, delegates response to key
6227 ;; pressed to `org-export--dispatch-action'.
6229 ;;;###autoload
6230 (defun org-export-dispatch (&optional arg)
6231 "Export dispatcher for Org mode.
6233 It provides an access to common export related tasks in a buffer.
6234 Its interface comes in two flavors: standard and expert.
6236 While both share the same set of bindings, only the former
6237 displays the valid keys associations in a dedicated buffer.
6238 Scrolling (resp. line-wise motion) in this buffer is done with
6239 SPC and DEL (resp. C-n and C-p) keys.
6241 Set variable `org-export-dispatch-use-expert-ui' to switch to one
6242 flavor or the other.
6245 of options used back then, on the current buffer.
6247 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
6248 (interactive "P")
6249 (let* ((input
6250 (cond ((equal arg '(16)) '(stack))
6251 ((and arg org-export-dispatch-last-action))
6252 (t (save-window-excursion
6253 (unwind-protect
6254 (progn
6255 ;; Remember where we are
6256 (move-marker org-export-dispatch-last-position
6257 (point)
6258 (org-base-buffer (current-buffer)))
6259 ;; Get and store an export command
6260 (setq org-export-dispatch-last-action
6261 (org-export--dispatch-ui
6262 (list org-export-initial-scope
6263 (and org-export-in-background 'async))
6264 nil
6265 org-export-dispatch-use-expert-ui)))
6266 (and (get-buffer "*Org Export Dispatcher*")
6267 (kill-buffer "*Org Export Dispatcher*")))))))
6268 (action (car input))
6269 (optns (cdr input)))
6270 (unless (memq 'subtree optns)
6271 (move-marker org-export-dispatch-last-position nil))
6272 (cl-case action
6273 ;; First handle special hard-coded actions.
6274 (template (org-export-insert-default-template nil optns))
6275 (stack (org-export-stack))
6276 (publish-current-file
6277 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
6278 (publish-current-project
6279 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
6280 (publish-choose-project
6281 (org-publish (assoc (completing-read
6282 "Publish project: "
6283 org-publish-project-alist nil t)
6284 org-publish-project-alist)
6285 (memq 'force optns)
6286 (memq 'async optns)))
6287 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
6288 (otherwise
6289 (save-excursion
6290 (when arg
6291 ;; Repeating command, maybe move cursor to restore subtree
6292 ;; context.
6293 (if (eq (marker-buffer org-export-dispatch-last-position)
6294 (org-base-buffer (current-buffer)))
6295 (goto-char org-export-dispatch-last-position)
6296 ;; We are in a different buffer, forget position.
6297 (move-marker org-export-dispatch-last-position nil)))
6298 (funcall action
6299 ;; Return a symbol instead of a list to ease
6300 ;; asynchronous export macro use.
6301 (and (memq 'async optns) t)
6302 (and (memq 'subtree optns) t)
6303 (and (memq 'visible optns) t)
6304 (and (memq 'body optns) t)))))))
6306 (defun org-export--dispatch-ui (options first-key expertp)
6307 "Handle interface for `org-export-dispatch'.
6309 OPTIONS is a list containing current interactive options set for
6310 export. It can contain any of the following symbols:
6311 `body' toggles a body-only export
6312 `subtree' restricts export to current subtree
6313 `visible' restricts export to visible part of buffer.
6314 `force' force publishing files.
6315 `async' use asynchronous export process
6317 FIRST-KEY is the key pressed to select the first level menu. It
6318 is nil when this menu hasn't been selected yet.
6320 EXPERTP, when non-nil, triggers expert UI. In that case, no help
6321 buffer is provided, but indications about currently active
6322 options are given in the prompt. Moreover, [?] allows switching
6323 back to standard interface."
6324 (let* ((fontify-key
6325 (lambda (key &optional access-key)
6326 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
6327 ;; non-nil is the required first-level key to activate
6328 ;; KEY. When its value is t, activate KEY independently
6329 ;; on the first key, if any. A nil value means KEY will
6330 ;; only be activated at first level.
6331 (if (or (eq access-key t) (eq access-key first-key))
6332 (propertize key 'face 'org-warning)
6333 key)))
6334 (fontify-value
6335 (lambda (value)
6336 ;; Fontify VALUE string.
6337 (propertize value 'face 'font-lock-variable-name-face)))
6338 ;; Prepare menu entries by extracting them from registered
6339 ;; back-ends and sorting them by access key and by ordinal,
6340 ;; if any.
6341 (entries
6342 (sort (sort (delq nil
6343 (mapcar #'org-export-backend-menu
6344 org-export-registered-backends))
6345 (lambda (a b)
6346 (let ((key-a (nth 1 a))
6347 (key-b (nth 1 b)))
6348 (cond ((and (numberp key-a) (numberp key-b))
6349 (< key-a key-b))
6350 ((numberp key-b) t)))))
6351 'car-less-than-car))
6352 ;; Compute a list of allowed keys based on the first key
6353 ;; pressed, if any. Some keys
6354 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
6355 ;; available.
6356 (allowed-keys
6357 (nconc (list 2 22 19 6 1)
6358 (if (not first-key) (org-uniquify (mapcar 'car entries))
6359 (let (sub-menu)
6360 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
6361 (when (eq (car entry) first-key)
6362 (setq sub-menu (append (nth 2 entry) sub-menu))))))
6363 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
6364 ((not first-key) (list ?P)))
6365 (list ?& ?#)
6366 (when expertp (list ??))
6367 (list ?q)))
6368 ;; Build the help menu for standard UI.
6369 (help
6370 (unless expertp
6371 (concat
6372 ;; Options are hard-coded.
6373 (format "[%s] Body only: %s [%s] Visible only: %s
6374 \[%s] Export scope: %s [%s] Force publishing: %s
6376 (funcall fontify-key "C-b" t)
6377 (funcall fontify-value
6378 (if (memq 'body options) "On " "Off"))
6379 (funcall fontify-key "C-v" t)
6380 (funcall fontify-value
6381 (if (memq 'visible options) "On " "Off"))
6382 (funcall fontify-key "C-s" t)
6383 (funcall fontify-value
6384 (if (memq 'subtree options) "Subtree" "Buffer "))
6385 (funcall fontify-key "C-f" t)
6386 (funcall fontify-value
6387 (if (memq 'force options) "On " "Off"))
6388 (funcall fontify-key "C-a" t)
6389 (funcall fontify-value
6390 (if (memq 'async options) "On " "Off")))
6391 ;; Display registered back-end entries. When a key
6392 ;; appears for the second time, do not create another
6393 ;; entry, but append its sub-menu to existing menu.
6394 (let (last-key)
6395 (mapconcat
6396 (lambda (entry)
6397 (let ((top-key (car entry)))
6398 (concat
6399 (unless (eq top-key last-key)
6400 (setq last-key top-key)
6402 (funcall fontify-key (char-to-string top-key))
6403 (nth 1 entry)))
6404 (let ((sub-menu (nth 2 entry)))
6405 (unless (functionp sub-menu)
6406 ;; Split sub-menu into two columns.
6407 (let ((index -1))
6408 (concat
6409 (mapconcat
6410 (lambda (sub-entry)
6411 (cl-incf index)
6412 (format
6413 (if (zerop (mod index 2)) " [%s] %-26s"
6415 (funcall fontify-key
6416 (char-to-string (car sub-entry))
6417 top-key)
6418 (nth 1 sub-entry)))
6419 sub-menu "")
6421 entries ""))
6422 ;; Publishing menu is hard-coded.
6424 [%s] Current file [%s] Current project
6426 (funcall fontify-key "P")
6427 (funcall fontify-key "f" ?P)
6428 (funcall fontify-key "p" ?P)
6429 (funcall fontify-key "x" ?P)
6430 (funcall fontify-key "a" ?P))
6432 (funcall fontify-key "&" t)
6433 (funcall fontify-key "#" t))
6434 (format "[%s] %s"
6435 (funcall fontify-key "q" t)
6436 (if first-key "Main menu" "Exit")))))
6437 ;; Build prompts for both standard and expert UI.
6438 (standard-prompt (unless expertp "Export command: "))
6439 (expert-prompt
6440 (when expertp
6441 (format
6442 "Export command (C-%s%s%s%s%s) [%s]: "
6443 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6444 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6445 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6446 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6447 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6448 (mapconcat (lambda (k)
6449 ;; Strip control characters.
6450 (unless (< k 27) (char-to-string k)))
6451 allowed-keys "")))))
6452 ;; With expert UI, just read key with a fancy prompt. In standard
6453 ;; UI, display an intrusive help buffer.
6454 (if expertp
6455 (org-export--dispatch-action
6456 expert-prompt allowed-keys entries options first-key expertp)
6457 ;; At first call, create frame layout in order to display menu.
6458 (unless (get-buffer "*Org Export Dispatcher*")
6459 (delete-other-windows)
6460 (org-switch-to-buffer-other-window
6461 (get-buffer-create "*Org Export Dispatcher*"))
6462 (setq cursor-type nil
6463 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6464 ;; Make sure that invisible cursor will not highlight square
6465 ;; brackets.
6466 (set-syntax-table (copy-syntax-table))
6467 (modify-syntax-entry ?\[ "w"))
6468 ;; At this point, the buffer containing the menu exists and is
6469 ;; visible in the current window. So, refresh it.
6470 (with-current-buffer "*Org Export Dispatcher*"
6471 ;; Refresh help. Maintain display continuity by re-visiting
6472 ;; previous window position.
6473 (let ((pos (window-start)))
6474 (erase-buffer)
6475 (insert help)
6476 (set-window-start nil pos)))
6477 (org-fit-window-to-buffer)
6478 (org-export--dispatch-action
6479 standard-prompt allowed-keys entries options first-key expertp))))
6481 (defun org-export--dispatch-action
6482 (prompt allowed-keys entries options first-key expertp)
6483 "Read a character from command input and act accordingly.
6485 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6486 a list of characters available at a given step in the process.
6487 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6488 EXPERTP are the same as defined in `org-export--dispatch-ui',
6489 which see.
6491 Toggle export options when required. Otherwise, return value is
6492 a list with action as CAR and a list of interactive export
6493 options as CDR."
6494 (let (key)
6495 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6496 ;; C-p, SPC, DEL).
6497 (while (and (setq key (read-char-exclusive prompt))
6498 (not expertp)
6499 (memq key '(14 16 ?\s ?\d)))
6500 (cl-case key
6501 (14 (if (not (pos-visible-in-window-p (point-max)))
6502 (ignore-errors (scroll-up 1))
6503 (message "End of buffer")
6504 (sit-for 1)))
6505 (16 (if (not (pos-visible-in-window-p (point-min)))
6506 (ignore-errors (scroll-down 1))
6507 (message "Beginning of buffer")
6508 (sit-for 1)))
6509 (?\s (if (not (pos-visible-in-window-p (point-max)))
6510 (scroll-up nil)
6511 (message "End of buffer")
6512 (sit-for 1)))
6513 (?\d (if (not (pos-visible-in-window-p (point-min)))
6514 (scroll-down nil)
6515 (message "Beginning of buffer")
6516 (sit-for 1)))))
6517 (cond
6518 ;; Ignore undefined associations.
6519 ((not (memq key allowed-keys))
6520 (ding)
6521 (unless expertp (message "Invalid key") (sit-for 1))
6522 (org-export--dispatch-ui options first-key expertp))
6523 ;; q key at first level aborts export. At second level, cancel
6524 ;; first key instead.
6525 ((eq key ?q) (if (not first-key) (error "Export aborted")
6526 (org-export--dispatch-ui options nil expertp)))
6527 ;; Help key: Switch back to standard interface if expert UI was
6528 ;; active.
6529 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6530 ;; Send request for template insertion along with export scope.
6531 ((eq key ?#) (cons 'template (memq 'subtree options)))
6532 ;; Switch to asynchronous export stack.
6533 ((eq key ?&) '(stack))
6534 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6535 ((memq key '(2 22 19 6 1))
6536 (org-export--dispatch-ui
6537 (let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
6538 (6 'force) (1 'async))))
6539 (if (memq option options) (remq option options)
6540 (cons option options)))
6541 first-key expertp))
6542 ;; Action selected: Send key and options back to
6543 ;; `org-export-dispatch'.
6544 ((or first-key (functionp (nth 2 (assq key entries))))
6545 (cons (cond
6546 ((not first-key) (nth 2 (assq key entries)))
6547 ;; Publishing actions are hard-coded. Send a special
6548 ;; signal to `org-export-dispatch'.
6549 ((eq first-key ?P)
6550 (cl-case key
6551 (?f 'publish-current-file)
6552 (?p 'publish-current-project)
6553 (?x 'publish-choose-project)
6554 (?a 'publish-all)))
6555 ;; Return first action associated to FIRST-KEY + KEY
6556 ;; path. Indeed, derived backends can share the same
6557 ;; FIRST-KEY.
6558 (t (catch 'found
6559 (dolist (entry (member (assq first-key entries) entries))
6560 (let ((match (assq key (nth 2 entry))))
6561 (when match (throw 'found (nth 2 match))))))))
6562 options))
6563 ;; Otherwise, enter sub-menu.
6564 (t (org-export--dispatch-ui options key expertp)))))
6568 (provide 'ox)
6570 ;; Local variables:
6571 ;; generated-autoload-file: "org-loaddefs.el"
6572 ;; End:
6574 ;;; ox.el ends here