| blob | 2597109622f7c2c90187adbdf0f6219985782aa1 |
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/, _word_ and +word+.
367 If the export target supports emphasizing text, the word will be
368 typeset in bold, italic, with an underline or strike-through,
369 respectively.
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:
951 ;; Register back-end.
955 ;; Tell parser to not parse EXPORT-BLOCK blocks.
962 ;; Splice in the body, if any.
966 "Return filters for BACKEND."
971 "Return menu entry for BACKEND."
976 "Return export options for BACKEND."
981 "Return translate table for BACKEND."
986 "Signal an error if BACKEND isn't defined."
991 "Non-nil if BACKEND is derived from one of BACKENDS."
996 org-export-registered-backends))
998 parent))
1001 \f
1002 ;;; The Communication Channel
1003 ;;
1004 ;; During export process, every function has access to a number of
1005 ;; properties. They are of two types:
1006 ;;
1007 ;; 1. Environment options are collected once at the very beginning of
1008 ;; the process, out of the original buffer and configuration.
1009 ;; Collecting them is handled by `org-export-get-environment'
1010 ;; function.
1011 ;;
1012 ;; Most environment options are defined through the
1013 ;; `org-export-options-alist' variable.
1014 ;;
1015 ;; 2. Tree properties are extracted directly from the parsed tree,
1016 ;; just before export, by `org-export-collect-tree-properties'.
1017 ;;
1018 ;; Here is the full list of properties available during transcode
1019 ;; process, with their category and their value type.
1020 ;;
1021 ;; + `:author' :: Author's name.
1022 ;; - category :: option
1023 ;; - type :: string
1024 ;;
1025 ;; + `:back-end' :: Current back-end used for transcoding.
1026 ;; - category :: tree
1027 ;; - type :: symbol
1028 ;;
1029 ;; + `:creator' :: String to write as creation information.
1030 ;; - category :: option
1031 ;; - type :: string
1032 ;;
1033 ;; + `:date' :: String to use as date.
1034 ;; - category :: option
1035 ;; - type :: string
1036 ;;
1037 ;; + `:description' :: Description text for the current data.
1038 ;; - category :: option
1039 ;; - type :: string
1040 ;;
1041 ;; + `:email' :: Author's email.
1042 ;; - category :: option
1043 ;; - type :: string
1044 ;;
1045 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1046 ;; process.
1047 ;; - category :: option
1048 ;; - type :: list of strings
1049 ;;
1050 ;; + `:exported-data' :: Hash table used for memoizing
1051 ;; `org-export-data'.
1052 ;; - category :: tree
1053 ;; - type :: hash table
1054 ;;
1055 ;; + `:filetags' :: List of global tags for buffer. Used by
1056 ;; `org-export-get-tags' to get tags with inheritance.
1057 ;; - category :: option
1058 ;; - type :: list of strings
1059 ;;
1060 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1061 ;; their definition, as parsed data. Only non-inlined footnotes
1062 ;; are represented in this alist. Also, every definition isn't
1063 ;; guaranteed to be referenced in the parse tree. The purpose of
1064 ;; this property is to preserve definitions from oblivion
1065 ;; (i.e. when the parse tree comes from a part of the original
1066 ;; buffer), it isn't meant for direct use in a back-end. To
1067 ;; retrieve a definition relative to a reference, use
1068 ;; `org-export-get-footnote-definition' instead.
1069 ;; - category :: option
1070 ;; - type :: alist (STRING . LIST)
1071 ;;
1072 ;; + `:headline-levels' :: Maximum level being exported as an
1073 ;; headline. Comparison is done with the relative level of
1074 ;; headlines in the parse tree, not necessarily with their
1075 ;; actual level.
1076 ;; - category :: option
1077 ;; - type :: integer
1078 ;;
1079 ;; + `:headline-offset' :: Difference between relative and real level
1080 ;; of headlines in the parse tree. For example, a value of -1
1081 ;; means a level 2 headline should be considered as level
1082 ;; 1 (cf. `org-export-get-relative-level').
1083 ;; - category :: tree
1084 ;; - type :: integer
1085 ;;
1086 ;; + `:headline-numbering' :: Alist between headlines and their
1087 ;; numbering, as a list of numbers
1088 ;; (cf. `org-export-get-headline-number').
1089 ;; - category :: tree
1090 ;; - type :: alist (INTEGER . LIST)
1091 ;;
1092 ;; + `:id-alist' :: Alist between ID strings and destination file's
1093 ;; path, relative to current directory. It is used by
1094 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1095 ;; external file.
1096 ;; - category :: option
1097 ;; - type :: alist (STRING . STRING)
1098 ;;
1099 ;; + `:ignore-list' :: List of elements and objects that should be
1100 ;; ignored during export.
1101 ;; - category :: tree
1102 ;; - type :: list of elements and objects
1103 ;;
1104 ;; + `:input-file' :: Full path to input file, if any.
1105 ;; - category :: option
1106 ;; - type :: string or nil
1107 ;;
1108 ;; + `:keywords' :: List of keywords attached to data.
1109 ;; - category :: option
1110 ;; - type :: string
1111 ;;
1112 ;; + `:language' :: Default language used for translations.
1113 ;; - category :: option
1114 ;; - type :: string
1115 ;;
1116 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1117 ;; transcoding.
1118 ;; - category :: option
1119 ;; - type :: list (as returned by `org-element-parse-buffer')
1120 ;;
1121 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1122 ;; all line breaks.
1123 ;; - category :: option
1124 ;; - type :: symbol (nil, t)
1125 ;;
1126 ;; + `:section-numbers' :: Non-nil means transcoding should add
1127 ;; section numbers to headlines.
1128 ;; - category :: option
1129 ;; - type :: symbol (nil, t)
1130 ;;
1131 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1132 ;; in transcoding. When such a tag is present, subtrees without
1133 ;; it are de facto excluded from the process. See
1134 ;; `use-select-tags'.
1135 ;; - category :: option
1136 ;; - type :: list of strings
1137 ;;
1138 ;; + `:target-list' :: List of targets encountered in the parse tree.
1139 ;; This is used to partly resolve "fuzzy" links
1140 ;; (cf. `org-export-resolve-fuzzy-link').
1141 ;; - category :: tree
1142 ;; - type :: list of strings
1143 ;;
1144 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1145 ;; a time stamp in the output.
1146 ;; - category :: option
1147 ;; - type :: symbol (nil, t)
1148 ;;
1149 ;; + `:translate-alist' :: Alist between element and object types and
1150 ;; transcoding functions relative to the current back-end.
1151 ;; Special keys `template' and `plain-text' are also possible.
1152 ;; - category :: option
1153 ;; - type :: alist (SYMBOL . FUNCTION)
1154 ;;
1155 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1156 ;; also be transcoded. If it is set to the `headline' symbol,
1157 ;; only the archived headline's name is retained.
1158 ;; - category :: option
1159 ;; - type :: symbol (nil, t, `headline')
1160 ;;
1161 ;; + `:with-author' :: Non-nil means author's name should be included
1162 ;; in the output.
1163 ;; - category :: option
1164 ;; - type :: symbol (nil, t)
1165 ;;
1166 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1167 ;; - category :: option
1168 ;; - type :: symbol (nil, t)
1169 ;;
1170 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1171 ;; inserted at the end of the transcoded string. If the value
1172 ;; is `comment', it should be commented.
1173 ;; - category :: option
1174 ;; - type :: symbol (`comment', nil, t)
1175 ;;
1176 ;; + `:with-date' :: Non-nil means output should contain a date.
1177 ;; - category :: option
1178 ;; - type :. symbol (nil, t)
1179 ;;
1180 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1181 ;; its value is a list of names, only drawers with such names
1182 ;; will be transcoded.
1183 ;; - category :: option
1184 ;; - type :: symbol (nil, t) or list of strings
1185 ;;
1186 ;; + `:with-email' :: Non-nil means output should contain author's
1187 ;; email.
1188 ;; - category :: option
1189 ;; - type :: symbol (nil, t)
1190 ;;
1191 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1192 ;; interpreted.
1193 ;; - category :: option
1194 ;; - type :: symbol (nil, t)
1195 ;;
1196 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1197 ;; strings starting with a colon as a fixed-with (verbatim) area.
1198 ;; - category :: option
1199 ;; - type :: symbol (nil, t)
1200 ;;
1201 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1202 ;; footnotes.
1203 ;; - category :: option
1204 ;; - type :: symbol (nil, t)
1205 ;;
1206 ;; + `:with-plannings' :: Non-nil means transcoding should include
1207 ;; planning info.
1208 ;; - category :: option
1209 ;; - type :: symbol (nil, t)
1210 ;;
1211 ;; + `:with-priority' :: Non-nil means transcoding should include
1212 ;; priority cookies.
1213 ;; - category :: option
1214 ;; - type :: symbol (nil, t)
1215 ;;
1216 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1217 ;; plain text.
1218 ;; - category :: option
1219 ;; - type :: symbol (nil, t)
1220 ;;
1221 ;; + `:with-special-strings' :: Non-nil means transcoding should
1222 ;; interpret special strings in plain text.
1223 ;; - category :: option
1224 ;; - type :: symbol (nil, t)
1225 ;;
1226 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1227 ;; interpret subscript and superscript. With a value of "{}",
1228 ;; only interpret those using curly brackets.
1229 ;; - category :: option
1230 ;; - type :: symbol (nil, {}, t)
1231 ;;
1232 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1233 ;; tables.
1234 ;; - category :: option
1235 ;; - type :: symbol (nil, t)
1236 ;;
1237 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1238 ;; headlines. A `not-in-toc' value will remove them from the
1239 ;; table of contents, if any, nonetheless.
1240 ;; - category :: option
1241 ;; - type :: symbol (nil, t, `not-in-toc')
1242 ;;
1243 ;; + `:with-tasks' :: Non-nil means transcoding should include
1244 ;; headlines with a TODO keyword. A `todo' value will only
1245 ;; include headlines with a todo type keyword while a `done'
1246 ;; value will do the contrary. If a list of strings is provided,
1247 ;; only tasks with keywords belonging to that list will be kept.
1248 ;; - category :: option
1249 ;; - type :: symbol (t, todo, done, nil) or list of strings
1250 ;;
1251 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1252 ;; time stamps. Special value `active' (resp. `inactive') ask to
1253 ;; export only active (resp. inactive) timestamps. Otherwise,
1254 ;; completely remove them.
1255 ;; - category :: option
1256 ;; - type :: symbol: (`active', `inactive', t, nil)
1257 ;;
1258 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1259 ;; added to the output. An integer value limits its depth.
1260 ;; - category :: option
1261 ;; - type :: symbol (nil, t or integer)
1262 ;;
1263 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1264 ;; include TODO keywords.
1265 ;; - category :: option
1266 ;; - type :: symbol (nil, t)
1269 ;;;; Environment Options
1270 ;;
1271 ;; Environment options encompass all parameters defined outside the
1272 ;; scope of the parsed data. They come from five sources, in
1273 ;; increasing precedence order:
1274 ;;
1275 ;; - Global variables,
1276 ;; - Buffer's attributes,
1277 ;; - Options keyword symbols,
1278 ;; - Buffer keywords,
1279 ;; - Subtree properties.
1280 ;;
1281 ;; The central internal function with regards to environment options
1282 ;; is `org-export-get-environment'. It updates global variables with
1283 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1284 ;; the different sources.
1285 ;;
1286 ;; The internal functions doing the retrieval are:
1287 ;; `org-export--get-global-options',
1288 ;; `org-export--get-buffer-attributes',
1289 ;; `org-export--parse-option-keyword',
1290 ;; `org-export--get-subtree-options' and
1291 ;; `org-export--get-inbuffer-options'
1292 ;;
1293 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1294 ;; take care of the part relative to "#+BIND:" keywords.
1297 "Collect export options from the current buffer.
1299 Optional argument BACKEND is a symbol specifying which back-end
1300 specific options to read, if any.
1302 When optional argument SUBTREEP is non-nil, assume the export is
1303 done against the current sub-tree.
1305 Third optional argument EXT-PLIST is a property list with
1306 external parameters overriding Org default settings, but still
1307 inferior to file-local settings."
1308 ;; First install #+BIND variables.
1310 ;; Get and prioritize export options...
1312 ;; ... from global variables...
1314 ;; ... from an external property list...
1315 ext-plist
1316 ;; ... from in-buffer settings...
1318 backend
1320 ;; ... and from subtree, when appropriate.
1322 ;; Eventually add misc. properties.
1324 :back-end
1325 backend
1326 :translate-alist
1328 :footnote-definition-alist
1329 ;; Footnotes definitions must be collected in the original
1330 ;; buffer, as there's no insurance that they will still be in
1331 ;; the parse tree, due to possible narrowing.
1345 alist))))
1346 alist))
1347 :id-alist
1348 ;; Collect id references.
1359 alist))))
1362 "Parse an OPTIONS line and return values as a plist.
1363 Optional argument BACKEND is a symbol specifying which back-end
1364 specific items to read, if any."
1367 ;; Build an alist between #+OPTION: item and property-name.
1372 all)))
1373 plist)
1378 options)
1383 alist)
1384 plist))
1387 "Get export options in subtree at point.
1388 Optional argument BACKEND is a symbol specifying back-end used
1389 for export. Return options as a plist."
1390 ;; For each buffer keyword, create an headline property setting the
1391 ;; same property in communication channel. The name for the property
1392 ;; is the keyword with "EXPORT_" appended to it.
1395 ;; Make sure point is at an heading.
1397 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1398 ;; title as its fallback value.
1404 plist :title
1407 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1411 ;; Handle other keywords. TITLE keyword is excluded as it has
1412 ;; been handled already.
1419 ;; Export properties are not case-sensitive.
1426 plist
1429 ;; Parse VALUE if required.
1433 ;; If BEHAVIOUR is `split' expected value is
1434 ;; a list of strings, not a string.
1437 ;; Also look for both general keywords and back-end specific
1438 ;; options if BACKEND is provided.
1440 org-export-options-alist)))
1441 ;; Return value.
1442 plist)))
1445 "Return current buffer export options, as a plist.
1447 Optional argument BACKEND, when non-nil, is a symbol specifying
1448 which back-end specific options should also be read in the
1449 process.
1451 Optional argument FILES is a list of setup files names read so
1452 far, used to avoid circular dependencies.
1454 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1458 ;; 1. Special keywords, as in `org-export-special-keywords'.
1472 ;; Avoid circular dependencies.
1487 ;; 2. Standard options, as in `org-export-options-alist'.
1489 ;; Also look for back-end specific options if
1490 ;; BACKEND is defined.
1492 ;; Build ALIST between keyword name and property name.
1496 all)))
1497 ;; Build regexp matching all keywords associated to export
1498 ;; options. Note: the search is case insensitive.
1512 plist prop
1513 ;; Handle value depending on specified BEHAVIOUR.
1526 ;; Parse keywords specified in
1527 ;; `org-element-document-properties'.
1535 plist prop
1538 org-element-document-properties))
1539 ;; 3. Return final value.
1540 plist)))
1543 "Return properties related to buffer attributes, as a plist."
1546 ;; Store full path of input file name, or nil. For internal use.
1547 :input-file visited-file
1554 "Return global export options as a plist.
1556 Optional argument BACKEND, if non-nil, is a symbol specifying
1557 which back-end specific export options should also be read in the
1558 process."
1561 ;; Output value.
1562 plist)
1567 plist
1569 ;; Eval default value provided. If keyword is a member
1570 ;; of `org-element-document-properties', parse it as
1571 ;; a secondary string before storing it.
1576 value
1579 all)
1580 ;; Return value.
1581 plist))
1585 "Can we use #+BIND values during export?
1586 By default this will ask for confirmation by the user, to divert
1587 possible security risks."
1592 org-export--allow-BIND-local)
1597 "Install the values from #+BIND lines as local variables.
1598 Variables must be installed before in-buffer options are
1599 retrieved."
1614 ;;;; Tree Properties
1615 ;;
1616 ;; Tree properties are information extracted from parse tree. They
1617 ;; are initialized at the beginning of the transcoding process by
1618 ;; `org-export-collect-tree-properties'.
1619 ;;
1620 ;; Dedicated functions focus on computing the value of specific tree
1621 ;; properties during initialization. Thus,
1622 ;; `org-export--populate-ignore-list' lists elements and objects that
1623 ;; should be skipped during export, `org-export--get-min-level' gets
1624 ;; the minimal exportable level, used as a basis to compute relative
1625 ;; level for headlines. Eventually
1626 ;; `org-export--collect-headline-numbering' builds an alist between
1627 ;; headlines and their numbering.
1630 "Extract tree properties from parse tree.
1632 DATA is the parse tree from which information is retrieved. INFO
1633 is a list holding export options.
1635 Following tree properties are set or updated:
1637 `:exported-data' Hash table used to memoize results from
1638 `org-export-data'.
1640 `:footnote-definition-alist' List of footnotes definitions in
1641 original buffer and current parse tree.
1643 `:headline-offset' Offset between true level of headlines and
1644 local level. An offset of -1 means an headline
1645 of level 2 should be considered as a level
1646 1 headline in the context.
1648 `:headline-numbering' Alist of all headlines as key an the
1649 associated numbering as value.
1651 `:ignore-list' List of elements that should be ignored during
1652 export.
1654 `:target-list' List of all targets in the parse tree.
1656 Return updated plist."
1657 ;; Install the parse tree in the communication channel, in order to
1658 ;; use `org-export-get-genealogy' and al.
1660 ;; Get the list of elements and objects to ignore, and put it into
1661 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1662 ;; been done during parse tree filtering.
1665 :ignore-list
1668 ;; Compute `:headline-offset' in order to be able to use
1669 ;; `org-export-get-relative-level'.
1672 :headline-offset
1674 ;; Update footnotes definitions list with definitions in parse tree.
1675 ;; This is required since buffer expansion might have modified
1676 ;; boundaries of footnote definitions contained in the parse tree.
1677 ;; This way, definitions in `footnote-definition-alist' are bound to
1678 ;; match those in the parse tree.
1681 data 'footnote-definition
1685 defs)))
1687 ;; Properties order doesn't matter: get the rest of the tree
1688 ;; properties.
1690 `(:target-list
1699 info))
1702 "Return minimum exportable headline's level in DATA.
1703 DATA is parsed tree as returned by `org-element-parse-buffer'.
1704 OPTIONS is a plist holding export options."
1715 ;; If no headline was found, for the sake of consistency, set
1716 ;; minimum level to 1 nonetheless.
1720 "Return numbering of all exportable headlines in a parse tree.
1722 DATA is the parse tree. OPTIONS is the plist holding export
1723 options.
1725 Return an alist whose key is an headline and value is its
1726 associated numbering \(in the shape of a list of numbers\)."
1729 data
1730 'headline
1735 headline
1737 for idx from 0 to org-export-max-depth
1741 options)))
1744 "Return list of elements and objects to ignore during export.
1745 DATA is the parse tree to traverse. OPTIONS is the plist holding
1746 export options."
1748 walk-data
1749 ;; First find trees containing a select tag, if any.
1753 ;; Collect ignored elements or objects into IGNORE-LIST.
1759 ;; If headline is archived but tree below has
1760 ;; to be skipped, add it to ignore list.
1763 ;; Move into secondary string, if any.
1768 ;; Move into recursive objects/elements.
1770 ;; Main call.
1772 ;; Return value.
1773 ignore))
1776 "Return list of headlines containing a select tag in their tree.
1777 DATA is parsed data as returned by `org-element-parse-buffer'.
1778 INFO is a plist holding export options."
1780 walk-data ; for byte-compiler.
1791 ;; When a select tag is found, mark full
1792 ;; genealogy and every headline within the tree
1793 ;; as acceptable.
1796 genealogy
1798 selected-trees))
1799 ;; Else, continue searching in tree, recursively.
1806 "Non-nil when element or object BLOB should be skipped during export.
1807 OPTIONS is the plist holding export options. SELECTED, when
1808 non-nil, is a list of headlines belonging to a tree with a select
1809 tag."
1824 ;; Ignore subtrees with an exclude tag.
1827 ;; When a select tag is present in the buffer, ignore any tree
1828 ;; without it.
1830 ;; Ignore commented sub-trees.
1832 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1834 ;; Ignore tasks, if specified by `:with-tasks' property.
1850 ;; No timestamp allowed.
1852 ;; Only active timestamps allowed and the current one isn't
1853 ;; active.
1857 ;; Only inactive timestamps allowed and the current one isn't
1858 ;; inactive.
1864 \f
1865 ;;; The Transcoder
1866 ;;
1867 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1868 ;; `org-element-parse-buffer') and transcodes it into a specified
1869 ;; back-end output. It takes care of filtering out elements or
1870 ;; objects according to export options and organizing the output blank
1871 ;; lines and white space are preserved. The function memoizes its
1872 ;; results, so it is cheap to call it within translators.
1873 ;;
1874 ;; Internally, three functions handle the filtering of objects and
1875 ;; elements during the export. In particular,
1876 ;; `org-export-ignore-element' marks an element or object so future
1877 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1878 ;; elements or objects should be seen as real Org syntax and
1879 ;; `org-export-expand' transforms the others back into their original
1880 ;; shape
1881 ;;
1882 ;; `org-export-transcoder' is an accessor returning appropriate
1883 ;; translator function for a given element or object.
1886 "Return appropriate transcoder for BLOB.
1887 INFO is a plist containing export directives."
1889 ;; Return contents only for complete parse trees.
1895 "Convert DATA into current back-end format.
1897 DATA is a parse tree, an element or an object or a secondary
1898 string. INFO is a plist holding export options.
1900 Return transcoded string."
1906 ;; Ignored element/object.
1908 ;; Plain text. All residual text properties from parse
1909 ;; tree (i.e. `:parent' property) are removed.
1916 info)))
1917 ;; Uninterpreted element/object: change it back to Org
1918 ;; syntax and export again resulting raw string.
1922 data
1926 info))
1927 ;; Secondary string.
1930 ;; Element/Object without contents or, as a special case,
1931 ;; headline with archive tag and archived trees restricted
1932 ;; to title only.
1940 ;; Element/Object with contents.
1953 ;; Elements directly containing objects
1954 ;; must have their indentation normalized
1955 ;; first.
1957 data
1958 ;; When normalizing contents of the first
1959 ;; paragraph in an item or a footnote
1960 ;; definition, ignore first line's
1961 ;; indentation: there is none and it
1962 ;; might be misleading.
1967 data)
1974 info))))))))
1975 ;; Final result will be memoized before being returned.
1977 data
1981 ;; Append the same white space between elements or objects as in
1982 ;; the original buffer, and call appropriate filters.
1993 info)))
1994 results)))
1998 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1999 Check is done according to export options INFO, stored as
2000 a plist."
2002 ;; ... entities...
2004 ;; ... emphasis...
2007 ;; ... fixed-width areas.
2009 ;; ... footnotes...
2012 ;; ... sub/superscripts...
2018 ;; ... tables...
2023 "Expand a parsed element or object to its original state.
2024 BLOB is either an element or an object. CONTENTS is its
2025 contents, as a string or nil."
2028 blob contents))
2031 "Add ELEMENT to `:ignore-list' in INFO.
2033 Any element in `:ignore-list' will be skipped when using
2034 `org-element-map'. INFO is modified by side effects."
2038 \f
2039 ;;; The Filter System
2040 ;;
2041 ;; Filters allow end-users to tweak easily the transcoded output.
2042 ;; They are the functional counterpart of hooks, as every filter in
2043 ;; a set is applied to the return value of the previous one.
2044 ;;
2045 ;; Every set is back-end agnostic. Although, a filter is always
2046 ;; called, in addition to the string it applies to, with the back-end
2047 ;; used as argument, so it's easy for the end-user to add back-end
2048 ;; specific filters in the set. The communication channel, as
2049 ;; a plist, is required as the third argument.
2050 ;;
2051 ;; From the developer side, filters sets can be installed in the
2052 ;; process with the help of `org-export-define-backend', which
2053 ;; internally stores filters as an alist. Each association has a key
2054 ;; among the following symbols and a function or a list of functions
2055 ;; as value.
2056 ;;
2057 ;; - `:filter-parse-tree' applies directly on the complete parsed
2058 ;; tree. It's the only filters set that doesn't apply to a string.
2059 ;; Users can set it through `org-export-filter-parse-tree-functions'
2060 ;; variable.
2061 ;;
2062 ;; - `:filter-final-output' applies to the final transcoded string.
2063 ;; Users can set it with `org-export-filter-final-output-functions'
2064 ;; variable
2065 ;;
2066 ;; - `:filter-plain-text' applies to any string not recognized as Org
2067 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2068 ;; configure it.
2069 ;;
2070 ;; - `:filter-TYPE' applies on the string returned after an element or
2071 ;; object of type TYPE has been transcoded. An user can modify
2072 ;; `org-export-filter-TYPE-functions'
2073 ;;
2074 ;; All filters sets are applied with
2075 ;; `org-export-filter-apply-functions' function. Filters in a set are
2076 ;; applied in a LIFO fashion. It allows developers to be sure that
2077 ;; their filters will be applied first.
2078 ;;
2079 ;; Filters properties are installed in communication channel with
2080 ;; `org-export-install-filters' function.
2081 ;;
2082 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2083 ;; `org-export-before-parsing-hook') are run at the beginning of the
2084 ;; export process and just before parsing to allow for heavy structure
2085 ;; modifications.
2088 ;;;; Hooks
2091 "Hook run at the beginning of the export process.
2093 This is run before include keywords and macros are expanded and
2094 Babel code blocks executed, on a copy of the original buffer
2095 being exported. Visibility and narrowing are preserved. Point
2096 is at the beginning of the buffer.
2098 Every function in this hook will be called with one argument: the
2102 "Hook run before parsing an export buffer.
2104 This is run after include keywords and macros have been expanded
2105 and Babel code blocks executed, on a copy of the original buffer
2106 being exported. Visibility and narrowing are preserved. Point
2107 is at the beginning of the buffer.
2109 Every function in this hook will be called with one argument: the
2113 ;;;; Special Filters
2116 "List of functions applied to the parsed tree.
2117 Each filter is called with three arguments: the parse tree, as
2118 returned by `org-element-parse-buffer', the back-end, as
2119 a symbol, and the communication channel, as a plist. It must
2123 "List of functions applied to the transcoded string.
2124 Each filter is called with three arguments: the full transcoded
2125 string, the back-end, as a symbol, and the communication channel,
2126 as a plist. It must return a string that will be used as the
2130 "List of functions applied to plain text.
2131 Each filter is called with three arguments: a string which
2132 contains no Org syntax, the back-end, as a symbol, and the
2133 communication channel, as a plist. It must return a string or
2137 ;;;; Elements Filters
2140 "List of functions applied to a transcoded babel-call.
2141 Each filter is called with three arguments: the transcoded data,
2142 as a string, the back-end, as a symbol, and the communication
2146 "List of functions applied to a transcoded center block.
2147 Each filter is called with three arguments: the transcoded data,
2148 as a string, the back-end, as a symbol, and the communication
2152 "List of functions applied to a transcoded clock.
2153 Each filter is called with three arguments: the transcoded data,
2154 as a string, the back-end, as a symbol, and the communication
2158 "List of functions applied to a transcoded comment.
2159 Each filter is called with three arguments: the transcoded data,
2160 as a string, the back-end, as a symbol, and the communication
2164 "List of functions applied to a transcoded comment-block.
2165 Each filter is called with three arguments: the transcoded data,
2166 as a string, the back-end, as a symbol, and the communication
2170 "List of functions applied to a transcoded diary-sexp.
2171 Each filter is called with three arguments: the transcoded data,
2172 as a string, the back-end, as a symbol, and the communication
2176 "List of functions applied to a transcoded drawer.
2177 Each filter is called with three arguments: the transcoded data,
2178 as a string, the back-end, as a symbol, and the communication
2182 "List of functions applied to a transcoded dynamic-block.
2183 Each filter is called with three arguments: the transcoded data,
2184 as a string, the back-end, as a symbol, and the communication
2188 "List of functions applied to a transcoded example-block.
2189 Each filter is called with three arguments: the transcoded data,
2190 as a string, the back-end, as a symbol, and the communication
2194 "List of functions applied to a transcoded export-block.
2195 Each filter is called with three arguments: the transcoded data,
2196 as a string, the back-end, as a symbol, and the communication
2200 "List of functions applied to a transcoded fixed-width.
2201 Each filter is called with three arguments: the transcoded data,
2202 as a string, the back-end, as a symbol, and the communication
2206 "List of functions applied to a transcoded footnote-definition.
2207 Each filter is called with three arguments: the transcoded data,
2208 as a string, the back-end, as a symbol, and the communication
2212 "List of functions applied to a transcoded headline.
2213 Each filter is called with three arguments: the transcoded data,
2214 as a string, the back-end, as a symbol, and the communication
2218 "List of functions applied to a transcoded horizontal-rule.
2219 Each filter is called with three arguments: the transcoded data,
2220 as a string, the back-end, as a symbol, and the communication
2224 "List of functions applied to a transcoded inlinetask.
2225 Each filter is called with three arguments: the transcoded data,
2226 as a string, the back-end, as a symbol, and the communication
2230 "List of functions applied to a transcoded item.
2231 Each filter is called with three arguments: the transcoded data,
2232 as a string, the back-end, as a symbol, and the communication
2236 "List of functions applied to a transcoded keyword.
2237 Each filter is called with three arguments: the transcoded data,
2238 as a string, the back-end, as a symbol, and the communication
2242 "List of functions applied to a transcoded latex-environment.
2243 Each filter is called with three arguments: the transcoded data,
2244 as a string, the back-end, as a symbol, and the communication
2248 "List of functions applied to a transcoded node-property.
2249 Each filter is called with three arguments: the transcoded data,
2250 as a string, the back-end, as a symbol, and the communication
2254 "List of functions applied to a transcoded paragraph.
2255 Each filter is called with three arguments: the transcoded data,
2256 as a string, the back-end, as a symbol, and the communication
2260 "List of functions applied to a transcoded plain-list.
2261 Each filter is called with three arguments: the transcoded data,
2262 as a string, the back-end, as a symbol, and the communication
2266 "List of functions applied to a transcoded planning.
2267 Each filter is called with three arguments: the transcoded data,
2268 as a string, the back-end, as a symbol, and the communication
2272 "List of functions applied to a transcoded property-drawer.
2273 Each filter is called with three arguments: the transcoded data,
2274 as a string, the back-end, as a symbol, and the communication
2278 "List of functions applied to a transcoded quote block.
2279 Each filter is called with three arguments: the transcoded quote
2280 data, as a string, the back-end, as a symbol, and the
2281 communication channel, as a plist. It must return a string or
2285 "List of functions applied to a transcoded quote-section.
2286 Each filter is called with three arguments: the transcoded data,
2287 as a string, the back-end, as a symbol, and the communication
2291 "List of functions applied to a transcoded section.
2292 Each filter is called with three arguments: the transcoded data,
2293 as a string, the back-end, as a symbol, and the communication
2297 "List of functions applied to a transcoded special block.
2298 Each filter is called with three arguments: the transcoded data,
2299 as a string, the back-end, as a symbol, and the communication
2303 "List of functions applied to a transcoded src-block.
2304 Each filter is called with three arguments: the transcoded data,
2305 as a string, the back-end, as a symbol, and the communication
2309 "List of functions applied to a transcoded table.
2310 Each filter is called with three arguments: the transcoded data,
2311 as a string, the back-end, as a symbol, and the communication
2315 "List of functions applied to a transcoded table-cell.
2316 Each filter is called with three arguments: the transcoded data,
2317 as a string, the back-end, as a symbol, and the communication
2321 "List of functions applied to a transcoded table-row.
2322 Each filter is called with three arguments: the transcoded data,
2323 as a string, the back-end, as a symbol, and the communication
2327 "List of functions applied to a transcoded verse block.
2328 Each filter is called with three arguments: the transcoded data,
2329 as a string, the back-end, as a symbol, and the communication
2333 ;;;; Objects Filters
2336 "List of functions applied to transcoded bold text.
2337 Each filter is called with three arguments: the transcoded data,
2338 as a string, the back-end, as a symbol, and the communication
2342 "List of functions applied to transcoded code text.
2343 Each filter is called with three arguments: the transcoded data,
2344 as a string, the back-end, as a symbol, and the communication
2348 "List of functions applied to a transcoded entity.
2349 Each filter is called with three arguments: the transcoded data,
2350 as a string, the back-end, as a symbol, and the communication
2354 "List of functions applied to a transcoded export-snippet.
2355 Each filter is called with three arguments: the transcoded data,
2356 as a string, the back-end, as a symbol, and the communication
2360 "List of functions applied to a transcoded footnote-reference.
2361 Each filter is called with three arguments: the transcoded data,
2362 as a string, the back-end, as a symbol, and the communication
2366 "List of functions applied to a transcoded inline-babel-call.
2367 Each filter is called with three arguments: the transcoded data,
2368 as a string, the back-end, as a symbol, and the communication
2372 "List of functions applied to a transcoded inline-src-block.
2373 Each filter is called with three arguments: the transcoded data,
2374 as a string, the back-end, as a symbol, and the communication
2378 "List of functions applied to transcoded italic text.
2379 Each filter is called with three arguments: the transcoded data,
2380 as a string, the back-end, as a symbol, and the communication
2384 "List of functions applied to a transcoded latex-fragment.
2385 Each filter is called with three arguments: the transcoded data,
2386 as a string, the back-end, as a symbol, and the communication
2390 "List of functions applied to a transcoded line-break.
2391 Each filter is called with three arguments: the transcoded data,
2392 as a string, the back-end, as a symbol, and the communication
2396 "List of functions applied to a transcoded link.
2397 Each filter is called with three arguments: the transcoded data,
2398 as a string, the back-end, as a symbol, and the communication
2402 "List of functions applied to a transcoded macro.
2403 Each filter is called with three arguments: the transcoded data,
2404 as a string, the back-end, as a symbol, and the communication
2408 "List of functions applied to a transcoded radio-target.
2409 Each filter is called with three arguments: the transcoded data,
2410 as a string, the back-end, as a symbol, and the communication
2414 "List of functions applied to a transcoded statistics-cookie.
2415 Each filter is called with three arguments: the transcoded data,
2416 as a string, the back-end, as a symbol, and the communication
2420 "List of functions applied to transcoded strike-through text.
2421 Each filter is called with three arguments: the transcoded data,
2422 as a string, the back-end, as a symbol, and the communication
2426 "List of functions applied to a transcoded subscript.
2427 Each filter is called with three arguments: the transcoded data,
2428 as a string, the back-end, as a symbol, and the communication
2432 "List of functions applied to a transcoded superscript.
2433 Each filter is called with three arguments: the transcoded data,
2434 as a string, the back-end, as a symbol, and the communication
2438 "List of functions applied to a transcoded target.
2439 Each filter is called with three arguments: the transcoded data,
2440 as a string, the back-end, as a symbol, and the communication
2444 "List of functions applied to a transcoded timestamp.
2445 Each filter is called with three arguments: the transcoded data,
2446 as a string, the back-end, as a symbol, and the communication
2450 "List of functions applied to transcoded underline text.
2451 Each filter is called with three arguments: the transcoded data,
2452 as a string, the back-end, as a symbol, and the communication
2456 "List of functions applied to transcoded verbatim text.
2457 Each filter is called with three arguments: the transcoded data,
2458 as a string, the back-end, as a symbol, and the communication
2462 ;;;; Filters Tools
2463 ;;
2464 ;; Internal function `org-export-install-filters' installs filters
2465 ;; hard-coded in back-ends (developer filters) and filters from global
2466 ;; variables (user filters) in the communication channel.
2467 ;;
2468 ;; Internal function `org-export-filter-apply-functions' takes care
2469 ;; about applying each filter in order to a given data. It ignores
2470 ;; filters returning a nil value but stops whenever a filter returns
2471 ;; an empty string.
2474 "Call every function in FILTERS.
2476 Functions are called with arguments VALUE, current export
2477 back-end and INFO. A function returning a nil value will be
2478 skipped. If it returns the empty string, the process ends and
2479 VALUE is ignored.
2481 Call is done in a LIFO fashion, to be sure that developer
2482 specified filters, if any, are called first."
2491 "Install filters properties in communication channel.
2493 INFO is a plist containing the current communication channel.
2495 Return the updated communication channel."
2497 ;; Install user defined filters with `org-export-filters-alist'.
2500 org-export-filters-alist)
2501 ;; Prepend back-end specific filters to that list.
2503 ;; Single values get consed, lists are prepended.
2508 plist key
2512 ;; Return new communication channel.
2516 \f
2517 ;;; Core functions
2518 ;;
2519 ;; This is the room for the main function, `org-export-as', along with
2520 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2521 ;; They differ only by the way they output the resulting code.
2522 ;;
2523 ;; `org-export-output-file-name' is an auxiliary function meant to be
2524 ;; used with `org-export-to-file'. With a given extension, it tries
2525 ;; to provide a canonical file name to write export output to.
2526 ;;
2527 ;; Note that `org-export-as' doesn't really parse the current buffer,
2528 ;; but a copy of it (with the same buffer-local variables and
2529 ;; visibility), where macros and include keywords are expanded and
2530 ;; Babel blocks are executed, if appropriate.
2531 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2532 ;;
2533 ;; File inclusion is taken care of by
2534 ;; `org-export-expand-include-keyword' and
2535 ;; `org-export--prepare-file-contents'. Structure wise, including
2536 ;; a whole Org file in a buffer often makes little sense. For
2537 ;; example, if the file contains an headline and the include keyword
2538 ;; was within an item, the item should contain the headline. That's
2539 ;; why file inclusion should be done before any structure can be
2540 ;; associated to the file, that is before parsing.
2544 "Transcode current Org buffer into BACKEND code.
2546 If narrowing is active in the current buffer, only transcode its
2547 narrowed part.
2549 If a region is active, transcode that region.
2551 When optional argument SUBTREEP is non-nil, transcode the
2552 sub-tree at point, extracting information from the headline
2553 properties first.
2555 When optional argument VISIBLE-ONLY is non-nil, don't export
2556 contents of hidden elements.
2558 When optional argument BODY-ONLY is non-nil, only return body
2559 code, without preamble nor postamble.
2561 Optional argument EXT-PLIST, when provided, is a property list
2562 with external parameters overriding Org default settings, but
2563 still inferior to file-local settings.
2565 Optional argument NOEXPAND, when non-nil, prevents included files
2566 to be expanded and Babel code to be executed.
2568 Return code as a string."
2569 ;; Barf if BACKEND isn't registered.
2573 ;; Narrow buffer to an appropriate region or subtree for
2574 ;; parsing. If parsing subtree, be sure to remove main headline
2575 ;; too.
2583 ;; Initialize communication channel with original buffer
2584 ;; attributes, unavailable in its copy.
2587 ;; Run first hook with current back-end as argument.
2589 ;; Update communication channel and get parse tree. Buffer
2590 ;; isn't parsed directly. Instead, a temporary copy is
2591 ;; created, where include keywords, macros are expanded and
2592 ;; code blocks are evaluated.
2595 ;; Update macro templates since #+INCLUDE keywords might
2596 ;; have added some new ones.
2600 ;; Update radio targets since keyword inclusion might have
2601 ;; added some more.
2603 ;; Run last hook with current back-end as argument.
2606 ;; Update communication channel with environment. Also
2607 ;; install user's and developer's filters.
2612 ;; Expand export-specific set of macros: {{{author}}},
2613 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2614 ;; once regular macros have been expanded, since document
2615 ;; keywords may contain one of them.
2622 ;; EMAIL is not a parsed keyword: store it as-is.
2626 ;; Eventually parse buffer. Call parse-tree filters to get
2627 ;; the final tree.
2632 ;; Now tree is complete, compute its properties and add them
2633 ;; to communication channel.
2637 ;; Eventually transcode TREE. Wrap the resulting string into
2638 ;; a template, if required. Finally call final-output filter.
2647 info)))
2648 ;; Maybe add final OUTPUT to kill ring, then return it.
2651 output)))))
2655 "Call `org-export-as' with output to a specified buffer.
2657 BACKEND is the back-end used for transcoding, as a symbol.
2659 BUFFER is the output buffer. If it already exists, it will be
2660 erased first, otherwise, it will be created.
2662 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2663 and NOEXPAND are similar to those used in `org-export-as', which
2664 see.
2666 Return buffer."
2668 backend subtreep visible-only body-only ext-plist noexpand))
2674 buffer))
2678 "Call `org-export-as' with output to a specified file.
2680 BACKEND is the back-end used for transcoding, as a symbol. FILE
2681 is the name of the output file, as a string.
2683 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2684 and NOEXPAND are similar to those used in `org-export-as', which
2685 see.
2687 Return output file's name."
2688 ;; Checks for FILE permissions. `write-file' would do the same, but
2689 ;; we'd rather avoid needless transcoding of parse tree.
2691 ;; Insert contents to a temporary buffer and write it to FILE.
2693 backend subtreep visible-only body-only ext-plist noexpand)))
2698 ;; Return full path.
2699 file)
2702 "Return output file's name according to buffer specifications.
2704 EXTENSION is a string representing the output file extension,
2705 with the leading dot.
2707 With a non-nil optional argument SUBTREEP, try to determine
2709 of subtree at point.
2711 When optional argument PUB-DIR is set, use it as the publishing
2712 directory.
2714 When optional argument VISIBLE-ONLY is non-nil, don't export
2715 contents of hidden elements.
2717 Return file name as a string, or nil if it couldn't be
2718 determined."
2720 ;; File name may come from EXPORT_FILE_NAME subtree property,
2721 ;; assuming point is at beginning of said sub-tree.
2728 ;; File name may be extracted from buffer's associated
2729 ;; file, if any.
2732 ;; Can't determine file name on our own: Ask user.
2736 "Output file: " pub-dir nil nil nil
2739 ;; Build file name. Enforce EXTENSION over whatever user may have
2740 ;; come up with. PUB-DIR, if defined, always has precedence over
2741 ;; any provided path.
2746 extension))
2751 "Apply BODY in a copy of the current buffer.
2753 The copy preserves local variables and visibility of the original
2754 buffer.
2756 Point is at buffer's beginning when BODY is applied."
2766 ,original-buffer
2778 "Expand every include keyword in buffer.
2779 Optional argument INCLUDED is a list of included file names along
2780 with their line restriction, when appropriate. It is used to
2781 avoid infinite recursion. Optional argument DIR is the current
2782 working directory. It is used to properly resolve relative
2783 paths."
2790 ;; Extract arguments from keyword's value.
2804 ;; Minimal level of included file defaults to the child
2805 ;; level of the current headline, if any, or one. It
2806 ;; only applies is the file is meant to be included as
2807 ;; an Org one.
2815 ;; Remove keyword.
2820 ;; Check if files has already been parsed. Look after
2821 ;; inclusion lines too, as different parts of the same file
2822 ;; can be included too.
2834 ind-str contents ind-str))))
2842 ind-str env contents ind-str))))
2855 "Prepare the contents of FILE for inclusion and return them as a string.
2857 When optional argument LINES is a string specifying a range of
2858 lines, include only those lines.
2860 Optional argument IND, when non-nil, is an integer specifying the
2861 global indentation of returned contents. Since its purpose is to
2862 allow an included file to stay in the same environment it was
2863 created \(i.e. a list item), it doesn't apply past the first
2864 headline encountered.
2866 Optional argument MINLEVEL, when non-nil, is an integer
2867 specifying the level that any top-level headline in the included
2868 file should have."
2884 ;; Remove blank lines at beginning and end of contents. The logic
2885 ;; behind that removal is that blank lines around include keyword
2886 ;; override blank lines in included file.
2895 ;; If IND is set, preserve indentation of include keyword until
2896 ;; the first headline encountered.
2902 ;; Do not move footnote definitions out of column 0.
2908 ;; When MINLEVEL is specified, compute minimal level for headlines
2909 ;; in the file (CUR-MIN), and remove stars to each headline so
2910 ;; that headlines with minimal level have a level of MINLEVEL.
2920 ;; Only change stars, don't bother moving whole
2921 ;; sections.
2928 "Execute every Babel code in the visible part of current buffer.
2929 This function will return an error if the current buffer is
2930 visiting a file."
2931 ;; Get a pristine copy of current buffer so Babel references can be
2932 ;; properly resolved.
2939 \f
2940 ;;; Tools For Back-Ends
2941 ;;
2942 ;; A whole set of tools is available to help build new exporters. Any
2943 ;; function general enough to have its use across many back-ends
2944 ;; should be added here.
2946 ;;;; For Affiliated Keywords
2947 ;;
2948 ;; `org-export-read-attribute' reads a property from a given element
2949 ;; as a plist. It can be used to normalize affiliated keywords'
2950 ;; syntax.
2951 ;;
2952 ;; Since captions can span over multiple lines and accept dual values,
2953 ;; their internal representation is a bit tricky. Therefore,
2954 ;; `org-export-get-caption' transparently returns a given element's
2955 ;; caption as a secondary string.
2958 "Turn ATTRIBUTE property from ELEMENT into a plist.
2960 When optional argument PROPERTY is non-nil, return the value of
2961 that property within attributes.
2965 properties."
2973 "Return caption from ELEMENT as a secondary string.
2975 When optional argument SHORTP is non-nil, return short caption,
2976 as a secondary string, instead.
2978 Caption lines are separated by a white space."
2986 ;;;; For Derived Back-ends
2987 ;;
2988 ;; `org-export-with-backend' is a function allowing to locally use
2989 ;; another back-end to transcode some object or element. In a derived
2990 ;; back-end, it may be used as a fall-back function once all specific
2991 ;; cases have been treated.
2994 "Call a transcoder from BACK-END on DATA.
2995 CONTENTS, when non-nil, is the transcoded contents of DATA
2996 element, as a string. INFO, when non-nil, is the communication
2997 channel used for export, as a plist.."
3007 ;;;; For Export Snippets
3008 ;;
3009 ;; Every export snippet is transmitted to the back-end. Though, the
3010 ;; latter will only retain one type of export-snippet, ignoring
3011 ;; others, based on the former's target back-end. The function
3012 ;; `org-export-snippet-backend' returns that back-end for a given
3013 ;; export-snippet.
3016 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3017 Translation, with `org-export-snippet-translation-alist', is
3018 applied."
3022 back-end))))
3025 ;;;; For Footnotes
3026 ;;
3027 ;; `org-export-collect-footnote-definitions' is a tool to list
3028 ;; actually used footnotes definitions in the whole parse tree, or in
3029 ;; an headline, in order to add footnote listings throughout the
3030 ;; transcoded data.
3031 ;;
3032 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3033 ;; back-ends, when they need to attach the footnote definition only to
3034 ;; the first occurrence of the corresponding label.
3035 ;;
3036 ;; `org-export-get-footnote-definition' and
3037 ;; `org-export-get-footnote-number' provide easier access to
3038 ;; additional information relative to a footnote reference.
3041 "Return an alist between footnote numbers, labels and definitions.
3043 DATA is the parse tree from which definitions are collected.
3044 INFO is the plist used as a communication channel.
3046 Definitions are sorted by order of references. They either
3047 appear as Org data or as a secondary string for inlined
3048 footnotes. Unreferenced definitions are ignored."
3050 collect-fn ; for byte-compiler.
3054 ;; Collect footnote number, label and definition in DATA.
3056 data 'footnote-reference
3063 def)
3064 num-alist)
3065 ;; Also search in definition for nested footnotes.
3068 ;; Don't enter footnote definitions since it will happen
3069 ;; when their first reference is found.
3075 "Non-nil when a footnote reference is the first one for its label.
3077 FOOTNOTE-REFERENCE is the footnote reference being considered.
3078 INFO is the plist used as a communication channel."
3080 ;; Anonymous footnotes are always a first reference.
3082 ;; Otherwise, return the first footnote with the same LABEL and
3083 ;; test if it is equal to FOOTNOTE-REFERENCE.
3089 data 'footnote-reference
3094 ;; If FN isn't inlined, be sure to traverse its
3095 ;; definition before resuming search. See
3096 ;; comments in `org-export-get-footnote-number'
3097 ;; for more information.
3101 ;; Don't enter footnote definitions since it will
3102 ;; happen when their first reference is found.
3105 footnote-reference)))))
3108 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3109 INFO is the plist used as a communication channel."
3115 "Return number associated to a footnote.
3117 FOOTNOTE is either a footnote reference or a footnote definition.
3118 INFO is the plist used as a communication channel."
3120 seen-refs
3121 search-ref ; For byte-compiler.
3125 ;; Search footnote references through DATA, filling
3126 ;; SEEN-REFS along the way.
3128 data 'footnote-reference
3132 ;; Anonymous footnote match: return number.
3135 ;; Labels match: return number.
3138 ;; Anonymous footnote: it's always a new one. Also,
3139 ;; be sure to return nil from the `cond' so
3140 ;; `first-match' doesn't get us out of the loop.
3142 ;; Label not seen so far: add it so SEEN-REFS.
3143 ;;
3144 ;; Also search for subsequent references in
3145 ;; footnote definition so numbering follows reading
3146 ;; logic. Note that we don't have to care about
3147 ;; inline definitions, since `org-element-map'
3148 ;; already traverses them at the right time.
3149 ;;
3150 ;; Once again, return nil to stay in the loop.
3155 nil))))
3156 ;; Don't enter footnote definitions since it will happen
3157 ;; when their first reference is found.
3162 ;;;; For Headlines
3163 ;;
3164 ;; `org-export-get-relative-level' is a shortcut to get headline
3165 ;; level, relatively to the lower headline level in the parsed tree.
3166 ;;
3167 ;; `org-export-get-headline-number' returns the section number of an
3168 ;; headline, while `org-export-number-to-roman' allows to convert it
3169 ;; to roman numbers.
3170 ;;
3171 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3172 ;; `org-export-last-sibling-p' are three useful predicates when it
3173 ;; comes to fulfill the `:headline-levels' property.
3174 ;;
3175 ;; `org-export-get-tags', `org-export-get-category' and
3176 ;; `org-export-get-node-property' extract useful information from an
3177 ;; headline or a parent headline. They all handle inheritance.
3180 "Return HEADLINE relative level within current parsed tree.
3181 INFO is a plist holding contextual information."
3186 "Non-nil when HEADLINE is considered as low level.
3188 INFO is a plist used as a communication channel.
3190 A low level headlines has a relative level greater than
3191 `:headline-levels' property value.
3193 Return value is the difference between HEADLINE relative level
3194 and the last level being considered as high enough, or nil."
3201 "Return HEADLINE numbering as a list of numbers.
3202 INFO is a plist holding contextual information."
3206 "Return a non-nil value if HEADLINE element should be numbered.
3207 INFO is a plist used as a communication channel."
3213 "Convert integer N into a roman numeral."
3226 res)))
3229 "Return list of tags associated to ELEMENT.
3231 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3232 is a plist used as a communication channel.
3234 Select tags (see `org-export-select-tags') and exclude tags (see
3235 `org-export-exclude-tags') are removed from the list.
3237 When non-nil, optional argument TAGS should be a list of strings.
3238 Any tag belonging to this list will also be removed.
3240 When optional argument INHERITED is non-nil, tags can also be
3241 inherited from parent headlines and FILETAGS keywords."
3247 ;; Build complete list of inherited tags.
3258 ;; Add FILETAGS keywords and return results.
3262 "Return node PROPERTY value for BLOB.
3264 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3265 element or object.
3267 If optional argument INHERITED is non-nil, the value can be
3268 inherited from a parent headline.
3270 Return value is a string or nil."
3282 "Return category for element or object BLOB.
3284 INFO is a plist used as a communication channel.
3286 CATEGORY is automatically inherited from a parent headline, from
3287 #+CATEGORY: keyword or created out of original file name. If all
3291 ;; Almost like `org-export-node-property', but we cannot trust
3292 ;; `plist-member' as every headline has a `:category'
3293 ;; property, would it be nil or equal to "???" (which has the
3294 ;; same meaning).
3313 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3314 INFO is a plist used as a communication channel."
3319 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3320 INFO is a plist used as a communication channel."
3324 ;;;; For Links
3325 ;;
3326 ;; `org-export-solidify-link-text' turns a string into a safer version
3327 ;; for links, replacing most non-standard characters with hyphens.
3328 ;;
3329 ;; `org-export-get-coderef-format' returns an appropriate format
3330 ;; string for coderefs.
3331 ;;
3332 ;; `org-export-inline-image-p' returns a non-nil value when the link
3333 ;; provided should be considered as an inline image.
3334 ;;
3335 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3336 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3337 ;; returns an appropriate unique identifier when found, or nil.
3338 ;;
3339 ;; `org-export-resolve-id-link' returns the first headline with
3340 ;; specified id or custom-id in parse tree, the path to the external
3341 ;; file with the id or nil when neither was found.
3342 ;;
3343 ;; `org-export-resolve-coderef' associates a reference to a line
3344 ;; number in the element it belongs, or returns the reference itself
3345 ;; when the element isn't numbered.
3348 "Take link text S and make a safe target out of it."
3353 "Return format string for code reference link.
3354 PATH is the link path. DESC is its description."
3362 "Non-nil if LINK object points to an inline image.
3364 Optional argument is a set of RULES defining inline images. It
3365 is an alist where associations have the following shape:
3367 \(TYPE . REGEXP)
3369 Applying a rule means apply REGEXP against LINK's path when its
3370 type is TYPE. The function will return a non-nil value if any of
3371 the provided rules is non-nil. The default rule is
3372 `org-export-default-inline-image-rule'.
3374 This only applies to links without a description."
3385 rules)
3386 ;; Return nil if no rule matched.
3387 nil))))
3390 "Resolve a code reference REF.
3392 INFO is a plist used as a communication channel.
3394 Return associated line number in source code, or REF itself,
3395 depending on src-block or example element's switches."
3403 org-coderef-label-format)))
3407 ;; Element containing REF is found. Resolve it to either
3408 ;; a label or a line number, as needed.
3418 "Return LINK destination.
3420 INFO is a plist holding contextual information.
3422 Return value can be an object, an element, or nil:
3424 - If LINK path matches a target object (i.e. <<path>>) or
3427 - If LINK path exactly matches the name affiliated keyword
3428 \(i.e. #+NAME: path) of an element, return that element.
3430 - If LINK path exactly matches any headline name, return that
3431 element. If more than one headline share that name, priority
3432 will be given to the one with the closest common ancestor, if
3433 any, or the first one in the parse tree otherwise.
3435 - Otherwise, return nil.
3441 ;; First try to find a matching "<<path>>" unless user specified
3442 ;; he was looking for an headline (path starts with a *
3443 ;; character).
3447 return target)))
3448 ;; Then try to find an element with a matching "#+NAME: path"
3449 ;; affiliated keyword.
3456 ;; Last case: link either points to an headline or to
3457 ;; nothingness. Try to find the source, with priority given to
3458 ;; headlines with the closest common ancestor. If such candidate
3459 ;; is found, return it, otherwise return nil.
3463 ;; Return first headline whose `:raw-value' property
3464 ;; is NAME in parse tree DATA, or nil.
3467 data 'headline
3471 name)
3472 headline))
3474 ;; Search among headlines sharing an ancestor with link,
3475 ;; from closest to farthest.
3483 ;; No match with a common ancestor: try the full parse-tree.
3489 "Return headline referenced as LINK destination.
3491 INFO is a plist used as a communication channel.
3493 Return value can be the headline element matched in current parse
3497 ;; First check if id is within the current parse tree.
3503 headline))
3505 ;; Otherwise, look for external files.
3509 "Return radio-target object referenced as LINK destination.
3511 INFO is a plist used as a communication channel.
3513 Return value can be a radio-target object or nil. Assume LINK
3523 ;;;; For References
3524 ;;
3525 ;; `org-export-get-ordinal' associates a sequence number to any object
3526 ;; or element.
3529 "Return ordinal number of an element or object.
3531 ELEMENT is the element or object considered. INFO is the plist
3532 used as a communication channel.
3534 Optional argument TYPES, when non-nil, is a list of element or
3535 object types, as symbols, that should also be counted in.
3536 Otherwise, only provided element's type is considered.
3538 Optional argument PREDICATE is a function returning a non-nil
3539 value if the current element or object should be counted in. It
3540 accepts two arguments: the element or object being considered and
3541 the plist used as a communication channel. This allows to count
3542 only a certain type of objects (i.e. inline images).
3544 Return value is a list of numbers if ELEMENT is an headline or an
3545 item. It is nil for keywords. It represents the footnote number
3546 for footnote definitions and footnote references. If ELEMENT is
3547 a target, return the same value as if ELEMENT was the closest
3548 table, item or headline containing the target. In any other
3549 case, return the sequence number of ELEMENT among elements or
3550 objects of the same type."
3551 ;; A target keyword, representing an invisible target, never has
3552 ;; a sequence number.
3554 ;; Ordinal of a target object refer to the ordinal of the closest
3555 ;; table, item, or headline containing the object.
3559 when
3563 table))
3564 return parent)))
3566 ;; Special case 1: An headline returns its number as a list.
3568 ;; Special case 2: An item returns its number as a list.
3572 struct
3579 ;; Increment counter until ELEMENT is found again.
3590 ;;;; For Src-Blocks
3591 ;;
3592 ;; `org-export-get-loc' counts number of code lines accumulated in
3593 ;; src-block or example-block elements with a "+n" switch until
3594 ;; a given element, excluded. Note: "-n" switches reset that count.
3595 ;;
3596 ;; `org-export-unravel-code' extracts source code (along with a code
3597 ;; references alist) from an `element-block' or `src-block' type
3598 ;; element.
3599 ;;
3600 ;; `org-export-format-code' applies a formatting function to each line
3601 ;; of code, providing relative line number and code reference when
3602 ;; appropriate. Since it doesn't access the original element from
3603 ;; which the source code is coming, it expects from the code calling
3604 ;; it to know if lines should be numbered and if code references
3605 ;; should appear.
3606 ;;
3607 ;; Eventually, `org-export-format-code-default' is a higher-level
3608 ;; function (it makes use of the two previous functions) which handles
3609 ;; line numbering and code references inclusion, and returns source
3610 ;; code in a format suitable for plain text or verbatim output.
3613 "Return accumulated lines of code up to ELEMENT.
3615 INFO is the plist used as a communication channel.
3617 ELEMENT is excluded from count."
3624 ;; ELEMENT is reached: Quit the loop.
3626 ;; Only count lines from src-block and example-block elements
3627 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3631 ;; Accumulate locs or reset them.
3635 ;; Return nil to stay in the loop.
3636 nil)))
3638 ;; Return value.
3639 loc))
3642 "Clean source code and extract references out of it.
3644 ELEMENT has either a `src-block' an `example-block' type.
3646 Return a cons cell whose CAR is the source code, cleaned from any
3647 reference and protective comma and CDR is an alist between
3648 relative line number (integer) and name of code reference on that
3649 line (string)."
3651 ;; Get code and clean it. Remove blank lines at its
3652 ;; beginning and end.
3658 ;; If appropriate, remove global indentation.
3661 c
3663 ;; Get format used for references.
3666 org-coderef-label-format)))
3667 ;; Build a regexp matching a loc with a reference.
3672 ;; Return value.
3674 ;; Code with references removed.
3680 ;; Ref line: remove ref, and signal its position in REFS.
3684 ;; Reference alist.
3685 refs)))
3688 "Format CODE by applying FUN line-wise and return it.
3690 CODE is a string representing the code to format. FUN is
3691 a function. It must accept three arguments: a line of
3692 code (string), the current line number (integer) or nil and the
3693 reference associated to the current line (string) or nil.
3695 Optional argument NUM-LINES can be an integer representing the
3696 number of code lines accumulated until the current code. Line
3697 numbers passed to FUN will take it into account. If it is nil,
3698 FUN's second argument will always be nil. This number can be
3699 obtained with `org-export-get-loc' function.
3701 Optional argument REF-ALIST can be an alist between relative line
3702 number (i.e. ignoring NUM-LINES) and the name of the code
3703 reference on it. If it is nil, FUN's third argument will always
3704 be nil. It can be obtained through the use of
3705 `org-export-unravel-code' function."
3717 "Return source code from ELEMENT, formatted in a standard way.
3719 ELEMENT is either a `src-block' or `example-block' element. INFO
3720 is a plist used as a communication channel.
3722 This function takes care of line numbering and code references
3723 inclusion. Line numbers, when applicable, appear at the
3724 beginning of the line, separated from the code by two white
3725 spaces. Code references, on the other hand, appear flushed to
3726 the right, separated by six white spaces from the widest line of
3727 code."
3728 ;; Extract code and references.
3734 ;; Handle line numbering.
3743 ;; Prepare references display, if required. Any reference
3744 ;; should start six columns after the widest line of code,
3745 ;; wrapped with parenthesis.
3750 code
3754 number-str
3755 loc
3761 num-start refs)))
3764 ;;;; For Tables
3765 ;;
3766 ;; `org-export-table-has-special-column-p' and and
3767 ;; `org-export-table-row-is-special-p' are predicates used to look for
3768 ;; meta-information about the table structure.
3769 ;;
3770 ;; `org-table-has-header-p' tells when the rows before the first rule
3771 ;; should be considered as table's header.
3772 ;;
3773 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3774 ;; and `org-export-table-cell-borders' extract information from
3775 ;; a table-cell element.
3776 ;;
3777 ;; `org-export-table-dimensions' gives the number on rows and columns
3778 ;; in the table, ignoring horizontal rules and special columns.
3779 ;; `org-export-table-cell-address', given a table-cell object, returns
3780 ;; the absolute address of a cell. On the other hand,
3781 ;; `org-export-get-table-cell-at' does the contrary.
3782 ;;
3783 ;; `org-export-table-cell-starts-colgroup-p',
3784 ;; `org-export-table-cell-ends-colgroup-p',
3785 ;; `org-export-table-row-starts-rowgroup-p',
3786 ;; `org-export-table-row-ends-rowgroup-p',
3787 ;; `org-export-table-row-starts-header-p' and
3788 ;; `org-export-table-row-ends-header-p' indicate position of current
3789 ;; row or cell within the table.
3792 "Non-nil when TABLE has a special column.
3793 All special columns will be ignored during export."
3794 ;; The table has a special column when every first cell of every row
3795 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3796 ;; "*" "_" and "^". Though, do not consider a first row containing
3797 ;; only empty cells as special.
3813 "Non-nil when TABLE has an header.
3815 INFO is a plist used as a communication channel.
3817 A table has an header when it contains at least two row groups."
3820 table 'table-row
3828 info)))
3831 "Non-nil if TABLE-ROW is considered special.
3833 INFO is a plist used as the communication channel.
3835 All special rows will be ignored during export."
3839 ;; A row is special either when...
3841 ;; ... it starts with a field only containing "/",
3843 ;; ... the table contains a special column and the row start
3844 ;; with a marking character among, "^", "_", "$" or "!",
3848 ;; ... it contains only alignment cookies and empty cells.
3854 ;; Since VALUE is a secondary string, the following
3855 ;; checks avoid expanding it with `org-export-data'.
3867 "Return TABLE-ROW's group.
3869 INFO is a plist used as the communication channel.
3871 Return value is the group number, as an integer, or nil special
3872 rows and table rules. Group 1 is also table's header."
3889 "Return TABLE-CELL contents width.
3891 INFO is a plist used as the communication channel.
3893 Return value is the width given by the last width cookie in the
3894 same column as TABLE-CELL, or nil."
3899 cookie-width)
3903 ;; In a special row, try to find a width cookie at COLUMN.
3907 ;; The following checks avoid expanding unnecessarily the
3908 ;; cell with `org-export-data'
3916 ;; Ignore table rules.
3919 ;; Return value.
3920 cookie-width))
3923 "Return TABLE-CELL contents alignment.
3925 INFO is a plist used as the communication channel.
3927 Return alignment as specified by the last alignment cookie in the
3928 same column as TABLE-CELL. If no such cookie is found, a default
3929 alignment value will be deduced from fraction of numbers in the
3930 column (see `org-table-number-fraction' for more information).
3931 Possible values are `left', `right' and `center'."
3938 cookie-align)
3942 ;; In a special row, try to find an alignment cookie at
3943 ;; COLUMN.
3947 ;; Since VALUE is a secondary string, the following checks
3948 ;; avoid useless expansion through `org-export-data'.
3956 ;; Ignore table rules.
3958 ;; In a standard row, check if cell's contents are expressing
3959 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3960 ;; Though, don't bother if an alignment cookie has already
3961 ;; defined cell's alignment.
3966 info)))
3971 ;; Return value. Alignment specified by cookies has precedence
3972 ;; over alignment deduced from cells contents.
3981 "Return TABLE-CELL borders.
3983 INFO is a plist used as a communication channel.
3985 Return value is a list of symbols, or nil. Possible values are:
3986 `top', `bottom', `above', `below', `left' and `right'. Note:
3987 `top' (resp. `bottom') only happen for a cell in the first
3988 row (resp. last row) of the table, ignoring table rules, if any.
3990 Returned borders ignore special rows."
3993 borders)
3994 ;; Top/above border? TABLE-CELL has a border above when a rule
3995 ;; used to demarcate row groups can be found above. Hence,
3996 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3997 ;; another regular row has to be found above that rule.
4006 ;; Look at every row before the current one.
4008 ;; No rule above, or rule found starts the table (ignoring any
4009 ;; special row): TABLE-CELL is at the top of the table.
4012 ;; Bottom/below border? TABLE-CELL has a border below when next
4013 ;; non-regular row below is a rule.
4022 ;; Look at every row after the current one.
4024 ;; No rule below, or rule found ends the table (modulo some
4025 ;; special row): TABLE-CELL is at the bottom of the table.
4028 ;; Right/left borders? They can only be specified by column
4029 ;; groups. Column groups are defined in a row starting with "/".
4030 ;; Also a column groups row only contains "<", "<>", ">" or blank
4031 ;; cells.
4048 ;; There's a left border when previous cell, if
4049 ;; any, ends a group, or current one starts one.
4055 ;; There's a right border when next cell, if any,
4056 ;; starts a group, or current one ends one.
4063 ;; Table rows are read in reverse order so last column groups
4064 ;; row has precedence over any previous one.
4066 ;; Return value.
4067 borders))
4070 "Non-nil when TABLE-CELL is at the beginning of a row group.
4071 INFO is a plist used as a communication channel."
4072 ;; A cell starts a column group either when it is at the beginning
4073 ;; of a row (or after the special column, if any) or when it has
4074 ;; a left border.
4078 table-cell)
4082 "Non-nil when TABLE-CELL is at the end of a row group.
4083 INFO is a plist used as a communication channel."
4084 ;; A cell ends a column group either when it is at the end of a row
4085 ;; or when it has a right border.
4088 table-cell)
4092 "Non-nil when TABLE-ROW is at the beginning of a column group.
4093 INFO is a plist used as a communication channel."
4101 "Non-nil when TABLE-ROW is at the end of a column group.
4102 INFO is a plist used as a communication channel."
4110 "Non-nil when TABLE-ROW is the first table header's row.
4111 INFO is a plist used as a communication channel."
4118 "Non-nil when TABLE-ROW is the last table header's row.
4119 INFO is a plist used as a communication channel."
4126 "Return TABLE dimensions.
4128 INFO is a plist used as a communication channel.
4130 Return value is a CONS like (ROWS . COLUMNS) where
4131 ROWS (resp. COLUMNS) is the number of exportable
4132 rows (resp. columns)."
4134 ;; Set number of rows, and extract first one.
4136 table 'table-row
4141 ;; Set number of columns.
4143 ;; Return value.
4147 "Return address of a regular TABLE-CELL object.
4149 TABLE-CELL is the cell considered. INFO is a plist used as
4150 a communication channel.
4152 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4153 zero-based index. Only exportable cells are considered. The
4154 function returns nil for other cells."
4157 ;; Ignore cells in special rows or in special column.
4162 ;; Row number.
4165 table 'table-row
4171 ;; Column number.
4174 table-row 'table-cell
4180 "Return regular table-cell object at ADDRESS in TABLE.
4182 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4183 zero-based index. TABLE is a table type element. INFO is
4184 a plist used as a communication channel.
4186 If no table-cell, among exportable cells, is found at ADDRESS,
4187 return nil."
4190 ;; Row at (car address) or nil.
4193 table 'table-row
4199 'table-cell
4206 ;;;; For Tables Of Contents
4207 ;;
4208 ;; `org-export-collect-headlines' builds a list of all exportable
4209 ;; headline elements, maybe limited to a certain depth. One can then
4210 ;; easily parse it and transcode it.
4211 ;;
4212 ;; Building lists of tables, figures or listings is quite similar.
4213 ;; Once the generic function `org-export-collect-elements' is defined,
4214 ;; `org-export-collect-tables', `org-export-collect-figures' and
4215 ;; `org-export-collect-listings' can be derived from it.
4218 "Collect headlines in order to build a table of contents.
4220 INFO is a plist used as a communication channel.
4222 When optional argument N is an integer, it specifies the depth of
4223 the table of contents. Otherwise, it is set to the value of the
4224 last headline level. See `org-export-headline-levels' for more
4225 information.
4227 Return a list of all exportable headlines as parsed elements."
4231 'headline
4233 ;; Strip contents from HEADLINE.
4236 info))
4239 "Collect referenceable elements of a determined type.
4241 TYPE can be a symbol or a list of symbols specifying element
4242 types to search. Only elements with a caption are collected.
4244 INFO is a plist used as a communication channel.
4246 When non-nil, optional argument PREDICATE is a function accepting
4247 one argument, an element of type TYPE. It returns a non-nil
4248 value when that element should be collected.
4250 Return a list of all elements found, in order of appearance."
4256 element))
4257 info))
4260 "Build a list of tables.
4261 INFO is a plist used as a communication channel.
4263 Return a list of table elements with a caption."
4267 "Build a list of figures.
4269 INFO is a plist used as a communication channel. PREDICATE is
4270 a function which accepts one argument: a paragraph element and
4271 whose return value is non-nil when that element should be
4272 collected.
4274 A figure is a paragraph type element, with a caption, verifying
4276 a vague concept that may depend on back-end.
4278 Return a list of elements recognized as figures."
4282 "Build a list of src blocks.
4284 INFO is a plist used as a communication channel.
4286 Return a list of src-block elements with a caption."
4290 ;;;; For Timestamps
4291 ;;
4292 ;; `org-export-timestamp-has-time-p' is a predicate to know if hours
4293 ;; and minutes are defined in a given timestamp.
4294 ;;
4295 ;; `org-export-format-timestamp' allows to format a timestamp object
4296 ;; with an arbitrary format string.
4299 "Non-nil when TIMESTAMP has a time specified."
4303 "Format a TIMESTAMP element into a string.
4305 FORMAT is a format specifier to be passed to
4306 `format-time-string'.
4308 When optional argument END is non-nil, use end of date-range or
4309 time-range, if possible.
4311 When optional argument UTC is non-nil, time will be expressed as
4312 Universal Time."
4314 format
4322 utc))
4325 "Extract a timestamp object from a date or time range.
4327 TIMESTAMP is a timestamp object. END, when non-nil, means extract
4328 the end of the range. Otherwise, extract its start.
4330 Return a new timestamp object sharing the same parent as
4331 TIMESTAMP."
4335 ;; Set new type.
4338 ;; Copy start properties over end properties if END is
4339 ;; non-nil. Otherwise, copy end properties over `start' ones.
4347 split-ts
4351 ;; Eventually refresh `:raw-value'.
4357 "Apply `org-translate-time' on a TIMESTAMP object.
4358 When optional argument BOUNDARY is non-nil, it is either the
4359 symbol `start' or `end'. In this case, only translate the
4360 starting or ending part of TIMESTAMP if it is a date or time
4361 range. Otherwise, translate both parts."
4369 "--"
4375 :raw-value
4380 ;;;; Smart Quotes
4381 ;;
4382 ;; The main function for the smart quotes sub-system is
4383 ;; `org-export-activate-smart-quotes', which replaces every quote in
4384 ;; a given string from the parse tree with its "smart" counterpart.
4385 ;;
4386 ;; Dictionary for smart quotes is stored in
4387 ;; `org-export-smart-quotes-alist'.
4388 ;;
4389 ;; Internally, regexps matching potential smart quotes (checks at
4390 ;; string boundaries are also necessary) are defined in
4391 ;; `org-export-smart-quotes-regexps'.
4428 "Smart quotes translations.
4430 Alist whose CAR is a language string and CDR is an alist with
4431 quote type as key and a plist associating various encodings to
4432 their translation as value.
4434 A quote type can be any symbol among `opening-double-quote',
4435 `closing-double-quote', `opening-single-quote',
4436 `closing-single-quote' and `apostrophe'.
4438 Valid encodings include `:utf-8', `:html', `:latex' and
4439 `:texinfo'.
4445 ;; Possible opening quote at beginning of string.
4447 ;; Possible closing quote at beginning of string.
4449 ;; Possible apostrophe at beginning of string.
4451 ;; Opening single and double quotes.
4453 ;; Closing single and double quotes.
4455 ;; Apostrophe.
4457 ;; Possible opening quote at end of string.
4459 ;; Possible closing quote at end of string.
4461 ;; Possible apostrophe at end of string.
4463 "List of regexps matching a quote or an apostrophe.
4469 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4470 `:utf-8'. INFO is a plist used as a communication channel.
4472 The function has to retrieve information about string
4473 surroundings in parse tree. It can only happen with an
4474 unmodified string. Thus, if S has already been through another
4475 process, a non-nil ORIGINAL optional argument will provide that
4476 original string.
4478 Return the new string."
4485 ;; Return smart quote associated to a give quote Q, as
4486 ;; a string. TYPE is a symbol among `open', `close' and
4487 ;; `apostrophe'.
4497 org-export-smart-quotes-alist))))
4498 encoding)
4499 q)))))
4501 ;; Only a quote: no regexp can match. We have to check both
4502 ;; sides and decide what to do.
4510 ;; 1. Replace quote character at the beginning of S.
4512 ;; Apostrophe?
4518 ;; Closing quote?
4524 ;; Opening quote?
4530 ;; 2. Replace quotes in the middle of the string.
4532 ;; Opening quotes.
4538 ;; Closing quotes.
4544 ;; Apostrophes.
4549 ;; 3. Replace quote character at the end of S.
4551 ;; Apostrophe?
4556 ;; Closing quote?
4562 ;; Opening quote?
4567 ;; Return string with smart quotes.
4568 s))))
4570 ;;;; Topology
4571 ;;
4572 ;; Here are various functions to retrieve information about the
4573 ;; neighbourhood of a given element or object. Neighbours of interest
4574 ;; are direct parent (`org-export-get-parent'), parent headline
4575 ;; (`org-export-get-parent-headline'), first element containing an
4576 ;; object, (`org-export-get-parent-element'), parent table
4577 ;; (`org-export-get-parent-table'), previous element or object
4578 ;; (`org-export-get-previous-element') and next element or object
4579 ;; (`org-export-get-next-element').
4580 ;;
4581 ;; `org-export-get-genealogy' returns the full genealogy of a given
4582 ;; element or object, from closest parent to full parse tree.
4585 "Return BLOB parent or nil.
4586 BLOB is the element or object considered."
4590 "Return full genealogy relative to a given element or object.
4592 BLOB is the element or object being considered.
4594 Ancestors are returned from closest to farthest, the last one
4595 being the full parse tree."
4602 "Return BLOB parent headline or nil.
4603 BLOB is the element or object being considered."
4607 parent))
4610 "Return first element containing OBJECT or nil.
4611 OBJECT is the object to consider."
4615 parent))
4618 "Return OBJECT parent table or nil.
4619 OBJECT is either a `table-cell' or `table-element' type object."
4623 parent))
4626 "Return previous element or object.
4627 BLOB is an element or object. INFO is a plist used as
4628 a communication channel. Return previous exportable element or
4629 object, a string, or nil."
4636 ;; An object can belong to the contents of its parent or
4637 ;; to a secondary string. We check the latter option
4638 ;; first.
4641 org-element-all-elements))
4645 org-element-secondary-value-alist))
4646 parent)))
4651 "Return next element or object.
4652 BLOB is an element or object. INFO is a plist used as
4653 a communication channel. Return next exportable element or
4654 object, a string, or nil."
4659 ;; An object can belong to the contents of its parent or to
4660 ;; a secondary string. We check the latter option first.
4663 org-element-all-objects))
4667 org-element-secondary-value-alist))
4668 parent)))
4671 nil))
4674 ;;;; Translation
4675 ;;
4676 ;; `org-export-translate' translates a string according to language
4677 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4678 ;; variable and a specified charset. `org-export-dictionary' contains
4679 ;; the dictionary used for the translation.
4801 "Dictionary for export engine.
4803 Alist whose CAR is the string to translate and CDR is an alist
4804 whose CAR is the language string and CDR is a plist whose
4805 properties are possible charsets and values translated terms.
4807 It is used as a database for `org-export-translate'. Since this
4808 function returns the string as-is if no translation was found,
4809 the variable only needs to record values different from the
4813 "Translate string S according to language specification.
4815 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4816 and `:utf-8'. INFO is a plist used as a communication channel.
4818 Translation depends on `:language' property. Return the
4819 translated string. If no translation is found, try to fall back
4820 to `:default' encoding. If it fails, return S."
4826 s)))
4829 \f
4830 ;;; The Dispatcher
4831 ;;
4832 ;; `org-export-dispatch' is the standard interactive way to start an
4833 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4834 ;; for its interface, which, in turn, delegates response to key
4835 ;; pressed to `org-export-dispatch-action'.
4837 ;;;###autoload
4839 "Export dispatcher for Org mode.
4841 It provides an access to common export related tasks in a buffer.
4842 Its interface comes in two flavours: standard and expert. While
4843 both share the same set of bindings, only the former displays the
4844 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4845 to switch to one or the other."
4850 nil
4851 org-export-dispatch-use-expert-ui)
4857 ;; First handle special hard-coded actions.
4863 "Publish project: "
4864 org-e-publish-project-alist nil t)
4865 org-e-publish-project-alist)
4875 "Handle interface for `org-export-dispatch'.
4877 OPTIONS is a list containing current interactive options set for
4878 export. It can contain any of the following symbols:
4879 `body' toggles a body-only export
4880 `subtree' restricts export to current subtree
4881 `visible' restricts export to visible part of buffer.
4882 `force' force publishing files.
4884 FIRST-KEY is the key pressed to select the first level menu. It
4885 is nil when this menu hasn't been selected yet.
4887 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4888 buffer is provided, but indications about currently active
4889 options are given in the prompt. Moreover, \[?] allows to switch
4890 back to standard interface."
4893 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4894 ;; non-nil is the required first-level key to activate
4895 ;; KEY. When its value is t, activate KEY independently
4896 ;; on the first key, if any. A nil value means KEY will
4897 ;; only be activated at first level.
4901 ;; Prepare menu entries by extracting them from
4902 ;; `org-export-registered-backends', and sorting them by
4903 ;; access key and by ordinal, if any.
4909 org-export-registered-backends))
4917 ;; Compute a list of allowed keys based on the first key
4918 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4919 ;; always available.
4931 ;; Build the help menu for standard UI.
4935 ;; Options are hard-coded.
4937 [%s] Body only: %s [%s] Visible only: %s
4947 ;; Display registered back-end entries. When a key
4948 ;; appears for the second time, do not create another
4949 ;; entry, but append its sub-menu to existing menu.
4962 ;; Split sub-menu into two columns.
4973 top-key)
4978 ;; Publishing menu is hard-coded.
4980 [%s] Current file [%s] Current project
4990 ;; Build prompts for both standard and expert UI.
4995 "Export command (Options: %s%s%s%s) [%s]: "
5001 ;; With expert UI, just read key with a fancy prompt. In standard
5002 ;; UI, display an intrusive help buffer.
5005 expert-prompt allowed-keys backends options first-key expertp)
5006 ;; At first call, create frame layout in order to display menu.
5012 ;; At this point, the buffer containing the menu exists and is
5013 ;; visible in the current window. So, refresh it.
5019 standard-prompt allowed-keys backends options first-key expertp))))
5023 "Read a character from command input and act accordingly.
5025 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5026 a list of characters available at a given step in the process.
5027 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5028 EXPERTP are the same as defined in `org-export-dispatch-ui',
5029 which see.
5031 Toggle export options when required. Otherwise, return value is
5032 a list with action as CAR and a list of interactive export
5033 options as CDR."
5035 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
5036 ;; depending on user's key pressed.
5039 ;; Ignore non-standard characters (i.e. "M-a") and
5040 ;; undefined associations.
5045 ;; q key at first level aborts export. At second
5046 ;; level, cancel first key instead.
5049 ;; Help key: Switch back to standard interface if
5050 ;; expert UI was active.
5052 ;; Toggle export options.
5059 first-key expertp))
5060 ;; Action selected: Send key and options back to
5061 ;; `org-export-dispatch'.
5065 ;; Publishing actions are hard-coded. Send a special
5066 ;; signal to `org-export-dispatch'.
5073 ;; Return first action associated to FIRST-KEY + KEY
5074 ;; path. Indeed, derived backends can share the same
5075 ;; FIRST-KEY.
5081 options))
5082 ;; Otherwise, enter sub-menu.
5087 ;;; org-export.el ends here