| blob | 69dca6854648424a513ab97a61d8c2e35e4fb700 |
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 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements a generic export engine for Org, built on
26 ;; its syntactical parser: Org Elements.
27 ;;
28 ;; Besides that parser, the generic exporter is made of three distinct
29 ;; parts:
30 ;;
31 ;; - The communication channel consists in a property list, which is
32 ;; created and updated during the process. Its use is to offer
33 ;; every piece of information, would it be about initial environment
34 ;; or contextual data, all in a single place. The exhaustive list
35 ;; of properties is given in "The Communication Channel" section of
36 ;; this file.
37 ;;
38 ;; - The transcoder walks the parse tree, ignores or treat as plain
39 ;; text elements and objects according to export options, and
40 ;; eventually calls back-end specific functions to do the real
41 ;; transcoding, concatenating their return value along the way.
42 ;;
43 ;; - The filter system is activated at the very beginning and the very
44 ;; end of the export process, and each time an element or an object
45 ;; has been converted. It is the entry point to fine-tune standard
46 ;; output from back-end transcoders. See "The Filter System"
47 ;; section for more information.
48 ;;
49 ;; The core function is `org-export-as'. It returns the transcoded
50 ;; buffer as a string.
51 ;;
52 ;; An export back-end is defined with `org-export-define-backend'.
53 ;; This function can also support specific buffer keywords, OPTION
54 ;; keyword's items and filters. Refer to function's documentation for
55 ;; more information.
56 ;;
57 ;; If the new back-end shares most properties with another one,
58 ;; `org-export-define-derived-backend' can be used to simplify the
59 ;; process.
60 ;;
61 ;; Any back-end can define its own variables. Among them, those
62 ;; customizable should belong to the `org-export-BACKEND' group.
63 ;;
64 ;; Tools for common tasks across back-ends are implemented in the
65 ;; following part of the file.
66 ;;
67 ;; Then, a wrapper macro for asynchronous export,
68 ;; `org-export-async-start', along with tools to display results. are
69 ;; given in the penultimate part.
70 ;;
71 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
72 ;; back-ends is provided in the last one.
74 ;;; Code:
93 \f
94 ;;; Internal Variables
95 ;;
96 ;; Among internal variables, the most important is
97 ;; `org-export-options-alist'. This variable define the global export
98 ;; options, shared between every exporter, and how they are acquired.
143 "Alist between export properties and ways to set them.
145 The CAR of the alist is the property name, and the CDR is a list
146 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
148 KEYWORD is a string representing a buffer keyword, or nil. Each
149 property defined this way can also be set, during subtree
150 export, through a headline property named after the keyword
152 property).
153 OPTION is a string that could be found in an #+OPTIONS: line.
154 DEFAULT is the default value for the property.
155 BEHAVIOUR determines how Org should handle multiple keywords for
156 the same property. It is a symbol among:
157 nil Keep old value and discard the new one.
158 t Replace old value with the new one.
159 `space' Concatenate the values, separating them with a space.
160 `newline' Concatenate the values, separating them with
161 a newline.
162 `split' Split values at white spaces, and cons them to the
163 previous list.
165 Values set through KEYWORD and OPTION have precedence over
166 DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
262 "Non-nil means asynchronous export process should leave data behind.
266 located in `temporary-file-directory'.
268 When non-nil, it will also set `debug-on-error' to a non-nil
272 "Record asynchronously generated export results and processes.
273 This is an alist: its CAR is the source of the
274 result (destination file or buffer for a finished process,
275 original buffer for a running one) and its CDR is a list
276 containing the back-end used, as a symbol, and either a process
277 or the time at which it finished. It is used to build the menu
281 "List of backends currently available in the exporter.
282 This variable is set with `org-export-define-backend' and
286 "Last command called from the dispatcher.
287 The value should be a list. Its CAR is the action, as a symbol,
291 "The position where the last export command was created using the dispatcher.
292 This marker will be used with `C-u C-c C-e' to make sure export repetition
295 ;; For compatibility with Org < 8
297 "Name, if any, of the back-end used during an export process.
299 Its value is a symbol such as `html', `latex', `ascii', or nil if
300 the back-end is anonymous (see `org-export-create-backend') or if
301 there is no export process in progress.
303 It can be used to teach Babel blocks how to act differently
306 \f
307 ;;; User-configurable Variables
308 ;;
309 ;; Configuration for the masses.
310 ;;
311 ;; They should never be accessed directly, as their value is to be
312 ;; stored in a property list (cf. `org-export-options-alist').
313 ;; Back-ends will read their value from there instead.
316 "Options for exporting Org mode files."
321 "General options for export engine."
326 "Whether sub-trees with the ARCHIVE tag should be exported.
328 This can have three different values:
329 nil Do not export, pretend this tree is not present.
330 t Do export the entire tree.
331 `headline' Only export the headline, but skip the tree below it.
333 This option can also be set with the OPTIONS keyword,
342 "Non-nil means insert author name into the exported file.
343 This option can also be set with the OPTIONS keyword,
349 "Non-nil means export CLOCK keywords.
350 This option can also be set with the OPTIONS keyword,
356 "Non-nil means the postamble should contain a creator sentence.
358 The sentence can be set in `org-export-creator-string' and
361 If the value is `comment' insert it as a comment."
369 "Non-nil means insert date in the exported document.
370 This option can also be set with the OPTIONS keyword,
376 "Time-stamp format string to use for DATE keyword.
378 The format string, when specified, only applies if date consists
379 in a single time-stamp. Otherwise its value will be ignored.
381 See `format-time-string' for details on how to build this
382 string."
390 emacs-version
392 "Information about the creator of the document.
393 This option can also be set on with the CREATOR keyword."
398 "Non-nil means export contents of standard drawers.
400 When t, all drawers are exported. This may also be a list of
401 drawer names to export. If that list starts with `not', only
402 drawers with such names will be ignored.
404 This variable doesn't apply to properties drawers.
406 This option can also be set with the OPTIONS keyword,
419 :inline t
423 "Non-nil means insert author email into the exported file.
424 This option can also be set with the OPTIONS keyword,
430 "Non-nil means interpret *word*, /word/, _word_ and +word+.
432 If the export target supports emphasizing text, the word will be
433 typeset in bold, italic, with an underline or strike-through,
434 respectively.
436 This option can also be set with the OPTIONS keyword,
442 "Tags that exclude a tree from export.
444 All trees carrying any of these tags will be excluded from
445 export. This is without condition, so even subtrees inside that
446 carry one of the `org-export-select-tags' will be removed.
448 This option can also be set with the EXCLUDE_TAGS keyword."
455 This can be used to have pre-formatted text, fragments of code
456 etc. For example:
457 : ;; Some Lisp examples
458 : (while (defc cnt)
459 : (ding))
460 will be looking just like this in also HTML. See also the QUOTE
461 keyword. Not all export backends support this.
463 This option can also be set with the OPTIONS keyword,
469 "Non-nil means Org footnotes should be exported.
470 This option can also be set with the OPTIONS keyword,
476 "Non-nil means process LaTeX environments and fragments.
478 This option can also be set with the OPTIONS line,
481 nil Ignore math snippets.
482 `verbatim' Keep everything in verbatim.
483 t Allow export of math snippets."
493 "The last level which is still exported as a headline.
495 Inferior levels will usually produce itemize or enumerate lists
496 when exported, but back-end behaviour may differ.
498 This option can also be set with the OPTIONS keyword,
504 "The default language for export and clocktable translations, as a string.
505 This may have an association in
506 `org-clock-clocktable-language-setup',
507 `org-export-smart-quotes-alist' and `org-export-dictionary'.
508 This option can also be set with the LANGUAGE keyword."
513 "Non-nil means preserve all line breaks when exporting.
514 This option can also be set with the OPTIONS keyword,
520 "Non-nil means interpret entities when exporting.
523 Å.
525 For a list of supported names, see the constant `org-entities'
526 and the user option `org-entities-user'.
528 This option can also be set with the OPTIONS keyword,
534 "Non-nil means inlinetasks should be exported.
535 This option can also be set with the OPTIONS keyword,
543 "Non-nil means include planning info in export.
545 Planning info is the line containing either SCHEDULED:,
546 DEADLINE:, CLOSED: time-stamps, or a combination of them.
548 This option can also be set with the OPTIONS keyword,
556 "Non-nil means include priority cookies in export.
557 This option can also be set with the OPTIONS keyword,
563 "Non-nil means add section numbers to headlines when exporting.
565 When set to an integer n, numbering will only happen for
566 headlines whose relative level is higher or equal to n.
568 This option can also be set with the OPTIONS keyword,
574 "Tags that select a tree for export.
576 If any such tag is found in a buffer, all trees that do not carry
577 one of these tags will be ignored during export. Inside trees
578 that are selected like this, you can still deselect a subtree by
579 tagging it with one of the `org-export-exclude-tags'.
581 This option can also be set with the SELECT_TAGS keyword."
586 "Non-nil means activate smart quotes during export.
587 This option can also be set with the OPTIONS keyword,
590 When setting this to non-nil, you need to take care of
591 using the correct Babel package when exporting to LaTeX.
592 E.g., you can load Babel for french like this:
603 When this option is turned on, these strings will be exported as:
605 Org HTML LaTeX UTF-8
606 -----+----------+--------+-------
608 -- – -- –
609 --- — --- —
612 This option can also be set with the OPTIONS keyword,
618 "Non-nil means include statistics cookies in export.
619 This option can also be set with the OPTIONS keyword,
629 When this option is turned on, you can use TeX-like syntax for
631 will be considered as a single item - so grouping with {} is
632 normally not needed. For example, the following things will be
633 parsed as single sub- or superscripts.
635 10^24 or 10^tau several digits will be considered 1 item.
636 10^-12 or 10^-tau a leading sign with digits or a word
637 x^2-y^3 will be read as x^2 - y^3, because items are
638 terminated by almost any nonword/nondigit char.
639 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
641 Still, ambiguity is possible - so when in doubt use {} to enclose
642 the sub/superscript. If you set this variable to the symbol
643 `{}', the braces are *required* in order to trigger
644 interpretations as sub/superscript. This can be helpful in
647 This option can also be set with the OPTIONS keyword,
656 "Non-nil means create a table of contents in exported files.
658 The TOC contains headlines with levels up
659 to`org-export-headline-levels'. When an integer, include levels
660 up to N in the toc, this may then be different from
661 `org-export-headline-levels', but it will not be allowed to be
662 larger than the number of headline levels. When nil, no table of
663 contents is made.
665 This option can also be set with the OPTIONS keyword,
675 For example:
677 | Name | Address | Birthday |
678 |-------------+----------+-----------|
679 | Arthur Dent | England | 29.2.2100 |
681 This option can also be set with the OPTIONS keyword,
687 "If nil, do not export tags, just remove them from headlines.
689 If this is the symbol `not-in-toc', tags will be removed from
690 table of contents entries, but still be shown in the headlines of
691 the document.
693 This option can also be set with the OPTIONS keyword,
702 "Non-nil means include TODO items for export.
704 This may have the following values:
705 t include tasks independent of state.
706 `todo' include only tasks that are not yet done.
707 `done' include only tasks that are already done.
708 nil ignore all tasks.
709 list of keywords include tasks with these keywords.
711 This option can also be set with the OPTIONS keyword,
723 "Non-nil means insert a time stamp into the exported file.
724 The time stamp shows when the file was created. This option can
730 "Non nil means allow timestamps in export.
732 It can be set to any of the following values:
733 t export all timestamps.
734 `active' export active timestamps only.
735 `inactive' export inactive timestamps only.
736 nil do not export timestamps
738 This only applies to timestamps isolated in a paragraph
739 containing only timestamps. Other timestamps are always
740 exported.
742 This option can also be set with the OPTIONS keyword, e.g.
752 "Non-nil means include TODO keywords in export.
753 When nil, remove all these keywords from the export. This option
759 "Non-nil means BIND keywords can define local variable values.
760 This is a potential security risk, which is why the default value
761 is nil. You can also allow them through local buffer variables."
768 "Alist between export snippets back-ends and exporter back-ends.
770 This variable allows to provide shortcuts for export snippets.
774 HTML code while every other back-end will ignore it."
783 "Coding system for the exported file."
790 "Should we push exported content to the kill ring?"
799 "The initial scope when exporting with `org-export-dispatch'.
800 This variable can be either set to `buffer' or `subtree'."
807 "Non-nil means show buffer after exporting to temp buffer.
808 When Org exports to a file, the buffer visiting that file is ever
809 shown, but remains buried. However, when exporting to
810 a temporary buffer, that buffer is popped up in a second window.
811 When this variable is nil, the buffer remains buried also in
812 these cases."
817 "Non-nil means export and publishing commands will run in background.
818 Results from an asynchronous export are never displayed
826 "File used to initialize external export process.
827 Value must be an absolute file name. It defaults to user's
828 initialization file. Though, a specific configuration makes the
829 process faster and the export more portable."
836 "Non-nil means using a non-intrusive `org-export-dispatch'.
837 In that case, no help buffer is displayed. Though, an indicator
843 asynchronous). Also, \[?] allows to switch back to standard
844 mode."
851 \f
852 ;;; Defining Back-ends
853 ;;
854 ;; An export back-end is a structure with `org-export-backend' type
855 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
856 ;; and `menu' slots.
857 ;;
858 ;; At the lowest level, a back-end is created with
859 ;; `org-export-create-backend' function.
860 ;;
861 ;; A named back-end can be registered with
862 ;; `org-export-register-backend' function. A registered back-end can
863 ;; later be referred to by its name, with `org-export-get-backend'
864 ;; function. Also, such a back-end can become the parent of a derived
865 ;; back-end from which slot values will be inherited by default.
866 ;; `org-export-derived-backend-p' can check if a given back-end is
867 ;; derived from a list of back-end names.
868 ;;
869 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
870 ;; `org-export-get-all-filters' return the full alist of transcoders,
871 ;; options and filters, including those inherited from ancestors.
872 ;;
873 ;; At a higher level, `org-export-define-backend' is the standard way
874 ;; to define an export back-end. If the new back-end is similar to
875 ;; a registered back-end, `org-export-define-derived-backend' may be
876 ;; used instead.
877 ;;
878 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
879 ;; when a given back-end hasn't been registered yet.
883 name parent transcoders options filters blocks menu)
886 "Return export back-end named after NAME.
887 NAME is a symbol. Return nil if no such back-end is found."
894 "Register BACKEND as a known export back-end.
895 BACKEND is a structure with `org-export-backend' type."
896 ;; Refuse to register an unnamed back-end.
899 ;; Refuse to register a back-end with an unknown parent.
903 ;; Register dedicated export blocks in the parser.
907 ;; If a back-end with the same name as BACKEND is already
908 ;; registered, replace it with BACKEND. Otherwise, simply add
909 ;; BACKEND to the list of registered back-ends.
915 "Signal an error if BACKEND isn't defined."
920 "Non-nil if BACKEND is derived from one of BACKENDS.
921 BACKEND is an export back-end, as returned by, e.g.,
922 `org-export-create-backend', or a symbol referring to
923 a registered back-end. BACKENDS is constituted of symbols."
935 "Return full translation table for BACKEND.
937 BACKEND is an export back-end, as return by, e.g,,
938 `org-export-create-backend'. Return value is an alist where
939 keys are element or object types, as symbols, and values are
940 transcoders.
942 Unlike to `org-export-backend-transcoders', this function
943 also returns transcoders inherited from parent back-ends,
944 if any."
948 parent)
953 transcoders)))
956 "Return export options for BACKEND.
958 BACKEND is an export back-end, as return by, e.g,,
959 `org-export-create-backend'. See `org-export-options-alist'
960 for the shape of the return value.
962 Unlike to `org-export-backend-options', this function also
963 returns options inherited from parent back-ends, if any."
967 parent)
971 options)))
974 "Return complete list of filters for BACKEND.
976 BACKEND is an export back-end, as return by, e.g,,
977 `org-export-create-backend'. Return value is an alist where
978 keys are symbols and values lists of functions.
980 Unlike to `org-export-backend-filters', this function also
981 returns filters inherited from parent back-ends, if any."
985 parent)
989 filters)))
992 "Define a new back-end BACKEND.
994 TRANSCODERS is an alist between object or element types and
995 functions handling them.
997 These functions should return a string without any trailing
998 space, or nil. They must accept three arguments: the object or
999 element itself, its contents or nil when it isn't recursive and
1000 the property list used as a communication channel.
1002 Contents, when not nil, are stripped from any global indentation
1003 \(although the relative one is preserved). They also always end
1004 with a single newline character.
1006 If, for a given type, no function is found, that element or
1007 object type will simply be ignored, along with any blank line or
1008 white space at its end. The same will happen if the function
1009 returns the nil value. If that function returns the empty
1010 string, the type will be ignored, but the blank lines or white
1011 spaces will be kept.
1013 In addition to element and object types, one function can be
1014 associated to the `template' (or `inner-template') symbol and
1015 another one to the `plain-text' symbol.
1017 The former returns the final transcoded string, and can be used
1018 to add a preamble and a postamble to document's body. It must
1019 accept two arguments: the transcoded string and the property list
1020 containing export options. A function associated to `template'
1022 A function associated to `inner-template' is always applied.
1024 The latter, when defined, is to be called on every text not
1025 recognized as an element or an object. It must accept two
1026 arguments: the text string and the information channel. It is an
1027 appropriate place to protect special chars relative to the
1028 back-end.
1030 BODY can start with pre-defined keyword arguments. The following
1031 keywords are understood:
1033 :export-block
1035 String, or list of strings, representing block names that
1036 will not be parsed. This is used to specify blocks that will
1037 contain raw code specific to the back-end. These blocks
1038 still have to be handled by the relative `export-block' type
1039 translator.
1041 :filters-alist
1043 Alist between filters and function, or list of functions,
1044 specific to the back-end. See `org-export-filters-alist' for
1045 a list of all allowed filters. Filters defined here
1046 shouldn't make a back-end test, as it may prevent back-ends
1047 derived from this one to behave properly.
1049 :menu-entry
1051 Menu entry for the export dispatcher. It should be a list
1052 like:
1054 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1056 where :
1058 KEY is a free character selecting the back-end.
1060 DESCRIPTION-OR-ORDINAL is either a string or a number.
1062 If it is a string, is will be used to name the back-end in
1063 its menu entry. If it is a number, the following menu will
1064 be displayed as a sub-menu of the back-end with the same
1065 KEY. Also, the number will be used to determine in which
1066 order such sub-menus will appear (lowest first).
1068 ACTION-OR-MENU is either a function or an alist.
1070 If it is an action, it will be called with four
1071 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1072 BODY-ONLY. See `org-export-as' for further explanations on
1073 some of them.
1075 If it is an alist, associations should follow the
1076 pattern:
1078 '(KEY DESCRIPTION ACTION)
1080 where KEY, DESCRIPTION and ACTION are described above.
1082 Valid values include:
1086 or
1091 \(lambda (a s v b)
1092 \(if a (org-latex-export-to-pdf t s v b)
1093 \(org-open-file
1094 \(org-latex-export-to-pdf nil s v b)))))))
1096 or the following, which will be added to the previous
1097 sub-menu,
1099 '(?l 1
1103 :options-alist
1105 Alist between back-end specific properties introduced in
1106 communication channel and how their value are acquired. See
1107 `org-export-options-alist' for more information about
1108 structure of the values."
1122 :transcoders transcoders
1123 :options options
1124 :filters filters
1125 :blocks blocks
1129 "Create a new back-end as a variant of an existing one.
1131 CHILD is the name of the derived back-end. PARENT is the name of
1132 the parent back-end.
1134 BODY can start with pre-defined keyword arguments. The following
1135 keywords are understood:
1137 :export-block
1139 String, or list of strings, representing block names that
1140 will not be parsed. This is used to specify blocks that will
1141 contain raw code specific to the back-end. These blocks
1142 still have to be handled by the relative `export-block' type
1143 translator.
1145 :filters-alist
1147 Alist of filters that will overwrite or complete filters
1148 defined in PARENT back-end. See `org-export-filters-alist'
1149 for a list of allowed filters.
1151 :menu-entry
1153 Menu entry for the export dispatcher. See
1154 `org-export-define-backend' for more information about the
1155 expected value.
1157 :options-alist
1159 Alist of back-end specific properties that will overwrite or
1160 complete those defined in PARENT back-end. Refer to
1161 `org-export-options-alist' for more information about
1162 structure of the values.
1164 :translate-alist
1166 Alist of element and object types and transcoders that will
1167 overwrite or complete transcode table from PARENT back-end.
1168 Refer to `org-export-define-backend' for detailed information
1169 about transcoders.
1172 as a variant of `latex' back-end with a custom template function:
1174 \(org-export-define-derived-backend 'my-latex 'latex
1175 :translate-alist '((template . my-latex-template-fun)))
1177 The back-end could then be called with, for example:
1194 :parent parent
1195 :transcoders transcoders
1196 :options options
1197 :filters filters
1198 :blocks blocks
1202 \f
1203 ;;; The Communication Channel
1204 ;;
1205 ;; During export process, every function has access to a number of
1206 ;; properties. They are of two types:
1207 ;;
1208 ;; 1. Environment options are collected once at the very beginning of
1209 ;; the process, out of the original buffer and configuration.
1210 ;; Collecting them is handled by `org-export-get-environment'
1211 ;; function.
1212 ;;
1213 ;; Most environment options are defined through the
1214 ;; `org-export-options-alist' variable.
1215 ;;
1216 ;; 2. Tree properties are extracted directly from the parsed tree,
1217 ;; just before export, by `org-export-collect-tree-properties'.
1218 ;;
1219 ;; Here is the full list of properties available during transcode
1220 ;; process, with their category and their value type.
1221 ;;
1222 ;; + `:author' :: Author's name.
1223 ;; - category :: option
1224 ;; - type :: string
1225 ;;
1226 ;; + `:back-end' :: Current back-end used for transcoding.
1227 ;; - category :: tree
1228 ;; - type :: symbol
1229 ;;
1230 ;; + `:creator' :: String to write as creation information.
1231 ;; - category :: option
1232 ;; - type :: string
1233 ;;
1234 ;; + `:date' :: String to use as date.
1235 ;; - category :: option
1236 ;; - type :: string
1237 ;;
1238 ;; + `:description' :: Description text for the current data.
1239 ;; - category :: option
1240 ;; - type :: string
1241 ;;
1242 ;; + `:email' :: Author's email.
1243 ;; - category :: option
1244 ;; - type :: string
1245 ;;
1246 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1247 ;; process.
1248 ;; - category :: option
1249 ;; - type :: list of strings
1250 ;;
1251 ;; + `:export-options' :: List of export options available for current
1252 ;; process.
1253 ;; - category :: none
1254 ;; - type :: list of symbols, among `subtree', `body-only' and
1255 ;; `visible-only'.
1256 ;;
1257 ;; + `:exported-data' :: Hash table used for memoizing
1258 ;; `org-export-data'.
1259 ;; - category :: tree
1260 ;; - type :: hash table
1261 ;;
1262 ;; + `:filetags' :: List of global tags for buffer. Used by
1263 ;; `org-export-get-tags' to get tags with inheritance.
1264 ;; - category :: option
1265 ;; - type :: list of strings
1266 ;;
1267 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1268 ;; their definition, as parsed data. Only non-inlined footnotes
1269 ;; are represented in this alist. Also, every definition isn't
1270 ;; guaranteed to be referenced in the parse tree. The purpose of
1271 ;; this property is to preserve definitions from oblivion
1272 ;; (i.e. when the parse tree comes from a part of the original
1273 ;; buffer), it isn't meant for direct use in a back-end. To
1274 ;; retrieve a definition relative to a reference, use
1275 ;; `org-export-get-footnote-definition' instead.
1276 ;; - category :: option
1277 ;; - type :: alist (STRING . LIST)
1278 ;;
1279 ;; + `:headline-levels' :: Maximum level being exported as an
1280 ;; headline. Comparison is done with the relative level of
1281 ;; headlines in the parse tree, not necessarily with their
1282 ;; actual level.
1283 ;; - category :: option
1284 ;; - type :: integer
1285 ;;
1286 ;; + `:headline-offset' :: Difference between relative and real level
1287 ;; of headlines in the parse tree. For example, a value of -1
1288 ;; means a level 2 headline should be considered as level
1289 ;; 1 (cf. `org-export-get-relative-level').
1290 ;; - category :: tree
1291 ;; - type :: integer
1292 ;;
1293 ;; + `:headline-numbering' :: Alist between headlines and their
1294 ;; numbering, as a list of numbers
1295 ;; (cf. `org-export-get-headline-number').
1296 ;; - category :: tree
1297 ;; - type :: alist (INTEGER . LIST)
1298 ;;
1299 ;; + `:id-alist' :: Alist between ID strings and destination file's
1300 ;; path, relative to current directory. It is used by
1301 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1302 ;; external file.
1303 ;; - category :: option
1304 ;; - type :: alist (STRING . STRING)
1305 ;;
1306 ;; + `:ignore-list' :: List of elements and objects that should be
1307 ;; ignored during export.
1308 ;; - category :: tree
1309 ;; - type :: list of elements and objects
1310 ;;
1311 ;; + `:input-file' :: Full path to input file, if any.
1312 ;; - category :: option
1313 ;; - type :: string or nil
1314 ;;
1315 ;; + `:keywords' :: List of keywords attached to data.
1316 ;; - category :: option
1317 ;; - type :: string
1318 ;;
1319 ;; + `:language' :: Default language used for translations.
1320 ;; - category :: option
1321 ;; - type :: string
1322 ;;
1323 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1324 ;; transcoding.
1325 ;; - category :: option
1326 ;; - type :: list (as returned by `org-element-parse-buffer')
1327 ;;
1328 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1329 ;; all line breaks.
1330 ;; - category :: option
1331 ;; - type :: symbol (nil, t)
1332 ;;
1333 ;; + `:section-numbers' :: Non-nil means transcoding should add
1334 ;; section numbers to headlines.
1335 ;; - category :: option
1336 ;; - type :: symbol (nil, t)
1337 ;;
1338 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1339 ;; in transcoding. When such a tag is present, subtrees without
1340 ;; it are de facto excluded from the process. See
1341 ;; `use-select-tags'.
1342 ;; - category :: option
1343 ;; - type :: list of strings
1344 ;;
1345 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1346 ;; a time stamp in the output.
1347 ;; - category :: option
1348 ;; - type :: symbol (nil, t)
1349 ;;
1350 ;; + `:translate-alist' :: Alist between element and object types and
1351 ;; transcoding functions relative to the current back-end.
1352 ;; Special keys `inner-template', `template' and `plain-text' are
1353 ;; also possible.
1354 ;; - category :: option
1355 ;; - type :: alist (SYMBOL . FUNCTION)
1356 ;;
1357 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1358 ;; also be transcoded. If it is set to the `headline' symbol,
1359 ;; only the archived headline's name is retained.
1360 ;; - category :: option
1361 ;; - type :: symbol (nil, t, `headline')
1362 ;;
1363 ;; + `:with-author' :: Non-nil means author's name should be included
1364 ;; in the output.
1365 ;; - category :: option
1366 ;; - type :: symbol (nil, t)
1367 ;;
1368 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1369 ;; - category :: option
1370 ;; - type :: symbol (nil, t)
1371 ;;
1372 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1373 ;; inserted at the end of the transcoded string. If the value
1374 ;; is `comment', it should be commented.
1375 ;; - category :: option
1376 ;; - type :: symbol (`comment', nil, t)
1377 ;;
1378 ;; + `:with-date' :: Non-nil means output should contain a date.
1379 ;; - category :: option
1380 ;; - type :. symbol (nil, t)
1381 ;;
1382 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1383 ;; its value is a list of names, only drawers with such names
1384 ;; will be transcoded. If that list starts with `not', drawer
1385 ;; with these names will be skipped.
1386 ;; - category :: option
1387 ;; - type :: symbol (nil, t) or list of strings
1388 ;;
1389 ;; + `:with-email' :: Non-nil means output should contain author's
1390 ;; email.
1391 ;; - category :: option
1392 ;; - type :: symbol (nil, t)
1393 ;;
1394 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1395 ;; interpreted.
1396 ;; - category :: option
1397 ;; - type :: symbol (nil, t)
1398 ;;
1399 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1400 ;; strings starting with a colon as a fixed-with (verbatim) area.
1401 ;; - category :: option
1402 ;; - type :: symbol (nil, t)
1403 ;;
1404 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1405 ;; footnotes.
1406 ;; - category :: option
1407 ;; - type :: symbol (nil, t)
1408 ;;
1409 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1410 ;; `latex-fragment' objects should appear in export output. When
1411 ;; this property is set to `verbatim', they will be left as-is.
1412 ;; - category :: option
1413 ;; - type :: symbol (`verbatim', nil, t)
1414 ;;
1415 ;; + `:with-planning' :: Non-nil means transcoding should include
1416 ;; planning info.
1417 ;; - category :: option
1418 ;; - type :: symbol (nil, t)
1419 ;;
1420 ;; + `:with-priority' :: Non-nil means transcoding should include
1421 ;; priority cookies.
1422 ;; - category :: option
1423 ;; - type :: symbol (nil, t)
1424 ;;
1425 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1426 ;; plain text.
1427 ;; - category :: option
1428 ;; - type :: symbol (nil, t)
1429 ;;
1430 ;; + `:with-special-strings' :: Non-nil means transcoding should
1431 ;; interpret special strings in plain text.
1432 ;; - category :: option
1433 ;; - type :: symbol (nil, t)
1434 ;;
1435 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1436 ;; interpret subscript and superscript. With a value of "{}",
1437 ;; only interpret those using curly brackets.
1438 ;; - category :: option
1439 ;; - type :: symbol (nil, {}, t)
1440 ;;
1441 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1442 ;; tables.
1443 ;; - category :: option
1444 ;; - type :: symbol (nil, t)
1445 ;;
1446 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1447 ;; headlines. A `not-in-toc' value will remove them from the
1448 ;; table of contents, if any, nonetheless.
1449 ;; - category :: option
1450 ;; - type :: symbol (nil, t, `not-in-toc')
1451 ;;
1452 ;; + `:with-tasks' :: Non-nil means transcoding should include
1453 ;; headlines with a TODO keyword. A `todo' value will only
1454 ;; include headlines with a todo type keyword while a `done'
1455 ;; value will do the contrary. If a list of strings is provided,
1456 ;; only tasks with keywords belonging to that list will be kept.
1457 ;; - category :: option
1458 ;; - type :: symbol (t, todo, done, nil) or list of strings
1459 ;;
1460 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1461 ;; time stamps. Special value `active' (resp. `inactive') ask to
1462 ;; export only active (resp. inactive) timestamps. Otherwise,
1463 ;; completely remove them.
1464 ;; - category :: option
1465 ;; - type :: symbol: (`active', `inactive', t, nil)
1466 ;;
1467 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1468 ;; added to the output. An integer value limits its depth.
1469 ;; - category :: option
1470 ;; - type :: symbol (nil, t or integer)
1471 ;;
1472 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1473 ;; include TODO keywords.
1474 ;; - category :: option
1475 ;; - type :: symbol (nil, t)
1478 ;;;; Environment Options
1479 ;;
1480 ;; Environment options encompass all parameters defined outside the
1481 ;; scope of the parsed data. They come from five sources, in
1482 ;; increasing precedence order:
1483 ;;
1484 ;; - Global variables,
1485 ;; - Buffer's attributes,
1486 ;; - Options keyword symbols,
1487 ;; - Buffer keywords,
1488 ;; - Subtree properties.
1489 ;;
1490 ;; The central internal function with regards to environment options
1491 ;; is `org-export-get-environment'. It updates global variables with
1492 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1493 ;; the different sources.
1494 ;;
1495 ;; The internal functions doing the retrieval are:
1496 ;; `org-export--get-global-options',
1497 ;; `org-export--get-buffer-attributes',
1498 ;; `org-export--parse-option-keyword',
1499 ;; `org-export--get-subtree-options' and
1500 ;; `org-export--get-inbuffer-options'
1501 ;;
1502 ;; Also, `org-export--list-bound-variables' collects bound variables
1503 ;; along with their value in order to set them as buffer local
1504 ;; variables later in the process.
1507 "Collect export options from the current buffer.
1509 Optional argument BACKEND is an export back-end, as returned by
1510 `org-export-create-backend'.
1512 When optional argument SUBTREEP is non-nil, assume the export is
1513 done against the current sub-tree.
1515 Third optional argument EXT-PLIST is a property list with
1516 external parameters overriding Org default settings, but still
1517 inferior to file-local settings."
1518 ;; First install #+BIND variables since these must be set before
1519 ;; global options are read.
1522 ;; Get and prioritize export options...
1524 ;; ... from global variables...
1526 ;; ... from an external property list...
1527 ext-plist
1528 ;; ... from in-buffer settings...
1530 ;; ... and from subtree, when appropriate.
1532 ;; Eventually add misc. properties.
1534 :back-end
1535 backend
1537 :footnote-definition-alist
1538 ;; Footnotes definitions must be collected in the original
1539 ;; buffer, as there's no insurance that they will still be in
1540 ;; the parse tree, due to possible narrowing.
1554 alist))))
1555 alist))
1556 :id-alist
1557 ;; Collect id references.
1568 alist))))
1571 "Parse an OPTIONS line and return values as a plist.
1572 Optional argument BACKEND is an export back-end, as returned by,
1573 e.g., `org-export-create-backend'. It specifies which back-end
1574 specific items to read, if any."
1576 ;; Priority is given to back-end specific options.
1578 org-export-options-alist))
1579 plist)
1588 options))
1590 property
1593 plist))
1596 "Get export options in subtree at point.
1597 Optional argument BACKEND is an export back-end, as returned by,
1598 e.g., `org-export-create-backend'. It specifies back-end used
1599 for export. Return options as a plist."
1600 ;; For each buffer keyword, create a headline property setting the
1601 ;; same property in communication channel. The name for the property
1602 ;; is the keyword with "EXPORT_" appended to it.
1605 ;; Make sure point is at a heading.
1607 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1608 ;; title as its fallback value.
1614 plist :title
1617 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1621 ;; Handle other keywords. TITLE keyword is excluded as it has
1622 ;; been handled already.
1630 ;; Export properties are not case-sensitive.
1637 plist
1638 property
1640 ;; Parse VALUE if required.
1644 ;; If BEHAVIOUR is `split' expected value is
1645 ;; a list of strings, not a string.
1648 ;; Look for both general keywords and back-end specific
1649 ;; options, with priority given to the latter.
1651 org-export-options-alist)))
1652 ;; Return value.
1653 plist)))
1656 "Return current buffer export options, as a plist.
1658 Optional argument BACKEND, when non-nil, is an export back-end,
1659 as returned by, e.g., `org-export-create-backend'. It specifies
1660 which back-end specific options should also be read in the
1661 process.
1663 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1665 get-options ; For byte-compiler.
1668 ;; Priority is given to back-end specific options.
1670 org-export-options-alist))
1673 org-export-special-keywords))))
1676 ;; Return all properties associated to KEYWORD.
1683 ;; Recursively read keywords in buffer. FILES is a list
1684 ;; of files read so far. PLIST is the current property
1685 ;; list obtained.
1694 ;; Options in `org-export-special-keywords'.
1698 ;; Avoid circular dependencies.
1708 plist
1713 plist
1719 ;; Options in `org-export-options-alist'.
1724 plist property
1725 ;; Handle value depending on specified
1726 ;; BEHAVIOUR.
1732 " "
1745 ;; Return final value.
1746 plist))))
1747 ;; Read options in the current buffer.
1750 ;; Parse keywords specified in `org-element-document-properties'
1751 ;; and return PLIST.
1762 "Return properties related to buffer attributes, as a plist."
1763 ;; Store full path of input file name, or nil. For internal use.
1771 "Return global export options as a plist.
1772 Optional argument BACKEND, if non-nil, is an export back-end, as
1773 returned by, e.g., `org-export-create-backend'. It specifies
1774 which back-end specific export options should also be read in the
1775 process."
1777 ;; Priority is given to back-end specific options.
1779 org-export-options-alist)))
1786 plist
1787 prop
1788 ;; Eval default value provided. If keyword is
1789 ;; a member of `org-element-document-properties',
1790 ;; parse it as a secondary string before storing it.
1797 value)))))))))))
1800 "Return variables bound from BIND keywords in current buffer.
1801 Also look for BIND keywords in setup files. The return value is
1802 an alist where associations are (VARIABLE-NAME VALUE)."
1807 ;; Return an alist between variable names and their
1808 ;; value. FILES is a list of setup files names read so
1809 ;; far, used to avoid circular dependencies. ALIST is
1810 ;; the alist collected so far.
1821 ;; Enter setup file.
1831 alist))))))))))
1832 alist)))))
1833 ;; Return value in appropriate order of appearance.
1837 ;;;; Tree Properties
1838 ;;
1839 ;; Tree properties are information extracted from parse tree. They
1840 ;; are initialized at the beginning of the transcoding process by
1841 ;; `org-export-collect-tree-properties'.
1842 ;;
1843 ;; Dedicated functions focus on computing the value of specific tree
1844 ;; properties during initialization. Thus,
1845 ;; `org-export--populate-ignore-list' lists elements and objects that
1846 ;; should be skipped during export, `org-export--get-min-level' gets
1847 ;; the minimal exportable level, used as a basis to compute relative
1848 ;; level for headlines. Eventually
1849 ;; `org-export--collect-headline-numbering' builds an alist between
1850 ;; headlines and their numbering.
1853 "Extract tree properties from parse tree.
1855 DATA is the parse tree from which information is retrieved. INFO
1856 is a list holding export options.
1858 Following tree properties are set or updated:
1860 `:exported-data' Hash table used to memoize results from
1861 `org-export-data'.
1863 `:footnote-definition-alist' List of footnotes definitions in
1864 original buffer and current parse tree.
1866 `:headline-offset' Offset between true level of headlines and
1867 local level. An offset of -1 means a headline
1868 of level 2 should be considered as a level
1869 1 headline in the context.
1871 `:headline-numbering' Alist of all headlines as key an the
1872 associated numbering as value.
1874 `:ignore-list' List of elements that should be ignored during
1875 export.
1877 Return updated plist."
1878 ;; Install the parse tree in the communication channel, in order to
1879 ;; use `org-export-get-genealogy' and al.
1881 ;; Get the list of elements and objects to ignore, and put it into
1882 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1883 ;; been done during parse tree filtering.
1886 :ignore-list
1889 ;; Compute `:headline-offset' in order to be able to use
1890 ;; `org-export-get-relative-level'.
1893 :headline-offset
1895 ;; Update footnotes definitions list with definitions in parse tree.
1896 ;; This is required since buffer expansion might have modified
1897 ;; boundaries of footnote definitions contained in the parse tree.
1898 ;; This way, definitions in `footnote-definition-alist' are bound to
1899 ;; match those in the parse tree.
1905 defs)))
1907 ;; Properties order doesn't matter: get the rest of the tree
1908 ;; properties.
1912 info))
1915 "Return minimum exportable headline's level in DATA.
1916 DATA is parsed tree as returned by `org-element-parse-buffer'.
1917 OPTIONS is a plist holding export options."
1928 ;; If no headline was found, for the sake of consistency, set
1929 ;; minimum level to 1 nonetheless.
1933 "Return numbering of all exportable headlines in a parse tree.
1935 DATA is the parse tree. OPTIONS is the plist holding export
1936 options.
1938 Return an alist whose key is a headline and value is its
1939 associated numbering \(in the shape of a list of numbers\) or nil
1940 for a footnotes section."
1948 headline
1950 for idx from 0 to org-export-max-depth
1954 options)))
1957 "Return list of elements and objects to ignore during export.
1958 DATA is the parse tree to traverse. OPTIONS is the plist holding
1959 export options."
1961 walk-data
1962 ;; First find trees containing a select tag, if any.
1966 ;; Collect ignored elements or objects into IGNORE-LIST.
1972 ;; If headline is archived but tree below has
1973 ;; to be skipped, add it to ignore list.
1976 ;; Move into secondary string, if any.
1981 ;; Move into recursive objects/elements.
1983 ;; Main call.
1985 ;; Return value.
1986 ignore))
1989 "Return list of headlines and inlinetasks with a select tag in their tree.
1990 DATA is parsed data as returned by `org-element-parse-buffer'.
1991 INFO is a plist holding export options."
1993 walk-data ; For byte-compiler.
2003 ;; When a select tag is found, mark full
2004 ;; genealogy and every headline within the tree
2005 ;; as acceptable.
2008 genealogy
2011 selected-trees))
2012 ;; If at a headline, continue searching in tree,
2013 ;; recursively.
2023 selected-trees))
2026 "Non-nil when element or object BLOB should be skipped during export.
2027 OPTIONS is the plist holding export options. SELECTED, when
2028 non-nil, is a list of headlines or inlinetasks belonging to
2029 a tree with a select tag."
2036 ;; If `:with-drawers' value starts with `not', ignore
2037 ;; every drawer whose name belong to that list.
2038 ;; Otherwise, ignore drawers whose name isn't in that
2039 ;; list.
2055 ;; Ignore subtrees with an exclude tag.
2058 ;; When a select tag is present in the buffer, ignore any tree
2059 ;; without it.
2061 ;; Ignore commented sub-trees.
2063 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2065 ;; Ignore tasks, if specified by `:with-tasks' property.
2080 ;; `:with-timestamps' only applies to isolated timestamps
2081 ;; objects, i.e. timestamp objects in a paragraph containing only
2082 ;; timestamps and whitespaces.
2090 options t))))
2099 \f
2100 ;;; The Transcoder
2101 ;;
2102 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2103 ;; `org-element-parse-buffer') and transcodes it into a specified
2104 ;; back-end output. It takes care of filtering out elements or
2105 ;; objects according to export options and organizing the output blank
2106 ;; lines and white space are preserved. The function memoizes its
2107 ;; results, so it is cheap to call it within transcoders.
2108 ;;
2109 ;; It is possible to modify locally the back-end used by
2110 ;; `org-export-data' or even use a temporary back-end by using
2111 ;; `org-export-data-with-backend'.
2112 ;;
2113 ;; Internally, three functions handle the filtering of objects and
2114 ;; elements during the export. In particular,
2115 ;; `org-export-ignore-element' marks an element or object so future
2116 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2117 ;; elements or objects should be seen as real Org syntax and
2118 ;; `org-export-expand' transforms the others back into their original
2119 ;; shape
2120 ;;
2121 ;; `org-export-transcoder' is an accessor returning appropriate
2122 ;; translator function for a given element or object.
2125 "Return appropriate transcoder for BLOB.
2126 INFO is a plist containing export directives."
2128 ;; Return contents only for complete parse trees.
2134 "Convert DATA into current back-end format.
2136 DATA is a parse tree, an element or an object or a secondary
2137 string. INFO is a plist holding export options.
2139 Return transcoded string."
2145 ;; Ignored element/object.
2147 ;; Plain text.
2153 info))
2154 ;; Uninterpreted element/object: change it back to Org
2155 ;; syntax and export again resulting raw string.
2159 data
2163 info))
2164 ;; Secondary string.
2167 ;; Element/Object without contents or, as a special case,
2168 ;; headline with archive tag and archived trees restricted
2169 ;; to title only.
2177 ;; Export snippets never return a nil value so
2178 ;; that white spaces following them are never
2179 ;; ignored.
2181 ;; Element/Object with contents.
2194 ;; Elements directly containing objects
2195 ;; must have their indentation normalized
2196 ;; first.
2198 data
2199 ;; When normalizing contents of the first
2200 ;; paragraph in an item or a footnote
2201 ;; definition, ignore first line's
2202 ;; indentation: there is none and it
2203 ;; might be misleading.
2208 data)
2215 info))))))))
2216 ;; Final result will be memoized before being returned.
2218 data
2222 ;; Append the same white space between elements or objects as in
2223 ;; the original buffer, and call appropriate filters.
2234 info)))
2235 results)))
2239 "Convert DATA into BACKEND format.
2241 DATA is an element, an object, a secondary string or a string.
2242 BACKEND is a symbol. INFO is a plist used as a communication
2243 channel.
2245 Unlike to `org-export-with-backend', this function will
2246 recursively convert DATA using BACKEND translation table."
2249 data
2250 ;; Set-up a new communication channel with translations defined in
2251 ;; BACKEND as the translate table and a new hash table for
2252 ;; memoization.
2254 info
2257 ;; Size of the hash table is reduced since this function
2258 ;; will probably be used on small trees.
2262 "Non-nil if element or object BLOB should be interpreted during export.
2263 If nil, BLOB will appear as raw Org syntax. Check is done
2264 according to export options INFO, stored as a plist."
2266 ;; ... entities...
2268 ;; ... emphasis...
2271 ;; ... fixed-width areas.
2273 ;; ... LaTeX environments and fragments...
2277 ;; ... sub/superscripts...
2283 ;; ... tables...
2288 "Expand a parsed element or object to its original state.
2290 BLOB is either an element or an object. CONTENTS is its
2291 contents, as a string or nil.
2293 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2294 keywords before output."
2299 blob contents))))
2302 "Add ELEMENT to `:ignore-list' in INFO.
2304 Any element in `:ignore-list' will be skipped when using
2305 `org-element-map'. INFO is modified by side effects."
2309 \f
2310 ;;; The Filter System
2311 ;;
2312 ;; Filters allow end-users to tweak easily the transcoded output.
2313 ;; They are the functional counterpart of hooks, as every filter in
2314 ;; a set is applied to the return value of the previous one.
2315 ;;
2316 ;; Every set is back-end agnostic. Although, a filter is always
2317 ;; called, in addition to the string it applies to, with the back-end
2318 ;; used as argument, so it's easy for the end-user to add back-end
2319 ;; specific filters in the set. The communication channel, as
2320 ;; a plist, is required as the third argument.
2321 ;;
2322 ;; From the developer side, filters sets can be installed in the
2323 ;; process with the help of `org-export-define-backend', which
2324 ;; internally stores filters as an alist. Each association has a key
2325 ;; among the following symbols and a function or a list of functions
2326 ;; as value.
2327 ;;
2328 ;; - `:filter-options' applies to the property list containing export
2329 ;; options. Unlike to other filters, functions in this list accept
2330 ;; two arguments instead of three: the property list containing
2331 ;; export options and the back-end. Users can set its value through
2332 ;; `org-export-filter-options-functions' variable.
2333 ;;
2334 ;; - `:filter-parse-tree' applies directly to the complete parsed
2335 ;; tree. Users can set it through
2336 ;; `org-export-filter-parse-tree-functions' variable.
2337 ;;
2338 ;; - `:filter-final-output' applies to the final transcoded string.
2339 ;; Users can set it with `org-export-filter-final-output-functions'
2340 ;; variable
2341 ;;
2342 ;; - `:filter-plain-text' applies to any string not recognized as Org
2343 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2344 ;; configure it.
2345 ;;
2346 ;; - `:filter-TYPE' applies on the string returned after an element or
2347 ;; object of type TYPE has been transcoded. A user can modify
2348 ;; `org-export-filter-TYPE-functions'
2349 ;;
2350 ;; All filters sets are applied with
2351 ;; `org-export-filter-apply-functions' function. Filters in a set are
2352 ;; applied in a LIFO fashion. It allows developers to be sure that
2353 ;; their filters will be applied first.
2354 ;;
2355 ;; Filters properties are installed in communication channel with
2356 ;; `org-export-install-filters' function.
2357 ;;
2358 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2359 ;; `org-export-before-parsing-hook') are run at the beginning of the
2360 ;; export process and just before parsing to allow for heavy structure
2361 ;; modifications.
2364 ;;;; Hooks
2367 "Hook run at the beginning of the export process.
2369 This is run before include keywords and macros are expanded and
2370 Babel code blocks executed, on a copy of the original buffer
2371 being exported. Visibility and narrowing are preserved. Point
2372 is at the beginning of the buffer.
2374 Every function in this hook will be called with one argument: the
2378 "Hook run before parsing an export buffer.
2380 This is run after include keywords and macros have been expanded
2381 and Babel code blocks executed, on a copy of the original buffer
2382 being exported. Visibility and narrowing are preserved. Point
2383 is at the beginning of the buffer.
2385 Every function in this hook will be called with one argument: the
2389 ;;;; Special Filters
2392 "List of functions applied to the export options.
2393 Each filter is called with two arguments: the export options, as
2394 a plist, and the back-end, as a symbol. It must return
2398 "List of functions applied to the parsed tree.
2399 Each filter is called with three arguments: the parse tree, as
2400 returned by `org-element-parse-buffer', the back-end, as
2401 a symbol, and the communication channel, as a plist. It must
2405 "List of functions applied to plain text.
2406 Each filter is called with three arguments: a string which
2407 contains no Org syntax, the back-end, as a symbol, and the
2408 communication channel, as a plist. It must return a string or
2412 "List of functions applied to the transcoded string.
2413 Each filter is called with three arguments: the full transcoded
2414 string, the back-end, as a symbol, and the communication channel,
2415 as a plist. It must return a string that will be used as the
2419 ;;;; Elements Filters
2422 "List of functions applied to a transcoded babel-call.
2423 Each filter is called with three arguments: the transcoded data,
2424 as a string, the back-end, as a symbol, and the communication
2428 "List of functions applied to a transcoded center block.
2429 Each filter is called with three arguments: the transcoded data,
2430 as a string, the back-end, as a symbol, and the communication
2434 "List of functions applied to a transcoded clock.
2435 Each filter is called with three arguments: the transcoded data,
2436 as a string, the back-end, as a symbol, and the communication
2440 "List of functions applied to a transcoded comment.
2441 Each filter is called with three arguments: the transcoded data,
2442 as a string, the back-end, as a symbol, and the communication
2446 "List of functions applied to a transcoded comment-block.
2447 Each filter is called with three arguments: the transcoded data,
2448 as a string, the back-end, as a symbol, and the communication
2452 "List of functions applied to a transcoded diary-sexp.
2453 Each filter is called with three arguments: the transcoded data,
2454 as a string, the back-end, as a symbol, and the communication
2458 "List of functions applied to a transcoded drawer.
2459 Each filter is called with three arguments: the transcoded data,
2460 as a string, the back-end, as a symbol, and the communication
2464 "List of functions applied to a transcoded dynamic-block.
2465 Each filter is called with three arguments: the transcoded data,
2466 as a string, the back-end, as a symbol, and the communication
2470 "List of functions applied to a transcoded example-block.
2471 Each filter is called with three arguments: the transcoded data,
2472 as a string, the back-end, as a symbol, and the communication
2476 "List of functions applied to a transcoded export-block.
2477 Each filter is called with three arguments: the transcoded data,
2478 as a string, the back-end, as a symbol, and the communication
2482 "List of functions applied to a transcoded fixed-width.
2483 Each filter is called with three arguments: the transcoded data,
2484 as a string, the back-end, as a symbol, and the communication
2488 "List of functions applied to a transcoded footnote-definition.
2489 Each filter is called with three arguments: the transcoded data,
2490 as a string, the back-end, as a symbol, and the communication
2494 "List of functions applied to a transcoded headline.
2495 Each filter is called with three arguments: the transcoded data,
2496 as a string, the back-end, as a symbol, and the communication
2500 "List of functions applied to a transcoded horizontal-rule.
2501 Each filter is called with three arguments: the transcoded data,
2502 as a string, the back-end, as a symbol, and the communication
2506 "List of functions applied to a transcoded inlinetask.
2507 Each filter is called with three arguments: the transcoded data,
2508 as a string, the back-end, as a symbol, and the communication
2512 "List of functions applied to a transcoded item.
2513 Each filter is called with three arguments: the transcoded data,
2514 as a string, the back-end, as a symbol, and the communication
2518 "List of functions applied to a transcoded keyword.
2519 Each filter is called with three arguments: the transcoded data,
2520 as a string, the back-end, as a symbol, and the communication
2524 "List of functions applied to a transcoded latex-environment.
2525 Each filter is called with three arguments: the transcoded data,
2526 as a string, the back-end, as a symbol, and the communication
2530 "List of functions applied to a transcoded node-property.
2531 Each filter is called with three arguments: the transcoded data,
2532 as a string, the back-end, as a symbol, and the communication
2536 "List of functions applied to a transcoded paragraph.
2537 Each filter is called with three arguments: the transcoded data,
2538 as a string, the back-end, as a symbol, and the communication
2542 "List of functions applied to a transcoded plain-list.
2543 Each filter is called with three arguments: the transcoded data,
2544 as a string, the back-end, as a symbol, and the communication
2548 "List of functions applied to a transcoded planning.
2549 Each filter is called with three arguments: the transcoded data,
2550 as a string, the back-end, as a symbol, and the communication
2554 "List of functions applied to a transcoded property-drawer.
2555 Each filter is called with three arguments: the transcoded data,
2556 as a string, the back-end, as a symbol, and the communication
2560 "List of functions applied to a transcoded quote block.
2561 Each filter is called with three arguments: the transcoded quote
2562 data, as a string, the back-end, as a symbol, and the
2563 communication channel, as a plist. It must return a string or
2567 "List of functions applied to a transcoded quote-section.
2568 Each filter is called with three arguments: the transcoded data,
2569 as a string, the back-end, as a symbol, and the communication
2573 "List of functions applied to a transcoded section.
2574 Each filter is called with three arguments: the transcoded data,
2575 as a string, the back-end, as a symbol, and the communication
2579 "List of functions applied to a transcoded special block.
2580 Each filter is called with three arguments: the transcoded data,
2581 as a string, the back-end, as a symbol, and the communication
2585 "List of functions applied to a transcoded src-block.
2586 Each filter is called with three arguments: the transcoded data,
2587 as a string, the back-end, as a symbol, and the communication
2591 "List of functions applied to a transcoded table.
2592 Each filter is called with three arguments: the transcoded data,
2593 as a string, the back-end, as a symbol, and the communication
2597 "List of functions applied to a transcoded table-cell.
2598 Each filter is called with three arguments: the transcoded data,
2599 as a string, the back-end, as a symbol, and the communication
2603 "List of functions applied to a transcoded table-row.
2604 Each filter is called with three arguments: the transcoded data,
2605 as a string, the back-end, as a symbol, and the communication
2609 "List of functions applied to a transcoded verse block.
2610 Each filter is called with three arguments: the transcoded data,
2611 as a string, the back-end, as a symbol, and the communication
2615 ;;;; Objects Filters
2618 "List of functions applied to transcoded bold text.
2619 Each filter is called with three arguments: the transcoded data,
2620 as a string, the back-end, as a symbol, and the communication
2624 "List of functions applied to transcoded code text.
2625 Each filter is called with three arguments: the transcoded data,
2626 as a string, the back-end, as a symbol, and the communication
2630 "List of functions applied to a transcoded entity.
2631 Each filter is called with three arguments: the transcoded data,
2632 as a string, the back-end, as a symbol, and the communication
2636 "List of functions applied to a transcoded export-snippet.
2637 Each filter is called with three arguments: the transcoded data,
2638 as a string, the back-end, as a symbol, and the communication
2642 "List of functions applied to a transcoded footnote-reference.
2643 Each filter is called with three arguments: the transcoded data,
2644 as a string, the back-end, as a symbol, and the communication
2648 "List of functions applied to a transcoded inline-babel-call.
2649 Each filter is called with three arguments: the transcoded data,
2650 as a string, the back-end, as a symbol, and the communication
2654 "List of functions applied to a transcoded inline-src-block.
2655 Each filter is called with three arguments: the transcoded data,
2656 as a string, the back-end, as a symbol, and the communication
2660 "List of functions applied to transcoded italic text.
2661 Each filter is called with three arguments: the transcoded data,
2662 as a string, the back-end, as a symbol, and the communication
2666 "List of functions applied to a transcoded latex-fragment.
2667 Each filter is called with three arguments: the transcoded data,
2668 as a string, the back-end, as a symbol, and the communication
2672 "List of functions applied to a transcoded line-break.
2673 Each filter is called with three arguments: the transcoded data,
2674 as a string, the back-end, as a symbol, and the communication
2678 "List of functions applied to a transcoded link.
2679 Each filter is called with three arguments: the transcoded data,
2680 as a string, the back-end, as a symbol, and the communication
2684 "List of functions applied to a transcoded radio-target.
2685 Each filter is called with three arguments: the transcoded data,
2686 as a string, the back-end, as a symbol, and the communication
2690 "List of functions applied to a transcoded statistics-cookie.
2691 Each filter is called with three arguments: the transcoded data,
2692 as a string, the back-end, as a symbol, and the communication
2696 "List of functions applied to transcoded strike-through text.
2697 Each filter is called with three arguments: the transcoded data,
2698 as a string, the back-end, as a symbol, and the communication
2702 "List of functions applied to a transcoded subscript.
2703 Each filter is called with three arguments: the transcoded data,
2704 as a string, the back-end, as a symbol, and the communication
2708 "List of functions applied to a transcoded superscript.
2709 Each filter is called with three arguments: the transcoded data,
2710 as a string, the back-end, as a symbol, and the communication
2714 "List of functions applied to a transcoded target.
2715 Each filter is called with three arguments: the transcoded data,
2716 as a string, the back-end, as a symbol, and the communication
2720 "List of functions applied to a transcoded timestamp.
2721 Each filter is called with three arguments: the transcoded data,
2722 as a string, the back-end, as a symbol, and the communication
2726 "List of functions applied to transcoded underline text.
2727 Each filter is called with three arguments: the transcoded data,
2728 as a string, the back-end, as a symbol, and the communication
2732 "List of functions applied to transcoded verbatim text.
2733 Each filter is called with three arguments: the transcoded data,
2734 as a string, the back-end, as a symbol, and the communication
2738 ;;;; Filters Tools
2739 ;;
2740 ;; Internal function `org-export-install-filters' installs filters
2741 ;; hard-coded in back-ends (developer filters) and filters from global
2742 ;; variables (user filters) in the communication channel.
2743 ;;
2744 ;; Internal function `org-export-filter-apply-functions' takes care
2745 ;; about applying each filter in order to a given data. It ignores
2746 ;; filters returning a nil value but stops whenever a filter returns
2747 ;; an empty string.
2750 "Call every function in FILTERS.
2752 Functions are called with arguments VALUE, current export
2753 back-end's name and INFO. A function returning a nil value will
2754 be skipped. If it returns the empty string, the process ends and
2755 VALUE is ignored.
2757 Call is done in a LIFO fashion, to be sure that developer
2758 specified filters, if any, are called first."
2769 "Install filters properties in communication channel.
2770 INFO is a plist containing the current communication channel.
2771 Return the updated communication channel."
2773 ;; Install user-defined filters with `org-export-filters-alist'
2774 ;; and filters already in INFO (through ext-plist mechanism).
2781 ;; Filters in INFO will be called
2782 ;; before those user provided.
2785 default-value)))))
2786 org-export-filters-alist)
2787 ;; Prepend back-end specific filters to that list.
2789 ;; Single values get consed, lists are appended.
2794 plist key
2798 ;; Return new communication channel.
2802 \f
2803 ;;; Core functions
2804 ;;
2805 ;; This is the room for the main function, `org-export-as', along with
2806 ;; its derivative, `org-export-string-as'.
2807 ;; `org-export--copy-to-kill-ring-p' determines if output of these
2808 ;; function should be added to kill ring.
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.
2975 tree)
2976 ;; Update communication channel and get parse tree. Buffer
2977 ;; isn't parsed directly. Instead, a temporary copy is
2978 ;; created, where include keywords, macros are expanded and
2979 ;; code blocks are evaluated.
2981 ;; Run first hook with current back-end's name as argument.
2985 ;; Update macro templates since #+INCLUDE keywords might have
2986 ;; added some new ones.
2990 ;; Update radio targets since keyword inclusion might have
2991 ;; added some more.
2993 ;; Run last hook with current back-end's name as argument.
2998 ;; Update communication channel with environment. Also
2999 ;; install user's and developer's filters.
3004 ;; Expand export-specific set of macros: {{{author}}},
3005 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3006 ;; once regular macros have been expanded, since document
3007 ;; keywords may contain one of them.
3013 ;; EMAIL is not a parsed keyword: store it as-is.
3017 ;; Call options filters and update export options. We do not
3018 ;; use `org-export-filter-apply-functions' here since the
3019 ;; arity of such filters is different.
3024 ;; Parse buffer and call parse-tree filter on it.
3029 ;; Now tree is complete, compute its properties and add them
3030 ;; to communication channel.
3034 ;; Eventually transcode TREE. Wrap the resulting string into
3035 ;; a template.
3044 ;; Remove all text properties since they cannot be
3045 ;; retrieved from an external process. Finally call
3046 ;; final-output filter and return result.
3052 info))))))))
3054 ;;;###autoload
3056 "Transcode STRING into BACKEND code.
3058 BACKEND is either an export back-end, as returned by, e.g.,
3059 `org-export-create-backend', or a symbol referring to
3060 a registered back-end.
3062 When optional argument BODY-ONLY is non-nil, only return body
3063 code, without preamble nor postamble.
3065 Optional argument EXT-PLIST, when provided, is a property list
3066 with external parameters overriding Org default settings, but
3067 still inferior to file-local settings.
3069 Return code as a string."
3075 ;;;###autoload
3077 "Replace the active region by its export to BACKEND.
3078 BACKEND is either an export back-end, as returned by, e.g.,
3079 `org-export-create-backend', or a symbol referring to
3080 a registered back-end."
3090 ;;;###autoload
3092 "Insert all export keywords with default values at beginning of line.
3094 BACKEND is a symbol referring to the name of a registered export
3095 back-end, for which specific export options should be added to
3096 the template, or `default' for default template. When it is nil,
3097 the user will be prompted for a category.
3099 If SUBTREEP is non-nil, export configuration will be set up
3100 locally for the subtree through node properties."
3110 "Options category: "
3114 org-export--registered-backends))))))
3115 options keywords)
3116 ;; Populate OPTIONS and KEYWORDS.
3133 ;; Move to an appropriate location in order to insert options.
3135 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3136 ;; list of available keywords.
3164 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3182 ;; And the rest of keywords.
3193 "Expand every include keyword in buffer.
3194 Optional argument INCLUDED is a list of included file names along
3195 with their line restriction, when appropriate. It is used to
3196 avoid infinite recursion. Optional argument DIR is the current
3197 working directory. It is used to properly resolve relative
3198 paths."
3205 ;; Extract arguments from keyword's value.
3213 dir)
3218 value)
3224 ;; Minimal level of included file defaults to the child
3225 ;; level of the current headline, if any, or one. It
3226 ;; only applies is the file is meant to be included as
3227 ;; an Org one.
3235 ;; Remove keyword.
3241 ;; Check if files has already been parsed. Look after
3242 ;; inclusion lines too, as different parts of the same file
3243 ;; can be included too.
3255 ind-str contents ind-str))))
3263 ind-str env contents ind-str))))
3276 "Prepare the contents of FILE for inclusion and return them as a string.
3278 When optional argument LINES is a string specifying a range of
3279 lines, include only those lines.
3281 Optional argument IND, when non-nil, is an integer specifying the
3282 global indentation of returned contents. Since its purpose is to
3283 allow an included file to stay in the same environment it was
3284 created \(i.e. a list item), it doesn't apply past the first
3285 headline encountered.
3287 Optional argument MINLEVEL, when non-nil, is an integer
3288 specifying the level that any top-level headline in the included
3289 file should have."
3305 ;; Remove blank lines at beginning and end of contents. The logic
3306 ;; behind that removal is that blank lines around include keyword
3307 ;; override blank lines in included file.
3316 ;; If IND is set, preserve indentation of include keyword until
3317 ;; the first headline encountered.
3324 ;; Do not move footnote definitions out of column 0.
3330 ;; When MINLEVEL is specified, compute minimal level for headlines
3331 ;; in the file (CUR-MIN), and remove stars to each headline so
3332 ;; that headlines with minimal level have a level of MINLEVEL.
3343 ;; Only change stars, don't bother moving whole
3344 ;; sections.
3351 "Execute every Babel code in the visible part of current buffer."
3352 ;; Get a pristine copy of current buffer so Babel references can be
3353 ;; properly resolved.
3360 "Return a non-nil value when output should be added to the kill ring.
3361 See also `org-export-copy-to-kill-ring'."
3367 \f
3368 ;;; Tools For Back-Ends
3369 ;;
3370 ;; A whole set of tools is available to help build new exporters. Any
3371 ;; function general enough to have its use across many back-ends
3372 ;; should be added here.
3374 ;;;; For Affiliated Keywords
3375 ;;
3376 ;; `org-export-read-attribute' reads a property from a given element
3377 ;; as a plist. It can be used to normalize affiliated keywords'
3378 ;; syntax.
3379 ;;
3380 ;; Since captions can span over multiple lines and accept dual values,
3381 ;; their internal representation is a bit tricky. Therefore,
3382 ;; `org-export-get-caption' transparently returns a given element's
3383 ;; caption as a secondary string.
3386 "Turn ATTRIBUTE property from ELEMENT into a plist.
3388 When optional argument PROPERTY is non-nil, return the value of
3389 that property within attributes.
3393 properties.
3395 All values will become strings except the empty string and
3398 will become the empty string."
3412 s)
3417 ;; Ignore any string before first property with `cdr'.
3422 "Return caption from ELEMENT as a secondary string.
3424 When optional argument SHORTP is non-nil, return short caption,
3425 as a secondary string, instead.
3427 Caption lines are separated by a white space."
3435 ;;;; For Derived Back-ends
3436 ;;
3437 ;; `org-export-with-backend' is a function allowing to locally use
3438 ;; another back-end to transcode some object or element. In a derived
3439 ;; back-end, it may be used as a fall-back function once all specific
3440 ;; cases have been treated.
3443 "Call a transcoder from BACKEND on DATA.
3444 BACKEND is an export back-end, as returned by, e.g.,
3445 `org-export-create-backend', or a symbol referring to
3446 a registered back-end. DATA is an Org element, object, secondary
3447 string or string. CONTENTS, when non-nil, is the transcoded
3448 contents of DATA element, as a string. INFO, when non-nil, is
3449 the communication channel used for export, as a plist."
3459 transcoder data contents
3462 :translate-alist all-transcoders
3466 ;;;; For Export Snippets
3467 ;;
3468 ;; Every export snippet is transmitted to the back-end. Though, the
3469 ;; latter will only retain one type of export-snippet, ignoring
3470 ;; others, based on the former's target back-end. The function
3471 ;; `org-export-snippet-backend' returns that back-end for a given
3472 ;; export-snippet.
3475 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3476 Translation, with `org-export-snippet-translation-alist', is
3477 applied."
3481 back-end))))
3484 ;;;; For Footnotes
3485 ;;
3486 ;; `org-export-collect-footnote-definitions' is a tool to list
3487 ;; actually used footnotes definitions in the whole parse tree, or in
3488 ;; a headline, in order to add footnote listings throughout the
3489 ;; transcoded data.
3490 ;;
3491 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3492 ;; back-ends, when they need to attach the footnote definition only to
3493 ;; the first occurrence of the corresponding label.
3494 ;;
3495 ;; `org-export-get-footnote-definition' and
3496 ;; `org-export-get-footnote-number' provide easier access to
3497 ;; additional information relative to a footnote reference.
3500 "Return an alist between footnote numbers, labels and definitions.
3502 DATA is the parse tree from which definitions are collected.
3503 INFO is the plist used as a communication channel.
3505 Definitions are sorted by order of references. They either
3506 appear as Org data or as a secondary string for inlined
3507 footnotes. Unreferenced definitions are ignored."
3509 collect-fn ; for byte-compiler.
3513 ;; Collect footnote number, label and definition in DATA.
3521 def)
3522 num-alist)
3523 ;; Also search in definition for nested footnotes.
3526 ;; Don't enter footnote definitions since it will happen
3527 ;; when their first reference is found.
3533 "Non-nil when a footnote reference is the first one for its label.
3535 FOOTNOTE-REFERENCE is the footnote reference being considered.
3536 INFO is the plist used as a communication channel."
3538 ;; Anonymous footnotes are always a first reference.
3540 ;; Otherwise, return the first footnote with the same LABEL and
3541 ;; test if it is equal to FOOTNOTE-REFERENCE.
3551 ;; If FN isn't inlined, be sure to traverse its
3552 ;; definition before resuming search. See
3553 ;; comments in `org-export-get-footnote-number'
3554 ;; for more information.
3558 ;; Don't enter footnote definitions since it will
3559 ;; happen when their first reference is found.
3562 footnote-reference)))))
3565 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3566 INFO is the plist used as a communication channel. If no such
3568 string."
3575 "Return number associated to a footnote.
3577 FOOTNOTE is either a footnote reference or a footnote definition.
3578 INFO is the plist used as a communication channel."
3580 seen-refs
3581 search-ref ; For byte-compiler.
3585 ;; Search footnote references through DATA, filling
3586 ;; SEEN-REFS along the way.
3591 ;; Anonymous footnote match: return number.
3594 ;; Labels match: return number.
3597 ;; Anonymous footnote: it's always a new one.
3598 ;; Also, be sure to return nil from the `cond' so
3599 ;; `first-match' doesn't get us out of the loop.
3601 ;; Label not seen so far: add it so SEEN-REFS.
3602 ;;
3603 ;; Also search for subsequent references in
3604 ;; footnote definition so numbering follows
3605 ;; reading logic. Note that we don't have to care
3606 ;; about inline definitions, since
3607 ;; `org-element-map' already traverses them at the
3608 ;; right time.
3609 ;;
3610 ;; Once again, return nil to stay in the loop.
3615 nil))))
3616 ;; Don't enter footnote definitions since it will
3617 ;; happen when their first reference is found.
3622 ;;;; For Headlines
3623 ;;
3624 ;; `org-export-get-relative-level' is a shortcut to get headline
3625 ;; level, relatively to the lower headline level in the parsed tree.
3626 ;;
3627 ;; `org-export-get-headline-number' returns the section number of an
3628 ;; headline, while `org-export-number-to-roman' allows to convert it
3629 ;; to roman numbers.
3630 ;;
3631 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3632 ;; `org-export-last-sibling-p' are three useful predicates when it
3633 ;; comes to fulfill the `:headline-levels' property.
3634 ;;
3635 ;; `org-export-get-tags', `org-export-get-category' and
3636 ;; `org-export-get-node-property' extract useful information from an
3637 ;; headline or a parent headline. They all handle inheritance.
3638 ;;
3639 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3640 ;; as a secondary string, suitable for table of contents. It falls
3641 ;; back onto default title.
3644 "Return HEADLINE relative level within current parsed tree.
3645 INFO is a plist holding contextual information."
3650 "Non-nil when HEADLINE is considered as low level.
3652 INFO is a plist used as a communication channel.
3654 A low level headlines has a relative level greater than
3655 `:headline-levels' property value.
3657 Return value is the difference between HEADLINE relative level
3658 and the last level being considered as high enough, or nil."
3665 "Return HEADLINE numbering as a list of numbers.
3666 INFO is a plist holding contextual information."
3670 "Return a non-nil value if HEADLINE element should be numbered.
3671 INFO is a plist used as a communication channel."
3677 "Convert integer N into a roman numeral."
3690 res)))
3693 "Return list of tags associated to ELEMENT.
3695 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3696 is a plist used as a communication channel.
3698 Select tags (see `org-export-select-tags') and exclude tags (see
3699 `org-export-exclude-tags') are removed from the list.
3701 When non-nil, optional argument TAGS should be a list of strings.
3702 Any tag belonging to this list will also be removed.
3704 When optional argument INHERITED is non-nil, tags can also be
3705 inherited from parent headlines and FILETAGS keywords."
3711 ;; Build complete list of inherited tags.
3722 ;; Add FILETAGS keywords and return results.
3726 "Return node PROPERTY value for BLOB.
3728 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3729 element or object.
3731 If optional argument INHERITED is non-nil, the value can be
3732 inherited from a parent headline.
3734 Return value is a string or nil."
3746 "Return category for element or object BLOB.
3748 INFO is a plist used as a communication channel.
3750 CATEGORY is automatically inherited from a parent headline, from
3751 #+CATEGORY: keyword or created out of original file name. If all
3755 ;; Almost like `org-export-node-property', but we cannot trust
3756 ;; `plist-member' as every headline has a `:CATEGORY'
3757 ;; property, would it be nil or equal to "???" (which has the
3758 ;; same meaning).
3776 "Return alternative title for HEADLINE, as a secondary string.
3777 INFO is a plist used as a communication channel. If no optional
3778 title is defined, fall-back to the regular title."
3783 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3784 INFO is a plist used as a communication channel."
3789 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3790 INFO is a plist used as a communication channel."
3794 ;;;; For Keywords
3795 ;;
3796 ;; `org-export-get-date' returns a date appropriate for the document
3797 ;; to about to be exported. In particular, it takes care of
3798 ;; `org-export-date-timestamp-format'.
3801 "Return date value for the current document.
3803 INFO is a plist used as a communication channel. FMT, when
3804 non-nil, is a time format string that will be applied on the date
3805 if it consists in a single timestamp object. It defaults to
3806 `org-export-date-timestamp-format' when nil.
3808 A proper date can be a secondary string, a string or nil. It is
3809 meant to be translated with `org-export-data' or alike."
3820 ;;;; For Links
3821 ;;
3822 ;; `org-export-solidify-link-text' turns a string into a safer version
3823 ;; for links, replacing most non-standard characters with hyphens.
3824 ;;
3825 ;; `org-export-get-coderef-format' returns an appropriate format
3826 ;; string for coderefs.
3827 ;;
3828 ;; `org-export-inline-image-p' returns a non-nil value when the link
3829 ;; provided should be considered as an inline image.
3830 ;;
3831 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3832 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3833 ;; returns an appropriate unique identifier when found, or nil.
3834 ;;
3835 ;; `org-export-resolve-id-link' returns the first headline with
3836 ;; specified id or custom-id in parse tree, the path to the external
3837 ;; file with the id or nil when neither was found.
3838 ;;
3839 ;; `org-export-resolve-coderef' associates a reference to a line
3840 ;; number in the element it belongs, or returns the reference itself
3841 ;; when the element isn't numbered.
3844 "Take link text S and make a safe target out of it."
3849 "Return format string for code reference link.
3850 PATH is the link path. DESC is its description."
3858 "Non-nil if LINK object points to an inline image.
3860 Optional argument is a set of RULES defining inline images. It
3861 is an alist where associations have the following shape:
3863 \(TYPE . REGEXP)
3865 Applying a rule means apply REGEXP against LINK's path when its
3866 type is TYPE. The function will return a non-nil value if any of
3867 the provided rules is non-nil. The default rule is
3868 `org-export-default-inline-image-rule'.
3870 This only applies to links without a description."
3881 rules)
3882 ;; Return nil if no rule matched.
3883 nil))))
3886 "Resolve a code reference REF.
3888 INFO is a plist used as a communication channel.
3890 Return associated line number in source code, or REF itself,
3891 depending on src-block or example element's switches."
3898 org-coderef-label-format)))
3902 ;; Element containing REF is found. Resolve it to either
3903 ;; a label or a line number, as needed.
3913 "Return LINK destination.
3915 INFO is a plist holding contextual information.
3917 Return value can be an object, an element, or nil:
3919 - If LINK path matches a target object (i.e. <<path>>) return it.
3921 - If LINK path exactly matches the name affiliated keyword
3922 \(i.e. #+NAME: path) of an element, return that element.
3924 - If LINK path exactly matches any headline name, return that
3925 element. If more than one headline share that name, priority
3926 will be given to the one with the closest common ancestor, if
3927 any, or the first one in the parse tree otherwise.
3929 - Otherwise, return nil.
3932 significant."
3935 ;; Split PATH at white spaces so matches are space
3936 ;; insensitive.
3939 ;; Cache for destinations that are not position dependent.
3947 ;; Destination is not position dependent: use cached value.
3949 ;; First try to find a matching "<<path>>" unless user specified
3950 ;; he was looking for a headline (path starts with a "*"
3951 ;; character).
3957 path)
3958 blob))
3961 ;; Then try to find an element with a matching "#+NAME: path"
3962 ;; affiliated keyword.
3965 org-element-all-elements
3970 el)))
3973 ;; Last case: link either points to a headline or to nothingness.
3974 ;; Try to find the source, with priority given to headlines with
3975 ;; the closest common ancestor. If such candidate is found,
3976 ;; return it, otherwise return nil.
3980 ;; Return first headline whose `:raw-value' property is
3981 ;; NAME in parse tree DATA, or nil. Statistics cookies
3982 ;; are ignored.
3990 name)
3991 headline))
3993 ;; Search among headlines sharing an ancestor with link, from
3994 ;; closest to farthest.
4003 ;; No destination found: return nil.
4007 "Return headline referenced as LINK destination.
4009 INFO is a plist used as a communication channel.
4011 Return value can be the headline element matched in current parse
4015 ;; First check if id is within the current parse tree.
4020 headline))
4022 ;; Otherwise, look for external files.
4026 "Return radio-target object referenced as LINK destination.
4028 INFO is a plist used as a communication channel.
4030 Return value can be a radio-target object or nil. Assume LINK
4039 nil nil path nil nil t)
4040 t)
4041 radio))
4045 ;;;; For References
4046 ;;
4047 ;; `org-export-get-ordinal' associates a sequence number to any object
4048 ;; or element.
4051 "Return ordinal number of an element or object.
4053 ELEMENT is the element or object considered. INFO is the plist
4054 used as a communication channel.
4056 Optional argument TYPES, when non-nil, is a list of element or
4057 object types, as symbols, that should also be counted in.
4058 Otherwise, only provided element's type is considered.
4060 Optional argument PREDICATE is a function returning a non-nil
4061 value if the current element or object should be counted in. It
4062 accepts two arguments: the element or object being considered and
4063 the plist used as a communication channel. This allows to count
4064 only a certain type of objects (i.e. inline images).
4066 Return value is a list of numbers if ELEMENT is a headline or an
4067 item. It is nil for keywords. It represents the footnote number
4068 for footnote definitions and footnote references. If ELEMENT is
4069 a target, return the same value as if ELEMENT was the closest
4070 table, item or headline containing the target. In any other
4071 case, return the sequence number of ELEMENT among elements or
4072 objects of the same type."
4073 ;; Ordinal of a target object refer to the ordinal of the closest
4074 ;; table, item, or headline containing the object.
4078 when
4082 table))
4083 return parent)))
4085 ;; Special case 1: A headline returns its number as a list.
4087 ;; Special case 2: An item returns its number as a list.
4091 struct
4098 ;; Increment counter until ELEMENT is found again.
4109 ;;;; For Src-Blocks
4110 ;;
4111 ;; `org-export-get-loc' counts number of code lines accumulated in
4112 ;; src-block or example-block elements with a "+n" switch until
4113 ;; a given element, excluded. Note: "-n" switches reset that count.
4114 ;;
4115 ;; `org-export-unravel-code' extracts source code (along with a code
4116 ;; references alist) from an `element-block' or `src-block' type
4117 ;; element.
4118 ;;
4119 ;; `org-export-format-code' applies a formatting function to each line
4120 ;; of code, providing relative line number and code reference when
4121 ;; appropriate. Since it doesn't access the original element from
4122 ;; which the source code is coming, it expects from the code calling
4123 ;; it to know if lines should be numbered and if code references
4124 ;; should appear.
4125 ;;
4126 ;; Eventually, `org-export-format-code-default' is a higher-level
4127 ;; function (it makes use of the two previous functions) which handles
4128 ;; line numbering and code references inclusion, and returns source
4129 ;; code in a format suitable for plain text or verbatim output.
4132 "Return accumulated lines of code up to ELEMENT.
4134 INFO is the plist used as a communication channel.
4136 ELEMENT is excluded from count."
4142 ;; ELEMENT is reached: Quit the loop.
4144 ;; Only count lines from src-block and example-block elements
4145 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4149 ;; Accumulate locs or reset them.
4153 ;; Return nil to stay in the loop.
4154 nil)))
4156 ;; Return value.
4157 loc))
4160 "Clean source code and extract references out of it.
4162 ELEMENT has either a `src-block' an `example-block' type.
4164 Return a cons cell whose CAR is the source code, cleaned from any
4165 reference and protective comma and CDR is an alist between
4166 relative line number (integer) and name of code reference on that
4167 line (string)."
4169 ;; Get code and clean it. Remove blank lines at its
4170 ;; beginning and end.
4176 ;; Get format used for references.
4179 org-coderef-label-format)))
4180 ;; Build a regexp matching a loc with a reference.
4185 ;; Return value.
4187 ;; Code with references removed.
4193 ;; Ref line: remove ref, and signal its position in REFS.
4197 ;; Reference alist.
4198 refs)))
4201 "Format CODE by applying FUN line-wise and return it.
4203 CODE is a string representing the code to format. FUN is
4204 a function. It must accept three arguments: a line of
4205 code (string), the current line number (integer) or nil and the
4206 reference associated to the current line (string) or nil.
4208 Optional argument NUM-LINES can be an integer representing the
4209 number of code lines accumulated until the current code. Line
4210 numbers passed to FUN will take it into account. If it is nil,
4211 FUN's second argument will always be nil. This number can be
4212 obtained with `org-export-get-loc' function.
4214 Optional argument REF-ALIST can be an alist between relative line
4215 number (i.e. ignoring NUM-LINES) and the name of the code
4216 reference on it. If it is nil, FUN's third argument will always
4217 be nil. It can be obtained through the use of
4218 `org-export-unravel-code' function."
4230 "Return source code from ELEMENT, formatted in a standard way.
4232 ELEMENT is either a `src-block' or `example-block' element. INFO
4233 is a plist used as a communication channel.
4235 This function takes care of line numbering and code references
4236 inclusion. Line numbers, when applicable, appear at the
4237 beginning of the line, separated from the code by two white
4238 spaces. Code references, on the other hand, appear flushed to
4239 the right, separated by six white spaces from the widest line of
4240 code."
4241 ;; Extract code and references.
4248 ;; Handle line numbering.
4257 ;; Prepare references display, if required. Any reference
4258 ;; should start six columns after the widest line of code,
4259 ;; wrapped with parenthesis.
4264 code
4268 number-str
4269 loc
4275 num-start refs)))))
4278 ;;;; For Tables
4279 ;;
4280 ;; `org-export-table-has-special-column-p' and and
4281 ;; `org-export-table-row-is-special-p' are predicates used to look for
4282 ;; meta-information about the table structure.
4283 ;;
4284 ;; `org-table-has-header-p' tells when the rows before the first rule
4285 ;; should be considered as table's header.
4286 ;;
4287 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4288 ;; and `org-export-table-cell-borders' extract information from
4289 ;; a table-cell element.
4290 ;;
4291 ;; `org-export-table-dimensions' gives the number on rows and columns
4292 ;; in the table, ignoring horizontal rules and special columns.
4293 ;; `org-export-table-cell-address', given a table-cell object, returns
4294 ;; the absolute address of a cell. On the other hand,
4295 ;; `org-export-get-table-cell-at' does the contrary.
4296 ;;
4297 ;; `org-export-table-cell-starts-colgroup-p',
4298 ;; `org-export-table-cell-ends-colgroup-p',
4299 ;; `org-export-table-row-starts-rowgroup-p',
4300 ;; `org-export-table-row-ends-rowgroup-p',
4301 ;; `org-export-table-row-starts-header-p' and
4302 ;; `org-export-table-row-ends-header-p' indicate position of current
4303 ;; row or cell within the table.
4306 "Non-nil when TABLE has a special column.
4307 All special columns will be ignored during export."
4308 ;; The table has a special column when every first cell of every row
4309 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4310 ;; "*" "_" and "^". Though, do not consider a first row containing
4311 ;; only empty cells as special.
4327 "Non-nil when TABLE has a header.
4329 INFO is a plist used as a communication channel.
4331 A table has a header when it contains at least two row groups."
4340 table
4351 cache)))))
4354 "Non-nil if TABLE-ROW is considered special.
4356 INFO is a plist used as the communication channel.
4358 All special rows will be ignored during export."
4362 ;; A row is special either when...
4364 ;; ... it starts with a field only containing "/",
4366 ;; ... the table contains a special column and the row start
4367 ;; with a marking character among, "^", "_", "$" or "!",
4371 ;; ... it contains only alignment cookies and empty cells.
4377 ;; Since VALUE is a secondary string, the following
4378 ;; checks avoid expanding it with `org-export-data'.
4390 "Return TABLE-ROW's group number, as an integer.
4392 INFO is a plist used as the communication channel.
4394 Return value is the group number, as an integer, or nil for
4395 special rows and rows separators. First group is also table's
4396 header."
4414 "Return TABLE-CELL contents width.
4416 INFO is a plist used as the communication channel.
4418 Return value is the width given by the last width cookie in the
4419 same column as TABLE-CELL, or nil."
4438 ;; In a special row, try to find a width cookie at COLUMN.
4442 ;; The following checks avoid expanding unnecessarily
4443 ;; the cell with `org-export-data'.
4453 "Return TABLE-CELL contents alignment.
4455 INFO is a plist used as the communication channel.
4457 Return alignment as specified by the last alignment cookie in the
4458 same column as TABLE-CELL. If no such cookie is found, a default
4459 alignment value will be deduced from fraction of numbers in the
4460 column (see `org-table-number-fraction' for more information).
4461 Possible values are `left', `right' and `center'."
4462 ;; Load `org-table-number-fraction' and `org-table-number-regexp'.
4479 cookie-align
4480 previous-cell-number-p)
4483 ;; In a special row, try to find an alignment cookie at
4484 ;; COLUMN.
4488 ;; Since VALUE is a secondary string, the following
4489 ;; checks avoid useless expansion through
4490 ;; `org-export-data'.
4498 ;; Ignore table rules.
4500 ;; In a standard row, check if cell's contents are
4501 ;; expressing some kind of number. Increase NUMBER-CELLS
4502 ;; accordingly. Though, don't bother if an alignment
4503 ;; cookie has already defined cell's alignment.
4508 info)))
4510 ;; Treat an empty cell as a number if it follows
4511 ;; a number.
4517 ;; Return value. Alignment specified by cookies has
4518 ;; precedence over alignment deduced from cell's contents.
4520 column
4525 org-table-number-fraction)
4530 "Return TABLE-CELL borders.
4532 INFO is a plist used as a communication channel.
4534 Return value is a list of symbols, or nil. Possible values are:
4535 `top', `bottom', `above', `below', `left' and `right'. Note:
4536 `top' (resp. `bottom') only happen for a cell in the first
4537 row (resp. last row) of the table, ignoring table rules, if any.
4539 Returned borders ignore special rows."
4542 borders)
4543 ;; Top/above border? TABLE-CELL has a border above when a rule
4544 ;; used to demarcate row groups can be found above. Hence,
4545 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4546 ;; another regular row has to be found above that rule.
4555 ;; Look at every row before the current one.
4557 ;; No rule above, or rule found starts the table (ignoring any
4558 ;; special row): TABLE-CELL is at the top of the table.
4561 ;; Bottom/below border? TABLE-CELL has a border below when next
4562 ;; non-regular row below is a rule.
4571 ;; Look at every row after the current one.
4573 ;; No rule below, or rule found ends the table (modulo some
4574 ;; special row): TABLE-CELL is at the bottom of the table.
4577 ;; Right/left borders? They can only be specified by column
4578 ;; groups. Column groups are defined in a row starting with "/".
4579 ;; Also a column groups row only contains "<", "<>", ">" or blank
4580 ;; cells.
4597 ;; There's a left border when previous cell, if
4598 ;; any, ends a group, or current one starts one.
4604 ;; There's a right border when next cell, if any,
4605 ;; starts a group, or current one ends one.
4612 ;; Table rows are read in reverse order so last column groups
4613 ;; row has precedence over any previous one.
4615 ;; Return value.
4616 borders))
4619 "Non-nil when TABLE-CELL is at the beginning of a row group.
4620 INFO is a plist used as a communication channel."
4621 ;; A cell starts a column group either when it is at the beginning
4622 ;; of a row (or after the special column, if any) or when it has
4623 ;; a left border.
4626 table-cell)
4630 "Non-nil when TABLE-CELL is at the end of a row group.
4631 INFO is a plist used as a communication channel."
4632 ;; A cell ends a column group either when it is at the end of a row
4633 ;; or when it has a right border.
4636 table-cell)
4640 "Non-nil when TABLE-ROW is at the beginning of a column group.
4641 INFO is a plist used as a communication channel."
4649 "Non-nil when TABLE-ROW is at the end of a column group.
4650 INFO is a plist used as a communication channel."
4658 "Non-nil when TABLE-ROW is the first table header's row.
4659 INFO is a plist used as a communication channel."
4666 "Non-nil when TABLE-ROW is the last table header's row.
4667 INFO is a plist used as a communication channel."
4674 "Return TABLE-ROW number.
4675 INFO is a plist used as a communication channel. Return value is
4676 zero-based and ignores separators. The function returns nil for
4677 special colums and separators."
4689 "Return TABLE dimensions.
4691 INFO is a plist used as a communication channel.
4693 Return value is a CONS like (ROWS . COLUMNS) where
4694 ROWS (resp. COLUMNS) is the number of exportable
4695 rows (resp. columns)."
4697 ;; Set number of rows, and extract first one.
4703 ;; Set number of columns.
4705 ;; Return value.
4709 "Return address of a regular TABLE-CELL object.
4711 TABLE-CELL is the cell considered. INFO is a plist used as
4712 a communication channel.
4714 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4715 zero-based index. Only exportable cells are considered. The
4716 function returns nil for other cells."
4728 "Return regular table-cell object at ADDRESS in TABLE.
4730 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4731 zero-based index. TABLE is a table type element. INFO is
4732 a plist used as a communication channel.
4734 If no table-cell, among exportable cells, is found at ADDRESS,
4735 return nil."
4738 ;; Row at (car address) or nil.
4746 'table-cell
4753 ;;;; For Tables Of Contents
4754 ;;
4755 ;; `org-export-collect-headlines' builds a list of all exportable
4756 ;; headline elements, maybe limited to a certain depth. One can then
4757 ;; easily parse it and transcode it.
4758 ;;
4759 ;; Building lists of tables, figures or listings is quite similar.
4760 ;; Once the generic function `org-export-collect-elements' is defined,
4761 ;; `org-export-collect-tables', `org-export-collect-figures' and
4762 ;; `org-export-collect-listings' can be derived from it.
4765 "Collect headlines in order to build a table of contents.
4767 INFO is a plist used as a communication channel.
4769 When optional argument N is an integer, it specifies the depth of
4770 the table of contents. Otherwise, it is set to the value of the
4771 last headline level. See `org-export-headline-levels' for more
4772 information.
4774 Return a list of all exportable headlines as parsed elements.
4775 Footnote sections, if any, will be ignored."
4783 info)))
4786 "Collect referenceable elements of a determined type.
4788 TYPE can be a symbol or a list of symbols specifying element
4789 types to search. Only elements with a caption are collected.
4791 INFO is a plist used as a communication channel.
4793 When non-nil, optional argument PREDICATE is a function accepting
4794 one argument, an element of type TYPE. It returns a non-nil
4795 value when that element should be collected.
4797 Return a list of all elements found, in order of appearance."
4802 element))
4803 info))
4806 "Build a list of tables.
4807 INFO is a plist used as a communication channel.
4809 Return a list of table elements with a caption."
4813 "Build a list of figures.
4815 INFO is a plist used as a communication channel. PREDICATE is
4816 a function which accepts one argument: a paragraph element and
4817 whose return value is non-nil when that element should be
4818 collected.
4820 A figure is a paragraph type element, with a caption, verifying
4822 a vague concept that may depend on back-end.
4824 Return a list of elements recognized as figures."
4828 "Build a list of src blocks.
4830 INFO is a plist used as a communication channel.
4832 Return a list of src-block elements with a caption."
4836 ;;;; Smart Quotes
4837 ;;
4838 ;; The main function for the smart quotes sub-system is
4839 ;; `org-export-activate-smart-quotes', which replaces every quote in
4840 ;; a given string from the parse tree with its "smart" counterpart.
4841 ;;
4842 ;; Dictionary for smart quotes is stored in
4843 ;; `org-export-smart-quotes-alist'.
4844 ;;
4845 ;; Internally, regexps matching potential smart quotes (checks at
4846 ;; string boundaries are also necessary) are defined in
4847 ;; `org-export-smart-quotes-regexps'.
4851 ;; one may use: »...«, "...", ›...‹, or '...'.
4852 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4853 ;; LaTeX quotes require Babel!
4898 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4907 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4916 ;; https://nn.wikipedia.org/wiki/Sitatteikn
4925 ;; based on https://sv.wikipedia.org/wiki/Citattecken
4931 )
4932 "Smart quotes translations.
4934 Alist whose CAR is a language string and CDR is an alist with
4935 quote type as key and a plist associating various encodings to
4936 their translation as value.
4938 A quote type can be any symbol among `opening-double-quote',
4939 `closing-double-quote', `opening-single-quote',
4940 `closing-single-quote' and `apostrophe'.
4942 Valid encodings include `:utf-8', `:html', `:latex' and
4943 `:texinfo'.
4949 ;; Possible opening quote at beginning of string.
4951 ;; Possible closing quote at beginning of string.
4953 ;; Possible apostrophe at beginning of string.
4955 ;; Opening single and double quotes.
4957 ;; Closing single and double quotes.
4959 ;; Apostrophe.
4961 ;; Possible opening quote at end of string.
4963 ;; Possible closing quote at end of string.
4965 ;; Possible apostrophe at end of string.
4967 "List of regexps matching a quote or an apostrophe.
4973 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4974 `:utf-8'. INFO is a plist used as a communication channel.
4976 The function has to retrieve information about string
4977 surroundings in parse tree. It can only happen with an
4978 unmodified string. Thus, if S has already been through another
4979 process, a non-nil ORIGINAL optional argument will provide that
4980 original string.
4982 Return the new string."
4985 ;; Try to be flexible when computing number of blanks
4986 ;; before object. The previous object may be a string
4987 ;; introduced by the back-end and not completely parsed.
4990 ;; A string with missing `:post-blank'
4991 ;; property.
4995 ;; Fallback value.
5000 ;; Return smart quote associated to a give quote Q, as
5001 ;; a string. TYPE is a symbol among `open', `close' and
5002 ;; `apostrophe'.
5012 org-export-smart-quotes-alist))))
5013 encoding)
5014 q)))))
5016 ;; Only a quote: no regexp can match. We have to check both
5017 ;; sides and decide what to do.
5025 ;; 1. Replace quote character at the beginning of S.
5027 ;; Apostrophe?
5033 ;; Closing quote?
5039 ;; Opening quote?
5045 ;; 2. Replace quotes in the middle of the string.
5047 ;; Opening quotes.
5053 ;; Closing quotes.
5059 ;; Apostrophes.
5064 ;; 3. Replace quote character at the end of S.
5066 ;; Apostrophe?
5071 ;; Closing quote?
5077 ;; Opening quote?
5082 ;; Return string with smart quotes.
5083 s))))
5085 ;;;; Topology
5086 ;;
5087 ;; Here are various functions to retrieve information about the
5088 ;; neighbourhood of a given element or object. Neighbours of interest
5089 ;; are direct parent (`org-export-get-parent'), parent headline
5090 ;; (`org-export-get-parent-headline'), first element containing an
5091 ;; object, (`org-export-get-parent-element'), parent table
5092 ;; (`org-export-get-parent-table'), previous element or object
5093 ;; (`org-export-get-previous-element') and next element or object
5094 ;; (`org-export-get-next-element').
5095 ;;
5096 ;; `org-export-get-genealogy' returns the full genealogy of a given
5097 ;; element or object, from closest parent to full parse tree.
5100 "Return BLOB parent or nil.
5101 BLOB is the element or object considered."
5105 "Return full genealogy relative to a given element or object.
5107 BLOB is the element or object being considered.
5109 Ancestors are returned from closest to farthest, the last one
5110 being the full parse tree."
5117 "Return BLOB parent headline or nil.
5118 BLOB is the element or object being considered."
5122 parent))
5125 "Return first element containing OBJECT or nil.
5126 OBJECT is the object to consider."
5130 parent))
5133 "Return OBJECT parent table or nil.
5134 OBJECT is either a `table-cell' or `table-element' type object."
5138 parent))
5141 "Return previous element or object.
5143 BLOB is an element or object. INFO is a plist used as
5144 a communication channel. Return previous exportable element or
5145 object, a string, or nil.
5147 When optional argument N is a positive integer, return a list
5148 containing up to N siblings before BLOB, from farthest to
5149 closest. With any other non-nil value, return a list containing
5150 all of them."
5152 ;; An object can belong to the contents of its parent or
5153 ;; to a secondary string. We check the latter option
5154 ;; first.
5158 org-element-secondary-value-alist))
5159 parent)))
5162 prev)
5171 prev)))
5174 "Return next element or object.
5176 BLOB is an element or object. INFO is a plist used as
5177 a communication channel. Return next exportable element or
5178 object, a string, or nil.
5180 When optional argument N is a positive integer, return a list
5181 containing up to N siblings after BLOB, from closest to farthest.
5182 With any other non-nil value, return a list containing all of
5183 them."
5185 ;; An object can belong to the contents of its parent or to
5186 ;; a secondary string. We check the latter option first.
5190 org-element-secondary-value-alist))
5191 parent)))
5194 next)
5202 siblings)
5206 ;;;; Translation
5207 ;;
5208 ;; `org-export-translate' translates a string according to the language
5209 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5210 ;; the dictionary used for the translation.
5394 "Dictionary for export engine.
5396 Alist whose CAR is the string to translate and CDR is an alist
5397 whose CAR is the language string and CDR is a plist whose
5398 properties are possible charsets and values translated terms.
5400 It is used as a database for `org-export-translate'. Since this
5401 function returns the string as-is if no translation was found,
5402 the variable only needs to record values different from the
5406 "Translate string S according to language specification.
5408 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5409 and `:utf-8'. INFO is a plist used as a communication channel.
5411 Translation depends on `:language' property. Return the
5412 translated string. If no translation is found, try to fall back
5413 to `:default' encoding. If it fails, return S."
5419 s)))
5422 \f
5423 ;;; Asynchronous Export
5424 ;;
5425 ;; `org-export-async-start' is the entry point for asynchronous
5426 ;; export. It recreates current buffer (including visibility,
5427 ;; narrowing and visited file) in an external Emacs process, and
5428 ;; evaluates a command there. It then applies a function on the
5429 ;; returned results in the current process.
5430 ;;
5431 ;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
5432 ;; allow to export to a buffer or a file, asynchronously or not.
5433 ;;
5434 ;; `org-export-output-file-name' is an auxiliary function meant to be
5435 ;; used with `org-export-to-file'. With a given extension, it tries
5436 ;; to provide a canonical file name to write export output to.
5437 ;;
5438 ;; Asynchronously generated results are never displayed directly.
5439 ;; Instead, they are stored in `org-export-stack-contents'. They can
5440 ;; then be retrieved by calling `org-export-stack'.
5441 ;;
5442 ;; Export Stack is viewed through a dedicated major mode
5443 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5444 ;;`org-export-stack-delete', `org-export-stack-view' and
5445 ;;`org-export-stack-clear'.
5446 ;;
5447 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5448 ;; It should be used whenever `org-export-async-start' is called.
5451 "Call function FUN on the results returned by BODY evaluation.
5453 BODY evaluation happens in an asynchronous process, from a buffer
5454 which is an exact copy of the current one.
5456 Use `org-export-add-to-stack' in FUN in order to register results
5457 in the stack.
5459 This is a low level function. See also `org-export-to-buffer'
5460 and `org-export-to-file' for more specialized functions."
5463 ;; Write the full sexp evaluating BODY in a copy of the current
5464 ;; buffer to a temporary file, as it may be too long for program
5465 ;; args in `start-process'.
5472 ;; Null characters (from variable values) are inserted
5473 ;; within the file. As a consequence, coding system for
5474 ;; buffer contents will not be recognized properly. So,
5475 ;; we make sure it is the same as the one used to display
5476 ;; the original buffer.
5478 ,coding
5481 ;; Ignore `kill-emacs-hook' and code evaluation
5482 ;; queries from Babel as we need a truly
5483 ;; non-interactive process.
5485 org-babel-confirm-evaluate-answer-no t)
5486 ;; Initialize export framework.
5488 ;; Re-create current buffer there.
5491 ;; Sexp to evaluate in the buffer.
5493 ;; Start external process.
5496 (,process
5501 "-l" org-export-async-init-file
5503 ;; Register running process in stack.
5505 ;; Set-up sentinel in order to catch results.
5508 ,process
5530 ;;;###autoload
5533 &optional async subtreep visible-only body-only ext-plist
5534 post-process)
5535 "Call `org-export-as' with output to a specified buffer.
5537 BACKEND is either an export back-end, as returned by, e.g.,
5538 `org-export-create-backend', or a symbol referring to
5539 a registered back-end.
5541 BUFFER is the name of the output buffer. If it already exists,
5542 it will be erased first, otherwise, it will be created.
5544 A non-nil optional argument ASYNC means the process should happen
5545 asynchronously. The resulting buffer should then be accessible
5546 through the `org-export-stack' interface. When ASYNC is nil, the
5547 buffer is displayed if `org-export-show-temporary-export-buffer'
5548 is non-nil.
5550 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5551 EXT-PLIST are similar to those used in `org-export-as', which
5552 see.
5554 Optional argument POST-PROCESS is a function which should accept
5555 no argument. It is always called within the current process,
5556 from BUFFER, with point at its beginning. Export back-ends can
5557 use it to set a major mode there, e.g,
5559 \(defun org-latex-export-as-latex
5560 \(&optional async subtreep visible-only body-only ext-plist)
5561 \(interactive)
5563 async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
5565 This function returns BUFFER."
5593 buffer)))
5595 ;;;###autoload
5598 post-process)
5599 "Call `org-export-as' with output to a specified file.
5601 BACKEND is either an export back-end, as returned by, e.g.,
5602 `org-export-create-backend', or a symbol referring to
5603 a registered back-end. FILE is the name of the output file, as
5604 a string.
5606 A non-nil optional argument ASYNC means the process should happen
5607 asynchronously. The resulting buffer file then be accessible
5608 through the `org-export-stack' interface.
5610 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
5611 EXT-PLIST are similar to those used in `org-export-as', which
5612 see.
5614 Optional argument POST-PROCESS is called with FILE as its
5615 argument and happens asynchronously when ASYNC is non-nil. It
5616 has to return a file name, or nil. Export back-ends can use this
5617 to send the output file through additional processing, e.g,
5619 \(defun org-latex-export-to-latex
5620 \(&optional async subtreep visible-only body-only ext-plist)
5621 \(interactive)
5623 \(org-export-to-file 'latex outfile
5624 async subtreep visible-only body-only ext-plist
5625 \(lambda (file) (org-latex-compile file)))
5627 The function returns either a file name returned by POST-PROCESS,
5628 or FILE."
5646 backend subtreep visible-only body-only ext-plist)))
5653 ;; Get proper return value.
5655 file))))))
5658 "Return output file's name according to buffer specifications.
5660 EXTENSION is a string representing the output file extension,
5661 with the leading dot.
5663 With a non-nil optional argument SUBTREEP, try to determine
5665 of subtree at point.
5667 When optional argument PUB-DIR is set, use it as the publishing
5668 directory.
5670 When optional argument VISIBLE-ONLY is non-nil, don't export
5671 contents of hidden elements.
5673 Return file name as a string."
5676 ;; File name may come from EXPORT_FILE_NAME subtree
5677 ;; property, assuming point is at beginning of said
5678 ;; sub-tree.
5685 ;; File name may be extracted from buffer's associated
5686 ;; file, if any.
5688 ;; Can't determine file name on our own: Ask user.
5692 "Output file: " pub-dir nil nil nil
5696 ;; Build file name. Enforce EXTENSION over whatever user
5697 ;; may have come up with. PUB-DIR, if defined, always has
5698 ;; precedence over any provided path.
5703 extension))
5706 ;; If writing to OUTPUT-FILE would overwrite original file, append
5707 ;; EXTENSION another time to final name.
5710 output-file)))
5713 "Add a new result to export stack if not present already.
5715 SOURCE is a buffer or a file name containing export results.
5716 BACKEND is a symbol representing export back-end used to generate
5717 it.
5719 Entries already pointing to SOURCE and unavailable entries are
5720 removed beforehand. Return the new stack."
5726 "Menu for asynchronous export results and running processes."
5736 "Return source from export results at point in stack."
5743 source
5744 ;; SOURCE is not consistent with current line. The stack
5745 ;; view is outdated.
5749 "Remove all entries from export stack."
5754 "Refresh the asynchronous export stack.
5755 DUMMY is ignored. Unavailable sources are removed from the list.
5756 Return the new stack."
5766 ;; Back-end.
5768 ;; Age.
5771 ;; Compute age of the results.
5773 "%4h:%.2m "
5775 ;; Source.
5780 ;; Clear stack from exited processes, dead buffers or
5781 ;; non-existent files.
5793 "Remove export results at point from stack.
5794 If optional argument SOURCE is non-nil, remove it instead."
5799 org-export-stack-contents))))
5802 "View export results at point in stack.
5803 With an optional prefix argument IN-EMACS, force viewing files
5804 within Emacs."
5818 (define-key km "p" 'previous-line)
5819 (define-key km "\C-p" 'previous-line)
5820 (define-key km "\C-?" 'previous-line)
5821 (define-key km [up] 'previous-line)
5822 (define-key km "C" 'org-export-stack-clear)
5823 (define-key km "v" 'org-export-stack-view)
5824 (define-key km (kbd "RET") 'org-export-stack-view)
5825 (define-key km "d" 'org-export-stack-remove)
5826 km)
5827 "Keymap for Org Export Stack.")
5829 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5830 "Mode for displaying asynchronous export stack.
5833 stack.
5835 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5836 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5837 stack completely.
5839 Removing entries in an Org Export Stack buffer doesn't affect
5840 files or buffers, only the display.
5843 (abbrev-mode 0)
5844 (auto-fill-mode 0)
5845 (setq buffer-read-only t
5846 buffer-undo-list t
5847 truncate-lines t
5848 header-line-format
5849 '(:eval
5850 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5851 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5852 (set (make-local-variable 'revert-buffer-function)
5853 'org-export-stack-refresh))
5856 \f
5857 ;;; The Dispatcher
5858 ;;
5859 ;; `org-export-dispatch' is the standard interactive way to start an
5860 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5861 ;; for its interface, which, in turn, delegates response to key
5862 ;; pressed to `org-export--dispatch-action'.
5864 ;;;###autoload
5865 (defun org-export-dispatch (&optional arg)
5866 "Export dispatcher for Org mode.
5868 It provides an access to common export related tasks in a buffer.
5869 Its interface comes in two flavours: standard and expert.
5871 While both share the same set of bindings, only the former
5872 displays the valid keys associations in a dedicated buffer.
5873 Scrolling (resp. line-wise motion) in this buffer is done with
5874 SPC and DEL (resp. C-n and C-p) keys.
5876 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5877 flavour or the other.
5880 of options used back then, on the current buffer.
5882 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5883 (interactive "P")
5884 (let* ((input
5885 (cond ((equal arg '(16)) '(stack))
5886 ((and arg org-export-dispatch-last-action))
5887 (t (save-window-excursion
5888 (unwind-protect
5889 (progn
5890 ;; Remember where we are
5891 (move-marker org-export-dispatch-last-position
5892 (point)
5893 (org-base-buffer (current-buffer)))
5894 ;; Get and store an export command
5895 (setq org-export-dispatch-last-action
5896 (org-export--dispatch-ui
5897 (list org-export-initial-scope
5898 (and org-export-in-background 'async))
5899 nil
5900 org-export-dispatch-use-expert-ui)))
5901 (and (get-buffer "*Org Export Dispatcher*")
5902 (kill-buffer "*Org Export Dispatcher*")))))))
5903 (action (car input))
5904 (optns (cdr input)))
5905 (unless (memq 'subtree optns)
5906 (move-marker org-export-dispatch-last-position nil))
5907 (case action
5908 ;; First handle special hard-coded actions.
5909 (template (org-export-insert-default-template nil optns))
5910 (stack (org-export-stack))
5911 (publish-current-file
5912 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5913 (publish-current-project
5914 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5915 (publish-choose-project
5916 (org-publish (assoc (org-icompleting-read
5917 "Publish project: "
5918 org-publish-project-alist nil t)
5919 org-publish-project-alist)
5920 (memq 'force optns)
5921 (memq 'async optns)))
5922 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5923 (otherwise
5924 (save-excursion
5925 (when arg
5926 ;; Repeating command, maybe move cursor to restore subtree
5927 ;; context.
5928 (if (eq (marker-buffer org-export-dispatch-last-position)
5929 (org-base-buffer (current-buffer)))
5930 (goto-char org-export-dispatch-last-position)
5931 ;; We are in a different buffer, forget position.
5932 (move-marker org-export-dispatch-last-position nil)))
5933 (funcall action
5934 ;; Return a symbol instead of a list to ease
5935 ;; asynchronous export macro use.
5936 (and (memq 'async optns) t)
5937 (and (memq 'subtree optns) t)
5938 (and (memq 'visible optns) t)
5939 (and (memq 'body optns) t)))))))
5941 (defun org-export--dispatch-ui (options first-key expertp)
5942 "Handle interface for `org-export-dispatch'.
5944 OPTIONS is a list containing current interactive options set for
5945 export. It can contain any of the following symbols:
5946 `body' toggles a body-only export
5947 `subtree' restricts export to current subtree
5948 `visible' restricts export to visible part of buffer.
5949 `force' force publishing files.
5950 `async' use asynchronous export process
5952 FIRST-KEY is the key pressed to select the first level menu. It
5953 is nil when this menu hasn't been selected yet.
5955 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5956 buffer is provided, but indications about currently active
5957 options are given in the prompt. Moreover, \[?] allows to switch
5958 back to standard interface."
5959 (let* ((fontify-key
5960 (lambda (key &optional access-key)
5961 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5962 ;; non-nil is the required first-level key to activate
5963 ;; KEY. When its value is t, activate KEY independently
5964 ;; on the first key, if any. A nil value means KEY will
5965 ;; only be activated at first level.
5966 (if (or (eq access-key t) (eq access-key first-key))
5967 (org-propertize key 'face 'org-warning)
5968 key)))
5969 (fontify-value
5970 (lambda (value)
5971 ;; Fontify VALUE string.
5972 (org-propertize value 'face 'font-lock-variable-name-face)))
5973 ;; Prepare menu entries by extracting them from registered
5974 ;; back-ends and sorting them by access key and by ordinal,
5975 ;; if any.
5976 (entries
5977 (sort (sort (delq nil
5978 (mapcar 'org-export-backend-menu
5979 org-export--registered-backends))
5980 (lambda (a b)
5981 (let ((key-a (nth 1 a))
5982 (key-b (nth 1 b)))
5983 (cond ((and (numberp key-a) (numberp key-b))
5984 (< key-a key-b))
5985 ((numberp key-b) t)))))
5986 'car-less-than-car))
5987 ;; Compute a list of allowed keys based on the first key
5988 ;; pressed, if any. Some keys
5989 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
5990 ;; available.
5991 (allowed-keys
5992 (nconc (list 2 22 19 6 1)
5993 (if (not first-key) (org-uniquify (mapcar 'car entries))
5994 (let (sub-menu)
5995 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
5996 (when (eq (car entry) first-key)
5997 (setq sub-menu (append (nth 2 entry) sub-menu))))))
5998 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5999 ((not first-key) (list ?P)))
6000 (list ?& ?#)
6001 (when expertp (list ??))
6002 (list ?q)))
6003 ;; Build the help menu for standard UI.
6004 (help
6005 (unless expertp
6006 (concat
6007 ;; Options are hard-coded.
6008 (format "[%s] Body only: %s [%s] Visible only: %s
6009 \[%s] Export scope: %s [%s] Force publishing: %s
6011 (funcall fontify-key "C-b" t)
6012 (funcall fontify-value
6013 (if (memq 'body options) "On " "Off"))
6014 (funcall fontify-key "C-v" t)
6015 (funcall fontify-value
6016 (if (memq 'visible options) "On " "Off"))
6017 (funcall fontify-key "C-s" t)
6018 (funcall fontify-value
6019 (if (memq 'subtree options) "Subtree" "Buffer "))
6020 (funcall fontify-key "C-f" t)
6021 (funcall fontify-value
6022 (if (memq 'force options) "On " "Off"))
6023 (funcall fontify-key "C-a" t)
6024 (funcall fontify-value
6025 (if (memq 'async options) "On " "Off")))
6026 ;; Display registered back-end entries. When a key
6027 ;; appears for the second time, do not create another
6028 ;; entry, but append its sub-menu to existing menu.
6029 (let (last-key)
6030 (mapconcat
6031 (lambda (entry)
6032 (let ((top-key (car entry)))
6033 (concat
6034 (unless (eq top-key last-key)
6035 (setq last-key top-key)
6037 (funcall fontify-key (char-to-string top-key))
6038 (nth 1 entry)))
6039 (let ((sub-menu (nth 2 entry)))
6040 (unless (functionp sub-menu)
6041 ;; Split sub-menu into two columns.
6042 (let ((index -1))
6043 (concat
6044 (mapconcat
6045 (lambda (sub-entry)
6046 (incf index)
6047 (format
6048 (if (zerop (mod index 2)) " [%s] %-26s"
6050 (funcall fontify-key
6051 (char-to-string (car sub-entry))
6052 top-key)
6053 (nth 1 sub-entry)))
6054 sub-menu "")
6056 entries ""))
6057 ;; Publishing menu is hard-coded.
6059 [%s] Current file [%s] Current project
6061 (funcall fontify-key "P")
6062 (funcall fontify-key "f" ?P)
6063 (funcall fontify-key "p" ?P)
6064 (funcall fontify-key "x" ?P)
6065 (funcall fontify-key "a" ?P))
6067 (funcall fontify-key "&" t)
6068 (funcall fontify-key "#" t))
6069 (format "[%s] %s"
6070 (funcall fontify-key "q" t)
6071 (if first-key "Main menu" "Exit")))))
6072 ;; Build prompts for both standard and expert UI.
6073 (standard-prompt (unless expertp "Export command: "))
6074 (expert-prompt
6075 (when expertp
6076 (format
6077 "Export command (C-%s%s%s%s%s) [%s]: "
6078 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6079 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6080 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6081 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6082 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6083 (mapconcat (lambda (k)
6084 ;; Strip control characters.
6085 (unless (< k 27) (char-to-string k)))
6086 allowed-keys "")))))
6087 ;; With expert UI, just read key with a fancy prompt. In standard
6088 ;; UI, display an intrusive help buffer.
6089 (if expertp
6090 (org-export--dispatch-action
6091 expert-prompt allowed-keys entries options first-key expertp)
6092 ;; At first call, create frame layout in order to display menu.
6093 (unless (get-buffer "*Org Export Dispatcher*")
6094 (delete-other-windows)
6095 (org-switch-to-buffer-other-window
6096 (get-buffer-create "*Org Export Dispatcher*"))
6097 (setq cursor-type nil
6098 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6099 ;; Make sure that invisible cursor will not highlight square
6100 ;; brackets.
6101 (set-syntax-table (copy-syntax-table))
6102 (modify-syntax-entry ?\[ "w"))
6103 ;; At this point, the buffer containing the menu exists and is
6104 ;; visible in the current window. So, refresh it.
6105 (with-current-buffer "*Org Export Dispatcher*"
6106 ;; Refresh help. Maintain display continuity by re-visiting
6107 ;; previous window position.
6108 (let ((pos (window-start)))
6109 (erase-buffer)
6110 (insert help)
6111 (set-window-start nil pos)))
6112 (org-fit-window-to-buffer)
6113 (org-export--dispatch-action
6114 standard-prompt allowed-keys entries options first-key expertp))))
6116 (defun org-export--dispatch-action
6117 (prompt allowed-keys entries options first-key expertp)
6118 "Read a character from command input and act accordingly.
6120 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6121 a list of characters available at a given step in the process.
6122 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6123 EXPERTP are the same as defined in `org-export--dispatch-ui',
6124 which see.
6126 Toggle export options when required. Otherwise, return value is
6127 a list with action as CAR and a list of interactive export
6128 options as CDR."
6129 (let (key)
6130 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6131 ;; C-p, SPC, DEL).
6132 (while (and (setq key (read-char-exclusive prompt))
6133 (not expertp)
6134 (memq key '(14 16 ?\s ?\d)))
6135 (case key
6136 (14 (if (not (pos-visible-in-window-p (point-max)))
6137 (ignore-errors (scroll-up 1))
6138 (message "End of buffer")
6139 (sit-for 1)))
6140 (16 (if (not (pos-visible-in-window-p (point-min)))
6141 (ignore-errors (scroll-down 1))
6142 (message "Beginning of buffer")
6143 (sit-for 1)))
6144 (?\s (if (not (pos-visible-in-window-p (point-max)))
6145 (scroll-up nil)
6146 (message "End of buffer")
6147 (sit-for 1)))
6148 (?\d (if (not (pos-visible-in-window-p (point-min)))
6149 (scroll-down nil)
6150 (message "Beginning of buffer")
6151 (sit-for 1)))))
6152 (cond
6153 ;; Ignore undefined associations.
6154 ((not (memq key allowed-keys))
6155 (ding)
6156 (unless expertp (message "Invalid key") (sit-for 1))
6157 (org-export--dispatch-ui options first-key expertp))
6158 ;; q key at first level aborts export. At second level, cancel
6159 ;; first key instead.
6160 ((eq key ?q) (if (not first-key) (error "Export aborted")
6161 (org-export--dispatch-ui options nil expertp)))
6162 ;; Help key: Switch back to standard interface if expert UI was
6163 ;; active.
6164 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6165 ;; Send request for template insertion along with export scope.
6166 ((eq key ?#) (cons 'template (memq 'subtree options)))
6167 ;; Switch to asynchronous export stack.
6168 ((eq key ?&) '(stack))
6169 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6170 ((memq key '(2 22 19 6 1))
6171 (org-export--dispatch-ui
6172 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6173 (6 'force) (1 'async))))
6174 (if (memq option options) (remq option options)
6175 (cons option options)))
6176 first-key expertp))
6177 ;; Action selected: Send key and options back to
6178 ;; `org-export-dispatch'.
6179 ((or first-key (functionp (nth 2 (assq key entries))))
6180 (cons (cond
6181 ((not first-key) (nth 2 (assq key entries)))
6182 ;; Publishing actions are hard-coded. Send a special
6183 ;; signal to `org-export-dispatch'.
6184 ((eq first-key ?P)
6185 (case key
6186 (?f 'publish-current-file)
6187 (?p 'publish-current-project)
6188 (?x 'publish-choose-project)
6189 (?a 'publish-all)))
6190 ;; Return first action associated to FIRST-KEY + KEY
6191 ;; path. Indeed, derived backends can share the same
6192 ;; FIRST-KEY.
6193 (t (catch 'found
6194 (mapc (lambda (entry)
6195 (let ((match (assq key (nth 2 entry))))
6196 (when match (throw 'found (nth 2 match)))))
6197 (member (assq first-key entries) entries)))))
6198 options))
6199 ;; Otherwise, enter sub-menu.
6200 (t (org-export--dispatch-ui options key expertp)))))
6204 (provide 'ox)
6206 ;; Local variables:
6207 ;; generated-autoload-file: "org-loaddefs.el"
6208 ;; End:
6210 ;;; ox.el ends here