| blob | f87ab3ec198661dc91e5cb5e113a377756c0c378 |
1 ;;; org-export.el --- Generic Export Engine For Org
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program 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 ;; This program 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 this program. 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 ;; which sets one mandatory variable: his translation table. Its name
52 ;; is always `org-BACKEND-translate-alist' where BACKEND stands for
53 ;; the name chosen for the back-end. Its value is an alist whose keys
54 ;; are elements and objects types and values translator functions.
55 ;; See function's docstring for more information about translators.
56 ;;
57 ;; Optionally, `org-export-define-backend' can also support specific
58 ;; buffer keywords, OPTION keyword's items and filters. Also refer to
59 ;; function documentation for more information.
60 ;;
61 ;; If the new back-end shares most properties with another one,
62 ;; `org-export-define-derived-backend' can be used to simplify the
63 ;; process.
64 ;;
65 ;; Any back-end can define its own variables. Among them, those
66 ;; customizable should belong to the `org-export-BACKEND' group.
67 ;;
68 ;; Tools for common tasks across back-ends are implemented in the
69 ;; penultimate part of this file. A dispatcher for standard back-ends
70 ;; is provided in the last one.
72 ;;; Code:
89 \f
90 ;;; Internal Variables
91 ;;
92 ;; Among internal variables, the most important is
93 ;; `org-export-options-alist'. This variable define the global export
94 ;; options, shared between every exporter, and how they are acquired.
138 "Alist between export properties and ways to set them.
140 The CAR of the alist is the property name, and the CDR is a list
141 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
143 KEYWORD is a string representing a buffer keyword, or nil. Each
144 property defined this way can also be set, during subtree
145 export, through an headline property named after the keyword
147 property).
148 OPTION is a string that could be found in an #+OPTIONS: line.
149 DEFAULT is the default value for the property.
150 BEHAVIOUR determine how Org should handle multiple keywords for
151 the same property. It is a symbol among:
152 nil Keep old value and discard the new one.
153 t Replace old value with the new one.
154 `space' Concatenate the values, separating them with a space.
155 `newline' Concatenate the values, separating them with
156 a newline.
157 `split' Split values at white spaces, and cons them to the
158 previous list.
160 KEYWORD and OPTION have precedence over DEFAULT.
162 All these properties should be back-end agnostic. Back-end
163 specific properties are set through `org-export-define-backend'.
167 "List of in-buffer keywords that require special treatment.
168 These keywords are not directly associated to a property. The
169 way they are handled must be hard-coded into
229 "Alist between filters properties and initial values.
231 The key of each association is a property name accessible through
232 the communication channel. Its value is a configurable global
233 variable defining initial filters.
235 This list is meant to install user specified filters. Back-end
236 developers may install their own filters using
237 `org-export-define-backend'. Filters defined there will always
238 be prepended to the current list, so they always get applied
247 "Default rule for link matching an inline image.
248 This rule applies to links with no description. By default, it
249 will be considered as an inline image if it targets a local file
252 See `org-export-inline-image-p' for more information about
256 \f
257 ;;; User-configurable Variables
258 ;;
259 ;; Configuration for the masses.
260 ;;
261 ;; They should never be accessed directly, as their value is to be
262 ;; stored in a property list (cf. `org-export-options-alist').
263 ;; Back-ends will read their value from there instead.
266 "Options for exporting Org mode files."
271 "General options for export engine."
276 "Whether sub-trees with the ARCHIVE tag should be exported.
278 This can have three different values:
279 nil Do not export, pretend this tree is not present.
280 t Do export the entire tree.
281 `headline' Only export the headline, but skip the tree below it.
283 This option can also be set with the #+OPTIONS line,
292 "Non-nil means insert author name into the exported file.
293 This option can also be set with the #+OPTIONS line,
299 "Non-nil means export CLOCK keywords.
300 This option can also be set with the #+OPTIONS line,
306 "Non-nil means the postamble should contain a creator sentence.
308 The sentence can be set in `org-export-creator-string' and
311 If the value is `comment' insert it as a comment."
319 "Non-nil means insert date in the exported document.
320 This options can also be set with the OPTIONS keyword,
326 emacs-version)
327 "String to insert at the end of the generated document."
332 "Non-nil means export contents of standard drawers.
334 When t, all drawers are exported. This may also be a list of
335 drawer names to export. This variable doesn't apply to
336 properties drawers.
338 This option can also be set with the #+OPTIONS line,
348 "Non-nil means insert author email into the exported file.
349 This option can also be set with the #+OPTIONS line,
355 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
357 If the export target supports emphasizing text, the word will be
358 typeset in bold, italic, or underlined, respectively. Not all
359 export backends support this.
366 "Tags that exclude a tree from export.
368 All trees carrying any of these tags will be excluded from
369 export. This is without condition, so even subtrees inside that
370 carry one of the `org-export-select-tags' will be removed.
372 This option can also be set with the #+EXCLUDE_TAGS: keyword."
379 This can be used to have pre-formatted text, fragments of code
380 etc. For example:
381 : ;; Some Lisp examples
382 : (while (defc cnt)
383 : (ding))
384 will be looking just like this in also HTML. See also the QUOTE
385 keyword. Not all export backends support this.
392 "Non-nil means Org footnotes should be exported.
393 This option can also be set with the #+OPTIONS line,
399 "The last level which is still exported as a headline.
401 Inferior levels will produce itemize lists when exported.
408 "The default language for export and clocktable translations, as a string.
409 This may have an association in
410 `org-clock-clocktable-language-setup'."
415 "Non-nil means preserve all line breaks when exporting.
417 Normally, in HTML output paragraphs will be reformatted.
419 This option can also be set with the #+OPTIONS line,
425 "Non-nil means interpret entities when exporting.
428 Å.
430 For a list of supported names, see the constant `org-entities'
431 and the user option `org-entities-user'.
433 This option can also be set with the #+OPTIONS line,
439 "Non-nil means inlinetasks should be exported.
440 This option can also be set with the #+OPTIONS line,
446 "Non-nil means include planning info in export.
447 This option can also be set with the #+OPTIONS: line,
453 "Non-nil means include priority cookies in export.
454 This option can also be set with the #+OPTIONS line,
460 "Non-nil means add section numbers to headlines when exporting.
462 When set to an integer n, numbering will only happen for
463 headlines whose relative level is higher or equal to n.
465 This option can also be set with the #+OPTIONS line,
471 "Tags that select a tree for export.
473 If any such tag is found in a buffer, all trees that do not carry
474 one of these tags will be ignored during export. Inside trees
475 that are selected like this, you can still deselect a subtree by
476 tagging it with one of the `org-export-exclude-tags'.
478 This option can also be set with the #+SELECT_TAGS: keyword."
483 "Non-nil means activate smart quotes during export.
484 This option can also be set with the #+OPTIONS: line,
492 When this option is turned on, these strings will be exported as:
494 Org HTML LaTeX UTF-8
495 -----+----------+--------+-------
497 -- – -- –
498 --- — --- —
501 This option can also be set with the #+OPTIONS line,
507 "Non-nil means include statistics cookies in export.
508 This option can also be set with the #+OPTIONS: line,
516 When this option is turned on, you can use TeX-like syntax for
518 will be considered as a single item - so grouping with {} is
519 normally not needed. For example, the following things will be
520 parsed as single sub- or superscripts.
522 10^24 or 10^tau several digits will be considered 1 item.
523 10^-12 or 10^-tau a leading sign with digits or a word
524 x^2-y^3 will be read as x^2 - y^3, because items are
525 terminated by almost any nonword/nondigit char.
526 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
528 Still, ambiguity is possible - so when in doubt use {} to enclose
529 the sub/superscript. If you set this variable to the symbol
530 `{}', the braces are *required* in order to trigger
531 interpretations as sub/superscript. This can be helpful in
534 This option can also be set with the #+OPTIONS line,
543 "Non-nil means create a table of contents in exported files.
545 The TOC contains headlines with levels up
546 to`org-export-headline-levels'. When an integer, include levels
547 up to N in the toc, this may then be different from
548 `org-export-headline-levels', but it will not be allowed to be
549 larger than the number of headline levels. When nil, no table of
550 contents is made.
552 This option can also be set with the #+OPTIONS line,
562 For example:
564 | Name | Address | Birthday |
565 |-------------+----------+-----------|
566 | Arthur Dent | England | 29.2.2100 |
573 "If nil, do not export tags, just remove them from headlines.
575 If this is the symbol `not-in-toc', tags will be removed from
576 table of contents entries, but still be shown in the headlines of
577 the document.
579 This option can also be set with the #+OPTIONS line,
588 "Non-nil means include TODO items for export.
590 This may have the following values:
591 t include tasks independent of state.
592 `todo' include only tasks that are not yet done.
593 `done' include only tasks that are already done.
594 nil ignore all tasks.
595 list of keywords include tasks with these keywords.
597 This option can also be set with the #+OPTIONS line,
609 "Non-nil means insert a time stamp into the exported file.
610 The time stamp shows when the file was created.
612 This option can also be set with the #+OPTIONS line,
618 "Non nil means allow timestamps in export.
620 It can be set to `active', `inactive', t or nil, in order to
621 export, respectively, only active timestamps, only inactive ones,
622 all of them or none.
624 This option can also be set with the #+OPTIONS line, e.g.
634 "Non-nil means include TODO keywords in export.
635 When nil, remove all these keywords from the export."
640 "Non-nil means allow #+BIND to define local variable values for export.
641 This is a potential security risk, which is why the user must
642 confirm the use of these lines."
650 "Alist between export snippets back-ends and exporter back-ends.
652 This variable allows to provide shortcuts for export snippets.
656 HTML code while every other back-end will ignore it."
664 "Coding system for the exported file."
669 "Non-nil means exported stuff will also be pushed onto the kill ring."
674 "The initial scope when exporting with `org-export-dispatch'.
675 This variable can be either set to `buffer' or `subtree'."
682 "Non-nil means show buffer after exporting to temp buffer.
683 When Org exports to a file, the buffer visiting that file is ever
684 shown, but remains buried. However, when exporting to
685 a temporary buffer, that buffer is popped up in a second window.
686 When this variable is nil, the buffer remains buried also in
687 these cases."
692 "Non-nil means using a non-intrusive `org-export-dispatch'.
693 In that case, no help buffer is displayed. Though, an indicator
698 be passed the FORCE argument). Also, \[?] allows to switch back
699 to standard mode."
704 \f
705 ;;; Defining New Back-ends
706 ;;
707 ;; `org-export-define-backend' is the standard way to define an export
708 ;; back-end. It allows to specify translators, filters, buffer
709 ;; options and a menu entry. If the new back-end shares translators
710 ;; with another back-end, `org-export-define-derived-backend' may be
711 ;; used instead.
712 ;;
713 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
714 ;; when a given back-end hasn't been registered yet.
717 "Define a new back-end BACKEND.
719 TRANSLATORS is an alist between object or element types and
720 functions handling them.
722 These functions should return a string without any trailing
723 space, or nil. They must accept three arguments: the object or
724 element itself, its contents or nil when it isn't recursive and
725 the property list used as a communication channel.
727 Contents, when not nil, are stripped from any global indentation
728 \(although the relative one is preserved). They also always end
729 with a single newline character.
731 If, for a given type, no function is found, that element or
732 object type will simply be ignored, along with any blank line or
733 white space at its end. The same will happen if the function
734 returns the nil value. If that function returns the empty
735 string, the type will be ignored, but the blank lines or white
736 spaces will be kept.
738 In addition to element and object types, one function can be
739 associated to the `template' symbol and another one to the
740 `plain-text' symbol.
742 The former returns the final transcoded string, and can be used
743 to add a preamble and a postamble to document's body. It must
744 accept two arguments: the transcoded string and the property list
745 containing export options.
747 The latter, when defined, is to be called on every text not
748 recognized as an element or an object. It must accept two
749 arguments: the text string and the information channel. It is an
750 appropriate place to protect special chars relative to the
751 back-end.
753 BODY can start with pre-defined keyword arguments. The following
754 keywords are understood:
756 :export-block
758 String, or list of strings, representing block names that
759 will not be parsed. This is used to specify blocks that will
760 contain raw code specific to the back-end. These blocks
761 still have to be handled by the relative `export-block' type
762 translator.
764 :filters-alist
766 Alist between filters and function, or list of functions,
767 specific to the back-end. See `org-export-filters-alist' for
768 a list of all allowed filters. Filters defined here
769 shouldn't make a back-end test, as it may prevent back-ends
770 derived from this one to behave properly.
772 :menu-entry
774 Menu entry for the export dispatcher. It should be a list
775 like:
777 \(KEY DESCRIPTION ACTION-OR-MENU)
779 where :
781 KEY is a free character selecting the back-end.
782 DESCRIPTION is a string naming the back-end.
783 ACTION-OR-MENU is either a function or an alist.
785 If it is an action, it will be called with three arguments:
786 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
787 for further explanations.
789 If it is an alist, associations should follow the
790 pattern:
792 \(KEY DESCRIPTION ACTION)
794 where KEY, DESCRIPTION and ACTION are described above.
796 Valid values include:
800 or
807 \(lambda (subtree visible body-only)
808 \(org-open-file
809 \(org-e-latex-export-to-pdf subtree visible body-only))))))
811 :options-alist
813 Alist between back-end specific properties introduced in
814 communication channel and how their value are acquired. See
815 `org-export-options-alist' for more information about
816 structure of the values."
831 ;; Define translators.
834 ;; Define options.
838 See `org-export-options-alist' for more information on the
839 structure of the values."
840 backend)))
841 ;; Define filters.
844 "Alist between filters keywords and back-end specific filters.
846 ;; Tell parser to not parse EXPORT-BLOCK blocks.
853 ;; Add an entry for back-end in `org-export-dispatch'.
857 ;; Splice in the body, if any.
861 "Create a new back-end as a variant of an existing one.
863 CHILD is the name of the derived back-end. PARENT is the name of
864 the parent back-end.
866 BODY can start with pre-defined keyword arguments. The following
867 keywords are understood:
869 :export-block
871 String, or list of strings, representing block names that
872 will not be parsed. This is used to specify blocks that will
873 contain raw code specific to the back-end. These blocks
874 still have to be handled by the relative `export-block' type
875 translator.
877 :filters-alist
879 Alist of filters that will overwrite or complete filters
880 defined in PARENT back-end. See `org-export-filters-alist'
881 for a list of allowed filters.
883 :menu-entry
885 Menu entry for the export dispatcher. See
886 `org-export-define-backend' for more information about the
887 expected value.
889 :options-alist
891 Alist of back-end specific properties that will overwrite or
892 complete those defined in PARENT back-end. Refer to
893 `org-export-options-alist' for more information about
894 structure of the values.
896 :sub-menu-entry
898 Append entries to an existing menu in the export dispatcher.
899 The associated value should be a list whose CAR is the
900 character selecting the menu to expand and CDR a list of
901 entries following the pattern:
903 \(KEY DESCRIPTION ACTION)
905 where KEY is a free character triggering the action,
906 DESCRIPTION is a string defining the action, and ACTION is
907 a function that will be called with three arguments:
908 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
909 for further explanations.
911 Valid values include:
915 \(lambda (s v b)
916 \(org-open-file (org-e-beamer-export-to-pdf s v b)))))
918 :translate-alist
920 Alist of element and object types and transcoders that will
921 overwrite or complete transcode table from PARENT back-end.
922 Refer to `org-export-define-backend' for detailed information
923 about transcoders.
926 as a variant of `e-latex' back-end with a custom template
927 function:
929 \(org-export-define-derived-backend my-latex e-latex
930 :translate-alist ((template . my-latex-template-fun)))
932 The back-end could then be called with, for example:
951 ;; Tell parser to not parse EXPORT-BLOCK blocks.
958 ;; Define filters.
965 "Alist between filters keywords and back-end specific filters.
967 ;; Define options.
975 See `org-export-options-alist' for more information on the
976 structure of the values."
977 child))))
978 ;; Define translators.
985 ;; Add an entry for back-end in `org-export-dispatch'.
991 org-export-dispatch-menu-entries))))
995 ;; Splice in the body, if any.
999 "Signal an error if BACKEND isn't defined."
1004 \f
1005 ;;; The Communication Channel
1006 ;;
1007 ;; During export process, every function has access to a number of
1008 ;; properties. They are of two types:
1009 ;;
1010 ;; 1. Environment options are collected once at the very beginning of
1011 ;; the process, out of the original buffer and configuration.
1012 ;; Collecting them is handled by `org-export-get-environment'
1013 ;; function.
1014 ;;
1015 ;; Most environment options are defined through the
1016 ;; `org-export-options-alist' variable.
1017 ;;
1018 ;; 2. Tree properties are extracted directly from the parsed tree,
1019 ;; just before export, by `org-export-collect-tree-properties'.
1020 ;;
1021 ;; Here is the full list of properties available during transcode
1022 ;; process, with their category and their value type.
1023 ;;
1024 ;; + `:author' :: Author's name.
1025 ;; - category :: option
1026 ;; - type :: string
1027 ;;
1028 ;; + `:back-end' :: Current back-end used for transcoding.
1029 ;; - category :: tree
1030 ;; - type :: symbol
1031 ;;
1032 ;; + `:creator' :: String to write as creation information.
1033 ;; - category :: option
1034 ;; - type :: string
1035 ;;
1036 ;; + `:date' :: String to use as date.
1037 ;; - category :: option
1038 ;; - type :: string
1039 ;;
1040 ;; + `:description' :: Description text for the current data.
1041 ;; - category :: option
1042 ;; - type :: string
1043 ;;
1044 ;; + `:email' :: Author's email.
1045 ;; - category :: option
1046 ;; - type :: string
1047 ;;
1048 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1049 ;; process.
1050 ;; - category :: option
1051 ;; - type :: list of strings
1052 ;;
1053 ;; + `:exported-data' :: Hash table used for memoizing
1054 ;; `org-export-data'.
1055 ;; - category :: tree
1056 ;; - type :: hash table
1057 ;;
1058 ;; + `:filetags' :: List of global tags for buffer. Used by
1059 ;; `org-export-get-tags' to get tags with inheritance.
1060 ;; - category :: option
1061 ;; - type :: list of strings
1062 ;;
1063 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1064 ;; their definition, as parsed data. Only non-inlined footnotes
1065 ;; are represented in this alist. Also, every definition isn't
1066 ;; guaranteed to be referenced in the parse tree. The purpose of
1067 ;; this property is to preserve definitions from oblivion
1068 ;; (i.e. when the parse tree comes from a part of the original
1069 ;; buffer), it isn't meant for direct use in a back-end. To
1070 ;; retrieve a definition relative to a reference, use
1071 ;; `org-export-get-footnote-definition' instead.
1072 ;; - category :: option
1073 ;; - type :: alist (STRING . LIST)
1074 ;;
1075 ;; + `:headline-levels' :: Maximum level being exported as an
1076 ;; headline. Comparison is done with the relative level of
1077 ;; headlines in the parse tree, not necessarily with their
1078 ;; actual level.
1079 ;; - category :: option
1080 ;; - type :: integer
1081 ;;
1082 ;; + `:headline-offset' :: Difference between relative and real level
1083 ;; of headlines in the parse tree. For example, a value of -1
1084 ;; means a level 2 headline should be considered as level
1085 ;; 1 (cf. `org-export-get-relative-level').
1086 ;; - category :: tree
1087 ;; - type :: integer
1088 ;;
1089 ;; + `:headline-numbering' :: Alist between headlines and their
1090 ;; numbering, as a list of numbers
1091 ;; (cf. `org-export-get-headline-number').
1092 ;; - category :: tree
1093 ;; - type :: alist (INTEGER . LIST)
1094 ;;
1095 ;; + `:id-alist' :: Alist between ID strings and destination file's
1096 ;; path, relative to current directory. It is used by
1097 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1098 ;; external file.
1099 ;; - category :: option
1100 ;; - type :: alist (STRING . STRING)
1101 ;;
1102 ;; + `:ignore-list' :: List of elements and objects that should be
1103 ;; ignored during export.
1104 ;; - category :: tree
1105 ;; - type :: list of elements and objects
1106 ;;
1107 ;; + `:input-file' :: Full path to input file, if any.
1108 ;; - category :: option
1109 ;; - type :: string or nil
1110 ;;
1111 ;; + `:keywords' :: List of keywords attached to data.
1112 ;; - category :: option
1113 ;; - type :: string
1114 ;;
1115 ;; + `:language' :: Default language used for translations.
1116 ;; - category :: option
1117 ;; - type :: string
1118 ;;
1119 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1120 ;; transcoding.
1121 ;; - category :: option
1122 ;; - type :: list (as returned by `org-element-parse-buffer')
1123 ;;
1124 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1125 ;; all line breaks.
1126 ;; - category :: option
1127 ;; - type :: symbol (nil, t)
1128 ;;
1129 ;; + `:section-numbers' :: Non-nil means transcoding should add
1130 ;; section numbers to headlines.
1131 ;; - category :: option
1132 ;; - type :: symbol (nil, t)
1133 ;;
1134 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1135 ;; in transcoding. When such a tag is present, subtrees without
1136 ;; it are de facto excluded from the process. See
1137 ;; `use-select-tags'.
1138 ;; - category :: option
1139 ;; - type :: list of strings
1140 ;;
1141 ;; + `:target-list' :: List of targets encountered in the parse tree.
1142 ;; This is used to partly resolve "fuzzy" links
1143 ;; (cf. `org-export-resolve-fuzzy-link').
1144 ;; - category :: tree
1145 ;; - type :: list of strings
1146 ;;
1147 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1148 ;; a time stamp in the output.
1149 ;; - category :: option
1150 ;; - type :: symbol (nil, t)
1151 ;;
1152 ;; + `:translate-alist' :: Alist between element and object types and
1153 ;; transcoding functions relative to the current back-end.
1154 ;; Special keys `template' and `plain-text' are also possible.
1155 ;; - category :: option
1156 ;; - type :: alist (SYMBOL . FUNCTION)
1157 ;;
1158 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1159 ;; also be transcoded. If it is set to the `headline' symbol,
1160 ;; only the archived headline's name is retained.
1161 ;; - category :: option
1162 ;; - type :: symbol (nil, t, `headline')
1163 ;;
1164 ;; + `:with-author' :: Non-nil means author's name should be included
1165 ;; in the output.
1166 ;; - category :: option
1167 ;; - type :: symbol (nil, t)
1168 ;;
1169 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1170 ;; - category :: option
1171 ;; - type :: symbol (nil, t)
1172 ;;
1173 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1174 ;; inserted at the end of the transcoded string. If the value
1175 ;; is `comment', it should be commented.
1176 ;; - category :: option
1177 ;; - type :: symbol (`comment', nil, t)
1178 ;;
1179 ;; + `:with-date' :: Non-nil means output should contain a date.
1180 ;; - category :: option
1181 ;; - type :. symbol (nil, t)
1182 ;;
1183 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1184 ;; its value is a list of names, only drawers with such names
1185 ;; will be transcoded.
1186 ;; - category :: option
1187 ;; - type :: symbol (nil, t) or list of strings
1188 ;;
1189 ;; + `:with-email' :: Non-nil means output should contain author's
1190 ;; email.
1191 ;; - category :: option
1192 ;; - type :: symbol (nil, t)
1193 ;;
1194 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1195 ;; interpreted.
1196 ;; - category :: option
1197 ;; - type :: symbol (nil, t)
1198 ;;
1199 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1200 ;; strings starting with a colon as a fixed-with (verbatim) area.
1201 ;; - category :: option
1202 ;; - type :: symbol (nil, t)
1203 ;;
1204 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1205 ;; footnotes.
1206 ;; - category :: option
1207 ;; - type :: symbol (nil, t)
1208 ;;
1209 ;; + `:with-plannings' :: Non-nil means transcoding should include
1210 ;; planning info.
1211 ;; - category :: option
1212 ;; - type :: symbol (nil, t)
1213 ;;
1214 ;; + `:with-priority' :: Non-nil means transcoding should include
1215 ;; priority cookies.
1216 ;; - category :: option
1217 ;; - type :: symbol (nil, t)
1218 ;;
1219 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1220 ;; plain text.
1221 ;; - category :: option
1222 ;; - type :: symbol (nil, t)
1223 ;;
1224 ;; + `:with-special-strings' :: Non-nil means transcoding should
1225 ;; interpret special strings in plain text.
1226 ;; - category :: option
1227 ;; - type :: symbol (nil, t)
1228 ;;
1229 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1230 ;; interpret subscript and superscript. With a value of "{}",
1231 ;; only interpret those using curly brackets.
1232 ;; - category :: option
1233 ;; - type :: symbol (nil, {}, t)
1234 ;;
1235 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1236 ;; tables.
1237 ;; - category :: option
1238 ;; - type :: symbol (nil, t)
1239 ;;
1240 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1241 ;; headlines. A `not-in-toc' value will remove them from the
1242 ;; table of contents, if any, nonetheless.
1243 ;; - category :: option
1244 ;; - type :: symbol (nil, t, `not-in-toc')
1245 ;;
1246 ;; + `:with-tasks' :: Non-nil means transcoding should include
1247 ;; headlines with a TODO keyword. A `todo' value will only
1248 ;; include headlines with a todo type keyword while a `done'
1249 ;; value will do the contrary. If a list of strings is provided,
1250 ;; only tasks with keywords belonging to that list will be kept.
1251 ;; - category :: option
1252 ;; - type :: symbol (t, todo, done, nil) or list of strings
1253 ;;
1254 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1255 ;; time stamps. Special value `active' (resp. `inactive') ask to
1256 ;; export only active (resp. inactive) timestamps. Otherwise,
1257 ;; completely remove them.
1258 ;; - category :: option
1259 ;; - type :: symbol: (`active', `inactive', t, nil)
1260 ;;
1261 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1262 ;; added to the output. An integer value limits its depth.
1263 ;; - category :: option
1264 ;; - type :: symbol (nil, t or integer)
1265 ;;
1266 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1267 ;; include TODO keywords.
1268 ;; - category :: option
1269 ;; - type :: symbol (nil, t)
1272 ;;;; Environment Options
1273 ;;
1274 ;; Environment options encompass all parameters defined outside the
1275 ;; scope of the parsed data. They come from five sources, in
1276 ;; increasing precedence order:
1277 ;;
1278 ;; - Global variables,
1279 ;; - Buffer's attributes,
1280 ;; - Options keyword symbols,
1281 ;; - Buffer keywords,
1282 ;; - Subtree properties.
1283 ;;
1284 ;; The central internal function with regards to environment options
1285 ;; is `org-export-get-environment'. It updates global variables with
1286 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1287 ;; the different sources.
1288 ;;
1289 ;; The internal functions doing the retrieval are:
1290 ;; `org-export--get-global-options',
1291 ;; `org-export--get-buffer-attributes',
1292 ;; `org-export--parse-option-keyword',
1293 ;; `org-export--get-subtree-options' and
1294 ;; `org-export--get-inbuffer-options'
1295 ;;
1296 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1297 ;; take care of the part relative to "#+BIND:" keywords.
1300 "Collect export options from the current buffer.
1302 Optional argument BACKEND is a symbol specifying which back-end
1303 specific options to read, if any.
1305 When optional argument SUBTREEP is non-nil, assume the export is
1306 done against the current sub-tree.
1308 Third optional argument EXT-PLIST is a property list with
1309 external parameters overriding Org default settings, but still
1310 inferior to file-local settings."
1311 ;; First install #+BIND variables.
1313 ;; Get and prioritize export options...
1315 ;; ... from global variables...
1317 ;; ... from an external property list...
1318 ext-plist
1319 ;; ... from in-buffer settings...
1321 backend
1323 ;; ... and from subtree, when appropriate.
1325 ;; Eventually add misc. properties.
1327 :back-end
1328 backend
1329 :translate-alist
1332 :footnote-definition-alist
1333 ;; Footnotes definitions must be collected in the original
1334 ;; buffer, as there's no insurance that they will still be in
1335 ;; the parse tree, due to possible narrowing.
1349 alist))))
1350 alist))
1351 :id-alist
1352 ;; Collect id references.
1363 alist))))
1366 "Parse an OPTIONS line and return values as a plist.
1367 Optional argument BACKEND is a symbol specifying which back-end
1368 specific items to read, if any."
1375 ;; Build an alist between #+OPTION: item and property-name.
1380 all)))
1381 plist)
1386 options)
1391 alist)
1392 plist))
1395 "Get export options in subtree at point.
1396 Optional argument BACKEND is a symbol specifying back-end used
1397 for export. Return options as a plist."
1398 ;; For each buffer keyword, create an headline property setting the
1399 ;; same property in communication channel. The name for the property
1400 ;; is the keyword with "EXPORT_" appended to it.
1403 ;; Make sure point is at an heading.
1405 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1406 ;; title as its fallback value.
1413 plist :title
1416 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1420 ;; Handle other keywords. TITLE keyword is excluded as it has
1421 ;; been handled already.
1428 ;; Export properties are not case-sensitive.
1435 plist
1437 ;; Parse VALUE if required.
1441 value))))))))
1442 ;; Also look for both general keywords and back-end specific
1443 ;; options if BACKEND is provided.
1448 org-export-options-alist)))
1449 ;; Return value.
1450 plist)))
1453 "Return current buffer export options, as a plist.
1455 Optional argument BACKEND, when non-nil, is a symbol specifying
1456 which back-end specific options should also be read in the
1457 process.
1459 Optional argument FILES is a list of setup files names read so
1460 far, used to avoid circular dependencies.
1462 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1466 ;; 1. Special keywords, as in `org-export-special-keywords'.
1480 ;; Avoid circular dependencies.
1495 ;; 2. Standard options, as in `org-export-options-alist'.
1497 ;; Also look for back-end specific options
1498 ;; if BACKEND is defined.
1504 ;; Build ALIST between keyword name and property name.
1508 all)))
1509 ;; Build regexp matching all keywords associated to export
1510 ;; options. Note: the search is case insensitive.
1524 plist prop
1525 ;; Handle value depending on specified BEHAVIOUR.
1538 ;; Parse keywords specified in
1539 ;; `org-element-document-properties'.
1547 plist prop
1550 org-element-document-properties))
1551 ;; 3. Return final value.
1552 plist)))
1555 "Return properties related to buffer attributes, as a plist."
1558 ;; Store full path of input file name, or nil. For internal use.
1559 :input-file visited-file
1566 "Return global export options as a plist.
1568 Optional argument BACKEND, if non-nil, is a symbol specifying
1569 which back-end specific export options should also be read in the
1570 process."
1576 ;; Output value.
1577 plist)
1582 plist
1584 ;; Eval default value provided. If keyword is a member
1585 ;; of `org-element-document-properties', parse it as
1586 ;; a secondary string before storing it.
1591 value
1594 all)
1595 ;; Return value.
1596 plist))
1600 "Can we use #+BIND values during export?
1601 By default this will ask for confirmation by the user, to divert
1602 possible security risks."
1607 org-export--allow-BIND-local)
1612 "Install the values from #+BIND lines as local variables.
1613 Variables must be installed before in-buffer options are
1614 retrieved."
1629 ;;;; Tree Properties
1630 ;;
1631 ;; Tree properties are information extracted from parse tree. They
1632 ;; are initialized at the beginning of the transcoding process by
1633 ;; `org-export-collect-tree-properties'.
1634 ;;
1635 ;; Dedicated functions focus on computing the value of specific tree
1636 ;; properties during initialization. Thus,
1637 ;; `org-export--populate-ignore-list' lists elements and objects that
1638 ;; should be skipped during export, `org-export--get-min-level' gets
1639 ;; the minimal exportable level, used as a basis to compute relative
1640 ;; level for headlines. Eventually
1641 ;; `org-export--collect-headline-numbering' builds an alist between
1642 ;; headlines and their numbering.
1645 "Extract tree properties from parse tree.
1647 DATA is the parse tree from which information is retrieved. INFO
1648 is a list holding export options.
1650 Following tree properties are set or updated:
1652 `:exported-data' Hash table used to memoize results from
1653 `org-export-data'.
1655 `:footnote-definition-alist' List of footnotes definitions in
1656 original buffer and current parse tree.
1658 `:headline-offset' Offset between true level of headlines and
1659 local level. An offset of -1 means an headline
1660 of level 2 should be considered as a level
1661 1 headline in the context.
1663 `:headline-numbering' Alist of all headlines as key an the
1664 associated numbering as value.
1666 `:ignore-list' List of elements that should be ignored during
1667 export.
1669 `:target-list' List of all targets in the parse tree.
1671 Return updated plist."
1672 ;; Install the parse tree in the communication channel, in order to
1673 ;; use `org-export-get-genealogy' and al.
1675 ;; Get the list of elements and objects to ignore, and put it into
1676 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1677 ;; been done during parse tree filtering.
1680 :ignore-list
1683 ;; Compute `:headline-offset' in order to be able to use
1684 ;; `org-export-get-relative-level'.
1687 :headline-offset
1689 ;; Update footnotes definitions list with definitions in parse tree.
1690 ;; This is required since buffer expansion might have modified
1691 ;; boundaries of footnote definitions contained in the parse tree.
1692 ;; This way, definitions in `footnote-definition-alist' are bound to
1693 ;; match those in the parse tree.
1696 data 'footnote-definition
1700 defs)))
1702 ;; Properties order doesn't matter: get the rest of the tree
1703 ;; properties.
1705 `(:target-list
1714 info))
1717 "Return minimum exportable headline's level in DATA.
1718 DATA is parsed tree as returned by `org-element-parse-buffer'.
1719 OPTIONS is a plist holding export options."
1730 ;; If no headline was found, for the sake of consistency, set
1731 ;; minimum level to 1 nonetheless.
1735 "Return numbering of all exportable headlines in a parse tree.
1737 DATA is the parse tree. OPTIONS is the plist holding export
1738 options.
1740 Return an alist whose key is an headline and value is its
1741 associated numbering \(in the shape of a list of numbers\)."
1744 data
1745 'headline
1750 headline
1752 for idx from 0 to org-export-max-depth
1756 options)))
1759 "Return list of elements and objects to ignore during export.
1760 DATA is the parse tree to traverse. OPTIONS is the plist holding
1761 export options."
1763 walk-data
1764 ;; First find trees containing a select tag, if any.
1768 ;; Collect ignored elements or objects into IGNORE-LIST.
1774 ;; If headline is archived but tree below has
1775 ;; to be skipped, add it to ignore list.
1778 ;; Move into secondary string, if any.
1783 ;; Move into recursive objects/elements.
1785 ;; Main call.
1787 ;; Return value.
1788 ignore))
1791 "Return list of headlines containing a select tag in their tree.
1792 DATA is parsed data as returned by `org-element-parse-buffer'.
1793 INFO is a plist holding export options."
1795 walk-data ; for byte-compiler.
1806 ;; When a select tag is found, mark full
1807 ;; genealogy and every headline within the tree
1808 ;; as acceptable.
1811 genealogy
1813 selected-trees))
1814 ;; Else, continue searching in tree, recursively.
1821 "Non-nil when element or object BLOB should be skipped during export.
1822 OPTIONS is the plist holding export options. SELECTED, when
1823 non-nil, is a list of headlines belonging to a tree with a select
1824 tag."
1839 ;; Ignore subtrees with an exclude tag.
1842 ;; When a select tag is present in the buffer, ignore any tree
1843 ;; without it.
1845 ;; Ignore commented sub-trees.
1847 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1849 ;; Ignore tasks, if specified by `:with-tasks' property.
1865 ;; No timestamp allowed.
1867 ;; Only active timestamps allowed and the current one isn't
1868 ;; active.
1872 ;; Only inactive timestamps allowed and the current one isn't
1873 ;; inactive.
1879 \f
1880 ;;; The Transcoder
1881 ;;
1882 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1883 ;; `org-element-parse-buffer') and transcodes it into a specified
1884 ;; back-end output. It takes care of filtering out elements or
1885 ;; objects according to export options and organizing the output blank
1886 ;; lines and white space are preserved. The function memoizes its
1887 ;; results, so it is cheap to call it within translators.
1888 ;;
1889 ;; Internally, three functions handle the filtering of objects and
1890 ;; elements during the export. In particular,
1891 ;; `org-export-ignore-element' marks an element or object so future
1892 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1893 ;; elements or objects should be seen as real Org syntax and
1894 ;; `org-export-expand' transforms the others back into their original
1895 ;; shape
1896 ;;
1897 ;; `org-export-transcoder' is an accessor returning appropriate
1898 ;; translator function for a given element or object.
1901 "Return appropriate transcoder for BLOB.
1902 INFO is a plist containing export directives."
1904 ;; Return contents only for complete parse trees.
1910 "Convert DATA into current back-end format.
1912 DATA is a parse tree, an element or an object or a secondary
1913 string. INFO is a plist holding export options.
1915 Return transcoded string."
1921 ;; Ignored element/object.
1923 ;; Plain text. All residual text properties from parse
1924 ;; tree (i.e. `:parent' property) are removed.
1931 info)))
1932 ;; Uninterpreted element/object: change it back to Org
1933 ;; syntax and export again resulting raw string.
1937 data
1941 info))
1942 ;; Secondary string.
1945 ;; Element/Object without contents or, as a special case,
1946 ;; headline with archive tag and archived trees restricted
1947 ;; to title only.
1955 ;; Element/Object with contents.
1968 ;; Elements directly containing objects
1969 ;; must have their indentation normalized
1970 ;; first.
1972 data
1973 ;; When normalizing contents of the first
1974 ;; paragraph in an item or a footnote
1975 ;; definition, ignore first line's
1976 ;; indentation: there is none and it
1977 ;; might be misleading.
1982 data)
1989 info))))))))
1990 ;; Final result will be memoized before being returned.
1992 data
1996 ;; Append the same white space between elements or objects as in
1997 ;; the original buffer, and call appropriate filters.
2008 info)))
2009 results)))
2013 "Non-nil if element or object BLOB should be interpreted as Org syntax.
2014 Check is done according to export options INFO, stored as
2015 a plist."
2017 ;; ... entities...
2019 ;; ... emphasis...
2021 ;; ... fixed-width areas.
2023 ;; ... footnotes...
2026 ;; ... sub/superscripts...
2032 ;; ... tables...
2037 "Expand a parsed element or object to its original state.
2038 BLOB is either an element or an object. CONTENTS is its
2039 contents, as a string or nil."
2042 blob contents))
2045 "Add ELEMENT to `:ignore-list' in INFO.
2047 Any element in `:ignore-list' will be skipped when using
2048 `org-element-map'. INFO is modified by side effects."
2052 \f
2053 ;;; The Filter System
2054 ;;
2055 ;; Filters allow end-users to tweak easily the transcoded output.
2056 ;; They are the functional counterpart of hooks, as every filter in
2057 ;; a set is applied to the return value of the previous one.
2058 ;;
2059 ;; Every set is back-end agnostic. Although, a filter is always
2060 ;; called, in addition to the string it applies to, with the back-end
2061 ;; used as argument, so it's easy for the end-user to add back-end
2062 ;; specific filters in the set. The communication channel, as
2063 ;; a plist, is required as the third argument.
2064 ;;
2065 ;; From the developer side, filters sets can be installed in the
2066 ;; process with the help of `org-export-define-backend', which
2067 ;; internally sets `org-BACKEND-filters-alist' variable. Each
2068 ;; association has a key among the following symbols and a function or
2069 ;; a list of functions as value.
2070 ;;
2071 ;; - `:filter-parse-tree' applies directly on the complete parsed
2072 ;; tree. It's the only filters set that doesn't apply to a string.
2073 ;; Users can set it through `org-export-filter-parse-tree-functions'
2074 ;; variable.
2075 ;;
2076 ;; - `:filter-final-output' applies to the final transcoded string.
2077 ;; Users can set it with `org-export-filter-final-output-functions'
2078 ;; variable
2079 ;;
2080 ;; - `:filter-plain-text' applies to any string not recognized as Org
2081 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2082 ;; configure it.
2083 ;;
2084 ;; - `:filter-TYPE' applies on the string returned after an element or
2085 ;; object of type TYPE has been transcoded. An user can modify
2086 ;; `org-export-filter-TYPE-functions'
2087 ;;
2088 ;; All filters sets are applied with
2089 ;; `org-export-filter-apply-functions' function. Filters in a set are
2090 ;; applied in a LIFO fashion. It allows developers to be sure that
2091 ;; their filters will be applied first.
2092 ;;
2093 ;; Filters properties are installed in communication channel with
2094 ;; `org-export-install-filters' function.
2095 ;;
2096 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2097 ;; `org-export-before-parsing-hook') are run at the beginning of the
2098 ;; export process and just before parsing to allow for heavy structure
2099 ;; modifications.
2102 ;;;; Hooks
2105 "Hook run at the beginning of the export process.
2107 This is run before include keywords and macros are expanded and
2108 Babel code blocks executed, on a copy of the original buffer
2109 being exported. Visibility and narrowing are preserved. Point
2110 is at the beginning of the buffer.
2112 Every function in this hook will be called with one argument: the
2116 "Hook run before parsing an export buffer.
2118 This is run after include keywords and macros have been expanded
2119 and Babel code blocks executed, on a copy of the original buffer
2120 being exported. Visibility and narrowing are preserved. Point
2121 is at the beginning of the buffer.
2123 Every function in this hook will be called with one argument: the
2127 ;;;; Special Filters
2130 "List of functions applied to the parsed tree.
2131 Each filter is called with three arguments: the parse tree, as
2132 returned by `org-element-parse-buffer', the back-end, as
2133 a symbol, and the communication channel, as a plist. It must
2137 "List of functions applied to the transcoded string.
2138 Each filter is called with three arguments: the full transcoded
2139 string, the back-end, as a symbol, and the communication channel,
2140 as a plist. It must return a string that will be used as the
2144 "List of functions applied to plain text.
2145 Each filter is called with three arguments: a string which
2146 contains no Org syntax, the back-end, as a symbol, and the
2147 communication channel, as a plist. It must return a string or
2151 ;;;; Elements Filters
2154 "List of functions applied to a transcoded babel-call.
2155 Each filter is called with three arguments: the transcoded data,
2156 as a string, the back-end, as a symbol, and the communication
2160 "List of functions applied to a transcoded center block.
2161 Each filter is called with three arguments: the transcoded data,
2162 as a string, the back-end, as a symbol, and the communication
2166 "List of functions applied to a transcoded clock.
2167 Each filter is called with three arguments: the transcoded data,
2168 as a string, the back-end, as a symbol, and the communication
2172 "List of functions applied to a transcoded comment.
2173 Each filter is called with three arguments: the transcoded data,
2174 as a string, the back-end, as a symbol, and the communication
2178 "List of functions applied to a transcoded comment-block.
2179 Each filter is called with three arguments: the transcoded data,
2180 as a string, the back-end, as a symbol, and the communication
2184 "List of functions applied to a transcoded diary-sexp.
2185 Each filter is called with three arguments: the transcoded data,
2186 as a string, the back-end, as a symbol, and the communication
2190 "List of functions applied to a transcoded drawer.
2191 Each filter is called with three arguments: the transcoded data,
2192 as a string, the back-end, as a symbol, and the communication
2196 "List of functions applied to a transcoded dynamic-block.
2197 Each filter is called with three arguments: the transcoded data,
2198 as a string, the back-end, as a symbol, and the communication
2202 "List of functions applied to a transcoded example-block.
2203 Each filter is called with three arguments: the transcoded data,
2204 as a string, the back-end, as a symbol, and the communication
2208 "List of functions applied to a transcoded export-block.
2209 Each filter is called with three arguments: the transcoded data,
2210 as a string, the back-end, as a symbol, and the communication
2214 "List of functions applied to a transcoded fixed-width.
2215 Each filter is called with three arguments: the transcoded data,
2216 as a string, the back-end, as a symbol, and the communication
2220 "List of functions applied to a transcoded footnote-definition.
2221 Each filter is called with three arguments: the transcoded data,
2222 as a string, the back-end, as a symbol, and the communication
2226 "List of functions applied to a transcoded headline.
2227 Each filter is called with three arguments: the transcoded data,
2228 as a string, the back-end, as a symbol, and the communication
2232 "List of functions applied to a transcoded horizontal-rule.
2233 Each filter is called with three arguments: the transcoded data,
2234 as a string, the back-end, as a symbol, and the communication
2238 "List of functions applied to a transcoded inlinetask.
2239 Each filter is called with three arguments: the transcoded data,
2240 as a string, the back-end, as a symbol, and the communication
2244 "List of functions applied to a transcoded item.
2245 Each filter is called with three arguments: the transcoded data,
2246 as a string, the back-end, as a symbol, and the communication
2250 "List of functions applied to a transcoded keyword.
2251 Each filter is called with three arguments: the transcoded data,
2252 as a string, the back-end, as a symbol, and the communication
2256 "List of functions applied to a transcoded latex-environment.
2257 Each filter is called with three arguments: the transcoded data,
2258 as a string, the back-end, as a symbol, and the communication
2262 "List of functions applied to a transcoded node-property.
2263 Each filter is called with three arguments: the transcoded data,
2264 as a string, the back-end, as a symbol, and the communication
2268 "List of functions applied to a transcoded paragraph.
2269 Each filter is called with three arguments: the transcoded data,
2270 as a string, the back-end, as a symbol, and the communication
2274 "List of functions applied to a transcoded plain-list.
2275 Each filter is called with three arguments: the transcoded data,
2276 as a string, the back-end, as a symbol, and the communication
2280 "List of functions applied to a transcoded planning.
2281 Each filter is called with three arguments: the transcoded data,
2282 as a string, the back-end, as a symbol, and the communication
2286 "List of functions applied to a transcoded property-drawer.
2287 Each filter is called with three arguments: the transcoded data,
2288 as a string, the back-end, as a symbol, and the communication
2292 "List of functions applied to a transcoded quote block.
2293 Each filter is called with three arguments: the transcoded quote
2294 data, as a string, the back-end, as a symbol, and the
2295 communication channel, as a plist. It must return a string or
2299 "List of functions applied to a transcoded quote-section.
2300 Each filter is called with three arguments: the transcoded data,
2301 as a string, the back-end, as a symbol, and the communication
2305 "List of functions applied to a transcoded section.
2306 Each filter is called with three arguments: the transcoded data,
2307 as a string, the back-end, as a symbol, and the communication
2311 "List of functions applied to a transcoded special block.
2312 Each filter is called with three arguments: the transcoded data,
2313 as a string, the back-end, as a symbol, and the communication
2317 "List of functions applied to a transcoded src-block.
2318 Each filter is called with three arguments: the transcoded data,
2319 as a string, the back-end, as a symbol, and the communication
2323 "List of functions applied to a transcoded table.
2324 Each filter is called with three arguments: the transcoded data,
2325 as a string, the back-end, as a symbol, and the communication
2329 "List of functions applied to a transcoded table-cell.
2330 Each filter is called with three arguments: the transcoded data,
2331 as a string, the back-end, as a symbol, and the communication
2335 "List of functions applied to a transcoded table-row.
2336 Each filter is called with three arguments: the transcoded data,
2337 as a string, the back-end, as a symbol, and the communication
2341 "List of functions applied to a transcoded verse block.
2342 Each filter is called with three arguments: the transcoded data,
2343 as a string, the back-end, as a symbol, and the communication
2347 ;;;; Objects Filters
2350 "List of functions applied to transcoded bold text.
2351 Each filter is called with three arguments: the transcoded data,
2352 as a string, the back-end, as a symbol, and the communication
2356 "List of functions applied to transcoded code text.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 "List of functions applied to a transcoded entity.
2363 Each filter is called with three arguments: the transcoded data,
2364 as a string, the back-end, as a symbol, and the communication
2368 "List of functions applied to a transcoded export-snippet.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded footnote-reference.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 "List of functions applied to a transcoded inline-babel-call.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to a transcoded inline-src-block.
2387 Each filter is called with three arguments: the transcoded data,
2388 as a string, the back-end, as a symbol, and the communication
2392 "List of functions applied to transcoded italic text.
2393 Each filter is called with three arguments: the transcoded data,
2394 as a string, the back-end, as a symbol, and the communication
2398 "List of functions applied to a transcoded latex-fragment.
2399 Each filter is called with three arguments: the transcoded data,
2400 as a string, the back-end, as a symbol, and the communication
2404 "List of functions applied to a transcoded line-break.
2405 Each filter is called with three arguments: the transcoded data,
2406 as a string, the back-end, as a symbol, and the communication
2410 "List of functions applied to a transcoded link.
2411 Each filter is called with three arguments: the transcoded data,
2412 as a string, the back-end, as a symbol, and the communication
2416 "List of functions applied to a transcoded macro.
2417 Each filter is called with three arguments: the transcoded data,
2418 as a string, the back-end, as a symbol, and the communication
2422 "List of functions applied to a transcoded radio-target.
2423 Each filter is called with three arguments: the transcoded data,
2424 as a string, the back-end, as a symbol, and the communication
2428 "List of functions applied to a transcoded statistics-cookie.
2429 Each filter is called with three arguments: the transcoded data,
2430 as a string, the back-end, as a symbol, and the communication
2434 "List of functions applied to transcoded strike-through text.
2435 Each filter is called with three arguments: the transcoded data,
2436 as a string, the back-end, as a symbol, and the communication
2440 "List of functions applied to a transcoded subscript.
2441 Each filter is called with three arguments: the transcoded data,
2442 as a string, the back-end, as a symbol, and the communication
2446 "List of functions applied to a transcoded superscript.
2447 Each filter is called with three arguments: the transcoded data,
2448 as a string, the back-end, as a symbol, and the communication
2452 "List of functions applied to a transcoded target.
2453 Each filter is called with three arguments: the transcoded data,
2454 as a string, the back-end, as a symbol, and the communication
2458 "List of functions applied to a transcoded timestamp.
2459 Each filter is called with three arguments: the transcoded data,
2460 as a string, the back-end, as a symbol, and the communication
2464 "List of functions applied to transcoded underline text.
2465 Each filter is called with three arguments: the transcoded data,
2466 as a string, the back-end, as a symbol, and the communication
2470 "List of functions applied to transcoded verbatim text.
2471 Each filter is called with three arguments: the transcoded data,
2472 as a string, the back-end, as a symbol, and the communication
2476 ;;;; Filters Tools
2477 ;;
2478 ;; Internal function `org-export-install-filters' installs filters
2479 ;; hard-coded in back-ends (developer filters) and filters from global
2480 ;; variables (user filters) in the communication channel.
2481 ;;
2482 ;; Internal function `org-export-filter-apply-functions' takes care
2483 ;; about applying each filter in order to a given data. It ignores
2484 ;; filters returning a nil value but stops whenever a filter returns
2485 ;; an empty string.
2488 "Call every function in FILTERS.
2490 Functions are called with arguments VALUE, current export
2491 back-end and INFO. A function returning a nil value will be
2492 skipped. If it returns the empty string, the process ends and
2493 VALUE is ignored.
2495 Call is done in a LIFO fashion, to be sure that developer
2496 specified filters, if any, are called first."
2505 "Install filters properties in communication channel.
2507 INFO is a plist containing the current communication channel.
2509 Return the updated communication channel."
2511 ;; Install user defined filters with `org-export-filters-alist'.
2514 org-export-filters-alist)
2515 ;; Prepend back-end specific filters to that list.
2520 ;; Single values get consed, lists are prepended.
2525 plist key
2529 ;; Return new communication channel.
2533 \f
2534 ;;; Core functions
2535 ;;
2536 ;; This is the room for the main function, `org-export-as', along with
2537 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2538 ;; They differ only by the way they output the resulting code.
2539 ;;
2540 ;; `org-export-output-file-name' is an auxiliary function meant to be
2541 ;; used with `org-export-to-file'. With a given extension, it tries
2542 ;; to provide a canonical file name to write export output to.
2543 ;;
2544 ;; Note that `org-export-as' doesn't really parse the current buffer,
2545 ;; but a copy of it (with the same buffer-local variables and
2546 ;; visibility), where macros and include keywords are expanded and
2547 ;; Babel blocks are executed, if appropriate.
2548 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2549 ;;
2550 ;; File inclusion is taken care of by
2551 ;; `org-export-expand-include-keyword' and
2552 ;; `org-export--prepare-file-contents'. Structure wise, including
2553 ;; a whole Org file in a buffer often makes little sense. For
2554 ;; example, if the file contains an headline and the include keyword
2555 ;; was within an item, the item should contain the headline. That's
2556 ;; why file inclusion should be done before any structure can be
2557 ;; associated to the file, that is before parsing.
2561 "Transcode current Org buffer into BACKEND code.
2563 If narrowing is active in the current buffer, only transcode its
2564 narrowed part.
2566 If a region is active, transcode that region.
2568 When optional argument SUBTREEP is non-nil, transcode the
2569 sub-tree at point, extracting information from the headline
2570 properties first.
2572 When optional argument VISIBLE-ONLY is non-nil, don't export
2573 contents of hidden elements.
2575 When optional argument BODY-ONLY is non-nil, only return body
2576 code, without preamble nor postamble.
2578 Optional argument EXT-PLIST, when provided, is a property list
2579 with external parameters overriding Org default settings, but
2580 still inferior to file-local settings.
2582 Optional argument NOEXPAND, when non-nil, prevents included files
2583 to be expanded and Babel code to be executed.
2585 Return code as a string."
2586 ;; Barf if BACKEND isn't registered.
2590 ;; Narrow buffer to an appropriate region or subtree for
2591 ;; parsing. If parsing subtree, be sure to remove main headline
2592 ;; too.
2600 ;; Initialize communication channel with original buffer
2601 ;; attributes, unavailable in its copy.
2604 ;; Run first hook with current back-end as argument.
2606 ;; Update communication channel and get parse tree. Buffer
2607 ;; isn't parsed directly. Instead, a temporary copy is
2608 ;; created, where include keywords, macros are expanded and
2609 ;; code blocks are evaluated.
2612 ;; Update macro templates since #+INCLUDE keywords might
2613 ;; have added some new ones.
2616 ;; TODO: Setting `org-current-export-file' is required by
2617 ;; Org Babel to properly resolve noweb references. Once
2618 ;; "org-exp.el" is removed, modify
2619 ;; `org-export-blocks-preprocess' so it accepts the value
2620 ;; as an argument instead.
2623 ;; Update radio targets since keyword inclusion might have
2624 ;; added some more.
2626 ;; Run last hook with current back-end as argument.
2629 ;; Update communication channel with environment. Also
2630 ;; install user's and developer's filters.
2635 ;; Expand export-specific set of macros: {{{author}}},
2636 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2637 ;; once regular macros have been expanded, since document
2638 ;; keywords may contain one of them.
2645 ;; EMAIL is not a parsed keyword: store it as-is.
2649 ;; Eventually parse buffer. Call parse-tree filters to get
2650 ;; the final tree.
2655 ;; Now tree is complete, compute its properties and add them
2656 ;; to communication channel.
2660 ;; Eventually transcode TREE. Wrap the resulting string into
2661 ;; a template, if required. Finally call final-output filter.
2670 info)))
2671 ;; Maybe add final OUTPUT to kill ring, then return it.
2674 output)))))
2678 "Call `org-export-as' with output to a specified buffer.
2680 BACKEND is the back-end used for transcoding, as a symbol.
2682 BUFFER is the output buffer. If it already exists, it will be
2683 erased first, otherwise, it will be created.
2685 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2686 and NOEXPAND are similar to those used in `org-export-as', which
2687 see.
2689 Return buffer."
2691 backend subtreep visible-only body-only ext-plist noexpand))
2697 buffer))
2701 "Call `org-export-as' with output to a specified file.
2703 BACKEND is the back-end used for transcoding, as a symbol. FILE
2704 is the name of the output file, as a string.
2706 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2707 and NOEXPAND are similar to those used in `org-export-as', which
2708 see.
2710 Return output file's name."
2711 ;; Checks for FILE permissions. `write-file' would do the same, but
2712 ;; we'd rather avoid needless transcoding of parse tree.
2714 ;; Insert contents to a temporary buffer and write it to FILE.
2716 backend subtreep visible-only body-only ext-plist noexpand)))
2721 ;; Return full path.
2722 file)
2725 "Return output file's name according to buffer specifications.
2727 EXTENSION is a string representing the output file extension,
2728 with the leading dot.
2730 With a non-nil optional argument SUBTREEP, try to determine
2732 of subtree at point.
2734 When optional argument PUB-DIR is set, use it as the publishing
2735 directory.
2737 When optional argument VISIBLE-ONLY is non-nil, don't export
2738 contents of hidden elements.
2740 Return file name as a string, or nil if it couldn't be
2741 determined."
2743 ;; File name may come from EXPORT_FILE_NAME subtree property,
2744 ;; assuming point is at beginning of said sub-tree.
2751 ;; File name may be extracted from buffer's associated
2752 ;; file, if any.
2755 ;; Can't determine file name on our own: Ask user.
2759 "Output file: " pub-dir nil nil nil
2762 ;; Build file name. Enforce EXTENSION over whatever user may have
2763 ;; come up with. PUB-DIR, if defined, always has precedence over
2764 ;; any provided path.
2769 extension))
2774 "Apply BODY in a copy of the current buffer.
2776 The copy preserves local variables and visibility of the original
2777 buffer.
2779 Point is at buffer's beginning when BODY is applied."
2789 ,original-buffer
2801 "Expand every include keyword in buffer.
2802 Optional argument INCLUDED is a list of included file names along
2803 with their line restriction, when appropriate. It is used to
2804 avoid infinite recursion. Optional argument DIR is the current
2805 working directory. It is used to properly resolve relative
2806 paths."
2813 ;; Extract arguments from keyword's value.
2827 ;; Minimal level of included file defaults to the child
2828 ;; level of the current headline, if any, or one. It
2829 ;; only applies is the file is meant to be included as
2830 ;; an Org one.
2838 ;; Remove keyword.
2843 ;; Check if files has already been parsed. Look after
2844 ;; inclusion lines too, as different parts of the same file
2845 ;; can be included too.
2857 ind-str contents ind-str))))
2865 ind-str env contents ind-str))))
2878 "Prepare the contents of FILE for inclusion and return them as a string.
2880 When optional argument LINES is a string specifying a range of
2881 lines, include only those lines.
2883 Optional argument IND, when non-nil, is an integer specifying the
2884 global indentation of returned contents. Since its purpose is to
2885 allow an included file to stay in the same environment it was
2886 created \(i.e. a list item), it doesn't apply past the first
2887 headline encountered.
2889 Optional argument MINLEVEL, when non-nil, is an integer
2890 specifying the level that any top-level headline in the included
2891 file should have."
2907 ;; Remove blank lines at beginning and end of contents. The logic
2908 ;; behind that removal is that blank lines around include keyword
2909 ;; override blank lines in included file.
2918 ;; If IND is set, preserve indentation of include keyword until
2919 ;; the first headline encountered.
2925 ;; Do not move footnote definitions out of column 0.
2931 ;; When MINLEVEL is specified, compute minimal level for headlines
2932 ;; in the file (CUR-MIN), and remove stars to each headline so
2933 ;; that headlines with minimal level have a level of MINLEVEL.
2943 ;; Only change stars, don't bother moving whole
2944 ;; sections.
2950 \f
2951 ;;; Tools For Back-Ends
2952 ;;
2953 ;; A whole set of tools is available to help build new exporters. Any
2954 ;; function general enough to have its use across many back-ends
2955 ;; should be added here.
2957 ;;;; For Affiliated Keywords
2958 ;;
2959 ;; `org-export-read-attribute' reads a property from a given element
2960 ;; as a plist. It can be used to normalize affiliated keywords'
2961 ;; syntax.
2962 ;;
2963 ;; Since captions can span over multiple lines and accept dual values,
2964 ;; their internal representation is a bit tricky. Therefore,
2965 ;; `org-export-get-caption' transparently returns a given element's
2966 ;; caption as a secondary string.
2969 "Turn ATTRIBUTE property from ELEMENT into a plist.
2971 When optional argument PROPERTY is non-nil, return the value of
2972 that property within attributes.
2976 properties."
2984 "Return caption from ELEMENT as a secondary string.
2986 When optional argument SHORTP is non-nil, return short caption,
2987 as a secondary string, instead.
2989 Caption lines are separated by a white space."
2997 ;;;; For Derived Back-ends
2998 ;;
2999 ;; `org-export-with-backend' is a function allowing to locally use
3000 ;; another back-end to transcode some object or element. In a derived
3001 ;; back-end, it may be used as a fall-back function once all specific
3002 ;; cases have been treated.
3005 "Call a transcoder from BACK-END on DATA."
3013 back-end)))))))
3019 ;;;; For Export Snippets
3020 ;;
3021 ;; Every export snippet is transmitted to the back-end. Though, the
3022 ;; latter will only retain one type of export-snippet, ignoring
3023 ;; others, based on the former's target back-end. The function
3024 ;; `org-export-snippet-backend' returns that back-end for a given
3025 ;; export-snippet.
3028 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3029 Translation, with `org-export-snippet-translation-alist', is
3030 applied."
3034 back-end))))
3037 ;;;; For Footnotes
3038 ;;
3039 ;; `org-export-collect-footnote-definitions' is a tool to list
3040 ;; actually used footnotes definitions in the whole parse tree, or in
3041 ;; an headline, in order to add footnote listings throughout the
3042 ;; transcoded data.
3043 ;;
3044 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3045 ;; back-ends, when they need to attach the footnote definition only to
3046 ;; the first occurrence of the corresponding label.
3047 ;;
3048 ;; `org-export-get-footnote-definition' and
3049 ;; `org-export-get-footnote-number' provide easier access to
3050 ;; additional information relative to a footnote reference.
3053 "Return an alist between footnote numbers, labels and definitions.
3055 DATA is the parse tree from which definitions are collected.
3056 INFO is the plist used as a communication channel.
3058 Definitions are sorted by order of references. They either
3059 appear as Org data or as a secondary string for inlined
3060 footnotes. Unreferenced definitions are ignored."
3062 collect-fn ; for byte-compiler.
3066 ;; Collect footnote number, label and definition in DATA.
3068 data 'footnote-reference
3075 def)
3076 num-alist)
3077 ;; Also search in definition for nested footnotes.
3080 ;; Don't enter footnote definitions since it will happen
3081 ;; when their first reference is found.
3087 "Non-nil when a footnote reference is the first one for its label.
3089 FOOTNOTE-REFERENCE is the footnote reference being considered.
3090 INFO is the plist used as a communication channel."
3092 ;; Anonymous footnotes are always a first reference.
3094 ;; Otherwise, return the first footnote with the same LABEL and
3095 ;; test if it is equal to FOOTNOTE-REFERENCE.
3101 data 'footnote-reference
3106 ;; If FN isn't inlined, be sure to traverse its
3107 ;; definition before resuming search. See
3108 ;; comments in `org-export-get-footnote-number'
3109 ;; for more information.
3113 ;; Don't enter footnote definitions since it will
3114 ;; happen when their first reference is found.
3117 footnote-reference)))))
3120 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3121 INFO is the plist used as a communication channel."
3127 "Return number associated to a footnote.
3129 FOOTNOTE is either a footnote reference or a footnote definition.
3130 INFO is the plist used as a communication channel."
3132 seen-refs
3133 search-ref ; For byte-compiler.
3137 ;; Search footnote references through DATA, filling
3138 ;; SEEN-REFS along the way.
3140 data 'footnote-reference
3144 ;; Anonymous footnote match: return number.
3147 ;; Labels match: return number.
3150 ;; Anonymous footnote: it's always a new one. Also,
3151 ;; be sure to return nil from the `cond' so
3152 ;; `first-match' doesn't get us out of the loop.
3154 ;; Label not seen so far: add it so SEEN-REFS.
3155 ;;
3156 ;; Also search for subsequent references in
3157 ;; footnote definition so numbering follows reading
3158 ;; logic. Note that we don't have to care about
3159 ;; inline definitions, since `org-element-map'
3160 ;; already traverses them at the right time.
3161 ;;
3162 ;; Once again, return nil to stay in the loop.
3167 nil))))
3168 ;; Don't enter footnote definitions since it will happen
3169 ;; when their first reference is found.
3174 ;;;; For Headlines
3175 ;;
3176 ;; `org-export-get-relative-level' is a shortcut to get headline
3177 ;; level, relatively to the lower headline level in the parsed tree.
3178 ;;
3179 ;; `org-export-get-headline-number' returns the section number of an
3180 ;; headline, while `org-export-number-to-roman' allows to convert it
3181 ;; to roman numbers.
3182 ;;
3183 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3184 ;; `org-export-last-sibling-p' are three useful predicates when it
3185 ;; comes to fulfill the `:headline-levels' property.
3186 ;;
3187 ;; `org-export-get-tags', `org-export-get-category' and
3188 ;; `org-export-get-node-property' extract useful information from an
3189 ;; headline or a parent headline. They all handle inheritance.
3192 "Return HEADLINE relative level within current parsed tree.
3193 INFO is a plist holding contextual information."
3198 "Non-nil when HEADLINE is considered as low level.
3200 INFO is a plist used as a communication channel.
3202 A low level headlines has a relative level greater than
3203 `:headline-levels' property value.
3205 Return value is the difference between HEADLINE relative level
3206 and the last level being considered as high enough, or nil."
3213 "Return HEADLINE numbering as a list of numbers.
3214 INFO is a plist holding contextual information."
3218 "Return a non-nil value if HEADLINE element should be numbered.
3219 INFO is a plist used as a communication channel."
3225 "Convert integer N into a roman numeral."
3238 res)))
3241 "Return list of tags associated to ELEMENT.
3243 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3244 is a plist used as a communication channel.
3246 Select tags (see `org-export-select-tags') and exclude tags (see
3247 `org-export-exclude-tags') are removed from the list.
3249 When non-nil, optional argument TAGS should be a list of strings.
3250 Any tag belonging to this list will also be removed.
3252 When optional argument INHERITED is non-nil, tags can also be
3253 inherited from parent headlines and FILETAGS keywords."
3259 ;; Build complete list of inherited tags.
3270 ;; Add FILETAGS keywords and return results.
3274 "Return node PROPERTY value for BLOB.
3276 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3277 element or object.
3279 If optional argument INHERITED is non-nil, the value can be
3280 inherited from a parent headline.
3282 Return value is a string or nil."
3294 "Return category for element or object BLOB.
3296 INFO is a plist used as a communication channel.
3298 CATEGORY is automatically inherited from a parent headline, from
3299 #+CATEGORY: keyword or created out of original file name. If all
3303 ;; Almost like `org-export-node-property', but we cannot trust
3304 ;; `plist-member' as every headline has a `:category'
3305 ;; property, would it be nil or equal to "???" (which has the
3306 ;; same meaning).
3325 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3326 INFO is a plist used as a communication channel."
3331 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3332 INFO is a plist used as a communication channel."
3336 ;;;; For Links
3337 ;;
3338 ;; `org-export-solidify-link-text' turns a string into a safer version
3339 ;; for links, replacing most non-standard characters with hyphens.
3340 ;;
3341 ;; `org-export-get-coderef-format' returns an appropriate format
3342 ;; string for coderefs.
3343 ;;
3344 ;; `org-export-inline-image-p' returns a non-nil value when the link
3345 ;; provided should be considered as an inline image.
3346 ;;
3347 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3348 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3349 ;; returns an appropriate unique identifier when found, or nil.
3350 ;;
3351 ;; `org-export-resolve-id-link' returns the first headline with
3352 ;; specified id or custom-id in parse tree, the path to the external
3353 ;; file with the id or nil when neither was found.
3354 ;;
3355 ;; `org-export-resolve-coderef' associates a reference to a line
3356 ;; number in the element it belongs, or returns the reference itself
3357 ;; when the element isn't numbered.
3360 "Take link text S and make a safe target out of it."
3365 "Return format string for code reference link.
3366 PATH is the link path. DESC is its description."
3374 "Non-nil if LINK object points to an inline image.
3376 Optional argument is a set of RULES defining inline images. It
3377 is an alist where associations have the following shape:
3379 \(TYPE . REGEXP)
3381 Applying a rule means apply REGEXP against LINK's path when its
3382 type is TYPE. The function will return a non-nil value if any of
3383 the provided rules is non-nil. The default rule is
3384 `org-export-default-inline-image-rule'.
3386 This only applies to links without a description."
3397 rules)
3398 ;; Return nil if no rule matched.
3399 nil))))
3402 "Resolve a code reference REF.
3404 INFO is a plist used as a communication channel.
3406 Return associated line number in source code, or REF itself,
3407 depending on src-block or example element's switches."
3415 org-coderef-label-format)))
3419 ;; Element containing REF is found. Resolve it to either
3420 ;; a label or a line number, as needed.
3430 "Return LINK destination.
3432 INFO is a plist holding contextual information.
3434 Return value can be an object, an element, or nil:
3436 - If LINK path matches a target object (i.e. <<path>>) or
3439 - If LINK path exactly matches the name affiliated keyword
3440 \(i.e. #+NAME: path) of an element, return that element.
3442 - If LINK path exactly matches any headline name, return that
3443 element. If more than one headline share that name, priority
3444 will be given to the one with the closest common ancestor, if
3445 any, or the first one in the parse tree otherwise.
3447 - Otherwise, return nil.
3453 ;; First try to find a matching "<<path>>" unless user specified
3454 ;; he was looking for an headline (path starts with a *
3455 ;; character).
3459 return target)))
3460 ;; Then try to find an element with a matching "#+NAME: path"
3461 ;; affiliated keyword.
3468 ;; Last case: link either points to an headline or to
3469 ;; nothingness. Try to find the source, with priority given to
3470 ;; headlines with the closest common ancestor. If such candidate
3471 ;; is found, return it, otherwise return nil.
3475 ;; Return first headline whose `:raw-value' property
3476 ;; is NAME in parse tree DATA, or nil.
3479 data 'headline
3483 name)
3484 headline))
3486 ;; Search among headlines sharing an ancestor with link,
3487 ;; from closest to farthest.
3495 ;; No match with a common ancestor: try the full parse-tree.
3501 "Return headline referenced as LINK destination.
3503 INFO is a plist used as a communication channel.
3505 Return value can be the headline element matched in current parse
3509 ;; First check if id is within the current parse tree.
3515 headline))
3517 ;; Otherwise, look for external files.
3521 "Return radio-target object referenced as LINK destination.
3523 INFO is a plist used as a communication channel.
3525 Return value can be a radio-target object or nil. Assume LINK
3535 ;;;; For References
3536 ;;
3537 ;; `org-export-get-ordinal' associates a sequence number to any object
3538 ;; or element.
3541 "Return ordinal number of an element or object.
3543 ELEMENT is the element or object considered. INFO is the plist
3544 used as a communication channel.
3546 Optional argument TYPES, when non-nil, is a list of element or
3547 object types, as symbols, that should also be counted in.
3548 Otherwise, only provided element's type is considered.
3550 Optional argument PREDICATE is a function returning a non-nil
3551 value if the current element or object should be counted in. It
3552 accepts two arguments: the element or object being considered and
3553 the plist used as a communication channel. This allows to count
3554 only a certain type of objects (i.e. inline images).
3556 Return value is a list of numbers if ELEMENT is an headline or an
3557 item. It is nil for keywords. It represents the footnote number
3558 for footnote definitions and footnote references. If ELEMENT is
3559 a target, return the same value as if ELEMENT was the closest
3560 table, item or headline containing the target. In any other
3561 case, return the sequence number of ELEMENT among elements or
3562 objects of the same type."
3563 ;; A target keyword, representing an invisible target, never has
3564 ;; a sequence number.
3566 ;; Ordinal of a target object refer to the ordinal of the closest
3567 ;; table, item, or headline containing the object.
3571 when
3575 table))
3576 return parent)))
3578 ;; Special case 1: An headline returns its number as a list.
3580 ;; Special case 2: An item returns its number as a list.
3584 struct
3591 ;; Increment counter until ELEMENT is found again.
3602 ;;;; For Src-Blocks
3603 ;;
3604 ;; `org-export-get-loc' counts number of code lines accumulated in
3605 ;; src-block or example-block elements with a "+n" switch until
3606 ;; a given element, excluded. Note: "-n" switches reset that count.
3607 ;;
3608 ;; `org-export-unravel-code' extracts source code (along with a code
3609 ;; references alist) from an `element-block' or `src-block' type
3610 ;; element.
3611 ;;
3612 ;; `org-export-format-code' applies a formatting function to each line
3613 ;; of code, providing relative line number and code reference when
3614 ;; appropriate. Since it doesn't access the original element from
3615 ;; which the source code is coming, it expects from the code calling
3616 ;; it to know if lines should be numbered and if code references
3617 ;; should appear.
3618 ;;
3619 ;; Eventually, `org-export-format-code-default' is a higher-level
3620 ;; function (it makes use of the two previous functions) which handles
3621 ;; line numbering and code references inclusion, and returns source
3622 ;; code in a format suitable for plain text or verbatim output.
3625 "Return accumulated lines of code up to ELEMENT.
3627 INFO is the plist used as a communication channel.
3629 ELEMENT is excluded from count."
3636 ;; ELEMENT is reached: Quit the loop.
3638 ;; Only count lines from src-block and example-block elements
3639 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3643 ;; Accumulate locs or reset them.
3647 ;; Return nil to stay in the loop.
3648 nil)))
3650 ;; Return value.
3651 loc))
3654 "Clean source code and extract references out of it.
3656 ELEMENT has either a `src-block' an `example-block' type.
3658 Return a cons cell whose CAR is the source code, cleaned from any
3659 reference and protective comma and CDR is an alist between
3660 relative line number (integer) and name of code reference on that
3661 line (string)."
3663 ;; Get code and clean it. Remove blank lines at its
3664 ;; beginning and end.
3670 ;; If appropriate, remove global indentation.
3673 c
3675 ;; Get format used for references.
3678 org-coderef-label-format)))
3679 ;; Build a regexp matching a loc with a reference.
3684 ;; Return value.
3686 ;; Code with references removed.
3692 ;; Ref line: remove ref, and signal its position in REFS.
3696 ;; Reference alist.
3697 refs)))
3700 "Format CODE by applying FUN line-wise and return it.
3702 CODE is a string representing the code to format. FUN is
3703 a function. It must accept three arguments: a line of
3704 code (string), the current line number (integer) or nil and the
3705 reference associated to the current line (string) or nil.
3707 Optional argument NUM-LINES can be an integer representing the
3708 number of code lines accumulated until the current code. Line
3709 numbers passed to FUN will take it into account. If it is nil,
3710 FUN's second argument will always be nil. This number can be
3711 obtained with `org-export-get-loc' function.
3713 Optional argument REF-ALIST can be an alist between relative line
3714 number (i.e. ignoring NUM-LINES) and the name of the code
3715 reference on it. If it is nil, FUN's third argument will always
3716 be nil. It can be obtained through the use of
3717 `org-export-unravel-code' function."
3729 "Return source code from ELEMENT, formatted in a standard way.
3731 ELEMENT is either a `src-block' or `example-block' element. INFO
3732 is a plist used as a communication channel.
3734 This function takes care of line numbering and code references
3735 inclusion. Line numbers, when applicable, appear at the
3736 beginning of the line, separated from the code by two white
3737 spaces. Code references, on the other hand, appear flushed to
3738 the right, separated by six white spaces from the widest line of
3739 code."
3740 ;; Extract code and references.
3746 ;; Handle line numbering.
3755 ;; Prepare references display, if required. Any reference
3756 ;; should start six columns after the widest line of code,
3757 ;; wrapped with parenthesis.
3762 code
3766 number-str
3767 loc
3773 num-start refs)))
3776 ;;;; For Tables
3777 ;;
3778 ;; `org-export-table-has-special-column-p' and and
3779 ;; `org-export-table-row-is-special-p' are predicates used to look for
3780 ;; meta-information about the table structure.
3781 ;;
3782 ;; `org-table-has-header-p' tells when the rows before the first rule
3783 ;; should be considered as table's header.
3784 ;;
3785 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3786 ;; and `org-export-table-cell-borders' extract information from
3787 ;; a table-cell element.
3788 ;;
3789 ;; `org-export-table-dimensions' gives the number on rows and columns
3790 ;; in the table, ignoring horizontal rules and special columns.
3791 ;; `org-export-table-cell-address', given a table-cell object, returns
3792 ;; the absolute address of a cell. On the other hand,
3793 ;; `org-export-get-table-cell-at' does the contrary.
3794 ;;
3795 ;; `org-export-table-cell-starts-colgroup-p',
3796 ;; `org-export-table-cell-ends-colgroup-p',
3797 ;; `org-export-table-row-starts-rowgroup-p',
3798 ;; `org-export-table-row-ends-rowgroup-p',
3799 ;; `org-export-table-row-starts-header-p' and
3800 ;; `org-export-table-row-ends-header-p' indicate position of current
3801 ;; row or cell within the table.
3804 "Non-nil when TABLE has a special column.
3805 All special columns will be ignored during export."
3806 ;; The table has a special column when every first cell of every row
3807 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3808 ;; "*" "_" and "^". Though, do not consider a first row containing
3809 ;; only empty cells as special.
3825 "Non-nil when TABLE has an header.
3827 INFO is a plist used as a communication channel.
3829 A table has an header when it contains at least two row groups."
3832 table 'table-row
3840 info)))
3843 "Non-nil if TABLE-ROW is considered special.
3845 INFO is a plist used as the communication channel.
3847 All special rows will be ignored during export."
3851 ;; A row is special either when...
3853 ;; ... it starts with a field only containing "/",
3855 ;; ... the table contains a special column and the row start
3856 ;; with a marking character among, "^", "_", "$" or "!",
3860 ;; ... it contains only alignment cookies and empty cells.
3866 ;; Since VALUE is a secondary string, the following
3867 ;; checks avoid expanding it with `org-export-data'.
3879 "Return TABLE-ROW's group.
3881 INFO is a plist used as the communication channel.
3883 Return value is the group number, as an integer, or nil special
3884 rows and table rules. Group 1 is also table's header."
3901 "Return TABLE-CELL contents width.
3903 INFO is a plist used as the communication channel.
3905 Return value is the width given by the last width cookie in the
3906 same column as TABLE-CELL, or nil."
3911 cookie-width)
3915 ;; In a special row, try to find a width cookie at COLUMN.
3919 ;; The following checks avoid expanding unnecessarily the
3920 ;; cell with `org-export-data'
3928 ;; Ignore table rules.
3931 ;; Return value.
3932 cookie-width))
3935 "Return TABLE-CELL contents alignment.
3937 INFO is a plist used as the communication channel.
3939 Return alignment as specified by the last alignment cookie in the
3940 same column as TABLE-CELL. If no such cookie is found, a default
3941 alignment value will be deduced from fraction of numbers in the
3942 column (see `org-table-number-fraction' for more information).
3943 Possible values are `left', `right' and `center'."
3950 cookie-align)
3954 ;; In a special row, try to find an alignment cookie at
3955 ;; COLUMN.
3959 ;; Since VALUE is a secondary string, the following checks
3960 ;; avoid useless expansion through `org-export-data'.
3968 ;; Ignore table rules.
3970 ;; In a standard row, check if cell's contents are expressing
3971 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3972 ;; Though, don't bother if an alignment cookie has already
3973 ;; defined cell's alignment.
3978 info)))
3983 ;; Return value. Alignment specified by cookies has precedence
3984 ;; over alignment deduced from cells contents.
3993 "Return TABLE-CELL borders.
3995 INFO is a plist used as a communication channel.
3997 Return value is a list of symbols, or nil. Possible values are:
3998 `top', `bottom', `above', `below', `left' and `right'. Note:
3999 `top' (resp. `bottom') only happen for a cell in the first
4000 row (resp. last row) of the table, ignoring table rules, if any.
4002 Returned borders ignore special rows."
4005 borders)
4006 ;; Top/above border? TABLE-CELL has a border above when a rule
4007 ;; used to demarcate row groups can be found above. Hence,
4008 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4009 ;; another regular row has to be found above that rule.
4018 ;; Look at every row before the current one.
4020 ;; No rule above, or rule found starts the table (ignoring any
4021 ;; special row): TABLE-CELL is at the top of the table.
4024 ;; Bottom/below border? TABLE-CELL has a border below when next
4025 ;; non-regular row below is a rule.
4034 ;; Look at every row after the current one.
4036 ;; No rule below, or rule found ends the table (modulo some
4037 ;; special row): TABLE-CELL is at the bottom of the table.
4040 ;; Right/left borders? They can only be specified by column
4041 ;; groups. Column groups are defined in a row starting with "/".
4042 ;; Also a column groups row only contains "<", "<>", ">" or blank
4043 ;; cells.
4060 ;; There's a left border when previous cell, if
4061 ;; any, ends a group, or current one starts one.
4067 ;; There's a right border when next cell, if any,
4068 ;; starts a group, or current one ends one.
4075 ;; Table rows are read in reverse order so last column groups
4076 ;; row has precedence over any previous one.
4078 ;; Return value.
4079 borders))
4082 "Non-nil when TABLE-CELL is at the beginning of a row group.
4083 INFO is a plist used as a communication channel."
4084 ;; A cell starts a column group either when it is at the beginning
4085 ;; of a row (or after the special column, if any) or when it has
4086 ;; a left border.
4090 table-cell)
4094 "Non-nil when TABLE-CELL is at the end of a row group.
4095 INFO is a plist used as a communication channel."
4096 ;; A cell ends a column group either when it is at the end of a row
4097 ;; or when it has a right border.
4100 table-cell)
4104 "Non-nil when TABLE-ROW is at the beginning of a column group.
4105 INFO is a plist used as a communication channel."
4113 "Non-nil when TABLE-ROW is at the end of a column group.
4114 INFO is a plist used as a communication channel."
4122 "Non-nil when TABLE-ROW is the first table header's row.
4123 INFO is a plist used as a communication channel."
4130 "Non-nil when TABLE-ROW is the last table header's row.
4131 INFO is a plist used as a communication channel."
4138 "Return TABLE dimensions.
4140 INFO is a plist used as a communication channel.
4142 Return value is a CONS like (ROWS . COLUMNS) where
4143 ROWS (resp. COLUMNS) is the number of exportable
4144 rows (resp. columns)."
4146 ;; Set number of rows, and extract first one.
4148 table 'table-row
4153 ;; Set number of columns.
4155 ;; Return value.
4159 "Return address of a regular TABLE-CELL object.
4161 TABLE-CELL is the cell considered. INFO is a plist used as
4162 a communication channel.
4164 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4165 zero-based index. Only exportable cells are considered. The
4166 function returns nil for other cells."
4169 ;; Ignore cells in special rows or in special column.
4174 ;; Row number.
4177 table 'table-row
4183 ;; Column number.
4186 table-row 'table-cell
4192 "Return regular table-cell object at ADDRESS in TABLE.
4194 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4195 zero-based index. TABLE is a table type element. INFO is
4196 a plist used as a communication channel.
4198 If no table-cell, among exportable cells, is found at ADDRESS,
4199 return nil."
4202 ;; Row at (car address) or nil.
4205 table 'table-row
4211 'table-cell
4218 ;;;; For Tables Of Contents
4219 ;;
4220 ;; `org-export-collect-headlines' builds a list of all exportable
4221 ;; headline elements, maybe limited to a certain depth. One can then
4222 ;; easily parse it and transcode it.
4223 ;;
4224 ;; Building lists of tables, figures or listings is quite similar.
4225 ;; Once the generic function `org-export-collect-elements' is defined,
4226 ;; `org-export-collect-tables', `org-export-collect-figures' and
4227 ;; `org-export-collect-listings' can be derived from it.
4230 "Collect headlines in order to build a table of contents.
4232 INFO is a plist used as a communication channel.
4234 When optional argument N is an integer, it specifies the depth of
4235 the table of contents. Otherwise, it is set to the value of the
4236 last headline level. See `org-export-headline-levels' for more
4237 information.
4239 Return a list of all exportable headlines as parsed elements."
4243 'headline
4245 ;; Strip contents from HEADLINE.
4248 info))
4251 "Collect referenceable elements of a determined type.
4253 TYPE can be a symbol or a list of symbols specifying element
4254 types to search. Only elements with a caption are collected.
4256 INFO is a plist used as a communication channel.
4258 When non-nil, optional argument PREDICATE is a function accepting
4259 one argument, an element of type TYPE. It returns a non-nil
4260 value when that element should be collected.
4262 Return a list of all elements found, in order of appearance."
4268 element))
4269 info))
4272 "Build a list of tables.
4273 INFO is a plist used as a communication channel.
4275 Return a list of table elements with a caption."
4279 "Build a list of figures.
4281 INFO is a plist used as a communication channel. PREDICATE is
4282 a function which accepts one argument: a paragraph element and
4283 whose return value is non-nil when that element should be
4284 collected.
4286 A figure is a paragraph type element, with a caption, verifying
4288 a vague concept that may depend on back-end.
4290 Return a list of elements recognized as figures."
4294 "Build a list of src blocks.
4296 INFO is a plist used as a communication channel.
4298 Return a list of src-block elements with a caption."
4302 ;;;; Smart Quotes
4339 "Smart quotes translations.
4341 Alist whose CAR is a language string and CDR is an alist with
4342 quote type as key and a plist associating various encodings to
4343 their translation as value.
4345 A quote type can be any symbol among `opening-double-quote',
4346 `closing-double-quote', `opening-single-quote',
4347 `closing-single-quote' and `apostrophe'.
4349 Valid encodings include `:utf-8', `:html', `:latex' and
4350 `:texinfo'.
4356 ;; Possible opening quote at beginning of string.
4358 ;; Possible closing quote at beginning of string.
4360 ;; Possible apostrophe at beginning of string.
4362 ;; Opening single and double quotes.
4364 ;; Closing single and double quotes.
4366 ;; Apostrophe.
4368 ;; Possible opening quote at end of string.
4370 ;; Possible closing quote at end of string.
4372 ;; Possible apostrophe at end of string.
4374 "List of regexps matching a quote or an apostrophe.
4380 ENCODING is a symbol among `:html', `:latex' and `:utf-8'. INFO
4381 is a plist used as a communication channel.
4383 The function has to retrieve information about string
4384 surroundings in parse tree. It can only happen with an
4385 unmodified string. Thus, if S has already been through another
4386 process, a non-nil ORIGINAL optional argument will provide that
4387 original string.
4389 Return the new string."
4396 ;; Return smart quote associated to a give quote Q, as
4397 ;; a string. TYPE is a symbol among `open', `close' and
4398 ;; `apostrophe'.
4408 org-export-smart-quotes-alist))))
4409 encoding)
4410 q)))))
4412 ;; Only a quote: no regexp can match. We have to check both
4413 ;; sides and decide what to do.
4421 ;; 1. Replace quote character at the beginning of S.
4423 ;; Apostrophe?
4429 ;; Closing quote?
4435 ;; Opening quote?
4441 ;; 2. Replace quotes in the middle of the string.
4443 ;; Opening quotes.
4449 ;; Closing quotes.
4455 ;; Apostrophes.
4460 ;; 3. Replace quote character at the end of S.
4462 ;; Apostrophe?
4467 ;; Closing quote?
4473 ;; Opening quote?
4478 ;; Return string with smart quotes.
4479 s))))
4481 ;;;; Topology
4482 ;;
4483 ;; Here are various functions to retrieve information about the
4484 ;; neighbourhood of a given element or object. Neighbours of interest
4485 ;; are direct parent (`org-export-get-parent'), parent headline
4486 ;; (`org-export-get-parent-headline'), first element containing an
4487 ;; object, (`org-export-get-parent-element'), parent table
4488 ;; (`org-export-get-parent-table'), previous element or object
4489 ;; (`org-export-get-previous-element') and next element or object
4490 ;; (`org-export-get-next-element').
4491 ;;
4492 ;; `org-export-get-genealogy' returns the full genealogy of a given
4493 ;; element or object, from closest parent to full parse tree.
4496 "Return BLOB parent or nil.
4497 BLOB is the element or object considered."
4501 "Return full genealogy relative to a given element or object.
4503 BLOB is the element or object being considered.
4505 Ancestors are returned from closest to farthest, the last one
4506 being the full parse tree."
4513 "Return BLOB parent headline or nil.
4514 BLOB is the element or object being considered."
4518 parent))
4521 "Return first element containing OBJECT or nil.
4522 OBJECT is the object to consider."
4526 parent))
4529 "Return OBJECT parent table or nil.
4530 OBJECT is either a `table-cell' or `table-element' type object."
4534 parent))
4537 "Return previous element or object.
4538 BLOB is an element or object. INFO is a plist used as
4539 a communication channel. Return previous exportable element or
4540 object, a string, or nil."
4547 ;; An object can belong to the contents of its parent or
4548 ;; to a secondary string. We check the latter option
4549 ;; first.
4552 org-element-all-elements))
4556 org-element-secondary-value-alist))
4557 parent)))
4562 "Return next element or object.
4563 BLOB is an element or object. INFO is a plist used as
4564 a communication channel. Return next exportable element or
4565 object, a string, or nil."
4570 ;; An object can belong to the contents of its parent or to
4571 ;; a secondary string. We check the latter option first.
4574 org-element-all-objects))
4578 org-element-secondary-value-alist))
4579 parent)))
4582 nil))
4585 ;;;; Translation
4586 ;;
4587 ;; `org-export-translate' translates a string according to language
4588 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4589 ;; variable and a specified charset. `org-export-dictionary' contains
4590 ;; the dictionary used for the translation.
4712 "Dictionary for export engine.
4714 Alist whose CAR is the string to translate and CDR is an alist
4715 whose CAR is the language string and CDR is a plist whose
4716 properties are possible charsets and values translated terms.
4718 It is used as a database for `org-export-translate'. Since this
4719 function returns the string as-is if no translation was found,
4720 the variable only needs to record values different from the
4724 "Translate string S according to language specification.
4726 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4727 and `:utf-8'. INFO is a plist used as a communication channel.
4729 Translation depends on `:language' property. Return the
4730 translated string. If no translation is found, try to fall back
4731 to `:default' encoding. If it fails, return S."
4737 s)))
4740 \f
4741 ;;; The Dispatcher
4742 ;;
4743 ;; `org-export-dispatch' is the standard interactive way to start an
4744 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4745 ;; for its interface, which, in turn, delegates response to key
4746 ;; pressed to `org-export-dispatch-action'.
4749 "List of menu entries available for `org-export-dispatch'.
4750 This variable shouldn't be set directly. Set-up :menu-entry
4751 keyword in either `org-export-define-backend' or
4754 ;;;###autoload
4756 "Export dispatcher for Org mode.
4758 It provides an access to common export related tasks in a buffer.
4759 Its interface comes in two flavours: standard and expert. While
4760 both share the same set of bindings, only the former displays the
4761 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4762 to switch to one or the other."
4767 nil
4768 org-export-dispatch-use-expert-ui)
4774 ;; First handle special hard-coded actions.
4780 "Publish project: "
4781 org-e-publish-project-alist nil t)
4782 org-e-publish-project-alist)
4792 "Handle interface for `org-export-dispatch'.
4794 OPTIONS is a list containing current interactive options set for
4795 export. It can contain any of the following symbols:
4796 `body' toggles a body-only export
4797 `subtree' restricts export to current subtree
4798 `visible' restricts export to visible part of buffer.
4799 `force' force publishing files.
4801 FIRST-KEY is the key pressed to select the first level menu. It
4802 is nil when this menu hasn't been selected yet.
4804 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4805 buffer is provided, but indications about currently active
4806 options are given in the prompt. Moreover, \[?] allows to switch
4807 back to standard interface."
4810 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4811 ;; non-nil is the required first-level key to activate
4812 ;; KEY. When its value is t, activate KEY independently
4813 ;; on the first key, if any. A nil value means KEY will
4814 ;; only be activated at first level.
4818 ;; Make sure order of menu doesn't depend on the order in
4819 ;; which back-ends are loaded.
4822 ;; Compute a list of allowed keys based on the first key
4823 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4824 ;; always available.
4834 ;; Build the help menu for standard UI.
4838 ;; Options are hard-coded.
4840 [%s] Body only: %s [%s] Visible only: %s
4850 ;; Display registered back-end entries.
4860 ;; Split sub-menu into two columns.
4870 top-key)
4875 ;; Publishing menu is hard-coded.
4877 [%s] Current file [%s] Current project
4887 ;; Build prompts for both standard and expert UI.
4892 "Export command (Options: %s%s%s%s) [%s]: "
4898 ;; With expert UI, just read key with a fancy prompt. In standard
4899 ;; UI, display an intrusive help buffer.
4902 expert-prompt allowed-keys backends options first-key expertp)
4903 ;; At first call, create frame layout in order to display menu.
4909 ;; At this point, the buffer containing the menu exists and is
4910 ;; visible in the current window. So, refresh it.
4916 standard-prompt allowed-keys backends options first-key expertp))))
4920 "Read a character from command input and act accordingly.
4922 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
4923 a list of characters available at a given step in the process.
4924 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
4925 EXPERTP are the same as defined in `org-export-dispatch-ui',
4926 which see.
4928 Toggle export options when required. Otherwise, return value is
4929 a list with action as CAR and a list of interactive export
4930 options as CDR."
4932 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4933 ;; depending on user's key pressed.
4936 ;; Ignore non-standard characters (i.e. "M-a") and
4937 ;; undefined associations.
4942 ;; q key at first level aborts export. At second
4943 ;; level, cancel first key instead.
4946 ;; Help key: Switch back to standard interface if
4947 ;; expert UI was active.
4949 ;; Toggle export options.
4956 first-key expertp))
4957 ;; Action selected: Send key and options back to
4958 ;; `org-export-dispatch'.
4964 ;; Publishing actions are hard-coded. Send a special
4965 ;; signal to `org-export-dispatch'.
4973 options))
4974 ;; Otherwise, enter sub-menu.
4979 ;;; org-export.el ends here