| blob | 8641ba742c10b7f2fa7dd0b403d39f1c591fba84 |
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 defines one mandatory information: his translation table.
52 ;; Its value is an alist whose keys are elements and objects types and
53 ;; values translator functions. See function's docstring for more
54 ;; information about translators.
55 ;;
56 ;; Optionally, `org-export-define-backend' can also support specific
57 ;; buffer keywords, OPTION keyword's items and filters. Also refer to
58 ;; function documentation for more information.
59 ;;
60 ;; If the new back-end shares most properties with another one,
61 ;; `org-export-define-derived-backend' can be used to simplify the
62 ;; process.
63 ;;
64 ;; Any back-end can define its own variables. Among them, those
65 ;; customizable should belong to the `org-export-BACKEND' group.
66 ;;
67 ;; Tools for common tasks across back-ends are implemented in the
68 ;; penultimate part of this file. A dispatcher for standard back-ends
69 ;; is provided in the last one.
71 ;;; Code:
88 \f
89 ;;; Internal Variables
90 ;;
91 ;; Among internal variables, the most important is
92 ;; `org-export-options-alist'. This variable define the global export
93 ;; 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 "List of backends currently available in the exporter.
257 A backend is stored as a list where CAR is its name, as a symbol,
258 and CDR is a plist with the following properties:
259 `:filters-alist', `:menu-entry', `:options-alist' and
260 `:translate-alist'.
262 This variable is set with `org-export-define-backend' and
266 \f
267 ;;; User-configurable Variables
268 ;;
269 ;; Configuration for the masses.
270 ;;
271 ;; They should never be accessed directly, as their value is to be
272 ;; stored in a property list (cf. `org-export-options-alist').
273 ;; Back-ends will read their value from there instead.
276 "Options for exporting Org mode files."
281 "General options for export engine."
286 "Whether sub-trees with the ARCHIVE tag should be exported.
288 This can have three different values:
289 nil Do not export, pretend this tree is not present.
290 t Do export the entire tree.
291 `headline' Only export the headline, but skip the tree below it.
293 This option can also be set with the #+OPTIONS line,
302 "Non-nil means insert author name into the exported file.
303 This option can also be set with the #+OPTIONS line,
309 "Non-nil means export CLOCK keywords.
310 This option can also be set with the #+OPTIONS line,
316 "Non-nil means the postamble should contain a creator sentence.
318 The sentence can be set in `org-export-creator-string' and
321 If the value is `comment' insert it as a comment."
329 "Non-nil means insert date in the exported document.
330 This options can also be set with the OPTIONS keyword,
336 emacs-version)
337 "String to insert at the end of the generated document."
342 "Non-nil means export contents of standard drawers.
344 When t, all drawers are exported. This may also be a list of
345 drawer names to export. This variable doesn't apply to
346 properties drawers.
348 This option can also be set with the #+OPTIONS line,
358 "Non-nil means insert author email into the exported file.
359 This option can also be set with the #+OPTIONS line,
365 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
367 If the export target supports emphasizing text, the word will be
368 typeset in bold, italic, or underlined, respectively. Not all
369 export backends support this.
376 "Tags that exclude a tree from export.
378 All trees carrying any of these tags will be excluded from
379 export. This is without condition, so even subtrees inside that
380 carry one of the `org-export-select-tags' will be removed.
382 This option can also be set with the #+EXCLUDE_TAGS: keyword."
389 This can be used to have pre-formatted text, fragments of code
390 etc. For example:
391 : ;; Some Lisp examples
392 : (while (defc cnt)
393 : (ding))
394 will be looking just like this in also HTML. See also the QUOTE
395 keyword. Not all export backends support this.
402 "Non-nil means Org footnotes should be exported.
403 This option can also be set with the #+OPTIONS line,
409 "The last level which is still exported as a headline.
411 Inferior levels will produce itemize lists when exported.
418 "The default language for export and clocktable translations, as a string.
419 This may have an association in
420 `org-clock-clocktable-language-setup'."
425 "Non-nil means preserve all line breaks when exporting.
427 Normally, in HTML output paragraphs will be reformatted.
429 This option can also be set with the #+OPTIONS line,
435 "Non-nil means interpret entities when exporting.
438 Å.
440 For a list of supported names, see the constant `org-entities'
441 and the user option `org-entities-user'.
443 This option can also be set with the #+OPTIONS line,
449 "Non-nil means inlinetasks should be exported.
450 This option can also be set with the #+OPTIONS line,
456 "Non-nil means include planning info in export.
457 This option can also be set with the #+OPTIONS: line,
463 "Non-nil means include priority cookies in export.
464 This option can also be set with the #+OPTIONS line,
470 "Non-nil means add section numbers to headlines when exporting.
472 When set to an integer n, numbering will only happen for
473 headlines whose relative level is higher or equal to n.
475 This option can also be set with the #+OPTIONS line,
481 "Tags that select a tree for export.
483 If any such tag is found in a buffer, all trees that do not carry
484 one of these tags will be ignored during export. Inside trees
485 that are selected like this, you can still deselect a subtree by
486 tagging it with one of the `org-export-exclude-tags'.
488 This option can also be set with the #+SELECT_TAGS: keyword."
493 "Non-nil means activate smart quotes during export.
494 This option can also be set with the #+OPTIONS: line,
502 When this option is turned on, these strings will be exported as:
504 Org HTML LaTeX UTF-8
505 -----+----------+--------+-------
507 -- – -- –
508 --- — --- —
511 This option can also be set with the #+OPTIONS line,
517 "Non-nil means include statistics cookies in export.
518 This option can also be set with the #+OPTIONS: line,
526 When this option is turned on, you can use TeX-like syntax for
528 will be considered as a single item - so grouping with {} is
529 normally not needed. For example, the following things will be
530 parsed as single sub- or superscripts.
532 10^24 or 10^tau several digits will be considered 1 item.
533 10^-12 or 10^-tau a leading sign with digits or a word
534 x^2-y^3 will be read as x^2 - y^3, because items are
535 terminated by almost any nonword/nondigit char.
536 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
538 Still, ambiguity is possible - so when in doubt use {} to enclose
539 the sub/superscript. If you set this variable to the symbol
540 `{}', the braces are *required* in order to trigger
541 interpretations as sub/superscript. This can be helpful in
544 This option can also be set with the #+OPTIONS line,
553 "Non-nil means create a table of contents in exported files.
555 The TOC contains headlines with levels up
556 to`org-export-headline-levels'. When an integer, include levels
557 up to N in the toc, this may then be different from
558 `org-export-headline-levels', but it will not be allowed to be
559 larger than the number of headline levels. When nil, no table of
560 contents is made.
562 This option can also be set with the #+OPTIONS line,
572 For example:
574 | Name | Address | Birthday |
575 |-------------+----------+-----------|
576 | Arthur Dent | England | 29.2.2100 |
583 "If nil, do not export tags, just remove them from headlines.
585 If this is the symbol `not-in-toc', tags will be removed from
586 table of contents entries, but still be shown in the headlines of
587 the document.
589 This option can also be set with the #+OPTIONS line,
598 "Non-nil means include TODO items for export.
600 This may have the following values:
601 t include tasks independent of state.
602 `todo' include only tasks that are not yet done.
603 `done' include only tasks that are already done.
604 nil ignore all tasks.
605 list of keywords include tasks with these keywords.
607 This option can also be set with the #+OPTIONS line,
619 "Non-nil means insert a time stamp into the exported file.
620 The time stamp shows when the file was created.
622 This option can also be set with the #+OPTIONS line,
628 "Non nil means allow timestamps in export.
630 It can be set to `active', `inactive', t or nil, in order to
631 export, respectively, only active timestamps, only inactive ones,
632 all of them or none.
634 This option can also be set with the #+OPTIONS line, e.g.
644 "Non-nil means include TODO keywords in export.
645 When nil, remove all these keywords from the export."
650 "Non-nil means allow #+BIND to define local variable values for export.
651 This is a potential security risk, which is why the user must
652 confirm the use of these lines."
660 "Alist between export snippets back-ends and exporter back-ends.
662 This variable allows to provide shortcuts for export snippets.
666 HTML code while every other back-end will ignore it."
674 "Coding system for the exported file."
679 "Non-nil means exported stuff will also be pushed onto the kill ring."
684 "The initial scope when exporting with `org-export-dispatch'.
685 This variable can be either set to `buffer' or `subtree'."
692 "Non-nil means show buffer after exporting to temp buffer.
693 When Org exports to a file, the buffer visiting that file is ever
694 shown, but remains buried. However, when exporting to
695 a temporary buffer, that buffer is popped up in a second window.
696 When this variable is nil, the buffer remains buried also in
697 these cases."
702 "Non-nil means using a non-intrusive `org-export-dispatch'.
703 In that case, no help buffer is displayed. Though, an indicator
708 be passed the FORCE argument). Also, \[?] allows to switch back
709 to standard mode."
714 \f
715 ;;; Defining Back-ends
716 ;;
717 ;; `org-export-define-backend' is the standard way to define an export
718 ;; back-end. It allows to specify translators, filters, buffer
719 ;; options and a menu entry. If the new back-end shares translators
720 ;; with another back-end, `org-export-define-derived-backend' may be
721 ;; used instead.
722 ;;
723 ;; Internally, a back-end is stored as a list, of which CAR is the
724 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
725 ;; properties of a given back-end are: `org-export-backend-filters',
726 ;; `org-export-backend-menu', `org-export-backend-options' and
727 ;; `org-export-backend-translate-table'.
728 ;;
729 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
730 ;; when a given back-end hasn't been registered yet.
733 "Define a new back-end BACKEND.
735 TRANSLATORS is an alist between object or element types and
736 functions handling them.
738 These functions should return a string without any trailing
739 space, or nil. They must accept three arguments: the object or
740 element itself, its contents or nil when it isn't recursive and
741 the property list used as a communication channel.
743 Contents, when not nil, are stripped from any global indentation
744 \(although the relative one is preserved). They also always end
745 with a single newline character.
747 If, for a given type, no function is found, that element or
748 object type will simply be ignored, along with any blank line or
749 white space at its end. The same will happen if the function
750 returns the nil value. If that function returns the empty
751 string, the type will be ignored, but the blank lines or white
752 spaces will be kept.
754 In addition to element and object types, one function can be
755 associated to the `template' symbol and another one to the
756 `plain-text' symbol.
758 The former returns the final transcoded string, and can be used
759 to add a preamble and a postamble to document's body. It must
760 accept two arguments: the transcoded string and the property list
761 containing export options.
763 The latter, when defined, is to be called on every text not
764 recognized as an element or an object. It must accept two
765 arguments: the text string and the information channel. It is an
766 appropriate place to protect special chars relative to the
767 back-end.
769 BODY can start with pre-defined keyword arguments. The following
770 keywords are understood:
772 :export-block
774 String, or list of strings, representing block names that
775 will not be parsed. This is used to specify blocks that will
776 contain raw code specific to the back-end. These blocks
777 still have to be handled by the relative `export-block' type
778 translator.
780 :filters-alist
782 Alist between filters and function, or list of functions,
783 specific to the back-end. See `org-export-filters-alist' for
784 a list of all allowed filters. Filters defined here
785 shouldn't make a back-end test, as it may prevent back-ends
786 derived from this one to behave properly.
788 :menu-entry
790 Menu entry for the export dispatcher. It should be a list
791 like:
793 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
795 where :
797 KEY is a free character selecting the back-end.
799 DESCRIPTION-OR-ORDINAL is either a string or a number.
801 If it is a string, is will be used to name the back-end in
802 its menu entry. If it is a number, the following menu will
803 be displayed as a sub-menu of the back-end with the same
804 KEY. Also, the number will be used to determine in which
805 order such sub-menus will appear (lowest first).
807 ACTION-OR-MENU is either a function or an alist.
809 If it is an action, it will be called with three arguments:
810 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
811 for further explanations.
813 If it is an alist, associations should follow the
814 pattern:
816 \(KEY DESCRIPTION ACTION)
818 where KEY, DESCRIPTION and ACTION are described above.
820 Valid values include:
824 or
831 \(lambda (subtree visible body-only)
832 \(org-open-file
833 \(org-e-latex-export-to-pdf subtree visible body-only))))))
835 :options-alist
837 Alist between back-end specific properties introduced in
838 communication channel and how their value are acquired. See
839 `org-export-options-alist' for more information about
840 structure of the values."
859 ;; Register back-end.
863 ;; Tell parser to not parse EXPORT-BLOCK blocks.
870 ;; Splice in the body, if any.
874 "Create a new back-end as a variant of an existing one.
876 CHILD is the name of the derived back-end. PARENT is the name of
877 the parent back-end.
879 BODY can start with pre-defined keyword arguments. The following
880 keywords are understood:
882 :export-block
884 String, or list of strings, representing block names that
885 will not be parsed. This is used to specify blocks that will
886 contain raw code specific to the back-end. These blocks
887 still have to be handled by the relative `export-block' type
888 translator.
890 :filters-alist
892 Alist of filters that will overwrite or complete filters
893 defined in PARENT back-end. See `org-export-filters-alist'
894 for a list of allowed filters.
896 :menu-entry
898 Menu entry for the export dispatcher. See
899 `org-export-define-backend' for more information about the
900 expected value.
902 :options-alist
904 Alist of back-end specific properties that will overwrite or
905 complete those defined in PARENT back-end. Refer to
906 `org-export-options-alist' for more information about
907 structure of the values.
909 :translate-alist
911 Alist of element and object types and transcoders that will
912 overwrite or complete transcode table from PARENT back-end.
913 Refer to `org-export-define-backend' for detailed information
914 about transcoders.
917 as a variant of `e-latex' back-end with a custom template
918 function:
920 \(org-export-define-derived-backend my-latex e-latex
921 :translate-alist ((template . my-latex-template-fun)))
923 The back-end could then be called with, for example:
949 ;; Register back-end.
953 ;; Tell parser to not parse EXPORT-BLOCK blocks.
960 ;; Splice in the body, if any.
964 "Return filters for BACKEND."
969 "Return menu entry for BACKEND."
974 "Return export options for BACKEND."
979 "Return translate table for BACKEND."
984 "Signal an error if BACKEND isn't defined."
989 \f
990 ;;; The Communication Channel
991 ;;
992 ;; During export process, every function has access to a number of
993 ;; properties. They are of two types:
994 ;;
995 ;; 1. Environment options are collected once at the very beginning of
996 ;; the process, out of the original buffer and configuration.
997 ;; Collecting them is handled by `org-export-get-environment'
998 ;; function.
999 ;;
1000 ;; Most environment options are defined through the
1001 ;; `org-export-options-alist' variable.
1002 ;;
1003 ;; 2. Tree properties are extracted directly from the parsed tree,
1004 ;; just before export, by `org-export-collect-tree-properties'.
1005 ;;
1006 ;; Here is the full list of properties available during transcode
1007 ;; process, with their category and their value type.
1008 ;;
1009 ;; + `:author' :: Author's name.
1010 ;; - category :: option
1011 ;; - type :: string
1012 ;;
1013 ;; + `:back-end' :: Current back-end used for transcoding.
1014 ;; - category :: tree
1015 ;; - type :: symbol
1016 ;;
1017 ;; + `:creator' :: String to write as creation information.
1018 ;; - category :: option
1019 ;; - type :: string
1020 ;;
1021 ;; + `:date' :: String to use as date.
1022 ;; - category :: option
1023 ;; - type :: string
1024 ;;
1025 ;; + `:description' :: Description text for the current data.
1026 ;; - category :: option
1027 ;; - type :: string
1028 ;;
1029 ;; + `:email' :: Author's email.
1030 ;; - category :: option
1031 ;; - type :: string
1032 ;;
1033 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1034 ;; process.
1035 ;; - category :: option
1036 ;; - type :: list of strings
1037 ;;
1038 ;; + `:exported-data' :: Hash table used for memoizing
1039 ;; `org-export-data'.
1040 ;; - category :: tree
1041 ;; - type :: hash table
1042 ;;
1043 ;; + `:filetags' :: List of global tags for buffer. Used by
1044 ;; `org-export-get-tags' to get tags with inheritance.
1045 ;; - category :: option
1046 ;; - type :: list of strings
1047 ;;
1048 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1049 ;; their definition, as parsed data. Only non-inlined footnotes
1050 ;; are represented in this alist. Also, every definition isn't
1051 ;; guaranteed to be referenced in the parse tree. The purpose of
1052 ;; this property is to preserve definitions from oblivion
1053 ;; (i.e. when the parse tree comes from a part of the original
1054 ;; buffer), it isn't meant for direct use in a back-end. To
1055 ;; retrieve a definition relative to a reference, use
1056 ;; `org-export-get-footnote-definition' instead.
1057 ;; - category :: option
1058 ;; - type :: alist (STRING . LIST)
1059 ;;
1060 ;; + `:headline-levels' :: Maximum level being exported as an
1061 ;; headline. Comparison is done with the relative level of
1062 ;; headlines in the parse tree, not necessarily with their
1063 ;; actual level.
1064 ;; - category :: option
1065 ;; - type :: integer
1066 ;;
1067 ;; + `:headline-offset' :: Difference between relative and real level
1068 ;; of headlines in the parse tree. For example, a value of -1
1069 ;; means a level 2 headline should be considered as level
1070 ;; 1 (cf. `org-export-get-relative-level').
1071 ;; - category :: tree
1072 ;; - type :: integer
1073 ;;
1074 ;; + `:headline-numbering' :: Alist between headlines and their
1075 ;; numbering, as a list of numbers
1076 ;; (cf. `org-export-get-headline-number').
1077 ;; - category :: tree
1078 ;; - type :: alist (INTEGER . LIST)
1079 ;;
1080 ;; + `:id-alist' :: Alist between ID strings and destination file's
1081 ;; path, relative to current directory. It is used by
1082 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1083 ;; external file.
1084 ;; - category :: option
1085 ;; - type :: alist (STRING . STRING)
1086 ;;
1087 ;; + `:ignore-list' :: List of elements and objects that should be
1088 ;; ignored during export.
1089 ;; - category :: tree
1090 ;; - type :: list of elements and objects
1091 ;;
1092 ;; + `:input-file' :: Full path to input file, if any.
1093 ;; - category :: option
1094 ;; - type :: string or nil
1095 ;;
1096 ;; + `:keywords' :: List of keywords attached to data.
1097 ;; - category :: option
1098 ;; - type :: string
1099 ;;
1100 ;; + `:language' :: Default language used for translations.
1101 ;; - category :: option
1102 ;; - type :: string
1103 ;;
1104 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1105 ;; transcoding.
1106 ;; - category :: option
1107 ;; - type :: list (as returned by `org-element-parse-buffer')
1108 ;;
1109 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1110 ;; all line breaks.
1111 ;; - category :: option
1112 ;; - type :: symbol (nil, t)
1113 ;;
1114 ;; + `:section-numbers' :: Non-nil means transcoding should add
1115 ;; section numbers to headlines.
1116 ;; - category :: option
1117 ;; - type :: symbol (nil, t)
1118 ;;
1119 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1120 ;; in transcoding. When such a tag is present, subtrees without
1121 ;; it are de facto excluded from the process. See
1122 ;; `use-select-tags'.
1123 ;; - category :: option
1124 ;; - type :: list of strings
1125 ;;
1126 ;; + `:target-list' :: List of targets encountered in the parse tree.
1127 ;; This is used to partly resolve "fuzzy" links
1128 ;; (cf. `org-export-resolve-fuzzy-link').
1129 ;; - category :: tree
1130 ;; - type :: list of strings
1131 ;;
1132 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1133 ;; a time stamp in the output.
1134 ;; - category :: option
1135 ;; - type :: symbol (nil, t)
1136 ;;
1137 ;; + `:translate-alist' :: Alist between element and object types and
1138 ;; transcoding functions relative to the current back-end.
1139 ;; Special keys `template' and `plain-text' are also possible.
1140 ;; - category :: option
1141 ;; - type :: alist (SYMBOL . FUNCTION)
1142 ;;
1143 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1144 ;; also be transcoded. If it is set to the `headline' symbol,
1145 ;; only the archived headline's name is retained.
1146 ;; - category :: option
1147 ;; - type :: symbol (nil, t, `headline')
1148 ;;
1149 ;; + `:with-author' :: Non-nil means author's name should be included
1150 ;; in the output.
1151 ;; - category :: option
1152 ;; - type :: symbol (nil, t)
1153 ;;
1154 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1155 ;; - category :: option
1156 ;; - type :: symbol (nil, t)
1157 ;;
1158 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1159 ;; inserted at the end of the transcoded string. If the value
1160 ;; is `comment', it should be commented.
1161 ;; - category :: option
1162 ;; - type :: symbol (`comment', nil, t)
1163 ;;
1164 ;; + `:with-date' :: Non-nil means output should contain a date.
1165 ;; - category :: option
1166 ;; - type :. symbol (nil, t)
1167 ;;
1168 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1169 ;; its value is a list of names, only drawers with such names
1170 ;; will be transcoded.
1171 ;; - category :: option
1172 ;; - type :: symbol (nil, t) or list of strings
1173 ;;
1174 ;; + `:with-email' :: Non-nil means output should contain author's
1175 ;; email.
1176 ;; - category :: option
1177 ;; - type :: symbol (nil, t)
1178 ;;
1179 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1180 ;; interpreted.
1181 ;; - category :: option
1182 ;; - type :: symbol (nil, t)
1183 ;;
1184 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1185 ;; strings starting with a colon as a fixed-with (verbatim) area.
1186 ;; - category :: option
1187 ;; - type :: symbol (nil, t)
1188 ;;
1189 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1190 ;; footnotes.
1191 ;; - category :: option
1192 ;; - type :: symbol (nil, t)
1193 ;;
1194 ;; + `:with-plannings' :: Non-nil means transcoding should include
1195 ;; planning info.
1196 ;; - category :: option
1197 ;; - type :: symbol (nil, t)
1198 ;;
1199 ;; + `:with-priority' :: Non-nil means transcoding should include
1200 ;; priority cookies.
1201 ;; - category :: option
1202 ;; - type :: symbol (nil, t)
1203 ;;
1204 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1205 ;; plain text.
1206 ;; - category :: option
1207 ;; - type :: symbol (nil, t)
1208 ;;
1209 ;; + `:with-special-strings' :: Non-nil means transcoding should
1210 ;; interpret special strings in plain text.
1211 ;; - category :: option
1212 ;; - type :: symbol (nil, t)
1213 ;;
1214 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1215 ;; interpret subscript and superscript. With a value of "{}",
1216 ;; only interpret those using curly brackets.
1217 ;; - category :: option
1218 ;; - type :: symbol (nil, {}, t)
1219 ;;
1220 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1221 ;; tables.
1222 ;; - category :: option
1223 ;; - type :: symbol (nil, t)
1224 ;;
1225 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1226 ;; headlines. A `not-in-toc' value will remove them from the
1227 ;; table of contents, if any, nonetheless.
1228 ;; - category :: option
1229 ;; - type :: symbol (nil, t, `not-in-toc')
1230 ;;
1231 ;; + `:with-tasks' :: Non-nil means transcoding should include
1232 ;; headlines with a TODO keyword. A `todo' value will only
1233 ;; include headlines with a todo type keyword while a `done'
1234 ;; value will do the contrary. If a list of strings is provided,
1235 ;; only tasks with keywords belonging to that list will be kept.
1236 ;; - category :: option
1237 ;; - type :: symbol (t, todo, done, nil) or list of strings
1238 ;;
1239 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1240 ;; time stamps. Special value `active' (resp. `inactive') ask to
1241 ;; export only active (resp. inactive) timestamps. Otherwise,
1242 ;; completely remove them.
1243 ;; - category :: option
1244 ;; - type :: symbol: (`active', `inactive', t, nil)
1245 ;;
1246 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1247 ;; added to the output. An integer value limits its depth.
1248 ;; - category :: option
1249 ;; - type :: symbol (nil, t or integer)
1250 ;;
1251 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1252 ;; include TODO keywords.
1253 ;; - category :: option
1254 ;; - type :: symbol (nil, t)
1257 ;;;; Environment Options
1258 ;;
1259 ;; Environment options encompass all parameters defined outside the
1260 ;; scope of the parsed data. They come from five sources, in
1261 ;; increasing precedence order:
1262 ;;
1263 ;; - Global variables,
1264 ;; - Buffer's attributes,
1265 ;; - Options keyword symbols,
1266 ;; - Buffer keywords,
1267 ;; - Subtree properties.
1268 ;;
1269 ;; The central internal function with regards to environment options
1270 ;; is `org-export-get-environment'. It updates global variables with
1271 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1272 ;; the different sources.
1273 ;;
1274 ;; The internal functions doing the retrieval are:
1275 ;; `org-export--get-global-options',
1276 ;; `org-export--get-buffer-attributes',
1277 ;; `org-export--parse-option-keyword',
1278 ;; `org-export--get-subtree-options' and
1279 ;; `org-export--get-inbuffer-options'
1280 ;;
1281 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1282 ;; take care of the part relative to "#+BIND:" keywords.
1285 "Collect export options from the current buffer.
1287 Optional argument BACKEND is a symbol specifying which back-end
1288 specific options to read, if any.
1290 When optional argument SUBTREEP is non-nil, assume the export is
1291 done against the current sub-tree.
1293 Third optional argument EXT-PLIST is a property list with
1294 external parameters overriding Org default settings, but still
1295 inferior to file-local settings."
1296 ;; First install #+BIND variables.
1298 ;; Get and prioritize export options...
1300 ;; ... from global variables...
1302 ;; ... from an external property list...
1303 ext-plist
1304 ;; ... from in-buffer settings...
1306 backend
1308 ;; ... and from subtree, when appropriate.
1310 ;; Eventually add misc. properties.
1312 :back-end
1313 backend
1314 :translate-alist
1316 :footnote-definition-alist
1317 ;; Footnotes definitions must be collected in the original
1318 ;; buffer, as there's no insurance that they will still be in
1319 ;; the parse tree, due to possible narrowing.
1333 alist))))
1334 alist))
1335 :id-alist
1336 ;; Collect id references.
1347 alist))))
1350 "Parse an OPTIONS line and return values as a plist.
1351 Optional argument BACKEND is a symbol specifying which back-end
1352 specific items to read, if any."
1355 ;; Build an alist between #+OPTION: item and property-name.
1360 all)))
1361 plist)
1366 options)
1371 alist)
1372 plist))
1375 "Get export options in subtree at point.
1376 Optional argument BACKEND is a symbol specifying back-end used
1377 for export. Return options as a plist."
1378 ;; For each buffer keyword, create an headline property setting the
1379 ;; same property in communication channel. The name for the property
1380 ;; is the keyword with "EXPORT_" appended to it.
1383 ;; Make sure point is at an heading.
1385 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1386 ;; title as its fallback value.
1393 plist :title
1396 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1400 ;; Handle other keywords. TITLE keyword is excluded as it has
1401 ;; been handled already.
1408 ;; Export properties are not case-sensitive.
1415 plist
1417 ;; Parse VALUE if required.
1421 value))))))))
1422 ;; Also look for both general keywords and back-end specific
1423 ;; options if BACKEND is provided.
1425 org-export-options-alist)))
1426 ;; Return value.
1427 plist)))
1430 "Return current buffer export options, as a plist.
1432 Optional argument BACKEND, when non-nil, is a symbol specifying
1433 which back-end specific options should also be read in the
1434 process.
1436 Optional argument FILES is a list of setup files names read so
1437 far, used to avoid circular dependencies.
1439 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1443 ;; 1. Special keywords, as in `org-export-special-keywords'.
1457 ;; Avoid circular dependencies.
1472 ;; 2. Standard options, as in `org-export-options-alist'.
1474 ;; Also look for back-end specific options if
1475 ;; BACKEND is defined.
1477 ;; Build ALIST between keyword name and property name.
1481 all)))
1482 ;; Build regexp matching all keywords associated to export
1483 ;; options. Note: the search is case insensitive.
1497 plist prop
1498 ;; Handle value depending on specified BEHAVIOUR.
1511 ;; Parse keywords specified in
1512 ;; `org-element-document-properties'.
1520 plist prop
1523 org-element-document-properties))
1524 ;; 3. Return final value.
1525 plist)))
1528 "Return properties related to buffer attributes, as a plist."
1531 ;; Store full path of input file name, or nil. For internal use.
1532 :input-file visited-file
1539 "Return global export options as a plist.
1541 Optional argument BACKEND, if non-nil, is a symbol specifying
1542 which back-end specific export options should also be read in the
1543 process."
1546 ;; Output value.
1547 plist)
1552 plist
1554 ;; Eval default value provided. If keyword is a member
1555 ;; of `org-element-document-properties', parse it as
1556 ;; a secondary string before storing it.
1561 value
1564 all)
1565 ;; Return value.
1566 plist))
1570 "Can we use #+BIND values during export?
1571 By default this will ask for confirmation by the user, to divert
1572 possible security risks."
1577 org-export--allow-BIND-local)
1582 "Install the values from #+BIND lines as local variables.
1583 Variables must be installed before in-buffer options are
1584 retrieved."
1599 ;;;; Tree Properties
1600 ;;
1601 ;; Tree properties are information extracted from parse tree. They
1602 ;; are initialized at the beginning of the transcoding process by
1603 ;; `org-export-collect-tree-properties'.
1604 ;;
1605 ;; Dedicated functions focus on computing the value of specific tree
1606 ;; properties during initialization. Thus,
1607 ;; `org-export--populate-ignore-list' lists elements and objects that
1608 ;; should be skipped during export, `org-export--get-min-level' gets
1609 ;; the minimal exportable level, used as a basis to compute relative
1610 ;; level for headlines. Eventually
1611 ;; `org-export--collect-headline-numbering' builds an alist between
1612 ;; headlines and their numbering.
1615 "Extract tree properties from parse tree.
1617 DATA is the parse tree from which information is retrieved. INFO
1618 is a list holding export options.
1620 Following tree properties are set or updated:
1622 `:exported-data' Hash table used to memoize results from
1623 `org-export-data'.
1625 `:footnote-definition-alist' List of footnotes definitions in
1626 original buffer and current parse tree.
1628 `:headline-offset' Offset between true level of headlines and
1629 local level. An offset of -1 means an headline
1630 of level 2 should be considered as a level
1631 1 headline in the context.
1633 `:headline-numbering' Alist of all headlines as key an the
1634 associated numbering as value.
1636 `:ignore-list' List of elements that should be ignored during
1637 export.
1639 `:target-list' List of all targets in the parse tree.
1641 Return updated plist."
1642 ;; Install the parse tree in the communication channel, in order to
1643 ;; use `org-export-get-genealogy' and al.
1645 ;; Get the list of elements and objects to ignore, and put it into
1646 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1647 ;; been done during parse tree filtering.
1650 :ignore-list
1653 ;; Compute `:headline-offset' in order to be able to use
1654 ;; `org-export-get-relative-level'.
1657 :headline-offset
1659 ;; Update footnotes definitions list with definitions in parse tree.
1660 ;; This is required since buffer expansion might have modified
1661 ;; boundaries of footnote definitions contained in the parse tree.
1662 ;; This way, definitions in `footnote-definition-alist' are bound to
1663 ;; match those in the parse tree.
1666 data 'footnote-definition
1670 defs)))
1672 ;; Properties order doesn't matter: get the rest of the tree
1673 ;; properties.
1675 `(:target-list
1684 info))
1687 "Return minimum exportable headline's level in DATA.
1688 DATA is parsed tree as returned by `org-element-parse-buffer'.
1689 OPTIONS is a plist holding export options."
1700 ;; If no headline was found, for the sake of consistency, set
1701 ;; minimum level to 1 nonetheless.
1705 "Return numbering of all exportable headlines in a parse tree.
1707 DATA is the parse tree. OPTIONS is the plist holding export
1708 options.
1710 Return an alist whose key is an headline and value is its
1711 associated numbering \(in the shape of a list of numbers\)."
1714 data
1715 'headline
1720 headline
1722 for idx from 0 to org-export-max-depth
1726 options)))
1729 "Return list of elements and objects to ignore during export.
1730 DATA is the parse tree to traverse. OPTIONS is the plist holding
1731 export options."
1733 walk-data
1734 ;; First find trees containing a select tag, if any.
1738 ;; Collect ignored elements or objects into IGNORE-LIST.
1744 ;; If headline is archived but tree below has
1745 ;; to be skipped, add it to ignore list.
1748 ;; Move into secondary string, if any.
1753 ;; Move into recursive objects/elements.
1755 ;; Main call.
1757 ;; Return value.
1758 ignore))
1761 "Return list of headlines containing a select tag in their tree.
1762 DATA is parsed data as returned by `org-element-parse-buffer'.
1763 INFO is a plist holding export options."
1765 walk-data ; for byte-compiler.
1776 ;; When a select tag is found, mark full
1777 ;; genealogy and every headline within the tree
1778 ;; as acceptable.
1781 genealogy
1783 selected-trees))
1784 ;; Else, continue searching in tree, recursively.
1791 "Non-nil when element or object BLOB should be skipped during export.
1792 OPTIONS is the plist holding export options. SELECTED, when
1793 non-nil, is a list of headlines belonging to a tree with a select
1794 tag."
1809 ;; Ignore subtrees with an exclude tag.
1812 ;; When a select tag is present in the buffer, ignore any tree
1813 ;; without it.
1815 ;; Ignore commented sub-trees.
1817 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1819 ;; Ignore tasks, if specified by `:with-tasks' property.
1835 ;; No timestamp allowed.
1837 ;; Only active timestamps allowed and the current one isn't
1838 ;; active.
1842 ;; Only inactive timestamps allowed and the current one isn't
1843 ;; inactive.
1849 \f
1850 ;;; The Transcoder
1851 ;;
1852 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1853 ;; `org-element-parse-buffer') and transcodes it into a specified
1854 ;; back-end output. It takes care of filtering out elements or
1855 ;; objects according to export options and organizing the output blank
1856 ;; lines and white space are preserved. The function memoizes its
1857 ;; results, so it is cheap to call it within translators.
1858 ;;
1859 ;; Internally, three functions handle the filtering of objects and
1860 ;; elements during the export. In particular,
1861 ;; `org-export-ignore-element' marks an element or object so future
1862 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1863 ;; elements or objects should be seen as real Org syntax and
1864 ;; `org-export-expand' transforms the others back into their original
1865 ;; shape
1866 ;;
1867 ;; `org-export-transcoder' is an accessor returning appropriate
1868 ;; translator function for a given element or object.
1871 "Return appropriate transcoder for BLOB.
1872 INFO is a plist containing export directives."
1874 ;; Return contents only for complete parse trees.
1880 "Convert DATA into current back-end format.
1882 DATA is a parse tree, an element or an object or a secondary
1883 string. INFO is a plist holding export options.
1885 Return transcoded string."
1891 ;; Ignored element/object.
1893 ;; Plain text. All residual text properties from parse
1894 ;; tree (i.e. `:parent' property) are removed.
1901 info)))
1902 ;; Uninterpreted element/object: change it back to Org
1903 ;; syntax and export again resulting raw string.
1907 data
1911 info))
1912 ;; Secondary string.
1915 ;; Element/Object without contents or, as a special case,
1916 ;; headline with archive tag and archived trees restricted
1917 ;; to title only.
1925 ;; Element/Object with contents.
1938 ;; Elements directly containing objects
1939 ;; must have their indentation normalized
1940 ;; first.
1942 data
1943 ;; When normalizing contents of the first
1944 ;; paragraph in an item or a footnote
1945 ;; definition, ignore first line's
1946 ;; indentation: there is none and it
1947 ;; might be misleading.
1952 data)
1959 info))))))))
1960 ;; Final result will be memoized before being returned.
1962 data
1966 ;; Append the same white space between elements or objects as in
1967 ;; the original buffer, and call appropriate filters.
1978 info)))
1979 results)))
1983 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1984 Check is done according to export options INFO, stored as
1985 a plist."
1987 ;; ... entities...
1989 ;; ... emphasis...
1991 ;; ... fixed-width areas.
1993 ;; ... footnotes...
1996 ;; ... sub/superscripts...
2002 ;; ... tables...
2007 "Expand a parsed element or object to its original state.
2008 BLOB is either an element or an object. CONTENTS is its
2009 contents, as a string or nil."
2012 blob contents))
2015 "Add ELEMENT to `:ignore-list' in INFO.
2017 Any element in `:ignore-list' will be skipped when using
2018 `org-element-map'. INFO is modified by side effects."
2022 \f
2023 ;;; The Filter System
2024 ;;
2025 ;; Filters allow end-users to tweak easily the transcoded output.
2026 ;; They are the functional counterpart of hooks, as every filter in
2027 ;; a set is applied to the return value of the previous one.
2028 ;;
2029 ;; Every set is back-end agnostic. Although, a filter is always
2030 ;; called, in addition to the string it applies to, with the back-end
2031 ;; used as argument, so it's easy for the end-user to add back-end
2032 ;; specific filters in the set. The communication channel, as
2033 ;; a plist, is required as the third argument.
2034 ;;
2035 ;; From the developer side, filters sets can be installed in the
2036 ;; process with the help of `org-export-define-backend', which
2037 ;; internally stores filters as an alist. Each association has a key
2038 ;; among the following symbols and a function or a list of functions
2039 ;; as value.
2040 ;;
2041 ;; - `:filter-parse-tree' applies directly on the complete parsed
2042 ;; tree. It's the only filters set that doesn't apply to a string.
2043 ;; Users can set it through `org-export-filter-parse-tree-functions'
2044 ;; variable.
2045 ;;
2046 ;; - `:filter-final-output' applies to the final transcoded string.
2047 ;; Users can set it with `org-export-filter-final-output-functions'
2048 ;; variable
2049 ;;
2050 ;; - `:filter-plain-text' applies to any string not recognized as Org
2051 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2052 ;; configure it.
2053 ;;
2054 ;; - `:filter-TYPE' applies on the string returned after an element or
2055 ;; object of type TYPE has been transcoded. An user can modify
2056 ;; `org-export-filter-TYPE-functions'
2057 ;;
2058 ;; All filters sets are applied with
2059 ;; `org-export-filter-apply-functions' function. Filters in a set are
2060 ;; applied in a LIFO fashion. It allows developers to be sure that
2061 ;; their filters will be applied first.
2062 ;;
2063 ;; Filters properties are installed in communication channel with
2064 ;; `org-export-install-filters' function.
2065 ;;
2066 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2067 ;; `org-export-before-parsing-hook') are run at the beginning of the
2068 ;; export process and just before parsing to allow for heavy structure
2069 ;; modifications.
2072 ;;;; Hooks
2075 "Hook run at the beginning of the export process.
2077 This is run before include keywords and macros are expanded and
2078 Babel code blocks executed, on a copy of the original buffer
2079 being exported. Visibility and narrowing are preserved. Point
2080 is at the beginning of the buffer.
2082 Every function in this hook will be called with one argument: the
2086 "Hook run before parsing an export buffer.
2088 This is run after include keywords and macros have been expanded
2089 and Babel code blocks executed, on a copy of the original buffer
2090 being exported. Visibility and narrowing are preserved. Point
2091 is at the beginning of the buffer.
2093 Every function in this hook will be called with one argument: the
2097 ;;;; Special Filters
2100 "List of functions applied to the parsed tree.
2101 Each filter is called with three arguments: the parse tree, as
2102 returned by `org-element-parse-buffer', the back-end, as
2103 a symbol, and the communication channel, as a plist. It must
2107 "List of functions applied to the transcoded string.
2108 Each filter is called with three arguments: the full transcoded
2109 string, the back-end, as a symbol, and the communication channel,
2110 as a plist. It must return a string that will be used as the
2114 "List of functions applied to plain text.
2115 Each filter is called with three arguments: a string which
2116 contains no Org syntax, the back-end, as a symbol, and the
2117 communication channel, as a plist. It must return a string or
2121 ;;;; Elements Filters
2124 "List of functions applied to a transcoded babel-call.
2125 Each filter is called with three arguments: the transcoded data,
2126 as a string, the back-end, as a symbol, and the communication
2130 "List of functions applied to a transcoded center block.
2131 Each filter is called with three arguments: the transcoded data,
2132 as a string, the back-end, as a symbol, and the communication
2136 "List of functions applied to a transcoded clock.
2137 Each filter is called with three arguments: the transcoded data,
2138 as a string, the back-end, as a symbol, and the communication
2142 "List of functions applied to a transcoded comment.
2143 Each filter is called with three arguments: the transcoded data,
2144 as a string, the back-end, as a symbol, and the communication
2148 "List of functions applied to a transcoded comment-block.
2149 Each filter is called with three arguments: the transcoded data,
2150 as a string, the back-end, as a symbol, and the communication
2154 "List of functions applied to a transcoded diary-sexp.
2155 Each filter is called with three arguments: the transcoded data,
2156 as a string, the back-end, as a symbol, and the communication
2160 "List of functions applied to a transcoded drawer.
2161 Each filter is called with three arguments: the transcoded data,
2162 as a string, the back-end, as a symbol, and the communication
2166 "List of functions applied to a transcoded dynamic-block.
2167 Each filter is called with three arguments: the transcoded data,
2168 as a string, the back-end, as a symbol, and the communication
2172 "List of functions applied to a transcoded example-block.
2173 Each filter is called with three arguments: the transcoded data,
2174 as a string, the back-end, as a symbol, and the communication
2178 "List of functions applied to a transcoded export-block.
2179 Each filter is called with three arguments: the transcoded data,
2180 as a string, the back-end, as a symbol, and the communication
2184 "List of functions applied to a transcoded fixed-width.
2185 Each filter is called with three arguments: the transcoded data,
2186 as a string, the back-end, as a symbol, and the communication
2190 "List of functions applied to a transcoded footnote-definition.
2191 Each filter is called with three arguments: the transcoded data,
2192 as a string, the back-end, as a symbol, and the communication
2196 "List of functions applied to a transcoded headline.
2197 Each filter is called with three arguments: the transcoded data,
2198 as a string, the back-end, as a symbol, and the communication
2202 "List of functions applied to a transcoded horizontal-rule.
2203 Each filter is called with three arguments: the transcoded data,
2204 as a string, the back-end, as a symbol, and the communication
2208 "List of functions applied to a transcoded inlinetask.
2209 Each filter is called with three arguments: the transcoded data,
2210 as a string, the back-end, as a symbol, and the communication
2214 "List of functions applied to a transcoded item.
2215 Each filter is called with three arguments: the transcoded data,
2216 as a string, the back-end, as a symbol, and the communication
2220 "List of functions applied to a transcoded keyword.
2221 Each filter is called with three arguments: the transcoded data,
2222 as a string, the back-end, as a symbol, and the communication
2226 "List of functions applied to a transcoded latex-environment.
2227 Each filter is called with three arguments: the transcoded data,
2228 as a string, the back-end, as a symbol, and the communication
2232 "List of functions applied to a transcoded node-property.
2233 Each filter is called with three arguments: the transcoded data,
2234 as a string, the back-end, as a symbol, and the communication
2238 "List of functions applied to a transcoded paragraph.
2239 Each filter is called with three arguments: the transcoded data,
2240 as a string, the back-end, as a symbol, and the communication
2244 "List of functions applied to a transcoded plain-list.
2245 Each filter is called with three arguments: the transcoded data,
2246 as a string, the back-end, as a symbol, and the communication
2250 "List of functions applied to a transcoded planning.
2251 Each filter is called with three arguments: the transcoded data,
2252 as a string, the back-end, as a symbol, and the communication
2256 "List of functions applied to a transcoded property-drawer.
2257 Each filter is called with three arguments: the transcoded data,
2258 as a string, the back-end, as a symbol, and the communication
2262 "List of functions applied to a transcoded quote block.
2263 Each filter is called with three arguments: the transcoded quote
2264 data, as a string, the back-end, as a symbol, and the
2265 communication channel, as a plist. It must return a string or
2269 "List of functions applied to a transcoded quote-section.
2270 Each filter is called with three arguments: the transcoded data,
2271 as a string, the back-end, as a symbol, and the communication
2275 "List of functions applied to a transcoded section.
2276 Each filter is called with three arguments: the transcoded data,
2277 as a string, the back-end, as a symbol, and the communication
2281 "List of functions applied to a transcoded special block.
2282 Each filter is called with three arguments: the transcoded data,
2283 as a string, the back-end, as a symbol, and the communication
2287 "List of functions applied to a transcoded src-block.
2288 Each filter is called with three arguments: the transcoded data,
2289 as a string, the back-end, as a symbol, and the communication
2293 "List of functions applied to a transcoded table.
2294 Each filter is called with three arguments: the transcoded data,
2295 as a string, the back-end, as a symbol, and the communication
2299 "List of functions applied to a transcoded table-cell.
2300 Each filter is called with three arguments: the transcoded data,
2301 as a string, the back-end, as a symbol, and the communication
2305 "List of functions applied to a transcoded table-row.
2306 Each filter is called with three arguments: the transcoded data,
2307 as a string, the back-end, as a symbol, and the communication
2311 "List of functions applied to a transcoded verse block.
2312 Each filter is called with three arguments: the transcoded data,
2313 as a string, the back-end, as a symbol, and the communication
2317 ;;;; Objects Filters
2320 "List of functions applied to transcoded bold text.
2321 Each filter is called with three arguments: the transcoded data,
2322 as a string, the back-end, as a symbol, and the communication
2326 "List of functions applied to transcoded code text.
2327 Each filter is called with three arguments: the transcoded data,
2328 as a string, the back-end, as a symbol, and the communication
2332 "List of functions applied to a transcoded entity.
2333 Each filter is called with three arguments: the transcoded data,
2334 as a string, the back-end, as a symbol, and the communication
2338 "List of functions applied to a transcoded export-snippet.
2339 Each filter is called with three arguments: the transcoded data,
2340 as a string, the back-end, as a symbol, and the communication
2344 "List of functions applied to a transcoded footnote-reference.
2345 Each filter is called with three arguments: the transcoded data,
2346 as a string, the back-end, as a symbol, and the communication
2350 "List of functions applied to a transcoded inline-babel-call.
2351 Each filter is called with three arguments: the transcoded data,
2352 as a string, the back-end, as a symbol, and the communication
2356 "List of functions applied to a transcoded inline-src-block.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 "List of functions applied to transcoded italic text.
2363 Each filter is called with three arguments: the transcoded data,
2364 as a string, the back-end, as a symbol, and the communication
2368 "List of functions applied to a transcoded latex-fragment.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded line-break.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 "List of functions applied to a transcoded link.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to a transcoded macro.
2387 Each filter is called with three arguments: the transcoded data,
2388 as a string, the back-end, as a symbol, and the communication
2392 "List of functions applied to a transcoded radio-target.
2393 Each filter is called with three arguments: the transcoded data,
2394 as a string, the back-end, as a symbol, and the communication
2398 "List of functions applied to a transcoded statistics-cookie.
2399 Each filter is called with three arguments: the transcoded data,
2400 as a string, the back-end, as a symbol, and the communication
2404 "List of functions applied to transcoded strike-through text.
2405 Each filter is called with three arguments: the transcoded data,
2406 as a string, the back-end, as a symbol, and the communication
2410 "List of functions applied to a transcoded subscript.
2411 Each filter is called with three arguments: the transcoded data,
2412 as a string, the back-end, as a symbol, and the communication
2416 "List of functions applied to a transcoded superscript.
2417 Each filter is called with three arguments: the transcoded data,
2418 as a string, the back-end, as a symbol, and the communication
2422 "List of functions applied to a transcoded target.
2423 Each filter is called with three arguments: the transcoded data,
2424 as a string, the back-end, as a symbol, and the communication
2428 "List of functions applied to a transcoded timestamp.
2429 Each filter is called with three arguments: the transcoded data,
2430 as a string, the back-end, as a symbol, and the communication
2434 "List of functions applied to transcoded underline text.
2435 Each filter is called with three arguments: the transcoded data,
2436 as a string, the back-end, as a symbol, and the communication
2440 "List of functions applied to transcoded verbatim text.
2441 Each filter is called with three arguments: the transcoded data,
2442 as a string, the back-end, as a symbol, and the communication
2446 ;;;; Filters Tools
2447 ;;
2448 ;; Internal function `org-export-install-filters' installs filters
2449 ;; hard-coded in back-ends (developer filters) and filters from global
2450 ;; variables (user filters) in the communication channel.
2451 ;;
2452 ;; Internal function `org-export-filter-apply-functions' takes care
2453 ;; about applying each filter in order to a given data. It ignores
2454 ;; filters returning a nil value but stops whenever a filter returns
2455 ;; an empty string.
2458 "Call every function in FILTERS.
2460 Functions are called with arguments VALUE, current export
2461 back-end and INFO. A function returning a nil value will be
2462 skipped. If it returns the empty string, the process ends and
2463 VALUE is ignored.
2465 Call is done in a LIFO fashion, to be sure that developer
2466 specified filters, if any, are called first."
2475 "Install filters properties in communication channel.
2477 INFO is a plist containing the current communication channel.
2479 Return the updated communication channel."
2481 ;; Install user defined filters with `org-export-filters-alist'.
2484 org-export-filters-alist)
2485 ;; Prepend back-end specific filters to that list.
2487 ;; Single values get consed, lists are prepended.
2492 plist key
2496 ;; Return new communication channel.
2500 \f
2501 ;;; Core functions
2502 ;;
2503 ;; This is the room for the main function, `org-export-as', along with
2504 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2505 ;; They differ only by the way they output the resulting code.
2506 ;;
2507 ;; `org-export-output-file-name' is an auxiliary function meant to be
2508 ;; used with `org-export-to-file'. With a given extension, it tries
2509 ;; to provide a canonical file name to write export output to.
2510 ;;
2511 ;; Note that `org-export-as' doesn't really parse the current buffer,
2512 ;; but a copy of it (with the same buffer-local variables and
2513 ;; visibility), where macros and include keywords are expanded and
2514 ;; Babel blocks are executed, if appropriate.
2515 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2516 ;;
2517 ;; File inclusion is taken care of by
2518 ;; `org-export-expand-include-keyword' and
2519 ;; `org-export--prepare-file-contents'. Structure wise, including
2520 ;; a whole Org file in a buffer often makes little sense. For
2521 ;; example, if the file contains an headline and the include keyword
2522 ;; was within an item, the item should contain the headline. That's
2523 ;; why file inclusion should be done before any structure can be
2524 ;; associated to the file, that is before parsing.
2528 "Transcode current Org buffer into BACKEND code.
2530 If narrowing is active in the current buffer, only transcode its
2531 narrowed part.
2533 If a region is active, transcode that region.
2535 When optional argument SUBTREEP is non-nil, transcode the
2536 sub-tree at point, extracting information from the headline
2537 properties first.
2539 When optional argument VISIBLE-ONLY is non-nil, don't export
2540 contents of hidden elements.
2542 When optional argument BODY-ONLY is non-nil, only return body
2543 code, without preamble nor postamble.
2545 Optional argument EXT-PLIST, when provided, is a property list
2546 with external parameters overriding Org default settings, but
2547 still inferior to file-local settings.
2549 Optional argument NOEXPAND, when non-nil, prevents included files
2550 to be expanded and Babel code to be executed.
2552 Return code as a string."
2553 ;; Barf if BACKEND isn't registered.
2557 ;; Narrow buffer to an appropriate region or subtree for
2558 ;; parsing. If parsing subtree, be sure to remove main headline
2559 ;; too.
2567 ;; Initialize communication channel with original buffer
2568 ;; attributes, unavailable in its copy.
2571 ;; Run first hook with current back-end as argument.
2573 ;; Update communication channel and get parse tree. Buffer
2574 ;; isn't parsed directly. Instead, a temporary copy is
2575 ;; created, where include keywords, macros are expanded and
2576 ;; code blocks are evaluated.
2579 ;; Update macro templates since #+INCLUDE keywords might
2580 ;; have added some new ones.
2583 ;; TODO: Setting `org-current-export-file' is required by
2584 ;; Org Babel to properly resolve noweb references. Once
2585 ;; "org-exp.el" is removed, modify
2586 ;; `org-export-blocks-preprocess' so it accepts the value
2587 ;; as an argument instead.
2590 ;; Update radio targets since keyword inclusion might have
2591 ;; added some more.
2593 ;; Run last hook with current back-end as argument.
2596 ;; Update communication channel with environment. Also
2597 ;; install user's and developer's filters.
2602 ;; Expand export-specific set of macros: {{{author}}},
2603 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2604 ;; once regular macros have been expanded, since document
2605 ;; keywords may contain one of them.
2612 ;; EMAIL is not a parsed keyword: store it as-is.
2616 ;; Eventually parse buffer. Call parse-tree filters to get
2617 ;; the final tree.
2622 ;; Now tree is complete, compute its properties and add them
2623 ;; to communication channel.
2627 ;; Eventually transcode TREE. Wrap the resulting string into
2628 ;; a template, if required. Finally call final-output filter.
2637 info)))
2638 ;; Maybe add final OUTPUT to kill ring, then return it.
2641 output)))))
2645 "Call `org-export-as' with output to a specified buffer.
2647 BACKEND is the back-end used for transcoding, as a symbol.
2649 BUFFER is the output buffer. If it already exists, it will be
2650 erased first, otherwise, it will be created.
2652 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2653 and NOEXPAND are similar to those used in `org-export-as', which
2654 see.
2656 Return buffer."
2658 backend subtreep visible-only body-only ext-plist noexpand))
2664 buffer))
2668 "Call `org-export-as' with output to a specified file.
2670 BACKEND is the back-end used for transcoding, as a symbol. FILE
2671 is the name of the output file, as a string.
2673 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2674 and NOEXPAND are similar to those used in `org-export-as', which
2675 see.
2677 Return output file's name."
2678 ;; Checks for FILE permissions. `write-file' would do the same, but
2679 ;; we'd rather avoid needless transcoding of parse tree.
2681 ;; Insert contents to a temporary buffer and write it to FILE.
2683 backend subtreep visible-only body-only ext-plist noexpand)))
2688 ;; Return full path.
2689 file)
2692 "Return output file's name according to buffer specifications.
2694 EXTENSION is a string representing the output file extension,
2695 with the leading dot.
2697 With a non-nil optional argument SUBTREEP, try to determine
2699 of subtree at point.
2701 When optional argument PUB-DIR is set, use it as the publishing
2702 directory.
2704 When optional argument VISIBLE-ONLY is non-nil, don't export
2705 contents of hidden elements.
2707 Return file name as a string, or nil if it couldn't be
2708 determined."
2710 ;; File name may come from EXPORT_FILE_NAME subtree property,
2711 ;; assuming point is at beginning of said sub-tree.
2718 ;; File name may be extracted from buffer's associated
2719 ;; file, if any.
2722 ;; Can't determine file name on our own: Ask user.
2726 "Output file: " pub-dir nil nil nil
2729 ;; Build file name. Enforce EXTENSION over whatever user may have
2730 ;; come up with. PUB-DIR, if defined, always has precedence over
2731 ;; any provided path.
2736 extension))
2741 "Apply BODY in a copy of the current buffer.
2743 The copy preserves local variables and visibility of the original
2744 buffer.
2746 Point is at buffer's beginning when BODY is applied."
2756 ,original-buffer
2768 "Expand every include keyword in buffer.
2769 Optional argument INCLUDED is a list of included file names along
2770 with their line restriction, when appropriate. It is used to
2771 avoid infinite recursion. Optional argument DIR is the current
2772 working directory. It is used to properly resolve relative
2773 paths."
2780 ;; Extract arguments from keyword's value.
2794 ;; Minimal level of included file defaults to the child
2795 ;; level of the current headline, if any, or one. It
2796 ;; only applies is the file is meant to be included as
2797 ;; an Org one.
2805 ;; Remove keyword.
2810 ;; Check if files has already been parsed. Look after
2811 ;; inclusion lines too, as different parts of the same file
2812 ;; can be included too.
2824 ind-str contents ind-str))))
2832 ind-str env contents ind-str))))
2845 "Prepare the contents of FILE for inclusion and return them as a string.
2847 When optional argument LINES is a string specifying a range of
2848 lines, include only those lines.
2850 Optional argument IND, when non-nil, is an integer specifying the
2851 global indentation of returned contents. Since its purpose is to
2852 allow an included file to stay in the same environment it was
2853 created \(i.e. a list item), it doesn't apply past the first
2854 headline encountered.
2856 Optional argument MINLEVEL, when non-nil, is an integer
2857 specifying the level that any top-level headline in the included
2858 file should have."
2874 ;; Remove blank lines at beginning and end of contents. The logic
2875 ;; behind that removal is that blank lines around include keyword
2876 ;; override blank lines in included file.
2885 ;; If IND is set, preserve indentation of include keyword until
2886 ;; the first headline encountered.
2892 ;; Do not move footnote definitions out of column 0.
2898 ;; When MINLEVEL is specified, compute minimal level for headlines
2899 ;; in the file (CUR-MIN), and remove stars to each headline so
2900 ;; that headlines with minimal level have a level of MINLEVEL.
2910 ;; Only change stars, don't bother moving whole
2911 ;; sections.
2917 \f
2918 ;;; Tools For Back-Ends
2919 ;;
2920 ;; A whole set of tools is available to help build new exporters. Any
2921 ;; function general enough to have its use across many back-ends
2922 ;; should be added here.
2924 ;;;; For Affiliated Keywords
2925 ;;
2926 ;; `org-export-read-attribute' reads a property from a given element
2927 ;; as a plist. It can be used to normalize affiliated keywords'
2928 ;; syntax.
2929 ;;
2930 ;; Since captions can span over multiple lines and accept dual values,
2931 ;; their internal representation is a bit tricky. Therefore,
2932 ;; `org-export-get-caption' transparently returns a given element's
2933 ;; caption as a secondary string.
2936 "Turn ATTRIBUTE property from ELEMENT into a plist.
2938 When optional argument PROPERTY is non-nil, return the value of
2939 that property within attributes.
2943 properties."
2951 "Return caption from ELEMENT as a secondary string.
2953 When optional argument SHORTP is non-nil, return short caption,
2954 as a secondary string, instead.
2956 Caption lines are separated by a white space."
2964 ;;;; For Derived Back-ends
2965 ;;
2966 ;; `org-export-with-backend' is a function allowing to locally use
2967 ;; another back-end to transcode some object or element. In a derived
2968 ;; back-end, it may be used as a fall-back function once all specific
2969 ;; cases have been treated.
2972 "Call a transcoder from BACK-END on DATA."
2983 ;;;; For Export Snippets
2984 ;;
2985 ;; Every export snippet is transmitted to the back-end. Though, the
2986 ;; latter will only retain one type of export-snippet, ignoring
2987 ;; others, based on the former's target back-end. The function
2988 ;; `org-export-snippet-backend' returns that back-end for a given
2989 ;; export-snippet.
2992 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2993 Translation, with `org-export-snippet-translation-alist', is
2994 applied."
2998 back-end))))
3001 ;;;; For Footnotes
3002 ;;
3003 ;; `org-export-collect-footnote-definitions' is a tool to list
3004 ;; actually used footnotes definitions in the whole parse tree, or in
3005 ;; an headline, in order to add footnote listings throughout the
3006 ;; transcoded data.
3007 ;;
3008 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3009 ;; back-ends, when they need to attach the footnote definition only to
3010 ;; the first occurrence of the corresponding label.
3011 ;;
3012 ;; `org-export-get-footnote-definition' and
3013 ;; `org-export-get-footnote-number' provide easier access to
3014 ;; additional information relative to a footnote reference.
3017 "Return an alist between footnote numbers, labels and definitions.
3019 DATA is the parse tree from which definitions are collected.
3020 INFO is the plist used as a communication channel.
3022 Definitions are sorted by order of references. They either
3023 appear as Org data or as a secondary string for inlined
3024 footnotes. Unreferenced definitions are ignored."
3026 collect-fn ; for byte-compiler.
3030 ;; Collect footnote number, label and definition in DATA.
3032 data 'footnote-reference
3039 def)
3040 num-alist)
3041 ;; Also search in definition for nested footnotes.
3044 ;; Don't enter footnote definitions since it will happen
3045 ;; when their first reference is found.
3051 "Non-nil when a footnote reference is the first one for its label.
3053 FOOTNOTE-REFERENCE is the footnote reference being considered.
3054 INFO is the plist used as a communication channel."
3056 ;; Anonymous footnotes are always a first reference.
3058 ;; Otherwise, return the first footnote with the same LABEL and
3059 ;; test if it is equal to FOOTNOTE-REFERENCE.
3065 data 'footnote-reference
3070 ;; If FN isn't inlined, be sure to traverse its
3071 ;; definition before resuming search. See
3072 ;; comments in `org-export-get-footnote-number'
3073 ;; for more information.
3077 ;; Don't enter footnote definitions since it will
3078 ;; happen when their first reference is found.
3081 footnote-reference)))))
3084 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3085 INFO is the plist used as a communication channel."
3091 "Return number associated to a footnote.
3093 FOOTNOTE is either a footnote reference or a footnote definition.
3094 INFO is the plist used as a communication channel."
3096 seen-refs
3097 search-ref ; For byte-compiler.
3101 ;; Search footnote references through DATA, filling
3102 ;; SEEN-REFS along the way.
3104 data 'footnote-reference
3108 ;; Anonymous footnote match: return number.
3111 ;; Labels match: return number.
3114 ;; Anonymous footnote: it's always a new one. Also,
3115 ;; be sure to return nil from the `cond' so
3116 ;; `first-match' doesn't get us out of the loop.
3118 ;; Label not seen so far: add it so SEEN-REFS.
3119 ;;
3120 ;; Also search for subsequent references in
3121 ;; footnote definition so numbering follows reading
3122 ;; logic. Note that we don't have to care about
3123 ;; inline definitions, since `org-element-map'
3124 ;; already traverses them at the right time.
3125 ;;
3126 ;; Once again, return nil to stay in the loop.
3131 nil))))
3132 ;; Don't enter footnote definitions since it will happen
3133 ;; when their first reference is found.
3138 ;;;; For Headlines
3139 ;;
3140 ;; `org-export-get-relative-level' is a shortcut to get headline
3141 ;; level, relatively to the lower headline level in the parsed tree.
3142 ;;
3143 ;; `org-export-get-headline-number' returns the section number of an
3144 ;; headline, while `org-export-number-to-roman' allows to convert it
3145 ;; to roman numbers.
3146 ;;
3147 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3148 ;; `org-export-last-sibling-p' are three useful predicates when it
3149 ;; comes to fulfill the `:headline-levels' property.
3150 ;;
3151 ;; `org-export-get-tags', `org-export-get-category' and
3152 ;; `org-export-get-node-property' extract useful information from an
3153 ;; headline or a parent headline. They all handle inheritance.
3156 "Return HEADLINE relative level within current parsed tree.
3157 INFO is a plist holding contextual information."
3162 "Non-nil when HEADLINE is considered as low level.
3164 INFO is a plist used as a communication channel.
3166 A low level headlines has a relative level greater than
3167 `:headline-levels' property value.
3169 Return value is the difference between HEADLINE relative level
3170 and the last level being considered as high enough, or nil."
3177 "Return HEADLINE numbering as a list of numbers.
3178 INFO is a plist holding contextual information."
3182 "Return a non-nil value if HEADLINE element should be numbered.
3183 INFO is a plist used as a communication channel."
3189 "Convert integer N into a roman numeral."
3202 res)))
3205 "Return list of tags associated to ELEMENT.
3207 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3208 is a plist used as a communication channel.
3210 Select tags (see `org-export-select-tags') and exclude tags (see
3211 `org-export-exclude-tags') are removed from the list.
3213 When non-nil, optional argument TAGS should be a list of strings.
3214 Any tag belonging to this list will also be removed.
3216 When optional argument INHERITED is non-nil, tags can also be
3217 inherited from parent headlines and FILETAGS keywords."
3223 ;; Build complete list of inherited tags.
3234 ;; Add FILETAGS keywords and return results.
3238 "Return node PROPERTY value for BLOB.
3240 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3241 element or object.
3243 If optional argument INHERITED is non-nil, the value can be
3244 inherited from a parent headline.
3246 Return value is a string or nil."
3258 "Return category for element or object BLOB.
3260 INFO is a plist used as a communication channel.
3262 CATEGORY is automatically inherited from a parent headline, from
3263 #+CATEGORY: keyword or created out of original file name. If all
3267 ;; Almost like `org-export-node-property', but we cannot trust
3268 ;; `plist-member' as every headline has a `:category'
3269 ;; property, would it be nil or equal to "???" (which has the
3270 ;; same meaning).
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'.
4712 ;;;###autoload
4714 "Export dispatcher for Org mode.
4716 It provides an access to common export related tasks in a buffer.
4717 Its interface comes in two flavours: standard and expert. While
4718 both share the same set of bindings, only the former displays the
4719 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4720 to switch to one or the other."
4725 nil
4726 org-export-dispatch-use-expert-ui)
4732 ;; First handle special hard-coded actions.
4738 "Publish project: "
4739 org-e-publish-project-alist nil t)
4740 org-e-publish-project-alist)
4750 "Handle interface for `org-export-dispatch'.
4752 OPTIONS is a list containing current interactive options set for
4753 export. It can contain any of the following symbols:
4754 `body' toggles a body-only export
4755 `subtree' restricts export to current subtree
4756 `visible' restricts export to visible part of buffer.
4757 `force' force publishing files.
4759 FIRST-KEY is the key pressed to select the first level menu. It
4760 is nil when this menu hasn't been selected yet.
4762 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4763 buffer is provided, but indications about currently active
4764 options are given in the prompt. Moreover, \[?] allows to switch
4765 back to standard interface."
4768 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4769 ;; non-nil is the required first-level key to activate
4770 ;; KEY. When its value is t, activate KEY independently
4771 ;; on the first key, if any. A nil value means KEY will
4772 ;; only be activated at first level.
4776 ;; Prepare menu entries by extracting them from
4777 ;; `org-export-registered-backends', and sorting them by
4778 ;; access key and by ordinal, if any.
4784 org-export-registered-backends))
4792 ;; Compute a list of allowed keys based on the first key
4793 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4794 ;; always available.
4805 ;; Build the help menu for standard UI.
4809 ;; Options are hard-coded.
4811 [%s] Body only: %s [%s] Visible only: %s
4821 ;; Display registered back-end entries. When a key
4822 ;; appears for the second time, do not create another
4823 ;; entry, but append its sub-menu to existing menu.
4836 ;; Split sub-menu into two columns.
4847 top-key)
4852 ;; Publishing menu is hard-coded.
4854 [%s] Current file [%s] Current project
4864 ;; Build prompts for both standard and expert UI.
4869 "Export command (Options: %s%s%s%s) [%s]: "
4875 ;; With expert UI, just read key with a fancy prompt. In standard
4876 ;; UI, display an intrusive help buffer.
4879 expert-prompt allowed-keys backends options first-key expertp)
4880 ;; At first call, create frame layout in order to display menu.
4886 ;; At this point, the buffer containing the menu exists and is
4887 ;; visible in the current window. So, refresh it.
4893 standard-prompt allowed-keys backends options first-key expertp))))
4897 "Read a character from command input and act accordingly.
4899 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
4900 a list of characters available at a given step in the process.
4901 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
4902 EXPERTP are the same as defined in `org-export-dispatch-ui',
4903 which see.
4905 Toggle export options when required. Otherwise, return value is
4906 a list with action as CAR and a list of interactive export
4907 options as CDR."
4909 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4910 ;; depending on user's key pressed.
4913 ;; Ignore non-standard characters (i.e. "M-a") and
4914 ;; undefined associations.
4919 ;; q key at first level aborts export. At second
4920 ;; level, cancel first key instead.
4923 ;; Help key: Switch back to standard interface if
4924 ;; expert UI was active.
4926 ;; Toggle export options.
4933 first-key expertp))
4934 ;; Action selected: Send key and options back to
4935 ;; `org-export-dispatch'.
4941 ;; Publishing actions are hard-coded. Send a special
4942 ;; signal to `org-export-dispatch'.
4950 options))
4951 ;; Otherwise, enter sub-menu.
4956 ;;; org-export.el ends here