| blob | 9353f1d474aaef4c018ba0ab0ee08907dab446f4 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012, 2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; GNU Emacs is free software: you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
22 ;;
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
25 ;;
26 ;; Besides that parser, the generic exporter is made of three distinct
27 ;; parts:
28 ;;
29 ;; - The communication channel consists in a property list, which is
30 ;; created and updated during the process. Its use is to offer
31 ;; every piece of information, would it be about initial environment
32 ;; or contextual data, all in a single place. The exhaustive list
33 ;; of properties is given in "The Communication Channel" section of
34 ;; this file.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core function is `org-export-as'. It returns the transcoded
48 ;; buffer as a string.
49 ;;
50 ;; An export back-end is defined with `org-export-define-backend'.
51 ;; This function can also support specific buffer keywords, OPTION
52 ;; keyword's items and filters. Refer to function's documentation for
53 ;; more information.
54 ;;
55 ;; If the new back-end shares most properties with another one,
56 ;; `org-export-define-derived-backend' can be used to simplify the
57 ;; process.
58 ;;
59 ;; Any back-end can define its own variables. Among them, those
60 ;; customizable should belong to the `org-export-BACKEND' group.
61 ;;
62 ;; Tools for common tasks across back-ends are implemented in the
63 ;; following part of the file.
64 ;;
65 ;; Then, a wrapper macro for asynchronous export,
66 ;; `org-export-async-start', along with tools to display results. are
67 ;; given in the penultimate part.
68 ;;
69 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
70 ;; back-ends is provided in the last one.
72 ;;; Code:
91 \f
92 ;;; Internal Variables
93 ;;
94 ;; Among internal variables, the most important is
95 ;; `org-export-options-alist'. This variable define the global export
96 ;; options, shared between every exporter, and how they are acquired.
141 "Alist between export properties and ways to set them.
143 The CAR of the alist is the property name, and the CDR is a list
144 like (KEYWORD OPTION DEFAULT BEHAVIOUR) 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 BEHAVIOUR 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.
163 Values set through KEYWORD and OPTION have precedence over
164 DEFAULT.
166 All these properties should be back-end agnostic. Back-end
167 specific properties are set through `org-export-define-backend'.
171 "List of in-buffer keywords that require special treatment.
172 These keywords are not directly associated to a property. The
173 way they are handled must be hard-coded into
233 "Alist between filters properties and initial values.
235 The key of each association is a property name accessible through
236 the communication channel. Its value is a configurable global
237 variable defining initial filters.
239 This list is meant to install user specified filters. Back-end
240 developers may install their own filters using
241 `org-export-define-backend'. Filters defined there will always
242 be prepended to the current list, so they always get applied
251 "Default rule for link matching an inline image.
252 This rule applies to links with no description. By default, it
253 will be considered as an inline image if it targets a local file
256 See `org-export-inline-image-p' for more information about
260 "Non-nil means asynchronous export process should leave data behind.
264 located in `temporary-file-directory'.
266 When non-nil, it will also set `debug-on-error' to a non-nil
270 "Record asynchronously generated export results and processes.
271 This is an alist: its CAR is the source of the
272 result (destination file or buffer for a finished process,
273 original buffer for a running one) and its CDR is a list
274 containing the back-end used, as a symbol, and either a process
275 or the time at which it finished. It is used to build the menu
279 "List of backends currently available in the exporter.
280 This variable is set with `org-export-define-backend' and
284 "Last command called from the dispatcher.
285 The value should be a list. Its CAR is the action, as a symbol,
289 "The position where the last export command was created using the dispatcher.
290 This marker will be used with `C-u C-c C-e' to make sure export repetition
293 \f
294 ;;; User-configurable Variables
295 ;;
296 ;; Configuration for the masses.
297 ;;
298 ;; They should never be accessed directly, as their value is to be
299 ;; stored in a property list (cf. `org-export-options-alist').
300 ;; Back-ends will read their value from there instead.
303 "Options for exporting Org mode files."
308 "General options for export engine."
313 "Whether sub-trees with the ARCHIVE tag should be exported.
315 This can have three different values:
316 nil Do not export, pretend this tree is not present.
317 t Do export the entire tree.
318 `headline' Only export the headline, but skip the tree below it.
320 This option can also be set with the OPTIONS keyword,
329 "Non-nil means insert author name into the exported file.
330 This option can also be set with the OPTIONS keyword,
336 "Non-nil means export CLOCK keywords.
337 This option can also be set with the OPTIONS keyword,
343 "Non-nil means the postamble should contain a creator sentence.
345 The sentence can be set in `org-export-creator-string' and
348 If the value is `comment' insert it as a comment."
356 "Non-nil means insert date in the exported document.
357 This option can also be set with the OPTIONS keyword,
363 "Time-stamp format string to use for DATE keyword.
365 The format string, when specified, only applies if date consists
366 in a single time-stamp. Otherwise its value will be ignored.
368 See `format-time-string' for details on how to build this
369 string."
377 emacs-version
379 "Information about the creator of the document.
380 This option can also be set on with the CREATOR keyword."
385 "Non-nil means export contents of standard drawers.
387 When t, all drawers are exported. This may also be a list of
388 drawer names to export. If that list starts with `not', only
389 drawers with such names will be ignored.
391 This variable doesn't apply to properties drawers.
393 This option can also be set with the OPTIONS keyword,
406 :inline t
410 "Non-nil means insert author email into the exported file.
411 This option can also be set with the OPTIONS keyword,
417 "Non-nil means interpret *word*, /word/, _word_ and +word+.
419 If the export target supports emphasizing text, the word will be
420 typeset in bold, italic, with an underline or strike-through,
421 respectively.
423 This option can also be set with the OPTIONS keyword,
429 "Tags that exclude a tree from export.
431 All trees carrying any of these tags will be excluded from
432 export. This is without condition, so even subtrees inside that
433 carry one of the `org-export-select-tags' will be removed.
435 This option can also be set with the EXCLUDE_TAGS keyword."
442 This can be used to have pre-formatted text, fragments of code
443 etc. For example:
444 : ;; Some Lisp examples
445 : (while (defc cnt)
446 : (ding))
447 will be looking just like this in also HTML. See also the QUOTE
448 keyword. Not all export backends support this.
450 This option can also be set with the OPTIONS keyword,
456 "Non-nil means Org footnotes should be exported.
457 This option can also be set with the OPTIONS keyword,
463 "Non-nil means process LaTeX environments and fragments.
465 This option can also be set with the OPTIONS line,
468 nil Ignore math snippets.
469 `verbatim' Keep everything in verbatim.
470 t Allow export of math snippets."
480 "The last level which is still exported as a headline.
482 Inferior levels will usually produce itemize or enumerate lists
483 when exported, but back-end behaviour may differ.
485 This option can also be set with the OPTIONS keyword,
491 "The default language for export and clocktable translations, as a string.
492 This may have an association in
493 `org-clock-clocktable-language-setup',
494 `org-export-smart-quotes-alist' and `org-export-dictionary'.
495 This option can also be set with the LANGUAGE keyword."
500 "Non-nil means preserve all line breaks when exporting.
501 This option can also be set with the OPTIONS keyword,
507 "Non-nil means interpret entities when exporting.
510 Å.
512 For a list of supported names, see the constant `org-entities'
513 and the user option `org-entities-user'.
515 This option can also be set with the OPTIONS keyword,
521 "Non-nil means inlinetasks should be exported.
522 This option can also be set with the OPTIONS keyword,
530 "Non-nil means include planning info in export.
532 Planning info is the line containing either SCHEDULED:,
533 DEADLINE:, CLOSED: time-stamps, or a combination of them.
535 This option can also be set with the OPTIONS keyword,
543 "Non-nil means include priority cookies in export.
544 This option can also be set with the OPTIONS keyword,
550 "Non-nil means add section numbers to headlines when exporting.
552 When set to an integer n, numbering will only happen for
553 headlines whose relative level is higher or equal to n.
555 This option can also be set with the OPTIONS keyword,
561 "Tags that select a tree for export.
563 If any such tag is found in a buffer, all trees that do not carry
564 one of these tags will be ignored during export. Inside trees
565 that are selected like this, you can still deselect a subtree by
566 tagging it with one of the `org-export-exclude-tags'.
568 This option can also be set with the SELECT_TAGS keyword."
573 "Non-nil means activate smart quotes during export.
574 This option can also be set with the OPTIONS keyword,
577 When setting this to non-nil, you need to take care of
578 using the correct Babel package when exporting to LaTeX.
579 E.g., you can load Babel for french like this:
590 When this option is turned on, these strings will be exported as:
592 Org HTML LaTeX UTF-8
593 -----+----------+--------+-------
595 -- – -- –
596 --- — --- —
599 This option can also be set with the OPTIONS keyword,
605 "Non-nil means include statistics cookies in export.
606 This option can also be set with the OPTIONS keyword,
616 When this option is turned on, you can use TeX-like syntax for
618 will be considered as a single item - so grouping with {} is
619 normally not needed. For example, the following things will be
620 parsed as single sub- or superscripts.
622 10^24 or 10^tau several digits will be considered 1 item.
623 10^-12 or 10^-tau a leading sign with digits or a word
624 x^2-y^3 will be read as x^2 - y^3, because items are
625 terminated by almost any nonword/nondigit char.
626 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
628 Still, ambiguity is possible - so when in doubt use {} to enclose
629 the sub/superscript. If you set this variable to the symbol
630 `{}', the braces are *required* in order to trigger
631 interpretations as sub/superscript. This can be helpful in
634 This option can also be set with the OPTIONS keyword,
643 "Non-nil means create a table of contents in exported files.
645 The TOC contains headlines with levels up
646 to`org-export-headline-levels'. When an integer, include levels
647 up to N in the toc, this may then be different from
648 `org-export-headline-levels', but it will not be allowed to be
649 larger than the number of headline levels. When nil, no table of
650 contents is made.
652 This option can also be set with the OPTIONS keyword,
662 For example:
664 | Name | Address | Birthday |
665 |-------------+----------+-----------|
666 | Arthur Dent | England | 29.2.2100 |
668 This option can also be set with the OPTIONS keyword,
674 "If nil, do not export tags, just remove them from headlines.
676 If this is the symbol `not-in-toc', tags will be removed from
677 table of contents entries, but still be shown in the headlines of
678 the document.
680 This option can also be set with the OPTIONS keyword,
689 "Non-nil means include TODO items for export.
691 This may have the following values:
692 t include tasks independent of state.
693 `todo' include only tasks that are not yet done.
694 `done' include only tasks that are already done.
695 nil ignore all tasks.
696 list of keywords include tasks with these keywords.
698 This option can also be set with the OPTIONS keyword,
710 "Non-nil means insert a time stamp into the exported file.
711 The time stamp shows when the file was created. This option can
717 "Non nil means allow timestamps in export.
719 It can be set to any of the following values:
720 t export all timestamps.
721 `active' export active timestamps only.
722 `inactive' export inactive timestamps only.
723 nil do not export timestamps
725 This only applies to timestamps isolated in a paragraph
726 containing only timestamps. Other timestamps are always
727 exported.
729 This option can also be set with the OPTIONS keyword, e.g.
739 "Non-nil means include TODO keywords in export.
740 When nil, remove all these keywords from the export. This option
746 "Non-nil means BIND keywords can define local variable values.
747 This is a potential security risk, which is why the default value
748 is nil. You can also allow them through local buffer variables."
755 "Alist between export snippets back-ends and exporter back-ends.
757 This variable allows to provide shortcuts for export snippets.
761 HTML code while every other back-end will ignore it."
770 "Coding system for the exported file."
777 "Should we push exported content to the kill ring?"
786 "The initial scope when exporting with `org-export-dispatch'.
787 This variable can be either set to `buffer' or `subtree'."
794 "Non-nil means show buffer after exporting to temp buffer.
795 When Org exports to a file, the buffer visiting that file is ever
796 shown, but remains buried. However, when exporting to
797 a temporary buffer, that buffer is popped up in a second window.
798 When this variable is nil, the buffer remains buried also in
799 these cases."
804 "Non-nil means export and publishing commands will run in background.
805 Results from an asynchronous export are never displayed
813 "File used to initialize external export process.
814 Value must be an absolute file name. It defaults to user's
815 initialization file. Though, a specific configuration makes the
816 process faster and the export more portable."
823 "Non-nil means using a non-intrusive `org-export-dispatch'.
824 In that case, no help buffer is displayed. Though, an indicator
830 asynchronous). Also, \[?] allows to switch back to standard
831 mode."
838 \f
839 ;;; Defining Back-ends
840 ;;
841 ;; An export back-end is a structure with `org-export-backend' type
842 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
843 ;; and `menu' slots.
844 ;;
845 ;; At the lowest level, a back-end is created with
846 ;; `org-export-create-backend' function.
847 ;;
848 ;; A named back-end can be registered with
849 ;; `org-export-register-backend' function. A registered back-end can
850 ;; later be referred to by its name, with `org-export-get-backend'
851 ;; function. Also, such a back-end can become the parent of a derived
852 ;; back-end from which slot values will be inherited by default.
853 ;; `org-export-derived-backend-p' can check if a given back-end is
854 ;; derived from a list of back-end names.
855 ;;
856 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
857 ;; `org-export-get-all-filters' return the full alist of transcoders,
858 ;; options and filters, including those inherited from ancestors.
859 ;;
860 ;; At a higher level, `org-export-define-backend' is the standard way
861 ;; to define an export back-end. If the new back-end is similar to
862 ;; a registered back-end, `org-export-define-derived-backend' may be
863 ;; used instead.
864 ;;
865 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
866 ;; when a given back-end hasn't been registered yet.
870 name parent transcoders options filters blocks menu)
873 "Return export back-end named after NAME.
874 NAME is a symbol. Return nil if no such back-end is found."
881 "Register BACKEND as a known export back-end.
882 BACKEND is a structure with `org-export-backend' type."
883 ;; Refuse to register an unnamed back-end.
886 ;; Refuse to register a back-end with an unknown parent.
890 ;; Register dedicated export blocks in the parser.
894 ;; If a back-end with the same name as BACKEND is already
895 ;; registered, replace it with BACKEND. Otherwise, simply add
896 ;; BACKEND to the list of registered back-ends.
902 "Signal an error if BACKEND isn't defined."
907 "Non-nil if BACKEND is derived from one of BACKENDS.
908 BACKEND is an export back-end, as returned by, e.g.,
909 `org-export-create-backend', or a symbol referring to
910 a registered back-end. BACKENDS is constituted of symbols."
922 "Return full translation table for BACKEND.
924 BACKEND is an export back-end, as return by, e.g,,
925 `org-export-create-backend'. Return value is an alist where
926 keys are element or object types, as symbols, and values are
927 transcoders.
929 Unlike to `org-export-backend-transcoders', this function
930 also returns transcoders inherited from parent back-ends,
931 if any."
935 parent)
940 transcoders)))
943 "Return export options for BACKEND.
945 BACKEND is an export back-end, as return by, e.g,,
946 `org-export-create-backend'. See `org-export-options-alist'
947 for the shape of the return value.
949 Unlike to `org-export-backend-options', this function also
950 returns options inherited from parent back-ends, if any."
954 parent)
958 options)))
961 "Return complete list of filters for BACKEND.
963 BACKEND is an export back-end, as return by, e.g,,
964 `org-export-create-backend'. Return value is an alist where
965 keys are symbols and values lists of functions.
967 Unlike to `org-export-backend-filters', this function also
968 returns filters inherited from parent back-ends, if any."
972 parent)
976 filters)))
979 "Define a new back-end BACKEND.
981 TRANSCODERS is an alist between object or element types and
982 functions handling them.
984 These functions should return a string without any trailing
985 space, or nil. They must accept three arguments: the object or
986 element itself, its contents or nil when it isn't recursive and
987 the property list used as a communication channel.
989 Contents, when not nil, are stripped from any global indentation
990 \(although the relative one is preserved). They also always end
991 with a single newline character.
993 If, for a given type, no function is found, that element or
994 object type will simply be ignored, along with any blank line or
995 white space at its end. The same will happen if the function
996 returns the nil value. If that function returns the empty
997 string, the type will be ignored, but the blank lines or white
998 spaces will be kept.
1000 In addition to element and object types, one function can be
1001 associated to the `template' (or `inner-template') symbol and
1002 another one to the `plain-text' symbol.
1004 The former returns the final transcoded string, and can be used
1005 to add a preamble and a postamble to document's body. It must
1006 accept two arguments: the transcoded string and the property list
1007 containing export options. A function associated to `template'
1009 A function associated to `inner-template' is always applied.
1011 The latter, when defined, is to be called on every text not
1012 recognized as an element or an object. It must accept two
1013 arguments: the text string and the information channel. It is an
1014 appropriate place to protect special chars relative to the
1015 back-end.
1017 BODY can start with pre-defined keyword arguments. The following
1018 keywords are understood:
1020 :export-block
1022 String, or list of strings, representing block names that
1023 will not be parsed. This is used to specify blocks that will
1024 contain raw code specific to the back-end. These blocks
1025 still have to be handled by the relative `export-block' type
1026 translator.
1028 :filters-alist
1030 Alist between filters and function, or list of functions,
1031 specific to the back-end. See `org-export-filters-alist' for
1032 a list of all allowed filters. Filters defined here
1033 shouldn't make a back-end test, as it may prevent back-ends
1034 derived from this one to behave properly.
1036 :menu-entry
1038 Menu entry for the export dispatcher. It should be a list
1039 like:
1041 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1043 where :
1045 KEY is a free character selecting the back-end.
1047 DESCRIPTION-OR-ORDINAL is either a string or a number.
1049 If it is a string, is will be used to name the back-end in
1050 its menu entry. If it is a number, the following menu will
1051 be displayed as a sub-menu of the back-end with the same
1052 KEY. Also, the number will be used to determine in which
1053 order such sub-menus will appear (lowest first).
1055 ACTION-OR-MENU is either a function or an alist.
1057 If it is an action, it will be called with four
1058 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1059 BODY-ONLY. See `org-export-as' for further explanations on
1060 some of them.
1062 If it is an alist, associations should follow the
1063 pattern:
1065 '(KEY DESCRIPTION ACTION)
1067 where KEY, DESCRIPTION and ACTION are described above.
1069 Valid values include:
1073 or
1078 \(lambda (a s v b)
1079 \(if a (org-latex-export-to-pdf t s v b)
1080 \(org-open-file
1081 \(org-latex-export-to-pdf nil s v b)))))))
1083 or the following, which will be added to the previous
1084 sub-menu,
1086 '(?l 1
1090 :options-alist
1092 Alist between back-end specific properties introduced in
1093 communication channel and how their value are acquired. See
1094 `org-export-options-alist' for more information about
1095 structure of the values."
1109 :transcoders transcoders
1110 :options options
1111 :filters filters
1112 :blocks blocks
1116 "Create a new back-end as a variant of an existing one.
1118 CHILD is the name of the derived back-end. PARENT is the name of
1119 the parent back-end.
1121 BODY can start with pre-defined keyword arguments. The following
1122 keywords are understood:
1124 :export-block
1126 String, or list of strings, representing block names that
1127 will not be parsed. This is used to specify blocks that will
1128 contain raw code specific to the back-end. These blocks
1129 still have to be handled by the relative `export-block' type
1130 translator.
1132 :filters-alist
1134 Alist of filters that will overwrite or complete filters
1135 defined in PARENT back-end. See `org-export-filters-alist'
1136 for a list of allowed filters.
1138 :menu-entry
1140 Menu entry for the export dispatcher. See
1141 `org-export-define-backend' for more information about the
1142 expected value.
1144 :options-alist
1146 Alist of back-end specific properties that will overwrite or
1147 complete those defined in PARENT back-end. Refer to
1148 `org-export-options-alist' for more information about
1149 structure of the values.
1151 :translate-alist
1153 Alist of element and object types and transcoders that will
1154 overwrite or complete transcode table from PARENT back-end.
1155 Refer to `org-export-define-backend' for detailed information
1156 about transcoders.
1159 as a variant of `latex' back-end with a custom template function:
1161 \(org-export-define-derived-backend 'my-latex 'latex
1162 :translate-alist '((template . my-latex-template-fun)))
1164 The back-end could then be called with, for example:
1181 :parent parent
1182 :transcoders transcoders
1183 :options options
1184 :filters filters
1185 :blocks blocks
1189 \f
1190 ;;; The Communication Channel
1191 ;;
1192 ;; During export process, every function has access to a number of
1193 ;; properties. They are of two types:
1194 ;;
1195 ;; 1. Environment options are collected once at the very beginning of
1196 ;; the process, out of the original buffer and configuration.
1197 ;; Collecting them is handled by `org-export-get-environment'
1198 ;; function.
1199 ;;
1200 ;; Most environment options are defined through the
1201 ;; `org-export-options-alist' variable.
1202 ;;
1203 ;; 2. Tree properties are extracted directly from the parsed tree,
1204 ;; just before export, by `org-export-collect-tree-properties'.
1205 ;;
1206 ;; Here is the full list of properties available during transcode
1207 ;; process, with their category and their value type.
1208 ;;
1209 ;; + `:author' :: Author's name.
1210 ;; - category :: option
1211 ;; - type :: string
1212 ;;
1213 ;; + `:back-end' :: Current back-end used for transcoding.
1214 ;; - category :: tree
1215 ;; - type :: symbol
1216 ;;
1217 ;; + `:creator' :: String to write as creation information.
1218 ;; - category :: option
1219 ;; - type :: string
1220 ;;
1221 ;; + `:date' :: String to use as date.
1222 ;; - category :: option
1223 ;; - type :: string
1224 ;;
1225 ;; + `:description' :: Description text for the current data.
1226 ;; - category :: option
1227 ;; - type :: string
1228 ;;
1229 ;; + `:email' :: Author's email.
1230 ;; - category :: option
1231 ;; - type :: string
1232 ;;
1233 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1234 ;; process.
1235 ;; - category :: option
1236 ;; - type :: list of strings
1237 ;;
1238 ;; + `:export-options' :: List of export options available for current
1239 ;; process.
1240 ;; - category :: none
1241 ;; - type :: list of symbols, among `subtree', `body-only' and
1242 ;; `visible-only'.
1243 ;;
1244 ;; + `:exported-data' :: Hash table used for memoizing
1245 ;; `org-export-data'.
1246 ;; - category :: tree
1247 ;; - type :: hash table
1248 ;;
1249 ;; + `:filetags' :: List of global tags for buffer. Used by
1250 ;; `org-export-get-tags' to get tags with inheritance.
1251 ;; - category :: option
1252 ;; - type :: list of strings
1253 ;;
1254 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1255 ;; their definition, as parsed data. Only non-inlined footnotes
1256 ;; are represented in this alist. Also, every definition isn't
1257 ;; guaranteed to be referenced in the parse tree. The purpose of
1258 ;; this property is to preserve definitions from oblivion
1259 ;; (i.e. when the parse tree comes from a part of the original
1260 ;; buffer), it isn't meant for direct use in a back-end. To
1261 ;; retrieve a definition relative to a reference, use
1262 ;; `org-export-get-footnote-definition' instead.
1263 ;; - category :: option
1264 ;; - type :: alist (STRING . LIST)
1265 ;;
1266 ;; + `:headline-levels' :: Maximum level being exported as an
1267 ;; headline. Comparison is done with the relative level of
1268 ;; headlines in the parse tree, not necessarily with their
1269 ;; actual level.
1270 ;; - category :: option
1271 ;; - type :: integer
1272 ;;
1273 ;; + `:headline-offset' :: Difference between relative and real level
1274 ;; of headlines in the parse tree. For example, a value of -1
1275 ;; means a level 2 headline should be considered as level
1276 ;; 1 (cf. `org-export-get-relative-level').
1277 ;; - category :: tree
1278 ;; - type :: integer
1279 ;;
1280 ;; + `:headline-numbering' :: Alist between headlines and their
1281 ;; numbering, as a list of numbers
1282 ;; (cf. `org-export-get-headline-number').
1283 ;; - category :: tree
1284 ;; - type :: alist (INTEGER . LIST)
1285 ;;
1286 ;; + `:id-alist' :: Alist between ID strings and destination file's
1287 ;; path, relative to current directory. It is used by
1288 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1289 ;; external file.
1290 ;; - category :: option
1291 ;; - type :: alist (STRING . STRING)
1292 ;;
1293 ;; + `:ignore-list' :: List of elements and objects that should be
1294 ;; ignored during export.
1295 ;; - category :: tree
1296 ;; - type :: list of elements and objects
1297 ;;
1298 ;; + `:input-file' :: Full path to input file, if any.
1299 ;; - category :: option
1300 ;; - type :: string or nil
1301 ;;
1302 ;; + `:keywords' :: List of keywords attached to data.
1303 ;; - category :: option
1304 ;; - type :: string
1305 ;;
1306 ;; + `:language' :: Default language used for translations.
1307 ;; - category :: option
1308 ;; - type :: string
1309 ;;
1310 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1311 ;; transcoding.
1312 ;; - category :: option
1313 ;; - type :: list (as returned by `org-element-parse-buffer')
1314 ;;
1315 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1316 ;; all line breaks.
1317 ;; - category :: option
1318 ;; - type :: symbol (nil, t)
1319 ;;
1320 ;; + `:section-numbers' :: Non-nil means transcoding should add
1321 ;; section numbers to headlines.
1322 ;; - category :: option
1323 ;; - type :: symbol (nil, t)
1324 ;;
1325 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1326 ;; in transcoding. When such a tag is present, subtrees without
1327 ;; it are de facto excluded from the process. See
1328 ;; `use-select-tags'.
1329 ;; - category :: option
1330 ;; - type :: list of strings
1331 ;;
1332 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1333 ;; a time stamp in the output.
1334 ;; - category :: option
1335 ;; - type :: symbol (nil, t)
1336 ;;
1337 ;; + `:translate-alist' :: Alist between element and object types and
1338 ;; transcoding functions relative to the current back-end.
1339 ;; Special keys `inner-template', `template' and `plain-text' are
1340 ;; also possible.
1341 ;; - category :: option
1342 ;; - type :: alist (SYMBOL . FUNCTION)
1343 ;;
1344 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1345 ;; also be transcoded. If it is set to the `headline' symbol,
1346 ;; only the archived headline's name is retained.
1347 ;; - category :: option
1348 ;; - type :: symbol (nil, t, `headline')
1349 ;;
1350 ;; + `:with-author' :: Non-nil means author's name should be included
1351 ;; in the output.
1352 ;; - category :: option
1353 ;; - type :: symbol (nil, t)
1354 ;;
1355 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1356 ;; - category :: option
1357 ;; - type :: symbol (nil, t)
1358 ;;
1359 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1360 ;; inserted at the end of the transcoded string. If the value
1361 ;; is `comment', it should be commented.
1362 ;; - category :: option
1363 ;; - type :: symbol (`comment', nil, t)
1364 ;;
1365 ;; + `:with-date' :: Non-nil means output should contain a date.
1366 ;; - category :: option
1367 ;; - type :. symbol (nil, t)
1368 ;;
1369 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1370 ;; its value is a list of names, only drawers with such names
1371 ;; will be transcoded. If that list starts with `not', drawer
1372 ;; with these names will be skipped.
1373 ;; - category :: option
1374 ;; - type :: symbol (nil, t) or list of strings
1375 ;;
1376 ;; + `:with-email' :: Non-nil means output should contain author's
1377 ;; email.
1378 ;; - category :: option
1379 ;; - type :: symbol (nil, t)
1380 ;;
1381 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1382 ;; interpreted.
1383 ;; - category :: option
1384 ;; - type :: symbol (nil, t)
1385 ;;
1386 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1387 ;; strings starting with a colon as a fixed-with (verbatim) area.
1388 ;; - category :: option
1389 ;; - type :: symbol (nil, t)
1390 ;;
1391 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1392 ;; footnotes.
1393 ;; - category :: option
1394 ;; - type :: symbol (nil, t)
1395 ;;
1396 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1397 ;; `latex-fragment' objects should appear in export output. When
1398 ;; this property is set to `verbatim', they will be left as-is.
1399 ;; - category :: option
1400 ;; - type :: symbol (`verbatim', nil, t)
1401 ;;
1402 ;; + `:with-planning' :: Non-nil means transcoding should include
1403 ;; planning info.
1404 ;; - category :: option
1405 ;; - type :: symbol (nil, t)
1406 ;;
1407 ;; + `:with-priority' :: Non-nil means transcoding should include
1408 ;; priority cookies.
1409 ;; - category :: option
1410 ;; - type :: symbol (nil, t)
1411 ;;
1412 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1413 ;; plain text.
1414 ;; - category :: option
1415 ;; - type :: symbol (nil, t)
1416 ;;
1417 ;; + `:with-special-strings' :: Non-nil means transcoding should
1418 ;; interpret special strings in plain text.
1419 ;; - category :: option
1420 ;; - type :: symbol (nil, t)
1421 ;;
1422 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1423 ;; interpret subscript and superscript. With a value of "{}",
1424 ;; only interpret those using curly brackets.
1425 ;; - category :: option
1426 ;; - type :: symbol (nil, {}, t)
1427 ;;
1428 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1429 ;; tables.
1430 ;; - category :: option
1431 ;; - type :: symbol (nil, t)
1432 ;;
1433 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1434 ;; headlines. A `not-in-toc' value will remove them from the
1435 ;; table of contents, if any, nonetheless.
1436 ;; - category :: option
1437 ;; - type :: symbol (nil, t, `not-in-toc')
1438 ;;
1439 ;; + `:with-tasks' :: Non-nil means transcoding should include
1440 ;; headlines with a TODO keyword. A `todo' value will only
1441 ;; include headlines with a todo type keyword while a `done'
1442 ;; value will do the contrary. If a list of strings is provided,
1443 ;; only tasks with keywords belonging to that list will be kept.
1444 ;; - category :: option
1445 ;; - type :: symbol (t, todo, done, nil) or list of strings
1446 ;;
1447 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1448 ;; time stamps. Special value `active' (resp. `inactive') ask to
1449 ;; export only active (resp. inactive) timestamps. Otherwise,
1450 ;; completely remove them.
1451 ;; - category :: option
1452 ;; - type :: symbol: (`active', `inactive', t, nil)
1453 ;;
1454 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1455 ;; added to the output. An integer value limits its depth.
1456 ;; - category :: option
1457 ;; - type :: symbol (nil, t or integer)
1458 ;;
1459 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1460 ;; include TODO keywords.
1461 ;; - category :: option
1462 ;; - type :: symbol (nil, t)
1465 ;;;; Environment Options
1466 ;;
1467 ;; Environment options encompass all parameters defined outside the
1468 ;; scope of the parsed data. They come from five sources, in
1469 ;; increasing precedence order:
1470 ;;
1471 ;; - Global variables,
1472 ;; - Buffer's attributes,
1473 ;; - Options keyword symbols,
1474 ;; - Buffer keywords,
1475 ;; - Subtree properties.
1476 ;;
1477 ;; The central internal function with regards to environment options
1478 ;; is `org-export-get-environment'. It updates global variables with
1479 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1480 ;; the different sources.
1481 ;;
1482 ;; The internal functions doing the retrieval are:
1483 ;; `org-export--get-global-options',
1484 ;; `org-export--get-buffer-attributes',
1485 ;; `org-export--parse-option-keyword',
1486 ;; `org-export--get-subtree-options' and
1487 ;; `org-export--get-inbuffer-options'
1488 ;;
1489 ;; Also, `org-export--list-bound-variables' collects bound variables
1490 ;; along with their value in order to set them as buffer local
1491 ;; variables later in the process.
1494 "Collect export options from the current buffer.
1496 Optional argument BACKEND is an export back-end, as returned by
1497 `org-export-create-backend'.
1499 When optional argument SUBTREEP is non-nil, assume the export is
1500 done against the current sub-tree.
1502 Third optional argument EXT-PLIST is a property list with
1503 external parameters overriding Org default settings, but still
1504 inferior to file-local settings."
1505 ;; First install #+BIND variables since these must be set before
1506 ;; global options are read.
1509 ;; Get and prioritize export options...
1511 ;; ... from global variables...
1513 ;; ... from an external property list...
1514 ext-plist
1515 ;; ... from in-buffer settings...
1517 ;; ... and from subtree, when appropriate.
1519 ;; Eventually add misc. properties.
1521 :back-end
1522 backend
1524 :footnote-definition-alist
1525 ;; Footnotes definitions must be collected in the original
1526 ;; buffer, as there's no insurance that they will still be in
1527 ;; the parse tree, due to possible narrowing.
1541 alist))))
1542 alist))
1543 :id-alist
1544 ;; Collect id references.
1555 alist))))
1558 "Parse an OPTIONS line and return values as a plist.
1559 Optional argument BACKEND is an export back-end, as returned by,
1560 e.g., `org-export-create-backend'. It specifies which back-end
1561 specific items to read, if any."
1563 ;; Priority is given to back-end specific options.
1565 org-export-options-alist))
1566 plist)
1575 options))
1577 property
1580 plist))
1583 "Get export options in subtree at point.
1584 Optional argument BACKEND is an export back-end, as returned by,
1585 e.g., `org-export-create-backend'. It specifies back-end used
1586 for export. Return options as a plist."
1587 ;; For each buffer keyword, create a headline property setting the
1588 ;; same property in communication channel. The name for the property
1589 ;; is the keyword with "EXPORT_" appended to it.
1592 ;; Make sure point is at a heading.
1594 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1595 ;; title as its fallback value.
1601 plist :title
1604 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1608 ;; Handle other keywords. TITLE keyword is excluded as it has
1609 ;; been handled already.
1617 ;; Export properties are not case-sensitive.
1624 plist
1625 property
1627 ;; Parse VALUE if required.
1631 ;; If BEHAVIOUR is `split' expected value is
1632 ;; a list of strings, not a string.
1635 ;; Look for both general keywords and back-end specific
1636 ;; options, with priority given to the latter.
1638 org-export-options-alist)))
1639 ;; Return value.
1640 plist)))
1643 "Return current buffer export options, as a plist.
1645 Optional argument BACKEND, when non-nil, is an export back-end,
1646 as returned by, e.g., `org-export-create-backend'. It specifies
1647 which back-end specific options should also be read in the
1648 process.
1650 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1652 get-options ; For byte-compiler.
1655 ;; Priority is given to back-end specific options.
1657 org-export-options-alist))
1660 org-export-special-keywords))))
1663 ;; Return all properties associated to KEYWORD.
1670 ;; Recursively read keywords in buffer. FILES is a list
1671 ;; of files read so far. PLIST is the current property
1672 ;; list obtained.
1681 ;; Options in `org-export-special-keywords'.
1685 ;; Avoid circular dependencies.
1695 plist
1700 plist
1706 ;; Options in `org-export-options-alist'.
1711 plist property
1712 ;; Handle value depending on specified
1713 ;; BEHAVIOUR.
1719 " "
1732 ;; Return final value.
1733 plist))))
1734 ;; Read options in the current buffer.
1736 ;; Parse keywords specified in `org-element-document-properties'
1737 ;; and return PLIST.
1748 "Return properties related to buffer attributes, as a plist."
1749 ;; Store full path of input file name, or nil. For internal use.
1754 "Return default title for current document, as a string.
1755 Title is extracted from associated file name, if any, or buffer's
1756 name."
1765 "Return global export options as a plist.
1766 Optional argument BACKEND, if non-nil, is an export back-end, as
1767 returned by, e.g., `org-export-create-backend'. It specifies
1768 which back-end specific export options should also be read in the
1769 process."
1771 ;; Priority is given to back-end specific options.
1773 org-export-options-alist)))
1779 plist
1780 prop
1781 ;; Eval default value provided. If keyword is
1782 ;; a member of `org-element-document-properties',
1783 ;; parse it as a secondary string before storing it.
1790 value)))))))))))
1793 "Return variables bound from BIND keywords in current buffer.
1794 Also look for BIND keywords in setup files. The return value is
1795 an alist where associations are (VARIABLE-NAME VALUE)."
1800 ;; Return an alist between variable names and their
1801 ;; value. FILES is a list of setup files names read so
1802 ;; far, used to avoid circular dependencies. ALIST is
1803 ;; the alist collected so far.
1814 ;; Enter setup file.
1824 alist))))))))))
1825 alist)))))
1826 ;; Return value in appropriate order of appearance.
1830 ;;;; Tree Properties
1831 ;;
1832 ;; Tree properties are information extracted from parse tree. They
1833 ;; are initialized at the beginning of the transcoding process by
1834 ;; `org-export-collect-tree-properties'.
1835 ;;
1836 ;; Dedicated functions focus on computing the value of specific tree
1837 ;; properties during initialization. Thus,
1838 ;; `org-export--populate-ignore-list' lists elements and objects that
1839 ;; should be skipped during export, `org-export--get-min-level' gets
1840 ;; the minimal exportable level, used as a basis to compute relative
1841 ;; level for headlines. Eventually
1842 ;; `org-export--collect-headline-numbering' builds an alist between
1843 ;; headlines and their numbering.
1846 "Extract tree properties from parse tree.
1848 DATA is the parse tree from which information is retrieved. INFO
1849 is a list holding export options.
1851 Following tree properties are set or updated:
1853 `:exported-data' Hash table used to memoize results from
1854 `org-export-data'.
1856 `:footnote-definition-alist' List of footnotes definitions in
1857 original buffer and current parse tree.
1859 `:headline-offset' Offset between true level of headlines and
1860 local level. An offset of -1 means a headline
1861 of level 2 should be considered as a level
1862 1 headline in the context.
1864 `:headline-numbering' Alist of all headlines as key an the
1865 associated numbering as value.
1867 `:ignore-list' List of elements that should be ignored during
1868 export.
1870 Return updated plist."
1871 ;; Install the parse tree in the communication channel, in order to
1872 ;; use `org-export-get-genealogy' and al.
1874 ;; Get the list of elements and objects to ignore, and put it into
1875 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1876 ;; been done during parse tree filtering.
1879 :ignore-list
1882 ;; Compute `:headline-offset' in order to be able to use
1883 ;; `org-export-get-relative-level'.
1886 :headline-offset
1888 ;; Update footnotes definitions list with definitions in parse tree.
1889 ;; This is required since buffer expansion might have modified
1890 ;; boundaries of footnote definitions contained in the parse tree.
1891 ;; This way, definitions in `footnote-definition-alist' are bound to
1892 ;; match those in the parse tree.
1898 defs)))
1900 ;; Properties order doesn't matter: get the rest of the tree
1901 ;; properties.
1905 info))
1908 "Return minimum exportable headline's level in DATA.
1909 DATA is parsed tree as returned by `org-element-parse-buffer'.
1910 OPTIONS is a plist holding export options."
1921 ;; If no headline was found, for the sake of consistency, set
1922 ;; minimum level to 1 nonetheless.
1926 "Return numbering of all exportable headlines in a parse tree.
1928 DATA is the parse tree. OPTIONS is the plist holding export
1929 options.
1931 Return an alist whose key is a headline and value is its
1932 associated numbering \(in the shape of a list of numbers\) or nil
1933 for a footnotes section."
1941 headline
1943 for idx from 0 to org-export-max-depth
1947 options)))
1950 "Return list of elements and objects to ignore during export.
1951 DATA is the parse tree to traverse. OPTIONS is the plist holding
1952 export options."
1954 walk-data
1955 ;; First find trees containing a select tag, if any.
1959 ;; Collect ignored elements or objects into IGNORE-LIST.
1965 ;; If headline is archived but tree below has
1966 ;; to be skipped, add it to ignore list.
1969 ;; Move into secondary string, if any.
1974 ;; Move into recursive objects/elements.
1976 ;; Main call.
1978 ;; Return value.
1979 ignore))
1982 "Return list of headlines and inlinetasks with a select tag in their tree.
1983 DATA is parsed data as returned by `org-element-parse-buffer'.
1984 INFO is a plist holding export options."
1986 walk-data ; For byte-compiler.
1996 ;; When a select tag is found, mark full
1997 ;; genealogy and every headline within the tree
1998 ;; as acceptable.
2001 genealogy
2004 selected-trees))
2005 ;; If at a headline, continue searching in tree,
2006 ;; recursively.
2016 selected-trees))
2019 "Non-nil when element or object BLOB should be skipped during export.
2020 OPTIONS is the plist holding export options. SELECTED, when
2021 non-nil, is a list of headlines or inlinetasks belonging to
2022 a tree with a select tag."
2029 ;; If `:with-drawers' value starts with `not', ignore
2030 ;; every drawer whose name belong to that list.
2031 ;; Otherwise, ignore drawers whose name isn't in that
2032 ;; list.
2048 ;; Ignore subtrees with an exclude tag.
2051 ;; When a select tag is present in the buffer, ignore any tree
2052 ;; without it.
2054 ;; Ignore commented sub-trees.
2056 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2058 ;; Ignore tasks, if specified by `:with-tasks' property.
2073 ;; `:with-timestamps' only applies to isolated timestamps
2074 ;; objects, i.e. timestamp objects in a paragraph containing only
2075 ;; timestamps and whitespaces.
2083 options t))))
2092 \f
2093 ;;; The Transcoder
2094 ;;
2095 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2096 ;; `org-element-parse-buffer') and transcodes it into a specified
2097 ;; back-end output. It takes care of filtering out elements or
2098 ;; objects according to export options and organizing the output blank
2099 ;; lines and white space are preserved. The function memoizes its
2100 ;; results, so it is cheap to call it within transcoders.
2101 ;;
2102 ;; It is possible to modify locally the back-end used by
2103 ;; `org-export-data' or even use a temporary back-end by using
2104 ;; `org-export-data-with-backend'.
2105 ;;
2106 ;; Internally, three functions handle the filtering of objects and
2107 ;; elements during the export. In particular,
2108 ;; `org-export-ignore-element' marks an element or object so future
2109 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2110 ;; elements or objects should be seen as real Org syntax and
2111 ;; `org-export-expand' transforms the others back into their original
2112 ;; shape
2113 ;;
2114 ;; `org-export-transcoder' is an accessor returning appropriate
2115 ;; translator function for a given element or object.
2118 "Return appropriate transcoder for BLOB.
2119 INFO is a plist containing export directives."
2121 ;; Return contents only for complete parse trees.
2127 "Convert DATA into current back-end format.
2129 DATA is a parse tree, an element or an object or a secondary
2130 string. INFO is a plist holding export options.
2132 Return transcoded string."
2138 ;; Ignored element/object.
2140 ;; Plain text.
2146 info))
2147 ;; Uninterpreted element/object: change it back to Org
2148 ;; syntax and export again resulting raw string.
2152 data
2156 info))
2157 ;; Secondary string.
2160 ;; Element/Object without contents or, as a special case,
2161 ;; headline with archive tag and archived trees restricted
2162 ;; to title only.
2170 ;; Export snippets never return a nil value so
2171 ;; that white spaces following them are never
2172 ;; ignored.
2174 ;; Element/Object with contents.
2187 ;; Elements directly containing objects
2188 ;; must have their indentation normalized
2189 ;; first.
2191 data
2192 ;; When normalizing contents of the first
2193 ;; paragraph in an item or a footnote
2194 ;; definition, ignore first line's
2195 ;; indentation: there is none and it
2196 ;; might be misleading.
2201 data)
2208 info))))))))
2209 ;; Final result will be memoized before being returned.
2211 data
2215 ;; Append the same white space between elements or objects as in
2216 ;; the original buffer, and call appropriate filters.
2227 info)))
2228 results)))
2232 "Convert DATA into BACKEND format.
2234 DATA is an element, an object, a secondary string or a string.
2235 BACKEND is a symbol. INFO is a plist used as a communication
2236 channel.
2238 Unlike to `org-export-with-backend', this function will
2239 recursively convert DATA using BACKEND translation table."
2242 data
2243 ;; Set-up a new communication channel with translations defined in
2244 ;; BACKEND as the translate table and a new hash table for
2245 ;; memoization.
2247 info
2249 ;; Size of the hash table is reduced since this function
2250 ;; will probably be used on short trees.
2254 "Non-nil if element or object BLOB should be interpreted during export.
2255 If nil, BLOB will appear as raw Org syntax. Check is done
2256 according to export options INFO, stored as a plist."
2258 ;; ... entities...
2260 ;; ... emphasis...
2263 ;; ... fixed-width areas.
2265 ;; ... LaTeX environments and fragments...
2269 ;; ... sub/superscripts...
2275 ;; ... tables...
2280 "Expand a parsed element or object to its original state.
2282 BLOB is either an element or an object. CONTENTS is its
2283 contents, as a string or nil.
2285 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2286 keywords before output."
2291 blob contents))))
2294 "Add ELEMENT to `:ignore-list' in INFO.
2296 Any element in `:ignore-list' will be skipped when using
2297 `org-element-map'. INFO is modified by side effects."
2301 \f
2302 ;;; The Filter System
2303 ;;
2304 ;; Filters allow end-users to tweak easily the transcoded output.
2305 ;; They are the functional counterpart of hooks, as every filter in
2306 ;; a set is applied to the return value of the previous one.
2307 ;;
2308 ;; Every set is back-end agnostic. Although, a filter is always
2309 ;; called, in addition to the string it applies to, with the back-end
2310 ;; used as argument, so it's easy for the end-user to add back-end
2311 ;; specific filters in the set. The communication channel, as
2312 ;; a plist, is required as the third argument.
2313 ;;
2314 ;; From the developer side, filters sets can be installed in the
2315 ;; process with the help of `org-export-define-backend', which
2316 ;; internally stores filters as an alist. Each association has a key
2317 ;; among the following symbols and a function or a list of functions
2318 ;; as value.
2319 ;;
2320 ;; - `:filter-options' applies to the property list containing export
2321 ;; options. Unlike to other filters, functions in this list accept
2322 ;; two arguments instead of three: the property list containing
2323 ;; export options and the back-end. Users can set its value through
2324 ;; `org-export-filter-options-functions' variable.
2325 ;;
2326 ;; - `:filter-parse-tree' applies directly to the complete parsed
2327 ;; tree. Users can set it through
2328 ;; `org-export-filter-parse-tree-functions' variable.
2329 ;;
2330 ;; - `:filter-final-output' applies to the final transcoded string.
2331 ;; Users can set it with `org-export-filter-final-output-functions'
2332 ;; variable
2333 ;;
2334 ;; - `:filter-plain-text' applies to any string not recognized as Org
2335 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2336 ;; configure it.
2337 ;;
2338 ;; - `:filter-TYPE' applies on the string returned after an element or
2339 ;; object of type TYPE has been transcoded. A user can modify
2340 ;; `org-export-filter-TYPE-functions'
2341 ;;
2342 ;; All filters sets are applied with
2343 ;; `org-export-filter-apply-functions' function. Filters in a set are
2344 ;; applied in a LIFO fashion. It allows developers to be sure that
2345 ;; their filters will be applied first.
2346 ;;
2347 ;; Filters properties are installed in communication channel with
2348 ;; `org-export-install-filters' function.
2349 ;;
2350 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2351 ;; `org-export-before-parsing-hook') are run at the beginning of the
2352 ;; export process and just before parsing to allow for heavy structure
2353 ;; modifications.
2356 ;;;; Hooks
2359 "Hook run at the beginning of the export process.
2361 This is run before include keywords and macros are expanded and
2362 Babel code blocks executed, on a copy of the original buffer
2363 being exported. Visibility and narrowing are preserved. Point
2364 is at the beginning of the buffer.
2366 Every function in this hook will be called with one argument: the
2370 "Hook run before parsing an export buffer.
2372 This is run after include keywords and macros have been expanded
2373 and Babel code blocks executed, on a copy of the original buffer
2374 being exported. Visibility and narrowing are preserved. Point
2375 is at the beginning of the buffer.
2377 Every function in this hook will be called with one argument: the
2381 ;;;; Special Filters
2384 "List of functions applied to the export options.
2385 Each filter is called with two arguments: the export options, as
2386 a plist, and the back-end, as a symbol. It must return
2390 "List of functions applied to the parsed tree.
2391 Each filter is called with three arguments: the parse tree, as
2392 returned by `org-element-parse-buffer', the back-end, as
2393 a symbol, and the communication channel, as a plist. It must
2397 "List of functions applied to plain text.
2398 Each filter is called with three arguments: a string which
2399 contains no Org syntax, the back-end, as a symbol, and the
2400 communication channel, as a plist. It must return a string or
2404 "List of functions applied to the transcoded string.
2405 Each filter is called with three arguments: the full transcoded
2406 string, the back-end, as a symbol, and the communication channel,
2407 as a plist. It must return a string that will be used as the
2411 ;;;; Elements Filters
2414 "List of functions applied to a transcoded babel-call.
2415 Each filter is called with three arguments: the transcoded data,
2416 as a string, the back-end, as a symbol, and the communication
2420 "List of functions applied to a transcoded center block.
2421 Each filter is called with three arguments: the transcoded data,
2422 as a string, the back-end, as a symbol, and the communication
2426 "List of functions applied to a transcoded clock.
2427 Each filter is called with three arguments: the transcoded data,
2428 as a string, the back-end, as a symbol, and the communication
2432 "List of functions applied to a transcoded comment.
2433 Each filter is called with three arguments: the transcoded data,
2434 as a string, the back-end, as a symbol, and the communication
2438 "List of functions applied to a transcoded comment-block.
2439 Each filter is called with three arguments: the transcoded data,
2440 as a string, the back-end, as a symbol, and the communication
2444 "List of functions applied to a transcoded diary-sexp.
2445 Each filter is called with three arguments: the transcoded data,
2446 as a string, the back-end, as a symbol, and the communication
2450 "List of functions applied to a transcoded drawer.
2451 Each filter is called with three arguments: the transcoded data,
2452 as a string, the back-end, as a symbol, and the communication
2456 "List of functions applied to a transcoded dynamic-block.
2457 Each filter is called with three arguments: the transcoded data,
2458 as a string, the back-end, as a symbol, and the communication
2462 "List of functions applied to a transcoded example-block.
2463 Each filter is called with three arguments: the transcoded data,
2464 as a string, the back-end, as a symbol, and the communication
2468 "List of functions applied to a transcoded export-block.
2469 Each filter is called with three arguments: the transcoded data,
2470 as a string, the back-end, as a symbol, and the communication
2474 "List of functions applied to a transcoded fixed-width.
2475 Each filter is called with three arguments: the transcoded data,
2476 as a string, the back-end, as a symbol, and the communication
2480 "List of functions applied to a transcoded footnote-definition.
2481 Each filter is called with three arguments: the transcoded data,
2482 as a string, the back-end, as a symbol, and the communication
2486 "List of functions applied to a transcoded headline.
2487 Each filter is called with three arguments: the transcoded data,
2488 as a string, the back-end, as a symbol, and the communication
2492 "List of functions applied to a transcoded horizontal-rule.
2493 Each filter is called with three arguments: the transcoded data,
2494 as a string, the back-end, as a symbol, and the communication
2498 "List of functions applied to a transcoded inlinetask.
2499 Each filter is called with three arguments: the transcoded data,
2500 as a string, the back-end, as a symbol, and the communication
2504 "List of functions applied to a transcoded item.
2505 Each filter is called with three arguments: the transcoded data,
2506 as a string, the back-end, as a symbol, and the communication
2510 "List of functions applied to a transcoded keyword.
2511 Each filter is called with three arguments: the transcoded data,
2512 as a string, the back-end, as a symbol, and the communication
2516 "List of functions applied to a transcoded latex-environment.
2517 Each filter is called with three arguments: the transcoded data,
2518 as a string, the back-end, as a symbol, and the communication
2522 "List of functions applied to a transcoded node-property.
2523 Each filter is called with three arguments: the transcoded data,
2524 as a string, the back-end, as a symbol, and the communication
2528 "List of functions applied to a transcoded paragraph.
2529 Each filter is called with three arguments: the transcoded data,
2530 as a string, the back-end, as a symbol, and the communication
2534 "List of functions applied to a transcoded plain-list.
2535 Each filter is called with three arguments: the transcoded data,
2536 as a string, the back-end, as a symbol, and the communication
2540 "List of functions applied to a transcoded planning.
2541 Each filter is called with three arguments: the transcoded data,
2542 as a string, the back-end, as a symbol, and the communication
2546 "List of functions applied to a transcoded property-drawer.
2547 Each filter is called with three arguments: the transcoded data,
2548 as a string, the back-end, as a symbol, and the communication
2552 "List of functions applied to a transcoded quote block.
2553 Each filter is called with three arguments: the transcoded quote
2554 data, as a string, the back-end, as a symbol, and the
2555 communication channel, as a plist. It must return a string or
2559 "List of functions applied to a transcoded quote-section.
2560 Each filter is called with three arguments: the transcoded data,
2561 as a string, the back-end, as a symbol, and the communication
2565 "List of functions applied to a transcoded section.
2566 Each filter is called with three arguments: the transcoded data,
2567 as a string, the back-end, as a symbol, and the communication
2571 "List of functions applied to a transcoded special block.
2572 Each filter is called with three arguments: the transcoded data,
2573 as a string, the back-end, as a symbol, and the communication
2577 "List of functions applied to a transcoded src-block.
2578 Each filter is called with three arguments: the transcoded data,
2579 as a string, the back-end, as a symbol, and the communication
2583 "List of functions applied to a transcoded table.
2584 Each filter is called with three arguments: the transcoded data,
2585 as a string, the back-end, as a symbol, and the communication
2589 "List of functions applied to a transcoded table-cell.
2590 Each filter is called with three arguments: the transcoded data,
2591 as a string, the back-end, as a symbol, and the communication
2595 "List of functions applied to a transcoded table-row.
2596 Each filter is called with three arguments: the transcoded data,
2597 as a string, the back-end, as a symbol, and the communication
2601 "List of functions applied to a transcoded verse block.
2602 Each filter is called with three arguments: the transcoded data,
2603 as a string, the back-end, as a symbol, and the communication
2607 ;;;; Objects Filters
2610 "List of functions applied to transcoded bold text.
2611 Each filter is called with three arguments: the transcoded data,
2612 as a string, the back-end, as a symbol, and the communication
2616 "List of functions applied to transcoded code text.
2617 Each filter is called with three arguments: the transcoded data,
2618 as a string, the back-end, as a symbol, and the communication
2622 "List of functions applied to a transcoded entity.
2623 Each filter is called with three arguments: the transcoded data,
2624 as a string, the back-end, as a symbol, and the communication
2628 "List of functions applied to a transcoded export-snippet.
2629 Each filter is called with three arguments: the transcoded data,
2630 as a string, the back-end, as a symbol, and the communication
2634 "List of functions applied to a transcoded footnote-reference.
2635 Each filter is called with three arguments: the transcoded data,
2636 as a string, the back-end, as a symbol, and the communication
2640 "List of functions applied to a transcoded inline-babel-call.
2641 Each filter is called with three arguments: the transcoded data,
2642 as a string, the back-end, as a symbol, and the communication
2646 "List of functions applied to a transcoded inline-src-block.
2647 Each filter is called with three arguments: the transcoded data,
2648 as a string, the back-end, as a symbol, and the communication
2652 "List of functions applied to transcoded italic text.
2653 Each filter is called with three arguments: the transcoded data,
2654 as a string, the back-end, as a symbol, and the communication
2658 "List of functions applied to a transcoded latex-fragment.
2659 Each filter is called with three arguments: the transcoded data,
2660 as a string, the back-end, as a symbol, and the communication
2664 "List of functions applied to a transcoded line-break.
2665 Each filter is called with three arguments: the transcoded data,
2666 as a string, the back-end, as a symbol, and the communication
2670 "List of functions applied to a transcoded link.
2671 Each filter is called with three arguments: the transcoded data,
2672 as a string, the back-end, as a symbol, and the communication
2676 "List of functions applied to a transcoded radio-target.
2677 Each filter is called with three arguments: the transcoded data,
2678 as a string, the back-end, as a symbol, and the communication
2682 "List of functions applied to a transcoded statistics-cookie.
2683 Each filter is called with three arguments: the transcoded data,
2684 as a string, the back-end, as a symbol, and the communication
2688 "List of functions applied to transcoded strike-through text.
2689 Each filter is called with three arguments: the transcoded data,
2690 as a string, the back-end, as a symbol, and the communication
2694 "List of functions applied to a transcoded subscript.
2695 Each filter is called with three arguments: the transcoded data,
2696 as a string, the back-end, as a symbol, and the communication
2700 "List of functions applied to a transcoded superscript.
2701 Each filter is called with three arguments: the transcoded data,
2702 as a string, the back-end, as a symbol, and the communication
2706 "List of functions applied to a transcoded target.
2707 Each filter is called with three arguments: the transcoded data,
2708 as a string, the back-end, as a symbol, and the communication
2712 "List of functions applied to a transcoded timestamp.
2713 Each filter is called with three arguments: the transcoded data,
2714 as a string, the back-end, as a symbol, and the communication
2718 "List of functions applied to transcoded underline text.
2719 Each filter is called with three arguments: the transcoded data,
2720 as a string, the back-end, as a symbol, and the communication
2724 "List of functions applied to transcoded verbatim text.
2725 Each filter is called with three arguments: the transcoded data,
2726 as a string, the back-end, as a symbol, and the communication
2730 ;;;; Filters Tools
2731 ;;
2732 ;; Internal function `org-export-install-filters' installs filters
2733 ;; hard-coded in back-ends (developer filters) and filters from global
2734 ;; variables (user filters) in the communication channel.
2735 ;;
2736 ;; Internal function `org-export-filter-apply-functions' takes care
2737 ;; about applying each filter in order to a given data. It ignores
2738 ;; filters returning a nil value but stops whenever a filter returns
2739 ;; an empty string.
2742 "Call every function in FILTERS.
2744 Functions are called with arguments VALUE, current export
2745 back-end's name and INFO. A function returning a nil value will
2746 be skipped. If it returns the empty string, the process ends and
2747 VALUE is ignored.
2749 Call is done in a LIFO fashion, to be sure that developer
2750 specified filters, if any, are called first."
2760 "Install filters properties in communication channel.
2761 INFO is a plist containing the current communication channel.
2762 Return the updated communication channel."
2764 ;; Install user-defined filters with `org-export-filters-alist'
2765 ;; and filters already in INFO (through ext-plist mechanism).
2772 ;; Filters in INFO will be called
2773 ;; before those user provided.
2776 default-value)))))
2777 org-export-filters-alist)
2778 ;; Prepend back-end specific filters to that list.
2780 ;; Single values get consed, lists are appended.
2785 plist key
2789 ;; Return new communication channel.
2793 \f
2794 ;;; Core functions
2795 ;;
2796 ;; This is the room for the main function, `org-export-as', along with
2797 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2798 ;; `org-export-string-as'. They differ either by the way they output
2799 ;; the resulting code (for the first two) or by the input type (for
2800 ;; the latter). `org-export--copy-to-kill-ring-p' determines if
2801 ;; output of these function should be added to kill ring.
2802 ;;
2803 ;; `org-export-output-file-name' is an auxiliary function meant to be
2804 ;; used with `org-export-to-file'. With a given extension, it tries
2805 ;; to provide a canonical file name to write export output to.
2806 ;;
2807 ;; Note that `org-export-as' doesn't really parse the current buffer,
2808 ;; but a copy of it (with the same buffer-local variables and
2809 ;; visibility), where macros and include keywords are expanded and
2810 ;; Babel blocks are executed, if appropriate.
2811 ;; `org-export-with-buffer-copy' macro prepares that copy.
2812 ;;
2813 ;; File inclusion is taken care of by
2814 ;; `org-export-expand-include-keyword' and
2815 ;; `org-export--prepare-file-contents'. Structure wise, including
2816 ;; a whole Org file in a buffer often makes little sense. For
2817 ;; example, if the file contains a headline and the include keyword
2818 ;; was within an item, the item should contain the headline. That's
2819 ;; why file inclusion should be done before any structure can be
2820 ;; associated to the file, that is before parsing.
2821 ;;
2822 ;; `org-export-insert-default-template' is a command to insert
2823 ;; a default template (or a back-end specific template) at point or in
2824 ;; current subtree.
2827 "Return a copy of the current buffer.
2828 The copy preserves Org buffer-local variables, visibility and
2829 narrowing."
2835 new-buf))
2838 "Apply BODY in a copy of the current buffer.
2839 The copy preserves local variables, visibility and contents of
2840 the original buffer. Point is at the beginning of the buffer
2841 when BODY is applied."
2850 ;; Kill copy without confirmation.
2856 "Generate a function duplicating BUFFER.
2858 The copy will preserve local variables, visibility, contents and
2859 narrowing of the original buffer. If a region was active in
2860 BUFFER, contents will be narrowed to that region instead.
2862 The resulting function can be evaled at a later time, from
2863 another buffer, effectively cloning the original buffer there.
2865 The function assumes BUFFER's major mode is `org-mode'."
2869 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2870 ;; already in BUFFER.
2872 ;; Copy specific buffer local variables and variables set
2873 ;; through BIND keywords.
2875 vars)
2883 buffer-file-name
2884 buffer-file-coding-system))
2888 ;; Skip unreadable values, as they cannot be
2889 ;; sent to external process.
2893 vars))))))
2894 ;; Whole buffer contents.
2899 ;; Narrowing.
2903 ;; Current position of point.
2905 ;; Overlays with invisible property.
2915 ov-set))))
2917 ov-set)))))
2919 ;;;###autoload
2922 "Transcode current Org buffer into BACKEND code.
2924 BACKEND is either an export back-end, as returned by, e.g.,
2925 `org-export-create-backend', or a symbol referring to
2926 a registered back-end.
2928 If narrowing is active in the current buffer, only transcode its
2929 narrowed part.
2931 If a region is active, transcode that region.
2933 When optional argument SUBTREEP is non-nil, transcode the
2934 sub-tree at point, extracting information from the headline
2935 properties first.
2937 When optional argument VISIBLE-ONLY is non-nil, don't export
2938 contents of hidden elements.
2940 When optional argument BODY-ONLY is non-nil, only return body
2941 code, without surrounding template.
2943 Optional argument EXT-PLIST, when provided, is a property list
2944 with external parameters overriding Org default settings, but
2945 still inferior to file-local settings.
2947 Return code as a string."
2952 ;; Narrow buffer to an appropriate region or subtree for
2953 ;; parsing. If parsing subtree, be sure to remove main headline
2954 ;; too.
2962 ;; Initialize communication channel with original buffer
2963 ;; attributes, unavailable in its copy.
2971 tree)
2972 ;; Store default title in `org-export--default-title' so that
2973 ;; `org-export-get-environment' can access it from buffer's
2974 ;; copy and then add it properly to communication channel.
2976 ;; Update communication channel and get parse tree. Buffer
2977 ;; isn't parsed directly. Instead, a temporary copy is
2978 ;; created, where include keywords, macros are expanded and
2979 ;; code blocks are evaluated.
2981 ;; Run first hook with current back-end's name as argument.
2985 ;; Update macro templates since #+INCLUDE keywords might have
2986 ;; added some new ones.
2990 ;; Update radio targets since keyword inclusion might have
2991 ;; added some more.
2993 ;; Run last hook with current back-end's name as argument.
2998 ;; Update communication channel with environment. Also
2999 ;; install user's and developer's filters.
3004 ;; Expand export-specific set of macros: {{{author}}},
3005 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3006 ;; once regular macros have been expanded, since document
3007 ;; keywords may contain one of them.
3013 ;; EMAIL is not a parsed keyword: store it as-is.
3017 ;; Call options filters and update export options. We do not
3018 ;; use `org-export-filter-apply-functions' here since the
3019 ;; arity of such filters is different.
3024 ;; Parse buffer and call parse-tree filter on it.
3029 ;; Now tree is complete, compute its properties and add them
3030 ;; to communication channel.
3034 ;; Eventually transcode TREE. Wrap the resulting string into
3035 ;; a template.
3044 ;; Remove all text properties since they cannot be
3045 ;; retrieved from an external process. Finally call
3046 ;; final-output filter and return result.
3052 info))))))))
3054 ;;;###autoload
3057 "Call `org-export-as' with output to a specified buffer.
3059 BACKEND is either an export back-end, as returned by, e.g.,
3060 `org-export-create-backend', or a symbol referring to
3061 a registered back-end.
3063 BUFFER is the output buffer. If it already exists, it will be
3064 erased first, otherwise, it will be created.
3066 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3067 EXT-PLIST are similar to those used in `org-export-as', which
3068 see.
3070 Depending on `org-export-copy-to-kill-ring', add buffer contents
3071 to kill ring. Return buffer."
3078 ;; Maybe add buffer contents to kill ring.
3081 ;; Return buffer.
3082 buffer))
3084 ;;;###autoload
3087 "Call `org-export-as' with output to a specified file.
3089 BACKEND is either an export back-end, as returned by, e.g.,
3090 `org-export-create-backend', or a symbol referring to
3091 a registered back-end. FILE is the name of the output file, as
3092 a string.
3094 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3095 EXT-PLIST are similar to those used in `org-export-as', which
3096 see.
3098 Depending on `org-export-copy-to-kill-ring', add file contents
3099 to kill ring. Return output file's name."
3100 ;; Checks for FILE permissions. `write-file' would do the same, but
3101 ;; we'd rather avoid needless transcoding of parse tree.
3103 ;; Insert contents to a temporary buffer and write it to FILE.
3109 ;; Maybe add file contents to kill ring.
3112 ;; Return full path.
3113 file)
3115 ;;;###autoload
3117 "Transcode STRING into BACKEND code.
3119 BACKEND is either an export back-end, as returned by, e.g.,
3120 `org-export-create-backend', or a symbol referring to
3121 a registered back-end.
3123 When optional argument BODY-ONLY is non-nil, only return body
3124 code, without preamble nor postamble.
3126 Optional argument EXT-PLIST, when provided, is a property list
3127 with external parameters overriding Org default settings, but
3128 still inferior to file-local settings.
3130 Return code as a string."
3136 ;;;###autoload
3138 "Replace the active region by its export to BACKEND.
3139 BACKEND is either an export back-end, as returned by, e.g.,
3140 `org-export-create-backend', or a symbol referring to
3141 a registered back-end."
3151 ;;;###autoload
3153 "Insert all export keywords with default values at beginning of line.
3155 BACKEND is a symbol referring to the name of a registered export
3156 back-end, for which specific export options should be added to
3157 the template, or `default' for default template. When it is nil,
3158 the user will be prompted for a category.
3160 If SUBTREEP is non-nil, export configuration will be set up
3161 locally for the subtree through node properties."
3171 "Options category: "
3175 org-export--registered-backends))))))
3176 options keywords)
3177 ;; Populate OPTIONS and KEYWORDS.
3194 ;; Move to an appropriate location in order to insert options.
3196 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3197 ;; list of available keywords.
3225 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3244 ;; And the rest of keywords.
3255 "Return output file's name according to buffer specifications.
3257 EXTENSION is a string representing the output file extension,
3258 with the leading dot.
3260 With a non-nil optional argument SUBTREEP, try to determine
3262 of subtree at point.
3264 When optional argument PUB-DIR is set, use it as the publishing
3265 directory.
3267 When optional argument VISIBLE-ONLY is non-nil, don't export
3268 contents of hidden elements.
3270 Return file name as a string."
3273 ;; File name may come from EXPORT_FILE_NAME subtree
3274 ;; property, assuming point is at beginning of said
3275 ;; sub-tree.
3282 ;; File name may be extracted from buffer's associated
3283 ;; file, if any.
3285 ;; Can't determine file name on our own: Ask user.
3289 "Output file: " pub-dir nil nil nil
3293 ;; Build file name. Enforce EXTENSION over whatever user
3294 ;; may have come up with. PUB-DIR, if defined, always has
3295 ;; precedence over any provided path.
3300 extension))
3303 ;; If writing to OUTPUT-FILE would overwrite original file, append
3304 ;; EXTENSION another time to final name.
3307 output-file)))
3310 "Expand every include keyword in buffer.
3311 Optional argument INCLUDED is a list of included file names along
3312 with their line restriction, when appropriate. It is used to
3313 avoid infinite recursion. Optional argument DIR is the current
3314 working directory. It is used to properly resolve relative
3315 paths."
3322 ;; Extract arguments from keyword's value.
3330 dir)
3335 value)
3341 ;; Minimal level of included file defaults to the child
3342 ;; level of the current headline, if any, or one. It
3343 ;; only applies is the file is meant to be included as
3344 ;; an Org one.
3352 ;; Remove keyword.
3358 ;; Check if files has already been parsed. Look after
3359 ;; inclusion lines too, as different parts of the same file
3360 ;; can be included too.
3372 ind-str contents ind-str))))
3380 ind-str env contents ind-str))))
3393 "Prepare the contents of FILE for inclusion and return them as a string.
3395 When optional argument LINES is a string specifying a range of
3396 lines, include only those lines.
3398 Optional argument IND, when non-nil, is an integer specifying the
3399 global indentation of returned contents. Since its purpose is to
3400 allow an included file to stay in the same environment it was
3401 created \(i.e. a list item), it doesn't apply past the first
3402 headline encountered.
3404 Optional argument MINLEVEL, when non-nil, is an integer
3405 specifying the level that any top-level headline in the included
3406 file should have."
3422 ;; Remove blank lines at beginning and end of contents. The logic
3423 ;; behind that removal is that blank lines around include keyword
3424 ;; override blank lines in included file.
3433 ;; If IND is set, preserve indentation of include keyword until
3434 ;; the first headline encountered.
3441 ;; Do not move footnote definitions out of column 0.
3447 ;; When MINLEVEL is specified, compute minimal level for headlines
3448 ;; in the file (CUR-MIN), and remove stars to each headline so
3449 ;; that headlines with minimal level have a level of MINLEVEL.
3460 ;; Only change stars, don't bother moving whole
3461 ;; sections.
3468 "Execute every Babel code in the visible part of current buffer."
3469 ;; Get a pristine copy of current buffer so Babel references can be
3470 ;; properly resolved.
3477 "Return a non-nil value when output should be added to the kill ring.
3478 See also `org-export-copy-to-kill-ring'."
3484 \f
3485 ;;; Tools For Back-Ends
3486 ;;
3487 ;; A whole set of tools is available to help build new exporters. Any
3488 ;; function general enough to have its use across many back-ends
3489 ;; should be added here.
3491 ;;;; For Affiliated Keywords
3492 ;;
3493 ;; `org-export-read-attribute' reads a property from a given element
3494 ;; as a plist. It can be used to normalize affiliated keywords'
3495 ;; syntax.
3496 ;;
3497 ;; Since captions can span over multiple lines and accept dual values,
3498 ;; their internal representation is a bit tricky. Therefore,
3499 ;; `org-export-get-caption' transparently returns a given element's
3500 ;; caption as a secondary string.
3503 "Turn ATTRIBUTE property from ELEMENT into a plist.
3505 When optional argument PROPERTY is non-nil, return the value of
3506 that property within attributes.
3510 properties.
3512 All values will become strings except the empty string and
3515 will become the empty string."
3529 s)
3534 ;; Ignore any string before first property with `cdr'.
3539 "Return caption from ELEMENT as a secondary string.
3541 When optional argument SHORTP is non-nil, return short caption,
3542 as a secondary string, instead.
3544 Caption lines are separated by a white space."
3552 ;;;; For Derived Back-ends
3553 ;;
3554 ;; `org-export-with-backend' is a function allowing to locally use
3555 ;; another back-end to transcode some object or element. In a derived
3556 ;; back-end, it may be used as a fall-back function once all specific
3557 ;; cases have been treated.
3560 "Call a transcoder from BACKEND on DATA.
3561 BACKEND is an export back-end, as returned by, e.g.,
3562 `org-export-create-backend', or a symbol referring to
3563 a registered back-end. DATA is an Org element, object, secondary
3564 string or string. CONTENTS, when non-nil, is the transcoded
3565 contents of DATA element, as a string. INFO, when non-nil, is
3566 the communication channel used for export, as a plist."
3577 ;;;; For Export Snippets
3578 ;;
3579 ;; Every export snippet is transmitted to the back-end. Though, the
3580 ;; latter will only retain one type of export-snippet, ignoring
3581 ;; others, based on the former's target back-end. The function
3582 ;; `org-export-snippet-backend' returns that back-end for a given
3583 ;; export-snippet.
3586 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3587 Translation, with `org-export-snippet-translation-alist', is
3588 applied."
3592 back-end))))
3595 ;;;; For Footnotes
3596 ;;
3597 ;; `org-export-collect-footnote-definitions' is a tool to list
3598 ;; actually used footnotes definitions in the whole parse tree, or in
3599 ;; a headline, in order to add footnote listings throughout the
3600 ;; transcoded data.
3601 ;;
3602 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3603 ;; back-ends, when they need to attach the footnote definition only to
3604 ;; the first occurrence of the corresponding label.
3605 ;;
3606 ;; `org-export-get-footnote-definition' and
3607 ;; `org-export-get-footnote-number' provide easier access to
3608 ;; additional information relative to a footnote reference.
3611 "Return an alist between footnote numbers, labels and definitions.
3613 DATA is the parse tree from which definitions are collected.
3614 INFO is the plist used as a communication channel.
3616 Definitions are sorted by order of references. They either
3617 appear as Org data or as a secondary string for inlined
3618 footnotes. Unreferenced definitions are ignored."
3620 collect-fn ; for byte-compiler.
3624 ;; Collect footnote number, label and definition in DATA.
3632 def)
3633 num-alist)
3634 ;; Also search in definition for nested footnotes.
3637 ;; Don't enter footnote definitions since it will happen
3638 ;; when their first reference is found.
3644 "Non-nil when a footnote reference is the first one for its label.
3646 FOOTNOTE-REFERENCE is the footnote reference being considered.
3647 INFO is the plist used as a communication channel."
3649 ;; Anonymous footnotes are always a first reference.
3651 ;; Otherwise, return the first footnote with the same LABEL and
3652 ;; test if it is equal to FOOTNOTE-REFERENCE.
3662 ;; If FN isn't inlined, be sure to traverse its
3663 ;; definition before resuming search. See
3664 ;; comments in `org-export-get-footnote-number'
3665 ;; for more information.
3669 ;; Don't enter footnote definitions since it will
3670 ;; happen when their first reference is found.
3673 footnote-reference)))))
3676 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3677 INFO is the plist used as a communication channel. If no such
3679 string."
3686 "Return number associated to a footnote.
3688 FOOTNOTE is either a footnote reference or a footnote definition.
3689 INFO is the plist used as a communication channel."
3691 seen-refs
3692 search-ref ; For byte-compiler.
3696 ;; Search footnote references through DATA, filling
3697 ;; SEEN-REFS along the way.
3702 ;; Anonymous footnote match: return number.
3705 ;; Labels match: return number.
3708 ;; Anonymous footnote: it's always a new one.
3709 ;; Also, be sure to return nil from the `cond' so
3710 ;; `first-match' doesn't get us out of the loop.
3712 ;; Label not seen so far: add it so SEEN-REFS.
3713 ;;
3714 ;; Also search for subsequent references in
3715 ;; footnote definition so numbering follows
3716 ;; reading logic. Note that we don't have to care
3717 ;; about inline definitions, since
3718 ;; `org-element-map' already traverses them at the
3719 ;; right time.
3720 ;;
3721 ;; Once again, return nil to stay in the loop.
3726 nil))))
3727 ;; Don't enter footnote definitions since it will
3728 ;; happen when their first reference is found.
3733 ;;;; For Headlines
3734 ;;
3735 ;; `org-export-get-relative-level' is a shortcut to get headline
3736 ;; level, relatively to the lower headline level in the parsed tree.
3737 ;;
3738 ;; `org-export-get-headline-number' returns the section number of an
3739 ;; headline, while `org-export-number-to-roman' allows to convert it
3740 ;; to roman numbers.
3741 ;;
3742 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3743 ;; `org-export-last-sibling-p' are three useful predicates when it
3744 ;; comes to fulfill the `:headline-levels' property.
3745 ;;
3746 ;; `org-export-get-tags', `org-export-get-category' and
3747 ;; `org-export-get-node-property' extract useful information from an
3748 ;; headline or a parent headline. They all handle inheritance.
3749 ;;
3750 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3751 ;; as a secondary string, suitable for table of contents. It falls
3752 ;; back onto default title.
3755 "Return HEADLINE relative level within current parsed tree.
3756 INFO is a plist holding contextual information."
3761 "Non-nil when HEADLINE is considered as low level.
3763 INFO is a plist used as a communication channel.
3765 A low level headlines has a relative level greater than
3766 `:headline-levels' property value.
3768 Return value is the difference between HEADLINE relative level
3769 and the last level being considered as high enough, or nil."
3776 "Return HEADLINE numbering as a list of numbers.
3777 INFO is a plist holding contextual information."
3781 "Return a non-nil value if HEADLINE element should be numbered.
3782 INFO is a plist used as a communication channel."
3788 "Convert integer N into a roman numeral."
3801 res)))
3804 "Return list of tags associated to ELEMENT.
3806 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3807 is a plist used as a communication channel.
3809 Select tags (see `org-export-select-tags') and exclude tags (see
3810 `org-export-exclude-tags') are removed from the list.
3812 When non-nil, optional argument TAGS should be a list of strings.
3813 Any tag belonging to this list will also be removed.
3815 When optional argument INHERITED is non-nil, tags can also be
3816 inherited from parent headlines and FILETAGS keywords."
3822 ;; Build complete list of inherited tags.
3833 ;; Add FILETAGS keywords and return results.
3837 "Return node PROPERTY value for BLOB.
3839 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3840 element or object.
3842 If optional argument INHERITED is non-nil, the value can be
3843 inherited from a parent headline.
3845 Return value is a string or nil."
3857 "Return category for element or object BLOB.
3859 INFO is a plist used as a communication channel.
3861 CATEGORY is automatically inherited from a parent headline, from
3862 #+CATEGORY: keyword or created out of original file name. If all
3866 ;; Almost like `org-export-node-property', but we cannot trust
3867 ;; `plist-member' as every headline has a `:CATEGORY'
3868 ;; property, would it be nil or equal to "???" (which has the
3869 ;; same meaning).
3887 "Return alternative title for HEADLINE, as a secondary string.
3888 INFO is a plist used as a communication channel. If no optional
3889 title is defined, fall-back to the regular title."
3894 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3895 INFO is a plist used as a communication channel."
3900 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3901 INFO is a plist used as a communication channel."
3905 ;;;; For Keywords
3906 ;;
3907 ;; `org-export-get-date' returns a date appropriate for the document
3908 ;; to about to be exported. In particular, it takes care of
3909 ;; `org-export-date-timestamp-format'.
3912 "Return date value for the current document.
3914 INFO is a plist used as a communication channel. FMT, when
3915 non-nil, is a time format string that will be applied on the date
3916 if it consists in a single timestamp object. It defaults to
3917 `org-export-date-timestamp-format' when nil.
3919 A proper date can be a secondary string, a string or nil. It is
3920 meant to be translated with `org-export-data' or alike."
3931 ;;;; For Links
3932 ;;
3933 ;; `org-export-solidify-link-text' turns a string into a safer version
3934 ;; for links, replacing most non-standard characters with hyphens.
3935 ;;
3936 ;; `org-export-get-coderef-format' returns an appropriate format
3937 ;; string for coderefs.
3938 ;;
3939 ;; `org-export-inline-image-p' returns a non-nil value when the link
3940 ;; provided should be considered as an inline image.
3941 ;;
3942 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3943 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3944 ;; returns an appropriate unique identifier when found, or nil.
3945 ;;
3946 ;; `org-export-resolve-id-link' returns the first headline with
3947 ;; specified id or custom-id in parse tree, the path to the external
3948 ;; file with the id or nil when neither was found.
3949 ;;
3950 ;; `org-export-resolve-coderef' associates a reference to a line
3951 ;; number in the element it belongs, or returns the reference itself
3952 ;; when the element isn't numbered.
3955 "Take link text S and make a safe target out of it."
3960 "Return format string for code reference link.
3961 PATH is the link path. DESC is its description."
3969 "Non-nil if LINK object points to an inline image.
3971 Optional argument is a set of RULES defining inline images. It
3972 is an alist where associations have the following shape:
3974 \(TYPE . REGEXP)
3976 Applying a rule means apply REGEXP against LINK's path when its
3977 type is TYPE. The function will return a non-nil value if any of
3978 the provided rules is non-nil. The default rule is
3979 `org-export-default-inline-image-rule'.
3981 This only applies to links without a description."
3992 rules)
3993 ;; Return nil if no rule matched.
3994 nil))))
3997 "Resolve a code reference REF.
3999 INFO is a plist used as a communication channel.
4001 Return associated line number in source code, or REF itself,
4002 depending on src-block or example element's switches."
4009 org-coderef-label-format)))
4013 ;; Element containing REF is found. Resolve it to either
4014 ;; a label or a line number, as needed.
4024 "Return LINK destination.
4026 INFO is a plist holding contextual information.
4028 Return value can be an object, an element, or nil:
4030 - If LINK path matches a target object (i.e. <<path>>) return it.
4032 - If LINK path exactly matches the name affiliated keyword
4033 \(i.e. #+NAME: path) of an element, return that element.
4035 - If LINK path exactly matches any headline name, return that
4036 element. If more than one headline share that name, priority
4037 will be given to the one with the closest common ancestor, if
4038 any, or the first one in the parse tree otherwise.
4040 - Otherwise, return nil.
4043 significant."
4046 ;; Split PATH at white spaces so matches are space
4047 ;; insensitive.
4050 ;; Cache for destinations that are not position dependent.
4058 ;; Destination is not position dependent: use cached value.
4060 ;; First try to find a matching "<<path>>" unless user specified
4061 ;; he was looking for a headline (path starts with a "*"
4062 ;; character).
4068 path)
4069 blob))
4072 ;; Then try to find an element with a matching "#+NAME: path"
4073 ;; affiliated keyword.
4076 org-element-all-elements
4081 el)))
4084 ;; Last case: link either points to a headline or to nothingness.
4085 ;; Try to find the source, with priority given to headlines with
4086 ;; the closest common ancestor. If such candidate is found,
4087 ;; return it, otherwise return nil.
4091 ;; Return first headline whose `:raw-value' property is
4092 ;; NAME in parse tree DATA, or nil. Statistics cookies
4093 ;; are ignored.
4101 name)
4102 headline))
4104 ;; Search among headlines sharing an ancestor with link, from
4105 ;; closest to farthest.
4114 ;; No destination found: return nil.
4118 "Return headline referenced as LINK destination.
4120 INFO is a plist used as a communication channel.
4122 Return value can be the headline element matched in current parse
4126 ;; First check if id is within the current parse tree.
4131 headline))
4133 ;; Otherwise, look for external files.
4137 "Return radio-target object referenced as LINK destination.
4139 INFO is a plist used as a communication channel.
4141 Return value can be a radio-target object or nil. Assume LINK
4150 nil nil path nil nil t)
4151 t)
4152 radio))
4156 ;;;; For References
4157 ;;
4158 ;; `org-export-get-ordinal' associates a sequence number to any object
4159 ;; or element.
4162 "Return ordinal number of an element or object.
4164 ELEMENT is the element or object considered. INFO is the plist
4165 used as a communication channel.
4167 Optional argument TYPES, when non-nil, is a list of element or
4168 object types, as symbols, that should also be counted in.
4169 Otherwise, only provided element's type is considered.
4171 Optional argument PREDICATE is a function returning a non-nil
4172 value if the current element or object should be counted in. It
4173 accepts two arguments: the element or object being considered and
4174 the plist used as a communication channel. This allows to count
4175 only a certain type of objects (i.e. inline images).
4177 Return value is a list of numbers if ELEMENT is a headline or an
4178 item. It is nil for keywords. It represents the footnote number
4179 for footnote definitions and footnote references. If ELEMENT is
4180 a target, return the same value as if ELEMENT was the closest
4181 table, item or headline containing the target. In any other
4182 case, return the sequence number of ELEMENT among elements or
4183 objects of the same type."
4184 ;; Ordinal of a target object refer to the ordinal of the closest
4185 ;; table, item, or headline containing the object.
4189 when
4193 table))
4194 return parent)))
4196 ;; Special case 1: A headline returns its number as a list.
4198 ;; Special case 2: An item returns its number as a list.
4202 struct
4209 ;; Increment counter until ELEMENT is found again.
4220 ;;;; For Src-Blocks
4221 ;;
4222 ;; `org-export-get-loc' counts number of code lines accumulated in
4223 ;; src-block or example-block elements with a "+n" switch until
4224 ;; a given element, excluded. Note: "-n" switches reset that count.
4225 ;;
4226 ;; `org-export-unravel-code' extracts source code (along with a code
4227 ;; references alist) from an `element-block' or `src-block' type
4228 ;; element.
4229 ;;
4230 ;; `org-export-format-code' applies a formatting function to each line
4231 ;; of code, providing relative line number and code reference when
4232 ;; appropriate. Since it doesn't access the original element from
4233 ;; which the source code is coming, it expects from the code calling
4234 ;; it to know if lines should be numbered and if code references
4235 ;; should appear.
4236 ;;
4237 ;; Eventually, `org-export-format-code-default' is a higher-level
4238 ;; function (it makes use of the two previous functions) which handles
4239 ;; line numbering and code references inclusion, and returns source
4240 ;; code in a format suitable for plain text or verbatim output.
4243 "Return accumulated lines of code up to ELEMENT.
4245 INFO is the plist used as a communication channel.
4247 ELEMENT is excluded from count."
4253 ;; ELEMENT is reached: Quit the loop.
4255 ;; Only count lines from src-block and example-block elements
4256 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4260 ;; Accumulate locs or reset them.
4264 ;; Return nil to stay in the loop.
4265 nil)))
4267 ;; Return value.
4268 loc))
4271 "Clean source code and extract references out of it.
4273 ELEMENT has either a `src-block' an `example-block' type.
4275 Return a cons cell whose CAR is the source code, cleaned from any
4276 reference and protective comma and CDR is an alist between
4277 relative line number (integer) and name of code reference on that
4278 line (string)."
4280 ;; Get code and clean it. Remove blank lines at its
4281 ;; beginning and end.
4287 ;; Get format used for references.
4290 org-coderef-label-format)))
4291 ;; Build a regexp matching a loc with a reference.
4296 ;; Return value.
4298 ;; Code with references removed.
4304 ;; Ref line: remove ref, and signal its position in REFS.
4308 ;; Reference alist.
4309 refs)))
4312 "Format CODE by applying FUN line-wise and return it.
4314 CODE is a string representing the code to format. FUN is
4315 a function. It must accept three arguments: a line of
4316 code (string), the current line number (integer) or nil and the
4317 reference associated to the current line (string) or nil.
4319 Optional argument NUM-LINES can be an integer representing the
4320 number of code lines accumulated until the current code. Line
4321 numbers passed to FUN will take it into account. If it is nil,
4322 FUN's second argument will always be nil. This number can be
4323 obtained with `org-export-get-loc' function.
4325 Optional argument REF-ALIST can be an alist between relative line
4326 number (i.e. ignoring NUM-LINES) and the name of the code
4327 reference on it. If it is nil, FUN's third argument will always
4328 be nil. It can be obtained through the use of
4329 `org-export-unravel-code' function."
4341 "Return source code from ELEMENT, formatted in a standard way.
4343 ELEMENT is either a `src-block' or `example-block' element. INFO
4344 is a plist used as a communication channel.
4346 This function takes care of line numbering and code references
4347 inclusion. Line numbers, when applicable, appear at the
4348 beginning of the line, separated from the code by two white
4349 spaces. Code references, on the other hand, appear flushed to
4350 the right, separated by six white spaces from the widest line of
4351 code."
4352 ;; Extract code and references.
4359 ;; Handle line numbering.
4368 ;; Prepare references display, if required. Any reference
4369 ;; should start six columns after the widest line of code,
4370 ;; wrapped with parenthesis.
4375 code
4379 number-str
4380 loc
4386 num-start refs)))))
4389 ;;;; For Tables
4390 ;;
4391 ;; `org-export-table-has-special-column-p' and and
4392 ;; `org-export-table-row-is-special-p' are predicates used to look for
4393 ;; meta-information about the table structure.
4394 ;;
4395 ;; `org-table-has-header-p' tells when the rows before the first rule
4396 ;; should be considered as table's header.
4397 ;;
4398 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4399 ;; and `org-export-table-cell-borders' extract information from
4400 ;; a table-cell element.
4401 ;;
4402 ;; `org-export-table-dimensions' gives the number on rows and columns
4403 ;; in the table, ignoring horizontal rules and special columns.
4404 ;; `org-export-table-cell-address', given a table-cell object, returns
4405 ;; the absolute address of a cell. On the other hand,
4406 ;; `org-export-get-table-cell-at' does the contrary.
4407 ;;
4408 ;; `org-export-table-cell-starts-colgroup-p',
4409 ;; `org-export-table-cell-ends-colgroup-p',
4410 ;; `org-export-table-row-starts-rowgroup-p',
4411 ;; `org-export-table-row-ends-rowgroup-p',
4412 ;; `org-export-table-row-starts-header-p' and
4413 ;; `org-export-table-row-ends-header-p' indicate position of current
4414 ;; row or cell within the table.
4417 "Non-nil when TABLE has a special column.
4418 All special columns will be ignored during export."
4419 ;; The table has a special column when every first cell of every row
4420 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4421 ;; "*" "_" and "^". Though, do not consider a first row containing
4422 ;; only empty cells as special.
4438 "Non-nil when TABLE has a header.
4440 INFO is a plist used as a communication channel.
4442 A table has a header when it contains at least two row groups."
4451 table
4462 cache)))))
4465 "Non-nil if TABLE-ROW is considered special.
4467 INFO is a plist used as the communication channel.
4469 All special rows will be ignored during export."
4473 ;; A row is special either when...
4475 ;; ... it starts with a field only containing "/",
4477 ;; ... the table contains a special column and the row start
4478 ;; with a marking character among, "^", "_", "$" or "!",
4482 ;; ... it contains only alignment cookies and empty cells.
4488 ;; Since VALUE is a secondary string, the following
4489 ;; checks avoid expanding it with `org-export-data'.
4501 "Return TABLE-ROW's group number, as an integer.
4503 INFO is a plist used as the communication channel.
4505 Return value is the group number, as an integer, or nil for
4506 special rows and rows separators. First group is also table's
4507 header."
4525 "Return TABLE-CELL contents width.
4527 INFO is a plist used as the communication channel.
4529 Return value is the width given by the last width cookie in the
4530 same column as TABLE-CELL, or nil."
4547 ;; In a special row, try to find a width cookie at COLUMN.
4551 ;; The following checks avoid expanding unnecessarily
4552 ;; the cell with `org-export-data'.
4562 "Return TABLE-CELL contents alignment.
4564 INFO is a plist used as the communication channel.
4566 Return alignment as specified by the last alignment cookie in the
4567 same column as TABLE-CELL. If no such cookie is found, a default
4568 alignment value will be deduced from fraction of numbers in the
4569 column (see `org-table-number-fraction' for more information).
4570 Possible values are `left', `right' and `center'."
4583 cookie-align
4584 previous-cell-number-p)
4587 ;; In a special row, try to find an alignment cookie at
4588 ;; COLUMN.
4592 ;; Since VALUE is a secondary string, the following
4593 ;; checks avoid useless expansion through
4594 ;; `org-export-data'.
4602 ;; Ignore table rules.
4604 ;; In a standard row, check if cell's contents are
4605 ;; expressing some kind of number. Increase NUMBER-CELLS
4606 ;; accordingly. Though, don't bother if an alignment
4607 ;; cookie has already defined cell's alignment.
4612 info)))
4614 ;; Treat an empty cell as a number if it follows
4615 ;; a number.
4621 ;; Return value. Alignment specified by cookies has
4622 ;; precedence over alignment deduced from cell's contents.
4628 org-table-number-fraction)
4631 cache)))))
4634 "Return TABLE-CELL borders.
4636 INFO is a plist used as a communication channel.
4638 Return value is a list of symbols, or nil. Possible values are:
4639 `top', `bottom', `above', `below', `left' and `right'. Note:
4640 `top' (resp. `bottom') only happen for a cell in the first
4641 row (resp. last row) of the table, ignoring table rules, if any.
4643 Returned borders ignore special rows."
4646 borders)
4647 ;; Top/above border? TABLE-CELL has a border above when a rule
4648 ;; used to demarcate row groups can be found above. Hence,
4649 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4650 ;; another regular row has to be found above that rule.
4659 ;; Look at every row before the current one.
4661 ;; No rule above, or rule found starts the table (ignoring any
4662 ;; special row): TABLE-CELL is at the top of the table.
4665 ;; Bottom/below border? TABLE-CELL has a border below when next
4666 ;; non-regular row below is a rule.
4675 ;; Look at every row after the current one.
4677 ;; No rule below, or rule found ends the table (modulo some
4678 ;; special row): TABLE-CELL is at the bottom of the table.
4681 ;; Right/left borders? They can only be specified by column
4682 ;; groups. Column groups are defined in a row starting with "/".
4683 ;; Also a column groups row only contains "<", "<>", ">" or blank
4684 ;; cells.
4701 ;; There's a left border when previous cell, if
4702 ;; any, ends a group, or current one starts one.
4708 ;; There's a right border when next cell, if any,
4709 ;; starts a group, or current one ends one.
4716 ;; Table rows are read in reverse order so last column groups
4717 ;; row has precedence over any previous one.
4719 ;; Return value.
4720 borders))
4723 "Non-nil when TABLE-CELL is at the beginning of a row group.
4724 INFO is a plist used as a communication channel."
4725 ;; A cell starts a column group either when it is at the beginning
4726 ;; of a row (or after the special column, if any) or when it has
4727 ;; a left border.
4730 table-cell)
4734 "Non-nil when TABLE-CELL is at the end of a row group.
4735 INFO is a plist used as a communication channel."
4736 ;; A cell ends a column group either when it is at the end of a row
4737 ;; or when it has a right border.
4740 table-cell)
4744 "Non-nil when TABLE-ROW is at the beginning of a column group.
4745 INFO is a plist used as a communication channel."
4753 "Non-nil when TABLE-ROW is at the end of a column group.
4754 INFO is a plist used as a communication channel."
4762 "Non-nil when TABLE-ROW is the first table header's row.
4763 INFO is a plist used as a communication channel."
4770 "Non-nil when TABLE-ROW is the last table header's row.
4771 INFO is a plist used as a communication channel."
4778 "Return TABLE-ROW number.
4779 INFO is a plist used as a communication channel. Return value is
4780 zero-based and ignores separators. The function returns nil for
4781 special colums and separators."
4793 "Return TABLE dimensions.
4795 INFO is a plist used as a communication channel.
4797 Return value is a CONS like (ROWS . COLUMNS) where
4798 ROWS (resp. COLUMNS) is the number of exportable
4799 rows (resp. columns)."
4801 ;; Set number of rows, and extract first one.
4807 ;; Set number of columns.
4809 ;; Return value.
4813 "Return address of a regular TABLE-CELL object.
4815 TABLE-CELL is the cell considered. INFO is a plist used as
4816 a communication channel.
4818 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4819 zero-based index. Only exportable cells are considered. The
4820 function returns nil for other cells."
4832 "Return regular table-cell object at ADDRESS in TABLE.
4834 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4835 zero-based index. TABLE is a table type element. INFO is
4836 a plist used as a communication channel.
4838 If no table-cell, among exportable cells, is found at ADDRESS,
4839 return nil."
4842 ;; Row at (car address) or nil.
4850 'table-cell
4857 ;;;; For Tables Of Contents
4858 ;;
4859 ;; `org-export-collect-headlines' builds a list of all exportable
4860 ;; headline elements, maybe limited to a certain depth. One can then
4861 ;; easily parse it and transcode it.
4862 ;;
4863 ;; Building lists of tables, figures or listings is quite similar.
4864 ;; Once the generic function `org-export-collect-elements' is defined,
4865 ;; `org-export-collect-tables', `org-export-collect-figures' and
4866 ;; `org-export-collect-listings' can be derived from it.
4869 "Collect headlines in order to build a table of contents.
4871 INFO is a plist used as a communication channel.
4873 When optional argument N is an integer, it specifies the depth of
4874 the table of contents. Otherwise, it is set to the value of the
4875 last headline level. See `org-export-headline-levels' for more
4876 information.
4878 Return a list of all exportable headlines as parsed elements.
4879 Footnote sections, if any, will be ignored."
4884 ;; Strip contents from HEADLINE.
4887 info))
4890 "Collect referenceable elements of a determined type.
4892 TYPE can be a symbol or a list of symbols specifying element
4893 types to search. Only elements with a caption are collected.
4895 INFO is a plist used as a communication channel.
4897 When non-nil, optional argument PREDICATE is a function accepting
4898 one argument, an element of type TYPE. It returns a non-nil
4899 value when that element should be collected.
4901 Return a list of all elements found, in order of appearance."
4906 element))
4907 info))
4910 "Build a list of tables.
4911 INFO is a plist used as a communication channel.
4913 Return a list of table elements with a caption."
4917 "Build a list of figures.
4919 INFO is a plist used as a communication channel. PREDICATE is
4920 a function which accepts one argument: a paragraph element and
4921 whose return value is non-nil when that element should be
4922 collected.
4924 A figure is a paragraph type element, with a caption, verifying
4926 a vague concept that may depend on back-end.
4928 Return a list of elements recognized as figures."
4932 "Build a list of src blocks.
4934 INFO is a plist used as a communication channel.
4936 Return a list of src-block elements with a caption."
4940 ;;;; Smart Quotes
4941 ;;
4942 ;; The main function for the smart quotes sub-system is
4943 ;; `org-export-activate-smart-quotes', which replaces every quote in
4944 ;; a given string from the parse tree with its "smart" counterpart.
4945 ;;
4946 ;; Dictionary for smart quotes is stored in
4947 ;; `org-export-smart-quotes-alist'.
4948 ;;
4949 ;; Internally, regexps matching potential smart quotes (checks at
4950 ;; string boundaries are also necessary) are defined in
4951 ;; `org-export-smart-quotes-regexps'.
4955 ;; one may use: »...«, "...", ›...‹, or '...'.
4956 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4957 ;; LaTeX quotes require Babel!
5002 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5011 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5020 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5029 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5035 )
5036 "Smart quotes translations.
5038 Alist whose CAR is a language string and CDR is an alist with
5039 quote type as key and a plist associating various encodings to
5040 their translation as value.
5042 A quote type can be any symbol among `opening-double-quote',
5043 `closing-double-quote', `opening-single-quote',
5044 `closing-single-quote' and `apostrophe'.
5046 Valid encodings include `:utf-8', `:html', `:latex' and
5047 `:texinfo'.
5053 ;; Possible opening quote at beginning of string.
5055 ;; Possible closing quote at beginning of string.
5057 ;; Possible apostrophe at beginning of string.
5059 ;; Opening single and double quotes.
5061 ;; Closing single and double quotes.
5063 ;; Apostrophe.
5065 ;; Possible opening quote at end of string.
5067 ;; Possible closing quote at end of string.
5069 ;; Possible apostrophe at end of string.
5071 "List of regexps matching a quote or an apostrophe.
5077 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5078 `:utf-8'. INFO is a plist used as a communication channel.
5080 The function has to retrieve information about string
5081 surroundings in parse tree. It can only happen with an
5082 unmodified string. Thus, if S has already been through another
5083 process, a non-nil ORIGINAL optional argument will provide that
5084 original string.
5086 Return the new string."
5089 ;; Try to be flexible when computing number of blanks
5090 ;; before object. The previous object may be a string
5091 ;; introduced by the back-end and not completely parsed.
5094 ;; A string with missing `:post-blank'
5095 ;; property.
5099 ;; Fallback value.
5104 ;; Return smart quote associated to a give quote Q, as
5105 ;; a string. TYPE is a symbol among `open', `close' and
5106 ;; `apostrophe'.
5116 org-export-smart-quotes-alist))))
5117 encoding)
5118 q)))))
5120 ;; Only a quote: no regexp can match. We have to check both
5121 ;; sides and decide what to do.
5129 ;; 1. Replace quote character at the beginning of S.
5131 ;; Apostrophe?
5137 ;; Closing quote?
5143 ;; Opening quote?
5149 ;; 2. Replace quotes in the middle of the string.
5151 ;; Opening quotes.
5157 ;; Closing quotes.
5163 ;; Apostrophes.
5168 ;; 3. Replace quote character at the end of S.
5170 ;; Apostrophe?
5175 ;; Closing quote?
5181 ;; Opening quote?
5186 ;; Return string with smart quotes.
5187 s))))
5189 ;;;; Topology
5190 ;;
5191 ;; Here are various functions to retrieve information about the
5192 ;; neighbourhood of a given element or object. Neighbours of interest
5193 ;; are direct parent (`org-export-get-parent'), parent headline
5194 ;; (`org-export-get-parent-headline'), first element containing an
5195 ;; object, (`org-export-get-parent-element'), parent table
5196 ;; (`org-export-get-parent-table'), previous element or object
5197 ;; (`org-export-get-previous-element') and next element or object
5198 ;; (`org-export-get-next-element').
5199 ;;
5200 ;; `org-export-get-genealogy' returns the full genealogy of a given
5201 ;; element or object, from closest parent to full parse tree.
5204 "Return BLOB parent or nil.
5205 BLOB is the element or object considered."
5209 "Return full genealogy relative to a given element or object.
5211 BLOB is the element or object being considered.
5213 Ancestors are returned from closest to farthest, the last one
5214 being the full parse tree."
5221 "Return BLOB parent headline or nil.
5222 BLOB is the element or object being considered."
5226 parent))
5229 "Return first element containing OBJECT or nil.
5230 OBJECT is the object to consider."
5234 parent))
5237 "Return OBJECT parent table or nil.
5238 OBJECT is either a `table-cell' or `table-element' type object."
5242 parent))
5245 "Return previous element or object.
5247 BLOB is an element or object. INFO is a plist used as
5248 a communication channel. Return previous exportable element or
5249 object, a string, or nil.
5251 When optional argument N is a positive integer, return a list
5252 containing up to N siblings before BLOB, from farthest to
5253 closest. With any other non-nil value, return a list containing
5254 all of them."
5256 ;; An object can belong to the contents of its parent or
5257 ;; to a secondary string. We check the latter option
5258 ;; first.
5261 org-element-all-elements))
5265 org-element-secondary-value-alist))
5266 parent)))
5269 prev)
5278 prev)))
5281 "Return next element or object.
5283 BLOB is an element or object. INFO is a plist used as
5284 a communication channel. Return next exportable element or
5285 object, a string, or nil.
5287 When optional argument N is a positive integer, return a list
5288 containing up to N siblings after BLOB, from closest to farthest.
5289 With any other non-nil value, return a list containing all of
5290 them."
5292 ;; An object can belong to the contents of its parent or to
5293 ;; a secondary string. We check the latter option first.
5296 org-element-all-objects))
5300 org-element-secondary-value-alist))
5301 parent)))
5304 next)
5312 siblings)
5316 ;;;; Translation
5317 ;;
5318 ;; `org-export-translate' translates a string according to language
5319 ;; specified by LANGUAGE keyword or `org-export-language-setup'
5320 ;; variable and a specified charset. `org-export-dictionary' contains
5321 ;; the dictionary used for the translation.
5505 "Dictionary for export engine.
5507 Alist whose CAR is the string to translate and CDR is an alist
5508 whose CAR is the language string and CDR is a plist whose
5509 properties are possible charsets and values translated terms.
5511 It is used as a database for `org-export-translate'. Since this
5512 function returns the string as-is if no translation was found,
5513 the variable only needs to record values different from the
5517 "Translate string S according to language specification.
5519 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5520 and `:utf-8'. INFO is a plist used as a communication channel.
5522 Translation depends on `:language' property. Return the
5523 translated string. If no translation is found, try to fall back
5524 to `:default' encoding. If it fails, return S."
5530 s)))
5533 \f
5534 ;;; Asynchronous Export
5535 ;;
5536 ;; `org-export-async-start' is the entry point for asynchronous
5537 ;; export. It recreates current buffer (including visibility,
5538 ;; narrowing and visited file) in an external Emacs process, and
5539 ;; evaluates a command there. It then applies a function on the
5540 ;; returned results in the current process.
5541 ;;
5542 ;; Asynchronously generated results are never displayed directly.
5543 ;; Instead, they are stored in `org-export-stack-contents'. They can
5544 ;; then be retrieved by calling `org-export-stack'.
5545 ;;
5546 ;; Export Stack is viewed through a dedicated major mode
5547 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5548 ;;`org-export-stack-delete', `org-export-stack-view' and
5549 ;;`org-export-stack-clear'.
5550 ;;
5551 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5552 ;; It should used whenever `org-export-async-start' is called.
5555 "Call function FUN on the results returned by BODY evaluation.
5557 BODY evaluation happens in an asynchronous process, from a buffer
5558 which is an exact copy of the current one.
5560 Use `org-export-add-to-stack' in FUN in order to register results
5561 in the stack. Examples for, respectively a temporary buffer and
5562 a file are:
5564 \(org-export-async-start
5565 \(lambda (output)
5567 \(erase-buffer)
5568 \(insert output)
5569 \(goto-char (point-min))
5570 \(org-export-add-to-stack (current-buffer) 'backend)))
5571 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5573 and
5575 \(org-export-async-start
5576 \(lambda (f) (org-export-add-to-stack f 'backend))
5577 `(expand-file-name
5578 \(org-export-to-file
5579 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5582 ;; Write the full sexp evaluating BODY in a copy of the current
5583 ;; buffer to a temporary file, as it may be too long for program
5584 ;; args in `start-process'.
5591 ;; Null characters (from variable values) are inserted
5592 ;; within the file. As a consequence, coding system for
5593 ;; buffer contents will not be recognized properly. So,
5594 ;; we make sure it is the same as the one used to display
5595 ;; the original buffer.
5597 ,coding
5600 ;; Ignore `kill-emacs-hook' and code evaluation
5601 ;; queries from Babel as we need a truly
5602 ;; non-interactive process.
5604 org-babel-confirm-evaluate-answer-no t)
5605 ;; Initialize export framework.
5607 ;; Re-create current buffer there.
5610 ;; Sexp to evaluate in the buffer.
5612 ;; Start external process.
5615 (,process
5620 "-l" org-export-async-init-file
5622 ;; Register running process in stack.
5624 ;; Set-up sentinel in order to catch results.
5626 ,process
5650 "Add a new result to export stack if not present already.
5652 SOURCE is a buffer or a file name containing export results.
5653 BACKEND is a symbol representing export back-end used to generate
5654 it.
5656 Entries already pointing to SOURCE and unavailable entries are
5657 removed beforehand. Return the new stack."
5663 "Menu for asynchronous export results and running processes."
5673 "Return source from export results at point in stack."
5680 source
5681 ;; SOURCE is not consistent with current line. The stack
5682 ;; view is outdated.
5686 "Remove all entries from export stack."
5691 "Refresh the asynchronous export stack.
5692 DUMMY is ignored. Unavailable sources are removed from the list.
5693 Return the new stack."
5703 ;; Back-end.
5705 ;; Age.
5708 ;; Compute age of the results.
5710 "%4h:%.2m "
5712 ;; Source.
5717 ;; Clear stack from exited processes, dead buffers or
5718 ;; non-existent files.
5730 "Remove export results at point from stack.
5731 If optional argument SOURCE is non-nil, remove it instead."
5736 org-export-stack-contents))))
5739 "View export results at point in stack.
5740 With an optional prefix argument IN-EMACS, force viewing files
5741 within Emacs."
5755 (define-key km "p" 'previous-line)
5756 (define-key km "\C-p" 'previous-line)
5757 (define-key km "\C-?" 'previous-line)
5758 (define-key km [up] 'previous-line)
5759 (define-key km "C" 'org-export-stack-clear)
5760 (define-key km "v" 'org-export-stack-view)
5761 (define-key km (kbd "RET") 'org-export-stack-view)
5762 (define-key km "d" 'org-export-stack-remove)
5763 km)
5764 "Keymap for Org Export Stack.")
5766 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5767 "Mode for displaying asynchronous export stack.
5770 stack.
5772 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5773 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5774 stack completely.
5776 Removing entries in an Org Export Stack buffer doesn't affect
5777 files or buffers, only the display.
5780 (abbrev-mode 0)
5781 (auto-fill-mode 0)
5782 (setq buffer-read-only t
5783 buffer-undo-list t
5784 truncate-lines t
5785 header-line-format
5786 '(:eval
5787 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5788 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5789 (set (make-local-variable 'revert-buffer-function)
5790 'org-export-stack-refresh))
5793 \f
5794 ;;; The Dispatcher
5795 ;;
5796 ;; `org-export-dispatch' is the standard interactive way to start an
5797 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5798 ;; for its interface, which, in turn, delegates response to key
5799 ;; pressed to `org-export--dispatch-action'.
5801 ;;;###autoload
5802 (defun org-export-dispatch (&optional arg)
5803 "Export dispatcher for Org mode.
5805 It provides an access to common export related tasks in a buffer.
5806 Its interface comes in two flavours: standard and expert.
5808 While both share the same set of bindings, only the former
5809 displays the valid keys associations in a dedicated buffer.
5810 Scrolling (resp. line-wise motion) in this buffer is done with
5811 SPC and DEL (resp. C-n and C-p) keys.
5813 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5814 flavour or the other.
5817 of options used back then, on the current buffer.
5819 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5820 (interactive "P")
5821 (let* ((input
5822 (cond ((equal arg '(16)) '(stack))
5823 ((and arg org-export-dispatch-last-action))
5824 (t (save-window-excursion
5825 (unwind-protect
5826 (progn
5827 ;; Remember where we are
5828 (move-marker org-export-dispatch-last-position
5829 (point)
5830 (org-base-buffer (current-buffer)))
5831 ;; Get and store an export command
5832 (setq org-export-dispatch-last-action
5833 (org-export--dispatch-ui
5834 (list org-export-initial-scope
5835 (and org-export-in-background 'async))
5836 nil
5837 org-export-dispatch-use-expert-ui)))
5838 (and (get-buffer "*Org Export Dispatcher*")
5839 (kill-buffer "*Org Export Dispatcher*")))))))
5840 (action (car input))
5841 (optns (cdr input)))
5842 (unless (memq 'subtree optns)
5843 (move-marker org-export-dispatch-last-position nil))
5844 (case action
5845 ;; First handle special hard-coded actions.
5846 (template (org-export-insert-default-template nil optns))
5847 (stack (org-export-stack))
5848 (publish-current-file
5849 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5850 (publish-current-project
5851 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5852 (publish-choose-project
5853 (org-publish (assoc (org-icompleting-read
5854 "Publish project: "
5855 org-publish-project-alist nil t)
5856 org-publish-project-alist)
5857 (memq 'force optns)
5858 (memq 'async optns)))
5859 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5860 (otherwise
5861 (save-excursion
5862 (when arg
5863 ;; Repeating command, maybe move cursor to restore subtree
5864 ;; context.
5865 (if (eq (marker-buffer org-export-dispatch-last-position)
5866 (org-base-buffer (current-buffer)))
5867 (goto-char org-export-dispatch-last-position)
5868 ;; We are in a different buffer, forget position.
5869 (move-marker org-export-dispatch-last-position nil)))
5870 (funcall action
5871 ;; Return a symbol instead of a list to ease
5872 ;; asynchronous export macro use.
5873 (and (memq 'async optns) t)
5874 (and (memq 'subtree optns) t)
5875 (and (memq 'visible optns) t)
5876 (and (memq 'body optns) t)))))))
5878 (defun org-export--dispatch-ui (options first-key expertp)
5879 "Handle interface for `org-export-dispatch'.
5881 OPTIONS is a list containing current interactive options set for
5882 export. It can contain any of the following symbols:
5883 `body' toggles a body-only export
5884 `subtree' restricts export to current subtree
5885 `visible' restricts export to visible part of buffer.
5886 `force' force publishing files.
5887 `async' use asynchronous export process
5889 FIRST-KEY is the key pressed to select the first level menu. It
5890 is nil when this menu hasn't been selected yet.
5892 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5893 buffer is provided, but indications about currently active
5894 options are given in the prompt. Moreover, \[?] allows to switch
5895 back to standard interface."
5896 (let* ((fontify-key
5897 (lambda (key &optional access-key)
5898 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5899 ;; non-nil is the required first-level key to activate
5900 ;; KEY. When its value is t, activate KEY independently
5901 ;; on the first key, if any. A nil value means KEY will
5902 ;; only be activated at first level.
5903 (if (or (eq access-key t) (eq access-key first-key))
5904 (org-propertize key 'face 'org-warning)
5905 key)))
5906 (fontify-value
5907 (lambda (value)
5908 ;; Fontify VALUE string.
5909 (org-propertize value 'face 'font-lock-variable-name-face)))
5910 ;; Prepare menu entries by extracting them from registered
5911 ;; back-ends and sorting them by access key and by ordinal,
5912 ;; if any.
5913 (entries
5914 (sort (sort (delq nil
5915 (mapcar 'org-export-backend-menu
5916 org-export--registered-backends))
5917 (lambda (a b)
5918 (let ((key-a (nth 1 a))
5919 (key-b (nth 1 b)))
5920 (cond ((and (numberp key-a) (numberp key-b))
5921 (< key-a key-b))
5922 ((numberp key-b) t)))))
5923 'car-less-than-car))
5924 ;; Compute a list of allowed keys based on the first key
5925 ;; pressed, if any. Some keys
5926 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
5927 ;; available.
5928 (allowed-keys
5929 (nconc (list 2 22 19 6 1)
5930 (if (not first-key) (org-uniquify (mapcar 'car entries))
5931 (let (sub-menu)
5932 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
5933 (when (eq (car entry) first-key)
5934 (setq sub-menu (append (nth 2 entry) sub-menu))))))
5935 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5936 ((not first-key) (list ?P)))
5937 (list ?& ?#)
5938 (when expertp (list ??))
5939 (list ?q)))
5940 ;; Build the help menu for standard UI.
5941 (help
5942 (unless expertp
5943 (concat
5944 ;; Options are hard-coded.
5945 (format "[%s] Body only: %s [%s] Visible only: %s
5946 \[%s] Export scope: %s [%s] Force publishing: %s
5948 (funcall fontify-key "C-b" t)
5949 (funcall fontify-value
5950 (if (memq 'body options) "On " "Off"))
5951 (funcall fontify-key "C-v" t)
5952 (funcall fontify-value
5953 (if (memq 'visible options) "On " "Off"))
5954 (funcall fontify-key "C-s" t)
5955 (funcall fontify-value
5956 (if (memq 'subtree options) "Subtree" "Buffer "))
5957 (funcall fontify-key "C-f" t)
5958 (funcall fontify-value
5959 (if (memq 'force options) "On " "Off"))
5960 (funcall fontify-key "C-a" t)
5961 (funcall fontify-value
5962 (if (memq 'async options) "On " "Off")))
5963 ;; Display registered back-end entries. When a key
5964 ;; appears for the second time, do not create another
5965 ;; entry, but append its sub-menu to existing menu.
5966 (let (last-key)
5967 (mapconcat
5968 (lambda (entry)
5969 (let ((top-key (car entry)))
5970 (concat
5971 (unless (eq top-key last-key)
5972 (setq last-key top-key)
5974 (funcall fontify-key (char-to-string top-key))
5975 (nth 1 entry)))
5976 (let ((sub-menu (nth 2 entry)))
5977 (unless (functionp sub-menu)
5978 ;; Split sub-menu into two columns.
5979 (let ((index -1))
5980 (concat
5981 (mapconcat
5982 (lambda (sub-entry)
5983 (incf index)
5984 (format
5985 (if (zerop (mod index 2)) " [%s] %-26s"
5987 (funcall fontify-key
5988 (char-to-string (car sub-entry))
5989 top-key)
5990 (nth 1 sub-entry)))
5991 sub-menu "")
5993 entries ""))
5994 ;; Publishing menu is hard-coded.
5996 [%s] Current file [%s] Current project
5998 (funcall fontify-key "P")
5999 (funcall fontify-key "f" ?P)
6000 (funcall fontify-key "p" ?P)
6001 (funcall fontify-key "x" ?P)
6002 (funcall fontify-key "a" ?P))
6004 (funcall fontify-key "&" t)
6005 (funcall fontify-key "#" t))
6006 (format "[%s] %s"
6007 (funcall fontify-key "q" t)
6008 (if first-key "Main menu" "Exit")))))
6009 ;; Build prompts for both standard and expert UI.
6010 (standard-prompt (unless expertp "Export command: "))
6011 (expert-prompt
6012 (when expertp
6013 (format
6014 "Export command (C-%s%s%s%s%s) [%s]: "
6015 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6016 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6017 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6018 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6019 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6020 (mapconcat (lambda (k)
6021 ;; Strip control characters.
6022 (unless (< k 27) (char-to-string k)))
6023 allowed-keys "")))))
6024 ;; With expert UI, just read key with a fancy prompt. In standard
6025 ;; UI, display an intrusive help buffer.
6026 (if expertp
6027 (org-export--dispatch-action
6028 expert-prompt allowed-keys entries options first-key expertp)
6029 ;; At first call, create frame layout in order to display menu.
6030 (unless (get-buffer "*Org Export Dispatcher*")
6031 (delete-other-windows)
6032 (org-switch-to-buffer-other-window
6033 (get-buffer-create "*Org Export Dispatcher*"))
6034 (setq cursor-type nil
6035 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6036 ;; Make sure that invisible cursor will not highlight square
6037 ;; brackets.
6038 (set-syntax-table (copy-syntax-table))
6039 (modify-syntax-entry ?\[ "w"))
6040 ;; At this point, the buffer containing the menu exists and is
6041 ;; visible in the current window. So, refresh it.
6042 (with-current-buffer "*Org Export Dispatcher*"
6043 ;; Refresh help. Maintain display continuity by re-visiting
6044 ;; previous window position.
6045 (let ((pos (window-start)))
6046 (erase-buffer)
6047 (insert help)
6048 (set-window-start nil pos)))
6049 (org-fit-window-to-buffer)
6050 (org-export--dispatch-action
6051 standard-prompt allowed-keys entries options first-key expertp))))
6053 (defun org-export--dispatch-action
6054 (prompt allowed-keys entries options first-key expertp)
6055 "Read a character from command input and act accordingly.
6057 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6058 a list of characters available at a given step in the process.
6059 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6060 EXPERTP are the same as defined in `org-export--dispatch-ui',
6061 which see.
6063 Toggle export options when required. Otherwise, return value is
6064 a list with action as CAR and a list of interactive export
6065 options as CDR."
6066 (let (key)
6067 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6068 ;; C-p, SPC, DEL).
6069 (while (and (setq key (read-char-exclusive prompt))
6070 (not expertp)
6071 (memq key '(14 16 ?\s ?\d)))
6072 (case key
6073 (14 (if (not (pos-visible-in-window-p (point-max)))
6074 (ignore-errors (scroll-up-line))
6075 (message "End of buffer")
6076 (sit-for 1)))
6077 (16 (if (not (pos-visible-in-window-p (point-min)))
6078 (ignore-errors (scroll-down-line))
6079 (message "Beginning of buffer")
6080 (sit-for 1)))
6081 (?\s (if (not (pos-visible-in-window-p (point-max)))
6082 (scroll-up nil)
6083 (message "End of buffer")
6084 (sit-for 1)))
6085 (?\d (if (not (pos-visible-in-window-p (point-min)))
6086 (scroll-down nil)
6087 (message "Beginning of buffer")
6088 (sit-for 1)))))
6089 (cond
6090 ;; Ignore undefined associations.
6091 ((not (memq key allowed-keys))
6092 (ding)
6093 (unless expertp (message "Invalid key") (sit-for 1))
6094 (org-export--dispatch-ui options first-key expertp))
6095 ;; q key at first level aborts export. At second level, cancel
6096 ;; first key instead.
6097 ((eq key ?q) (if (not first-key) (error "Export aborted")
6098 (org-export--dispatch-ui options nil expertp)))
6099 ;; Help key: Switch back to standard interface if expert UI was
6100 ;; active.
6101 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6102 ;; Send request for template insertion along with export scope.
6103 ((eq key ?#) (cons 'template (memq 'subtree options)))
6104 ;; Switch to asynchronous export stack.
6105 ((eq key ?&) '(stack))
6106 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6107 ((memq key '(2 22 19 6 1))
6108 (org-export--dispatch-ui
6109 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6110 (6 'force) (1 'async))))
6111 (if (memq option options) (remq option options)
6112 (cons option options)))
6113 first-key expertp))
6114 ;; Action selected: Send key and options back to
6115 ;; `org-export-dispatch'.
6116 ((or first-key (functionp (nth 2 (assq key entries))))
6117 (cons (cond
6118 ((not first-key) (nth 2 (assq key entries)))
6119 ;; Publishing actions are hard-coded. Send a special
6120 ;; signal to `org-export-dispatch'.
6121 ((eq first-key ?P)
6122 (case key
6123 (?f 'publish-current-file)
6124 (?p 'publish-current-project)
6125 (?x 'publish-choose-project)
6126 (?a 'publish-all)))
6127 ;; Return first action associated to FIRST-KEY + KEY
6128 ;; path. Indeed, derived backends can share the same
6129 ;; FIRST-KEY.
6130 (t (catch 'found
6131 (mapc (lambda (entry)
6132 (let ((match (assq key (nth 2 entry))))
6133 (when match (throw 'found (nth 2 match)))))
6134 (member (assq first-key entries) entries)))))
6135 options))
6136 ;; Otherwise, enter sub-menu.
6137 (t (org-export--dispatch-ui options key expertp)))))
6141 (provide 'ox)
6143 ;; Local variables:
6144 ;; generated-autoload-file: "org-loaddefs.el"
6145 ;; End:
6147 ;;; ox.el ends here