| blob | 8f5bbc299a9d9a5b3f2d52ddeb1079018a29b7dd |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012, 2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; GNU Emacs is free software: you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
22 ;;
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
25 ;;
26 ;; Besides that parser, the generic exporter is made of three distinct
27 ;; parts:
28 ;;
29 ;; - The communication channel consists in a property list, which is
30 ;; created and updated during the process. Its use is to offer
31 ;; every piece of information, would it be about initial environment
32 ;; or contextual data, all in a single place. The exhaustive list
33 ;; of properties is given in "The Communication Channel" section of
34 ;; this file.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core function is `org-export-as'. It returns the transcoded
48 ;; buffer as a string.
49 ;;
50 ;; An export back-end is defined with `org-export-define-backend'.
51 ;; This function can also support specific buffer keywords, OPTION
52 ;; keyword's items and filters. Refer to function's documentation for
53 ;; more information.
54 ;;
55 ;; If the new back-end shares most properties with another one,
56 ;; `org-export-define-derived-backend' can be used to simplify the
57 ;; process.
58 ;;
59 ;; Any back-end can define its own variables. Among them, those
60 ;; customizable should belong to the `org-export-BACKEND' group.
61 ;;
62 ;; Tools for common tasks across back-ends are implemented in the
63 ;; following part of the file.
64 ;;
65 ;; Then, a wrapper macro for asynchronous export,
66 ;; `org-export-async-start', along with tools to display results. are
67 ;; given in the penultimate part.
68 ;;
69 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
70 ;; back-ends is provided in the last one.
72 ;;; Code:
91 \f
92 ;;; Internal Variables
93 ;;
94 ;; Among internal variables, the most important is
95 ;; `org-export-options-alist'. This variable define the global export
96 ;; options, shared between every exporter, and how they are acquired.
141 "Alist between export properties and ways to set them.
143 The CAR of the alist is the property name, and the CDR is a list
144 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
146 KEYWORD is a string representing a buffer keyword, or nil. Each
147 property defined this way can also be set, during subtree
148 export, through a headline property named after the keyword
150 property).
151 OPTION is a string that could be found in an #+OPTIONS: line.
152 DEFAULT is the default value for the property.
153 BEHAVIOUR determines how Org should handle multiple keywords for
154 the same property. It is a symbol among:
155 nil Keep old value and discard the new one.
156 t Replace old value with the new one.
157 `space' Concatenate the values, separating them with a space.
158 `newline' Concatenate the values, separating them with
159 a newline.
160 `split' Split values at white spaces, and cons them to the
161 previous list.
163 Values set through KEYWORD and OPTION have precedence over
164 DEFAULT.
166 All these properties should be back-end agnostic. Back-end
167 specific properties are set through `org-export-define-backend'.
171 "List of in-buffer keywords that require special treatment.
172 These keywords are not directly associated to a property. The
173 way they are handled must be hard-coded into
233 "Alist between filters properties and initial values.
235 The key of each association is a property name accessible through
236 the communication channel. Its value is a configurable global
237 variable defining initial filters.
239 This list is meant to install user specified filters. Back-end
240 developers may install their own filters using
241 `org-export-define-backend'. Filters defined there will always
242 be prepended to the current list, so they always get applied
251 "Default rule for link matching an inline image.
252 This rule applies to links with no description. By default, it
253 will be considered as an inline image if it targets a local file
256 See `org-export-inline-image-p' for more information about
260 "Non-nil means asynchronous export process should leave data behind.
264 located in `temporary-file-directory'.
266 When non-nil, it will also set `debug-on-error' to a non-nil
270 "Record asynchronously generated export results and processes.
271 This is an alist: its CAR is the source of the
272 result (destination file or buffer for a finished process,
273 original buffer for a running one) and its CDR is a list
274 containing the back-end used, as a symbol, and either a process
275 or the time at which it finished. It is used to build the menu
279 "List of backends currently available in the exporter.
280 This variable is set with `org-export-define-backend' and
284 "Last command called from the dispatcher.
285 The value should be a list. Its CAR is the action, as a symbol,
289 "The position where the last export command was created using the dispatcher.
290 This marker will be used with `C-u C-c C-e' to make sure export repetition
293 ;; For compatibility with Org < 8
295 "Name, if any, of the back-end used during an export process.
297 Its value is a symbol such as `html', `latex', `ascii', or nil if
298 the back-end is anonymous (see `org-export-create-backend') or if
299 there is no export process in progress.
301 It can be used to teach Babel blocks how to act differently
304 \f
305 ;;; User-configurable Variables
306 ;;
307 ;; Configuration for the masses.
308 ;;
309 ;; They should never be accessed directly, as their value is to be
310 ;; stored in a property list (cf. `org-export-options-alist').
311 ;; Back-ends will read their value from there instead.
314 "Options for exporting Org mode files."
319 "General options for export engine."
324 "Whether sub-trees with the ARCHIVE tag should be exported.
326 This can have three different values:
327 nil Do not export, pretend this tree is not present.
328 t Do export the entire tree.
329 `headline' Only export the headline, but skip the tree below it.
331 This option can also be set with the OPTIONS keyword,
340 "Non-nil means insert author name into the exported file.
341 This option can also be set with the OPTIONS keyword,
347 "Non-nil means export CLOCK keywords.
348 This option can also be set with the OPTIONS keyword,
354 "Non-nil means the postamble should contain a creator sentence.
356 The sentence can be set in `org-export-creator-string' and
359 If the value is `comment' insert it as a comment."
367 "Non-nil means insert date in the exported document.
368 This option can also be set with the OPTIONS keyword,
374 "Time-stamp format string to use for DATE keyword.
376 The format string, when specified, only applies if date consists
377 in a single time-stamp. Otherwise its value will be ignored.
379 See `format-time-string' for details on how to build this
380 string."
388 emacs-version
390 "Information about the creator of the document.
391 This option can also be set on with the CREATOR keyword."
396 "Non-nil means export contents of standard drawers.
398 When t, all drawers are exported. This may also be a list of
399 drawer names to export. If that list starts with `not', only
400 drawers with such names will be ignored.
402 This variable doesn't apply to properties drawers.
404 This option can also be set with the OPTIONS keyword,
417 :inline t
421 "Non-nil means insert author email into the exported file.
422 This option can also be set with the OPTIONS keyword,
428 "Non-nil means interpret *word*, /word/, _word_ and +word+.
430 If the export target supports emphasizing text, the word will be
431 typeset in bold, italic, with an underline or strike-through,
432 respectively.
434 This option can also be set with the OPTIONS keyword,
440 "Tags that exclude a tree from export.
442 All trees carrying any of these tags will be excluded from
443 export. This is without condition, so even subtrees inside that
444 carry one of the `org-export-select-tags' will be removed.
446 This option can also be set with the EXCLUDE_TAGS keyword."
453 This can be used to have pre-formatted text, fragments of code
454 etc. For example:
455 : ;; Some Lisp examples
456 : (while (defc cnt)
457 : (ding))
458 will be looking just like this in also HTML. See also the QUOTE
459 keyword. Not all export backends support this.
461 This option can also be set with the OPTIONS keyword,
467 "Non-nil means Org footnotes should be exported.
468 This option can also be set with the OPTIONS keyword,
474 "Non-nil means process LaTeX environments and fragments.
476 This option can also be set with the OPTIONS line,
479 nil Ignore math snippets.
480 `verbatim' Keep everything in verbatim.
481 t Allow export of math snippets."
491 "The last level which is still exported as a headline.
493 Inferior levels will usually produce itemize or enumerate lists
494 when exported, but back-end behaviour may differ.
496 This option can also be set with the OPTIONS keyword,
502 "The default language for export and clocktable translations, as a string.
503 This may have an association in
504 `org-clock-clocktable-language-setup',
505 `org-export-smart-quotes-alist' and `org-export-dictionary'.
506 This option can also be set with the LANGUAGE keyword."
511 "Non-nil means preserve all line breaks when exporting.
512 This option can also be set with the OPTIONS keyword,
518 "Non-nil means interpret entities when exporting.
521 Å.
523 For a list of supported names, see the constant `org-entities'
524 and the user option `org-entities-user'.
526 This option can also be set with the OPTIONS keyword,
532 "Non-nil means inlinetasks should be exported.
533 This option can also be set with the OPTIONS keyword,
541 "Non-nil means include planning info in export.
543 Planning info is the line containing either SCHEDULED:,
544 DEADLINE:, CLOSED: time-stamps, or a combination of them.
546 This option can also be set with the OPTIONS keyword,
554 "Non-nil means include priority cookies in export.
555 This option can also be set with the OPTIONS keyword,
561 "Non-nil means add section numbers to headlines when exporting.
563 When set to an integer n, numbering will only happen for
564 headlines whose relative level is higher or equal to n.
566 This option can also be set with the OPTIONS keyword,
572 "Tags that select a tree for export.
574 If any such tag is found in a buffer, all trees that do not carry
575 one of these tags will be ignored during export. Inside trees
576 that are selected like this, you can still deselect a subtree by
577 tagging it with one of the `org-export-exclude-tags'.
579 This option can also be set with the SELECT_TAGS keyword."
584 "Non-nil means activate smart quotes during export.
585 This option can also be set with the OPTIONS keyword,
588 When setting this to non-nil, you need to take care of
589 using the correct Babel package when exporting to LaTeX.
590 E.g., you can load Babel for french like this:
601 When this option is turned on, these strings will be exported as:
603 Org HTML LaTeX UTF-8
604 -----+----------+--------+-------
606 -- – -- –
607 --- — --- —
610 This option can also be set with the OPTIONS keyword,
616 "Non-nil means include statistics cookies in export.
617 This option can also be set with the OPTIONS keyword,
627 When this option is turned on, you can use TeX-like syntax for
629 will be considered as a single item - so grouping with {} is
630 normally not needed. For example, the following things will be
631 parsed as single sub- or superscripts.
633 10^24 or 10^tau several digits will be considered 1 item.
634 10^-12 or 10^-tau a leading sign with digits or a word
635 x^2-y^3 will be read as x^2 - y^3, because items are
636 terminated by almost any nonword/nondigit char.
637 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
639 Still, ambiguity is possible - so when in doubt use {} to enclose
640 the sub/superscript. If you set this variable to the symbol
641 `{}', the braces are *required* in order to trigger
642 interpretations as sub/superscript. This can be helpful in
645 This option can also be set with the OPTIONS keyword,
654 "Non-nil means create a table of contents in exported files.
656 The TOC contains headlines with levels up
657 to`org-export-headline-levels'. When an integer, include levels
658 up to N in the toc, this may then be different from
659 `org-export-headline-levels', but it will not be allowed to be
660 larger than the number of headline levels. When nil, no table of
661 contents is made.
663 This option can also be set with the OPTIONS keyword,
673 For example:
675 | Name | Address | Birthday |
676 |-------------+----------+-----------|
677 | Arthur Dent | England | 29.2.2100 |
679 This option can also be set with the OPTIONS keyword,
685 "If nil, do not export tags, just remove them from headlines.
687 If this is the symbol `not-in-toc', tags will be removed from
688 table of contents entries, but still be shown in the headlines of
689 the document.
691 This option can also be set with the OPTIONS keyword,
700 "Non-nil means include TODO items for export.
702 This may have the following values:
703 t include tasks independent of state.
704 `todo' include only tasks that are not yet done.
705 `done' include only tasks that are already done.
706 nil ignore all tasks.
707 list of keywords include tasks with these keywords.
709 This option can also be set with the OPTIONS keyword,
721 "Non-nil means insert a time stamp into the exported file.
722 The time stamp shows when the file was created. This option can
728 "Non nil means allow timestamps in export.
730 It can be set to any of the following values:
731 t export all timestamps.
732 `active' export active timestamps only.
733 `inactive' export inactive timestamps only.
734 nil do not export timestamps
736 This only applies to timestamps isolated in a paragraph
737 containing only timestamps. Other timestamps are always
738 exported.
740 This option can also be set with the OPTIONS keyword, e.g.
750 "Non-nil means include TODO keywords in export.
751 When nil, remove all these keywords from the export. This option
757 "Non-nil means BIND keywords can define local variable values.
758 This is a potential security risk, which is why the default value
759 is nil. You can also allow them through local buffer variables."
766 "Alist between export snippets back-ends and exporter back-ends.
768 This variable allows to provide shortcuts for export snippets.
772 HTML code while every other back-end will ignore it."
781 "Coding system for the exported file."
788 "Should we push exported content to the kill ring?"
797 "The initial scope when exporting with `org-export-dispatch'.
798 This variable can be either set to `buffer' or `subtree'."
805 "Non-nil means show buffer after exporting to temp buffer.
806 When Org exports to a file, the buffer visiting that file is ever
807 shown, but remains buried. However, when exporting to
808 a temporary buffer, that buffer is popped up in a second window.
809 When this variable is nil, the buffer remains buried also in
810 these cases."
815 "Non-nil means export and publishing commands will run in background.
816 Results from an asynchronous export are never displayed
824 "File used to initialize external export process.
825 Value must be an absolute file name. It defaults to user's
826 initialization file. Though, a specific configuration makes the
827 process faster and the export more portable."
834 "Non-nil means using a non-intrusive `org-export-dispatch'.
835 In that case, no help buffer is displayed. Though, an indicator
841 asynchronous). Also, \[?] allows to switch back to standard
842 mode."
849 \f
850 ;;; Defining Back-ends
851 ;;
852 ;; An export back-end is a structure with `org-export-backend' type
853 ;; and `name', `parent', `transcoders', `options', `filters', `blocks'
854 ;; and `menu' slots.
855 ;;
856 ;; At the lowest level, a back-end is created with
857 ;; `org-export-create-backend' function.
858 ;;
859 ;; A named back-end can be registered with
860 ;; `org-export-register-backend' function. A registered back-end can
861 ;; later be referred to by its name, with `org-export-get-backend'
862 ;; function. Also, such a back-end can become the parent of a derived
863 ;; back-end from which slot values will be inherited by default.
864 ;; `org-export-derived-backend-p' can check if a given back-end is
865 ;; derived from a list of back-end names.
866 ;;
867 ;; `org-export-get-all-transcoders', `org-export-get-all-options' and
868 ;; `org-export-get-all-filters' return the full alist of transcoders,
869 ;; options and filters, including those inherited from ancestors.
870 ;;
871 ;; At a higher level, `org-export-define-backend' is the standard way
872 ;; to define an export back-end. If the new back-end is similar to
873 ;; a registered back-end, `org-export-define-derived-backend' may be
874 ;; used instead.
875 ;;
876 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
877 ;; when a given back-end hasn't been registered yet.
881 name parent transcoders options filters blocks menu)
884 "Return export back-end named after NAME.
885 NAME is a symbol. Return nil if no such back-end is found."
892 "Register BACKEND as a known export back-end.
893 BACKEND is a structure with `org-export-backend' type."
894 ;; Refuse to register an unnamed back-end.
897 ;; Refuse to register a back-end with an unknown parent.
901 ;; Register dedicated export blocks in the parser.
905 ;; If a back-end with the same name as BACKEND is already
906 ;; registered, replace it with BACKEND. Otherwise, simply add
907 ;; BACKEND to the list of registered back-ends.
913 "Signal an error if BACKEND isn't defined."
918 "Non-nil if BACKEND is derived from one of BACKENDS.
919 BACKEND is an export back-end, as returned by, e.g.,
920 `org-export-create-backend', or a symbol referring to
921 a registered back-end. BACKENDS is constituted of symbols."
933 "Return full translation table for BACKEND.
935 BACKEND is an export back-end, as return by, e.g,,
936 `org-export-create-backend'. Return value is an alist where
937 keys are element or object types, as symbols, and values are
938 transcoders.
940 Unlike to `org-export-backend-transcoders', this function
941 also returns transcoders inherited from parent back-ends,
942 if any."
946 parent)
951 transcoders)))
954 "Return export options for BACKEND.
956 BACKEND is an export back-end, as return by, e.g,,
957 `org-export-create-backend'. See `org-export-options-alist'
958 for the shape of the return value.
960 Unlike to `org-export-backend-options', this function also
961 returns options inherited from parent back-ends, if any."
965 parent)
969 options)))
972 "Return complete list of filters for BACKEND.
974 BACKEND is an export back-end, as return by, e.g,,
975 `org-export-create-backend'. Return value is an alist where
976 keys are symbols and values lists of functions.
978 Unlike to `org-export-backend-filters', this function also
979 returns filters inherited from parent back-ends, if any."
983 parent)
987 filters)))
990 "Define a new back-end BACKEND.
992 TRANSCODERS is an alist between object or element types and
993 functions handling them.
995 These functions should return a string without any trailing
996 space, or nil. They must accept three arguments: the object or
997 element itself, its contents or nil when it isn't recursive and
998 the property list used as a communication channel.
1000 Contents, when not nil, are stripped from any global indentation
1001 \(although the relative one is preserved). They also always end
1002 with a single newline character.
1004 If, for a given type, no function is found, that element or
1005 object type will simply be ignored, along with any blank line or
1006 white space at its end. The same will happen if the function
1007 returns the nil value. If that function returns the empty
1008 string, the type will be ignored, but the blank lines or white
1009 spaces will be kept.
1011 In addition to element and object types, one function can be
1012 associated to the `template' (or `inner-template') symbol and
1013 another one to the `plain-text' symbol.
1015 The former returns the final transcoded string, and can be used
1016 to add a preamble and a postamble to document's body. It must
1017 accept two arguments: the transcoded string and the property list
1018 containing export options. A function associated to `template'
1020 A function associated to `inner-template' is always applied.
1022 The latter, when defined, is to be called on every text not
1023 recognized as an element or an object. It must accept two
1024 arguments: the text string and the information channel. It is an
1025 appropriate place to protect special chars relative to the
1026 back-end.
1028 BODY can start with pre-defined keyword arguments. The following
1029 keywords are understood:
1031 :export-block
1033 String, or list of strings, representing block names that
1034 will not be parsed. This is used to specify blocks that will
1035 contain raw code specific to the back-end. These blocks
1036 still have to be handled by the relative `export-block' type
1037 translator.
1039 :filters-alist
1041 Alist between filters and function, or list of functions,
1042 specific to the back-end. See `org-export-filters-alist' for
1043 a list of all allowed filters. Filters defined here
1044 shouldn't make a back-end test, as it may prevent back-ends
1045 derived from this one to behave properly.
1047 :menu-entry
1049 Menu entry for the export dispatcher. It should be a list
1050 like:
1052 '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
1054 where :
1056 KEY is a free character selecting the back-end.
1058 DESCRIPTION-OR-ORDINAL is either a string or a number.
1060 If it is a string, is will be used to name the back-end in
1061 its menu entry. If it is a number, the following menu will
1062 be displayed as a sub-menu of the back-end with the same
1063 KEY. Also, the number will be used to determine in which
1064 order such sub-menus will appear (lowest first).
1066 ACTION-OR-MENU is either a function or an alist.
1068 If it is an action, it will be called with four
1069 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
1070 BODY-ONLY. See `org-export-as' for further explanations on
1071 some of them.
1073 If it is an alist, associations should follow the
1074 pattern:
1076 '(KEY DESCRIPTION ACTION)
1078 where KEY, DESCRIPTION and ACTION are described above.
1080 Valid values include:
1084 or
1089 \(lambda (a s v b)
1090 \(if a (org-latex-export-to-pdf t s v b)
1091 \(org-open-file
1092 \(org-latex-export-to-pdf nil s v b)))))))
1094 or the following, which will be added to the previous
1095 sub-menu,
1097 '(?l 1
1101 :options-alist
1103 Alist between back-end specific properties introduced in
1104 communication channel and how their value are acquired. See
1105 `org-export-options-alist' for more information about
1106 structure of the values."
1120 :transcoders transcoders
1121 :options options
1122 :filters filters
1123 :blocks blocks
1127 "Create a new back-end as a variant of an existing one.
1129 CHILD is the name of the derived back-end. PARENT is the name of
1130 the parent back-end.
1132 BODY can start with pre-defined keyword arguments. The following
1133 keywords are understood:
1135 :export-block
1137 String, or list of strings, representing block names that
1138 will not be parsed. This is used to specify blocks that will
1139 contain raw code specific to the back-end. These blocks
1140 still have to be handled by the relative `export-block' type
1141 translator.
1143 :filters-alist
1145 Alist of filters that will overwrite or complete filters
1146 defined in PARENT back-end. See `org-export-filters-alist'
1147 for a list of allowed filters.
1149 :menu-entry
1151 Menu entry for the export dispatcher. See
1152 `org-export-define-backend' for more information about the
1153 expected value.
1155 :options-alist
1157 Alist of back-end specific properties that will overwrite or
1158 complete those defined in PARENT back-end. Refer to
1159 `org-export-options-alist' for more information about
1160 structure of the values.
1162 :translate-alist
1164 Alist of element and object types and transcoders that will
1165 overwrite or complete transcode table from PARENT back-end.
1166 Refer to `org-export-define-backend' for detailed information
1167 about transcoders.
1170 as a variant of `latex' back-end with a custom template function:
1172 \(org-export-define-derived-backend 'my-latex 'latex
1173 :translate-alist '((template . my-latex-template-fun)))
1175 The back-end could then be called with, for example:
1192 :parent parent
1193 :transcoders transcoders
1194 :options options
1195 :filters filters
1196 :blocks blocks
1200 \f
1201 ;;; The Communication Channel
1202 ;;
1203 ;; During export process, every function has access to a number of
1204 ;; properties. They are of two types:
1205 ;;
1206 ;; 1. Environment options are collected once at the very beginning of
1207 ;; the process, out of the original buffer and configuration.
1208 ;; Collecting them is handled by `org-export-get-environment'
1209 ;; function.
1210 ;;
1211 ;; Most environment options are defined through the
1212 ;; `org-export-options-alist' variable.
1213 ;;
1214 ;; 2. Tree properties are extracted directly from the parsed tree,
1215 ;; just before export, by `org-export-collect-tree-properties'.
1216 ;;
1217 ;; Here is the full list of properties available during transcode
1218 ;; process, with their category and their value type.
1219 ;;
1220 ;; + `:author' :: Author's name.
1221 ;; - category :: option
1222 ;; - type :: string
1223 ;;
1224 ;; + `:back-end' :: Current back-end used for transcoding.
1225 ;; - category :: tree
1226 ;; - type :: symbol
1227 ;;
1228 ;; + `:creator' :: String to write as creation information.
1229 ;; - category :: option
1230 ;; - type :: string
1231 ;;
1232 ;; + `:date' :: String to use as date.
1233 ;; - category :: option
1234 ;; - type :: string
1235 ;;
1236 ;; + `:description' :: Description text for the current data.
1237 ;; - category :: option
1238 ;; - type :: string
1239 ;;
1240 ;; + `:email' :: Author's email.
1241 ;; - category :: option
1242 ;; - type :: string
1243 ;;
1244 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1245 ;; process.
1246 ;; - category :: option
1247 ;; - type :: list of strings
1248 ;;
1249 ;; + `:export-options' :: List of export options available for current
1250 ;; process.
1251 ;; - category :: none
1252 ;; - type :: list of symbols, among `subtree', `body-only' and
1253 ;; `visible-only'.
1254 ;;
1255 ;; + `:exported-data' :: Hash table used for memoizing
1256 ;; `org-export-data'.
1257 ;; - category :: tree
1258 ;; - type :: hash table
1259 ;;
1260 ;; + `:filetags' :: List of global tags for buffer. Used by
1261 ;; `org-export-get-tags' to get tags with inheritance.
1262 ;; - category :: option
1263 ;; - type :: list of strings
1264 ;;
1265 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1266 ;; their definition, as parsed data. Only non-inlined footnotes
1267 ;; are represented in this alist. Also, every definition isn't
1268 ;; guaranteed to be referenced in the parse tree. The purpose of
1269 ;; this property is to preserve definitions from oblivion
1270 ;; (i.e. when the parse tree comes from a part of the original
1271 ;; buffer), it isn't meant for direct use in a back-end. To
1272 ;; retrieve a definition relative to a reference, use
1273 ;; `org-export-get-footnote-definition' instead.
1274 ;; - category :: option
1275 ;; - type :: alist (STRING . LIST)
1276 ;;
1277 ;; + `:headline-levels' :: Maximum level being exported as an
1278 ;; headline. Comparison is done with the relative level of
1279 ;; headlines in the parse tree, not necessarily with their
1280 ;; actual level.
1281 ;; - category :: option
1282 ;; - type :: integer
1283 ;;
1284 ;; + `:headline-offset' :: Difference between relative and real level
1285 ;; of headlines in the parse tree. For example, a value of -1
1286 ;; means a level 2 headline should be considered as level
1287 ;; 1 (cf. `org-export-get-relative-level').
1288 ;; - category :: tree
1289 ;; - type :: integer
1290 ;;
1291 ;; + `:headline-numbering' :: Alist between headlines and their
1292 ;; numbering, as a list of numbers
1293 ;; (cf. `org-export-get-headline-number').
1294 ;; - category :: tree
1295 ;; - type :: alist (INTEGER . LIST)
1296 ;;
1297 ;; + `:id-alist' :: Alist between ID strings and destination file's
1298 ;; path, relative to current directory. It is used by
1299 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1300 ;; external file.
1301 ;; - category :: option
1302 ;; - type :: alist (STRING . STRING)
1303 ;;
1304 ;; + `:ignore-list' :: List of elements and objects that should be
1305 ;; ignored during export.
1306 ;; - category :: tree
1307 ;; - type :: list of elements and objects
1308 ;;
1309 ;; + `:input-file' :: Full path to input file, if any.
1310 ;; - category :: option
1311 ;; - type :: string or nil
1312 ;;
1313 ;; + `:keywords' :: List of keywords attached to data.
1314 ;; - category :: option
1315 ;; - type :: string
1316 ;;
1317 ;; + `:language' :: Default language used for translations.
1318 ;; - category :: option
1319 ;; - type :: string
1320 ;;
1321 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1322 ;; transcoding.
1323 ;; - category :: option
1324 ;; - type :: list (as returned by `org-element-parse-buffer')
1325 ;;
1326 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1327 ;; all line breaks.
1328 ;; - category :: option
1329 ;; - type :: symbol (nil, t)
1330 ;;
1331 ;; + `:section-numbers' :: Non-nil means transcoding should add
1332 ;; section numbers to headlines.
1333 ;; - category :: option
1334 ;; - type :: symbol (nil, t)
1335 ;;
1336 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1337 ;; in transcoding. When such a tag is present, subtrees without
1338 ;; it are de facto excluded from the process. See
1339 ;; `use-select-tags'.
1340 ;; - category :: option
1341 ;; - type :: list of strings
1342 ;;
1343 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1344 ;; a time stamp in the output.
1345 ;; - category :: option
1346 ;; - type :: symbol (nil, t)
1347 ;;
1348 ;; + `:translate-alist' :: Alist between element and object types and
1349 ;; transcoding functions relative to the current back-end.
1350 ;; Special keys `inner-template', `template' and `plain-text' are
1351 ;; also possible.
1352 ;; - category :: option
1353 ;; - type :: alist (SYMBOL . FUNCTION)
1354 ;;
1355 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1356 ;; also be transcoded. If it is set to the `headline' symbol,
1357 ;; only the archived headline's name is retained.
1358 ;; - category :: option
1359 ;; - type :: symbol (nil, t, `headline')
1360 ;;
1361 ;; + `:with-author' :: Non-nil means author's name should be included
1362 ;; in the output.
1363 ;; - category :: option
1364 ;; - type :: symbol (nil, t)
1365 ;;
1366 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1367 ;; - category :: option
1368 ;; - type :: symbol (nil, t)
1369 ;;
1370 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1371 ;; inserted at the end of the transcoded string. If the value
1372 ;; is `comment', it should be commented.
1373 ;; - category :: option
1374 ;; - type :: symbol (`comment', nil, t)
1375 ;;
1376 ;; + `:with-date' :: Non-nil means output should contain a date.
1377 ;; - category :: option
1378 ;; - type :. symbol (nil, t)
1379 ;;
1380 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1381 ;; its value is a list of names, only drawers with such names
1382 ;; will be transcoded. If that list starts with `not', drawer
1383 ;; with these names will be skipped.
1384 ;; - category :: option
1385 ;; - type :: symbol (nil, t) or list of strings
1386 ;;
1387 ;; + `:with-email' :: Non-nil means output should contain author's
1388 ;; email.
1389 ;; - category :: option
1390 ;; - type :: symbol (nil, t)
1391 ;;
1392 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1393 ;; interpreted.
1394 ;; - category :: option
1395 ;; - type :: symbol (nil, t)
1396 ;;
1397 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1398 ;; strings starting with a colon as a fixed-with (verbatim) area.
1399 ;; - category :: option
1400 ;; - type :: symbol (nil, t)
1401 ;;
1402 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1403 ;; footnotes.
1404 ;; - category :: option
1405 ;; - type :: symbol (nil, t)
1406 ;;
1407 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1408 ;; `latex-fragment' objects should appear in export output. When
1409 ;; this property is set to `verbatim', they will be left as-is.
1410 ;; - category :: option
1411 ;; - type :: symbol (`verbatim', nil, t)
1412 ;;
1413 ;; + `:with-planning' :: Non-nil means transcoding should include
1414 ;; planning info.
1415 ;; - category :: option
1416 ;; - type :: symbol (nil, t)
1417 ;;
1418 ;; + `:with-priority' :: Non-nil means transcoding should include
1419 ;; priority cookies.
1420 ;; - category :: option
1421 ;; - type :: symbol (nil, t)
1422 ;;
1423 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1424 ;; plain text.
1425 ;; - category :: option
1426 ;; - type :: symbol (nil, t)
1427 ;;
1428 ;; + `:with-special-strings' :: Non-nil means transcoding should
1429 ;; interpret special strings in plain text.
1430 ;; - category :: option
1431 ;; - type :: symbol (nil, t)
1432 ;;
1433 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1434 ;; interpret subscript and superscript. With a value of "{}",
1435 ;; only interpret those using curly brackets.
1436 ;; - category :: option
1437 ;; - type :: symbol (nil, {}, t)
1438 ;;
1439 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1440 ;; tables.
1441 ;; - category :: option
1442 ;; - type :: symbol (nil, t)
1443 ;;
1444 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1445 ;; headlines. A `not-in-toc' value will remove them from the
1446 ;; table of contents, if any, nonetheless.
1447 ;; - category :: option
1448 ;; - type :: symbol (nil, t, `not-in-toc')
1449 ;;
1450 ;; + `:with-tasks' :: Non-nil means transcoding should include
1451 ;; headlines with a TODO keyword. A `todo' value will only
1452 ;; include headlines with a todo type keyword while a `done'
1453 ;; value will do the contrary. If a list of strings is provided,
1454 ;; only tasks with keywords belonging to that list will be kept.
1455 ;; - category :: option
1456 ;; - type :: symbol (t, todo, done, nil) or list of strings
1457 ;;
1458 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1459 ;; time stamps. Special value `active' (resp. `inactive') ask to
1460 ;; export only active (resp. inactive) timestamps. Otherwise,
1461 ;; completely remove them.
1462 ;; - category :: option
1463 ;; - type :: symbol: (`active', `inactive', t, nil)
1464 ;;
1465 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1466 ;; added to the output. An integer value limits its depth.
1467 ;; - category :: option
1468 ;; - type :: symbol (nil, t or integer)
1469 ;;
1470 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1471 ;; include TODO keywords.
1472 ;; - category :: option
1473 ;; - type :: symbol (nil, t)
1476 ;;;; Environment Options
1477 ;;
1478 ;; Environment options encompass all parameters defined outside the
1479 ;; scope of the parsed data. They come from five sources, in
1480 ;; increasing precedence order:
1481 ;;
1482 ;; - Global variables,
1483 ;; - Buffer's attributes,
1484 ;; - Options keyword symbols,
1485 ;; - Buffer keywords,
1486 ;; - Subtree properties.
1487 ;;
1488 ;; The central internal function with regards to environment options
1489 ;; is `org-export-get-environment'. It updates global variables with
1490 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1491 ;; the different sources.
1492 ;;
1493 ;; The internal functions doing the retrieval are:
1494 ;; `org-export--get-global-options',
1495 ;; `org-export--get-buffer-attributes',
1496 ;; `org-export--parse-option-keyword',
1497 ;; `org-export--get-subtree-options' and
1498 ;; `org-export--get-inbuffer-options'
1499 ;;
1500 ;; Also, `org-export--list-bound-variables' collects bound variables
1501 ;; along with their value in order to set them as buffer local
1502 ;; variables later in the process.
1505 "Collect export options from the current buffer.
1507 Optional argument BACKEND is an export back-end, as returned by
1508 `org-export-create-backend'.
1510 When optional argument SUBTREEP is non-nil, assume the export is
1511 done against the current sub-tree.
1513 Third optional argument EXT-PLIST is a property list with
1514 external parameters overriding Org default settings, but still
1515 inferior to file-local settings."
1516 ;; First install #+BIND variables since these must be set before
1517 ;; global options are read.
1520 ;; Get and prioritize export options...
1522 ;; ... from global variables...
1524 ;; ... from an external property list...
1525 ext-plist
1526 ;; ... from in-buffer settings...
1528 ;; ... and from subtree, when appropriate.
1530 ;; Eventually add misc. properties.
1532 :back-end
1533 backend
1535 :footnote-definition-alist
1536 ;; Footnotes definitions must be collected in the original
1537 ;; buffer, as there's no insurance that they will still be in
1538 ;; the parse tree, due to possible narrowing.
1552 alist))))
1553 alist))
1554 :id-alist
1555 ;; Collect id references.
1566 alist))))
1569 "Parse an OPTIONS line and return values as a plist.
1570 Optional argument BACKEND is an export back-end, as returned by,
1571 e.g., `org-export-create-backend'. It specifies which back-end
1572 specific items to read, if any."
1574 ;; Priority is given to back-end specific options.
1576 org-export-options-alist))
1577 plist)
1586 options))
1588 property
1591 plist))
1594 "Get export options in subtree at point.
1595 Optional argument BACKEND is an export back-end, as returned by,
1596 e.g., `org-export-create-backend'. It specifies back-end used
1597 for export. Return options as a plist."
1598 ;; For each buffer keyword, create a headline property setting the
1599 ;; same property in communication channel. The name for the property
1600 ;; is the keyword with "EXPORT_" appended to it.
1603 ;; Make sure point is at a heading.
1605 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1606 ;; title as its fallback value.
1612 plist :title
1615 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1619 ;; Handle other keywords. TITLE keyword is excluded as it has
1620 ;; been handled already.
1628 ;; Export properties are not case-sensitive.
1635 plist
1636 property
1638 ;; Parse VALUE if required.
1642 ;; If BEHAVIOUR is `split' expected value is
1643 ;; a list of strings, not a string.
1646 ;; Look for both general keywords and back-end specific
1647 ;; options, with priority given to the latter.
1649 org-export-options-alist)))
1650 ;; Return value.
1651 plist)))
1654 "Return current buffer export options, as a plist.
1656 Optional argument BACKEND, when non-nil, is an export back-end,
1657 as returned by, e.g., `org-export-create-backend'. It specifies
1658 which back-end specific options should also be read in the
1659 process.
1661 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1663 get-options ; For byte-compiler.
1666 ;; Priority is given to back-end specific options.
1668 org-export-options-alist))
1671 org-export-special-keywords))))
1674 ;; Return all properties associated to KEYWORD.
1681 ;; Recursively read keywords in buffer. FILES is a list
1682 ;; of files read so far. PLIST is the current property
1683 ;; list obtained.
1692 ;; Options in `org-export-special-keywords'.
1696 ;; Avoid circular dependencies.
1706 plist
1711 plist
1717 ;; Options in `org-export-options-alist'.
1722 plist property
1723 ;; Handle value depending on specified
1724 ;; BEHAVIOUR.
1730 " "
1743 ;; Return final value.
1744 plist))))
1745 ;; Read options in the current buffer.
1747 ;; Parse keywords specified in `org-element-document-properties'
1748 ;; and return PLIST.
1759 "Return properties related to buffer attributes, as a plist."
1760 ;; Store full path of input file name, or nil. For internal use.
1765 "Return default title for current document, as a string.
1766 Title is extracted from associated file name, if any, or buffer's
1767 name."
1776 "Return global export options as a plist.
1777 Optional argument BACKEND, if non-nil, is an export back-end, as
1778 returned by, e.g., `org-export-create-backend'. It specifies
1779 which back-end specific export options should also be read in the
1780 process."
1782 ;; Priority is given to back-end specific options.
1784 org-export-options-alist)))
1790 plist
1791 prop
1792 ;; Eval default value provided. If keyword is
1793 ;; a member of `org-element-document-properties',
1794 ;; parse it as a secondary string before storing it.
1801 value)))))))))))
1804 "Return variables bound from BIND keywords in current buffer.
1805 Also look for BIND keywords in setup files. The return value is
1806 an alist where associations are (VARIABLE-NAME VALUE)."
1811 ;; Return an alist between variable names and their
1812 ;; value. FILES is a list of setup files names read so
1813 ;; far, used to avoid circular dependencies. ALIST is
1814 ;; the alist collected so far.
1825 ;; Enter setup file.
1835 alist))))))))))
1836 alist)))))
1837 ;; Return value in appropriate order of appearance.
1841 ;;;; Tree Properties
1842 ;;
1843 ;; Tree properties are information extracted from parse tree. They
1844 ;; are initialized at the beginning of the transcoding process by
1845 ;; `org-export-collect-tree-properties'.
1846 ;;
1847 ;; Dedicated functions focus on computing the value of specific tree
1848 ;; properties during initialization. Thus,
1849 ;; `org-export--populate-ignore-list' lists elements and objects that
1850 ;; should be skipped during export, `org-export--get-min-level' gets
1851 ;; the minimal exportable level, used as a basis to compute relative
1852 ;; level for headlines. Eventually
1853 ;; `org-export--collect-headline-numbering' builds an alist between
1854 ;; headlines and their numbering.
1857 "Extract tree properties from parse tree.
1859 DATA is the parse tree from which information is retrieved. INFO
1860 is a list holding export options.
1862 Following tree properties are set or updated:
1864 `:exported-data' Hash table used to memoize results from
1865 `org-export-data'.
1867 `:footnote-definition-alist' List of footnotes definitions in
1868 original buffer and current parse tree.
1870 `:headline-offset' Offset between true level of headlines and
1871 local level. An offset of -1 means a headline
1872 of level 2 should be considered as a level
1873 1 headline in the context.
1875 `:headline-numbering' Alist of all headlines as key an the
1876 associated numbering as value.
1878 `:ignore-list' List of elements that should be ignored during
1879 export.
1881 Return updated plist."
1882 ;; Install the parse tree in the communication channel, in order to
1883 ;; use `org-export-get-genealogy' and al.
1885 ;; Get the list of elements and objects to ignore, and put it into
1886 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1887 ;; been done during parse tree filtering.
1890 :ignore-list
1893 ;; Compute `:headline-offset' in order to be able to use
1894 ;; `org-export-get-relative-level'.
1897 :headline-offset
1899 ;; Update footnotes definitions list with definitions in parse tree.
1900 ;; This is required since buffer expansion might have modified
1901 ;; boundaries of footnote definitions contained in the parse tree.
1902 ;; This way, definitions in `footnote-definition-alist' are bound to
1903 ;; match those in the parse tree.
1909 defs)))
1911 ;; Properties order doesn't matter: get the rest of the tree
1912 ;; properties.
1916 info))
1919 "Return minimum exportable headline's level in DATA.
1920 DATA is parsed tree as returned by `org-element-parse-buffer'.
1921 OPTIONS is a plist holding export options."
1932 ;; If no headline was found, for the sake of consistency, set
1933 ;; minimum level to 1 nonetheless.
1937 "Return numbering of all exportable headlines in a parse tree.
1939 DATA is the parse tree. OPTIONS is the plist holding export
1940 options.
1942 Return an alist whose key is a headline and value is its
1943 associated numbering \(in the shape of a list of numbers\) or nil
1944 for a footnotes section."
1952 headline
1954 for idx from 0 to org-export-max-depth
1958 options)))
1961 "Return list of elements and objects to ignore during export.
1962 DATA is the parse tree to traverse. OPTIONS is the plist holding
1963 export options."
1965 walk-data
1966 ;; First find trees containing a select tag, if any.
1970 ;; Collect ignored elements or objects into IGNORE-LIST.
1976 ;; If headline is archived but tree below has
1977 ;; to be skipped, add it to ignore list.
1980 ;; Move into secondary string, if any.
1985 ;; Move into recursive objects/elements.
1987 ;; Main call.
1989 ;; Return value.
1990 ignore))
1993 "Return list of headlines and inlinetasks with a select tag in their tree.
1994 DATA is parsed data as returned by `org-element-parse-buffer'.
1995 INFO is a plist holding export options."
1997 walk-data ; For byte-compiler.
2007 ;; When a select tag is found, mark full
2008 ;; genealogy and every headline within the tree
2009 ;; as acceptable.
2012 genealogy
2015 selected-trees))
2016 ;; If at a headline, continue searching in tree,
2017 ;; recursively.
2027 selected-trees))
2030 "Non-nil when element or object BLOB should be skipped during export.
2031 OPTIONS is the plist holding export options. SELECTED, when
2032 non-nil, is a list of headlines or inlinetasks belonging to
2033 a tree with a select tag."
2040 ;; If `:with-drawers' value starts with `not', ignore
2041 ;; every drawer whose name belong to that list.
2042 ;; Otherwise, ignore drawers whose name isn't in that
2043 ;; list.
2059 ;; Ignore subtrees with an exclude tag.
2062 ;; When a select tag is present in the buffer, ignore any tree
2063 ;; without it.
2065 ;; Ignore commented sub-trees.
2067 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
2069 ;; Ignore tasks, if specified by `:with-tasks' property.
2084 ;; `:with-timestamps' only applies to isolated timestamps
2085 ;; objects, i.e. timestamp objects in a paragraph containing only
2086 ;; timestamps and whitespaces.
2094 options t))))
2103 \f
2104 ;;; The Transcoder
2105 ;;
2106 ;; `org-export-data' reads a parse tree (obtained with, i.e.
2107 ;; `org-element-parse-buffer') and transcodes it into a specified
2108 ;; back-end output. It takes care of filtering out elements or
2109 ;; objects according to export options and organizing the output blank
2110 ;; lines and white space are preserved. The function memoizes its
2111 ;; results, so it is cheap to call it within transcoders.
2112 ;;
2113 ;; It is possible to modify locally the back-end used by
2114 ;; `org-export-data' or even use a temporary back-end by using
2115 ;; `org-export-data-with-backend'.
2116 ;;
2117 ;; Internally, three functions handle the filtering of objects and
2118 ;; elements during the export. In particular,
2119 ;; `org-export-ignore-element' marks an element or object so future
2120 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
2121 ;; elements or objects should be seen as real Org syntax and
2122 ;; `org-export-expand' transforms the others back into their original
2123 ;; shape
2124 ;;
2125 ;; `org-export-transcoder' is an accessor returning appropriate
2126 ;; translator function for a given element or object.
2129 "Return appropriate transcoder for BLOB.
2130 INFO is a plist containing export directives."
2132 ;; Return contents only for complete parse trees.
2138 "Convert DATA into current back-end format.
2140 DATA is a parse tree, an element or an object or a secondary
2141 string. INFO is a plist holding export options.
2143 Return transcoded string."
2149 ;; Ignored element/object.
2151 ;; Plain text.
2157 info))
2158 ;; Uninterpreted element/object: change it back to Org
2159 ;; syntax and export again resulting raw string.
2163 data
2167 info))
2168 ;; Secondary string.
2171 ;; Element/Object without contents or, as a special case,
2172 ;; headline with archive tag and archived trees restricted
2173 ;; to title only.
2181 ;; Export snippets never return a nil value so
2182 ;; that white spaces following them are never
2183 ;; ignored.
2185 ;; Element/Object with contents.
2198 ;; Elements directly containing objects
2199 ;; must have their indentation normalized
2200 ;; first.
2202 data
2203 ;; When normalizing contents of the first
2204 ;; paragraph in an item or a footnote
2205 ;; definition, ignore first line's
2206 ;; indentation: there is none and it
2207 ;; might be misleading.
2212 data)
2219 info))))))))
2220 ;; Final result will be memoized before being returned.
2222 data
2226 ;; Append the same white space between elements or objects as in
2227 ;; the original buffer, and call appropriate filters.
2238 info)))
2239 results)))
2243 "Convert DATA into BACKEND format.
2245 DATA is an element, an object, a secondary string or a string.
2246 BACKEND is a symbol. INFO is a plist used as a communication
2247 channel.
2249 Unlike to `org-export-with-backend', this function will
2250 recursively convert DATA using BACKEND translation table."
2253 data
2254 ;; Set-up a new communication channel with translations defined in
2255 ;; BACKEND as the translate table and a new hash table for
2256 ;; memoization.
2258 info
2260 ;; Size of the hash table is reduced since this function
2261 ;; will probably be used on short trees.
2265 "Non-nil if element or object BLOB should be interpreted during export.
2266 If nil, BLOB will appear as raw Org syntax. Check is done
2267 according to export options INFO, stored as a plist."
2269 ;; ... entities...
2271 ;; ... emphasis...
2274 ;; ... fixed-width areas.
2276 ;; ... LaTeX environments and fragments...
2280 ;; ... sub/superscripts...
2286 ;; ... tables...
2291 "Expand a parsed element or object to its original state.
2293 BLOB is either an element or an object. CONTENTS is its
2294 contents, as a string or nil.
2296 When optional argument WITH-AFFILIATED is non-nil, add affiliated
2297 keywords before output."
2302 blob contents))))
2305 "Add ELEMENT to `:ignore-list' in INFO.
2307 Any element in `:ignore-list' will be skipped when using
2308 `org-element-map'. INFO is modified by side effects."
2312 \f
2313 ;;; The Filter System
2314 ;;
2315 ;; Filters allow end-users to tweak easily the transcoded output.
2316 ;; They are the functional counterpart of hooks, as every filter in
2317 ;; a set is applied to the return value of the previous one.
2318 ;;
2319 ;; Every set is back-end agnostic. Although, a filter is always
2320 ;; called, in addition to the string it applies to, with the back-end
2321 ;; used as argument, so it's easy for the end-user to add back-end
2322 ;; specific filters in the set. The communication channel, as
2323 ;; a plist, is required as the third argument.
2324 ;;
2325 ;; From the developer side, filters sets can be installed in the
2326 ;; process with the help of `org-export-define-backend', which
2327 ;; internally stores filters as an alist. Each association has a key
2328 ;; among the following symbols and a function or a list of functions
2329 ;; as value.
2330 ;;
2331 ;; - `:filter-options' applies to the property list containing export
2332 ;; options. Unlike to other filters, functions in this list accept
2333 ;; two arguments instead of three: the property list containing
2334 ;; export options and the back-end. Users can set its value through
2335 ;; `org-export-filter-options-functions' variable.
2336 ;;
2337 ;; - `:filter-parse-tree' applies directly to the complete parsed
2338 ;; tree. Users can set it through
2339 ;; `org-export-filter-parse-tree-functions' variable.
2340 ;;
2341 ;; - `:filter-final-output' applies to the final transcoded string.
2342 ;; Users can set it with `org-export-filter-final-output-functions'
2343 ;; variable
2344 ;;
2345 ;; - `:filter-plain-text' applies to any string not recognized as Org
2346 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2347 ;; configure it.
2348 ;;
2349 ;; - `:filter-TYPE' applies on the string returned after an element or
2350 ;; object of type TYPE has been transcoded. A user can modify
2351 ;; `org-export-filter-TYPE-functions'
2352 ;;
2353 ;; All filters sets are applied with
2354 ;; `org-export-filter-apply-functions' function. Filters in a set are
2355 ;; applied in a LIFO fashion. It allows developers to be sure that
2356 ;; their filters will be applied first.
2357 ;;
2358 ;; Filters properties are installed in communication channel with
2359 ;; `org-export-install-filters' function.
2360 ;;
2361 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2362 ;; `org-export-before-parsing-hook') are run at the beginning of the
2363 ;; export process and just before parsing to allow for heavy structure
2364 ;; modifications.
2367 ;;;; Hooks
2370 "Hook run at the beginning of the export process.
2372 This is run before include keywords and macros are expanded and
2373 Babel code blocks executed, on a copy of the original buffer
2374 being exported. Visibility and narrowing are preserved. Point
2375 is at the beginning of the buffer.
2377 Every function in this hook will be called with one argument: the
2381 "Hook run before parsing an export buffer.
2383 This is run after include keywords and macros have been expanded
2384 and Babel code blocks executed, on a copy of the original buffer
2385 being exported. Visibility and narrowing are preserved. Point
2386 is at the beginning of the buffer.
2388 Every function in this hook will be called with one argument: the
2392 ;;;; Special Filters
2395 "List of functions applied to the export options.
2396 Each filter is called with two arguments: the export options, as
2397 a plist, and the back-end, as a symbol. It must return
2401 "List of functions applied to the parsed tree.
2402 Each filter is called with three arguments: the parse tree, as
2403 returned by `org-element-parse-buffer', the back-end, as
2404 a symbol, and the communication channel, as a plist. It must
2408 "List of functions applied to plain text.
2409 Each filter is called with three arguments: a string which
2410 contains no Org syntax, the back-end, as a symbol, and the
2411 communication channel, as a plist. It must return a string or
2415 "List of functions applied to the transcoded string.
2416 Each filter is called with three arguments: the full transcoded
2417 string, the back-end, as a symbol, and the communication channel,
2418 as a plist. It must return a string that will be used as the
2422 ;;;; Elements Filters
2425 "List of functions applied to a transcoded babel-call.
2426 Each filter is called with three arguments: the transcoded data,
2427 as a string, the back-end, as a symbol, and the communication
2431 "List of functions applied to a transcoded center block.
2432 Each filter is called with three arguments: the transcoded data,
2433 as a string, the back-end, as a symbol, and the communication
2437 "List of functions applied to a transcoded clock.
2438 Each filter is called with three arguments: the transcoded data,
2439 as a string, the back-end, as a symbol, and the communication
2443 "List of functions applied to a transcoded comment.
2444 Each filter is called with three arguments: the transcoded data,
2445 as a string, the back-end, as a symbol, and the communication
2449 "List of functions applied to a transcoded comment-block.
2450 Each filter is called with three arguments: the transcoded data,
2451 as a string, the back-end, as a symbol, and the communication
2455 "List of functions applied to a transcoded diary-sexp.
2456 Each filter is called with three arguments: the transcoded data,
2457 as a string, the back-end, as a symbol, and the communication
2461 "List of functions applied to a transcoded drawer.
2462 Each filter is called with three arguments: the transcoded data,
2463 as a string, the back-end, as a symbol, and the communication
2467 "List of functions applied to a transcoded dynamic-block.
2468 Each filter is called with three arguments: the transcoded data,
2469 as a string, the back-end, as a symbol, and the communication
2473 "List of functions applied to a transcoded example-block.
2474 Each filter is called with three arguments: the transcoded data,
2475 as a string, the back-end, as a symbol, and the communication
2479 "List of functions applied to a transcoded export-block.
2480 Each filter is called with three arguments: the transcoded data,
2481 as a string, the back-end, as a symbol, and the communication
2485 "List of functions applied to a transcoded fixed-width.
2486 Each filter is called with three arguments: the transcoded data,
2487 as a string, the back-end, as a symbol, and the communication
2491 "List of functions applied to a transcoded footnote-definition.
2492 Each filter is called with three arguments: the transcoded data,
2493 as a string, the back-end, as a symbol, and the communication
2497 "List of functions applied to a transcoded headline.
2498 Each filter is called with three arguments: the transcoded data,
2499 as a string, the back-end, as a symbol, and the communication
2503 "List of functions applied to a transcoded horizontal-rule.
2504 Each filter is called with three arguments: the transcoded data,
2505 as a string, the back-end, as a symbol, and the communication
2509 "List of functions applied to a transcoded inlinetask.
2510 Each filter is called with three arguments: the transcoded data,
2511 as a string, the back-end, as a symbol, and the communication
2515 "List of functions applied to a transcoded item.
2516 Each filter is called with three arguments: the transcoded data,
2517 as a string, the back-end, as a symbol, and the communication
2521 "List of functions applied to a transcoded keyword.
2522 Each filter is called with three arguments: the transcoded data,
2523 as a string, the back-end, as a symbol, and the communication
2527 "List of functions applied to a transcoded latex-environment.
2528 Each filter is called with three arguments: the transcoded data,
2529 as a string, the back-end, as a symbol, and the communication
2533 "List of functions applied to a transcoded node-property.
2534 Each filter is called with three arguments: the transcoded data,
2535 as a string, the back-end, as a symbol, and the communication
2539 "List of functions applied to a transcoded paragraph.
2540 Each filter is called with three arguments: the transcoded data,
2541 as a string, the back-end, as a symbol, and the communication
2545 "List of functions applied to a transcoded plain-list.
2546 Each filter is called with three arguments: the transcoded data,
2547 as a string, the back-end, as a symbol, and the communication
2551 "List of functions applied to a transcoded planning.
2552 Each filter is called with three arguments: the transcoded data,
2553 as a string, the back-end, as a symbol, and the communication
2557 "List of functions applied to a transcoded property-drawer.
2558 Each filter is called with three arguments: the transcoded data,
2559 as a string, the back-end, as a symbol, and the communication
2563 "List of functions applied to a transcoded quote block.
2564 Each filter is called with three arguments: the transcoded quote
2565 data, as a string, the back-end, as a symbol, and the
2566 communication channel, as a plist. It must return a string or
2570 "List of functions applied to a transcoded quote-section.
2571 Each filter is called with three arguments: the transcoded data,
2572 as a string, the back-end, as a symbol, and the communication
2576 "List of functions applied to a transcoded section.
2577 Each filter is called with three arguments: the transcoded data,
2578 as a string, the back-end, as a symbol, and the communication
2582 "List of functions applied to a transcoded special block.
2583 Each filter is called with three arguments: the transcoded data,
2584 as a string, the back-end, as a symbol, and the communication
2588 "List of functions applied to a transcoded src-block.
2589 Each filter is called with three arguments: the transcoded data,
2590 as a string, the back-end, as a symbol, and the communication
2594 "List of functions applied to a transcoded table.
2595 Each filter is called with three arguments: the transcoded data,
2596 as a string, the back-end, as a symbol, and the communication
2600 "List of functions applied to a transcoded table-cell.
2601 Each filter is called with three arguments: the transcoded data,
2602 as a string, the back-end, as a symbol, and the communication
2606 "List of functions applied to a transcoded table-row.
2607 Each filter is called with three arguments: the transcoded data,
2608 as a string, the back-end, as a symbol, and the communication
2612 "List of functions applied to a transcoded verse block.
2613 Each filter is called with three arguments: the transcoded data,
2614 as a string, the back-end, as a symbol, and the communication
2618 ;;;; Objects Filters
2621 "List of functions applied to transcoded bold text.
2622 Each filter is called with three arguments: the transcoded data,
2623 as a string, the back-end, as a symbol, and the communication
2627 "List of functions applied to transcoded code text.
2628 Each filter is called with three arguments: the transcoded data,
2629 as a string, the back-end, as a symbol, and the communication
2633 "List of functions applied to a transcoded entity.
2634 Each filter is called with three arguments: the transcoded data,
2635 as a string, the back-end, as a symbol, and the communication
2639 "List of functions applied to a transcoded export-snippet.
2640 Each filter is called with three arguments: the transcoded data,
2641 as a string, the back-end, as a symbol, and the communication
2645 "List of functions applied to a transcoded footnote-reference.
2646 Each filter is called with three arguments: the transcoded data,
2647 as a string, the back-end, as a symbol, and the communication
2651 "List of functions applied to a transcoded inline-babel-call.
2652 Each filter is called with three arguments: the transcoded data,
2653 as a string, the back-end, as a symbol, and the communication
2657 "List of functions applied to a transcoded inline-src-block.
2658 Each filter is called with three arguments: the transcoded data,
2659 as a string, the back-end, as a symbol, and the communication
2663 "List of functions applied to transcoded italic text.
2664 Each filter is called with three arguments: the transcoded data,
2665 as a string, the back-end, as a symbol, and the communication
2669 "List of functions applied to a transcoded latex-fragment.
2670 Each filter is called with three arguments: the transcoded data,
2671 as a string, the back-end, as a symbol, and the communication
2675 "List of functions applied to a transcoded line-break.
2676 Each filter is called with three arguments: the transcoded data,
2677 as a string, the back-end, as a symbol, and the communication
2681 "List of functions applied to a transcoded link.
2682 Each filter is called with three arguments: the transcoded data,
2683 as a string, the back-end, as a symbol, and the communication
2687 "List of functions applied to a transcoded radio-target.
2688 Each filter is called with three arguments: the transcoded data,
2689 as a string, the back-end, as a symbol, and the communication
2693 "List of functions applied to a transcoded statistics-cookie.
2694 Each filter is called with three arguments: the transcoded data,
2695 as a string, the back-end, as a symbol, and the communication
2699 "List of functions applied to transcoded strike-through text.
2700 Each filter is called with three arguments: the transcoded data,
2701 as a string, the back-end, as a symbol, and the communication
2705 "List of functions applied to a transcoded subscript.
2706 Each filter is called with three arguments: the transcoded data,
2707 as a string, the back-end, as a symbol, and the communication
2711 "List of functions applied to a transcoded superscript.
2712 Each filter is called with three arguments: the transcoded data,
2713 as a string, the back-end, as a symbol, and the communication
2717 "List of functions applied to a transcoded target.
2718 Each filter is called with three arguments: the transcoded data,
2719 as a string, the back-end, as a symbol, and the communication
2723 "List of functions applied to a transcoded timestamp.
2724 Each filter is called with three arguments: the transcoded data,
2725 as a string, the back-end, as a symbol, and the communication
2729 "List of functions applied to transcoded underline text.
2730 Each filter is called with three arguments: the transcoded data,
2731 as a string, the back-end, as a symbol, and the communication
2735 "List of functions applied to transcoded verbatim text.
2736 Each filter is called with three arguments: the transcoded data,
2737 as a string, the back-end, as a symbol, and the communication
2741 ;;;; Filters Tools
2742 ;;
2743 ;; Internal function `org-export-install-filters' installs filters
2744 ;; hard-coded in back-ends (developer filters) and filters from global
2745 ;; variables (user filters) in the communication channel.
2746 ;;
2747 ;; Internal function `org-export-filter-apply-functions' takes care
2748 ;; about applying each filter in order to a given data. It ignores
2749 ;; filters returning a nil value but stops whenever a filter returns
2750 ;; an empty string.
2753 "Call every function in FILTERS.
2755 Functions are called with arguments VALUE, current export
2756 back-end's name and INFO. A function returning a nil value will
2757 be skipped. If it returns the empty string, the process ends and
2758 VALUE is ignored.
2760 Call is done in a LIFO fashion, to be sure that developer
2761 specified filters, if any, are called first."
2771 "Install filters properties in communication channel.
2772 INFO is a plist containing the current communication channel.
2773 Return the updated communication channel."
2775 ;; Install user-defined filters with `org-export-filters-alist'
2776 ;; and filters already in INFO (through ext-plist mechanism).
2783 ;; Filters in INFO will be called
2784 ;; before those user provided.
2787 default-value)))))
2788 org-export-filters-alist)
2789 ;; Prepend back-end specific filters to that list.
2791 ;; Single values get consed, lists are appended.
2796 plist key
2800 ;; Return new communication channel.
2804 \f
2805 ;;; Core functions
2806 ;;
2807 ;; This is the room for the main function, `org-export-as', along with
2808 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2809 ;; `org-export-string-as'. They differ either by the way they output
2810 ;; the resulting code (for the first two) or by the input type (for
2811 ;; the latter). `org-export--copy-to-kill-ring-p' determines if
2812 ;; output of these function should be added to kill ring.
2813 ;;
2814 ;; `org-export-output-file-name' is an auxiliary function meant to be
2815 ;; used with `org-export-to-file'. With a given extension, it tries
2816 ;; to provide a canonical file name to write export output to.
2817 ;;
2818 ;; Note that `org-export-as' doesn't really parse the current buffer,
2819 ;; but a copy of it (with the same buffer-local variables and
2820 ;; visibility), where macros and include keywords are expanded and
2821 ;; Babel blocks are executed, if appropriate.
2822 ;; `org-export-with-buffer-copy' macro prepares that copy.
2823 ;;
2824 ;; File inclusion is taken care of by
2825 ;; `org-export-expand-include-keyword' and
2826 ;; `org-export--prepare-file-contents'. Structure wise, including
2827 ;; a whole Org file in a buffer often makes little sense. For
2828 ;; example, if the file contains a headline and the include keyword
2829 ;; was within an item, the item should contain the headline. That's
2830 ;; why file inclusion should be done before any structure can be
2831 ;; associated to the file, that is before parsing.
2832 ;;
2833 ;; `org-export-insert-default-template' is a command to insert
2834 ;; a default template (or a back-end specific template) at point or in
2835 ;; current subtree.
2838 "Return a copy of the current buffer.
2839 The copy preserves Org buffer-local variables, visibility and
2840 narrowing."
2846 new-buf))
2849 "Apply BODY in a copy of the current buffer.
2850 The copy preserves local variables, visibility and contents of
2851 the original buffer. Point is at the beginning of the buffer
2852 when BODY is applied."
2861 ;; Kill copy without confirmation.
2867 "Generate a function duplicating BUFFER.
2869 The copy will preserve local variables, visibility, contents and
2870 narrowing of the original buffer. If a region was active in
2871 BUFFER, contents will be narrowed to that region instead.
2873 The resulting function can be evaled at a later time, from
2874 another buffer, effectively cloning the original buffer there.
2876 The function assumes BUFFER's major mode is `org-mode'."
2880 ;; Set major mode. Ignore `org-mode-hook' as it has been run
2881 ;; already in BUFFER.
2883 ;; Copy specific buffer local variables and variables set
2884 ;; through BIND keywords.
2886 vars)
2894 buffer-file-name
2895 buffer-file-coding-system))
2899 ;; Skip unreadable values, as they cannot be
2900 ;; sent to external process.
2904 vars))))))
2905 ;; Whole buffer contents.
2910 ;; Narrowing.
2914 ;; Current position of point.
2916 ;; Overlays with invisible property.
2926 ov-set))))
2928 ov-set)))))
2930 ;;;###autoload
2933 "Transcode current Org buffer into BACKEND code.
2935 BACKEND is either an export back-end, as returned by, e.g.,
2936 `org-export-create-backend', or a symbol referring to
2937 a registered back-end.
2939 If narrowing is active in the current buffer, only transcode its
2940 narrowed part.
2942 If a region is active, transcode that region.
2944 When optional argument SUBTREEP is non-nil, transcode the
2945 sub-tree at point, extracting information from the headline
2946 properties first.
2948 When optional argument VISIBLE-ONLY is non-nil, don't export
2949 contents of hidden elements.
2951 When optional argument BODY-ONLY is non-nil, only return body
2952 code, without surrounding template.
2954 Optional argument EXT-PLIST, when provided, is a property list
2955 with external parameters overriding Org default settings, but
2956 still inferior to file-local settings.
2958 Return code as a string."
2963 ;; Narrow buffer to an appropriate region or subtree for
2964 ;; parsing. If parsing subtree, be sure to remove main headline
2965 ;; too.
2973 ;; Initialize communication channel with original buffer
2974 ;; attributes, unavailable in its copy.
2983 tree)
2984 ;; Store default title in `org-export--default-title' so that
2985 ;; `org-export-get-environment' can access it from buffer's
2986 ;; copy and then add it properly to communication channel.
2988 ;; Update communication channel and get parse tree. Buffer
2989 ;; isn't parsed directly. Instead, a temporary copy is
2990 ;; created, where include keywords, macros are expanded and
2991 ;; code blocks are evaluated.
2993 ;; Run first hook with current back-end's name as argument.
2997 ;; Update macro templates since #+INCLUDE keywords might have
2998 ;; added some new ones.
3002 ;; Update radio targets since keyword inclusion might have
3003 ;; added some more.
3005 ;; Run last hook with current back-end's name as argument.
3010 ;; Update communication channel with environment. Also
3011 ;; install user's and developer's filters.
3016 ;; Expand export-specific set of macros: {{{author}}},
3017 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
3018 ;; once regular macros have been expanded, since document
3019 ;; keywords may contain one of them.
3025 ;; EMAIL is not a parsed keyword: store it as-is.
3029 ;; Call options filters and update export options. We do not
3030 ;; use `org-export-filter-apply-functions' here since the
3031 ;; arity of such filters is different.
3036 ;; Parse buffer and call parse-tree filter on it.
3041 ;; Now tree is complete, compute its properties and add them
3042 ;; to communication channel.
3046 ;; Eventually transcode TREE. Wrap the resulting string into
3047 ;; a template.
3056 ;; Remove all text properties since they cannot be
3057 ;; retrieved from an external process. Finally call
3058 ;; final-output filter and return result.
3064 info))))))))
3066 ;;;###autoload
3069 "Call `org-export-as' with output to a specified buffer.
3071 BACKEND is either an export back-end, as returned by, e.g.,
3072 `org-export-create-backend', or a symbol referring to
3073 a registered back-end.
3075 BUFFER is the output buffer. If it already exists, it will be
3076 erased first, otherwise, it will be created.
3078 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3079 EXT-PLIST are similar to those used in `org-export-as', which
3080 see.
3082 Depending on `org-export-copy-to-kill-ring', add buffer contents
3083 to kill ring. Return buffer."
3090 ;; Maybe add buffer contents to kill ring.
3093 ;; Return buffer.
3094 buffer))
3096 ;;;###autoload
3099 "Call `org-export-as' with output to a specified file.
3101 BACKEND is either an export back-end, as returned by, e.g.,
3102 `org-export-create-backend', or a symbol referring to
3103 a registered back-end. FILE is the name of the output file, as
3104 a string.
3106 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
3107 EXT-PLIST are similar to those used in `org-export-as', which
3108 see.
3110 Depending on `org-export-copy-to-kill-ring', add file contents
3111 to kill ring. Return output file's name."
3112 ;; Checks for FILE permissions. `write-file' would do the same, but
3113 ;; we'd rather avoid needless transcoding of parse tree.
3115 ;; Insert contents to a temporary buffer and write it to FILE.
3122 ;; Maybe add file contents to kill ring.
3125 ;; Return full path.
3126 file)
3128 ;;;###autoload
3130 "Transcode STRING into BACKEND code.
3132 BACKEND is either an export back-end, as returned by, e.g.,
3133 `org-export-create-backend', or a symbol referring to
3134 a registered back-end.
3136 When optional argument BODY-ONLY is non-nil, only return body
3137 code, without preamble nor postamble.
3139 Optional argument EXT-PLIST, when provided, is a property list
3140 with external parameters overriding Org default settings, but
3141 still inferior to file-local settings.
3143 Return code as a string."
3149 ;;;###autoload
3151 "Replace the active region by its export to BACKEND.
3152 BACKEND is either an export back-end, as returned by, e.g.,
3153 `org-export-create-backend', or a symbol referring to
3154 a registered back-end."
3164 ;;;###autoload
3166 "Insert all export keywords with default values at beginning of line.
3168 BACKEND is a symbol referring to the name of a registered export
3169 back-end, for which specific export options should be added to
3170 the template, or `default' for default template. When it is nil,
3171 the user will be prompted for a category.
3173 If SUBTREEP is non-nil, export configuration will be set up
3174 locally for the subtree through node properties."
3184 "Options category: "
3188 org-export--registered-backends))))))
3189 options keywords)
3190 ;; Populate OPTIONS and KEYWORDS.
3207 ;; Move to an appropriate location in order to insert options.
3209 ;; First get TITLE, DATE, AUTHOR and EMAIL if they belong to the
3210 ;; list of available keywords.
3238 ;; Then (multiple) OPTIONS lines. Never go past fill-column.
3257 ;; And the rest of keywords.
3268 "Return output file's name according to buffer specifications.
3270 EXTENSION is a string representing the output file extension,
3271 with the leading dot.
3273 With a non-nil optional argument SUBTREEP, try to determine
3275 of subtree at point.
3277 When optional argument PUB-DIR is set, use it as the publishing
3278 directory.
3280 When optional argument VISIBLE-ONLY is non-nil, don't export
3281 contents of hidden elements.
3283 Return file name as a string."
3286 ;; File name may come from EXPORT_FILE_NAME subtree
3287 ;; property, assuming point is at beginning of said
3288 ;; sub-tree.
3295 ;; File name may be extracted from buffer's associated
3296 ;; file, if any.
3298 ;; Can't determine file name on our own: Ask user.
3302 "Output file: " pub-dir nil nil nil
3306 ;; Build file name. Enforce EXTENSION over whatever user
3307 ;; may have come up with. PUB-DIR, if defined, always has
3308 ;; precedence over any provided path.
3313 extension))
3316 ;; If writing to OUTPUT-FILE would overwrite original file, append
3317 ;; EXTENSION another time to final name.
3320 output-file)))
3323 "Expand every include keyword in buffer.
3324 Optional argument INCLUDED is a list of included file names along
3325 with their line restriction, when appropriate. It is used to
3326 avoid infinite recursion. Optional argument DIR is the current
3327 working directory. It is used to properly resolve relative
3328 paths."
3335 ;; Extract arguments from keyword's value.
3343 dir)
3348 value)
3354 ;; Minimal level of included file defaults to the child
3355 ;; level of the current headline, if any, or one. It
3356 ;; only applies is the file is meant to be included as
3357 ;; an Org one.
3365 ;; Remove keyword.
3371 ;; Check if files has already been parsed. Look after
3372 ;; inclusion lines too, as different parts of the same file
3373 ;; can be included too.
3385 ind-str contents ind-str))))
3393 ind-str env contents ind-str))))
3406 "Prepare the contents of FILE for inclusion and return them as a string.
3408 When optional argument LINES is a string specifying a range of
3409 lines, include only those lines.
3411 Optional argument IND, when non-nil, is an integer specifying the
3412 global indentation of returned contents. Since its purpose is to
3413 allow an included file to stay in the same environment it was
3414 created \(i.e. a list item), it doesn't apply past the first
3415 headline encountered.
3417 Optional argument MINLEVEL, when non-nil, is an integer
3418 specifying the level that any top-level headline in the included
3419 file should have."
3435 ;; Remove blank lines at beginning and end of contents. The logic
3436 ;; behind that removal is that blank lines around include keyword
3437 ;; override blank lines in included file.
3446 ;; If IND is set, preserve indentation of include keyword until
3447 ;; the first headline encountered.
3454 ;; Do not move footnote definitions out of column 0.
3460 ;; When MINLEVEL is specified, compute minimal level for headlines
3461 ;; in the file (CUR-MIN), and remove stars to each headline so
3462 ;; that headlines with minimal level have a level of MINLEVEL.
3473 ;; Only change stars, don't bother moving whole
3474 ;; sections.
3481 "Execute every Babel code in the visible part of current buffer."
3482 ;; Get a pristine copy of current buffer so Babel references can be
3483 ;; properly resolved.
3490 "Return a non-nil value when output should be added to the kill ring.
3491 See also `org-export-copy-to-kill-ring'."
3497 \f
3498 ;;; Tools For Back-Ends
3499 ;;
3500 ;; A whole set of tools is available to help build new exporters. Any
3501 ;; function general enough to have its use across many back-ends
3502 ;; should be added here.
3504 ;;;; For Affiliated Keywords
3505 ;;
3506 ;; `org-export-read-attribute' reads a property from a given element
3507 ;; as a plist. It can be used to normalize affiliated keywords'
3508 ;; syntax.
3509 ;;
3510 ;; Since captions can span over multiple lines and accept dual values,
3511 ;; their internal representation is a bit tricky. Therefore,
3512 ;; `org-export-get-caption' transparently returns a given element's
3513 ;; caption as a secondary string.
3516 "Turn ATTRIBUTE property from ELEMENT into a plist.
3518 When optional argument PROPERTY is non-nil, return the value of
3519 that property within attributes.
3523 properties.
3525 All values will become strings except the empty string and
3528 will become the empty string."
3542 s)
3547 ;; Ignore any string before first property with `cdr'.
3552 "Return caption from ELEMENT as a secondary string.
3554 When optional argument SHORTP is non-nil, return short caption,
3555 as a secondary string, instead.
3557 Caption lines are separated by a white space."
3565 ;;;; For Derived Back-ends
3566 ;;
3567 ;; `org-export-with-backend' is a function allowing to locally use
3568 ;; another back-end to transcode some object or element. In a derived
3569 ;; back-end, it may be used as a fall-back function once all specific
3570 ;; cases have been treated.
3573 "Call a transcoder from BACKEND on DATA.
3574 BACKEND is an export back-end, as returned by, e.g.,
3575 `org-export-create-backend', or a symbol referring to
3576 a registered back-end. DATA is an Org element, object, secondary
3577 string or string. CONTENTS, when non-nil, is the transcoded
3578 contents of DATA element, as a string. INFO, when non-nil, is
3579 the communication channel used for export, as a plist."
3590 ;;;; For Export Snippets
3591 ;;
3592 ;; Every export snippet is transmitted to the back-end. Though, the
3593 ;; latter will only retain one type of export-snippet, ignoring
3594 ;; others, based on the former's target back-end. The function
3595 ;; `org-export-snippet-backend' returns that back-end for a given
3596 ;; export-snippet.
3599 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3600 Translation, with `org-export-snippet-translation-alist', is
3601 applied."
3605 back-end))))
3608 ;;;; For Footnotes
3609 ;;
3610 ;; `org-export-collect-footnote-definitions' is a tool to list
3611 ;; actually used footnotes definitions in the whole parse tree, or in
3612 ;; a headline, in order to add footnote listings throughout the
3613 ;; transcoded data.
3614 ;;
3615 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3616 ;; back-ends, when they need to attach the footnote definition only to
3617 ;; the first occurrence of the corresponding label.
3618 ;;
3619 ;; `org-export-get-footnote-definition' and
3620 ;; `org-export-get-footnote-number' provide easier access to
3621 ;; additional information relative to a footnote reference.
3624 "Return an alist between footnote numbers, labels and definitions.
3626 DATA is the parse tree from which definitions are collected.
3627 INFO is the plist used as a communication channel.
3629 Definitions are sorted by order of references. They either
3630 appear as Org data or as a secondary string for inlined
3631 footnotes. Unreferenced definitions are ignored."
3633 collect-fn ; for byte-compiler.
3637 ;; Collect footnote number, label and definition in DATA.
3645 def)
3646 num-alist)
3647 ;; Also search in definition for nested footnotes.
3650 ;; Don't enter footnote definitions since it will happen
3651 ;; when their first reference is found.
3657 "Non-nil when a footnote reference is the first one for its label.
3659 FOOTNOTE-REFERENCE is the footnote reference being considered.
3660 INFO is the plist used as a communication channel."
3662 ;; Anonymous footnotes are always a first reference.
3664 ;; Otherwise, return the first footnote with the same LABEL and
3665 ;; test if it is equal to FOOTNOTE-REFERENCE.
3675 ;; If FN isn't inlined, be sure to traverse its
3676 ;; definition before resuming search. See
3677 ;; comments in `org-export-get-footnote-number'
3678 ;; for more information.
3682 ;; Don't enter footnote definitions since it will
3683 ;; happen when their first reference is found.
3686 footnote-reference)))))
3689 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3690 INFO is the plist used as a communication channel. If no such
3692 string."
3699 "Return number associated to a footnote.
3701 FOOTNOTE is either a footnote reference or a footnote definition.
3702 INFO is the plist used as a communication channel."
3704 seen-refs
3705 search-ref ; For byte-compiler.
3709 ;; Search footnote references through DATA, filling
3710 ;; SEEN-REFS along the way.
3715 ;; Anonymous footnote match: return number.
3718 ;; Labels match: return number.
3721 ;; Anonymous footnote: it's always a new one.
3722 ;; Also, be sure to return nil from the `cond' so
3723 ;; `first-match' doesn't get us out of the loop.
3725 ;; Label not seen so far: add it so SEEN-REFS.
3726 ;;
3727 ;; Also search for subsequent references in
3728 ;; footnote definition so numbering follows
3729 ;; reading logic. Note that we don't have to care
3730 ;; about inline definitions, since
3731 ;; `org-element-map' already traverses them at the
3732 ;; right time.
3733 ;;
3734 ;; Once again, return nil to stay in the loop.
3739 nil))))
3740 ;; Don't enter footnote definitions since it will
3741 ;; happen when their first reference is found.
3746 ;;;; For Headlines
3747 ;;
3748 ;; `org-export-get-relative-level' is a shortcut to get headline
3749 ;; level, relatively to the lower headline level in the parsed tree.
3750 ;;
3751 ;; `org-export-get-headline-number' returns the section number of an
3752 ;; headline, while `org-export-number-to-roman' allows to convert it
3753 ;; to roman numbers.
3754 ;;
3755 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3756 ;; `org-export-last-sibling-p' are three useful predicates when it
3757 ;; comes to fulfill the `:headline-levels' property.
3758 ;;
3759 ;; `org-export-get-tags', `org-export-get-category' and
3760 ;; `org-export-get-node-property' extract useful information from an
3761 ;; headline or a parent headline. They all handle inheritance.
3762 ;;
3763 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3764 ;; as a secondary string, suitable for table of contents. It falls
3765 ;; back onto default title.
3768 "Return HEADLINE relative level within current parsed tree.
3769 INFO is a plist holding contextual information."
3774 "Non-nil when HEADLINE is considered as low level.
3776 INFO is a plist used as a communication channel.
3778 A low level headlines has a relative level greater than
3779 `:headline-levels' property value.
3781 Return value is the difference between HEADLINE relative level
3782 and the last level being considered as high enough, or nil."
3789 "Return HEADLINE numbering as a list of numbers.
3790 INFO is a plist holding contextual information."
3794 "Return a non-nil value if HEADLINE element should be numbered.
3795 INFO is a plist used as a communication channel."
3801 "Convert integer N into a roman numeral."
3814 res)))
3817 "Return list of tags associated to ELEMENT.
3819 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3820 is a plist used as a communication channel.
3822 Select tags (see `org-export-select-tags') and exclude tags (see
3823 `org-export-exclude-tags') are removed from the list.
3825 When non-nil, optional argument TAGS should be a list of strings.
3826 Any tag belonging to this list will also be removed.
3828 When optional argument INHERITED is non-nil, tags can also be
3829 inherited from parent headlines and FILETAGS keywords."
3835 ;; Build complete list of inherited tags.
3846 ;; Add FILETAGS keywords and return results.
3850 "Return node PROPERTY value for BLOB.
3852 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3853 element or object.
3855 If optional argument INHERITED is non-nil, the value can be
3856 inherited from a parent headline.
3858 Return value is a string or nil."
3870 "Return category for element or object BLOB.
3872 INFO is a plist used as a communication channel.
3874 CATEGORY is automatically inherited from a parent headline, from
3875 #+CATEGORY: keyword or created out of original file name. If all
3879 ;; Almost like `org-export-node-property', but we cannot trust
3880 ;; `plist-member' as every headline has a `:CATEGORY'
3881 ;; property, would it be nil or equal to "???" (which has the
3882 ;; same meaning).
3900 "Return alternative title for HEADLINE, as a secondary string.
3901 INFO is a plist used as a communication channel. If no optional
3902 title is defined, fall-back to the regular title."
3907 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3908 INFO is a plist used as a communication channel."
3913 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3914 INFO is a plist used as a communication channel."
3918 ;;;; For Keywords
3919 ;;
3920 ;; `org-export-get-date' returns a date appropriate for the document
3921 ;; to about to be exported. In particular, it takes care of
3922 ;; `org-export-date-timestamp-format'.
3925 "Return date value for the current document.
3927 INFO is a plist used as a communication channel. FMT, when
3928 non-nil, is a time format string that will be applied on the date
3929 if it consists in a single timestamp object. It defaults to
3930 `org-export-date-timestamp-format' when nil.
3932 A proper date can be a secondary string, a string or nil. It is
3933 meant to be translated with `org-export-data' or alike."
3944 ;;;; For Links
3945 ;;
3946 ;; `org-export-solidify-link-text' turns a string into a safer version
3947 ;; for links, replacing most non-standard characters with hyphens.
3948 ;;
3949 ;; `org-export-get-coderef-format' returns an appropriate format
3950 ;; string for coderefs.
3951 ;;
3952 ;; `org-export-inline-image-p' returns a non-nil value when the link
3953 ;; provided should be considered as an inline image.
3954 ;;
3955 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3956 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3957 ;; returns an appropriate unique identifier when found, or nil.
3958 ;;
3959 ;; `org-export-resolve-id-link' returns the first headline with
3960 ;; specified id or custom-id in parse tree, the path to the external
3961 ;; file with the id or nil when neither was found.
3962 ;;
3963 ;; `org-export-resolve-coderef' associates a reference to a line
3964 ;; number in the element it belongs, or returns the reference itself
3965 ;; when the element isn't numbered.
3968 "Take link text S and make a safe target out of it."
3973 "Return format string for code reference link.
3974 PATH is the link path. DESC is its description."
3982 "Non-nil if LINK object points to an inline image.
3984 Optional argument is a set of RULES defining inline images. It
3985 is an alist where associations have the following shape:
3987 \(TYPE . REGEXP)
3989 Applying a rule means apply REGEXP against LINK's path when its
3990 type is TYPE. The function will return a non-nil value if any of
3991 the provided rules is non-nil. The default rule is
3992 `org-export-default-inline-image-rule'.
3994 This only applies to links without a description."
4005 rules)
4006 ;; Return nil if no rule matched.
4007 nil))))
4010 "Resolve a code reference REF.
4012 INFO is a plist used as a communication channel.
4014 Return associated line number in source code, or REF itself,
4015 depending on src-block or example element's switches."
4022 org-coderef-label-format)))
4026 ;; Element containing REF is found. Resolve it to either
4027 ;; a label or a line number, as needed.
4037 "Return LINK destination.
4039 INFO is a plist holding contextual information.
4041 Return value can be an object, an element, or nil:
4043 - If LINK path matches a target object (i.e. <<path>>) return it.
4045 - If LINK path exactly matches the name affiliated keyword
4046 \(i.e. #+NAME: path) of an element, return that element.
4048 - If LINK path exactly matches any headline name, return that
4049 element. If more than one headline share that name, priority
4050 will be given to the one with the closest common ancestor, if
4051 any, or the first one in the parse tree otherwise.
4053 - Otherwise, return nil.
4056 significant."
4059 ;; Split PATH at white spaces so matches are space
4060 ;; insensitive.
4063 ;; Cache for destinations that are not position dependent.
4071 ;; Destination is not position dependent: use cached value.
4073 ;; First try to find a matching "<<path>>" unless user specified
4074 ;; he was looking for a headline (path starts with a "*"
4075 ;; character).
4081 path)
4082 blob))
4085 ;; Then try to find an element with a matching "#+NAME: path"
4086 ;; affiliated keyword.
4089 org-element-all-elements
4094 el)))
4097 ;; Last case: link either points to a headline or to nothingness.
4098 ;; Try to find the source, with priority given to headlines with
4099 ;; the closest common ancestor. If such candidate is found,
4100 ;; return it, otherwise return nil.
4104 ;; Return first headline whose `:raw-value' property is
4105 ;; NAME in parse tree DATA, or nil. Statistics cookies
4106 ;; are ignored.
4114 name)
4115 headline))
4117 ;; Search among headlines sharing an ancestor with link, from
4118 ;; closest to farthest.
4127 ;; No destination found: return nil.
4131 "Return headline referenced as LINK destination.
4133 INFO is a plist used as a communication channel.
4135 Return value can be the headline element matched in current parse
4139 ;; First check if id is within the current parse tree.
4144 headline))
4146 ;; Otherwise, look for external files.
4150 "Return radio-target object referenced as LINK destination.
4152 INFO is a plist used as a communication channel.
4154 Return value can be a radio-target object or nil. Assume LINK
4163 nil nil path nil nil t)
4164 t)
4165 radio))
4169 ;;;; For References
4170 ;;
4171 ;; `org-export-get-ordinal' associates a sequence number to any object
4172 ;; or element.
4175 "Return ordinal number of an element or object.
4177 ELEMENT is the element or object considered. INFO is the plist
4178 used as a communication channel.
4180 Optional argument TYPES, when non-nil, is a list of element or
4181 object types, as symbols, that should also be counted in.
4182 Otherwise, only provided element's type is considered.
4184 Optional argument PREDICATE is a function returning a non-nil
4185 value if the current element or object should be counted in. It
4186 accepts two arguments: the element or object being considered and
4187 the plist used as a communication channel. This allows to count
4188 only a certain type of objects (i.e. inline images).
4190 Return value is a list of numbers if ELEMENT is a headline or an
4191 item. It is nil for keywords. It represents the footnote number
4192 for footnote definitions and footnote references. If ELEMENT is
4193 a target, return the same value as if ELEMENT was the closest
4194 table, item or headline containing the target. In any other
4195 case, return the sequence number of ELEMENT among elements or
4196 objects of the same type."
4197 ;; Ordinal of a target object refer to the ordinal of the closest
4198 ;; table, item, or headline containing the object.
4202 when
4206 table))
4207 return parent)))
4209 ;; Special case 1: A headline returns its number as a list.
4211 ;; Special case 2: An item returns its number as a list.
4215 struct
4222 ;; Increment counter until ELEMENT is found again.
4233 ;;;; For Src-Blocks
4234 ;;
4235 ;; `org-export-get-loc' counts number of code lines accumulated in
4236 ;; src-block or example-block elements with a "+n" switch until
4237 ;; a given element, excluded. Note: "-n" switches reset that count.
4238 ;;
4239 ;; `org-export-unravel-code' extracts source code (along with a code
4240 ;; references alist) from an `element-block' or `src-block' type
4241 ;; element.
4242 ;;
4243 ;; `org-export-format-code' applies a formatting function to each line
4244 ;; of code, providing relative line number and code reference when
4245 ;; appropriate. Since it doesn't access the original element from
4246 ;; which the source code is coming, it expects from the code calling
4247 ;; it to know if lines should be numbered and if code references
4248 ;; should appear.
4249 ;;
4250 ;; Eventually, `org-export-format-code-default' is a higher-level
4251 ;; function (it makes use of the two previous functions) which handles
4252 ;; line numbering and code references inclusion, and returns source
4253 ;; code in a format suitable for plain text or verbatim output.
4256 "Return accumulated lines of code up to ELEMENT.
4258 INFO is the plist used as a communication channel.
4260 ELEMENT is excluded from count."
4266 ;; ELEMENT is reached: Quit the loop.
4268 ;; Only count lines from src-block and example-block elements
4269 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
4273 ;; Accumulate locs or reset them.
4277 ;; Return nil to stay in the loop.
4278 nil)))
4280 ;; Return value.
4281 loc))
4284 "Clean source code and extract references out of it.
4286 ELEMENT has either a `src-block' an `example-block' type.
4288 Return a cons cell whose CAR is the source code, cleaned from any
4289 reference and protective comma and CDR is an alist between
4290 relative line number (integer) and name of code reference on that
4291 line (string)."
4293 ;; Get code and clean it. Remove blank lines at its
4294 ;; beginning and end.
4300 ;; Get format used for references.
4303 org-coderef-label-format)))
4304 ;; Build a regexp matching a loc with a reference.
4309 ;; Return value.
4311 ;; Code with references removed.
4317 ;; Ref line: remove ref, and signal its position in REFS.
4321 ;; Reference alist.
4322 refs)))
4325 "Format CODE by applying FUN line-wise and return it.
4327 CODE is a string representing the code to format. FUN is
4328 a function. It must accept three arguments: a line of
4329 code (string), the current line number (integer) or nil and the
4330 reference associated to the current line (string) or nil.
4332 Optional argument NUM-LINES can be an integer representing the
4333 number of code lines accumulated until the current code. Line
4334 numbers passed to FUN will take it into account. If it is nil,
4335 FUN's second argument will always be nil. This number can be
4336 obtained with `org-export-get-loc' function.
4338 Optional argument REF-ALIST can be an alist between relative line
4339 number (i.e. ignoring NUM-LINES) and the name of the code
4340 reference on it. If it is nil, FUN's third argument will always
4341 be nil. It can be obtained through the use of
4342 `org-export-unravel-code' function."
4354 "Return source code from ELEMENT, formatted in a standard way.
4356 ELEMENT is either a `src-block' or `example-block' element. INFO
4357 is a plist used as a communication channel.
4359 This function takes care of line numbering and code references
4360 inclusion. Line numbers, when applicable, appear at the
4361 beginning of the line, separated from the code by two white
4362 spaces. Code references, on the other hand, appear flushed to
4363 the right, separated by six white spaces from the widest line of
4364 code."
4365 ;; Extract code and references.
4372 ;; Handle line numbering.
4381 ;; Prepare references display, if required. Any reference
4382 ;; should start six columns after the widest line of code,
4383 ;; wrapped with parenthesis.
4388 code
4392 number-str
4393 loc
4399 num-start refs)))))
4402 ;;;; For Tables
4403 ;;
4404 ;; `org-export-table-has-special-column-p' and and
4405 ;; `org-export-table-row-is-special-p' are predicates used to look for
4406 ;; meta-information about the table structure.
4407 ;;
4408 ;; `org-table-has-header-p' tells when the rows before the first rule
4409 ;; should be considered as table's header.
4410 ;;
4411 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4412 ;; and `org-export-table-cell-borders' extract information from
4413 ;; a table-cell element.
4414 ;;
4415 ;; `org-export-table-dimensions' gives the number on rows and columns
4416 ;; in the table, ignoring horizontal rules and special columns.
4417 ;; `org-export-table-cell-address', given a table-cell object, returns
4418 ;; the absolute address of a cell. On the other hand,
4419 ;; `org-export-get-table-cell-at' does the contrary.
4420 ;;
4421 ;; `org-export-table-cell-starts-colgroup-p',
4422 ;; `org-export-table-cell-ends-colgroup-p',
4423 ;; `org-export-table-row-starts-rowgroup-p',
4424 ;; `org-export-table-row-ends-rowgroup-p',
4425 ;; `org-export-table-row-starts-header-p' and
4426 ;; `org-export-table-row-ends-header-p' indicate position of current
4427 ;; row or cell within the table.
4430 "Non-nil when TABLE has a special column.
4431 All special columns will be ignored during export."
4432 ;; The table has a special column when every first cell of every row
4433 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4434 ;; "*" "_" and "^". Though, do not consider a first row containing
4435 ;; only empty cells as special.
4451 "Non-nil when TABLE has a header.
4453 INFO is a plist used as a communication channel.
4455 A table has a header when it contains at least two row groups."
4464 table
4475 cache)))))
4478 "Non-nil if TABLE-ROW is considered special.
4480 INFO is a plist used as the communication channel.
4482 All special rows will be ignored during export."
4486 ;; A row is special either when...
4488 ;; ... it starts with a field only containing "/",
4490 ;; ... the table contains a special column and the row start
4491 ;; with a marking character among, "^", "_", "$" or "!",
4495 ;; ... it contains only alignment cookies and empty cells.
4501 ;; Since VALUE is a secondary string, the following
4502 ;; checks avoid expanding it with `org-export-data'.
4514 "Return TABLE-ROW's group number, as an integer.
4516 INFO is a plist used as the communication channel.
4518 Return value is the group number, as an integer, or nil for
4519 special rows and rows separators. First group is also table's
4520 header."
4538 "Return TABLE-CELL contents width.
4540 INFO is a plist used as the communication channel.
4542 Return value is the width given by the last width cookie in the
4543 same column as TABLE-CELL, or nil."
4560 ;; In a special row, try to find a width cookie at COLUMN.
4564 ;; The following checks avoid expanding unnecessarily
4565 ;; the cell with `org-export-data'.
4575 "Return TABLE-CELL contents alignment.
4577 INFO is a plist used as the communication channel.
4579 Return alignment as specified by the last alignment cookie in the
4580 same column as TABLE-CELL. If no such cookie is found, a default
4581 alignment value will be deduced from fraction of numbers in the
4582 column (see `org-table-number-fraction' for more information).
4583 Possible values are `left', `right' and `center'."
4596 cookie-align
4597 previous-cell-number-p)
4600 ;; In a special row, try to find an alignment cookie at
4601 ;; COLUMN.
4605 ;; Since VALUE is a secondary string, the following
4606 ;; checks avoid useless expansion through
4607 ;; `org-export-data'.
4615 ;; Ignore table rules.
4617 ;; In a standard row, check if cell's contents are
4618 ;; expressing some kind of number. Increase NUMBER-CELLS
4619 ;; accordingly. Though, don't bother if an alignment
4620 ;; cookie has already defined cell's alignment.
4625 info)))
4627 ;; Treat an empty cell as a number if it follows
4628 ;; a number.
4634 ;; Return value. Alignment specified by cookies has
4635 ;; precedence over alignment deduced from cell's contents.
4641 org-table-number-fraction)
4644 cache)))))
4647 "Return TABLE-CELL borders.
4649 INFO is a plist used as a communication channel.
4651 Return value is a list of symbols, or nil. Possible values are:
4652 `top', `bottom', `above', `below', `left' and `right'. Note:
4653 `top' (resp. `bottom') only happen for a cell in the first
4654 row (resp. last row) of the table, ignoring table rules, if any.
4656 Returned borders ignore special rows."
4659 borders)
4660 ;; Top/above border? TABLE-CELL has a border above when a rule
4661 ;; used to demarcate row groups can be found above. Hence,
4662 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4663 ;; another regular row has to be found above that rule.
4672 ;; Look at every row before the current one.
4674 ;; No rule above, or rule found starts the table (ignoring any
4675 ;; special row): TABLE-CELL is at the top of the table.
4678 ;; Bottom/below border? TABLE-CELL has a border below when next
4679 ;; non-regular row below is a rule.
4688 ;; Look at every row after the current one.
4690 ;; No rule below, or rule found ends the table (modulo some
4691 ;; special row): TABLE-CELL is at the bottom of the table.
4694 ;; Right/left borders? They can only be specified by column
4695 ;; groups. Column groups are defined in a row starting with "/".
4696 ;; Also a column groups row only contains "<", "<>", ">" or blank
4697 ;; cells.
4714 ;; There's a left border when previous cell, if
4715 ;; any, ends a group, or current one starts one.
4721 ;; There's a right border when next cell, if any,
4722 ;; starts a group, or current one ends one.
4729 ;; Table rows are read in reverse order so last column groups
4730 ;; row has precedence over any previous one.
4732 ;; Return value.
4733 borders))
4736 "Non-nil when TABLE-CELL is at the beginning of a row group.
4737 INFO is a plist used as a communication channel."
4738 ;; A cell starts a column group either when it is at the beginning
4739 ;; of a row (or after the special column, if any) or when it has
4740 ;; a left border.
4743 table-cell)
4747 "Non-nil when TABLE-CELL is at the end of a row group.
4748 INFO is a plist used as a communication channel."
4749 ;; A cell ends a column group either when it is at the end of a row
4750 ;; or when it has a right border.
4753 table-cell)
4757 "Non-nil when TABLE-ROW is at the beginning of a column group.
4758 INFO is a plist used as a communication channel."
4766 "Non-nil when TABLE-ROW is at the end of a column group.
4767 INFO is a plist used as a communication channel."
4775 "Non-nil when TABLE-ROW is the first table header's row.
4776 INFO is a plist used as a communication channel."
4783 "Non-nil when TABLE-ROW is the last table header's row.
4784 INFO is a plist used as a communication channel."
4791 "Return TABLE-ROW number.
4792 INFO is a plist used as a communication channel. Return value is
4793 zero-based and ignores separators. The function returns nil for
4794 special colums and separators."
4806 "Return TABLE dimensions.
4808 INFO is a plist used as a communication channel.
4810 Return value is a CONS like (ROWS . COLUMNS) where
4811 ROWS (resp. COLUMNS) is the number of exportable
4812 rows (resp. columns)."
4814 ;; Set number of rows, and extract first one.
4820 ;; Set number of columns.
4822 ;; Return value.
4826 "Return address of a regular TABLE-CELL object.
4828 TABLE-CELL is the cell considered. INFO is a plist used as
4829 a communication channel.
4831 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4832 zero-based index. Only exportable cells are considered. The
4833 function returns nil for other cells."
4845 "Return regular table-cell object at ADDRESS in TABLE.
4847 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4848 zero-based index. TABLE is a table type element. INFO is
4849 a plist used as a communication channel.
4851 If no table-cell, among exportable cells, is found at ADDRESS,
4852 return nil."
4855 ;; Row at (car address) or nil.
4863 'table-cell
4870 ;;;; For Tables Of Contents
4871 ;;
4872 ;; `org-export-collect-headlines' builds a list of all exportable
4873 ;; headline elements, maybe limited to a certain depth. One can then
4874 ;; easily parse it and transcode it.
4875 ;;
4876 ;; Building lists of tables, figures or listings is quite similar.
4877 ;; Once the generic function `org-export-collect-elements' is defined,
4878 ;; `org-export-collect-tables', `org-export-collect-figures' and
4879 ;; `org-export-collect-listings' can be derived from it.
4882 "Collect headlines in order to build a table of contents.
4884 INFO is a plist used as a communication channel.
4886 When optional argument N is an integer, it specifies the depth of
4887 the table of contents. Otherwise, it is set to the value of the
4888 last headline level. See `org-export-headline-levels' for more
4889 information.
4891 Return a list of all exportable headlines as parsed elements.
4892 Footnote sections, if any, will be ignored."
4897 ;; Strip contents from HEADLINE.
4900 info))
4903 "Collect referenceable elements of a determined type.
4905 TYPE can be a symbol or a list of symbols specifying element
4906 types to search. Only elements with a caption are collected.
4908 INFO is a plist used as a communication channel.
4910 When non-nil, optional argument PREDICATE is a function accepting
4911 one argument, an element of type TYPE. It returns a non-nil
4912 value when that element should be collected.
4914 Return a list of all elements found, in order of appearance."
4919 element))
4920 info))
4923 "Build a list of tables.
4924 INFO is a plist used as a communication channel.
4926 Return a list of table elements with a caption."
4930 "Build a list of figures.
4932 INFO is a plist used as a communication channel. PREDICATE is
4933 a function which accepts one argument: a paragraph element and
4934 whose return value is non-nil when that element should be
4935 collected.
4937 A figure is a paragraph type element, with a caption, verifying
4939 a vague concept that may depend on back-end.
4941 Return a list of elements recognized as figures."
4945 "Build a list of src blocks.
4947 INFO is a plist used as a communication channel.
4949 Return a list of src-block elements with a caption."
4953 ;;;; Smart Quotes
4954 ;;
4955 ;; The main function for the smart quotes sub-system is
4956 ;; `org-export-activate-smart-quotes', which replaces every quote in
4957 ;; a given string from the parse tree with its "smart" counterpart.
4958 ;;
4959 ;; Dictionary for smart quotes is stored in
4960 ;; `org-export-smart-quotes-alist'.
4961 ;;
4962 ;; Internally, regexps matching potential smart quotes (checks at
4963 ;; string boundaries are also necessary) are defined in
4964 ;; `org-export-smart-quotes-regexps'.
4968 ;; one may use: »...«, "...", ›...‹, or '...'.
4969 ;; http://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
4970 ;; LaTeX quotes require Babel!
5015 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5024 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5033 ;; https://nn.wikipedia.org/wiki/Sitatteikn
5042 ;; based on https://sv.wikipedia.org/wiki/Citattecken
5048 )
5049 "Smart quotes translations.
5051 Alist whose CAR is a language string and CDR is an alist with
5052 quote type as key and a plist associating various encodings to
5053 their translation as value.
5055 A quote type can be any symbol among `opening-double-quote',
5056 `closing-double-quote', `opening-single-quote',
5057 `closing-single-quote' and `apostrophe'.
5059 Valid encodings include `:utf-8', `:html', `:latex' and
5060 `:texinfo'.
5066 ;; Possible opening quote at beginning of string.
5068 ;; Possible closing quote at beginning of string.
5070 ;; Possible apostrophe at beginning of string.
5072 ;; Opening single and double quotes.
5074 ;; Closing single and double quotes.
5076 ;; Apostrophe.
5078 ;; Possible opening quote at end of string.
5080 ;; Possible closing quote at end of string.
5082 ;; Possible apostrophe at end of string.
5084 "List of regexps matching a quote or an apostrophe.
5090 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
5091 `:utf-8'. INFO is a plist used as a communication channel.
5093 The function has to retrieve information about string
5094 surroundings in parse tree. It can only happen with an
5095 unmodified string. Thus, if S has already been through another
5096 process, a non-nil ORIGINAL optional argument will provide that
5097 original string.
5099 Return the new string."
5102 ;; Try to be flexible when computing number of blanks
5103 ;; before object. The previous object may be a string
5104 ;; introduced by the back-end and not completely parsed.
5107 ;; A string with missing `:post-blank'
5108 ;; property.
5112 ;; Fallback value.
5117 ;; Return smart quote associated to a give quote Q, as
5118 ;; a string. TYPE is a symbol among `open', `close' and
5119 ;; `apostrophe'.
5129 org-export-smart-quotes-alist))))
5130 encoding)
5131 q)))))
5133 ;; Only a quote: no regexp can match. We have to check both
5134 ;; sides and decide what to do.
5142 ;; 1. Replace quote character at the beginning of S.
5144 ;; Apostrophe?
5150 ;; Closing quote?
5156 ;; Opening quote?
5162 ;; 2. Replace quotes in the middle of the string.
5164 ;; Opening quotes.
5170 ;; Closing quotes.
5176 ;; Apostrophes.
5181 ;; 3. Replace quote character at the end of S.
5183 ;; Apostrophe?
5188 ;; Closing quote?
5194 ;; Opening quote?
5199 ;; Return string with smart quotes.
5200 s))))
5202 ;;;; Topology
5203 ;;
5204 ;; Here are various functions to retrieve information about the
5205 ;; neighbourhood of a given element or object. Neighbours of interest
5206 ;; are direct parent (`org-export-get-parent'), parent headline
5207 ;; (`org-export-get-parent-headline'), first element containing an
5208 ;; object, (`org-export-get-parent-element'), parent table
5209 ;; (`org-export-get-parent-table'), previous element or object
5210 ;; (`org-export-get-previous-element') and next element or object
5211 ;; (`org-export-get-next-element').
5212 ;;
5213 ;; `org-export-get-genealogy' returns the full genealogy of a given
5214 ;; element or object, from closest parent to full parse tree.
5217 "Return BLOB parent or nil.
5218 BLOB is the element or object considered."
5222 "Return full genealogy relative to a given element or object.
5224 BLOB is the element or object being considered.
5226 Ancestors are returned from closest to farthest, the last one
5227 being the full parse tree."
5234 "Return BLOB parent headline or nil.
5235 BLOB is the element or object being considered."
5239 parent))
5242 "Return first element containing OBJECT or nil.
5243 OBJECT is the object to consider."
5247 parent))
5250 "Return OBJECT parent table or nil.
5251 OBJECT is either a `table-cell' or `table-element' type object."
5255 parent))
5258 "Return previous element or object.
5260 BLOB is an element or object. INFO is a plist used as
5261 a communication channel. Return previous exportable element or
5262 object, a string, or nil.
5264 When optional argument N is a positive integer, return a list
5265 containing up to N siblings before BLOB, from farthest to
5266 closest. With any other non-nil value, return a list containing
5267 all of them."
5269 ;; An object can belong to the contents of its parent or
5270 ;; to a secondary string. We check the latter option
5271 ;; first.
5274 org-element-all-elements))
5278 org-element-secondary-value-alist))
5279 parent)))
5282 prev)
5291 prev)))
5294 "Return next element or object.
5296 BLOB is an element or object. INFO is a plist used as
5297 a communication channel. Return next exportable element or
5298 object, a string, or nil.
5300 When optional argument N is a positive integer, return a list
5301 containing up to N siblings after BLOB, from closest to farthest.
5302 With any other non-nil value, return a list containing all of
5303 them."
5305 ;; An object can belong to the contents of its parent or to
5306 ;; a secondary string. We check the latter option first.
5309 org-element-all-objects))
5313 org-element-secondary-value-alist))
5314 parent)))
5317 next)
5325 siblings)
5329 ;;;; Translation
5330 ;;
5331 ;; `org-export-translate' translates a string according to the language
5332 ;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
5333 ;; the dictionary used for the translation.
5517 "Dictionary for export engine.
5519 Alist whose CAR is the string to translate and CDR is an alist
5520 whose CAR is the language string and CDR is a plist whose
5521 properties are possible charsets and values translated terms.
5523 It is used as a database for `org-export-translate'. Since this
5524 function returns the string as-is if no translation was found,
5525 the variable only needs to record values different from the
5529 "Translate string S according to language specification.
5531 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5532 and `:utf-8'. INFO is a plist used as a communication channel.
5534 Translation depends on `:language' property. Return the
5535 translated string. If no translation is found, try to fall back
5536 to `:default' encoding. If it fails, return S."
5542 s)))
5545 \f
5546 ;;; Asynchronous Export
5547 ;;
5548 ;; `org-export-async-start' is the entry point for asynchronous
5549 ;; export. It recreates current buffer (including visibility,
5550 ;; narrowing and visited file) in an external Emacs process, and
5551 ;; evaluates a command there. It then applies a function on the
5552 ;; returned results in the current process.
5553 ;;
5554 ;; Asynchronously generated results are never displayed directly.
5555 ;; Instead, they are stored in `org-export-stack-contents'. They can
5556 ;; then be retrieved by calling `org-export-stack'.
5557 ;;
5558 ;; Export Stack is viewed through a dedicated major mode
5559 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5560 ;;`org-export-stack-delete', `org-export-stack-view' and
5561 ;;`org-export-stack-clear'.
5562 ;;
5563 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5564 ;; It should used whenever `org-export-async-start' is called.
5567 "Call function FUN on the results returned by BODY evaluation.
5569 BODY evaluation happens in an asynchronous process, from a buffer
5570 which is an exact copy of the current one.
5572 Use `org-export-add-to-stack' in FUN in order to register results
5573 in the stack. Examples for, respectively a temporary buffer and
5574 a file are:
5576 \(org-export-async-start
5577 \(lambda (output)
5579 \(erase-buffer)
5580 \(insert output)
5581 \(goto-char (point-min))
5582 \(org-export-add-to-stack (current-buffer) 'backend)))
5583 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5585 and
5587 \(org-export-async-start
5588 \(lambda (f) (org-export-add-to-stack f 'backend))
5589 `(expand-file-name
5590 \(org-export-to-file
5591 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5594 ;; Write the full sexp evaluating BODY in a copy of the current
5595 ;; buffer to a temporary file, as it may be too long for program
5596 ;; args in `start-process'.
5603 ;; Null characters (from variable values) are inserted
5604 ;; within the file. As a consequence, coding system for
5605 ;; buffer contents will not be recognized properly. So,
5606 ;; we make sure it is the same as the one used to display
5607 ;; the original buffer.
5609 ,coding
5612 ;; Ignore `kill-emacs-hook' and code evaluation
5613 ;; queries from Babel as we need a truly
5614 ;; non-interactive process.
5616 org-babel-confirm-evaluate-answer-no t)
5617 ;; Initialize export framework.
5619 ;; Re-create current buffer there.
5622 ;; Sexp to evaluate in the buffer.
5624 ;; Start external process.
5627 (,process
5632 "-l" org-export-async-init-file
5634 ;; Register running process in stack.
5636 ;; Set-up sentinel in order to catch results.
5638 ,process
5662 "Add a new result to export stack if not present already.
5664 SOURCE is a buffer or a file name containing export results.
5665 BACKEND is a symbol representing export back-end used to generate
5666 it.
5668 Entries already pointing to SOURCE and unavailable entries are
5669 removed beforehand. Return the new stack."
5675 "Menu for asynchronous export results and running processes."
5685 "Return source from export results at point in stack."
5692 source
5693 ;; SOURCE is not consistent with current line. The stack
5694 ;; view is outdated.
5698 "Remove all entries from export stack."
5703 "Refresh the asynchronous export stack.
5704 DUMMY is ignored. Unavailable sources are removed from the list.
5705 Return the new stack."
5715 ;; Back-end.
5717 ;; Age.
5720 ;; Compute age of the results.
5722 "%4h:%.2m "
5724 ;; Source.
5729 ;; Clear stack from exited processes, dead buffers or
5730 ;; non-existent files.
5742 "Remove export results at point from stack.
5743 If optional argument SOURCE is non-nil, remove it instead."
5748 org-export-stack-contents))))
5751 "View export results at point in stack.
5752 With an optional prefix argument IN-EMACS, force viewing files
5753 within Emacs."
5767 (define-key km "p" 'previous-line)
5768 (define-key km "\C-p" 'previous-line)
5769 (define-key km "\C-?" 'previous-line)
5770 (define-key km [up] 'previous-line)
5771 (define-key km "C" 'org-export-stack-clear)
5772 (define-key km "v" 'org-export-stack-view)
5773 (define-key km (kbd "RET") 'org-export-stack-view)
5774 (define-key km "d" 'org-export-stack-remove)
5775 km)
5776 "Keymap for Org Export Stack.")
5778 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5779 "Mode for displaying asynchronous export stack.
5782 stack.
5784 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5785 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5786 stack completely.
5788 Removing entries in an Org Export Stack buffer doesn't affect
5789 files or buffers, only the display.
5792 (abbrev-mode 0)
5793 (auto-fill-mode 0)
5794 (setq buffer-read-only t
5795 buffer-undo-list t
5796 truncate-lines t
5797 header-line-format
5798 '(:eval
5799 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5800 (org-add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5801 (set (make-local-variable 'revert-buffer-function)
5802 'org-export-stack-refresh))
5805 \f
5806 ;;; The Dispatcher
5807 ;;
5808 ;; `org-export-dispatch' is the standard interactive way to start an
5809 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5810 ;; for its interface, which, in turn, delegates response to key
5811 ;; pressed to `org-export--dispatch-action'.
5813 ;;;###autoload
5814 (defun org-export-dispatch (&optional arg)
5815 "Export dispatcher for Org mode.
5817 It provides an access to common export related tasks in a buffer.
5818 Its interface comes in two flavours: standard and expert.
5820 While both share the same set of bindings, only the former
5821 displays the valid keys associations in a dedicated buffer.
5822 Scrolling (resp. line-wise motion) in this buffer is done with
5823 SPC and DEL (resp. C-n and C-p) keys.
5825 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5826 flavour or the other.
5829 of options used back then, on the current buffer.
5831 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5832 (interactive "P")
5833 (let* ((input
5834 (cond ((equal arg '(16)) '(stack))
5835 ((and arg org-export-dispatch-last-action))
5836 (t (save-window-excursion
5837 (unwind-protect
5838 (progn
5839 ;; Remember where we are
5840 (move-marker org-export-dispatch-last-position
5841 (point)
5842 (org-base-buffer (current-buffer)))
5843 ;; Get and store an export command
5844 (setq org-export-dispatch-last-action
5845 (org-export--dispatch-ui
5846 (list org-export-initial-scope
5847 (and org-export-in-background 'async))
5848 nil
5849 org-export-dispatch-use-expert-ui)))
5850 (and (get-buffer "*Org Export Dispatcher*")
5851 (kill-buffer "*Org Export Dispatcher*")))))))
5852 (action (car input))
5853 (optns (cdr input)))
5854 (unless (memq 'subtree optns)
5855 (move-marker org-export-dispatch-last-position nil))
5856 (case action
5857 ;; First handle special hard-coded actions.
5858 (template (org-export-insert-default-template nil optns))
5859 (stack (org-export-stack))
5860 (publish-current-file
5861 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5862 (publish-current-project
5863 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5864 (publish-choose-project
5865 (org-publish (assoc (org-icompleting-read
5866 "Publish project: "
5867 org-publish-project-alist nil t)
5868 org-publish-project-alist)
5869 (memq 'force optns)
5870 (memq 'async optns)))
5871 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5872 (otherwise
5873 (save-excursion
5874 (when arg
5875 ;; Repeating command, maybe move cursor to restore subtree
5876 ;; context.
5877 (if (eq (marker-buffer org-export-dispatch-last-position)
5878 (org-base-buffer (current-buffer)))
5879 (goto-char org-export-dispatch-last-position)
5880 ;; We are in a different buffer, forget position.
5881 (move-marker org-export-dispatch-last-position nil)))
5882 (funcall action
5883 ;; Return a symbol instead of a list to ease
5884 ;; asynchronous export macro use.
5885 (and (memq 'async optns) t)
5886 (and (memq 'subtree optns) t)
5887 (and (memq 'visible optns) t)
5888 (and (memq 'body optns) t)))))))
5890 (defun org-export--dispatch-ui (options first-key expertp)
5891 "Handle interface for `org-export-dispatch'.
5893 OPTIONS is a list containing current interactive options set for
5894 export. It can contain any of the following symbols:
5895 `body' toggles a body-only export
5896 `subtree' restricts export to current subtree
5897 `visible' restricts export to visible part of buffer.
5898 `force' force publishing files.
5899 `async' use asynchronous export process
5901 FIRST-KEY is the key pressed to select the first level menu. It
5902 is nil when this menu hasn't been selected yet.
5904 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5905 buffer is provided, but indications about currently active
5906 options are given in the prompt. Moreover, \[?] allows to switch
5907 back to standard interface."
5908 (let* ((fontify-key
5909 (lambda (key &optional access-key)
5910 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5911 ;; non-nil is the required first-level key to activate
5912 ;; KEY. When its value is t, activate KEY independently
5913 ;; on the first key, if any. A nil value means KEY will
5914 ;; only be activated at first level.
5915 (if (or (eq access-key t) (eq access-key first-key))
5916 (org-propertize key 'face 'org-warning)
5917 key)))
5918 (fontify-value
5919 (lambda (value)
5920 ;; Fontify VALUE string.
5921 (org-propertize value 'face 'font-lock-variable-name-face)))
5922 ;; Prepare menu entries by extracting them from registered
5923 ;; back-ends and sorting them by access key and by ordinal,
5924 ;; if any.
5925 (entries
5926 (sort (sort (delq nil
5927 (mapcar 'org-export-backend-menu
5928 org-export--registered-backends))
5929 (lambda (a b)
5930 (let ((key-a (nth 1 a))
5931 (key-b (nth 1 b)))
5932 (cond ((and (numberp key-a) (numberp key-b))
5933 (< key-a key-b))
5934 ((numberp key-b) t)))))
5935 'car-less-than-car))
5936 ;; Compute a list of allowed keys based on the first key
5937 ;; pressed, if any. Some keys
5938 ;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
5939 ;; available.
5940 (allowed-keys
5941 (nconc (list 2 22 19 6 1)
5942 (if (not first-key) (org-uniquify (mapcar 'car entries))
5943 (let (sub-menu)
5944 (dolist (entry entries (sort (mapcar 'car sub-menu) '<))
5945 (when (eq (car entry) first-key)
5946 (setq sub-menu (append (nth 2 entry) sub-menu))))))
5947 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5948 ((not first-key) (list ?P)))
5949 (list ?& ?#)
5950 (when expertp (list ??))
5951 (list ?q)))
5952 ;; Build the help menu for standard UI.
5953 (help
5954 (unless expertp
5955 (concat
5956 ;; Options are hard-coded.
5957 (format "[%s] Body only: %s [%s] Visible only: %s
5958 \[%s] Export scope: %s [%s] Force publishing: %s
5960 (funcall fontify-key "C-b" t)
5961 (funcall fontify-value
5962 (if (memq 'body options) "On " "Off"))
5963 (funcall fontify-key "C-v" t)
5964 (funcall fontify-value
5965 (if (memq 'visible options) "On " "Off"))
5966 (funcall fontify-key "C-s" t)
5967 (funcall fontify-value
5968 (if (memq 'subtree options) "Subtree" "Buffer "))
5969 (funcall fontify-key "C-f" t)
5970 (funcall fontify-value
5971 (if (memq 'force options) "On " "Off"))
5972 (funcall fontify-key "C-a" t)
5973 (funcall fontify-value
5974 (if (memq 'async options) "On " "Off")))
5975 ;; Display registered back-end entries. When a key
5976 ;; appears for the second time, do not create another
5977 ;; entry, but append its sub-menu to existing menu.
5978 (let (last-key)
5979 (mapconcat
5980 (lambda (entry)
5981 (let ((top-key (car entry)))
5982 (concat
5983 (unless (eq top-key last-key)
5984 (setq last-key top-key)
5986 (funcall fontify-key (char-to-string top-key))
5987 (nth 1 entry)))
5988 (let ((sub-menu (nth 2 entry)))
5989 (unless (functionp sub-menu)
5990 ;; Split sub-menu into two columns.
5991 (let ((index -1))
5992 (concat
5993 (mapconcat
5994 (lambda (sub-entry)
5995 (incf index)
5996 (format
5997 (if (zerop (mod index 2)) " [%s] %-26s"
5999 (funcall fontify-key
6000 (char-to-string (car sub-entry))
6001 top-key)
6002 (nth 1 sub-entry)))
6003 sub-menu "")
6005 entries ""))
6006 ;; Publishing menu is hard-coded.
6008 [%s] Current file [%s] Current project
6010 (funcall fontify-key "P")
6011 (funcall fontify-key "f" ?P)
6012 (funcall fontify-key "p" ?P)
6013 (funcall fontify-key "x" ?P)
6014 (funcall fontify-key "a" ?P))
6016 (funcall fontify-key "&" t)
6017 (funcall fontify-key "#" t))
6018 (format "[%s] %s"
6019 (funcall fontify-key "q" t)
6020 (if first-key "Main menu" "Exit")))))
6021 ;; Build prompts for both standard and expert UI.
6022 (standard-prompt (unless expertp "Export command: "))
6023 (expert-prompt
6024 (when expertp
6025 (format
6026 "Export command (C-%s%s%s%s%s) [%s]: "
6027 (if (memq 'body options) (funcall fontify-key "b" t) "b")
6028 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
6029 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
6030 (if (memq 'force options) (funcall fontify-key "f" t) "f")
6031 (if (memq 'async options) (funcall fontify-key "a" t) "a")
6032 (mapconcat (lambda (k)
6033 ;; Strip control characters.
6034 (unless (< k 27) (char-to-string k)))
6035 allowed-keys "")))))
6036 ;; With expert UI, just read key with a fancy prompt. In standard
6037 ;; UI, display an intrusive help buffer.
6038 (if expertp
6039 (org-export--dispatch-action
6040 expert-prompt allowed-keys entries options first-key expertp)
6041 ;; At first call, create frame layout in order to display menu.
6042 (unless (get-buffer "*Org Export Dispatcher*")
6043 (delete-other-windows)
6044 (org-switch-to-buffer-other-window
6045 (get-buffer-create "*Org Export Dispatcher*"))
6046 (setq cursor-type nil
6047 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
6048 ;; Make sure that invisible cursor will not highlight square
6049 ;; brackets.
6050 (set-syntax-table (copy-syntax-table))
6051 (modify-syntax-entry ?\[ "w"))
6052 ;; At this point, the buffer containing the menu exists and is
6053 ;; visible in the current window. So, refresh it.
6054 (with-current-buffer "*Org Export Dispatcher*"
6055 ;; Refresh help. Maintain display continuity by re-visiting
6056 ;; previous window position.
6057 (let ((pos (window-start)))
6058 (erase-buffer)
6059 (insert help)
6060 (set-window-start nil pos)))
6061 (org-fit-window-to-buffer)
6062 (org-export--dispatch-action
6063 standard-prompt allowed-keys entries options first-key expertp))))
6065 (defun org-export--dispatch-action
6066 (prompt allowed-keys entries options first-key expertp)
6067 "Read a character from command input and act accordingly.
6069 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
6070 a list of characters available at a given step in the process.
6071 ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
6072 EXPERTP are the same as defined in `org-export--dispatch-ui',
6073 which see.
6075 Toggle export options when required. Otherwise, return value is
6076 a list with action as CAR and a list of interactive export
6077 options as CDR."
6078 (let (key)
6079 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
6080 ;; C-p, SPC, DEL).
6081 (while (and (setq key (read-char-exclusive prompt))
6082 (not expertp)
6083 (memq key '(14 16 ?\s ?\d)))
6084 (case key
6085 (14 (if (not (pos-visible-in-window-p (point-max)))
6086 (ignore-errors (scroll-up 1))
6087 (message "End of buffer")
6088 (sit-for 1)))
6089 (16 (if (not (pos-visible-in-window-p (point-min)))
6090 (ignore-errors (scroll-down 1))
6091 (message "Beginning of buffer")
6092 (sit-for 1)))
6093 (?\s (if (not (pos-visible-in-window-p (point-max)))
6094 (scroll-up nil)
6095 (message "End of buffer")
6096 (sit-for 1)))
6097 (?\d (if (not (pos-visible-in-window-p (point-min)))
6098 (scroll-down nil)
6099 (message "Beginning of buffer")
6100 (sit-for 1)))))
6101 (cond
6102 ;; Ignore undefined associations.
6103 ((not (memq key allowed-keys))
6104 (ding)
6105 (unless expertp (message "Invalid key") (sit-for 1))
6106 (org-export--dispatch-ui options first-key expertp))
6107 ;; q key at first level aborts export. At second level, cancel
6108 ;; first key instead.
6109 ((eq key ?q) (if (not first-key) (error "Export aborted")
6110 (org-export--dispatch-ui options nil expertp)))
6111 ;; Help key: Switch back to standard interface if expert UI was
6112 ;; active.
6113 ((eq key ??) (org-export--dispatch-ui options first-key nil))
6114 ;; Send request for template insertion along with export scope.
6115 ((eq key ?#) (cons 'template (memq 'subtree options)))
6116 ;; Switch to asynchronous export stack.
6117 ((eq key ?&) '(stack))
6118 ;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
6119 ((memq key '(2 22 19 6 1))
6120 (org-export--dispatch-ui
6121 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
6122 (6 'force) (1 'async))))
6123 (if (memq option options) (remq option options)
6124 (cons option options)))
6125 first-key expertp))
6126 ;; Action selected: Send key and options back to
6127 ;; `org-export-dispatch'.
6128 ((or first-key (functionp (nth 2 (assq key entries))))
6129 (cons (cond
6130 ((not first-key) (nth 2 (assq key entries)))
6131 ;; Publishing actions are hard-coded. Send a special
6132 ;; signal to `org-export-dispatch'.
6133 ((eq first-key ?P)
6134 (case key
6135 (?f 'publish-current-file)
6136 (?p 'publish-current-project)
6137 (?x 'publish-choose-project)
6138 (?a 'publish-all)))
6139 ;; Return first action associated to FIRST-KEY + KEY
6140 ;; path. Indeed, derived backends can share the same
6141 ;; FIRST-KEY.
6142 (t (catch 'found
6143 (mapc (lambda (entry)
6144 (let ((match (assq key (nth 2 entry))))
6145 (when match (throw 'found (nth 2 match)))))
6146 (member (assq first-key entries) entries)))))
6147 options))
6148 ;; Otherwise, enter sub-menu.
6149 (t (org-export--dispatch-ui options key expertp)))))
6153 (provide 'ox)
6155 ;; Local variables:
6156 ;; generated-autoload-file: "org-loaddefs.el"
6157 ;; End:
6159 ;;; ox.el ends here