| blob | 71435b77e82b0101d4a27f7e1f69ce73c1f6c418 |
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 property name associated to KEYWORD.
1668 options))))
1671 ;; Recursively read keywords in buffer. FILES is a list
1672 ;; of files read so far. PLIST is the current property
1673 ;; list obtained.
1682 ;; Options in `org-export-special-keywords'.
1686 ;; Avoid circular dependencies.
1696 plist
1701 plist
1707 ;; Options in `org-export-options-alist'.
1712 plist prop
1713 ;; Handle value depending on specified
1714 ;; BEHAVIOUR.
1720 " "
1732 ;; Return final value.
1733 plist))))
1734 ;; Read options in the current buffer.
1736 ;; Parse keywords specified in `org-element-document-properties'.
1738 ;; Find the property associated to the keyword.
1746 org-element-document-properties)
1747 ;; Return value.
1748 plist))
1751 "Return properties related to buffer attributes, as a plist."
1752 ;; Store full path of input file name, or nil. For internal use.
1757 "Return default title for current document, as a string.
1758 Title is extracted from associated file name, if any, or buffer's
1759 name."
1768 "Return global export options as a plist.
1769 Optional argument BACKEND, if non-nil, is an export back-end, as
1770 returned by, e.g., `org-export-create-backend'. It specifies
1771 which back-end specific export options should also be read in the
1772 process."
1774 ;; Priority is given to back-end specific options.
1776 org-export-options-alist)))
1782 plist
1783 prop
1784 ;; Eval default value provided. If keyword is
1785 ;; a member of `org-element-document-properties',
1786 ;; parse it as a secondary string before storing it.
1793 value)))))))))))
1796 "Return variables bound from BIND keywords in current buffer.
1797 Also look for BIND keywords in setup files. The return value is
1798 an alist where associations are (VARIABLE-NAME VALUE)."
1803 ;; Return an alist between variable names and their
1804 ;; value. FILES is a list of setup files names read so
1805 ;; far, used to avoid circular dependencies. ALIST is
1806 ;; the alist collected so far.
1817 ;; Enter setup file.
1827 alist))))))))))
1828 alist)))))
1829 ;; Return value in appropriate order of appearance.
1833 ;;;; Tree Properties
1834 ;;
1835 ;; Tree properties are information extracted from parse tree. They
1836 ;; are initialized at the beginning of the transcoding process by
1837 ;; `org-export-collect-tree-properties'.
1838 ;;
1839 ;; Dedicated functions focus on computing the value of specific tree
1840 ;; properties during initialization. Thus,
1841 ;; `org-export--populate-ignore-list' lists elements and objects that
1842 ;; should be skipped during export, `org-export--get-min-level' gets
1843 ;; the minimal exportable level, used as a basis to compute relative
1844 ;; level for headlines. Eventually
1845 ;; `org-export--collect-headline-numbering' builds an alist between
1846 ;; headlines and their numbering.
1849 "Extract tree properties from parse tree.
1851 DATA is the parse tree from which information is retrieved. INFO
1852 is a list holding export options.
1854 Following tree properties are set or updated:
1856 `:exported-data' Hash table used to memoize results from
1857 `org-export-data'.
1859 `:footnote-definition-alist' List of footnotes definitions in
1860 original buffer and current parse tree.
1862 `:headline-offset' Offset between true level of headlines and
1863 local level. An offset of -1 means a headline
1864 of level 2 should be considered as a level
1865 1 headline in the context.
1867 `:headline-numbering' Alist of all headlines as key an the
1868 associated numbering as value.
1870 `:ignore-list' List of elements that should be ignored during
1871 export.
1873 Return updated plist."
1874 ;; Install the parse tree in the communication channel, in order to
1875 ;; use `org-export-get-genealogy' and al.
1877 ;; Get the list of elements and objects to ignore, and put it into
1878 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1879 ;; been done during parse tree filtering.
1882 :ignore-list
1885 ;; Compute `:headline-offset' in order to be able to use
1886 ;; `org-export-get-relative-level'.
1889 :headline-offset
1891 ;; Update footnotes definitions list with definitions in parse tree.
1892 ;; This is required since buffer expansion might have modified
1893 ;; boundaries of footnote definitions contained in the parse tree.
1894 ;; This way, definitions in `footnote-definition-alist' are bound to
1895 ;; match those in the parse tree.
1901 defs)))
1903 ;; Properties order doesn't matter: get the rest of the tree
1904 ;; properties.
1908 info))
1911 "Return minimum exportable headline's level in DATA.
1912 DATA is parsed tree as returned by `org-element-parse-buffer'.
1913 OPTIONS is a plist holding export options."
1924 ;; If no headline was found, for the sake of consistency, set
1925 ;; minimum level to 1 nonetheless.
1929 "Return numbering of all exportable headlines in a parse tree.
1931 DATA is the parse tree. OPTIONS is the plist holding export
1932 options.
1934 Return an alist whose key is a headline and value is its
1935 associated numbering \(in the shape of a list of numbers\) or nil
1936 for a footnotes section."
1944 headline
1946 for idx from 0 to org-export-max-depth
1950 options)))
1953 "Return list of elements and objects to ignore during export.
1954 DATA is the parse tree to traverse. OPTIONS is the plist holding
1955 export options."
1957 walk-data
1958 ;; First find trees containing a select tag, if any.
1962 ;; Collect ignored elements or objects into IGNORE-LIST.
1968 ;; If headline is archived but tree below has
1969 ;; to be skipped, add it to ignore list.
1972 ;; Move into secondary string, if any.
1977 ;; Move into recursive objects/elements.
1979 ;; Main call.
1981 ;; Return value.
1982 ignore))
1985 "Return list of headlines and inlinetasks with a select tag in their tree.
1986 DATA is parsed data as returned by `org-element-parse-buffer'.
1987 INFO is a plist holding export options."
1989 walk-data ; For byte-compiler.
1999 ;; When a select tag is found, mark full
2000 ;; genealogy and every headline within the tree
2001 ;; as acceptable.
2004 genealogy
2007 selected-trees))
2008 ;; If at a headline, continue searching in tree,
2009 ;; recursively.
2019 selected-trees))
2022 "Non-nil when element or object BLOB should be skipped during export.
2023 OPTIONS is the plist holding export options. SELECTED, when
2024 non-nil, is a list of headlines or inlinetasks belonging to
2025 a tree with a select tag."
2032 ;; If `:with-drawers' value starts with `not', ignore
2033 ;; every drawer whose name belong to that list.
2034 ;; Otherwise, ignore drawers whose name isn't in that
2035 ;; list.
2051 ;; Ignore subtrees with an exclude tag.
2054 ;; When a select tag is present in the buffer, ignore any tree
2055 ;; without it.
2057 ;; Ignore commented sub-trees.
2059 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2061 ;; Ignore tasks, if specified by `:with-tasks' property.
2076 ;; `:with-timestamps' only applies to isolated timestamps
2077 ;; objects, i.e. timestamp objects in a paragraph containing only
2078 ;; timestamps and whitespaces.
2086 options t))))
2095 \f
2096 ;;; The Transcoder
2097 ;;
2098 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2099 ;; `org-element-parse-buffer') and transcodes it into a specified
2100 ;; back-end output. It takes care of filtering out elements or
2101 ;; objects according to export options and organizing the output blank
2102 ;; lines and white space are preserved. The function memoizes its
2103 ;; results, so it is cheap to call it within transcoders.
2104 ;;
2105 ;; It is possible to modify locally the back-end used by
2106 ;; `org-export-data' or even use a temporary back-end by using
2107 ;; `org-export-data-with-backend'.
2108 ;;
2109 ;; Internally, three functions handle the filtering of objects and
2110 ;; elements during the export. In particular,
2111 ;; `org-export-ignore-element' marks an element or object so future
2112 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2113 ;; elements or objects should be seen as real Org syntax and
2114 ;; `org-export-expand' transforms the others back into their original
2115 ;; shape
2116 ;;
2117 ;; `org-export-transcoder' is an accessor returning appropriate
2118 ;; translator function for a given element or object.
2121 "Return appropriate transcoder for BLOB.
2122 INFO is a plist containing export directives."
2124 ;; Return contents only for complete parse trees.
2130 "Convert DATA into current back-end format.
2132 DATA is a parse tree, an element or an object or a secondary
2133 string. INFO is a plist holding export options.
2135 Return transcoded string."
2141 ;; Ignored element/object.
2143 ;; Plain text.
2149 info))
2150 ;; Uninterpreted element/object: change it back to Org
2151 ;; syntax and export again resulting raw string.
2155 data
2159 info))
2160 ;; Secondary string.
2163 ;; Element/Object without contents or, as a special case,
2164 ;; headline with archive tag and archived trees restricted
2165 ;; to title only.
2173 ;; Export snippets never return a nil value so
2174 ;; that white spaces following them are never
2175 ;; ignored.
2177 ;; Element/Object with contents.
2190 ;; Elements directly containing objects
2191 ;; must have their indentation normalized
2192 ;; first.
2194 data
2195 ;; When normalizing contents of the first
2196 ;; paragraph in an item or a footnote
2197 ;; definition, ignore first line's
2198 ;; indentation: there is none and it
2199 ;; might be misleading.
2204 data)
2211 info))))))))
2212 ;; Final result will be memoized before being returned.
2214 data
2218 ;; Append the same white space between elements or objects as in
2219 ;; the original buffer, and call appropriate filters.
2230 info)))
2231 results)))
2235 "Convert DATA into BACKEND format.
2237 DATA is an element, an object, a secondary string or a string.
2238 BACKEND is a symbol. INFO is a plist used as a communication
2239 channel.
2241 Unlike to `org-export-with-backend', this function will
2242 recursively convert DATA using BACKEND translation table."
2245 data
2246 ;; Set-up a new communication channel with translations defined in
2247 ;; BACKEND as the translate table and a new hash table for
2248 ;; memoization.
2250 info
2252 ;; Size of the hash table is reduced since this function
2253 ;; will probably be used on short trees.
2257 "Non-nil if element or object BLOB should be interpreted during export.
2258 If nil, BLOB will appear as raw Org syntax. Check is done
2259 according to export options INFO, stored as a plist."
2261 ;; ... entities...
2263 ;; ... emphasis...
2266 ;; ... fixed-width areas.
2268 ;; ... LaTeX environments and fragments...
2272 ;; ... sub/superscripts...
2278 ;; ... tables...
2283 "Expand a parsed element or object to its original state.
2285 BLOB is either an element or an object. CONTENTS is its
2286 contents, as a string or nil.
2288 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2289 keywords before output."
2294 blob contents))))
2297 "Add ELEMENT to `:ignore-list' in INFO.
2299 Any element in `:ignore-list' will be skipped when using
2300 `org-element-map'. INFO is modified by side effects."
2304 \f
2305 ;;; The Filter System
2306 ;;
2307 ;; Filters allow end-users to tweak easily the transcoded output.
2308 ;; They are the functional counterpart of hooks, as every filter in
2309 ;; a set is applied to the return value of the previous one.
2310 ;;
2311 ;; Every set is back-end agnostic. Although, a filter is always
2312 ;; called, in addition to the string it applies to, with the back-end
2313 ;; used as argument, so it's easy for the end-user to add back-end
2314 ;; specific filters in the set. The communication channel, as
2315 ;; a plist, is required as the third argument.
2316 ;;
2317 ;; From the developer side, filters sets can be installed in the
2318 ;; process with the help of `org-export-define-backend', which
2319 ;; internally stores filters as an alist. Each association has a key
2320 ;; among the following symbols and a function or a list of functions
2321 ;; as value.
2322 ;;
2323 ;; - `:filter-options' applies to the property list containing export
2324 ;; options. Unlike to other filters, functions in this list accept
2325 ;; two arguments instead of three: the property list containing
2326 ;; export options and the back-end. Users can set its value through
2327 ;; `org-export-filter-options-functions' variable.
2328 ;;
2329 ;; - `:filter-parse-tree' applies directly to the complete parsed
2330 ;; tree. Users can set it through
2331 ;; `org-export-filter-parse-tree-functions' variable.
2332 ;;
2333 ;; - `:filter-final-output' applies to the final transcoded string.
2334 ;; Users can set it with `org-export-filter-final-output-functions'
2335 ;; variable
2336 ;;
2337 ;; - `:filter-plain-text' applies to any string not recognized as Org
2338 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2339 ;; configure it.
2340 ;;
2341 ;; - `:filter-TYPE' applies on the string returned after an element or
2342 ;; object of type TYPE has been transcoded. A user can modify
2343 ;; `org-export-filter-TYPE-functions'
2344 ;;
2345 ;; All filters sets are applied with
2346 ;; `org-export-filter-apply-functions' function. Filters in a set are
2347 ;; applied in a LIFO fashion. It allows developers to be sure that
2348 ;; their filters will be applied first.
2349 ;;
2350 ;; Filters properties are installed in communication channel with
2351 ;; `org-export-install-filters' function.
2352 ;;
2353 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2354 ;; `org-export-before-parsing-hook') are run at the beginning of the
2355 ;; export process and just before parsing to allow for heavy structure
2356 ;; modifications.
2359 ;;;; Hooks
2362 "Hook run at the beginning of the export process.
2364 This is run before include keywords and macros are expanded and
2365 Babel code blocks executed, on a copy of the original buffer
2366 being exported. Visibility and narrowing are preserved. Point
2367 is at the beginning of the buffer.
2369 Every function in this hook will be called with one argument: the
2373 "Hook run before parsing an export buffer.
2375 This is run after include keywords and macros have been expanded
2376 and Babel code blocks executed, on a copy of the original buffer
2377 being exported. Visibility and narrowing are preserved. Point
2378 is at the beginning of the buffer.
2380 Every function in this hook will be called with one argument: the
2384 ;;;; Special Filters
2387 "List of functions applied to the export options.
2388 Each filter is called with two arguments: the export options, as
2389 a plist, and the back-end, as a symbol. It must return
2393 "List of functions applied to the parsed tree.
2394 Each filter is called with three arguments: the parse tree, as
2395 returned by `org-element-parse-buffer', the back-end, as
2396 a symbol, and the communication channel, as a plist. It must
2400 "List of functions applied to plain text.
2401 Each filter is called with three arguments: a string which
2402 contains no Org syntax, the back-end, as a symbol, and the
2403 communication channel, as a plist. It must return a string or
2407 "List of functions applied to the transcoded string.
2408 Each filter is called with three arguments: the full transcoded
2409 string, the back-end, as a symbol, and the communication channel,
2410 as a plist. It must return a string that will be used as the
2414 ;;;; Elements Filters
2417 "List of functions applied to a transcoded babel-call.
2418 Each filter is called with three arguments: the transcoded data,
2419 as a string, the back-end, as a symbol, and the communication
2423 "List of functions applied to a transcoded center block.
2424 Each filter is called with three arguments: the transcoded data,
2425 as a string, the back-end, as a symbol, and the communication
2429 "List of functions applied to a transcoded clock.
2430 Each filter is called with three arguments: the transcoded data,
2431 as a string, the back-end, as a symbol, and the communication
2435 "List of functions applied to a transcoded comment.
2436 Each filter is called with three arguments: the transcoded data,
2437 as a string, the back-end, as a symbol, and the communication
2441 "List of functions applied to a transcoded comment-block.
2442 Each filter is called with three arguments: the transcoded data,
2443 as a string, the back-end, as a symbol, and the communication
2447 "List of functions applied to a transcoded diary-sexp.
2448 Each filter is called with three arguments: the transcoded data,
2449 as a string, the back-end, as a symbol, and the communication
2453 "List of functions applied to a transcoded drawer.
2454 Each filter is called with three arguments: the transcoded data,
2455 as a string, the back-end, as a symbol, and the communication
2459 "List of functions applied to a transcoded dynamic-block.
2460 Each filter is called with three arguments: the transcoded data,
2461 as a string, the back-end, as a symbol, and the communication
2465 "List of functions applied to a transcoded example-block.
2466 Each filter is called with three arguments: the transcoded data,
2467 as a string, the back-end, as a symbol, and the communication
2471 "List of functions applied to a transcoded export-block.
2472 Each filter is called with three arguments: the transcoded data,
2473 as a string, the back-end, as a symbol, and the communication
2477 "List of functions applied to a transcoded fixed-width.
2478 Each filter is called with three arguments: the transcoded data,
2479 as a string, the back-end, as a symbol, and the communication
2483 "List of functions applied to a transcoded footnote-definition.
2484 Each filter is called with three arguments: the transcoded data,
2485 as a string, the back-end, as a symbol, and the communication
2489 "List of functions applied to a transcoded headline.
2490 Each filter is called with three arguments: the transcoded data,
2491 as a string, the back-end, as a symbol, and the communication
2495 "List of functions applied to a transcoded horizontal-rule.
2496 Each filter is called with three arguments: the transcoded data,
2497 as a string, the back-end, as a symbol, and the communication
2501 "List of functions applied to a transcoded inlinetask.
2502 Each filter is called with three arguments: the transcoded data,
2503 as a string, the back-end, as a symbol, and the communication
2507 "List of functions applied to a transcoded item.
2508 Each filter is called with three arguments: the transcoded data,
2509 as a string, the back-end, as a symbol, and the communication
2513 "List of functions applied to a transcoded keyword.
2514 Each filter is called with three arguments: the transcoded data,
2515 as a string, the back-end, as a symbol, and the communication
2519 "List of functions applied to a transcoded latex-environment.
2520 Each filter is called with three arguments: the transcoded data,
2521 as a string, the back-end, as a symbol, and the communication
2525 "List of functions applied to a transcoded node-property.
2526 Each filter is called with three arguments: the transcoded data,
2527 as a string, the back-end, as a symbol, and the communication
2531 "List of functions applied to a transcoded paragraph.
2532 Each filter is called with three arguments: the transcoded data,
2533 as a string, the back-end, as a symbol, and the communication
2537 "List of functions applied to a transcoded plain-list.
2538 Each filter is called with three arguments: the transcoded data,
2539 as a string, the back-end, as a symbol, and the communication
2543 "List of functions applied to a transcoded planning.
2544 Each filter is called with three arguments: the transcoded data,
2545 as a string, the back-end, as a symbol, and the communication
2549 "List of functions applied to a transcoded property-drawer.
2550 Each filter is called with three arguments: the transcoded data,
2551 as a string, the back-end, as a symbol, and the communication
2555 "List of functions applied to a transcoded quote block.
2556 Each filter is called with three arguments: the transcoded quote
2557 data, as a string, the back-end, as a symbol, and the
2558 communication channel, as a plist. It must return a string or
2562 "List of functions applied to a transcoded quote-section.
2563 Each filter is called with three arguments: the transcoded data,
2564 as a string, the back-end, as a symbol, and the communication
2568 "List of functions applied to a transcoded section.
2569 Each filter is called with three arguments: the transcoded data,
2570 as a string, the back-end, as a symbol, and the communication
2574 "List of functions applied to a transcoded special block.
2575 Each filter is called with three arguments: the transcoded data,
2576 as a string, the back-end, as a symbol, and the communication
2580 "List of functions applied to a transcoded src-block.
2581 Each filter is called with three arguments: the transcoded data,
2582 as a string, the back-end, as a symbol, and the communication
2586 "List of functions applied to a transcoded table.
2587 Each filter is called with three arguments: the transcoded data,
2588 as a string, the back-end, as a symbol, and the communication
2592 "List of functions applied to a transcoded table-cell.
2593 Each filter is called with three arguments: the transcoded data,
2594 as a string, the back-end, as a symbol, and the communication
2598 "List of functions applied to a transcoded table-row.
2599 Each filter is called with three arguments: the transcoded data,
2600 as a string, the back-end, as a symbol, and the communication
2604 "List of functions applied to a transcoded verse block.
2605 Each filter is called with three arguments: the transcoded data,
2606 as a string, the back-end, as a symbol, and the communication
2610 ;;;; Objects Filters
2613 "List of functions applied to transcoded bold text.
2614 Each filter is called with three arguments: the transcoded data,
2615 as a string, the back-end, as a symbol, and the communication
2619 "List of functions applied to transcoded code text.
2620 Each filter is called with three arguments: the transcoded data,
2621 as a string, the back-end, as a symbol, and the communication
2625 "List of functions applied to a transcoded entity.
2626 Each filter is called with three arguments: the transcoded data,
2627 as a string, the back-end, as a symbol, and the communication
2631 "List of functions applied to a transcoded export-snippet.
2632 Each filter is called with three arguments: the transcoded data,
2633 as a string, the back-end, as a symbol, and the communication
2637 "List of functions applied to a transcoded footnote-reference.
2638 Each filter is called with three arguments: the transcoded data,
2639 as a string, the back-end, as a symbol, and the communication
2643 "List of functions applied to a transcoded inline-babel-call.
2644 Each filter is called with three arguments: the transcoded data,
2645 as a string, the back-end, as a symbol, and the communication
2649 "List of functions applied to a transcoded inline-src-block.
2650 Each filter is called with three arguments: the transcoded data,
2651 as a string, the back-end, as a symbol, and the communication
2655 "List of functions applied to transcoded italic text.
2656 Each filter is called with three arguments: the transcoded data,
2657 as a string, the back-end, as a symbol, and the communication
2661 "List of functions applied to a transcoded latex-fragment.
2662 Each filter is called with three arguments: the transcoded data,
2663 as a string, the back-end, as a symbol, and the communication
2667 "List of functions applied to a transcoded line-break.
2668 Each filter is called with three arguments: the transcoded data,
2669 as a string, the back-end, as a symbol, and the communication
2673 "List of functions applied to a transcoded link.
2674 Each filter is called with three arguments: the transcoded data,
2675 as a string, the back-end, as a symbol, and the communication
2679 "List of functions applied to a transcoded radio-target.
2680 Each filter is called with three arguments: the transcoded data,
2681 as a string, the back-end, as a symbol, and the communication
2685 "List of functions applied to a transcoded statistics-cookie.
2686 Each filter is called with three arguments: the transcoded data,
2687 as a string, the back-end, as a symbol, and the communication
2691 "List of functions applied to transcoded strike-through text.
2692 Each filter is called with three arguments: the transcoded data,
2693 as a string, the back-end, as a symbol, and the communication
2697 "List of functions applied to a transcoded subscript.
2698 Each filter is called with three arguments: the transcoded data,
2699 as a string, the back-end, as a symbol, and the communication
2703 "List of functions applied to a transcoded superscript.
2704 Each filter is called with three arguments: the transcoded data,
2705 as a string, the back-end, as a symbol, and the communication
2709 "List of functions applied to a transcoded target.
2710 Each filter is called with three arguments: the transcoded data,
2711 as a string, the back-end, as a symbol, and the communication
2715 "List of functions applied to a transcoded timestamp.
2716 Each filter is called with three arguments: the transcoded data,
2717 as a string, the back-end, as a symbol, and the communication
2721 "List of functions applied to transcoded underline text.
2722 Each filter is called with three arguments: the transcoded data,
2723 as a string, the back-end, as a symbol, and the communication
2727 "List of functions applied to transcoded verbatim text.
2728 Each filter is called with three arguments: the transcoded data,
2729 as a string, the back-end, as a symbol, and the communication
2733 ;;;; Filters Tools
2734 ;;
2735 ;; Internal function `org-export-install-filters' installs filters
2736 ;; hard-coded in back-ends (developer filters) and filters from global
2737 ;; variables (user filters) in the communication channel.
2738 ;;
2739 ;; Internal function `org-export-filter-apply-functions' takes care
2740 ;; about applying each filter in order to a given data. It ignores
2741 ;; filters returning a nil value but stops whenever a filter returns
2742 ;; an empty string.
2745 "Call every function in FILTERS.
2747 Functions are called with arguments VALUE, current export
2748 back-end's name and INFO. A function returning a nil value will
2749 be skipped. If it returns the empty string, the process ends and
2750 VALUE is ignored.
2752 Call is done in a LIFO fashion, to be sure that developer
2753 specified filters, if any, are called first."
2763 "Install filters properties in communication channel.
2764 INFO is a plist containing the current communication channel.
2765 Return the updated communication channel."
2767 ;; Install user-defined filters with `org-export-filters-alist'
2768 ;; and filters already in INFO (through ext-plist mechanism).
2775 ;; Filters in INFO will be called
2776 ;; before those user provided.
2779 default-value)))))
2780 org-export-filters-alist)
2781 ;; Prepend back-end specific filters to that list.
2783 ;; Single values get consed, lists are appended.
2788 plist key
2792 ;; Return new communication channel.
2796 \f
2797 ;;; Core functions
2798 ;;
2799 ;; This is the room for the main function, `org-export-as', along with
2800 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2801 ;; `org-export-string-as'. They differ either by the way they output
2802 ;; the resulting code (for the first two) or by the input type (for
2803 ;; the latter). `org-export--copy-to-kill-ring-p' determines if
2804 ;; output of these function should be added to kill ring.
2805 ;;
2806 ;; `org-export-output-file-name' is an auxiliary function meant to be
2807 ;; used with `org-export-to-file'. With a given extension, it tries
2808 ;; to provide a canonical file name to write export output to.
2809 ;;
2810 ;; Note that `org-export-as' doesn't really parse the current buffer,
2811 ;; but a copy of it (with the same buffer-local variables and
2812 ;; visibility), where macros and include keywords are expanded and
2813 ;; Babel blocks are executed, if appropriate.
2814 ;; `org-export-with-buffer-copy' macro prepares that copy.
2815 ;;
2816 ;; File inclusion is taken care of by
2817 ;; `org-export-expand-include-keyword' and
2818 ;; `org-export--prepare-file-contents'. Structure wise, including
2819 ;; a whole Org file in a buffer often makes little sense. For
2820 ;; example, if the file contains a headline and the include keyword
2821 ;; was within an item, the item should contain the headline. That's
2822 ;; why file inclusion should be done before any structure can be
2823 ;; associated to the file, that is before parsing.
2824 ;;
2825 ;; `org-export-insert-default-template' is a command to insert
2826 ;; a default template (or a back-end specific template) at point or in
2827 ;; current subtree.
2830 "Return a copy of the current buffer.
2831 The copy preserves Org buffer-local variables, visibility and
2832 narrowing."
2838 new-buf))
2841 "Apply BODY in a copy of the current buffer.
2842 The copy preserves local variables, visibility and contents of
2843 the original buffer. Point is at the beginning of the buffer
2844 when BODY is applied."
2853 ;; Kill copy without confirmation.
2859 "Generate a function duplicating BUFFER.
2861 The copy will preserve local variables, visibility, contents and
2862 narrowing of the original buffer. If a region was active in
2863 BUFFER, contents will be narrowed to that region instead.
2865 The resulting function can be evaled at a later time, from
2866 another buffer, effectively cloning the original buffer there.
2868 The function assumes BUFFER's major mode is `org-mode'."
2872 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2873 ;; already in BUFFER.
2875 ;; Copy specific buffer local variables and variables set
2876 ;; through BIND keywords.
2878 vars)
2886 buffer-file-name
2887 buffer-file-coding-system))
2891 ;; Skip unreadable values, as they cannot be
2892 ;; sent to external process.
2896 vars))))))
2897 ;; Whole buffer contents.
2902 ;; Narrowing.
2906 ;; Current position of point.
2908 ;; Overlays with invisible property.
2918 ov-set))))
2920 ov-set)))))
2922 ;;;###autoload
2925 "Transcode current Org buffer into BACKEND code.
2927 BACKEND is either an export back-end, as returned by, e.g.,
2928 `org-export-create-backend', or a symbol referring to
2929 a registered back-end.
2931 If narrowing is active in the current buffer, only transcode its
2932 narrowed part.
2934 If a region is active, transcode that region.
2936 When optional argument SUBTREEP is non-nil, transcode the
2937 sub-tree at point, extracting information from the headline
2938 properties first.
2940 When optional argument VISIBLE-ONLY is non-nil, don't export
2941 contents of hidden elements.
2943 When optional argument BODY-ONLY is non-nil, only return body
2944 code, without surrounding template.
2946 Optional argument EXT-PLIST, when provided, is a property list
2947 with external parameters overriding Org default settings, but
2948 still inferior to file-local settings.
2950 Return code as a string."
2955 ;; Narrow buffer to an appropriate region or subtree for
2956 ;; parsing. If parsing subtree, be sure to remove main headline
2957 ;; too.
2965 ;; Initialize communication channel with original buffer
2966 ;; attributes, unavailable in its copy.
2974 tree)
2975 ;; Store default title in `org-export--default-title' so that
2976 ;; `org-export-get-environment' can access it from buffer's
2977 ;; copy and then add it properly to communication channel.
2979 ;; Update communication channel and get parse tree. Buffer
2980 ;; isn't parsed directly. Instead, a temporary copy is
2981 ;; created, where include keywords, macros are expanded and
2982 ;; code blocks are evaluated.
2984 ;; Run first hook with current back-end's name as argument.
2988 ;; Update macro templates since #+INCLUDE keywords might have
2989 ;; added some new ones.
2993 ;; Update radio targets since keyword inclusion might have
2994 ;; added some more.
2996 ;; Run last hook with current back-end's name as argument.
3001 ;; Update communication channel with environment. Also
3002 ;; install user's and developer's filters.
3007 ;; Expand export-specific set of macros: {{{author}}},
3008 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3009 ;; once regular macros have been expanded, since document
3010 ;; keywords may contain one of them.
3016 ;; EMAIL is not a parsed keyword: store it as-is.
3020 ;; Call options filters and update export options. We do not
3021 ;; use `org-export-filter-apply-functions' here since the
3022 ;; arity of such filters is different.
3027 ;; Parse buffer and call parse-tree filter on it.
3032 ;; Now tree is complete, compute its properties and add them
3033 ;; to communication channel.
3037 ;; Eventually transcode TREE. Wrap the resulting string into
3038 ;; a template.
3047 ;; Remove all text properties since they cannot be
3048 ;; retrieved from an external process. Finally call
3049 ;; final-output filter and return result.
3055 info))))))))
3057 ;;;###autoload
3060 "Call `org-export-as' with output to a specified buffer.
3062 BACKEND is either an export back-end, as returned by, e.g.,
3063 `org-export-create-backend', or a symbol referring to
3064 a registered back-end.
3066 BUFFER is the output buffer. If it already exists, it will be
3067 erased first, otherwise, it will be created.
3069 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3070 EXT-PLIST are similar to those used in `org-export-as', which
3071 see.
3073 Depending on `org-export-copy-to-kill-ring', add buffer contents
3074 to kill ring. Return buffer."
3081 ;; Maybe add buffer contents to kill ring.
3084 ;; Return buffer.
3085 buffer))
3087 ;;;###autoload
3090 "Call `org-export-as' with output to a specified file.
3092 BACKEND is either an export back-end, as returned by, e.g.,
3093 `org-export-create-backend', or a symbol referring to
3094 a registered back-end. FILE is the name of the output file, as
3095 a string.
3097 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3098 EXT-PLIST are similar to those used in `org-export-as', which
3099 see.
3101 Depending on `org-export-copy-to-kill-ring', add file contents
3102 to kill ring. Return output file's name."
3103 ;; Checks for FILE permissions. `write-file' would do the same, but
3104 ;; we'd rather avoid needless transcoding of parse tree.
3106 ;; Insert contents to a temporary buffer and write it to FILE.
3112 ;; Maybe add file contents to kill ring.
3115 ;; Return full path.
3116 file)
3118 ;;;###autoload
3120 "Transcode STRING into BACKEND code.
3122 BACKEND is either an export back-end, as returned by, e.g.,
3123 `org-export-create-backend', or a symbol referring to
3124 a registered back-end.
3126 When optional argument BODY-ONLY is non-nil, only return body
3127 code, without preamble nor postamble.
3129 Optional argument EXT-PLIST, when provided, is a property list
3130 with external parameters overriding Org default settings, but
3131 still inferior to file-local settings.
3133 Return code as a string."
3139 ;;;###autoload
3141 "Replace the active region by its export to BACKEND.
3142 BACKEND is either an export back-end, as returned by, e.g.,
3143 `org-export-create-backend', or a symbol referring to
3144 a registered back-end."
3154 ;;;###autoload
3156 "Insert all export keywords with default values at beginning of line.
3158 BACKEND is a symbol referring to the name of a registered export
3159 back-end, for which specific export options should be added to
3160 the template, or `default' for default template. When it is nil,
3161 the user will be prompted for a category.
3163 If SUBTREEP is non-nil, export configuration will be set up
3164 locally for the subtree through node properties."
3174 "Options category: "
3178 org-export--registered-backends))))))
3179 options keywords)
3180 ;; Populate OPTIONS and KEYWORDS.
3197 ;; Move to an appropriate location in order to insert options.
3199 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3200 ;; list of available keywords.
3228 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3247 ;; And the rest of keywords.
3258 "Return output file's name according to buffer specifications.
3260 EXTENSION is a string representing the output file extension,
3261 with the leading dot.
3263 With a non-nil optional argument SUBTREEP, try to determine
3265 of subtree at point.
3267 When optional argument PUB-DIR is set, use it as the publishing
3268 directory.
3270 When optional argument VISIBLE-ONLY is non-nil, don't export
3271 contents of hidden elements.
3273 Return file name as a string."
3276 ;; File name may come from EXPORT_FILE_NAME subtree
3277 ;; property, assuming point is at beginning of said
3278 ;; sub-tree.
3285 ;; File name may be extracted from buffer's associated
3286 ;; file, if any.
3288 ;; Can't determine file name on our own: Ask user.
3292 "Output file: " pub-dir nil nil nil
3296 ;; Build file name. Enforce EXTENSION over whatever user
3297 ;; may have come up with. PUB-DIR, if defined, always has
3298 ;; precedence over any provided path.
3303 extension))
3306 ;; If writing to OUTPUT-FILE would overwrite original file, append
3307 ;; EXTENSION another time to final name.
3310 output-file)))
3313 "Expand every include keyword in buffer.
3314 Optional argument INCLUDED is a list of included file names along
3315 with their line restriction, when appropriate. It is used to
3316 avoid infinite recursion. Optional argument DIR is the current
3317 working directory. It is used to properly resolve relative
3318 paths."
3325 ;; Extract arguments from keyword's value.
3333 dir)
3338 value)
3344 ;; Minimal level of included file defaults to the child
3345 ;; level of the current headline, if any, or one. It
3346 ;; only applies is the file is meant to be included as
3347 ;; an Org one.
3355 ;; Remove keyword.
3361 ;; Check if files has already been parsed. Look after
3362 ;; inclusion lines too, as different parts of the same file
3363 ;; can be included too.
3375 ind-str contents ind-str))))
3383 ind-str env contents ind-str))))
3396 "Prepare the contents of FILE for inclusion and return them as a string.
3398 When optional argument LINES is a string specifying a range of
3399 lines, include only those lines.
3401 Optional argument IND, when non-nil, is an integer specifying the
3402 global indentation of returned contents. Since its purpose is to
3403 allow an included file to stay in the same environment it was
3404 created \(i.e. a list item), it doesn't apply past the first
3405 headline encountered.
3407 Optional argument MINLEVEL, when non-nil, is an integer
3408 specifying the level that any top-level headline in the included
3409 file should have."
3425 ;; Remove blank lines at beginning and end of contents. The logic
3426 ;; behind that removal is that blank lines around include keyword
3427 ;; override blank lines in included file.
3436 ;; If IND is set, preserve indentation of include keyword until
3437 ;; the first headline encountered.
3444 ;; Do not move footnote definitions out of column 0.
3450 ;; When MINLEVEL is specified, compute minimal level for headlines
3451 ;; in the file (CUR-MIN), and remove stars to each headline so
3452 ;; that headlines with minimal level have a level of MINLEVEL.
3463 ;; Only change stars, don't bother moving whole
3464 ;; sections.
3471 "Execute every Babel code in the visible part of current buffer."
3472 ;; Get a pristine copy of current buffer so Babel references can be
3473 ;; properly resolved.
3480 "Return a non-nil value when output should be added to the kill ring.
3481 See also `org-export-copy-to-kill-ring'."
3487 \f
3488 ;;; Tools For Back-Ends
3489 ;;
3490 ;; A whole set of tools is available to help build new exporters. Any
3491 ;; function general enough to have its use across many back-ends
3492 ;; should be added here.
3494 ;;;; For Affiliated Keywords
3495 ;;
3496 ;; `org-export-read-attribute' reads a property from a given element
3497 ;; as a plist. It can be used to normalize affiliated keywords'
3498 ;; syntax.
3499 ;;
3500 ;; Since captions can span over multiple lines and accept dual values,
3501 ;; their internal representation is a bit tricky. Therefore,
3502 ;; `org-export-get-caption' transparently returns a given element's
3503 ;; caption as a secondary string.
3506 "Turn ATTRIBUTE property from ELEMENT into a plist.
3508 When optional argument PROPERTY is non-nil, return the value of
3509 that property within attributes.
3513 properties.
3515 All values will become strings except the empty string and
3518 will become the empty string."
3532 s)
3537 ;; Ignore any string before first property with `cdr'.
3542 "Return caption from ELEMENT as a secondary string.
3544 When optional argument SHORTP is non-nil, return short caption,
3545 as a secondary string, instead.
3547 Caption lines are separated by a white space."
3555 ;;;; For Derived Back-ends
3556 ;;
3557 ;; `org-export-with-backend' is a function allowing to locally use
3558 ;; another back-end to transcode some object or element. In a derived
3559 ;; back-end, it may be used as a fall-back function once all specific
3560 ;; cases have been treated.
3563 "Call a transcoder from BACKEND on DATA.
3564 BACKEND is an export back-end, as returned by, e.g.,
3565 `org-export-create-backend', or a symbol referring to
3566 a registered back-end. DATA is an Org element, object, secondary
3567 string or string. CONTENTS, when non-nil, is the transcoded
3568 contents of DATA element, as a string. INFO, when non-nil, is
3569 the communication channel used for export, as a plist."
3580 ;;;; For Export Snippets
3581 ;;
3582 ;; Every export snippet is transmitted to the back-end. Though, the
3583 ;; latter will only retain one type of export-snippet, ignoring
3584 ;; others, based on the former's target back-end. The function
3585 ;; `org-export-snippet-backend' returns that back-end for a given
3586 ;; export-snippet.
3589 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3590 Translation, with `org-export-snippet-translation-alist', is
3591 applied."
3595 back-end))))
3598 ;;;; For Footnotes
3599 ;;
3600 ;; `org-export-collect-footnote-definitions' is a tool to list
3601 ;; actually used footnotes definitions in the whole parse tree, or in
3602 ;; a headline, in order to add footnote listings throughout the
3603 ;; transcoded data.
3604 ;;
3605 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3606 ;; back-ends, when they need to attach the footnote definition only to
3607 ;; the first occurrence of the corresponding label.
3608 ;;
3609 ;; `org-export-get-footnote-definition' and
3610 ;; `org-export-get-footnote-number' provide easier access to
3611 ;; additional information relative to a footnote reference.
3614 "Return an alist between footnote numbers, labels and definitions.
3616 DATA is the parse tree from which definitions are collected.
3617 INFO is the plist used as a communication channel.
3619 Definitions are sorted by order of references. They either
3620 appear as Org data or as a secondary string for inlined
3621 footnotes. Unreferenced definitions are ignored."
3623 collect-fn ; for byte-compiler.
3627 ;; Collect footnote number, label and definition in DATA.
3635 def)
3636 num-alist)
3637 ;; Also search in definition for nested footnotes.
3640 ;; Don't enter footnote definitions since it will happen
3641 ;; when their first reference is found.
3647 "Non-nil when a footnote reference is the first one for its label.
3649 FOOTNOTE-REFERENCE is the footnote reference being considered.
3650 INFO is the plist used as a communication channel."
3652 ;; Anonymous footnotes are always a first reference.
3654 ;; Otherwise, return the first footnote with the same LABEL and
3655 ;; test if it is equal to FOOTNOTE-REFERENCE.
3665 ;; If FN isn't inlined, be sure to traverse its
3666 ;; definition before resuming search. See
3667 ;; comments in `org-export-get-footnote-number'
3668 ;; for more information.
3672 ;; Don't enter footnote definitions since it will
3673 ;; happen when their first reference is found.
3676 footnote-reference)))))
3679 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3680 INFO is the plist used as a communication channel. If no such
3682 string."
3689 "Return number associated to a footnote.
3691 FOOTNOTE is either a footnote reference or a footnote definition.
3692 INFO is the plist used as a communication channel."
3694 seen-refs
3695 search-ref ; For byte-compiler.
3699 ;; Search footnote references through DATA, filling
3700 ;; SEEN-REFS along the way.
3705 ;; Anonymous footnote match: return number.
3708 ;; Labels match: return number.
3711 ;; Anonymous footnote: it's always a new one.
3712 ;; Also, be sure to return nil from the `cond' so
3713 ;; `first-match' doesn't get us out of the loop.
3715 ;; Label not seen so far: add it so SEEN-REFS.
3716 ;;
3717 ;; Also search for subsequent references in
3718 ;; footnote definition so numbering follows
3719 ;; reading logic. Note that we don't have to care
3720 ;; about inline definitions, since
3721 ;; `org-element-map' already traverses them at the
3722 ;; right time.
3723 ;;
3724 ;; Once again, return nil to stay in the loop.
3729 nil))))
3730 ;; Don't enter footnote definitions since it will
3731 ;; happen when their first reference is found.
3736 ;;;; For Headlines
3737 ;;
3738 ;; `org-export-get-relative-level' is a shortcut to get headline
3739 ;; level, relatively to the lower headline level in the parsed tree.
3740 ;;
3741 ;; `org-export-get-headline-number' returns the section number of an
3742 ;; headline, while `org-export-number-to-roman' allows to convert it
3743 ;; to roman numbers.
3744 ;;
3745 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3746 ;; `org-export-last-sibling-p' are three useful predicates when it
3747 ;; comes to fulfill the `:headline-levels' property.
3748 ;;
3749 ;; `org-export-get-tags', `org-export-get-category' and
3750 ;; `org-export-get-node-property' extract useful information from an
3751 ;; headline or a parent headline. They all handle inheritance.
3752 ;;
3753 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3754 ;; as a secondary string, suitable for table of contents. It falls
3755 ;; back onto default title.
3758 "Return HEADLINE relative level within current parsed tree.
3759 INFO is a plist holding contextual information."
3764 "Non-nil when HEADLINE is considered as low level.
3766 INFO is a plist used as a communication channel.
3768 A low level headlines has a relative level greater than
3769 `:headline-levels' property value.
3771 Return value is the difference between HEADLINE relative level
3772 and the last level being considered as high enough, or nil."
3779 "Return HEADLINE numbering as a list of numbers.
3780 INFO is a plist holding contextual information."
3784 "Return a non-nil value if HEADLINE element should be numbered.
3785 INFO is a plist used as a communication channel."
3791 "Convert integer N into a roman numeral."
3804 res)))
3807 "Return list of tags associated to ELEMENT.
3809 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3810 is a plist used as a communication channel.
3812 Select tags (see `org-export-select-tags') and exclude tags (see
3813 `org-export-exclude-tags') are removed from the list.
3815 When non-nil, optional argument TAGS should be a list of strings.
3816 Any tag belonging to this list will also be removed.
3818 When optional argument INHERITED is non-nil, tags can also be
3819 inherited from parent headlines and FILETAGS keywords."
3825 ;; Build complete list of inherited tags.
3836 ;; Add FILETAGS keywords and return results.
3840 "Return node PROPERTY value for BLOB.
3842 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3843 element or object.
3845 If optional argument INHERITED is non-nil, the value can be
3846 inherited from a parent headline.
3848 Return value is a string or nil."
3860 "Return category for element or object BLOB.
3862 INFO is a plist used as a communication channel.
3864 CATEGORY is automatically inherited from a parent headline, from
3865 #+CATEGORY: keyword or created out of original file name. If all
3869 ;; Almost like `org-export-node-property', but we cannot trust
3870 ;; `plist-member' as every headline has a `:CATEGORY'
3871 ;; property, would it be nil or equal to "???" (which has the
3872 ;; same meaning).
3890 "Return alternative title for HEADLINE, as a secondary string.
3891 INFO is a plist used as a communication channel. If no optional
3892 title is defined, fall-back to the regular title."
3897 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3898 INFO is a plist used as a communication channel."
3903 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3904 INFO is a plist used as a communication channel."
3908 ;;;; For Keywords
3909 ;;
3910 ;; `org-export-get-date' returns a date appropriate for the document
3911 ;; to about to be exported. In particular, it takes care of
3912 ;; `org-export-date-timestamp-format'.
3915 "Return date value for the current document.
3917 INFO is a plist used as a communication channel. FMT, when
3918 non-nil, is a time format string that will be applied on the date
3919 if it consists in a single timestamp object. It defaults to
3920 `org-export-date-timestamp-format' when nil.
3922 A proper date can be a secondary string, a string or nil. It is
3923 meant to be translated with `org-export-data' or alike."
3934 ;;;; For Links
3935 ;;
3936 ;; `org-export-solidify-link-text' turns a string into a safer version
3937 ;; for links, replacing most non-standard characters with hyphens.
3938 ;;
3939 ;; `org-export-get-coderef-format' returns an appropriate format
3940 ;; string for coderefs.
3941 ;;
3942 ;; `org-export-inline-image-p' returns a non-nil value when the link
3943 ;; provided should be considered as an inline image.
3944 ;;
3945 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3946 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3947 ;; returns an appropriate unique identifier when found, or nil.
3948 ;;
3949 ;; `org-export-resolve-id-link' returns the first headline with
3950 ;; specified id or custom-id in parse tree, the path to the external
3951 ;; file with the id or nil when neither was found.
3952 ;;
3953 ;; `org-export-resolve-coderef' associates a reference to a line
3954 ;; number in the element it belongs, or returns the reference itself
3955 ;; when the element isn't numbered.
3958 "Take link text S and make a safe target out of it."
3963 "Return format string for code reference link.
3964 PATH is the link path. DESC is its description."
3972 "Non-nil if LINK object points to an inline image.
3974 Optional argument is a set of RULES defining inline images. It
3975 is an alist where associations have the following shape:
3977 \(TYPE . REGEXP)
3979 Applying a rule means apply REGEXP against LINK's path when its
3980 type is TYPE. The function will return a non-nil value if any of
3981 the provided rules is non-nil. The default rule is
3982 `org-export-default-inline-image-rule'.
3984 This only applies to links without a description."
3995 rules)
3996 ;; Return nil if no rule matched.
3997 nil))))
4000 "Resolve a code reference REF.
4002 INFO is a plist used as a communication channel.
4004 Return associated line number in source code, or REF itself,
4005 depending on src-block or example element's switches."
4012 org-coderef-label-format)))
4016 ;; Element containing REF is found. Resolve it to either
4017 ;; a label or a line number, as needed.
4027 "Return LINK destination.
4029 INFO is a plist holding contextual information.
4031 Return value can be an object, an element, or nil:
4033 - If LINK path matches a target object (i.e. <<path>>) return it.
4035 - If LINK path exactly matches the name affiliated keyword
4036 \(i.e. #+NAME: path) of an element, return that element.
4038 - If LINK path exactly matches any headline name, return that
4039 element. If more than one headline share that name, priority
4040 will be given to the one with the closest common ancestor, if
4041 any, or the first one in the parse tree otherwise.
4043 - Otherwise, return nil.
4046 significant."
4049 ;; Split PATH at white spaces so matches are space
4050 ;; insensitive.
4053 ;; Cache for destinations that are not position dependent.
4061 ;; Destination is not position dependent: use cached value.
4063 ;; First try to find a matching "<<path>>" unless user specified
4064 ;; he was looking for a headline (path starts with a "*"
4065 ;; character).
4071 path)
4072 blob))
4075 ;; Then try to find an element with a matching "#+NAME: path"
4076 ;; affiliated keyword.
4079 org-element-all-elements
4084 el)))
4087 ;; Last case: link either points to a headline or to nothingness.
4088 ;; Try to find the source, with priority given to headlines with
4089 ;; the closest common ancestor. If such candidate is found,
4090 ;; return it, otherwise return nil.
4094 ;; Return first headline whose `:raw-value' property is
4095 ;; NAME in parse tree DATA, or nil. Statistics cookies
4096 ;; are ignored.
4104 name)
4105 headline))
4107 ;; Search among headlines sharing an ancestor with link, from
4108 ;; closest to farthest.
4117 ;; No destination found: return nil.
4121 "Return headline referenced as LINK destination.
4123 INFO is a plist used as a communication channel.
4125 Return value can be the headline element matched in current parse
4129 ;; First check if id is within the current parse tree.
4134 headline))
4136 ;; Otherwise, look for external files.
4140 "Return radio-target object referenced as LINK destination.
4142 INFO is a plist used as a communication channel.
4144 Return value can be a radio-target object or nil. Assume LINK
4153 nil nil path nil nil t)
4154 t)
4155 radio))
4159 ;;;; For References
4160 ;;
4161 ;; `org-export-get-ordinal' associates a sequence number to any object
4162 ;; or element.
4165 "Return ordinal number of an element or object.
4167 ELEMENT is the element or object considered. INFO is the plist
4168 used as a communication channel.
4170 Optional argument TYPES, when non-nil, is a list of element or
4171 object types, as symbols, that should also be counted in.
4172 Otherwise, only provided element's type is considered.
4174 Optional argument PREDICATE is a function returning a non-nil
4175 value if the current element or object should be counted in. It
4176 accepts two arguments: the element or object being considered and
4177 the plist used as a communication channel. This allows to count
4178 only a certain type of objects (i.e. inline images).
4180 Return value is a list of numbers if ELEMENT is a headline or an
4181 item. It is nil for keywords. It represents the footnote number
4182 for footnote definitions and footnote references. If ELEMENT is
4183 a target, return the same value as if ELEMENT was the closest
4184 table, item or headline containing the target. In any other
4185 case, return the sequence number of ELEMENT among elements or
4186 objects of the same type."
4187 ;; Ordinal of a target object refer to the ordinal of the closest
4188 ;; table, item, or headline containing the object.
4192 when
4196 table))
4197 return parent)))
4199 ;; Special case 1: A headline returns its number as a list.
4201 ;; Special case 2: An item returns its number as a list.
4205 struct
4212 ;; Increment counter until ELEMENT is found again.
4223 ;;;; For Src-Blocks
4224 ;;
4225 ;; `org-export-get-loc' counts number of code lines accumulated in
4226 ;; src-block or example-block elements with a "+n" switch until
4227 ;; a given element, excluded. Note: "-n" switches reset that count.
4228 ;;
4229 ;; `org-export-unravel-code' extracts source code (along with a code
4230 ;; references alist) from an `element-block' or `src-block' type
4231 ;; element.
4232 ;;
4233 ;; `org-export-format-code' applies a formatting function to each line
4234 ;; of code, providing relative line number and code reference when
4235 ;; appropriate. Since it doesn't access the original element from
4236 ;; which the source code is coming, it expects from the code calling
4237 ;; it to know if lines should be numbered and if code references
4238 ;; should appear.
4239 ;;
4240 ;; Eventually, `org-export-format-code-default' is a higher-level
4241 ;; function (it makes use of the two previous functions) which handles
4242 ;; line numbering and code references inclusion, and returns source
4243 ;; code in a format suitable for plain text or verbatim output.
4246 "Return accumulated lines of code up to ELEMENT.
4248 INFO is the plist used as a communication channel.
4250 ELEMENT is excluded from count."
4256 ;; ELEMENT is reached: Quit the loop.
4258 ;; Only count lines from src-block and example-block elements
4259 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4263 ;; Accumulate locs or reset them.
4267 ;; Return nil to stay in the loop.
4268 nil)))
4270 ;; Return value.
4271 loc))
4274 "Clean source code and extract references out of it.
4276 ELEMENT has either a `src-block' an `example-block' type.
4278 Return a cons cell whose CAR is the source code, cleaned from any
4279 reference and protective comma and CDR is an alist between
4280 relative line number (integer) and name of code reference on that
4281 line (string)."
4283 ;; Get code and clean it. Remove blank lines at its
4284 ;; beginning and end.
4290 ;; Get format used for references.
4293 org-coderef-label-format)))
4294 ;; Build a regexp matching a loc with a reference.
4299 ;; Return value.
4301 ;; Code with references removed.
4307 ;; Ref line: remove ref, and signal its position in REFS.
4311 ;; Reference alist.
4312 refs)))
4315 "Format CODE by applying FUN line-wise and return it.
4317 CODE is a string representing the code to format. FUN is
4318 a function. It must accept three arguments: a line of
4319 code (string), the current line number (integer) or nil and the
4320 reference associated to the current line (string) or nil.
4322 Optional argument NUM-LINES can be an integer representing the
4323 number of code lines accumulated until the current code. Line
4324 numbers passed to FUN will take it into account. If it is nil,
4325 FUN's second argument will always be nil. This number can be
4326 obtained with `org-export-get-loc' function.
4328 Optional argument REF-ALIST can be an alist between relative line
4329 number (i.e. ignoring NUM-LINES) and the name of the code
4330 reference on it. If it is nil, FUN's third argument will always
4331 be nil. It can be obtained through the use of
4332 `org-export-unravel-code' function."
4344 "Return source code from ELEMENT, formatted in a standard way.
4346 ELEMENT is either a `src-block' or `example-block' element. INFO
4347 is a plist used as a communication channel.
4349 This function takes care of line numbering and code references
4350 inclusion. Line numbers, when applicable, appear at the
4351 beginning of the line, separated from the code by two white
4352 spaces. Code references, on the other hand, appear flushed to
4353 the right, separated by six white spaces from the widest line of
4354 code."
4355 ;; Extract code and references.
4362 ;; Handle line numbering.
4371 ;; Prepare references display, if required. Any reference
4372 ;; should start six columns after the widest line of code,
4373 ;; wrapped with parenthesis.
4378 code
4382 number-str
4383 loc
4389 num-start refs)))))
4392 ;;;; For Tables
4393 ;;
4394 ;; `org-export-table-has-special-column-p' and and
4395 ;; `org-export-table-row-is-special-p' are predicates used to look for
4396 ;; meta-information about the table structure.
4397 ;;
4398 ;; `org-table-has-header-p' tells when the rows before the first rule
4399 ;; should be considered as table's header.
4400 ;;
4401 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4402 ;; and `org-export-table-cell-borders' extract information from
4403 ;; a table-cell element.
4404 ;;
4405 ;; `org-export-table-dimensions' gives the number on rows and columns
4406 ;; in the table, ignoring horizontal rules and special columns.
4407 ;; `org-export-table-cell-address', given a table-cell object, returns
4408 ;; the absolute address of a cell. On the other hand,
4409 ;; `org-export-get-table-cell-at' does the contrary.
4410 ;;
4411 ;; `org-export-table-cell-starts-colgroup-p',
4412 ;; `org-export-table-cell-ends-colgroup-p',
4413 ;; `org-export-table-row-starts-rowgroup-p',
4414 ;; `org-export-table-row-ends-rowgroup-p',
4415 ;; `org-export-table-row-starts-header-p' and
4416 ;; `org-export-table-row-ends-header-p' indicate position of current
4417 ;; row or cell within the table.
4420 "Non-nil when TABLE has a special column.
4421 All special columns will be ignored during export."
4422 ;; The table has a special column when every first cell of every row
4423 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4424 ;; "*" "_" and "^". Though, do not consider a first row containing
4425 ;; only empty cells as special.
4441 "Non-nil when TABLE has a header.
4443 INFO is a plist used as a communication channel.
4445 A table has a header when it contains at least two row groups."
4454 table
4465 cache)))))
4468 "Non-nil if TABLE-ROW is considered special.
4470 INFO is a plist used as the communication channel.
4472 All special rows will be ignored during export."
4476 ;; A row is special either when...
4478 ;; ... it starts with a field only containing "/",
4480 ;; ... the table contains a special column and the row start
4481 ;; with a marking character among, "^", "_", "$" or "!",
4485 ;; ... it contains only alignment cookies and empty cells.
4491 ;; Since VALUE is a secondary string, the following
4492 ;; checks avoid expanding it with `org-export-data'.
4504 "Return TABLE-ROW's group number, as an integer.
4506 INFO is a plist used as the communication channel.
4508 Return value is the group number, as an integer, or nil for
4509 special rows and rows separators. First group is also table's
4510 header."
4528 "Return TABLE-CELL contents width.
4530 INFO is a plist used as the communication channel.
4532 Return value is the width given by the last width cookie in the
4533 same column as TABLE-CELL, or nil."
4550 ;; In a special row, try to find a width cookie at COLUMN.
4554 ;; The following checks avoid expanding unnecessarily
4555 ;; the cell with `org-export-data'.
4565 "Return TABLE-CELL contents alignment.
4567 INFO is a plist used as the communication channel.
4569 Return alignment as specified by the last alignment cookie in the
4570 same column as TABLE-CELL. If no such cookie is found, a default
4571 alignment value will be deduced from fraction of numbers in the
4572 column (see `org-table-number-fraction' for more information).
4573 Possible values are `left', `right' and `center'."
4586 cookie-align
4587 previous-cell-number-p)
4590 ;; In a special row, try to find an alignment cookie at
4591 ;; COLUMN.
4595 ;; Since VALUE is a secondary string, the following
4596 ;; checks avoid useless expansion through
4597 ;; `org-export-data'.
4605 ;; Ignore table rules.
4607 ;; In a standard row, check if cell's contents are
4608 ;; expressing some kind of number. Increase NUMBER-CELLS
4609 ;; accordingly. Though, don't bother if an alignment
4610 ;; cookie has already defined cell's alignment.
4615 info)))
4617 ;; Treat an empty cell as a number if it follows
4618 ;; a number.
4624 ;; Return value. Alignment specified by cookies has
4625 ;; precedence over alignment deduced from cell's contents.
4631 org-table-number-fraction)
4634 cache)))))
4637 "Return TABLE-CELL borders.
4639 INFO is a plist used as a communication channel.
4641 Return value is a list of symbols, or nil. Possible values are:
4642 `top', `bottom', `above', `below', `left' and `right'. Note:
4643 `top' (resp. `bottom') only happen for a cell in the first
4644 row (resp. last row) of the table, ignoring table rules, if any.
4646 Returned borders ignore special rows."
4649 borders)
4650 ;; Top/above border? TABLE-CELL has a border above when a rule
4651 ;; used to demarcate row groups can be found above. Hence,
4652 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4653 ;; another regular row has to be found above that rule.
4662 ;; Look at every row before the current one.
4664 ;; No rule above, or rule found starts the table (ignoring any
4665 ;; special row): TABLE-CELL is at the top of the table.
4668 ;; Bottom/below border? TABLE-CELL has a border below when next
4669 ;; non-regular row below is a rule.
4678 ;; Look at every row after the current one.
4680 ;; No rule below, or rule found ends the table (modulo some
4681 ;; special row): TABLE-CELL is at the bottom of the table.
4684 ;; Right/left borders? They can only be specified by column
4685 ;; groups. Column groups are defined in a row starting with "/".
4686 ;; Also a column groups row only contains "<", "<>", ">" or blank
4687 ;; cells.
4704 ;; There's a left border when previous cell, if
4705 ;; any, ends a group, or current one starts one.
4711 ;; There's a right border when next cell, if any,
4712 ;; starts a group, or current one ends one.
4719 ;; Table rows are read in reverse order so last column groups
4720 ;; row has precedence over any previous one.
4722 ;; Return value.
4723 borders))
4726 "Non-nil when TABLE-CELL is at the beginning of a row group.
4727 INFO is a plist used as a communication channel."
4728 ;; A cell starts a column group either when it is at the beginning
4729 ;; of a row (or after the special column, if any) or when it has
4730 ;; a left border.
4733 table-cell)
4737 "Non-nil when TABLE-CELL is at the end of a row group.
4738 INFO is a plist used as a communication channel."
4739 ;; A cell ends a column group either when it is at the end of a row
4740 ;; or when it has a right border.
4743 table-cell)
4747 "Non-nil when TABLE-ROW is at the beginning of a column group.
4748 INFO is a plist used as a communication channel."
4756 "Non-nil when TABLE-ROW is at the end of a column group.
4757 INFO is a plist used as a communication channel."
4765 "Non-nil when TABLE-ROW is the first table header's row.
4766 INFO is a plist used as a communication channel."
4773 "Non-nil when TABLE-ROW is the last table header's row.
4774 INFO is a plist used as a communication channel."
4781 "Return TABLE-ROW number.
4782 INFO is a plist used as a communication channel. Return value is
4783 zero-based and ignores separators. The function returns nil for
4784 special colums and separators."
4796 "Return TABLE dimensions.
4798 INFO is a plist used as a communication channel.
4800 Return value is a CONS like (ROWS . COLUMNS) where
4801 ROWS (resp. COLUMNS) is the number of exportable
4802 rows (resp. columns)."
4804 ;; Set number of rows, and extract first one.
4810 ;; Set number of columns.
4812 ;; Return value.
4816 "Return address of a regular TABLE-CELL object.
4818 TABLE-CELL is the cell considered. INFO is a plist used as
4819 a communication channel.
4821 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4822 zero-based index. Only exportable cells are considered. The
4823 function returns nil for other cells."
4835 "Return regular table-cell object at ADDRESS in TABLE.
4837 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4838 zero-based index. TABLE is a table type element. INFO is
4839 a plist used as a communication channel.
4841 If no table-cell, among exportable cells, is found at ADDRESS,
4842 return nil."
4845 ;; Row at (car address) or nil.
4853 'table-cell
4860 ;;;; For Tables Of Contents
4861 ;;
4862 ;; `org-export-collect-headlines' builds a list of all exportable
4863 ;; headline elements, maybe limited to a certain depth. One can then
4864 ;; easily parse it and transcode it.
4865 ;;
4866 ;; Building lists of tables, figures or listings is quite similar.
4867 ;; Once the generic function `org-export-collect-elements' is defined,
4868 ;; `org-export-collect-tables', `org-export-collect-figures' and
4869 ;; `org-export-collect-listings' can be derived from it.
4872 "Collect headlines in order to build a table of contents.
4874 INFO is a plist used as a communication channel.
4876 When optional argument N is an integer, it specifies the depth of
4877 the table of contents. Otherwise, it is set to the value of the
4878 last headline level. See `org-export-headline-levels' for more
4879 information.
4881 Return a list of all exportable headlines as parsed elements.
4882 Footnote sections, if any, will be ignored."
4887 ;; Strip contents from HEADLINE.
4890 info))
4893 "Collect referenceable elements of a determined type.
4895 TYPE can be a symbol or a list of symbols specifying element
4896 types to search. Only elements with a caption are collected.
4898 INFO is a plist used as a communication channel.
4900 When non-nil, optional argument PREDICATE is a function accepting
4901 one argument, an element of type TYPE. It returns a non-nil
4902 value when that element should be collected.
4904 Return a list of all elements found, in order of appearance."
4909 element))
4910 info))
4913 "Build a list of tables.
4914 INFO is a plist used as a communication channel.
4916 Return a list of table elements with a caption."
4920 "Build a list of figures.
4922 INFO is a plist used as a communication channel. PREDICATE is
4923 a function which accepts one argument: a paragraph element and
4924 whose return value is non-nil when that element should be
4925 collected.
4927 A figure is a paragraph type element, with a caption, verifying
4929 a vague concept that may depend on back-end.
4931 Return a list of elements recognized as figures."
4935 "Build a list of src blocks.
4937 INFO is a plist used as a communication channel.
4939 Return a list of src-block elements with a caption."
4943 ;;;; Smart Quotes
4944 ;;
4945 ;; The main function for the smart quotes sub-system is
4946 ;; `org-export-activate-smart-quotes', which replaces every quote in
4947 ;; a given string from the parse tree with its "smart" counterpart.
4948 ;;
4949 ;; Dictionary for smart quotes is stored in
4950 ;; `org-export-smart-quotes-alist'.
4951 ;;
4952 ;; Internally, regexps matching potential smart quotes (checks at
4953 ;; string boundaries are also necessary) are defined in
4954 ;; `org-export-smart-quotes-regexps'.
4958 ;; one may use: »...«, "...", ›...‹, or '...'.
4959 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4960 ;; LaTeX quotes require Babel!
5005 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5014 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5023 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5032 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5038 )
5039 "Smart quotes translations.
5041 Alist whose CAR is a language string and CDR is an alist with
5042 quote type as key and a plist associating various encodings to
5043 their translation as value.
5045 A quote type can be any symbol among `opening-double-quote',
5046 `closing-double-quote', `opening-single-quote',
5047 `closing-single-quote' and `apostrophe'.
5049 Valid encodings include `:utf-8', `:html', `:latex' and
5050 `:texinfo'.
5056 ;; Possible opening quote at beginning of string.
5058 ;; Possible closing quote at beginning of string.
5060 ;; Possible apostrophe at beginning of string.
5062 ;; Opening single and double quotes.
5064 ;; Closing single and double quotes.
5066 ;; Apostrophe.
5068 ;; Possible opening quote at end of string.
5070 ;; Possible closing quote at end of string.
5072 ;; Possible apostrophe at end of string.
5074 "List of regexps matching a quote or an apostrophe.
5080 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5081 `:utf-8'. INFO is a plist used as a communication channel.
5083 The function has to retrieve information about string
5084 surroundings in parse tree. It can only happen with an
5085 unmodified string. Thus, if S has already been through another
5086 process, a non-nil ORIGINAL optional argument will provide that
5087 original string.
5089 Return the new string."
5092 ;; Try to be flexible when computing number of blanks
5093 ;; before object. The previous object may be a string
5094 ;; introduced by the back-end and not completely parsed.
5097 ;; A string with missing `:post-blank'
5098 ;; property.
5102 ;; Fallback value.
5107 ;; Return smart quote associated to a give quote Q, as
5108 ;; a string. TYPE is a symbol among `open', `close' and
5109 ;; `apostrophe'.
5119 org-export-smart-quotes-alist))))
5120 encoding)
5121 q)))))
5123 ;; Only a quote: no regexp can match. We have to check both
5124 ;; sides and decide what to do.
5132 ;; 1. Replace quote character at the beginning of S.
5134 ;; Apostrophe?
5140 ;; Closing quote?
5146 ;; Opening quote?
5152 ;; 2. Replace quotes in the middle of the string.
5154 ;; Opening quotes.
5160 ;; Closing quotes.
5166 ;; Apostrophes.
5171 ;; 3. Replace quote character at the end of S.
5173 ;; Apostrophe?
5178 ;; Closing quote?
5184 ;; Opening quote?
5189 ;; Return string with smart quotes.
5190 s))))
5192 ;;;; Topology
5193 ;;
5194 ;; Here are various functions to retrieve information about the
5195 ;; neighbourhood of a given element or object. Neighbours of interest
5196 ;; are direct parent (`org-export-get-parent'), parent headline
5197 ;; (`org-export-get-parent-headline'), first element containing an
5198 ;; object, (`org-export-get-parent-element'), parent table
5199 ;; (`org-export-get-parent-table'), previous element or object
5200 ;; (`org-export-get-previous-element') and next element or object
5201 ;; (`org-export-get-next-element').
5202 ;;
5203 ;; `org-export-get-genealogy' returns the full genealogy of a given
5204 ;; element or object, from closest parent to full parse tree.
5207 "Return BLOB parent or nil.
5208 BLOB is the element or object considered."
5212 "Return full genealogy relative to a given element or object.
5214 BLOB is the element or object being considered.
5216 Ancestors are returned from closest to farthest, the last one
5217 being the full parse tree."
5224 "Return BLOB parent headline or nil.
5225 BLOB is the element or object being considered."
5229 parent))
5232 "Return first element containing OBJECT or nil.
5233 OBJECT is the object to consider."
5237 parent))
5240 "Return OBJECT parent table or nil.
5241 OBJECT is either a `table-cell' or `table-element' type object."
5245 parent))
5248 "Return previous element or object.
5250 BLOB is an element or object. INFO is a plist used as
5251 a communication channel. Return previous exportable element or
5252 object, a string, or nil.
5254 When optional argument N is a positive integer, return a list
5255 containing up to N siblings before BLOB, from farthest to
5256 closest. With any other non-nil value, return a list containing
5257 all of them."
5259 ;; An object can belong to the contents of its parent or
5260 ;; to a secondary string. We check the latter option
5261 ;; first.
5264 org-element-all-elements))
5268 org-element-secondary-value-alist))
5269 parent)))
5272 prev)
5281 prev)))
5284 "Return next element or object.
5286 BLOB is an element or object. INFO is a plist used as
5287 a communication channel. Return next exportable element or
5288 object, a string, or nil.
5290 When optional argument N is a positive integer, return a list
5291 containing up to N siblings after BLOB, from closest to farthest.
5292 With any other non-nil value, return a list containing all of
5293 them."
5295 ;; An object can belong to the contents of its parent or to
5296 ;; a secondary string. We check the latter option first.
5299 org-element-all-objects))
5303 org-element-secondary-value-alist))
5304 parent)))
5307 next)
5315 siblings)
5319 ;;;; Translation
5320 ;;
5321 ;; `org-export-translate' translates a string according to language
5322 ;; specified by LANGUAGE keyword or `org-export-language-setup'
5323 ;; variable and a specified charset. `org-export-dictionary' contains
5324 ;; the dictionary used for the translation.
5508 "Dictionary for export engine.
5510 Alist whose CAR is the string to translate and CDR is an alist
5511 whose CAR is the language string and CDR is a plist whose
5512 properties are possible charsets and values translated terms.
5514 It is used as a database for `org-export-translate'. Since this
5515 function returns the string as-is if no translation was found,
5516 the variable only needs to record values different from the
5520 "Translate string S according to language specification.
5522 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5523 and `:utf-8'. INFO is a plist used as a communication channel.
5525 Translation depends on `:language' property. Return the
5526 translated string. If no translation is found, try to fall back
5527 to `:default' encoding. If it fails, return S."
5533 s)))
5536 \f
5537 ;;; Asynchronous Export
5538 ;;
5539 ;; `org-export-async-start' is the entry point for asynchronous
5540 ;; export. It recreates current buffer (including visibility,
5541 ;; narrowing and visited file) in an external Emacs process, and
5542 ;; evaluates a command there. It then applies a function on the
5543 ;; returned results in the current process.
5544 ;;
5545 ;; Asynchronously generated results are never displayed directly.
5546 ;; Instead, they are stored in `org-export-stack-contents'. They can
5547 ;; then be retrieved by calling `org-export-stack'.
5548 ;;
5549 ;; Export Stack is viewed through a dedicated major mode
5550 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5551 ;;`org-export-stack-delete', `org-export-stack-view' and
5552 ;;`org-export-stack-clear'.
5553 ;;
5554 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5555 ;; It should used whenever `org-export-async-start' is called.
5558 "Call function FUN on the results returned by BODY evaluation.
5560 BODY evaluation happens in an asynchronous process, from a buffer
5561 which is an exact copy of the current one.
5563 Use `org-export-add-to-stack' in FUN in order to register results
5564 in the stack. Examples for, respectively a temporary buffer and
5565 a file are:
5567 \(org-export-async-start
5568 \(lambda (output)
5570 \(erase-buffer)
5571 \(insert output)
5572 \(goto-char (point-min))
5573 \(org-export-add-to-stack (current-buffer) 'backend)))
5574 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5576 and
5578 \(org-export-async-start
5579 \(lambda (f) (org-export-add-to-stack f 'backend))
5580 `(expand-file-name
5581 \(org-export-to-file
5582 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5585 ;; Write the full sexp evaluating BODY in a copy of the current
5586 ;; buffer to a temporary file, as it may be too long for program
5587 ;; args in `start-process'.
5594 ;; Null characters (from variable values) are inserted
5595 ;; within the file. As a consequence, coding system for
5596 ;; buffer contents will not be recognized properly. So,
5597 ;; we make sure it is the same as the one used to display
5598 ;; the original buffer.
5600 ,coding
5603 ;; Ignore `kill-emacs-hook' and code evaluation
5604 ;; queries from Babel as we need a truly
5605 ;; non-interactive process.
5607 org-babel-confirm-evaluate-answer-no t)
5608 ;; Initialize export framework.
5610 ;; Re-create current buffer there.
5613 ;; Sexp to evaluate in the buffer.
5615 ;; Start external process.
5618 (,process
5623 "-l" org-export-async-init-file
5625 ;; Register running process in stack.
5627 ;; Set-up sentinel in order to catch results.
5629 ,process
5653 "Add a new result to export stack if not present already.
5655 SOURCE is a buffer or a file name containing export results.
5656 BACKEND is a symbol representing export back-end used to generate
5657 it.
5659 Entries already pointing to SOURCE and unavailable entries are
5660 removed beforehand. Return the new stack."
5666 "Menu for asynchronous export results and running processes."
5676 "Return source from export results at point in stack."
5683 source
5684 ;; SOURCE is not consistent with current line. The stack
5685 ;; view is outdated.
5689 "Remove all entries from export stack."
5694 "Refresh the asynchronous export stack.
5695 DUMMY is ignored. Unavailable sources are removed from the list.
5696 Return the new stack."
5706 ;; Back-end.
5708 ;; Age.
5711 ;; Compute age of the results.
5713 "%4h:%.2m "
5715 ;; Source.
5720 ;; Clear stack from exited processes, dead buffers or
5721 ;; non-existent files.
5733 "Remove export results at point from stack.
5734 If optional argument SOURCE is non-nil, remove it instead."
5739 org-export-stack-contents))))
5742 "View export results at point in stack.
5743 With an optional prefix argument IN-EMACS, force viewing files
5744 within Emacs."
5758 (define-key km "p" 'previous-line)
5759 (define-key km "\C-p" 'previous-line)
5760 (define-key km "\C-?" 'previous-line)
5761 (define-key km [up] 'previous-line)
5762 (define-key km "C" 'org-export-stack-clear)
5763 (define-key km "v" 'org-export-stack-view)
5764 (define-key km (kbd "RET") 'org-export-stack-view)
5765 (define-key km "d" 'org-export-stack-remove)
5766 km)
5767 "Keymap for Org Export Stack.")
5769 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5770 "Mode for displaying asynchronous export stack.
5773 stack.
5775 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5776 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5777 stack completely.
5779 Removing entries in an Org Export Stack buffer doesn't affect
5780 files or buffers, only the display.
5783 (abbrev-mode 0)
5784 (auto-fill-mode 0)
5785 (setq buffer-read-only t
5786 buffer-undo-list t
5787 truncate-lines t
5788 header-line-format
5789 '(:eval
5790 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5791 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5792 (set (make-local-variable 'revert-buffer-function)
5793 'org-export-stack-refresh))
5796 \f
5797 ;;; The Dispatcher
5798 ;;
5799 ;; `org-export-dispatch' is the standard interactive way to start an
5800 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5801 ;; for its interface, which, in turn, delegates response to key
5802 ;; pressed to `org-export--dispatch-action'.
5804 ;;;###autoload
5805 (defun org-export-dispatch (&optional arg)
5806 "Export dispatcher for Org mode.
5808 It provides an access to common export related tasks in a buffer.
5809 Its interface comes in two flavours: standard and expert.
5811 While both share the same set of bindings, only the former
5812 displays the valid keys associations in a dedicated buffer.
5813 Scrolling (resp. line-wise motion) in this buffer is done with
5814 SPC and DEL (resp. C-n and C-p) keys.
5816 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5817 flavour or the other.
5820 of options used back then, on the current buffer.
5822 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5823 (interactive "P")
5824 (let* ((input
5825 (cond ((equal arg '(16)) '(stack))
5826 ((and arg org-export-dispatch-last-action))
5827 (t (save-window-excursion
5828 (unwind-protect
5829 (progn
5830 ;; Remember where we are
5831 (move-marker org-export-dispatch-last-position
5832 (point)
5833 (org-base-buffer (current-buffer)))
5834 ;; Get and store an export command
5835 (setq org-export-dispatch-last-action
5836 (org-export--dispatch-ui
5837 (list org-export-initial-scope
5838 (and org-export-in-background 'async))
5839 nil
5840 org-export-dispatch-use-expert-ui)))
5841 (and (get-buffer "*Org Export Dispatcher*")
5842 (kill-buffer "*Org Export Dispatcher*")))))))
5843 (action (car input))
5844 (optns (cdr input)))
5845 (unless (memq 'subtree optns)
5846 (move-marker org-export-dispatch-last-position nil))
5847 (case action
5848 ;; First handle special hard-coded actions.
5849 (template (org-export-insert-default-template nil optns))
5850 (stack (org-export-stack))
5851 (publish-current-file
5852 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5853 (publish-current-project
5854 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5855 (publish-choose-project
5856 (org-publish (assoc (org-icompleting-read
5857 "Publish project: "
5858 org-publish-project-alist nil t)
5859 org-publish-project-alist)
5860 (memq 'force optns)
5861 (memq 'async optns)))
5862 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5863 (otherwise
5864 (save-excursion
5865 (when arg
5866 ;; Repeating command, maybe move cursor to restore subtree
5867 ;; context.
5868 (if (eq (marker-buffer org-export-dispatch-last-position)
5869 (org-base-buffer (current-buffer)))
5870 (goto-char org-export-dispatch-last-position)
5871 ;; We are in a different buffer, forget position.
5872 (move-marker org-export-dispatch-last-position nil)))
5873 (funcall action
5874 ;; Return a symbol instead of a list to ease
5875 ;; asynchronous export macro use.
5876 (and (memq 'async optns) t)
5877 (and (memq 'subtree optns) t)
5878 (and (memq 'visible optns) t)
5879 (and (memq 'body optns) t)))))))
5881 (defun org-export--dispatch-ui (options first-key expertp)
5882 "Handle interface for `org-export-dispatch'.
5884 OPTIONS is a list containing current interactive options set for
5885 export. It can contain any of the following symbols:
5886 `body' toggles a body-only export
5887 `subtree' restricts export to current subtree
5888 `visible' restricts export to visible part of buffer.
5889 `force' force publishing files.
5890 `async' use asynchronous export process
5892 FIRST-KEY is the key pressed to select the first level menu. It
5893 is nil when this menu hasn't been selected yet.
5895 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5896 buffer is provided, but indications about currently active
5897 options are given in the prompt. Moreover, \[?] allows to switch
5898 back to standard interface."
5899 (let* ((fontify-key
5900 (lambda (key &optional access-key)
5901 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5902 ;; non-nil is the required first-level key to activate
5903 ;; KEY. When its value is t, activate KEY independently
5904 ;; on the first key, if any. A nil value means KEY will
5905 ;; only be activated at first level.
5906 (if (or (eq access-key t) (eq access-key first-key))
5907 (org-propertize key 'face 'org-warning)
5908 key)))
5909 (fontify-value
5910 (lambda (value)
5911 ;; Fontify VALUE string.
5912 (org-propertize value 'face 'font-lock-variable-name-face)))
5913 ;; Prepare menu entries by extracting them from registered
5914 ;; back-ends and sorting them by access key and by ordinal,
5915 ;; if any.
5916 (entries
5917 (sort (sort (delq nil
5918 (mapcar 'org-export-backend-menu
5919 org-export--registered-backends))
5920 (lambda (a b)
5921 (let ((key-a (nth 1 a))
5922 (key-b (nth 1 b)))
5923 (cond ((and (numberp key-a) (numberp key-b))
5924 (< key-a key-b))
5925 ((numberp key-b) t)))))
5926 'car-less-than-car))
5927 ;; Compute a list of allowed keys based on the first key
5928 ;; pressed, if any. Some keys
5929 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
5930 ;; available.
5931 (allowed-keys
5932 (nconc (list 2 22 19 6 1)
5933 (if (not first-key) (org-uniquify (mapcar 'car entries))
5934 (let (sub-menu)
5935 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
5936 (when (eq (car entry) first-key)
5937 (setq sub-menu (append (nth 2 entry) sub-menu))))))
5938 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5939 ((not first-key) (list ?P)))
5940 (list ?& ?#)
5941 (when expertp (list ??))
5942 (list ?q)))
5943 ;; Build the help menu for standard UI.
5944 (help
5945 (unless expertp
5946 (concat
5947 ;; Options are hard-coded.
5948 (format "[%s] Body only: %s [%s] Visible only: %s
5949 \[%s] Export scope: %s [%s] Force publishing: %s
5951 (funcall fontify-key "C-b" t)
5952 (funcall fontify-value
5953 (if (memq 'body options) "On " "Off"))
5954 (funcall fontify-key "C-v" t)
5955 (funcall fontify-value
5956 (if (memq 'visible options) "On " "Off"))
5957 (funcall fontify-key "C-s" t)
5958 (funcall fontify-value
5959 (if (memq 'subtree options) "Subtree" "Buffer "))
5960 (funcall fontify-key "C-f" t)
5961 (funcall fontify-value
5962 (if (memq 'force options) "On " "Off"))
5963 (funcall fontify-key "C-a" t)
5964 (funcall fontify-value
5965 (if (memq 'async options) "On " "Off")))
5966 ;; Display registered back-end entries. When a key
5967 ;; appears for the second time, do not create another
5968 ;; entry, but append its sub-menu to existing menu.
5969 (let (last-key)
5970 (mapconcat
5971 (lambda (entry)
5972 (let ((top-key (car entry)))
5973 (concat
5974 (unless (eq top-key last-key)
5975 (setq last-key top-key)
5977 (funcall fontify-key (char-to-string top-key))
5978 (nth 1 entry)))
5979 (let ((sub-menu (nth 2 entry)))
5980 (unless (functionp sub-menu)
5981 ;; Split sub-menu into two columns.
5982 (let ((index -1))
5983 (concat
5984 (mapconcat
5985 (lambda (sub-entry)
5986 (incf index)
5987 (format
5988 (if (zerop (mod index 2)) " [%s] %-26s"
5990 (funcall fontify-key
5991 (char-to-string (car sub-entry))
5992 top-key)
5993 (nth 1 sub-entry)))
5994 sub-menu "")
5996 entries ""))
5997 ;; Publishing menu is hard-coded.
5999 [%s] Current file [%s] Current project
6001 (funcall fontify-key "P")
6002 (funcall fontify-key "f" ?P)
6003 (funcall fontify-key "p" ?P)
6004 (funcall fontify-key "x" ?P)
6005 (funcall fontify-key "a" ?P))
6007 (funcall fontify-key "&" t)
6008 (funcall fontify-key "#" t))
6009 (format "[%s] %s"
6010 (funcall fontify-key "q" t)
6011 (if first-key "Main menu" "Exit")))))
6012 ;; Build prompts for both standard and expert UI.
6013 (standard-prompt (unless expertp "Export command: "))
6014 (expert-prompt
6015 (when expertp
6016 (format
6017 "Export command (C-%s%s%s%s%s) [%s]: "
6018 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6019 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6020 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6021 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6022 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6023 (mapconcat (lambda (k)
6024 ;; Strip control characters.
6025 (unless (< k 27) (char-to-string k)))
6026 allowed-keys "")))))
6027 ;; With expert UI, just read key with a fancy prompt. In standard
6028 ;; UI, display an intrusive help buffer.
6029 (if expertp
6030 (org-export--dispatch-action
6031 expert-prompt allowed-keys entries options first-key expertp)
6032 ;; At first call, create frame layout in order to display menu.
6033 (unless (get-buffer "*Org Export Dispatcher*")
6034 (delete-other-windows)
6035 (org-switch-to-buffer-other-window
6036 (get-buffer-create "*Org Export Dispatcher*"))
6037 (setq cursor-type nil
6038 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6039 ;; Make sure that invisible cursor will not highlight square
6040 ;; brackets.
6041 (set-syntax-table (copy-syntax-table))
6042 (modify-syntax-entry ?\[ "w"))
6043 ;; At this point, the buffer containing the menu exists and is
6044 ;; visible in the current window. So, refresh it.
6045 (with-current-buffer "*Org Export Dispatcher*"
6046 ;; Refresh help. Maintain display continuity by re-visiting
6047 ;; previous window position.
6048 (let ((pos (window-start)))
6049 (erase-buffer)
6050 (insert help)
6051 (set-window-start nil pos)))
6052 (org-fit-window-to-buffer)
6053 (org-export--dispatch-action
6054 standard-prompt allowed-keys entries options first-key expertp))))
6056 (defun org-export--dispatch-action
6057 (prompt allowed-keys entries options first-key expertp)
6058 "Read a character from command input and act accordingly.
6060 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6061 a list of characters available at a given step in the process.
6062 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6063 EXPERTP are the same as defined in `org-export--dispatch-ui',
6064 which see.
6066 Toggle export options when required. Otherwise, return value is
6067 a list with action as CAR and a list of interactive export
6068 options as CDR."
6069 (let (key)
6070 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6071 ;; C-p, SPC, DEL).
6072 (while (and (setq key (read-char-exclusive prompt))
6073 (not expertp)
6074 (memq key '(14 16 ?\s ?\d)))
6075 (case key
6076 (14 (if (not (pos-visible-in-window-p (point-max)))
6077 (ignore-errors (scroll-up-line))
6078 (message "End of buffer")
6079 (sit-for 1)))
6080 (16 (if (not (pos-visible-in-window-p (point-min)))
6081 (ignore-errors (scroll-down-line))
6082 (message "Beginning of buffer")
6083 (sit-for 1)))
6084 (?\s (if (not (pos-visible-in-window-p (point-max)))
6085 (scroll-up nil)
6086 (message "End of buffer")
6087 (sit-for 1)))
6088 (?\d (if (not (pos-visible-in-window-p (point-min)))
6089 (scroll-down nil)
6090 (message "Beginning of buffer")
6091 (sit-for 1)))))
6092 (cond
6093 ;; Ignore undefined associations.
6094 ((not (memq key allowed-keys))
6095 (ding)
6096 (unless expertp (message "Invalid key") (sit-for 1))
6097 (org-export--dispatch-ui options first-key expertp))
6098 ;; q key at first level aborts export. At second level, cancel
6099 ;; first key instead.
6100 ((eq key ?q) (if (not first-key) (error "Export aborted")
6101 (org-export--dispatch-ui options nil expertp)))
6102 ;; Help key: Switch back to standard interface if expert UI was
6103 ;; active.
6104 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6105 ;; Send request for template insertion along with export scope.
6106 ((eq key ?#) (cons 'template (memq 'subtree options)))
6107 ;; Switch to asynchronous export stack.
6108 ((eq key ?&) '(stack))
6109 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6110 ((memq key '(2 22 19 6 1))
6111 (org-export--dispatch-ui
6112 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6113 (6 'force) (1 'async))))
6114 (if (memq option options) (remq option options)
6115 (cons option options)))
6116 first-key expertp))
6117 ;; Action selected: Send key and options back to
6118 ;; `org-export-dispatch'.
6119 ((or first-key (functionp (nth 2 (assq key entries))))
6120 (cons (cond
6121 ((not first-key) (nth 2 (assq key entries)))
6122 ;; Publishing actions are hard-coded. Send a special
6123 ;; signal to `org-export-dispatch'.
6124 ((eq first-key ?P)
6125 (case key
6126 (?f 'publish-current-file)
6127 (?p 'publish-current-project)
6128 (?x 'publish-choose-project)
6129 (?a 'publish-all)))
6130 ;; Return first action associated to FIRST-KEY + KEY
6131 ;; path. Indeed, derived backends can share the same
6132 ;; FIRST-KEY.
6133 (t (catch 'found
6134 (mapc (lambda (entry)
6135 (let ((match (assq key (nth 2 entry))))
6136 (when match (throw 'found (nth 2 match)))))
6137 (member (assq first-key entries) entries)))))
6138 options))
6139 ;; Otherwise, enter sub-menu.
6140 (t (org-export--dispatch-ui options key expertp)))))
6144 (provide 'ox)
6146 ;; Local variables:
6147 ;; generated-autoload-file: "org-loaddefs.el"
6148 ;; End:
6150 ;;; ox.el ends here