| blob | 210cdd906e463bc24461448062885faa08e7dc39 |
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.
137 "Alist between export properties and ways to set them.
139 The CAR of the alist is the property name, and the CDR is a list
140 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
142 KEYWORD is a string representing a buffer keyword, or nil. Each
143 property defined this way can also be set, during subtree
144 export, through an headline property named after the keyword
146 property).
147 OPTION is a string that could be found in an #+OPTIONS: line.
148 DEFAULT is the default value for the property.
149 BEHAVIOUR determine how Org should handle multiple keywords for
150 the same property. It is a symbol among:
151 nil Keep old value and discard the new one.
152 t Replace old value with the new one.
153 `space' Concatenate the values, separating them with a space.
154 `newline' Concatenate the values, separating them with
155 a newline.
156 `split' Split values at white spaces, and cons them to the
157 previous list.
159 KEYWORD and OPTION have precedence over DEFAULT.
161 All these properties should be back-end agnostic. Back-end
162 specific properties are set through `org-export-define-backend'.
166 "List of in-buffer keywords that require special treatment.
167 These keywords are not directly associated to a property. The
168 way they are handled must be hard-coded into
228 "Alist between filters properties and initial values.
230 The key of each association is a property name accessible through
231 the communication channel. Its value is a configurable global
232 variable defining initial filters.
234 This list is meant to install user specified filters. Back-end
235 developers may install their own filters using
236 `org-export-define-backend'. Filters defined there will always
237 be prepended to the current list, so they always get applied
246 "Default rule for link matching an inline image.
247 This rule applies to links with no description. By default, it
248 will be considered as an inline image if it targets a local file
251 See `org-export-inline-image-p' for more information about
255 \f
256 ;;; User-configurable Variables
257 ;;
258 ;; Configuration for the masses.
259 ;;
260 ;; They should never be accessed directly, as their value is to be
261 ;; stored in a property list (cf. `org-export-options-alist').
262 ;; Back-ends will read their value from there instead.
265 "Options for exporting Org mode files."
270 "General options for export engine."
275 "Whether sub-trees with the ARCHIVE tag should be exported.
277 This can have three different values:
278 nil Do not export, pretend this tree is not present.
279 t Do export the entire tree.
280 `headline' Only export the headline, but skip the tree below it.
282 This option can also be set with the #+OPTIONS line,
291 "Non-nil means insert author name into the exported file.
292 This option can also be set with the #+OPTIONS line,
298 "Non-nil means export CLOCK keywords.
299 This option can also be set with the #+OPTIONS line,
305 "Non-nil means the postamble should contain a creator sentence.
307 The sentence can be set in `org-export-creator-string' and
310 If the value is `comment' insert it as a comment."
320 emacs-version)
321 "String to insert at the end of the generated document."
326 "Non-nil means export contents of standard drawers.
328 When t, all drawers are exported. This may also be a list of
329 drawer names to export. This variable doesn't apply to
330 properties drawers.
332 This option can also be set with the #+OPTIONS line,
342 "Non-nil means insert author email into the exported file.
343 This option can also be set with the #+OPTIONS line,
349 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
351 If the export target supports emphasizing text, the word will be
352 typeset in bold, italic, or underlined, respectively. Not all
353 export backends support this.
360 "Tags that exclude a tree from export.
362 All trees carrying any of these tags will be excluded from
363 export. This is without condition, so even subtrees inside that
364 carry one of the `org-export-select-tags' will be removed.
366 This option can also be set with the #+EXCLUDE_TAGS: keyword."
373 This can be used to have pre-formatted text, fragments of code
374 etc. For example:
375 : ;; Some Lisp examples
376 : (while (defc cnt)
377 : (ding))
378 will be looking just like this in also HTML. See also the QUOTE
379 keyword. Not all export backends support this.
386 "Non-nil means Org footnotes should be exported.
387 This option can also be set with the #+OPTIONS line,
393 "The last level which is still exported as a headline.
395 Inferior levels will produce itemize lists when exported.
402 "The default language for export and clocktable translations, as a string.
403 This may have an association in
404 `org-clock-clocktable-language-setup'."
409 "Non-nil means preserve all line breaks when exporting.
411 Normally, in HTML output paragraphs will be reformatted.
413 This option can also be set with the #+OPTIONS line,
419 "Non-nil means interpret entities when exporting.
422 Å.
424 For a list of supported names, see the constant `org-entities'
425 and the user option `org-entities-user'.
427 This option can also be set with the #+OPTIONS line,
433 "Non-nil means inlinetasks should be exported.
434 This option can also be set with the #+OPTIONS line,
440 "Non-nil means include planning info in export.
441 This option can also be set with the #+OPTIONS: line,
447 "Non-nil means include priority cookies in export.
448 This option can also be set with the #+OPTIONS line,
454 "Non-nil means add section numbers to headlines when exporting.
456 When set to an integer n, numbering will only happen for
457 headlines whose relative level is higher or equal to n.
459 This option can also be set with the #+OPTIONS line,
465 "Tags that select a tree for export.
467 If any such tag is found in a buffer, all trees that do not carry
468 one of these tags will be ignored during export. Inside trees
469 that are selected like this, you can still deselect a subtree by
470 tagging it with one of the `org-export-exclude-tags'.
472 This option can also be set with the #+SELECT_TAGS: keyword."
477 "Non-nil means activate smart quotes during export.
478 This option can also be set with the #+OPTIONS: line,
486 When this option is turned on, these strings will be exported as:
488 Org HTML LaTeX UTF-8
489 -----+----------+--------+-------
491 -- – -- –
492 --- — --- —
495 This option can also be set with the #+OPTIONS line,
501 "Non-nil means include statistics cookies in export.
502 This option can also be set with the #+OPTIONS: line,
510 When this option is turned on, you can use TeX-like syntax for
512 will be considered as a single item - so grouping with {} is
513 normally not needed. For example, the following things will be
514 parsed as single sub- or superscripts.
516 10^24 or 10^tau several digits will be considered 1 item.
517 10^-12 or 10^-tau a leading sign with digits or a word
518 x^2-y^3 will be read as x^2 - y^3, because items are
519 terminated by almost any nonword/nondigit char.
520 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
522 Still, ambiguity is possible - so when in doubt use {} to enclose
523 the sub/superscript. If you set this variable to the symbol
524 `{}', the braces are *required* in order to trigger
525 interpretations as sub/superscript. This can be helpful in
528 This option can also be set with the #+OPTIONS line,
537 "Non-nil means create a table of contents in exported files.
539 The TOC contains headlines with levels up
540 to`org-export-headline-levels'. When an integer, include levels
541 up to N in the toc, this may then be different from
542 `org-export-headline-levels', but it will not be allowed to be
543 larger than the number of headline levels. When nil, no table of
544 contents is made.
546 This option can also be set with the #+OPTIONS line,
556 For example:
558 | Name | Address | Birthday |
559 |-------------+----------+-----------|
560 | Arthur Dent | England | 29.2.2100 |
567 "If nil, do not export tags, just remove them from headlines.
569 If this is the symbol `not-in-toc', tags will be removed from
570 table of contents entries, but still be shown in the headlines of
571 the document.
573 This option can also be set with the #+OPTIONS line,
582 "Non-nil means include TODO items for export.
584 This may have the following values:
585 t include tasks independent of state.
586 `todo' include only tasks that are not yet done.
587 `done' include only tasks that are already done.
588 nil ignore all tasks.
589 list of keywords include tasks with these keywords.
591 This option can also be set with the #+OPTIONS line,
603 "Non-nil means insert a time stamp into the exported file.
604 The time stamp shows when the file was created.
606 This option can also be set with the #+OPTIONS line,
612 "Non nil means allow timestamps in export.
614 It can be set to `active', `inactive', t or nil, in order to
615 export, respectively, only active timestamps, only inactive ones,
616 all of them or none.
618 This option can also be set with the #+OPTIONS line, e.g.
628 "Non-nil means include TODO keywords in export.
629 When nil, remove all these keywords from the export."
634 "Non-nil means allow #+BIND to define local variable values for export.
635 This is a potential security risk, which is why the user must
636 confirm the use of these lines."
644 "Alist between export snippets back-ends and exporter back-ends.
646 This variable allows to provide shortcuts for export snippets.
650 HTML code while every other back-end will ignore it."
658 "Coding system for the exported file."
663 "Non-nil means exported stuff will also be pushed onto the kill ring."
668 "The initial scope when exporting with `org-export-dispatch'.
669 This variable can be either set to `buffer' or `subtree'."
676 "Non-nil means show buffer after exporting to temp buffer.
677 When Org exports to a file, the buffer visiting that file is ever
678 shown, but remains buried. However, when exporting to
679 a temporary buffer, that buffer is popped up in a second window.
680 When this variable is nil, the buffer remains buried also in
681 these cases."
686 "Non-nil means using a non-intrusive `org-export-dispatch'.
687 In that case, no help buffer is displayed. Though, an indicator
692 be passed the FORCE argument). Also, \[?] allows to switch back
693 to standard mode."
698 \f
699 ;;; Defining New Back-ends
700 ;;
701 ;; `org-export-define-backend' is the standard way to define an export
702 ;; back-end. It allows to specify translators, filters, buffer
703 ;; options and a menu entry. If the new back-end shares translators
704 ;; with another back-end, `org-export-define-derived-backend' may be
705 ;; used instead.
706 ;;
707 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
708 ;; when a given back-end hasn't been registered yet.
711 "Define a new back-end BACKEND.
713 TRANSLATORS is an alist between object or element types and
714 functions handling them.
716 These functions should return a string without any trailing
717 space, or nil. They must accept three arguments: the object or
718 element itself, its contents or nil when it isn't recursive and
719 the property list used as a communication channel.
721 Contents, when not nil, are stripped from any global indentation
722 \(although the relative one is preserved). They also always end
723 with a single newline character.
725 If, for a given type, no function is found, that element or
726 object type will simply be ignored, along with any blank line or
727 white space at its end. The same will happen if the function
728 returns the nil value. If that function returns the empty
729 string, the type will be ignored, but the blank lines or white
730 spaces will be kept.
732 In addition to element and object types, one function can be
733 associated to the `template' symbol and another one to the
734 `plain-text' symbol.
736 The former returns the final transcoded string, and can be used
737 to add a preamble and a postamble to document's body. It must
738 accept two arguments: the transcoded string and the property list
739 containing export options.
741 The latter, when defined, is to be called on every text not
742 recognized as an element or an object. It must accept two
743 arguments: the text string and the information channel. It is an
744 appropriate place to protect special chars relative to the
745 back-end.
747 BODY can start with pre-defined keyword arguments. The following
748 keywords are understood:
750 :export-block
752 String, or list of strings, representing block names that
753 will not be parsed. This is used to specify blocks that will
754 contain raw code specific to the back-end. These blocks
755 still have to be handled by the relative `export-block' type
756 translator.
758 :filters-alist
760 Alist between filters and function, or list of functions,
761 specific to the back-end. See `org-export-filters-alist' for
762 a list of all allowed filters. Filters defined here
763 shouldn't make a back-end test, as it may prevent back-ends
764 derived from this one to behave properly.
766 :menu-entry
768 Menu entry for the export dispatcher. It should be a list
769 like:
771 \(KEY DESCRIPTION ACTION-OR-MENU)
773 where :
775 KEY is a free character selecting the back-end.
776 DESCRIPTION is a string naming the back-end.
777 ACTION-OR-MENU is either a function or an alist.
779 If it is an action, it will be called with three arguments:
780 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
781 for further explanations.
783 If it is an alist, associations should follow the
784 pattern:
786 \(KEY DESCRIPTION ACTION)
788 where KEY, DESCRIPTION and ACTION are described above.
790 Valid values include:
794 or
801 \(lambda (subtree visible body-only)
802 \(org-open-file
803 \(org-e-latex-export-to-pdf subtree visible body-only))))))
805 :options-alist
807 Alist between back-end specific properties introduced in
808 communication channel and how their value are acquired. See
809 `org-export-options-alist' for more information about
810 structure of the values."
825 ;; Define translators.
828 ;; Define options.
832 See `org-export-options-alist' for more information on the
833 structure of the values."
834 backend)))
835 ;; Define filters.
838 "Alist between filters keywords and back-end specific filters.
840 ;; Tell parser to not parse EXPORT-BLOCK blocks.
847 ;; Add an entry for back-end in `org-export-dispatch'.
851 ;; Splice in the body, if any.
855 "Create a new back-end as a variant of an existing one.
857 CHILD is the name of the derived back-end. PARENT is the name of
858 the parent back-end.
860 BODY can start with pre-defined keyword arguments. The following
861 keywords are understood:
863 :export-block
865 String, or list of strings, representing block names that
866 will not be parsed. This is used to specify blocks that will
867 contain raw code specific to the back-end. These blocks
868 still have to be handled by the relative `export-block' type
869 translator.
871 :filters-alist
873 Alist of filters that will overwrite or complete filters
874 defined in PARENT back-end. See `org-export-filters-alist'
875 for a list of allowed filters.
877 :menu-entry
879 Menu entry for the export dispatcher. See
880 `org-export-define-backend' for more information about the
881 expected value.
883 :options-alist
885 Alist of back-end specific properties that will overwrite or
886 complete those defined in PARENT back-end. Refer to
887 `org-export-options-alist' for more information about
888 structure of the values.
890 :sub-menu-entry
892 Append entries to an existing menu in the export dispatcher.
893 The associated value should be a list whose CAR is the
894 character selecting the menu to expand and CDR a list of
895 entries following the pattern:
897 \(KEY DESCRIPTION ACTION)
899 where KEY is a free character triggering the action,
900 DESCRIPTION is a string defining the action, and ACTION is
901 a function that will be called with three arguments:
902 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
903 for further explanations.
905 Valid values include:
909 \(lambda (s v b)
910 \(org-open-file (org-e-beamer-export-to-pdf s v b)))))
912 :translate-alist
914 Alist of element and object types and transcoders that will
915 overwrite or complete transcode table from PARENT back-end.
916 Refer to `org-export-define-backend' for detailed information
917 about transcoders.
920 as a variant of `e-latex' back-end with a custom template
921 function:
923 \(org-export-define-derived-backend my-latex e-latex
924 :translate-alist ((template . my-latex-template-fun)))
926 The back-end could then be called with, for example:
945 ;; Tell parser to not parse EXPORT-BLOCK blocks.
952 ;; Define filters.
959 "Alist between filters keywords and back-end specific filters.
961 ;; Define options.
969 See `org-export-options-alist' for more information on the
970 structure of the values."
971 child))))
972 ;; Define translators.
979 ;; Add an entry for back-end in `org-export-dispatch'.
985 org-export-dispatch-menu-entries))))
989 ;; Splice in the body, if any.
993 "Signal an error if BACKEND isn't defined."
998 \f
999 ;;; The Communication Channel
1000 ;;
1001 ;; During export process, every function has access to a number of
1002 ;; properties. They are of two types:
1003 ;;
1004 ;; 1. Environment options are collected once at the very beginning of
1005 ;; the process, out of the original buffer and configuration.
1006 ;; Collecting them is handled by `org-export-get-environment'
1007 ;; function.
1008 ;;
1009 ;; Most environment options are defined through the
1010 ;; `org-export-options-alist' variable.
1011 ;;
1012 ;; 2. Tree properties are extracted directly from the parsed tree,
1013 ;; just before export, by `org-export-collect-tree-properties'.
1014 ;;
1015 ;; Here is the full list of properties available during transcode
1016 ;; process, with their category and their value type.
1017 ;;
1018 ;; + `:author' :: Author's name.
1019 ;; - category :: option
1020 ;; - type :: string
1021 ;;
1022 ;; + `:back-end' :: Current back-end used for transcoding.
1023 ;; - category :: tree
1024 ;; - type :: symbol
1025 ;;
1026 ;; + `:creator' :: String to write as creation information.
1027 ;; - category :: option
1028 ;; - type :: string
1029 ;;
1030 ;; + `:date' :: String to use as date.
1031 ;; - category :: option
1032 ;; - type :: string
1033 ;;
1034 ;; + `:description' :: Description text for the current data.
1035 ;; - category :: option
1036 ;; - type :: string
1037 ;;
1038 ;; + `:email' :: Author's email.
1039 ;; - category :: option
1040 ;; - type :: string
1041 ;;
1042 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1043 ;; process.
1044 ;; - category :: option
1045 ;; - type :: list of strings
1046 ;;
1047 ;; + `:exported-data' :: Hash table used for memoizing
1048 ;; `org-export-data'.
1049 ;; - category :: tree
1050 ;; - type :: hash table
1051 ;;
1052 ;; + `:filetags' :: List of global tags for buffer. Used by
1053 ;; `org-export-get-tags' to get tags with inheritance.
1054 ;; - category :: option
1055 ;; - type :: list of strings
1056 ;;
1057 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1058 ;; their definition, as parsed data. Only non-inlined footnotes
1059 ;; are represented in this alist. Also, every definition isn't
1060 ;; guaranteed to be referenced in the parse tree. The purpose of
1061 ;; this property is to preserve definitions from oblivion
1062 ;; (i.e. when the parse tree comes from a part of the original
1063 ;; buffer), it isn't meant for direct use in a back-end. To
1064 ;; retrieve a definition relative to a reference, use
1065 ;; `org-export-get-footnote-definition' instead.
1066 ;; - category :: option
1067 ;; - type :: alist (STRING . LIST)
1068 ;;
1069 ;; + `:headline-levels' :: Maximum level being exported as an
1070 ;; headline. Comparison is done with the relative level of
1071 ;; headlines in the parse tree, not necessarily with their
1072 ;; actual level.
1073 ;; - category :: option
1074 ;; - type :: integer
1075 ;;
1076 ;; + `:headline-offset' :: Difference between relative and real level
1077 ;; of headlines in the parse tree. For example, a value of -1
1078 ;; means a level 2 headline should be considered as level
1079 ;; 1 (cf. `org-export-get-relative-level').
1080 ;; - category :: tree
1081 ;; - type :: integer
1082 ;;
1083 ;; + `:headline-numbering' :: Alist between headlines and their
1084 ;; numbering, as a list of numbers
1085 ;; (cf. `org-export-get-headline-number').
1086 ;; - category :: tree
1087 ;; - type :: alist (INTEGER . LIST)
1088 ;;
1089 ;; + `:id-alist' :: Alist between ID strings and destination file's
1090 ;; path, relative to current directory. It is used by
1091 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1092 ;; external file.
1093 ;; - category :: option
1094 ;; - type :: alist (STRING . STRING)
1095 ;;
1096 ;; + `:ignore-list' :: List of elements and objects that should be
1097 ;; ignored during export.
1098 ;; - category :: tree
1099 ;; - type :: list of elements and objects
1100 ;;
1101 ;; + `:input-file' :: Full path to input file, if any.
1102 ;; - category :: option
1103 ;; - type :: string or nil
1104 ;;
1105 ;; + `:keywords' :: List of keywords attached to data.
1106 ;; - category :: option
1107 ;; - type :: string
1108 ;;
1109 ;; + `:language' :: Default language used for translations.
1110 ;; - category :: option
1111 ;; - type :: string
1112 ;;
1113 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1114 ;; transcoding.
1115 ;; - category :: option
1116 ;; - type :: list (as returned by `org-element-parse-buffer')
1117 ;;
1118 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1119 ;; all line breaks.
1120 ;; - category :: option
1121 ;; - type :: symbol (nil, t)
1122 ;;
1123 ;; + `:section-numbers' :: Non-nil means transcoding should add
1124 ;; section numbers to headlines.
1125 ;; - category :: option
1126 ;; - type :: symbol (nil, t)
1127 ;;
1128 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1129 ;; in transcoding. When such a tag is present, subtrees without
1130 ;; it are de facto excluded from the process. See
1131 ;; `use-select-tags'.
1132 ;; - category :: option
1133 ;; - type :: list of strings
1134 ;;
1135 ;; + `:target-list' :: List of targets encountered in the parse tree.
1136 ;; This is used to partly resolve "fuzzy" links
1137 ;; (cf. `org-export-resolve-fuzzy-link').
1138 ;; - category :: tree
1139 ;; - type :: list of strings
1140 ;;
1141 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1142 ;; a time stamp in the output.
1143 ;; - category :: option
1144 ;; - type :: symbol (nil, t)
1145 ;;
1146 ;; + `:translate-alist' :: Alist between element and object types and
1147 ;; transcoding functions relative to the current back-end.
1148 ;; Special keys `template' and `plain-text' are also possible.
1149 ;; - category :: option
1150 ;; - type :: alist (SYMBOL . FUNCTION)
1151 ;;
1152 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1153 ;; also be transcoded. If it is set to the `headline' symbol,
1154 ;; only the archived headline's name is retained.
1155 ;; - category :: option
1156 ;; - type :: symbol (nil, t, `headline')
1157 ;;
1158 ;; + `:with-author' :: Non-nil means author's name should be included
1159 ;; in the output.
1160 ;; - category :: option
1161 ;; - type :: symbol (nil, t)
1162 ;;
1163 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
1164 ;; - category :: option
1165 ;; - type :: symbol (nil, t)
1166 ;;
1167 ;; + `:with-creator' :: Non-nild means a creation sentence should be
1168 ;; inserted at the end of the transcoded string. If the value
1169 ;; is `comment', it should be commented.
1170 ;; - category :: option
1171 ;; - type :: symbol (`comment', nil, t)
1172 ;;
1173 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1174 ;; its value is a list of names, only drawers with such names
1175 ;; will be transcoded.
1176 ;; - category :: option
1177 ;; - type :: symbol (nil, t) or list of strings
1178 ;;
1179 ;; + `:with-email' :: Non-nil means output should contain author's
1180 ;; email.
1181 ;; - category :: option
1182 ;; - type :: symbol (nil, t)
1183 ;;
1184 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1185 ;; interpreted.
1186 ;; - category :: option
1187 ;; - type :: symbol (nil, t)
1188 ;;
1189 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1190 ;; strings starting with a colon as a fixed-with (verbatim) area.
1191 ;; - category :: option
1192 ;; - type :: symbol (nil, t)
1193 ;;
1194 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1195 ;; footnotes.
1196 ;; - category :: option
1197 ;; - type :: symbol (nil, t)
1198 ;;
1199 ;; + `:with-plannings' :: Non-nil means transcoding should include
1200 ;; planning info.
1201 ;; - category :: option
1202 ;; - type :: symbol (nil, t)
1203 ;;
1204 ;; + `:with-priority' :: Non-nil means transcoding should include
1205 ;; priority cookies.
1206 ;; - category :: option
1207 ;; - type :: symbol (nil, t)
1208 ;;
1209 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1210 ;; plain text.
1211 ;; - category :: option
1212 ;; - type :: symbol (nil, t)
1213 ;;
1214 ;; + `:with-special-strings' :: Non-nil means transcoding should
1215 ;; interpret special strings in plain text.
1216 ;; - category :: option
1217 ;; - type :: symbol (nil, t)
1218 ;;
1219 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1220 ;; interpret subscript and superscript. With a value of "{}",
1221 ;; only interpret those using curly brackets.
1222 ;; - category :: option
1223 ;; - type :: symbol (nil, {}, t)
1224 ;;
1225 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1226 ;; tables.
1227 ;; - category :: option
1228 ;; - type :: symbol (nil, t)
1229 ;;
1230 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1231 ;; headlines. A `not-in-toc' value will remove them from the
1232 ;; table of contents, if any, nonetheless.
1233 ;; - category :: option
1234 ;; - type :: symbol (nil, t, `not-in-toc')
1235 ;;
1236 ;; + `:with-tasks' :: Non-nil means transcoding should include
1237 ;; headlines with a TODO keyword. A `todo' value will only
1238 ;; include headlines with a todo type keyword while a `done'
1239 ;; value will do the contrary. If a list of strings is provided,
1240 ;; only tasks with keywords belonging to that list will be kept.
1241 ;; - category :: option
1242 ;; - type :: symbol (t, todo, done, nil) or list of strings
1243 ;;
1244 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1245 ;; time stamps. Special value `active' (resp. `inactive') ask to
1246 ;; export only active (resp. inactive) timestamps. Otherwise,
1247 ;; completely remove them.
1248 ;; - category :: option
1249 ;; - type :: symbol: (`active', `inactive', t, nil)
1250 ;;
1251 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1252 ;; added to the output. An integer value limits its depth.
1253 ;; - category :: option
1254 ;; - type :: symbol (nil, t or integer)
1255 ;;
1256 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1257 ;; include TODO keywords.
1258 ;; - category :: option
1259 ;; - type :: symbol (nil, t)
1262 ;;;; Environment Options
1263 ;;
1264 ;; Environment options encompass all parameters defined outside the
1265 ;; scope of the parsed data. They come from five sources, in
1266 ;; increasing precedence order:
1267 ;;
1268 ;; - Global variables,
1269 ;; - Buffer's attributes,
1270 ;; - Options keyword symbols,
1271 ;; - Buffer keywords,
1272 ;; - Subtree properties.
1273 ;;
1274 ;; The central internal function with regards to environment options
1275 ;; is `org-export-get-environment'. It updates global variables with
1276 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1277 ;; the different sources.
1278 ;;
1279 ;; The internal functions doing the retrieval are:
1280 ;; `org-export--get-global-options',
1281 ;; `org-export--get-buffer-attributes',
1282 ;; `org-export--parse-option-keyword',
1283 ;; `org-export--get-subtree-options' and
1284 ;; `org-export--get-inbuffer-options'
1285 ;;
1286 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1287 ;; take care of the part relative to "#+BIND:" keywords.
1290 "Collect export options from the current buffer.
1292 Optional argument BACKEND is a symbol specifying which back-end
1293 specific options to read, if any.
1295 When optional argument SUBTREEP is non-nil, assume the export is
1296 done against the current sub-tree.
1298 Third optional argument EXT-PLIST is a property list with
1299 external parameters overriding Org default settings, but still
1300 inferior to file-local settings."
1301 ;; First install #+BIND variables.
1303 ;; Get and prioritize export options...
1305 ;; ... from global variables...
1307 ;; ... from an external property list...
1308 ext-plist
1309 ;; ... from in-buffer settings...
1311 backend
1313 ;; ... and from subtree, when appropriate.
1315 ;; Eventually add misc. properties.
1317 :back-end
1318 backend
1319 :translate-alist
1322 :footnote-definition-alist
1323 ;; Footnotes definitions must be collected in the original
1324 ;; buffer, as there's no insurance that they will still be in
1325 ;; the parse tree, due to possible narrowing.
1339 alist))))
1340 alist))
1341 :id-alist
1342 ;; Collect id references.
1353 alist))))
1356 "Parse an OPTIONS line and return values as a plist.
1357 Optional argument BACKEND is a symbol specifying which back-end
1358 specific items to read, if any."
1365 ;; Build an alist between #+OPTION: item and property-name.
1370 all)))
1371 plist)
1376 options)
1381 alist)
1382 plist))
1385 "Get export options in subtree at point.
1386 Optional argument BACKEND is a symbol specifying back-end used
1387 for export. Return options as a plist."
1388 ;; For each buffer keyword, create an headline property setting the
1389 ;; same property in communication channel. The name for the property
1390 ;; is the keyword with "EXPORT_" appended to it.
1393 ;; Make sure point is at an heading.
1395 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1396 ;; title as its fallback value.
1403 plist :title
1406 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1410 ;; Handle other keywords. TITLE keyword is excluded as it has
1411 ;; been handled already.
1418 ;; Export properties are not case-sensitive.
1425 plist
1427 ;; Parse VALUE if required.
1431 value))))))))
1432 ;; Also look for both general keywords and back-end specific
1433 ;; options if BACKEND is provided.
1438 org-export-options-alist)))
1439 ;; Return value.
1440 plist)))
1443 "Return current buffer export options, as a plist.
1445 Optional argument BACKEND, when non-nil, is a symbol specifying
1446 which back-end specific options should also be read in the
1447 process.
1449 Optional argument FILES is a list of setup files names read so
1450 far, used to avoid circular dependencies.
1452 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1456 ;; 1. Special keywords, as in `org-export-special-keywords'.
1470 ;; Avoid circular dependencies.
1485 ;; 2. Standard options, as in `org-export-options-alist'.
1487 ;; Also look for back-end specific options
1488 ;; if BACKEND is defined.
1494 ;; Build ALIST between keyword name and property name.
1498 all)))
1499 ;; Build regexp matching all keywords associated to export
1500 ;; options. Note: the search is case insensitive.
1514 plist prop
1515 ;; Handle value depending on specified BEHAVIOUR.
1528 ;; Parse keywords specified in
1529 ;; `org-element-document-properties'.
1537 plist prop
1540 org-element-document-properties))
1541 ;; 3. Return final value.
1542 plist)))
1545 "Return properties related to buffer attributes, as a plist."
1548 ;; Store full path of input file name, or nil. For internal use.
1549 :input-file visited-file
1556 "Return global export options as a plist.
1558 Optional argument BACKEND, if non-nil, is a symbol specifying
1559 which back-end specific export options should also be read in the
1560 process."
1566 ;; Output value.
1567 plist)
1572 plist
1574 ;; Eval default value provided. If keyword is a member
1575 ;; of `org-element-document-properties', parse it as
1576 ;; a secondary string before storing it.
1581 value
1584 all)
1585 ;; Return value.
1586 plist))
1590 "Can we use #+BIND values during export?
1591 By default this will ask for confirmation by the user, to divert
1592 possible security risks."
1597 org-export--allow-BIND-local)
1602 "Install the values from #+BIND lines as local variables.
1603 Variables must be installed before in-buffer options are
1604 retrieved."
1619 ;;;; Tree Properties
1620 ;;
1621 ;; Tree properties are information extracted from parse tree. They
1622 ;; are initialized at the beginning of the transcoding process by
1623 ;; `org-export-collect-tree-properties'.
1624 ;;
1625 ;; Dedicated functions focus on computing the value of specific tree
1626 ;; properties during initialization. Thus,
1627 ;; `org-export--populate-ignore-list' lists elements and objects that
1628 ;; should be skipped during export, `org-export--get-min-level' gets
1629 ;; the minimal exportable level, used as a basis to compute relative
1630 ;; level for headlines. Eventually
1631 ;; `org-export--collect-headline-numbering' builds an alist between
1632 ;; headlines and their numbering.
1635 "Extract tree properties from parse tree.
1637 DATA is the parse tree from which information is retrieved. INFO
1638 is a list holding export options.
1640 Following tree properties are set or updated:
1642 `:exported-data' Hash table used to memoize results from
1643 `org-export-data'.
1645 `:footnote-definition-alist' List of footnotes definitions in
1646 original buffer and current parse tree.
1648 `:headline-offset' Offset between true level of headlines and
1649 local level. An offset of -1 means an headline
1650 of level 2 should be considered as a level
1651 1 headline in the context.
1653 `:headline-numbering' Alist of all headlines as key an the
1654 associated numbering as value.
1656 `:ignore-list' List of elements that should be ignored during
1657 export.
1659 `:target-list' List of all targets in the parse tree.
1661 Return updated plist."
1662 ;; Install the parse tree in the communication channel, in order to
1663 ;; use `org-export-get-genealogy' and al.
1665 ;; Get the list of elements and objects to ignore, and put it into
1666 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1667 ;; been done during parse tree filtering.
1670 :ignore-list
1673 ;; Compute `:headline-offset' in order to be able to use
1674 ;; `org-export-get-relative-level'.
1677 :headline-offset
1679 ;; Update footnotes definitions list with definitions in parse tree.
1680 ;; This is required since buffer expansion might have modified
1681 ;; boundaries of footnote definitions contained in the parse tree.
1682 ;; This way, definitions in `footnote-definition-alist' are bound to
1683 ;; match those in the parse tree.
1686 data 'footnote-definition
1690 defs)))
1692 ;; Properties order doesn't matter: get the rest of the tree
1693 ;; properties.
1695 `(:target-list
1704 info))
1707 "Return minimum exportable headline's level in DATA.
1708 DATA is parsed tree as returned by `org-element-parse-buffer'.
1709 OPTIONS is a plist holding export options."
1720 ;; If no headline was found, for the sake of consistency, set
1721 ;; minimum level to 1 nonetheless.
1725 "Return numbering of all exportable headlines in a parse tree.
1727 DATA is the parse tree. OPTIONS is the plist holding export
1728 options.
1730 Return an alist whose key is an headline and value is its
1731 associated numbering \(in the shape of a list of numbers\)."
1734 data
1735 'headline
1740 headline
1742 for idx from 0 to org-export-max-depth
1746 options)))
1749 "Return list of elements and objects to ignore during export.
1750 DATA is the parse tree to traverse. OPTIONS is the plist holding
1751 export options."
1753 walk-data
1754 ;; First find trees containing a select tag, if any.
1758 ;; Collect ignored elements or objects into IGNORE-LIST.
1764 ;; If headline is archived but tree below has
1765 ;; to be skipped, add it to ignore list.
1768 ;; Move into secondary string, if any.
1773 ;; Move into recursive objects/elements.
1775 ;; Main call.
1777 ;; Return value.
1778 ignore))
1781 "Return list of headlines containing a select tag in their tree.
1782 DATA is parsed data as returned by `org-element-parse-buffer'.
1783 INFO is a plist holding export options."
1785 walk-data ; for byte-compiler.
1796 ;; When a select tag is found, mark full
1797 ;; genealogy and every headline within the tree
1798 ;; as acceptable.
1801 genealogy
1803 selected-trees))
1804 ;; Else, continue searching in tree, recursively.
1811 "Non-nil when element or object BLOB should be skipped during export.
1812 OPTIONS is the plist holding export options. SELECTED, when
1813 non-nil, is a list of headlines belonging to a tree with a select
1814 tag."
1829 ;; Ignore subtrees with an exclude tag.
1832 ;; When a select tag is present in the buffer, ignore any tree
1833 ;; without it.
1835 ;; Ignore commented sub-trees.
1837 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1839 ;; Ignore tasks, if specified by `:with-tasks' property.
1855 ;; No timestamp allowed.
1857 ;; Only active timestamps allowed and the current one isn't
1858 ;; active.
1862 ;; Only inactive timestamps allowed and the current one isn't
1863 ;; inactive.
1869 \f
1870 ;;; The Transcoder
1871 ;;
1872 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1873 ;; `org-element-parse-buffer') and transcodes it into a specified
1874 ;; back-end output. It takes care of filtering out elements or
1875 ;; objects according to export options and organizing the output blank
1876 ;; lines and white space are preserved. The function memoizes its
1877 ;; results, so it is cheap to call it within translators.
1878 ;;
1879 ;; Internally, three functions handle the filtering of objects and
1880 ;; elements during the export. In particular,
1881 ;; `org-export-ignore-element' marks an element or object so future
1882 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1883 ;; elements or objects should be seen as real Org syntax and
1884 ;; `org-export-expand' transforms the others back into their original
1885 ;; shape
1886 ;;
1887 ;; `org-export-transcoder' is an accessor returning appropriate
1888 ;; translator function for a given element or object.
1891 "Return appropriate transcoder for BLOB.
1892 INFO is a plist containing export directives."
1894 ;; Return contents only for complete parse trees.
1900 "Convert DATA into current back-end format.
1902 DATA is a parse tree, an element or an object or a secondary
1903 string. INFO is a plist holding export options.
1905 Return transcoded string."
1911 ;; Ignored element/object.
1913 ;; Plain text. All residual text properties from parse
1914 ;; tree (i.e. `:parent' property) are removed.
1921 info)))
1922 ;; Uninterpreted element/object: change it back to Org
1923 ;; syntax and export again resulting raw string.
1927 data
1931 info))
1932 ;; Secondary string.
1935 ;; Element/Object without contents or, as a special case,
1936 ;; headline with archive tag and archived trees restricted
1937 ;; to title only.
1945 ;; Element/Object with contents.
1958 ;; Elements directly containing objects
1959 ;; must have their indentation normalized
1960 ;; first.
1962 data
1963 ;; When normalizing contents of the first
1964 ;; paragraph in an item or a footnote
1965 ;; definition, ignore first line's
1966 ;; indentation: there is none and it
1967 ;; might be misleading.
1972 data)
1979 info))))))))
1980 ;; Final result will be memoized before being returned.
1982 data
1986 ;; Append the same white space between elements or objects as in
1987 ;; the original buffer, and call appropriate filters.
1998 info)))
1999 results)))
2003 "Non-nil if element or object BLOB should be interpreted as Org syntax.
2004 Check is done according to export options INFO, stored as
2005 a plist."
2007 ;; ... entities...
2009 ;; ... emphasis...
2011 ;; ... fixed-width areas.
2013 ;; ... footnotes...
2016 ;; ... sub/superscripts...
2022 ;; ... tables...
2027 "Expand a parsed element or object to its original state.
2028 BLOB is either an element or an object. CONTENTS is its
2029 contents, as a string or nil."
2032 blob contents))
2035 "Add ELEMENT to `:ignore-list' in INFO.
2037 Any element in `:ignore-list' will be skipped when using
2038 `org-element-map'. INFO is modified by side effects."
2042 \f
2043 ;;; The Filter System
2044 ;;
2045 ;; Filters allow end-users to tweak easily the transcoded output.
2046 ;; They are the functional counterpart of hooks, as every filter in
2047 ;; a set is applied to the return value of the previous one.
2048 ;;
2049 ;; Every set is back-end agnostic. Although, a filter is always
2050 ;; called, in addition to the string it applies to, with the back-end
2051 ;; used as argument, so it's easy for the end-user to add back-end
2052 ;; specific filters in the set. The communication channel, as
2053 ;; a plist, is required as the third argument.
2054 ;;
2055 ;; From the developer side, filters sets can be installed in the
2056 ;; process with the help of `org-export-define-backend', which
2057 ;; internally sets `org-BACKEND-filters-alist' variable. Each
2058 ;; association has a key among the following symbols and a function or
2059 ;; a list of functions as value.
2060 ;;
2061 ;; - `:filter-parse-tree' applies directly on the complete parsed
2062 ;; tree. It's the only filters set that doesn't apply to a string.
2063 ;; Users can set it through `org-export-filter-parse-tree-functions'
2064 ;; variable.
2065 ;;
2066 ;; - `:filter-final-output' applies to the final transcoded string.
2067 ;; Users can set it with `org-export-filter-final-output-functions'
2068 ;; variable
2069 ;;
2070 ;; - `:filter-plain-text' applies to any string not recognized as Org
2071 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2072 ;; configure it.
2073 ;;
2074 ;; - `:filter-TYPE' applies on the string returned after an element or
2075 ;; object of type TYPE has been transcoded. An user can modify
2076 ;; `org-export-filter-TYPE-functions'
2077 ;;
2078 ;; All filters sets are applied with
2079 ;; `org-export-filter-apply-functions' function. Filters in a set are
2080 ;; applied in a LIFO fashion. It allows developers to be sure that
2081 ;; their filters will be applied first.
2082 ;;
2083 ;; Filters properties are installed in communication channel with
2084 ;; `org-export-install-filters' function.
2085 ;;
2086 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2087 ;; `org-export-before-parsing-hook') are run at the beginning of the
2088 ;; export process and just before parsing to allow for heavy structure
2089 ;; modifications.
2092 ;;;; Hooks
2095 "Hook run at the beginning of the export process.
2097 This is run before include keywords and macros are expanded and
2098 Babel code blocks executed, on a copy of the original buffer
2099 being exported. Visibility and narrowing are preserved. Point
2100 is at the beginning of the buffer.
2102 Every function in this hook will be called with one argument: the
2106 "Hook run before parsing an export buffer.
2108 This is run after include keywords and macros have been expanded
2109 and Babel code blocks executed, on a copy of the original buffer
2110 being exported. Visibility and narrowing are preserved. Point
2111 is at the beginning of the buffer.
2113 Every function in this hook will be called with one argument: the
2117 ;;;; Special Filters
2120 "List of functions applied to the parsed tree.
2121 Each filter is called with three arguments: the parse tree, as
2122 returned by `org-element-parse-buffer', the back-end, as
2123 a symbol, and the communication channel, as a plist. It must
2127 "List of functions applied to the transcoded string.
2128 Each filter is called with three arguments: the full transcoded
2129 string, the back-end, as a symbol, and the communication channel,
2130 as a plist. It must return a string that will be used as the
2134 "List of functions applied to plain text.
2135 Each filter is called with three arguments: a string which
2136 contains no Org syntax, the back-end, as a symbol, and the
2137 communication channel, as a plist. It must return a string or
2141 ;;;; Elements Filters
2144 "List of functions applied to a transcoded babel-call.
2145 Each filter is called with three arguments: the transcoded data,
2146 as a string, the back-end, as a symbol, and the communication
2150 "List of functions applied to a transcoded center block.
2151 Each filter is called with three arguments: the transcoded data,
2152 as a string, the back-end, as a symbol, and the communication
2156 "List of functions applied to a transcoded clock.
2157 Each filter is called with three arguments: the transcoded data,
2158 as a string, the back-end, as a symbol, and the communication
2162 "List of functions applied to a transcoded comment.
2163 Each filter is called with three arguments: the transcoded data,
2164 as a string, the back-end, as a symbol, and the communication
2168 "List of functions applied to a transcoded comment-block.
2169 Each filter is called with three arguments: the transcoded data,
2170 as a string, the back-end, as a symbol, and the communication
2174 "List of functions applied to a transcoded diary-sexp.
2175 Each filter is called with three arguments: the transcoded data,
2176 as a string, the back-end, as a symbol, and the communication
2180 "List of functions applied to a transcoded drawer.
2181 Each filter is called with three arguments: the transcoded data,
2182 as a string, the back-end, as a symbol, and the communication
2186 "List of functions applied to a transcoded dynamic-block.
2187 Each filter is called with three arguments: the transcoded data,
2188 as a string, the back-end, as a symbol, and the communication
2192 "List of functions applied to a transcoded example-block.
2193 Each filter is called with three arguments: the transcoded data,
2194 as a string, the back-end, as a symbol, and the communication
2198 "List of functions applied to a transcoded export-block.
2199 Each filter is called with three arguments: the transcoded data,
2200 as a string, the back-end, as a symbol, and the communication
2204 "List of functions applied to a transcoded fixed-width.
2205 Each filter is called with three arguments: the transcoded data,
2206 as a string, the back-end, as a symbol, and the communication
2210 "List of functions applied to a transcoded footnote-definition.
2211 Each filter is called with three arguments: the transcoded data,
2212 as a string, the back-end, as a symbol, and the communication
2216 "List of functions applied to a transcoded headline.
2217 Each filter is called with three arguments: the transcoded data,
2218 as a string, the back-end, as a symbol, and the communication
2222 "List of functions applied to a transcoded horizontal-rule.
2223 Each filter is called with three arguments: the transcoded data,
2224 as a string, the back-end, as a symbol, and the communication
2228 "List of functions applied to a transcoded inlinetask.
2229 Each filter is called with three arguments: the transcoded data,
2230 as a string, the back-end, as a symbol, and the communication
2234 "List of functions applied to a transcoded item.
2235 Each filter is called with three arguments: the transcoded data,
2236 as a string, the back-end, as a symbol, and the communication
2240 "List of functions applied to a transcoded keyword.
2241 Each filter is called with three arguments: the transcoded data,
2242 as a string, the back-end, as a symbol, and the communication
2246 "List of functions applied to a transcoded latex-environment.
2247 Each filter is called with three arguments: the transcoded data,
2248 as a string, the back-end, as a symbol, and the communication
2252 "List of functions applied to a transcoded node-property.
2253 Each filter is called with three arguments: the transcoded data,
2254 as a string, the back-end, as a symbol, and the communication
2258 "List of functions applied to a transcoded paragraph.
2259 Each filter is called with three arguments: the transcoded data,
2260 as a string, the back-end, as a symbol, and the communication
2264 "List of functions applied to a transcoded plain-list.
2265 Each filter is called with three arguments: the transcoded data,
2266 as a string, the back-end, as a symbol, and the communication
2270 "List of functions applied to a transcoded planning.
2271 Each filter is called with three arguments: the transcoded data,
2272 as a string, the back-end, as a symbol, and the communication
2276 "List of functions applied to a transcoded property-drawer.
2277 Each filter is called with three arguments: the transcoded data,
2278 as a string, the back-end, as a symbol, and the communication
2282 "List of functions applied to a transcoded quote block.
2283 Each filter is called with three arguments: the transcoded quote
2284 data, as a string, the back-end, as a symbol, and the
2285 communication channel, as a plist. It must return a string or
2289 "List of functions applied to a transcoded quote-section.
2290 Each filter is called with three arguments: the transcoded data,
2291 as a string, the back-end, as a symbol, and the communication
2295 "List of functions applied to a transcoded section.
2296 Each filter is called with three arguments: the transcoded data,
2297 as a string, the back-end, as a symbol, and the communication
2301 "List of functions applied to a transcoded special block.
2302 Each filter is called with three arguments: the transcoded data,
2303 as a string, the back-end, as a symbol, and the communication
2307 "List of functions applied to a transcoded src-block.
2308 Each filter is called with three arguments: the transcoded data,
2309 as a string, the back-end, as a symbol, and the communication
2313 "List of functions applied to a transcoded table.
2314 Each filter is called with three arguments: the transcoded data,
2315 as a string, the back-end, as a symbol, and the communication
2319 "List of functions applied to a transcoded table-cell.
2320 Each filter is called with three arguments: the transcoded data,
2321 as a string, the back-end, as a symbol, and the communication
2325 "List of functions applied to a transcoded table-row.
2326 Each filter is called with three arguments: the transcoded data,
2327 as a string, the back-end, as a symbol, and the communication
2331 "List of functions applied to a transcoded verse block.
2332 Each filter is called with three arguments: the transcoded data,
2333 as a string, the back-end, as a symbol, and the communication
2337 ;;;; Objects Filters
2340 "List of functions applied to transcoded bold text.
2341 Each filter is called with three arguments: the transcoded data,
2342 as a string, the back-end, as a symbol, and the communication
2346 "List of functions applied to transcoded code text.
2347 Each filter is called with three arguments: the transcoded data,
2348 as a string, the back-end, as a symbol, and the communication
2352 "List of functions applied to a transcoded entity.
2353 Each filter is called with three arguments: the transcoded data,
2354 as a string, the back-end, as a symbol, and the communication
2358 "List of functions applied to a transcoded export-snippet.
2359 Each filter is called with three arguments: the transcoded data,
2360 as a string, the back-end, as a symbol, and the communication
2364 "List of functions applied to a transcoded footnote-reference.
2365 Each filter is called with three arguments: the transcoded data,
2366 as a string, the back-end, as a symbol, and the communication
2370 "List of functions applied to a transcoded inline-babel-call.
2371 Each filter is called with three arguments: the transcoded data,
2372 as a string, the back-end, as a symbol, and the communication
2376 "List of functions applied to a transcoded inline-src-block.
2377 Each filter is called with three arguments: the transcoded data,
2378 as a string, the back-end, as a symbol, and the communication
2382 "List of functions applied to transcoded italic text.
2383 Each filter is called with three arguments: the transcoded data,
2384 as a string, the back-end, as a symbol, and the communication
2388 "List of functions applied to a transcoded latex-fragment.
2389 Each filter is called with three arguments: the transcoded data,
2390 as a string, the back-end, as a symbol, and the communication
2394 "List of functions applied to a transcoded line-break.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2400 "List of functions applied to a transcoded link.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2406 "List of functions applied to a transcoded macro.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2412 "List of functions applied to a transcoded radio-target.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2418 "List of functions applied to a transcoded statistics-cookie.
2419 Each filter is called with three arguments: the transcoded data,
2420 as a string, the back-end, as a symbol, and the communication
2424 "List of functions applied to transcoded strike-through text.
2425 Each filter is called with three arguments: the transcoded data,
2426 as a string, the back-end, as a symbol, and the communication
2430 "List of functions applied to a transcoded subscript.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2436 "List of functions applied to a transcoded superscript.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2442 "List of functions applied to a transcoded target.
2443 Each filter is called with three arguments: the transcoded data,
2444 as a string, the back-end, as a symbol, and the communication
2448 "List of functions applied to a transcoded timestamp.
2449 Each filter is called with three arguments: the transcoded data,
2450 as a string, the back-end, as a symbol, and the communication
2454 "List of functions applied to transcoded underline text.
2455 Each filter is called with three arguments: the transcoded data,
2456 as a string, the back-end, as a symbol, and the communication
2460 "List of functions applied to transcoded verbatim text.
2461 Each filter is called with three arguments: the transcoded data,
2462 as a string, the back-end, as a symbol, and the communication
2466 ;;;; Filters Tools
2467 ;;
2468 ;; Internal function `org-export-install-filters' installs filters
2469 ;; hard-coded in back-ends (developer filters) and filters from global
2470 ;; variables (user filters) in the communication channel.
2471 ;;
2472 ;; Internal function `org-export-filter-apply-functions' takes care
2473 ;; about applying each filter in order to a given data. It ignores
2474 ;; filters returning a nil value but stops whenever a filter returns
2475 ;; an empty string.
2478 "Call every function in FILTERS.
2480 Functions are called with arguments VALUE, current export
2481 back-end and INFO. A function returning a nil value will be
2482 skipped. If it returns the empty string, the process ends and
2483 VALUE is ignored.
2485 Call is done in a LIFO fashion, to be sure that developer
2486 specified filters, if any, are called first."
2495 "Install filters properties in communication channel.
2497 INFO is a plist containing the current communication channel.
2499 Return the updated communication channel."
2501 ;; Install user defined filters with `org-export-filters-alist'.
2504 org-export-filters-alist)
2505 ;; Prepend back-end specific filters to that list.
2510 ;; Single values get consed, lists are prepended.
2515 plist key
2519 ;; Return new communication channel.
2523 \f
2524 ;;; Core functions
2525 ;;
2526 ;; This is the room for the main function, `org-export-as', along with
2527 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2528 ;; They differ only by the way they output the resulting code.
2529 ;;
2530 ;; `org-export-output-file-name' is an auxiliary function meant to be
2531 ;; used with `org-export-to-file'. With a given extension, it tries
2532 ;; to provide a canonical file name to write export output to.
2533 ;;
2534 ;; Note that `org-export-as' doesn't really parse the current buffer,
2535 ;; but a copy of it (with the same buffer-local variables and
2536 ;; visibility), where macros and include keywords are expanded and
2537 ;; Babel blocks are executed, if appropriate.
2538 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2539 ;;
2540 ;; File inclusion is taken care of by
2541 ;; `org-export-expand-include-keyword' and
2542 ;; `org-export--prepare-file-contents'. Structure wise, including
2543 ;; a whole Org file in a buffer often makes little sense. For
2544 ;; example, if the file contains an headline and the include keyword
2545 ;; was within an item, the item should contain the headline. That's
2546 ;; why file inclusion should be done before any structure can be
2547 ;; associated to the file, that is before parsing.
2548 ;;
2549 ;; Macro are expanded with `org-export-expand-macro'.
2553 "Transcode current Org buffer into BACKEND code.
2555 If narrowing is active in the current buffer, only transcode its
2556 narrowed part.
2558 If a region is active, transcode that region.
2560 When optional argument SUBTREEP is non-nil, transcode the
2561 sub-tree at point, extracting information from the headline
2562 properties first.
2564 When optional argument VISIBLE-ONLY is non-nil, don't export
2565 contents of hidden elements.
2567 When optional argument BODY-ONLY is non-nil, only return body
2568 code, without preamble nor postamble.
2570 Optional argument EXT-PLIST, when provided, is a property list
2571 with external parameters overriding Org default settings, but
2572 still inferior to file-local settings.
2574 Optional argument NOEXPAND, when non-nil, prevents included files
2575 to be expanded and Babel code to be executed.
2577 Return code as a string."
2578 ;; Barf if BACKEND isn't registered.
2582 ;; Narrow buffer to an appropriate region or subtree for
2583 ;; parsing. If parsing subtree, be sure to remove main headline
2584 ;; too.
2592 ;; Initialize communication channel with original buffer
2593 ;; attributes, unavailable in its copy.
2596 ;; Run first hook with current back-end as argument.
2598 ;; Update communication channel and get parse tree. Buffer
2599 ;; isn't parsed directly. Instead, a temporary copy is
2600 ;; created, where include keywords, macros are expanded and
2601 ;; code blocks are evaluated.
2604 ;; Update macro templates since #+INCLUDE keywords might
2605 ;; have added some new ones.
2608 ;; TODO: Setting `org-current-export-file' is required by
2609 ;; Org Babel to properly resolve noweb references. Once
2610 ;; "org-exp.el" is removed, modify
2611 ;; `org-export-blocks-preprocess' so it accepts the value
2612 ;; as an argument instead.
2615 ;; Update radio targets since keyword inclusion might have
2616 ;; added some more.
2618 ;; Run last hook with current back-end as argument.
2621 ;; Update communication channel with environment. Also
2622 ;; install user's and developer's filters.
2627 ;; Expand export-specific set of macros: {{{author}}},
2628 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2629 ;; once regular macros have been expanded, since document
2630 ;; keywords may contain one of them.
2637 ;; EMAIL is not a parsed keyword: store it as-is.
2641 ;; Eventually parse buffer. Call parse-tree filters to get
2642 ;; the final tree.
2647 ;; Now tree is complete, compute its properties and add them
2648 ;; to communication channel.
2652 ;; Eventually transcode TREE. Wrap the resulting string into
2653 ;; a template, if required. Finally call final-output filter.
2662 info)))
2663 ;; Maybe add final OUTPUT to kill ring, then return it.
2666 output)))))
2670 "Call `org-export-as' with output to a specified buffer.
2672 BACKEND is the back-end used for transcoding, as a symbol.
2674 BUFFER is the output buffer. If it already exists, it will be
2675 erased first, otherwise, it will be created.
2677 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2678 and NOEXPAND are similar to those used in `org-export-as', which
2679 see.
2681 Return buffer."
2683 backend subtreep visible-only body-only ext-plist noexpand))
2689 buffer))
2693 "Call `org-export-as' with output to a specified file.
2695 BACKEND is the back-end used for transcoding, as a symbol. FILE
2696 is the name of the output file, as a string.
2698 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2699 and NOEXPAND are similar to those used in `org-export-as', which
2700 see.
2702 Return output file's name."
2703 ;; Checks for FILE permissions. `write-file' would do the same, but
2704 ;; we'd rather avoid needless transcoding of parse tree.
2706 ;; Insert contents to a temporary buffer and write it to FILE.
2708 backend subtreep visible-only body-only ext-plist noexpand)))
2713 ;; Return full path.
2714 file)
2717 "Return output file's name according to buffer specifications.
2719 EXTENSION is a string representing the output file extension,
2720 with the leading dot.
2722 With a non-nil optional argument SUBTREEP, try to determine
2724 of subtree at point.
2726 When optional argument PUB-DIR is set, use it as the publishing
2727 directory.
2729 When optional argument VISIBLE-ONLY is non-nil, don't export
2730 contents of hidden elements.
2732 Return file name as a string, or nil if it couldn't be
2733 determined."
2735 ;; File name may come from EXPORT_FILE_NAME subtree property,
2736 ;; assuming point is at beginning of said sub-tree.
2743 ;; File name may be extracted from buffer's associated
2744 ;; file, if any.
2747 ;; Can't determine file name on our own: Ask user.
2751 "Output file: " pub-dir nil nil nil
2754 ;; Build file name. Enforce EXTENSION over whatever user may have
2755 ;; come up with. PUB-DIR, if defined, always has precedence over
2756 ;; any provided path.
2761 extension))
2766 "Apply BODY in a copy of the current buffer.
2768 The copy preserves local variables and visibility of the original
2769 buffer.
2771 Point is at buffer's beginning when BODY is applied."
2781 ,original-buffer
2793 "Expand every include keyword in buffer.
2794 Optional argument INCLUDED is a list of included file names along
2795 with their line restriction, when appropriate. It is used to
2796 avoid infinite recursion. Optional argument DIR is the current
2797 working directory. It is used to properly resolve relative
2798 paths."
2805 ;; Extract arguments from keyword's value.
2819 ;; Minimal level of included file defaults to the child
2820 ;; level of the current headline, if any, or one. It
2821 ;; only applies is the file is meant to be included as
2822 ;; an Org one.
2830 ;; Remove keyword.
2835 ;; Check if files has already been parsed. Look after
2836 ;; inclusion lines too, as different parts of the same file
2837 ;; can be included too.
2849 ind-str contents ind-str))))
2857 ind-str env contents ind-str))))
2870 "Prepare the contents of FILE for inclusion and return them as a string.
2872 When optional argument LINES is a string specifying a range of
2873 lines, include only those lines.
2875 Optional argument IND, when non-nil, is an integer specifying the
2876 global indentation of returned contents. Since its purpose is to
2877 allow an included file to stay in the same environment it was
2878 created \(i.e. a list item), it doesn't apply past the first
2879 headline encountered.
2881 Optional argument MINLEVEL, when non-nil, is an integer
2882 specifying the level that any top-level headline in the included
2883 file should have."
2899 ;; Remove blank lines at beginning and end of contents. The logic
2900 ;; behind that removal is that blank lines around include keyword
2901 ;; override blank lines in included file.
2910 ;; If IND is set, preserve indentation of include keyword until
2911 ;; the first headline encountered.
2917 ;; Do not move footnote definitions out of column 0.
2923 ;; When MINLEVEL is specified, compute minimal level for headlines
2924 ;; in the file (CUR-MIN), and remove stars to each headline so
2925 ;; that headlines with minimal level have a level of MINLEVEL.
2935 ;; Only change stars, don't bother moving whole
2936 ;; sections.
2942 \f
2943 ;;; Tools For Back-Ends
2944 ;;
2945 ;; A whole set of tools is available to help build new exporters. Any
2946 ;; function general enough to have its use across many back-ends
2947 ;; should be added here.
2949 ;;;; For Affiliated Keywords
2950 ;;
2951 ;; `org-export-read-attribute' reads a property from a given element
2952 ;; as a plist. It can be used to normalize affiliated keywords'
2953 ;; syntax.
2954 ;;
2955 ;; Since captions can span over multiple lines and accept dual values,
2956 ;; their internal representation is a bit tricky. Therefore,
2957 ;; `org-export-get-caption' transparently returns a given element's
2958 ;; caption as a secondary string.
2961 "Turn ATTRIBUTE property from ELEMENT into a plist.
2963 When optional argument PROPERTY is non-nil, return the value of
2964 that property within attributes.
2968 properties."
2976 "Return caption from ELEMENT as a secondary string.
2978 When optional argument SHORTP is non-nil, return short caption,
2979 as a secondary string, instead.
2981 Caption lines are separated by a white space."
2989 ;;;; For Export Snippets
2990 ;;
2991 ;; Every export snippet is transmitted to the back-end. Though, the
2992 ;; latter will only retain one type of export-snippet, ignoring
2993 ;; others, based on the former's target back-end. The function
2994 ;; `org-export-snippet-backend' returns that back-end for a given
2995 ;; export-snippet.
2998 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2999 Translation, with `org-export-snippet-translation-alist', is
3000 applied."
3004 back-end))))
3007 ;;;; For Footnotes
3008 ;;
3009 ;; `org-export-collect-footnote-definitions' is a tool to list
3010 ;; actually used footnotes definitions in the whole parse tree, or in
3011 ;; an headline, in order to add footnote listings throughout the
3012 ;; transcoded data.
3013 ;;
3014 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3015 ;; back-ends, when they need to attach the footnote definition only to
3016 ;; the first occurrence of the corresponding label.
3017 ;;
3018 ;; `org-export-get-footnote-definition' and
3019 ;; `org-export-get-footnote-number' provide easier access to
3020 ;; additional information relative to a footnote reference.
3023 "Return an alist between footnote numbers, labels and definitions.
3025 DATA is the parse tree from which definitions are collected.
3026 INFO is the plist used as a communication channel.
3028 Definitions are sorted by order of references. They either
3029 appear as Org data or as a secondary string for inlined
3030 footnotes. Unreferenced definitions are ignored."
3032 collect-fn ; for byte-compiler.
3036 ;; Collect footnote number, label and definition in DATA.
3038 data 'footnote-reference
3045 def)
3046 num-alist)
3047 ;; Also search in definition for nested footnotes.
3050 ;; Don't enter footnote definitions since it will happen
3051 ;; when their first reference is found.
3057 "Non-nil when a footnote reference is the first one for its label.
3059 FOOTNOTE-REFERENCE is the footnote reference being considered.
3060 INFO is the plist used as a communication channel."
3062 ;; Anonymous footnotes are always a first reference.
3064 ;; Otherwise, return the first footnote with the same LABEL and
3065 ;; test if it is equal to FOOTNOTE-REFERENCE.
3071 data 'footnote-reference
3076 ;; If FN isn't inlined, be sure to traverse its
3077 ;; definition before resuming search. See
3078 ;; comments in `org-export-get-footnote-number'
3079 ;; for more information.
3083 ;; Don't enter footnote definitions since it will
3084 ;; happen when their first reference is found.
3087 footnote-reference)))))
3090 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3091 INFO is the plist used as a communication channel."
3097 "Return number associated to a footnote.
3099 FOOTNOTE is either a footnote reference or a footnote definition.
3100 INFO is the plist used as a communication channel."
3102 seen-refs
3103 search-ref ; For byte-compiler.
3107 ;; Search footnote references through DATA, filling
3108 ;; SEEN-REFS along the way.
3110 data 'footnote-reference
3114 ;; Anonymous footnote match: return number.
3117 ;; Labels match: return number.
3120 ;; Anonymous footnote: it's always a new one. Also,
3121 ;; be sure to return nil from the `cond' so
3122 ;; `first-match' doesn't get us out of the loop.
3124 ;; Label not seen so far: add it so SEEN-REFS.
3125 ;;
3126 ;; Also search for subsequent references in
3127 ;; footnote definition so numbering follows reading
3128 ;; logic. Note that we don't have to care about
3129 ;; inline definitions, since `org-element-map'
3130 ;; already traverses them at the right time.
3131 ;;
3132 ;; Once again, return nil to stay in the loop.
3137 nil))))
3138 ;; Don't enter footnote definitions since it will happen
3139 ;; when their first reference is found.
3144 ;;;; For Headlines
3145 ;;
3146 ;; `org-export-get-relative-level' is a shortcut to get headline
3147 ;; level, relatively to the lower headline level in the parsed tree.
3148 ;;
3149 ;; `org-export-get-headline-number' returns the section number of an
3150 ;; headline, while `org-export-number-to-roman' allows to convert it
3151 ;; to roman numbers.
3152 ;;
3153 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3154 ;; `org-export-last-sibling-p' are three useful predicates when it
3155 ;; comes to fulfill the `:headline-levels' property.
3158 "Return HEADLINE relative level within current parsed tree.
3159 INFO is a plist holding contextual information."
3164 "Non-nil when HEADLINE is considered as low level.
3166 INFO is a plist used as a communication channel.
3168 A low level headlines has a relative level greater than
3169 `:headline-levels' property value.
3171 Return value is the difference between HEADLINE relative level
3172 and the last level being considered as high enough, or nil."
3179 "Return HEADLINE numbering as a list of numbers.
3180 INFO is a plist holding contextual information."
3184 "Return a non-nil value if HEADLINE element should be numbered.
3185 INFO is a plist used as a communication channel."
3191 "Convert integer N into a roman numeral."
3204 res)))
3207 "Return list of tags associated to ELEMENT.
3209 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3210 is a plist used as a communication channel.
3212 Select tags (see `org-export-select-tags') and exclude tags (see
3213 `org-export-exclude-tags') are removed from the list.
3215 When non-nil, optional argument TAGS should be a list of strings.
3216 Any tag belonging to this list will also be removed.
3218 When optional argument INHERITED is non-nil, tags can also be
3219 inherited from parent headlines and FILETAGS keywords."
3225 ;; Build complete list of inherited tags.
3236 ;; Add FILETAGS keywords and return results.
3240 "Return node PROPERTY value for BLOB.
3242 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3243 element or object.
3245 If optional argument INHERITED is non-nil, the value can be
3246 inherited from a parent headline.
3248 Return value is a string or nil."
3260 "Return category for element or object BLOB.
3262 INFO is a plist used as a communication channel.
3264 CATEGORY is automatically inherited from a parent headline, from
3265 #+CATEGORY: keyword or created out of original file name. If all
3269 ;; Almost like `org-export-node-property', but we cannot trust
3270 ;; `plist-member' as every headline has a `:category'
3271 ;; property, even if nil.
3289 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3290 INFO is a plist used as a communication channel."
3295 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3296 INFO is a plist used as a communication channel."
3300 ;;;; For Links
3301 ;;
3302 ;; `org-export-solidify-link-text' turns a string into a safer version
3303 ;; for links, replacing most non-standard characters with hyphens.
3304 ;;
3305 ;; `org-export-get-coderef-format' returns an appropriate format
3306 ;; string for coderefs.
3307 ;;
3308 ;; `org-export-inline-image-p' returns a non-nil value when the link
3309 ;; provided should be considered as an inline image.
3310 ;;
3311 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3312 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3313 ;; returns an appropriate unique identifier when found, or nil.
3314 ;;
3315 ;; `org-export-resolve-id-link' returns the first headline with
3316 ;; specified id or custom-id in parse tree, the path to the external
3317 ;; file with the id or nil when neither was found.
3318 ;;
3319 ;; `org-export-resolve-coderef' associates a reference to a line
3320 ;; number in the element it belongs, or returns the reference itself
3321 ;; when the element isn't numbered.
3324 "Take link text S and make a safe target out of it."
3329 "Return format string for code reference link.
3330 PATH is the link path. DESC is its description."
3338 "Non-nil if LINK object points to an inline image.
3340 Optional argument is a set of RULES defining inline images. It
3341 is an alist where associations have the following shape:
3343 \(TYPE . REGEXP)
3345 Applying a rule means apply REGEXP against LINK's path when its
3346 type is TYPE. The function will return a non-nil value if any of
3347 the provided rules is non-nil. The default rule is
3348 `org-export-default-inline-image-rule'.
3350 This only applies to links without a description."
3361 rules)
3362 ;; Return nil if no rule matched.
3363 nil))))
3366 "Resolve a code reference REF.
3368 INFO is a plist used as a communication channel.
3370 Return associated line number in source code, or REF itself,
3371 depending on src-block or example element's switches."
3379 org-coderef-label-format)))
3383 ;; Element containing REF is found. Resolve it to either
3384 ;; a label or a line number, as needed.
3394 "Return LINK destination.
3396 INFO is a plist holding contextual information.
3398 Return value can be an object, an element, or nil:
3400 - If LINK path matches a target object (i.e. <<path>>) or
3403 - If LINK path exactly matches the name affiliated keyword
3404 \(i.e. #+NAME: path) of an element, return that element.
3406 - If LINK path exactly matches any headline name, return that
3407 element. If more than one headline share that name, priority
3408 will be given to the one with the closest common ancestor, if
3409 any, or the first one in the parse tree otherwise.
3411 - Otherwise, return nil.
3417 ;; First try to find a matching "<<path>>" unless user specified
3418 ;; he was looking for an headline (path starts with a *
3419 ;; character).
3423 return target)))
3424 ;; Then try to find an element with a matching "#+NAME: path"
3425 ;; affiliated keyword.
3432 ;; Last case: link either points to an headline or to
3433 ;; nothingness. Try to find the source, with priority given to
3434 ;; headlines with the closest common ancestor. If such candidate
3435 ;; is found, return it, otherwise return nil.
3439 ;; Return first headline whose `:raw-value' property
3440 ;; is NAME in parse tree DATA, or nil.
3443 data 'headline
3447 name)
3448 headline))
3450 ;; Search among headlines sharing an ancestor with link,
3451 ;; from closest to farthest.
3459 ;; No match with a common ancestor: try the full parse-tree.
3465 "Return headline referenced as LINK destination.
3467 INFO is a plist used as a communication channel.
3469 Return value can be the headline element matched in current parse
3473 ;; First check if id is within the current parse tree.
3479 headline))
3481 ;; Otherwise, look for external files.
3485 "Return radio-target object referenced as LINK destination.
3487 INFO is a plist used as a communication channel.
3489 Return value can be a radio-target object or nil. Assume LINK
3499 ;;;; For References
3500 ;;
3501 ;; `org-export-get-ordinal' associates a sequence number to any object
3502 ;; or element.
3505 "Return ordinal number of an element or object.
3507 ELEMENT is the element or object considered. INFO is the plist
3508 used as a communication channel.
3510 Optional argument TYPES, when non-nil, is a list of element or
3511 object types, as symbols, that should also be counted in.
3512 Otherwise, only provided element's type is considered.
3514 Optional argument PREDICATE is a function returning a non-nil
3515 value if the current element or object should be counted in. It
3516 accepts two arguments: the element or object being considered and
3517 the plist used as a communication channel. This allows to count
3518 only a certain type of objects (i.e. inline images).
3520 Return value is a list of numbers if ELEMENT is an headline or an
3521 item. It is nil for keywords. It represents the footnote number
3522 for footnote definitions and footnote references. If ELEMENT is
3523 a target, return the same value as if ELEMENT was the closest
3524 table, item or headline containing the target. In any other
3525 case, return the sequence number of ELEMENT among elements or
3526 objects of the same type."
3527 ;; A target keyword, representing an invisible target, never has
3528 ;; a sequence number.
3530 ;; Ordinal of a target object refer to the ordinal of the closest
3531 ;; table, item, or headline containing the object.
3535 when
3539 table))
3540 return parent)))
3542 ;; Special case 1: An headline returns its number as a list.
3544 ;; Special case 2: An item returns its number as a list.
3548 struct
3555 ;; Increment counter until ELEMENT is found again.
3566 ;;;; For Src-Blocks
3567 ;;
3568 ;; `org-export-get-loc' counts number of code lines accumulated in
3569 ;; src-block or example-block elements with a "+n" switch until
3570 ;; a given element, excluded. Note: "-n" switches reset that count.
3571 ;;
3572 ;; `org-export-unravel-code' extracts source code (along with a code
3573 ;; references alist) from an `element-block' or `src-block' type
3574 ;; element.
3575 ;;
3576 ;; `org-export-format-code' applies a formatting function to each line
3577 ;; of code, providing relative line number and code reference when
3578 ;; appropriate. Since it doesn't access the original element from
3579 ;; which the source code is coming, it expects from the code calling
3580 ;; it to know if lines should be numbered and if code references
3581 ;; should appear.
3582 ;;
3583 ;; Eventually, `org-export-format-code-default' is a higher-level
3584 ;; function (it makes use of the two previous functions) which handles
3585 ;; line numbering and code references inclusion, and returns source
3586 ;; code in a format suitable for plain text or verbatim output.
3589 "Return accumulated lines of code up to ELEMENT.
3591 INFO is the plist used as a communication channel.
3593 ELEMENT is excluded from count."
3600 ;; ELEMENT is reached: Quit the loop.
3602 ;; Only count lines from src-block and example-block elements
3603 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3607 ;; Accumulate locs or reset them.
3611 ;; Return nil to stay in the loop.
3612 nil)))
3614 ;; Return value.
3615 loc))
3618 "Clean source code and extract references out of it.
3620 ELEMENT has either a `src-block' an `example-block' type.
3622 Return a cons cell whose CAR is the source code, cleaned from any
3623 reference and protective comma and CDR is an alist between
3624 relative line number (integer) and name of code reference on that
3625 line (string)."
3627 ;; Get code and clean it. Remove blank lines at its
3628 ;; beginning and end.
3634 ;; If appropriate, remove global indentation.
3637 c
3639 ;; Get format used for references.
3642 org-coderef-label-format)))
3643 ;; Build a regexp matching a loc with a reference.
3648 ;; Return value.
3650 ;; Code with references removed.
3656 ;; Ref line: remove ref, and signal its position in REFS.
3660 ;; Reference alist.
3661 refs)))
3664 "Format CODE by applying FUN line-wise and return it.
3666 CODE is a string representing the code to format. FUN is
3667 a function. It must accept three arguments: a line of
3668 code (string), the current line number (integer) or nil and the
3669 reference associated to the current line (string) or nil.
3671 Optional argument NUM-LINES can be an integer representing the
3672 number of code lines accumulated until the current code. Line
3673 numbers passed to FUN will take it into account. If it is nil,
3674 FUN's second argument will always be nil. This number can be
3675 obtained with `org-export-get-loc' function.
3677 Optional argument REF-ALIST can be an alist between relative line
3678 number (i.e. ignoring NUM-LINES) and the name of the code
3679 reference on it. If it is nil, FUN's third argument will always
3680 be nil. It can be obtained through the use of
3681 `org-export-unravel-code' function."
3693 "Return source code from ELEMENT, formatted in a standard way.
3695 ELEMENT is either a `src-block' or `example-block' element. INFO
3696 is a plist used as a communication channel.
3698 This function takes care of line numbering and code references
3699 inclusion. Line numbers, when applicable, appear at the
3700 beginning of the line, separated from the code by two white
3701 spaces. Code references, on the other hand, appear flushed to
3702 the right, separated by six white spaces from the widest line of
3703 code."
3704 ;; Extract code and references.
3710 ;; Handle line numbering.
3719 ;; Prepare references display, if required. Any reference
3720 ;; should start six columns after the widest line of code,
3721 ;; wrapped with parenthesis.
3726 code
3730 number-str
3731 loc
3737 num-start refs)))
3740 ;;;; For Tables
3741 ;;
3742 ;; `org-export-table-has-special-column-p' and and
3743 ;; `org-export-table-row-is-special-p' are predicates used to look for
3744 ;; meta-information about the table structure.
3745 ;;
3746 ;; `org-table-has-header-p' tells when the rows before the first rule
3747 ;; should be considered as table's header.
3748 ;;
3749 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3750 ;; and `org-export-table-cell-borders' extract information from
3751 ;; a table-cell element.
3752 ;;
3753 ;; `org-export-table-dimensions' gives the number on rows and columns
3754 ;; in the table, ignoring horizontal rules and special columns.
3755 ;; `org-export-table-cell-address', given a table-cell object, returns
3756 ;; the absolute address of a cell. On the other hand,
3757 ;; `org-export-get-table-cell-at' does the contrary.
3758 ;;
3759 ;; `org-export-table-cell-starts-colgroup-p',
3760 ;; `org-export-table-cell-ends-colgroup-p',
3761 ;; `org-export-table-row-starts-rowgroup-p',
3762 ;; `org-export-table-row-ends-rowgroup-p',
3763 ;; `org-export-table-row-starts-header-p' and
3764 ;; `org-export-table-row-ends-header-p' indicate position of current
3765 ;; row or cell within the table.
3768 "Non-nil when TABLE has a special column.
3769 All special columns will be ignored during export."
3770 ;; The table has a special column when every first cell of every row
3771 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3772 ;; "*" "_" and "^". Though, do not consider a first row containing
3773 ;; only empty cells as special.
3789 "Non-nil when TABLE has an header.
3791 INFO is a plist used as a communication channel.
3793 A table has an header when it contains at least two row groups."
3796 table 'table-row
3804 info)))
3807 "Non-nil if TABLE-ROW is considered special.
3809 INFO is a plist used as the communication channel.
3811 All special rows will be ignored during export."
3815 ;; A row is special either when...
3817 ;; ... it starts with a field only containing "/",
3819 ;; ... the table contains a special column and the row start
3820 ;; with a marking character among, "^", "_", "$" or "!",
3824 ;; ... it contains only alignment cookies and empty cells.
3830 ;; Since VALUE is a secondary string, the following
3831 ;; checks avoid expanding it with `org-export-data'.
3843 "Return TABLE-ROW's group.
3845 INFO is a plist used as the communication channel.
3847 Return value is the group number, as an integer, or nil special
3848 rows and table rules. Group 1 is also table's header."
3865 "Return TABLE-CELL contents width.
3867 INFO is a plist used as the communication channel.
3869 Return value is the width given by the last width cookie in the
3870 same column as TABLE-CELL, or nil."
3875 cookie-width)
3879 ;; In a special row, try to find a width cookie at COLUMN.
3883 ;; The following checks avoid expanding unnecessarily the
3884 ;; cell with `org-export-data'
3892 ;; Ignore table rules.
3895 ;; Return value.
3896 cookie-width))
3899 "Return TABLE-CELL contents alignment.
3901 INFO is a plist used as the communication channel.
3903 Return alignment as specified by the last alignment cookie in the
3904 same column as TABLE-CELL. If no such cookie is found, a default
3905 alignment value will be deduced from fraction of numbers in the
3906 column (see `org-table-number-fraction' for more information).
3907 Possible values are `left', `right' and `center'."
3914 cookie-align)
3918 ;; In a special row, try to find an alignment cookie at
3919 ;; COLUMN.
3923 ;; Since VALUE is a secondary string, the following checks
3924 ;; avoid useless expansion through `org-export-data'.
3932 ;; Ignore table rules.
3934 ;; In a standard row, check if cell's contents are expressing
3935 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3936 ;; Though, don't bother if an alignment cookie has already
3937 ;; defined cell's alignment.
3942 info)))
3947 ;; Return value. Alignment specified by cookies has precedence
3948 ;; over alignment deduced from cells contents.
3957 "Return TABLE-CELL borders.
3959 INFO is a plist used as a communication channel.
3961 Return value is a list of symbols, or nil. Possible values are:
3962 `top', `bottom', `above', `below', `left' and `right'. Note:
3963 `top' (resp. `bottom') only happen for a cell in the first
3964 row (resp. last row) of the table, ignoring table rules, if any.
3966 Returned borders ignore special rows."
3969 borders)
3970 ;; Top/above border? TABLE-CELL has a border above when a rule
3971 ;; used to demarcate row groups can be found above. Hence,
3972 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3973 ;; another regular row has to be found above that rule.
3982 ;; Look at every row before the current one.
3984 ;; No rule above, or rule found starts the table (ignoring any
3985 ;; special row): TABLE-CELL is at the top of the table.
3988 ;; Bottom/below border? TABLE-CELL has a border below when next
3989 ;; non-regular row below is a rule.
3998 ;; Look at every row after the current one.
4000 ;; No rule below, or rule found ends the table (modulo some
4001 ;; special row): TABLE-CELL is at the bottom of the table.
4004 ;; Right/left borders? They can only be specified by column
4005 ;; groups. Column groups are defined in a row starting with "/".
4006 ;; Also a column groups row only contains "<", "<>", ">" or blank
4007 ;; cells.
4024 ;; There's a left border when previous cell, if
4025 ;; any, ends a group, or current one starts one.
4031 ;; There's a right border when next cell, if any,
4032 ;; starts a group, or current one ends one.
4039 ;; Table rows are read in reverse order so last column groups
4040 ;; row has precedence over any previous one.
4042 ;; Return value.
4043 borders))
4046 "Non-nil when TABLE-CELL is at the beginning of a row group.
4047 INFO is a plist used as a communication channel."
4048 ;; A cell starts a column group either when it is at the beginning
4049 ;; of a row (or after the special column, if any) or when it has
4050 ;; a left border.
4054 table-cell)
4058 "Non-nil when TABLE-CELL is at the end of a row group.
4059 INFO is a plist used as a communication channel."
4060 ;; A cell ends a column group either when it is at the end of a row
4061 ;; or when it has a right border.
4064 table-cell)
4068 "Non-nil when TABLE-ROW is at the beginning of a column group.
4069 INFO is a plist used as a communication channel."
4077 "Non-nil when TABLE-ROW is at the end of a column group.
4078 INFO is a plist used as a communication channel."
4086 "Non-nil when TABLE-ROW is the first table header's row.
4087 INFO is a plist used as a communication channel."
4094 "Non-nil when TABLE-ROW is the last table header's row.
4095 INFO is a plist used as a communication channel."
4102 "Return TABLE dimensions.
4104 INFO is a plist used as a communication channel.
4106 Return value is a CONS like (ROWS . COLUMNS) where
4107 ROWS (resp. COLUMNS) is the number of exportable
4108 rows (resp. columns)."
4110 ;; Set number of rows, and extract first one.
4112 table 'table-row
4117 ;; Set number of columns.
4119 ;; Return value.
4123 "Return address of a regular TABLE-CELL object.
4125 TABLE-CELL is the cell considered. INFO is a plist used as
4126 a communication channel.
4128 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4129 zero-based index. Only exportable cells are considered. The
4130 function returns nil for other cells."
4133 ;; Ignore cells in special rows or in special column.
4138 ;; Row number.
4141 table 'table-row
4147 ;; Column number.
4150 table-row 'table-cell
4156 "Return regular table-cell object at ADDRESS in TABLE.
4158 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4159 zero-based index. TABLE is a table type element. INFO is
4160 a plist used as a communication channel.
4162 If no table-cell, among exportable cells, is found at ADDRESS,
4163 return nil."
4166 ;; Row at (car address) or nil.
4169 table 'table-row
4175 'table-cell
4182 ;;;; For Tables Of Contents
4183 ;;
4184 ;; `org-export-collect-headlines' builds a list of all exportable
4185 ;; headline elements, maybe limited to a certain depth. One can then
4186 ;; easily parse it and transcode it.
4187 ;;
4188 ;; Building lists of tables, figures or listings is quite similar.
4189 ;; Once the generic function `org-export-collect-elements' is defined,
4190 ;; `org-export-collect-tables', `org-export-collect-figures' and
4191 ;; `org-export-collect-listings' can be derived from it.
4194 "Collect headlines in order to build a table of contents.
4196 INFO is a plist used as a communication channel.
4198 When optional argument N is an integer, it specifies the depth of
4199 the table of contents. Otherwise, it is set to the value of the
4200 last headline level. See `org-export-headline-levels' for more
4201 information.
4203 Return a list of all exportable headlines as parsed elements."
4207 'headline
4209 ;; Strip contents from HEADLINE.
4212 info))
4215 "Collect referenceable elements of a determined type.
4217 TYPE can be a symbol or a list of symbols specifying element
4218 types to search. Only elements with a caption are collected.
4220 INFO is a plist used as a communication channel.
4222 When non-nil, optional argument PREDICATE is a function accepting
4223 one argument, an element of type TYPE. It returns a non-nil
4224 value when that element should be collected.
4226 Return a list of all elements found, in order of appearance."
4232 element))
4233 info))
4236 "Build a list of tables.
4237 INFO is a plist used as a communication channel.
4239 Return a list of table elements with a caption."
4243 "Build a list of figures.
4245 INFO is a plist used as a communication channel. PREDICATE is
4246 a function which accepts one argument: a paragraph element and
4247 whose return value is non-nil when that element should be
4248 collected.
4250 A figure is a paragraph type element, with a caption, verifying
4252 a vague concept that may depend on back-end.
4254 Return a list of elements recognized as figures."
4258 "Build a list of src blocks.
4260 INFO is a plist used as a communication channel.
4262 Return a list of src-block elements with a caption."
4266 ;;;; Smart Quotes
4303 "Smart quotes translations.
4305 Alist whose CAR is a language string and CDR is an alist with
4306 quote type as key and a plist associating various encodings to
4307 their translation as value.
4309 A quote type can be any symbol among `opening-double-quote',
4310 `closing-double-quote', `opening-single-quote',
4311 `closing-single-quote' and `apostrophe'.
4313 Valid encodings include `:utf-8', `:html', `:latex' and
4314 `:texinfo'.
4320 ;; Possible opening quote at beginning of string.
4322 ;; Possible closing quote at beginning of string.
4324 ;; Possible apostrophe at beginning of string.
4326 ;; Opening single and double quotes.
4328 ;; Closing single and double quotes.
4330 ;; Apostrophe.
4332 ;; Possible opening quote at end of string.
4334 ;; Possible closing quote at end of string.
4336 ;; Possible apostrophe at end of string.
4338 "List of regexps matching a quote or an apostrophe.
4344 ENCODING is a symbol among `:html', `:latex' and `:utf-8'. INFO
4345 is a plist used as a communication channel.
4347 The function has to retrieve information about string
4348 surroundings in parse tree. It can only happen with an
4349 unmodified string. Thus, if S has already been through another
4350 process, a non-nil ORIGINAL optional argument will provide that
4351 original string.
4353 Return the new string."
4360 ;; Return smart quote associated to a give quote Q, as
4361 ;; a string. TYPE is a symbol among `open', `close' and
4362 ;; `apostrophe'.
4372 org-export-smart-quotes-alist))))
4373 encoding)
4374 q)))))
4376 ;; Only a quote: no regexp can match. We have to check both
4377 ;; sides and decide what to do.
4385 ;; 1. Replace quote character at the beginning of S.
4387 ;; Apostrophe?
4393 ;; Closing quote?
4399 ;; Opening quote?
4405 ;; 2. Replace quotes in the middle of the string.
4407 ;; Opening quotes.
4413 ;; Closing quotes.
4419 ;; Apostrophes.
4424 ;; 3. Replace quote character at the end of S.
4426 ;; Apostrophe?
4431 ;; Closing quote?
4437 ;; Opening quote?
4442 ;; Return string with smart quotes.
4443 s))))
4445 ;;;; Topology
4446 ;;
4447 ;; Here are various functions to retrieve information about the
4448 ;; neighbourhood of a given element or object. Neighbours of interest
4449 ;; are direct parent (`org-export-get-parent'), parent headline
4450 ;; (`org-export-get-parent-headline'), first element containing an
4451 ;; object, (`org-export-get-parent-element'), parent table
4452 ;; (`org-export-get-parent-table'), previous element or object
4453 ;; (`org-export-get-previous-element') and next element or object
4454 ;; (`org-export-get-next-element').
4455 ;;
4456 ;; `org-export-get-genealogy' returns the full genealogy of a given
4457 ;; element or object, from closest parent to full parse tree.
4460 "Return BLOB parent or nil.
4461 BLOB is the element or object considered."
4465 "Return full genealogy relative to a given element or object.
4467 BLOB is the element or object being considered.
4469 Ancestors are returned from closest to farthest, the last one
4470 being the full parse tree."
4477 "Return BLOB parent headline or nil.
4478 BLOB is the element or object being considered."
4482 parent))
4485 "Return first element containing OBJECT or nil.
4486 OBJECT is the object to consider."
4490 parent))
4493 "Return OBJECT parent table or nil.
4494 OBJECT is either a `table-cell' or `table-element' type object."
4498 parent))
4501 "Return previous element or object.
4502 BLOB is an element or object. INFO is a plist used as
4503 a communication channel. Return previous exportable element or
4504 object, a string, or nil."
4511 ;; An object can belong to the contents of its parent or
4512 ;; to a secondary string. We check the latter option
4513 ;; first.
4516 org-element-all-elements))
4520 org-element-secondary-value-alist))
4521 parent)))
4526 "Return next element or object.
4527 BLOB is an element or object. INFO is a plist used as
4528 a communication channel. Return next exportable element or
4529 object, a string, or nil."
4534 ;; An object can belong to the contents of its parent or to
4535 ;; a secondary string. We check the latter option first.
4538 org-element-all-objects))
4542 org-element-secondary-value-alist))
4543 parent)))
4546 nil))
4549 ;;;; Translation
4550 ;;
4551 ;; `org-export-translate' translates a string according to language
4552 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4553 ;; variable and a specified charset. `org-export-dictionary' contains
4554 ;; the dictionary used for the translation.
4676 "Dictionary for export engine.
4678 Alist whose CAR is the string to translate and CDR is an alist
4679 whose CAR is the language string and CDR is a plist whose
4680 properties are possible charsets and values translated terms.
4682 It is used as a database for `org-export-translate'. Since this
4683 function returns the string as-is if no translation was found,
4684 the variable only needs to record values different from the
4688 "Translate string S according to language specification.
4690 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4691 and `:utf-8'. INFO is a plist used as a communication channel.
4693 Translation depends on `:language' property. Return the
4694 translated string. If no translation is found, try to fall back
4695 to `:default' encoding. If it fails, return S."
4701 s)))
4704 \f
4705 ;;; The Dispatcher
4706 ;;
4707 ;; `org-export-dispatch' is the standard interactive way to start an
4708 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4709 ;; for its interface, which, in turn, delegates response to key
4710 ;; pressed to `org-export-dispatch-action'.
4713 "List of menu entries available for `org-export-dispatch'.
4714 This variable shouldn't be set directly. Set-up :menu-entry
4715 keyword in either `org-export-define-backend' or
4718 ;;;###autoload
4720 "Export dispatcher for Org mode.
4722 It provides an access to common export related tasks in a buffer.
4723 Its interface comes in two flavours: standard and expert. While
4724 both share the same set of bindings, only the former displays the
4725 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4726 to switch to one or the other."
4731 nil
4732 org-export-dispatch-use-expert-ui)
4738 ;; First handle special hard-coded actions.
4744 "Publish project: "
4745 org-e-publish-project-alist nil t)
4746 org-e-publish-project-alist)
4756 "Handle interface for `org-export-dispatch'.
4758 OPTIONS is a list containing current interactive options set for
4759 export. It can contain any of the following symbols:
4760 `body' toggles a body-only export
4761 `subtree' restricts export to current subtree
4762 `visible' restricts export to visible part of buffer.
4763 `force' force publishing files.
4765 FIRST-KEY is the key pressed to select the first level menu. It
4766 is nil when this menu hasn't been selected yet.
4768 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4769 buffer is provided, but indications about currently active
4770 options are given in the prompt. Moreover, \[?] allows to switch
4771 back to standard interface."
4774 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4775 ;; non-nil is the required first-level key to activate
4776 ;; KEY. When its value is t, activate KEY independently
4777 ;; on the first key, if any. A nil value means KEY will
4778 ;; only be activated at first level.
4782 ;; Make sure order of menu doesn't depend on the order in
4783 ;; which back-ends are loaded.
4786 ;; Compute a list of allowed keys based on the first key
4787 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4788 ;; always available.
4798 ;; Build the help menu for standard UI.
4802 ;; Options are hard-coded.
4804 [%s] Body only: %s [%s] Visible only: %s
4814 ;; Display registered back-end entries.
4824 ;; Split sub-menu into two columns.
4834 top-key)
4839 ;; Publishing menu is hard-coded.
4841 [%s] Current file [%s] Current project
4851 ;; Build prompts for both standard and expert UI.
4856 "Export command (Options: %s%s%s%s) [%s]: "
4862 ;; With expert UI, just read key with a fancy prompt. In standard
4863 ;; UI, display an intrusive help buffer.
4866 expert-prompt allowed-keys backends options first-key expertp)
4867 ;; At first call, create frame layout in order to display menu.
4873 ;; At this point, the buffer containing the menu exists and is
4874 ;; visible in the current window. So, refresh it.
4880 standard-prompt allowed-keys backends options first-key expertp))))
4884 "Read a character from command input and act accordingly.
4886 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
4887 a list of characters available at a given step in the process.
4888 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
4889 EXPERTP are the same as defined in `org-export-dispatch-ui',
4890 which see.
4892 Toggle export options when required. Otherwise, return value is
4893 a list with action as CAR and a list of interactive export
4894 options as CDR."
4896 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4897 ;; depending on user's key pressed.
4900 ;; Ignore non-standard characters (i.e. "M-a") and
4901 ;; undefined associations.
4906 ;; q key at first level aborts export. At second
4907 ;; level, cancel first key instead.
4910 ;; Help key: Switch back to standard interface if
4911 ;; expert UI was active.
4913 ;; Toggle export options.
4920 first-key expertp))
4921 ;; Action selected: Send key and options back to
4922 ;; `org-export-dispatch'.
4928 ;; Publishing actions are hard-coded. Send a special
4929 ;; signal to `org-export-dispatch'.
4937 options))
4938 ;; Otherwise, enter sub-menu.
4943 ;;; org-export.el ends here