00a5ef58a068c1761f7f045fdce9e4ab60d6b7bf
| blob | 00a5ef58a068c1761f7f045fdce9e4ab60d6b7bf |
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 "Last command called from the dispatcher.
267 The value should be a list. Its CAR is the action, as a symbol,
271 \f
272 ;;; User-configurable Variables
273 ;;
274 ;; Configuration for the masses.
275 ;;
276 ;; They should never be accessed directly, as their value is to be
277 ;; stored in a property list (cf. `org-export-options-alist').
278 ;; Back-ends will read their value from there instead.
281 "Options for exporting Org mode files."
286 "General options for export engine."
291 "Whether sub-trees with the ARCHIVE tag should be exported.
293 This can have three different values:
294 nil Do not export, pretend this tree is not present.
295 t Do export the entire tree.
296 `headline' Only export the headline, but skip the tree below it.
298 This option can also be set with the #+OPTIONS line,
307 "Non-nil means insert author name into the exported file.
308 This option can also be set with the #+OPTIONS line,
314 "Non-nil means export CLOCK keywords.
315 This option can also be set with the #+OPTIONS line,
321 "Non-nil means the postamble should contain a creator sentence.
323 The sentence can be set in `org-export-creator-string' and
326 If the value is `comment' insert it as a comment."
334 "Non-nil means insert date in the exported document.
335 This options can also be set with the OPTIONS keyword,
341 emacs-version)
342 "String to insert at the end of the generated document."
347 "Non-nil means export contents of standard drawers.
349 When t, all drawers are exported. This may also be a list of
350 drawer names to export. This variable doesn't apply to
351 properties drawers.
353 This option can also be set with the #+OPTIONS line,
363 "Non-nil means insert author email into the exported file.
364 This option can also be set with the #+OPTIONS line,
370 "Non-nil means interpret *word*, /word/, _word_ and +word+.
372 If the export target supports emphasizing text, the word will be
373 typeset in bold, italic, with an underline or strike-through,
374 respectively.
381 "Tags that exclude a tree from export.
383 All trees carrying any of these tags will be excluded from
384 export. This is without condition, so even subtrees inside that
385 carry one of the `org-export-select-tags' will be removed.
387 This option can also be set with the #+EXCLUDE_TAGS: keyword."
394 This can be used to have pre-formatted text, fragments of code
395 etc. For example:
396 : ;; Some Lisp examples
397 : (while (defc cnt)
398 : (ding))
399 will be looking just like this in also HTML. See also the QUOTE
400 keyword. Not all export backends support this.
407 "Non-nil means Org footnotes should be exported.
408 This option can also be set with the #+OPTIONS line,
414 "The last level which is still exported as a headline.
416 Inferior levels will produce itemize lists when exported.
423 "The default language for export and clocktable translations, as a string.
424 This may have an association in
425 `org-clock-clocktable-language-setup'."
430 "Non-nil means preserve all line breaks when exporting.
432 Normally, in HTML output paragraphs will be reformatted.
434 This option can also be set with the #+OPTIONS line,
440 "Non-nil means interpret entities when exporting.
443 Å.
445 For a list of supported names, see the constant `org-entities'
446 and the user option `org-entities-user'.
448 This option can also be set with the #+OPTIONS line,
454 "Non-nil means inlinetasks should be exported.
455 This option can also be set with the #+OPTIONS line,
461 "Non-nil means include planning info in export.
462 This option can also be set with the #+OPTIONS: line,
468 "Non-nil means include priority cookies in export.
469 This option can also be set with the #+OPTIONS line,
475 "Non-nil means add section numbers to headlines when exporting.
477 When set to an integer n, numbering will only happen for
478 headlines whose relative level is higher or equal to n.
480 This option can also be set with the #+OPTIONS line,
486 "Tags that select a tree for export.
488 If any such tag is found in a buffer, all trees that do not carry
489 one of these tags will be ignored during export. Inside trees
490 that are selected like this, you can still deselect a subtree by
491 tagging it with one of the `org-export-exclude-tags'.
493 This option can also be set with the #+SELECT_TAGS: keyword."
498 "Non-nil means activate smart quotes during export.
499 This option can also be set with the #+OPTIONS: line,
507 When this option is turned on, these strings will be exported as:
509 Org HTML LaTeX UTF-8
510 -----+----------+--------+-------
512 -- – -- –
513 --- — --- —
516 This option can also be set with the #+OPTIONS line,
522 "Non-nil means include statistics cookies in export.
523 This option can also be set with the #+OPTIONS: line,
531 When this option is turned on, you can use TeX-like syntax for
533 will be considered as a single item - so grouping with {} is
534 normally not needed. For example, the following things will be
535 parsed as single sub- or superscripts.
537 10^24 or 10^tau several digits will be considered 1 item.
538 10^-12 or 10^-tau a leading sign with digits or a word
539 x^2-y^3 will be read as x^2 - y^3, because items are
540 terminated by almost any nonword/nondigit char.
541 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
543 Still, ambiguity is possible - so when in doubt use {} to enclose
544 the sub/superscript. If you set this variable to the symbol
545 `{}', the braces are *required* in order to trigger
546 interpretations as sub/superscript. This can be helpful in
549 This option can also be set with the #+OPTIONS line,
558 "Non-nil means create a table of contents in exported files.
560 The TOC contains headlines with levels up
561 to`org-export-headline-levels'. When an integer, include levels
562 up to N in the toc, this may then be different from
563 `org-export-headline-levels', but it will not be allowed to be
564 larger than the number of headline levels. When nil, no table of
565 contents is made.
567 This option can also be set with the #+OPTIONS line,
577 For example:
579 | Name | Address | Birthday |
580 |-------------+----------+-----------|
581 | Arthur Dent | England | 29.2.2100 |
588 "If nil, do not export tags, just remove them from headlines.
590 If this is the symbol `not-in-toc', tags will be removed from
591 table of contents entries, but still be shown in the headlines of
592 the document.
594 This option can also be set with the #+OPTIONS line,
603 "Non-nil means include TODO items for export.
605 This may have the following values:
606 t include tasks independent of state.
607 `todo' include only tasks that are not yet done.
608 `done' include only tasks that are already done.
609 nil ignore all tasks.
610 list of keywords include tasks with these keywords.
612 This option can also be set with the #+OPTIONS line,
624 "Non-nil means insert a time stamp into the exported file.
625 The time stamp shows when the file was created.
627 This option can also be set with the #+OPTIONS line,
633 "Non nil means allow timestamps in export.
635 It can be set to `active', `inactive', t or nil, in order to
636 export, respectively, only active timestamps, only inactive ones,
637 all of them or none.
639 This option can also be set with the #+OPTIONS line, e.g.
649 "Non-nil means include TODO keywords in export.
650 When nil, remove all these keywords from the export."
655 "Non-nil means allow #+BIND to define local variable values for export.
656 This is a potential security risk, which is why the user must
657 confirm the use of these lines."
665 "Alist between export snippets back-ends and exporter back-ends.
667 This variable allows to provide shortcuts for export snippets.
671 HTML code while every other back-end will ignore it."
679 "Coding system for the exported file."
684 "Non-nil means exported stuff will also be pushed onto the kill ring."
689 "The initial scope when exporting with `org-export-dispatch'.
690 This variable can be either set to `buffer' or `subtree'."
697 "Non-nil means show buffer after exporting to temp buffer.
698 When Org exports to a file, the buffer visiting that file is ever
699 shown, but remains buried. However, when exporting to
700 a temporary buffer, that buffer is popped up in a second window.
701 When this variable is nil, the buffer remains buried also in
702 these cases."
707 "Non-nil means using a non-intrusive `org-export-dispatch'.
708 In that case, no help buffer is displayed. Though, an indicator
713 be passed the FORCE argument). Also, \[?] allows to switch back
714 to standard mode."
719 \f
720 ;;; Defining Back-ends
721 ;;
722 ;; `org-export-define-backend' is the standard way to define an export
723 ;; back-end. It allows to specify translators, filters, buffer
724 ;; options and a menu entry. If the new back-end shares translators
725 ;; with another back-end, `org-export-define-derived-backend' may be
726 ;; used instead.
727 ;;
728 ;; Internally, a back-end is stored as a list, of which CAR is the
729 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
730 ;; properties of a given back-end are: `org-export-backend-filters',
731 ;; `org-export-backend-menu', `org-export-backend-options' and
732 ;; `org-export-backend-translate-table'.
733 ;;
734 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
735 ;; when a given back-end hasn't been registered yet.
738 "Define a new back-end BACKEND.
740 TRANSLATORS is an alist between object or element types and
741 functions handling them.
743 These functions should return a string without any trailing
744 space, or nil. They must accept three arguments: the object or
745 element itself, its contents or nil when it isn't recursive and
746 the property list used as a communication channel.
748 Contents, when not nil, are stripped from any global indentation
749 \(although the relative one is preserved). They also always end
750 with a single newline character.
752 If, for a given type, no function is found, that element or
753 object type will simply be ignored, along with any blank line or
754 white space at its end. The same will happen if the function
755 returns the nil value. If that function returns the empty
756 string, the type will be ignored, but the blank lines or white
757 spaces will be kept.
759 In addition to element and object types, one function can be
760 associated to the `template' symbol and another one to the
761 `plain-text' symbol.
763 The former returns the final transcoded string, and can be used
764 to add a preamble and a postamble to document's body. It must
765 accept two arguments: the transcoded string and the property list
766 containing export options.
768 The latter, when defined, is to be called on every text not
769 recognized as an element or an object. It must accept two
770 arguments: the text string and the information channel. It is an
771 appropriate place to protect special chars relative to the
772 back-end.
774 BODY can start with pre-defined keyword arguments. The following
775 keywords are understood:
777 :export-block
779 String, or list of strings, representing block names that
780 will not be parsed. This is used to specify blocks that will
781 contain raw code specific to the back-end. These blocks
782 still have to be handled by the relative `export-block' type
783 translator.
785 :filters-alist
787 Alist between filters and function, or list of functions,
788 specific to the back-end. See `org-export-filters-alist' for
789 a list of all allowed filters. Filters defined here
790 shouldn't make a back-end test, as it may prevent back-ends
791 derived from this one to behave properly.
793 :menu-entry
795 Menu entry for the export dispatcher. It should be a list
796 like:
798 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
800 where :
802 KEY is a free character selecting the back-end.
804 DESCRIPTION-OR-ORDINAL is either a string or a number.
806 If it is a string, is will be used to name the back-end in
807 its menu entry. If it is a number, the following menu will
808 be displayed as a sub-menu of the back-end with the same
809 KEY. Also, the number will be used to determine in which
810 order such sub-menus will appear (lowest first).
812 ACTION-OR-MENU is either a function or an alist.
814 If it is an action, it will be called with three arguments:
815 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
816 for further explanations.
818 If it is an alist, associations should follow the
819 pattern:
821 \(KEY DESCRIPTION ACTION)
823 where KEY, DESCRIPTION and ACTION are described above.
825 Valid values include:
829 or
836 \(lambda (subtree visible body-only)
837 \(org-open-file
838 \(org-e-latex-export-to-pdf subtree visible body-only))))))
840 :options-alist
842 Alist between back-end specific properties introduced in
843 communication channel and how their value are acquired. See
844 `org-export-options-alist' for more information about
845 structure of the values."
864 ;; Register back-end.
868 ;; Tell parser to not parse EXPORT-BLOCK blocks.
875 ;; Splice in the body, if any.
879 "Create a new back-end as a variant of an existing one.
881 CHILD is the name of the derived back-end. PARENT is the name of
882 the parent back-end.
884 BODY can start with pre-defined keyword arguments. The following
885 keywords are understood:
887 :export-block
889 String, or list of strings, representing block names that
890 will not be parsed. This is used to specify blocks that will
891 contain raw code specific to the back-end. These blocks
892 still have to be handled by the relative `export-block' type
893 translator.
895 :filters-alist
897 Alist of filters that will overwrite or complete filters
898 defined in PARENT back-end. See `org-export-filters-alist'
899 for a list of allowed filters.
901 :menu-entry
903 Menu entry for the export dispatcher. See
904 `org-export-define-backend' for more information about the
905 expected value.
907 :options-alist
909 Alist of back-end specific properties that will overwrite or
910 complete those defined in PARENT back-end. Refer to
911 `org-export-options-alist' for more information about
912 structure of the values.
914 :translate-alist
916 Alist of element and object types and transcoders that will
917 overwrite or complete transcode table from PARENT back-end.
918 Refer to `org-export-define-backend' for detailed information
919 about transcoders.
922 as a variant of `e-latex' back-end with a custom template
923 function:
925 \(org-export-define-derived-backend my-latex e-latex
926 :translate-alist ((template . my-latex-template-fun)))
928 The back-end could then be called with, for example:
956 ;; Register back-end.
960 ;; Tell parser to not parse EXPORT-BLOCK blocks.
967 ;; Splice in the body, if any.
971 "Return filters for BACKEND."
976 "Return menu entry for BACKEND."
981 "Return export options for BACKEND."
986 "Return translate table for BACKEND."
991 "Signal an error if BACKEND isn't defined."
996 "Non-nil if BACKEND is derived from one of BACKENDS."
1001 org-export-registered-backends))
1003 parent))
1006 \f
1007 ;;; The Communication Channel
1008 ;;
1009 ;; During export process, every function has access to a number of
1010 ;; properties. They are of two types:
1011 ;;
1012 ;; 1. Environment options are collected once at the very beginning of
1013 ;; the process, out of the original buffer and configuration.
1014 ;; Collecting them is handled by `org-export-get-environment'
1015 ;; function.
1016 ;;
1017 ;; Most environment options are defined through the
1018 ;; `org-export-options-alist' variable.
1019 ;;
1020 ;; 2. Tree properties are extracted directly from the parsed tree,
1021 ;; just before export, by `org-export-collect-tree-properties'.
1022 ;;
1023 ;; Here is the full list of properties available during transcode
1024 ;; process, with their category and their value type.
1025 ;;
1026 ;; + `:author' :: Author's name.
1027 ;; - category :: option
1028 ;; - type :: string
1029 ;;
1030 ;; + `:back-end' :: Current back-end used for transcoding.
1031 ;; - category :: tree
1032 ;; - type :: symbol
1033 ;;
1034 ;; + `:creator' :: String to write as creation information.
1035 ;; - category :: option
1036 ;; - type :: string
1037 ;;
1038 ;; + `:date' :: String to use as date.
1039 ;; - category :: option
1040 ;; - type :: string
1041 ;;
1042 ;; + `:description' :: Description text for the current data.
1043 ;; - category :: option
1044 ;; - type :: string
1045 ;;
1046 ;; + `:email' :: Author's email.
1047 ;; - category :: option
1048 ;; - type :: string
1049 ;;
1050 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1051 ;; process.
1052 ;; - category :: option
1053 ;; - type :: list of strings
1054 ;;
1055 ;; + `:exported-data' :: Hash table used for memoizing
1056 ;; `org-export-data'.
1057 ;; - category :: tree
1058 ;; - type :: hash table
1059 ;;
1060 ;; + `:filetags' :: List of global tags for buffer. Used by
1061 ;; `org-export-get-tags' to get tags with inheritance.
1062 ;; - category :: option
1063 ;; - type :: list of strings
1064 ;;
1065 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1066 ;; their definition, as parsed data. Only non-inlined footnotes
1067 ;; are represented in this alist. Also, every definition isn't
1068 ;; guaranteed to be referenced in the parse tree. The purpose of
1069 ;; this property is to preserve definitions from oblivion
1070 ;; (i.e. when the parse tree comes from a part of the original
1071 ;; buffer), it isn't meant for direct use in a back-end. To
1072 ;; retrieve a definition relative to a reference, use
1073 ;; `org-export-get-footnote-definition' instead.
1074 ;; - category :: option
1075 ;; - type :: alist (STRING . LIST)
1076 ;;
1077 ;; + `:headline-levels' :: Maximum level being exported as an
1078 ;; headline. Comparison is done with the relative level of
1079 ;; headlines in the parse tree, not necessarily with their
1080 ;; actual level.
1081 ;; - category :: option
1082 ;; - type :: integer
1083 ;;
1084 ;; + `:headline-offset' :: Difference between relative and real level
1085 ;; of headlines in the parse tree. For example, a value of -1
1086 ;; means a level 2 headline should be considered as level
1087 ;; 1 (cf. `org-export-get-relative-level').
1088 ;; - category :: tree
1089 ;; - type :: integer
1090 ;;
1091 ;; + `:headline-numbering' :: Alist between headlines and their
1092 ;; numbering, as a list of numbers
1093 ;; (cf. `org-export-get-headline-number').
1094 ;; - category :: tree
1095 ;; - type :: alist (INTEGER . LIST)
1096 ;;
1097 ;; + `:id-alist' :: Alist between ID strings and destination file's
1098 ;; path, relative to current directory. It is used by
1099 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1100 ;; external file.
1101 ;; - category :: option
1102 ;; - type :: alist (STRING . STRING)
1103 ;;
1104 ;; + `:ignore-list' :: List of elements and objects that should be
1105 ;; ignored during export.
1106 ;; - category :: tree
1107 ;; - type :: list of elements and objects
1108 ;;
1109 ;; + `:input-file' :: Full path to input file, if any.
1110 ;; - category :: option
1111 ;; - type :: string or nil
1112 ;;
1113 ;; + `:keywords' :: List of keywords attached to data.
1114 ;; - category :: option
1115 ;; - type :: string
1116 ;;
1117 ;; + `:language' :: Default language used for translations.
1118 ;; - category :: option
1119 ;; - type :: string
1120 ;;
1121 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1122 ;; transcoding.
1123 ;; - category :: option
1124 ;; - type :: list (as returned by `org-element-parse-buffer')
1125 ;;
1126 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1127 ;; all line breaks.
1128 ;; - category :: option
1129 ;; - type :: symbol (nil, t)
1130 ;;
1131 ;; + `:section-numbers' :: Non-nil means transcoding should add
1132 ;; section numbers to headlines.
1133 ;; - category :: option
1134 ;; - type :: symbol (nil, t)
1135 ;;
1136 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1137 ;; in transcoding. When such a tag is present, subtrees without
1138 ;; it are de facto excluded from the process. See
1139 ;; `use-select-tags'.
1140 ;; - category :: option
1141 ;; - type :: list of strings
1142 ;;
1143 ;; + `:target-list' :: List of targets encountered in the parse tree.
1144 ;; This is used to partly resolve "fuzzy" links
1145 ;; (cf. `org-export-resolve-fuzzy-link').
1146 ;; - category :: tree
1147 ;; - type :: list of strings
1148 ;;
1149 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1150 ;; a time stamp in the output.
1151 ;; - category :: option
1152 ;; - type :: symbol (nil, t)
1153 ;;
1154 ;; + `:translate-alist' :: Alist between element and object types and
1155 ;; transcoding functions relative to the current back-end.
1156 ;; Special keys `template' and `plain-text' are also possible.
1157 ;; - category :: option
1158 ;; - type :: alist (SYMBOL . FUNCTION)
1159 ;;
1160 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1161 ;; also be transcoded. If it is set to the `headline' symbol,
1162 ;; only the archived headline's name is retained.
1163 ;; - category :: option
1164 ;; - type :: symbol (nil, t, `headline')
1165 ;;
1166 ;; + `:with-author' :: Non-nil means author's name should be included
1167 ;; in the output.
1168 ;; - category :: option
1169 ;; - type :: symbol (nil, t)
1170 ;;
1171 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1172 ;; - category :: option
1173 ;; - type :: symbol (nil, t)
1174 ;;
1175 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1176 ;; inserted at the end of the transcoded string. If the value
1177 ;; is `comment', it should be commented.
1178 ;; - category :: option
1179 ;; - type :: symbol (`comment', nil, t)
1180 ;;
1181 ;; + `:with-date' :: Non-nil means output should contain a date.
1182 ;; - category :: option
1183 ;; - type :. symbol (nil, t)
1184 ;;
1185 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1186 ;; its value is a list of names, only drawers with such names
1187 ;; will be transcoded.
1188 ;; - category :: option
1189 ;; - type :: symbol (nil, t) or list of strings
1190 ;;
1191 ;; + `:with-email' :: Non-nil means output should contain author's
1192 ;; email.
1193 ;; - category :: option
1194 ;; - type :: symbol (nil, t)
1195 ;;
1196 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1197 ;; interpreted.
1198 ;; - category :: option
1199 ;; - type :: symbol (nil, t)
1200 ;;
1201 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1202 ;; strings starting with a colon as a fixed-with (verbatim) area.
1203 ;; - category :: option
1204 ;; - type :: symbol (nil, t)
1205 ;;
1206 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1207 ;; footnotes.
1208 ;; - category :: option
1209 ;; - type :: symbol (nil, t)
1210 ;;
1211 ;; + `:with-plannings' :: Non-nil means transcoding should include
1212 ;; planning info.
1213 ;; - category :: option
1214 ;; - type :: symbol (nil, t)
1215 ;;
1216 ;; + `:with-priority' :: Non-nil means transcoding should include
1217 ;; priority cookies.
1218 ;; - category :: option
1219 ;; - type :: symbol (nil, t)
1220 ;;
1221 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1222 ;; plain text.
1223 ;; - category :: option
1224 ;; - type :: symbol (nil, t)
1225 ;;
1226 ;; + `:with-special-strings' :: Non-nil means transcoding should
1227 ;; interpret special strings in plain text.
1228 ;; - category :: option
1229 ;; - type :: symbol (nil, t)
1230 ;;
1231 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1232 ;; interpret subscript and superscript. With a value of "{}",
1233 ;; only interpret those using curly brackets.
1234 ;; - category :: option
1235 ;; - type :: symbol (nil, {}, t)
1236 ;;
1237 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1238 ;; tables.
1239 ;; - category :: option
1240 ;; - type :: symbol (nil, t)
1241 ;;
1242 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1243 ;; headlines. A `not-in-toc' value will remove them from the
1244 ;; table of contents, if any, nonetheless.
1245 ;; - category :: option
1246 ;; - type :: symbol (nil, t, `not-in-toc')
1247 ;;
1248 ;; + `:with-tasks' :: Non-nil means transcoding should include
1249 ;; headlines with a TODO keyword. A `todo' value will only
1250 ;; include headlines with a todo type keyword while a `done'
1251 ;; value will do the contrary. If a list of strings is provided,
1252 ;; only tasks with keywords belonging to that list will be kept.
1253 ;; - category :: option
1254 ;; - type :: symbol (t, todo, done, nil) or list of strings
1255 ;;
1256 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1257 ;; time stamps. Special value `active' (resp. `inactive') ask to
1258 ;; export only active (resp. inactive) timestamps. Otherwise,
1259 ;; completely remove them.
1260 ;; - category :: option
1261 ;; - type :: symbol: (`active', `inactive', t, nil)
1262 ;;
1263 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1264 ;; added to the output. An integer value limits its depth.
1265 ;; - category :: option
1266 ;; - type :: symbol (nil, t or integer)
1267 ;;
1268 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1269 ;; include TODO keywords.
1270 ;; - category :: option
1271 ;; - type :: symbol (nil, t)
1274 ;;;; Environment Options
1275 ;;
1276 ;; Environment options encompass all parameters defined outside the
1277 ;; scope of the parsed data. They come from five sources, in
1278 ;; increasing precedence order:
1279 ;;
1280 ;; - Global variables,
1281 ;; - Buffer's attributes,
1282 ;; - Options keyword symbols,
1283 ;; - Buffer keywords,
1284 ;; - Subtree properties.
1285 ;;
1286 ;; The central internal function with regards to environment options
1287 ;; is `org-export-get-environment'. It updates global variables with
1288 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1289 ;; the different sources.
1290 ;;
1291 ;; The internal functions doing the retrieval are:
1292 ;; `org-export--get-global-options',
1293 ;; `org-export--get-buffer-attributes',
1294 ;; `org-export--parse-option-keyword',
1295 ;; `org-export--get-subtree-options' and
1296 ;; `org-export--get-inbuffer-options'
1297 ;;
1298 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1299 ;; take care of the part relative to "#+BIND:" keywords.
1302 "Collect export options from the current buffer.
1304 Optional argument BACKEND is a symbol specifying which back-end
1305 specific options to read, if any.
1307 When optional argument SUBTREEP is non-nil, assume the export is
1308 done against the current sub-tree.
1310 Third optional argument EXT-PLIST is a property list with
1311 external parameters overriding Org default settings, but still
1312 inferior to file-local settings."
1313 ;; First install #+BIND variables.
1315 ;; Get and prioritize export options...
1317 ;; ... from global variables...
1319 ;; ... from an external property list...
1320 ext-plist
1321 ;; ... from in-buffer settings...
1323 backend
1325 ;; ... and from subtree, when appropriate.
1327 ;; Eventually add misc. properties.
1329 :back-end
1330 backend
1331 :translate-alist
1333 :footnote-definition-alist
1334 ;; Footnotes definitions must be collected in the original
1335 ;; buffer, as there's no insurance that they will still be in
1336 ;; the parse tree, due to possible narrowing.
1350 alist))))
1351 alist))
1352 :id-alist
1353 ;; Collect id references.
1364 alist))))
1367 "Parse an OPTIONS line and return values as a plist.
1368 Optional argument BACKEND is a symbol specifying which back-end
1369 specific items to read, if any."
1372 ;; Build an alist between #+OPTION: item and property-name.
1377 all)))
1378 plist)
1383 options)
1388 alist)
1389 plist))
1392 "Get export options in subtree at point.
1393 Optional argument BACKEND is a symbol specifying back-end used
1394 for export. Return options as a plist."
1395 ;; For each buffer keyword, create an headline property setting the
1396 ;; same property in communication channel. The name for the property
1397 ;; is the keyword with "EXPORT_" appended to it.
1400 ;; Make sure point is at an heading.
1402 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1403 ;; title as its fallback value.
1409 plist :title
1412 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1416 ;; Handle other keywords. TITLE keyword is excluded as it has
1417 ;; been handled already.
1424 ;; Export properties are not case-sensitive.
1431 plist
1434 ;; Parse VALUE if required.
1438 ;; If BEHAVIOUR is `split' expected value is
1439 ;; a list of strings, not a string.
1442 ;; Also look for both general keywords and back-end specific
1443 ;; options if BACKEND is provided.
1445 org-export-options-alist)))
1446 ;; Return value.
1447 plist)))
1450 "Return current buffer export options, as a plist.
1452 Optional argument BACKEND, when non-nil, is a symbol specifying
1453 which back-end specific options should also be read in the
1454 process.
1456 Optional argument FILES is a list of setup files names read so
1457 far, used to avoid circular dependencies.
1459 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1463 ;; 1. Special keywords, as in `org-export-special-keywords'.
1477 ;; Avoid circular dependencies.
1492 ;; 2. Standard options, as in `org-export-options-alist'.
1494 ;; Also look for back-end specific options if
1495 ;; BACKEND is defined.
1497 ;; Build ALIST between keyword name and property name.
1501 all)))
1502 ;; Build regexp matching all keywords associated to export
1503 ;; options. Note: the search is case insensitive.
1517 plist prop
1518 ;; Handle value depending on specified BEHAVIOUR.
1531 ;; Parse keywords specified in
1532 ;; `org-element-document-properties'.
1540 plist prop
1543 org-element-document-properties))
1544 ;; 3. Return final value.
1545 plist)))
1548 "Return properties related to buffer attributes, as a plist."
1551 ;; Store full path of input file name, or nil. For internal use.
1552 :input-file visited-file
1559 "Return global export options as a plist.
1561 Optional argument BACKEND, if non-nil, is a symbol specifying
1562 which back-end specific export options should also be read in the
1563 process."
1566 ;; Output value.
1567 plist)
1572 plist
1574 ;; Eval default value provided. If keyword is a member
1575 ;; of `org-element-document-properties', parse it as
1576 ;; a secondary string before storing it.
1581 value
1584 all)
1585 ;; Return value.
1586 plist))
1590 "Can we use #+BIND values during export?
1591 By default this will ask for confirmation by the user, to divert
1592 possible security risks."
1597 org-export--allow-BIND-local)
1602 "Install the values from #+BIND lines as local variables.
1603 Variables must be installed before in-buffer options are
1604 retrieved."
1619 ;;;; Tree Properties
1620 ;;
1621 ;; Tree properties are information extracted from parse tree. They
1622 ;; are initialized at the beginning of the transcoding process by
1623 ;; `org-export-collect-tree-properties'.
1624 ;;
1625 ;; Dedicated functions focus on computing the value of specific tree
1626 ;; properties during initialization. Thus,
1627 ;; `org-export--populate-ignore-list' lists elements and objects that
1628 ;; should be skipped during export, `org-export--get-min-level' gets
1629 ;; the minimal exportable level, used as a basis to compute relative
1630 ;; level for headlines. Eventually
1631 ;; `org-export--collect-headline-numbering' builds an alist between
1632 ;; headlines and their numbering.
1635 "Extract tree properties from parse tree.
1637 DATA is the parse tree from which information is retrieved. INFO
1638 is a list holding export options.
1640 Following tree properties are set or updated:
1642 `:exported-data' Hash table used to memoize results from
1643 `org-export-data'.
1645 `:footnote-definition-alist' List of footnotes definitions in
1646 original buffer and current parse tree.
1648 `:headline-offset' Offset between true level of headlines and
1649 local level. An offset of -1 means an headline
1650 of level 2 should be considered as a level
1651 1 headline in the context.
1653 `:headline-numbering' Alist of all headlines as key an the
1654 associated numbering as value.
1656 `:ignore-list' List of elements that should be ignored during
1657 export.
1659 `:target-list' List of all targets in the parse tree.
1661 Return updated plist."
1662 ;; Install the parse tree in the communication channel, in order to
1663 ;; use `org-export-get-genealogy' and al.
1665 ;; Get the list of elements and objects to ignore, and put it into
1666 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1667 ;; been done during parse tree filtering.
1670 :ignore-list
1673 ;; Compute `:headline-offset' in order to be able to use
1674 ;; `org-export-get-relative-level'.
1677 :headline-offset
1679 ;; Update footnotes definitions list with definitions in parse tree.
1680 ;; This is required since buffer expansion might have modified
1681 ;; boundaries of footnote definitions contained in the parse tree.
1682 ;; This way, definitions in `footnote-definition-alist' are bound to
1683 ;; match those in the parse tree.
1686 data 'footnote-definition
1690 defs)))
1692 ;; Properties order doesn't matter: get the rest of the tree
1693 ;; properties.
1695 `(:target-list
1704 info))
1707 "Return minimum exportable headline's level in DATA.
1708 DATA is parsed tree as returned by `org-element-parse-buffer'.
1709 OPTIONS is a plist holding export options."
1720 ;; If no headline was found, for the sake of consistency, set
1721 ;; minimum level to 1 nonetheless.
1725 "Return numbering of all exportable headlines in a parse tree.
1727 DATA is the parse tree. OPTIONS is the plist holding export
1728 options.
1730 Return an alist whose key is an headline and value is its
1731 associated numbering \(in the shape of a list of numbers\)."
1734 data
1735 'headline
1740 headline
1742 for idx from 0 to org-export-max-depth
1746 options)))
1749 "Return list of elements and objects to ignore during export.
1750 DATA is the parse tree to traverse. OPTIONS is the plist holding
1751 export options."
1753 walk-data
1754 ;; First find trees containing a select tag, if any.
1758 ;; Collect ignored elements or objects into IGNORE-LIST.
1764 ;; If headline is archived but tree below has
1765 ;; to be skipped, add it to ignore list.
1768 ;; Move into secondary string, if any.
1773 ;; Move into recursive objects/elements.
1775 ;; Main call.
1777 ;; Return value.
1778 ignore))
1781 "Return list of headlines containing a select tag in their tree.
1782 DATA is parsed data as returned by `org-element-parse-buffer'.
1783 INFO is a plist holding export options."
1785 walk-data ; for byte-compiler.
1796 ;; When a select tag is found, mark full
1797 ;; genealogy and every headline within the tree
1798 ;; as acceptable.
1801 genealogy
1803 selected-trees))
1804 ;; Else, continue searching in tree, recursively.
1811 "Non-nil when element or object BLOB should be skipped during export.
1812 OPTIONS is the plist holding export options. SELECTED, when
1813 non-nil, is a list of headlines belonging to a tree with a select
1814 tag."
1829 ;; Ignore subtrees with an exclude tag.
1832 ;; When a select tag is present in the buffer, ignore any tree
1833 ;; without it.
1835 ;; Ignore commented sub-trees.
1837 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1839 ;; Ignore tasks, if specified by `:with-tasks' property.
1855 ;; No timestamp allowed.
1857 ;; Only active timestamps allowed and the current one isn't
1858 ;; active.
1862 ;; Only inactive timestamps allowed and the current one isn't
1863 ;; inactive.
1869 \f
1870 ;;; The Transcoder
1871 ;;
1872 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1873 ;; `org-element-parse-buffer') and transcodes it into a specified
1874 ;; back-end output. It takes care of filtering out elements or
1875 ;; objects according to export options and organizing the output blank
1876 ;; lines and white space are preserved. The function memoizes its
1877 ;; results, so it is cheap to call it within translators.
1878 ;;
1879 ;; Internally, three functions handle the filtering of objects and
1880 ;; elements during the export. In particular,
1881 ;; `org-export-ignore-element' marks an element or object so future
1882 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1883 ;; elements or objects should be seen as real Org syntax and
1884 ;; `org-export-expand' transforms the others back into their original
1885 ;; shape
1886 ;;
1887 ;; `org-export-transcoder' is an accessor returning appropriate
1888 ;; translator function for a given element or object.
1891 "Return appropriate transcoder for BLOB.
1892 INFO is a plist containing export directives."
1894 ;; Return contents only for complete parse trees.
1900 "Convert DATA into current back-end format.
1902 DATA is a parse tree, an element or an object or a secondary
1903 string. INFO is a plist holding export options.
1905 Return transcoded string."
1911 ;; Ignored element/object.
1913 ;; Plain text. All residual text properties from parse
1914 ;; tree (i.e. `:parent' property) are removed.
1921 info)))
1922 ;; Uninterpreted element/object: change it back to Org
1923 ;; syntax and export again resulting raw string.
1927 data
1931 info))
1932 ;; Secondary string.
1935 ;; Element/Object without contents or, as a special case,
1936 ;; headline with archive tag and archived trees restricted
1937 ;; to title only.
1945 ;; Element/Object with contents.
1958 ;; Elements directly containing objects
1959 ;; must have their indentation normalized
1960 ;; first.
1962 data
1963 ;; When normalizing contents of the first
1964 ;; paragraph in an item or a footnote
1965 ;; definition, ignore first line's
1966 ;; indentation: there is none and it
1967 ;; might be misleading.
1972 data)
1979 info))))))))
1980 ;; Final result will be memoized before being returned.
1982 data
1986 ;; Append the same white space between elements or objects as in
1987 ;; the original buffer, and call appropriate filters.
1998 info)))
1999 results)))
2003 "Non-nil if element or object BLOB should be interpreted as Org syntax.
2004 Check is done according to export options INFO, stored as
2005 a plist."
2007 ;; ... entities...
2009 ;; ... emphasis...
2012 ;; ... fixed-width areas.
2014 ;; ... footnotes...
2017 ;; ... sub/superscripts...
2023 ;; ... tables...
2028 "Expand a parsed element or object to its original state.
2029 BLOB is either an element or an object. CONTENTS is its
2030 contents, as a string or nil."
2033 blob contents))
2036 "Add ELEMENT to `:ignore-list' in INFO.
2038 Any element in `:ignore-list' will be skipped when using
2039 `org-element-map'. INFO is modified by side effects."
2043 \f
2044 ;;; The Filter System
2045 ;;
2046 ;; Filters allow end-users to tweak easily the transcoded output.
2047 ;; They are the functional counterpart of hooks, as every filter in
2048 ;; a set is applied to the return value of the previous one.
2049 ;;
2050 ;; Every set is back-end agnostic. Although, a filter is always
2051 ;; called, in addition to the string it applies to, with the back-end
2052 ;; used as argument, so it's easy for the end-user to add back-end
2053 ;; specific filters in the set. The communication channel, as
2054 ;; a plist, is required as the third argument.
2055 ;;
2056 ;; From the developer side, filters sets can be installed in the
2057 ;; process with the help of `org-export-define-backend', which
2058 ;; internally stores filters as an alist. Each association has a key
2059 ;; among the following symbols and a function or a list of functions
2060 ;; as value.
2061 ;;
2062 ;; - `:filter-parse-tree' applies directly on the complete parsed
2063 ;; tree. It's the only filters set that doesn't apply to a string.
2064 ;; Users can set it through `org-export-filter-parse-tree-functions'
2065 ;; variable.
2066 ;;
2067 ;; - `:filter-final-output' applies to the final transcoded string.
2068 ;; Users can set it with `org-export-filter-final-output-functions'
2069 ;; variable
2070 ;;
2071 ;; - `:filter-plain-text' applies to any string not recognized as Org
2072 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2073 ;; configure it.
2074 ;;
2075 ;; - `:filter-TYPE' applies on the string returned after an element or
2076 ;; object of type TYPE has been transcoded. An user can modify
2077 ;; `org-export-filter-TYPE-functions'
2078 ;;
2079 ;; All filters sets are applied with
2080 ;; `org-export-filter-apply-functions' function. Filters in a set are
2081 ;; applied in a LIFO fashion. It allows developers to be sure that
2082 ;; their filters will be applied first.
2083 ;;
2084 ;; Filters properties are installed in communication channel with
2085 ;; `org-export-install-filters' function.
2086 ;;
2087 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2088 ;; `org-export-before-parsing-hook') are run at the beginning of the
2089 ;; export process and just before parsing to allow for heavy structure
2090 ;; modifications.
2093 ;;;; Hooks
2096 "Hook run at the beginning of the export process.
2098 This is run before include keywords and macros are expanded and
2099 Babel code blocks executed, on a copy of the original buffer
2100 being exported. Visibility and narrowing are preserved. Point
2101 is at the beginning of the buffer.
2103 Every function in this hook will be called with one argument: the
2107 "Hook run before parsing an export buffer.
2109 This is run after include keywords and macros have been expanded
2110 and Babel code blocks executed, on a copy of the original buffer
2111 being exported. Visibility and narrowing are preserved. Point
2112 is at the beginning of the buffer.
2114 Every function in this hook will be called with one argument: the
2118 ;;;; Special Filters
2121 "List of functions applied to the parsed tree.
2122 Each filter is called with three arguments: the parse tree, as
2123 returned by `org-element-parse-buffer', the back-end, as
2124 a symbol, and the communication channel, as a plist. It must
2128 "List of functions applied to the transcoded string.
2129 Each filter is called with three arguments: the full transcoded
2130 string, the back-end, as a symbol, and the communication channel,
2131 as a plist. It must return a string that will be used as the
2135 "List of functions applied to plain text.
2136 Each filter is called with three arguments: a string which
2137 contains no Org syntax, the back-end, as a symbol, and the
2138 communication channel, as a plist. It must return a string or
2142 ;;;; Elements Filters
2145 "List of functions applied to a transcoded babel-call.
2146 Each filter is called with three arguments: the transcoded data,
2147 as a string, the back-end, as a symbol, and the communication
2151 "List of functions applied to a transcoded center block.
2152 Each filter is called with three arguments: the transcoded data,
2153 as a string, the back-end, as a symbol, and the communication
2157 "List of functions applied to a transcoded clock.
2158 Each filter is called with three arguments: the transcoded data,
2159 as a string, the back-end, as a symbol, and the communication
2163 "List of functions applied to a transcoded comment.
2164 Each filter is called with three arguments: the transcoded data,
2165 as a string, the back-end, as a symbol, and the communication
2169 "List of functions applied to a transcoded comment-block.
2170 Each filter is called with three arguments: the transcoded data,
2171 as a string, the back-end, as a symbol, and the communication
2175 "List of functions applied to a transcoded diary-sexp.
2176 Each filter is called with three arguments: the transcoded data,
2177 as a string, the back-end, as a symbol, and the communication
2181 "List of functions applied to a transcoded drawer.
2182 Each filter is called with three arguments: the transcoded data,
2183 as a string, the back-end, as a symbol, and the communication
2187 "List of functions applied to a transcoded dynamic-block.
2188 Each filter is called with three arguments: the transcoded data,
2189 as a string, the back-end, as a symbol, and the communication
2193 "List of functions applied to a transcoded example-block.
2194 Each filter is called with three arguments: the transcoded data,
2195 as a string, the back-end, as a symbol, and the communication
2199 "List of functions applied to a transcoded export-block.
2200 Each filter is called with three arguments: the transcoded data,
2201 as a string, the back-end, as a symbol, and the communication
2205 "List of functions applied to a transcoded fixed-width.
2206 Each filter is called with three arguments: the transcoded data,
2207 as a string, the back-end, as a symbol, and the communication
2211 "List of functions applied to a transcoded footnote-definition.
2212 Each filter is called with three arguments: the transcoded data,
2213 as a string, the back-end, as a symbol, and the communication
2217 "List of functions applied to a transcoded headline.
2218 Each filter is called with three arguments: the transcoded data,
2219 as a string, the back-end, as a symbol, and the communication
2223 "List of functions applied to a transcoded horizontal-rule.
2224 Each filter is called with three arguments: the transcoded data,
2225 as a string, the back-end, as a symbol, and the communication
2229 "List of functions applied to a transcoded inlinetask.
2230 Each filter is called with three arguments: the transcoded data,
2231 as a string, the back-end, as a symbol, and the communication
2235 "List of functions applied to a transcoded item.
2236 Each filter is called with three arguments: the transcoded data,
2237 as a string, the back-end, as a symbol, and the communication
2241 "List of functions applied to a transcoded keyword.
2242 Each filter is called with three arguments: the transcoded data,
2243 as a string, the back-end, as a symbol, and the communication
2247 "List of functions applied to a transcoded latex-environment.
2248 Each filter is called with three arguments: the transcoded data,
2249 as a string, the back-end, as a symbol, and the communication
2253 "List of functions applied to a transcoded node-property.
2254 Each filter is called with three arguments: the transcoded data,
2255 as a string, the back-end, as a symbol, and the communication
2259 "List of functions applied to a transcoded paragraph.
2260 Each filter is called with three arguments: the transcoded data,
2261 as a string, the back-end, as a symbol, and the communication
2265 "List of functions applied to a transcoded plain-list.
2266 Each filter is called with three arguments: the transcoded data,
2267 as a string, the back-end, as a symbol, and the communication
2271 "List of functions applied to a transcoded planning.
2272 Each filter is called with three arguments: the transcoded data,
2273 as a string, the back-end, as a symbol, and the communication
2277 "List of functions applied to a transcoded property-drawer.
2278 Each filter is called with three arguments: the transcoded data,
2279 as a string, the back-end, as a symbol, and the communication
2283 "List of functions applied to a transcoded quote block.
2284 Each filter is called with three arguments: the transcoded quote
2285 data, as a string, the back-end, as a symbol, and the
2286 communication channel, as a plist. It must return a string or
2290 "List of functions applied to a transcoded quote-section.
2291 Each filter is called with three arguments: the transcoded data,
2292 as a string, the back-end, as a symbol, and the communication
2296 "List of functions applied to a transcoded section.
2297 Each filter is called with three arguments: the transcoded data,
2298 as a string, the back-end, as a symbol, and the communication
2302 "List of functions applied to a transcoded special block.
2303 Each filter is called with three arguments: the transcoded data,
2304 as a string, the back-end, as a symbol, and the communication
2308 "List of functions applied to a transcoded src-block.
2309 Each filter is called with three arguments: the transcoded data,
2310 as a string, the back-end, as a symbol, and the communication
2314 "List of functions applied to a transcoded table.
2315 Each filter is called with three arguments: the transcoded data,
2316 as a string, the back-end, as a symbol, and the communication
2320 "List of functions applied to a transcoded table-cell.
2321 Each filter is called with three arguments: the transcoded data,
2322 as a string, the back-end, as a symbol, and the communication
2326 "List of functions applied to a transcoded table-row.
2327 Each filter is called with three arguments: the transcoded data,
2328 as a string, the back-end, as a symbol, and the communication
2332 "List of functions applied to a transcoded verse block.
2333 Each filter is called with three arguments: the transcoded data,
2334 as a string, the back-end, as a symbol, and the communication
2338 ;;;; Objects Filters
2341 "List of functions applied to transcoded bold text.
2342 Each filter is called with three arguments: the transcoded data,
2343 as a string, the back-end, as a symbol, and the communication
2347 "List of functions applied to transcoded code text.
2348 Each filter is called with three arguments: the transcoded data,
2349 as a string, the back-end, as a symbol, and the communication
2353 "List of functions applied to a transcoded entity.
2354 Each filter is called with three arguments: the transcoded data,
2355 as a string, the back-end, as a symbol, and the communication
2359 "List of functions applied to a transcoded export-snippet.
2360 Each filter is called with three arguments: the transcoded data,
2361 as a string, the back-end, as a symbol, and the communication
2365 "List of functions applied to a transcoded footnote-reference.
2366 Each filter is called with three arguments: the transcoded data,
2367 as a string, the back-end, as a symbol, and the communication
2371 "List of functions applied to a transcoded inline-babel-call.
2372 Each filter is called with three arguments: the transcoded data,
2373 as a string, the back-end, as a symbol, and the communication
2377 "List of functions applied to a transcoded inline-src-block.
2378 Each filter is called with three arguments: the transcoded data,
2379 as a string, the back-end, as a symbol, and the communication
2383 "List of functions applied to transcoded italic text.
2384 Each filter is called with three arguments: the transcoded data,
2385 as a string, the back-end, as a symbol, and the communication
2389 "List of functions applied to a transcoded latex-fragment.
2390 Each filter is called with three arguments: the transcoded data,
2391 as a string, the back-end, as a symbol, and the communication
2395 "List of functions applied to a transcoded line-break.
2396 Each filter is called with three arguments: the transcoded data,
2397 as a string, the back-end, as a symbol, and the communication
2401 "List of functions applied to a transcoded link.
2402 Each filter is called with three arguments: the transcoded data,
2403 as a string, the back-end, as a symbol, and the communication
2407 "List of functions applied to a transcoded macro.
2408 Each filter is called with three arguments: the transcoded data,
2409 as a string, the back-end, as a symbol, and the communication
2413 "List of functions applied to a transcoded radio-target.
2414 Each filter is called with three arguments: the transcoded data,
2415 as a string, the back-end, as a symbol, and the communication
2419 "List of functions applied to a transcoded statistics-cookie.
2420 Each filter is called with three arguments: the transcoded data,
2421 as a string, the back-end, as a symbol, and the communication
2425 "List of functions applied to transcoded strike-through text.
2426 Each filter is called with three arguments: the transcoded data,
2427 as a string, the back-end, as a symbol, and the communication
2431 "List of functions applied to a transcoded subscript.
2432 Each filter is called with three arguments: the transcoded data,
2433 as a string, the back-end, as a symbol, and the communication
2437 "List of functions applied to a transcoded superscript.
2438 Each filter is called with three arguments: the transcoded data,
2439 as a string, the back-end, as a symbol, and the communication
2443 "List of functions applied to a transcoded target.
2444 Each filter is called with three arguments: the transcoded data,
2445 as a string, the back-end, as a symbol, and the communication
2449 "List of functions applied to a transcoded timestamp.
2450 Each filter is called with three arguments: the transcoded data,
2451 as a string, the back-end, as a symbol, and the communication
2455 "List of functions applied to transcoded underline text.
2456 Each filter is called with three arguments: the transcoded data,
2457 as a string, the back-end, as a symbol, and the communication
2461 "List of functions applied to transcoded verbatim text.
2462 Each filter is called with three arguments: the transcoded data,
2463 as a string, the back-end, as a symbol, and the communication
2467 ;;;; Filters Tools
2468 ;;
2469 ;; Internal function `org-export-install-filters' installs filters
2470 ;; hard-coded in back-ends (developer filters) and filters from global
2471 ;; variables (user filters) in the communication channel.
2472 ;;
2473 ;; Internal function `org-export-filter-apply-functions' takes care
2474 ;; about applying each filter in order to a given data. It ignores
2475 ;; filters returning a nil value but stops whenever a filter returns
2476 ;; an empty string.
2479 "Call every function in FILTERS.
2481 Functions are called with arguments VALUE, current export
2482 back-end and INFO. A function returning a nil value will be
2483 skipped. If it returns the empty string, the process ends and
2484 VALUE is ignored.
2486 Call is done in a LIFO fashion, to be sure that developer
2487 specified filters, if any, are called first."
2496 "Install filters properties in communication channel.
2498 INFO is a plist containing the current communication channel.
2500 Return the updated communication channel."
2502 ;; Install user defined filters with `org-export-filters-alist'.
2505 org-export-filters-alist)
2506 ;; Prepend back-end specific filters to that list.
2508 ;; Single values get consed, lists are prepended.
2513 plist key
2517 ;; Return new communication channel.
2521 \f
2522 ;;; Core functions
2523 ;;
2524 ;; This is the room for the main function, `org-export-as', along with
2525 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2526 ;; They differ only by the way they output the resulting code.
2527 ;;
2528 ;; `org-export-output-file-name' is an auxiliary function meant to be
2529 ;; used with `org-export-to-file'. With a given extension, it tries
2530 ;; to provide a canonical file name to write export output to.
2531 ;;
2532 ;; Note that `org-export-as' doesn't really parse the current buffer,
2533 ;; but a copy of it (with the same buffer-local variables and
2534 ;; visibility), where macros and include keywords are expanded and
2535 ;; Babel blocks are executed, if appropriate.
2536 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2537 ;;
2538 ;; File inclusion is taken care of by
2539 ;; `org-export-expand-include-keyword' and
2540 ;; `org-export--prepare-file-contents'. Structure wise, including
2541 ;; a whole Org file in a buffer often makes little sense. For
2542 ;; example, if the file contains an headline and the include keyword
2543 ;; was within an item, the item should contain the headline. That's
2544 ;; why file inclusion should be done before any structure can be
2545 ;; associated to the file, that is before parsing.
2549 "Transcode current Org buffer into BACKEND code.
2551 If narrowing is active in the current buffer, only transcode its
2552 narrowed part.
2554 If a region is active, transcode that region.
2556 When optional argument SUBTREEP is non-nil, transcode the
2557 sub-tree at point, extracting information from the headline
2558 properties first.
2560 When optional argument VISIBLE-ONLY is non-nil, don't export
2561 contents of hidden elements.
2563 When optional argument BODY-ONLY is non-nil, only return body
2564 code, without preamble nor postamble.
2566 Optional argument EXT-PLIST, when provided, is a property list
2567 with external parameters overriding Org default settings, but
2568 still inferior to file-local settings.
2570 Optional argument NOEXPAND, when non-nil, prevents included files
2571 to be expanded and Babel code to be executed.
2573 Return code as a string."
2574 ;; Barf if BACKEND isn't registered.
2578 ;; Narrow buffer to an appropriate region or subtree for
2579 ;; parsing. If parsing subtree, be sure to remove main headline
2580 ;; too.
2588 ;; Initialize communication channel with original buffer
2589 ;; attributes, unavailable in its copy.
2592 ;; Run first hook with current back-end as argument.
2594 ;; Update communication channel and get parse tree. Buffer
2595 ;; isn't parsed directly. Instead, a temporary copy is
2596 ;; created, where include keywords, macros are expanded and
2597 ;; code blocks are evaluated.
2600 ;; Update macro templates since #+INCLUDE keywords might
2601 ;; have added some new ones.
2605 ;; Update radio targets since keyword inclusion might have
2606 ;; added some more.
2608 ;; Run last hook with current back-end as argument.
2611 ;; Update communication channel with environment. Also
2612 ;; install user's and developer's filters.
2617 ;; Expand export-specific set of macros: {{{author}}},
2618 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2619 ;; once regular macros have been expanded, since document
2620 ;; keywords may contain one of them.
2627 ;; EMAIL is not a parsed keyword: store it as-is.
2631 ;; Eventually parse buffer. Call parse-tree filters to get
2632 ;; the final tree.
2637 ;; Now tree is complete, compute its properties and add them
2638 ;; to communication channel.
2642 ;; Eventually transcode TREE. Wrap the resulting string into
2643 ;; a template, if required. Finally call final-output filter.
2652 info)))
2653 ;; Maybe add final OUTPUT to kill ring, then return it.
2656 output)))))
2660 "Call `org-export-as' with output to a specified buffer.
2662 BACKEND is the back-end used for transcoding, as a symbol.
2664 BUFFER is the output buffer. If it already exists, it will be
2665 erased first, otherwise, it will be created.
2667 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2668 and NOEXPAND are similar to those used in `org-export-as', which
2669 see.
2671 Return buffer."
2673 backend subtreep visible-only body-only ext-plist noexpand))
2679 buffer))
2683 "Call `org-export-as' with output to a specified file.
2685 BACKEND is the back-end used for transcoding, as a symbol. FILE
2686 is the name of the output file, as a string.
2688 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2689 and NOEXPAND are similar to those used in `org-export-as', which
2690 see.
2692 Return output file's name."
2693 ;; Checks for FILE permissions. `write-file' would do the same, but
2694 ;; we'd rather avoid needless transcoding of parse tree.
2696 ;; Insert contents to a temporary buffer and write it to FILE.
2698 backend subtreep visible-only body-only ext-plist noexpand)))
2703 ;; Return full path.
2704 file)
2707 "Return output file's name according to buffer specifications.
2709 EXTENSION is a string representing the output file extension,
2710 with the leading dot.
2712 With a non-nil optional argument SUBTREEP, try to determine
2714 of subtree at point.
2716 When optional argument PUB-DIR is set, use it as the publishing
2717 directory.
2719 When optional argument VISIBLE-ONLY is non-nil, don't export
2720 contents of hidden elements.
2722 Return file name as a string, or nil if it couldn't be
2723 determined."
2725 ;; File name may come from EXPORT_FILE_NAME subtree property,
2726 ;; assuming point is at beginning of said sub-tree.
2733 ;; File name may be extracted from buffer's associated
2734 ;; file, if any.
2737 ;; Can't determine file name on our own: Ask user.
2741 "Output file: " pub-dir nil nil nil
2744 ;; Build file name. Enforce EXTENSION over whatever user may have
2745 ;; come up with. PUB-DIR, if defined, always has precedence over
2746 ;; any provided path.
2751 extension))
2756 "Apply BODY in a copy of the current buffer.
2758 The copy preserves local variables and visibility of the original
2759 buffer.
2761 Point is at buffer's beginning when BODY is applied."
2771 ,original-buffer
2783 "Expand every include keyword in buffer.
2784 Optional argument INCLUDED is a list of included file names along
2785 with their line restriction, when appropriate. It is used to
2786 avoid infinite recursion. Optional argument DIR is the current
2787 working directory. It is used to properly resolve relative
2788 paths."
2795 ;; Extract arguments from keyword's value.
2809 ;; Minimal level of included file defaults to the child
2810 ;; level of the current headline, if any, or one. It
2811 ;; only applies is the file is meant to be included as
2812 ;; an Org one.
2820 ;; Remove keyword.
2825 ;; Check if files has already been parsed. Look after
2826 ;; inclusion lines too, as different parts of the same file
2827 ;; can be included too.
2839 ind-str contents ind-str))))
2847 ind-str env contents ind-str))))
2860 "Prepare the contents of FILE for inclusion and return them as a string.
2862 When optional argument LINES is a string specifying a range of
2863 lines, include only those lines.
2865 Optional argument IND, when non-nil, is an integer specifying the
2866 global indentation of returned contents. Since its purpose is to
2867 allow an included file to stay in the same environment it was
2868 created \(i.e. a list item), it doesn't apply past the first
2869 headline encountered.
2871 Optional argument MINLEVEL, when non-nil, is an integer
2872 specifying the level that any top-level headline in the included
2873 file should have."
2889 ;; Remove blank lines at beginning and end of contents. The logic
2890 ;; behind that removal is that blank lines around include keyword
2891 ;; override blank lines in included file.
2900 ;; If IND is set, preserve indentation of include keyword until
2901 ;; the first headline encountered.
2907 ;; Do not move footnote definitions out of column 0.
2913 ;; When MINLEVEL is specified, compute minimal level for headlines
2914 ;; in the file (CUR-MIN), and remove stars to each headline so
2915 ;; that headlines with minimal level have a level of MINLEVEL.
2925 ;; Only change stars, don't bother moving whole
2926 ;; sections.
2933 "Execute every Babel code in the visible part of current buffer.
2934 This function will return an error if the current buffer is
2935 visiting a file."
2936 ;; Get a pristine copy of current buffer so Babel references can be
2937 ;; properly resolved.
2944 \f
2945 ;;; Tools For Back-Ends
2946 ;;
2947 ;; A whole set of tools is available to help build new exporters. Any
2948 ;; function general enough to have its use across many back-ends
2949 ;; should be added here.
2951 ;;;; For Affiliated Keywords
2952 ;;
2953 ;; `org-export-read-attribute' reads a property from a given element
2954 ;; as a plist. It can be used to normalize affiliated keywords'
2955 ;; syntax.
2956 ;;
2957 ;; Since captions can span over multiple lines and accept dual values,
2958 ;; their internal representation is a bit tricky. Therefore,
2959 ;; `org-export-get-caption' transparently returns a given element's
2960 ;; caption as a secondary string.
2963 "Turn ATTRIBUTE property from ELEMENT into a plist.
2965 When optional argument PROPERTY is non-nil, return the value of
2966 that property within attributes.
2970 properties."
2978 "Return caption from ELEMENT as a secondary string.
2980 When optional argument SHORTP is non-nil, return short caption,
2981 as a secondary string, instead.
2983 Caption lines are separated by a white space."
2991 ;;;; For Derived Back-ends
2992 ;;
2993 ;; `org-export-with-backend' is a function allowing to locally use
2994 ;; another back-end to transcode some object or element. In a derived
2995 ;; back-end, it may be used as a fall-back function once all specific
2996 ;; cases have been treated.
2999 "Call a transcoder from BACK-END on DATA.
3000 CONTENTS, when non-nil, is the transcoded contents of DATA
3001 element, as a string. INFO, when non-nil, is the communication
3002 channel used for export, as a plist.."
3012 ;;;; For Export Snippets
3013 ;;
3014 ;; Every export snippet is transmitted to the back-end. Though, the
3015 ;; latter will only retain one type of export-snippet, ignoring
3016 ;; others, based on the former's target back-end. The function
3017 ;; `org-export-snippet-backend' returns that back-end for a given
3018 ;; export-snippet.
3021 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3022 Translation, with `org-export-snippet-translation-alist', is
3023 applied."
3027 back-end))))
3030 ;;;; For Footnotes
3031 ;;
3032 ;; `org-export-collect-footnote-definitions' is a tool to list
3033 ;; actually used footnotes definitions in the whole parse tree, or in
3034 ;; an headline, in order to add footnote listings throughout the
3035 ;; transcoded data.
3036 ;;
3037 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3038 ;; back-ends, when they need to attach the footnote definition only to
3039 ;; the first occurrence of the corresponding label.
3040 ;;
3041 ;; `org-export-get-footnote-definition' and
3042 ;; `org-export-get-footnote-number' provide easier access to
3043 ;; additional information relative to a footnote reference.
3046 "Return an alist between footnote numbers, labels and definitions.
3048 DATA is the parse tree from which definitions are collected.
3049 INFO is the plist used as a communication channel.
3051 Definitions are sorted by order of references. They either
3052 appear as Org data or as a secondary string for inlined
3053 footnotes. Unreferenced definitions are ignored."
3055 collect-fn ; for byte-compiler.
3059 ;; Collect footnote number, label and definition in DATA.
3061 data 'footnote-reference
3068 def)
3069 num-alist)
3070 ;; Also search in definition for nested footnotes.
3073 ;; Don't enter footnote definitions since it will happen
3074 ;; when their first reference is found.
3080 "Non-nil when a footnote reference is the first one for its label.
3082 FOOTNOTE-REFERENCE is the footnote reference being considered.
3083 INFO is the plist used as a communication channel."
3085 ;; Anonymous footnotes are always a first reference.
3087 ;; Otherwise, return the first footnote with the same LABEL and
3088 ;; test if it is equal to FOOTNOTE-REFERENCE.
3094 data 'footnote-reference
3099 ;; If FN isn't inlined, be sure to traverse its
3100 ;; definition before resuming search. See
3101 ;; comments in `org-export-get-footnote-number'
3102 ;; for more information.
3106 ;; Don't enter footnote definitions since it will
3107 ;; happen when their first reference is found.
3110 footnote-reference)))))
3113 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3114 INFO is the plist used as a communication channel."
3120 "Return number associated to a footnote.
3122 FOOTNOTE is either a footnote reference or a footnote definition.
3123 INFO is the plist used as a communication channel."
3125 seen-refs
3126 search-ref ; For byte-compiler.
3130 ;; Search footnote references through DATA, filling
3131 ;; SEEN-REFS along the way.
3133 data 'footnote-reference
3137 ;; Anonymous footnote match: return number.
3140 ;; Labels match: return number.
3143 ;; Anonymous footnote: it's always a new one. Also,
3144 ;; be sure to return nil from the `cond' so
3145 ;; `first-match' doesn't get us out of the loop.
3147 ;; Label not seen so far: add it so SEEN-REFS.
3148 ;;
3149 ;; Also search for subsequent references in
3150 ;; footnote definition so numbering follows reading
3151 ;; logic. Note that we don't have to care about
3152 ;; inline definitions, since `org-element-map'
3153 ;; already traverses them at the right time.
3154 ;;
3155 ;; Once again, return nil to stay in the loop.
3160 nil))))
3161 ;; Don't enter footnote definitions since it will happen
3162 ;; when their first reference is found.
3167 ;;;; For Headlines
3168 ;;
3169 ;; `org-export-get-relative-level' is a shortcut to get headline
3170 ;; level, relatively to the lower headline level in the parsed tree.
3171 ;;
3172 ;; `org-export-get-headline-number' returns the section number of an
3173 ;; headline, while `org-export-number-to-roman' allows to convert it
3174 ;; to roman numbers.
3175 ;;
3176 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3177 ;; `org-export-last-sibling-p' are three useful predicates when it
3178 ;; comes to fulfill the `:headline-levels' property.
3179 ;;
3180 ;; `org-export-get-tags', `org-export-get-category' and
3181 ;; `org-export-get-node-property' extract useful information from an
3182 ;; headline or a parent headline. They all handle inheritance.
3185 "Return HEADLINE relative level within current parsed tree.
3186 INFO is a plist holding contextual information."
3191 "Non-nil when HEADLINE is considered as low level.
3193 INFO is a plist used as a communication channel.
3195 A low level headlines has a relative level greater than
3196 `:headline-levels' property value.
3198 Return value is the difference between HEADLINE relative level
3199 and the last level being considered as high enough, or nil."
3206 "Return HEADLINE numbering as a list of numbers.
3207 INFO is a plist holding contextual information."
3211 "Return a non-nil value if HEADLINE element should be numbered.
3212 INFO is a plist used as a communication channel."
3218 "Convert integer N into a roman numeral."
3231 res)))
3234 "Return list of tags associated to ELEMENT.
3236 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3237 is a plist used as a communication channel.
3239 Select tags (see `org-export-select-tags') and exclude tags (see
3240 `org-export-exclude-tags') are removed from the list.
3242 When non-nil, optional argument TAGS should be a list of strings.
3243 Any tag belonging to this list will also be removed.
3245 When optional argument INHERITED is non-nil, tags can also be
3246 inherited from parent headlines and FILETAGS keywords."
3252 ;; Build complete list of inherited tags.
3263 ;; Add FILETAGS keywords and return results.
3267 "Return node PROPERTY value for BLOB.
3269 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3270 element or object.
3272 If optional argument INHERITED is non-nil, the value can be
3273 inherited from a parent headline.
3275 Return value is a string or nil."
3287 "Return category for element or object BLOB.
3289 INFO is a plist used as a communication channel.
3291 CATEGORY is automatically inherited from a parent headline, from
3292 #+CATEGORY: keyword or created out of original file name. If all
3296 ;; Almost like `org-export-node-property', but we cannot trust
3297 ;; `plist-member' as every headline has a `:category'
3298 ;; property, would it be nil or equal to "???" (which has the
3299 ;; same meaning).
3318 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3319 INFO is a plist used as a communication channel."
3324 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3325 INFO is a plist used as a communication channel."
3329 ;;;; For Links
3330 ;;
3331 ;; `org-export-solidify-link-text' turns a string into a safer version
3332 ;; for links, replacing most non-standard characters with hyphens.
3333 ;;
3334 ;; `org-export-get-coderef-format' returns an appropriate format
3335 ;; string for coderefs.
3336 ;;
3337 ;; `org-export-inline-image-p' returns a non-nil value when the link
3338 ;; provided should be considered as an inline image.
3339 ;;
3340 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3341 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3342 ;; returns an appropriate unique identifier when found, or nil.
3343 ;;
3344 ;; `org-export-resolve-id-link' returns the first headline with
3345 ;; specified id or custom-id in parse tree, the path to the external
3346 ;; file with the id or nil when neither was found.
3347 ;;
3348 ;; `org-export-resolve-coderef' associates a reference to a line
3349 ;; number in the element it belongs, or returns the reference itself
3350 ;; when the element isn't numbered.
3353 "Take link text S and make a safe target out of it."
3358 "Return format string for code reference link.
3359 PATH is the link path. DESC is its description."
3367 "Non-nil if LINK object points to an inline image.
3369 Optional argument is a set of RULES defining inline images. It
3370 is an alist where associations have the following shape:
3372 \(TYPE . REGEXP)
3374 Applying a rule means apply REGEXP against LINK's path when its
3375 type is TYPE. The function will return a non-nil value if any of
3376 the provided rules is non-nil. The default rule is
3377 `org-export-default-inline-image-rule'.
3379 This only applies to links without a description."
3390 rules)
3391 ;; Return nil if no rule matched.
3392 nil))))
3395 "Resolve a code reference REF.
3397 INFO is a plist used as a communication channel.
3399 Return associated line number in source code, or REF itself,
3400 depending on src-block or example element's switches."
3408 org-coderef-label-format)))
3412 ;; Element containing REF is found. Resolve it to either
3413 ;; a label or a line number, as needed.
3423 "Return LINK destination.
3425 INFO is a plist holding contextual information.
3427 Return value can be an object, an element, or nil:
3429 - If LINK path matches a target object (i.e. <<path>>) or
3432 - If LINK path exactly matches the name affiliated keyword
3433 \(i.e. #+NAME: path) of an element, return that element.
3435 - If LINK path exactly matches any headline name, return that
3436 element. If more than one headline share that name, priority
3437 will be given to the one with the closest common ancestor, if
3438 any, or the first one in the parse tree otherwise.
3440 - Otherwise, return nil.
3446 ;; First try to find a matching "<<path>>" unless user specified
3447 ;; he was looking for an headline (path starts with a *
3448 ;; character).
3452 return target)))
3453 ;; Then try to find an element with a matching "#+NAME: path"
3454 ;; affiliated keyword.
3461 ;; Last case: link either points to an headline or to
3462 ;; nothingness. Try to find the source, with priority given to
3463 ;; headlines with the closest common ancestor. If such candidate
3464 ;; is found, return it, otherwise return nil.
3468 ;; Return first headline whose `:raw-value' property
3469 ;; is NAME in parse tree DATA, or nil.
3472 data 'headline
3476 name)
3477 headline))
3479 ;; Search among headlines sharing an ancestor with link,
3480 ;; from closest to farthest.
3488 ;; No match with a common ancestor: try the full parse-tree.
3494 "Return headline referenced as LINK destination.
3496 INFO is a plist used as a communication channel.
3498 Return value can be the headline element matched in current parse
3502 ;; First check if id is within the current parse tree.
3508 headline))
3510 ;; Otherwise, look for external files.
3514 "Return radio-target object referenced as LINK destination.
3516 INFO is a plist used as a communication channel.
3518 Return value can be a radio-target object or nil. Assume LINK
3528 ;;;; For References
3529 ;;
3530 ;; `org-export-get-ordinal' associates a sequence number to any object
3531 ;; or element.
3534 "Return ordinal number of an element or object.
3536 ELEMENT is the element or object considered. INFO is the plist
3537 used as a communication channel.
3539 Optional argument TYPES, when non-nil, is a list of element or
3540 object types, as symbols, that should also be counted in.
3541 Otherwise, only provided element's type is considered.
3543 Optional argument PREDICATE is a function returning a non-nil
3544 value if the current element or object should be counted in. It
3545 accepts two arguments: the element or object being considered and
3546 the plist used as a communication channel. This allows to count
3547 only a certain type of objects (i.e. inline images).
3549 Return value is a list of numbers if ELEMENT is an headline or an
3550 item. It is nil for keywords. It represents the footnote number
3551 for footnote definitions and footnote references. If ELEMENT is
3552 a target, return the same value as if ELEMENT was the closest
3553 table, item or headline containing the target. In any other
3554 case, return the sequence number of ELEMENT among elements or
3555 objects of the same type."
3556 ;; A target keyword, representing an invisible target, never has
3557 ;; a sequence number.
3559 ;; Ordinal of a target object refer to the ordinal of the closest
3560 ;; table, item, or headline containing the object.
3564 when
3568 table))
3569 return parent)))
3571 ;; Special case 1: An headline returns its number as a list.
3573 ;; Special case 2: An item returns its number as a list.
3577 struct
3584 ;; Increment counter until ELEMENT is found again.
3595 ;;;; For Src-Blocks
3596 ;;
3597 ;; `org-export-get-loc' counts number of code lines accumulated in
3598 ;; src-block or example-block elements with a "+n" switch until
3599 ;; a given element, excluded. Note: "-n" switches reset that count.
3600 ;;
3601 ;; `org-export-unravel-code' extracts source code (along with a code
3602 ;; references alist) from an `element-block' or `src-block' type
3603 ;; element.
3604 ;;
3605 ;; `org-export-format-code' applies a formatting function to each line
3606 ;; of code, providing relative line number and code reference when
3607 ;; appropriate. Since it doesn't access the original element from
3608 ;; which the source code is coming, it expects from the code calling
3609 ;; it to know if lines should be numbered and if code references
3610 ;; should appear.
3611 ;;
3612 ;; Eventually, `org-export-format-code-default' is a higher-level
3613 ;; function (it makes use of the two previous functions) which handles
3614 ;; line numbering and code references inclusion, and returns source
3615 ;; code in a format suitable for plain text or verbatim output.
3618 "Return accumulated lines of code up to ELEMENT.
3620 INFO is the plist used as a communication channel.
3622 ELEMENT is excluded from count."
3629 ;; ELEMENT is reached: Quit the loop.
3631 ;; Only count lines from src-block and example-block elements
3632 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3636 ;; Accumulate locs or reset them.
3640 ;; Return nil to stay in the loop.
3641 nil)))
3643 ;; Return value.
3644 loc))
3647 "Clean source code and extract references out of it.
3649 ELEMENT has either a `src-block' an `example-block' type.
3651 Return a cons cell whose CAR is the source code, cleaned from any
3652 reference and protective comma and CDR is an alist between
3653 relative line number (integer) and name of code reference on that
3654 line (string)."
3656 ;; Get code and clean it. Remove blank lines at its
3657 ;; beginning and end.
3663 ;; If appropriate, remove global indentation.
3666 c
3668 ;; Get format used for references.
3671 org-coderef-label-format)))
3672 ;; Build a regexp matching a loc with a reference.
3677 ;; Return value.
3679 ;; Code with references removed.
3685 ;; Ref line: remove ref, and signal its position in REFS.
3689 ;; Reference alist.
3690 refs)))
3693 "Format CODE by applying FUN line-wise and return it.
3695 CODE is a string representing the code to format. FUN is
3696 a function. It must accept three arguments: a line of
3697 code (string), the current line number (integer) or nil and the
3698 reference associated to the current line (string) or nil.
3700 Optional argument NUM-LINES can be an integer representing the
3701 number of code lines accumulated until the current code. Line
3702 numbers passed to FUN will take it into account. If it is nil,
3703 FUN's second argument will always be nil. This number can be
3704 obtained with `org-export-get-loc' function.
3706 Optional argument REF-ALIST can be an alist between relative line
3707 number (i.e. ignoring NUM-LINES) and the name of the code
3708 reference on it. If it is nil, FUN's third argument will always
3709 be nil. It can be obtained through the use of
3710 `org-export-unravel-code' function."
3722 "Return source code from ELEMENT, formatted in a standard way.
3724 ELEMENT is either a `src-block' or `example-block' element. INFO
3725 is a plist used as a communication channel.
3727 This function takes care of line numbering and code references
3728 inclusion. Line numbers, when applicable, appear at the
3729 beginning of the line, separated from the code by two white
3730 spaces. Code references, on the other hand, appear flushed to
3731 the right, separated by six white spaces from the widest line of
3732 code."
3733 ;; Extract code and references.
3739 ;; Handle line numbering.
3748 ;; Prepare references display, if required. Any reference
3749 ;; should start six columns after the widest line of code,
3750 ;; wrapped with parenthesis.
3755 code
3759 number-str
3760 loc
3766 num-start refs)))
3769 ;;;; For Tables
3770 ;;
3771 ;; `org-export-table-has-special-column-p' and and
3772 ;; `org-export-table-row-is-special-p' are predicates used to look for
3773 ;; meta-information about the table structure.
3774 ;;
3775 ;; `org-table-has-header-p' tells when the rows before the first rule
3776 ;; should be considered as table's header.
3777 ;;
3778 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3779 ;; and `org-export-table-cell-borders' extract information from
3780 ;; a table-cell element.
3781 ;;
3782 ;; `org-export-table-dimensions' gives the number on rows and columns
3783 ;; in the table, ignoring horizontal rules and special columns.
3784 ;; `org-export-table-cell-address', given a table-cell object, returns
3785 ;; the absolute address of a cell. On the other hand,
3786 ;; `org-export-get-table-cell-at' does the contrary.
3787 ;;
3788 ;; `org-export-table-cell-starts-colgroup-p',
3789 ;; `org-export-table-cell-ends-colgroup-p',
3790 ;; `org-export-table-row-starts-rowgroup-p',
3791 ;; `org-export-table-row-ends-rowgroup-p',
3792 ;; `org-export-table-row-starts-header-p' and
3793 ;; `org-export-table-row-ends-header-p' indicate position of current
3794 ;; row or cell within the table.
3797 "Non-nil when TABLE has a special column.
3798 All special columns will be ignored during export."
3799 ;; The table has a special column when every first cell of every row
3800 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3801 ;; "*" "_" and "^". Though, do not consider a first row containing
3802 ;; only empty cells as special.
3818 "Non-nil when TABLE has an header.
3820 INFO is a plist used as a communication channel.
3822 A table has an header when it contains at least two row groups."
3825 table 'table-row
3833 info)))
3836 "Non-nil if TABLE-ROW is considered special.
3838 INFO is a plist used as the communication channel.
3840 All special rows will be ignored during export."
3844 ;; A row is special either when...
3846 ;; ... it starts with a field only containing "/",
3848 ;; ... the table contains a special column and the row start
3849 ;; with a marking character among, "^", "_", "$" or "!",
3853 ;; ... it contains only alignment cookies and empty cells.
3859 ;; Since VALUE is a secondary string, the following
3860 ;; checks avoid expanding it with `org-export-data'.
3872 "Return TABLE-ROW's group.
3874 INFO is a plist used as the communication channel.
3876 Return value is the group number, as an integer, or nil special
3877 rows and table rules. Group 1 is also table's header."
3894 "Return TABLE-CELL contents width.
3896 INFO is a plist used as the communication channel.
3898 Return value is the width given by the last width cookie in the
3899 same column as TABLE-CELL, or nil."
3904 cookie-width)
3908 ;; In a special row, try to find a width cookie at COLUMN.
3912 ;; The following checks avoid expanding unnecessarily the
3913 ;; cell with `org-export-data'
3921 ;; Ignore table rules.
3924 ;; Return value.
3925 cookie-width))
3928 "Return TABLE-CELL contents alignment.
3930 INFO is a plist used as the communication channel.
3932 Return alignment as specified by the last alignment cookie in the
3933 same column as TABLE-CELL. If no such cookie is found, a default
3934 alignment value will be deduced from fraction of numbers in the
3935 column (see `org-table-number-fraction' for more information).
3936 Possible values are `left', `right' and `center'."
3943 cookie-align)
3947 ;; In a special row, try to find an alignment cookie at
3948 ;; COLUMN.
3952 ;; Since VALUE is a secondary string, the following checks
3953 ;; avoid useless expansion through `org-export-data'.
3961 ;; Ignore table rules.
3963 ;; In a standard row, check if cell's contents are expressing
3964 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3965 ;; Though, don't bother if an alignment cookie has already
3966 ;; defined cell's alignment.
3971 info)))
3976 ;; Return value. Alignment specified by cookies has precedence
3977 ;; over alignment deduced from cells contents.
3986 "Return TABLE-CELL borders.
3988 INFO is a plist used as a communication channel.
3990 Return value is a list of symbols, or nil. Possible values are:
3991 `top', `bottom', `above', `below', `left' and `right'. Note:
3992 `top' (resp. `bottom') only happen for a cell in the first
3993 row (resp. last row) of the table, ignoring table rules, if any.
3995 Returned borders ignore special rows."
3998 borders)
3999 ;; Top/above border? TABLE-CELL has a border above when a rule
4000 ;; used to demarcate row groups can be found above. Hence,
4001 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4002 ;; another regular row has to be found above that rule.
4011 ;; Look at every row before the current one.
4013 ;; No rule above, or rule found starts the table (ignoring any
4014 ;; special row): TABLE-CELL is at the top of the table.
4017 ;; Bottom/below border? TABLE-CELL has a border below when next
4018 ;; non-regular row below is a rule.
4027 ;; Look at every row after the current one.
4029 ;; No rule below, or rule found ends the table (modulo some
4030 ;; special row): TABLE-CELL is at the bottom of the table.
4033 ;; Right/left borders? They can only be specified by column
4034 ;; groups. Column groups are defined in a row starting with "/".
4035 ;; Also a column groups row only contains "<", "<>", ">" or blank
4036 ;; cells.
4053 ;; There's a left border when previous cell, if
4054 ;; any, ends a group, or current one starts one.
4060 ;; There's a right border when next cell, if any,
4061 ;; starts a group, or current one ends one.
4068 ;; Table rows are read in reverse order so last column groups
4069 ;; row has precedence over any previous one.
4071 ;; Return value.
4072 borders))
4075 "Non-nil when TABLE-CELL is at the beginning of a row group.
4076 INFO is a plist used as a communication channel."
4077 ;; A cell starts a column group either when it is at the beginning
4078 ;; of a row (or after the special column, if any) or when it has
4079 ;; a left border.
4083 table-cell)
4087 "Non-nil when TABLE-CELL is at the end of a row group.
4088 INFO is a plist used as a communication channel."
4089 ;; A cell ends a column group either when it is at the end of a row
4090 ;; or when it has a right border.
4093 table-cell)
4097 "Non-nil when TABLE-ROW is at the beginning of a column group.
4098 INFO is a plist used as a communication channel."
4106 "Non-nil when TABLE-ROW is at the end of a column group.
4107 INFO is a plist used as a communication channel."
4115 "Non-nil when TABLE-ROW is the first table header's row.
4116 INFO is a plist used as a communication channel."
4123 "Non-nil when TABLE-ROW is the last table header's row.
4124 INFO is a plist used as a communication channel."
4131 "Return TABLE dimensions.
4133 INFO is a plist used as a communication channel.
4135 Return value is a CONS like (ROWS . COLUMNS) where
4136 ROWS (resp. COLUMNS) is the number of exportable
4137 rows (resp. columns)."
4139 ;; Set number of rows, and extract first one.
4141 table 'table-row
4146 ;; Set number of columns.
4148 ;; Return value.
4152 "Return address of a regular TABLE-CELL object.
4154 TABLE-CELL is the cell considered. INFO is a plist used as
4155 a communication channel.
4157 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4158 zero-based index. Only exportable cells are considered. The
4159 function returns nil for other cells."
4162 ;; Ignore cells in special rows or in special column.
4167 ;; Row number.
4170 table 'table-row
4176 ;; Column number.
4179 table-row 'table-cell
4185 "Return regular table-cell object at ADDRESS in TABLE.
4187 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4188 zero-based index. TABLE is a table type element. INFO is
4189 a plist used as a communication channel.
4191 If no table-cell, among exportable cells, is found at ADDRESS,
4192 return nil."
4195 ;; Row at (car address) or nil.
4198 table 'table-row
4204 'table-cell
4211 ;;;; For Tables Of Contents
4212 ;;
4213 ;; `org-export-collect-headlines' builds a list of all exportable
4214 ;; headline elements, maybe limited to a certain depth. One can then
4215 ;; easily parse it and transcode it.
4216 ;;
4217 ;; Building lists of tables, figures or listings is quite similar.
4218 ;; Once the generic function `org-export-collect-elements' is defined,
4219 ;; `org-export-collect-tables', `org-export-collect-figures' and
4220 ;; `org-export-collect-listings' can be derived from it.
4223 "Collect headlines in order to build a table of contents.
4225 INFO is a plist used as a communication channel.
4227 When optional argument N is an integer, it specifies the depth of
4228 the table of contents. Otherwise, it is set to the value of the
4229 last headline level. See `org-export-headline-levels' for more
4230 information.
4232 Return a list of all exportable headlines as parsed elements."
4236 'headline
4238 ;; Strip contents from HEADLINE.
4241 info))
4244 "Collect referenceable elements of a determined type.
4246 TYPE can be a symbol or a list of symbols specifying element
4247 types to search. Only elements with a caption are collected.
4249 INFO is a plist used as a communication channel.
4251 When non-nil, optional argument PREDICATE is a function accepting
4252 one argument, an element of type TYPE. It returns a non-nil
4253 value when that element should be collected.
4255 Return a list of all elements found, in order of appearance."
4261 element))
4262 info))
4265 "Build a list of tables.
4266 INFO is a plist used as a communication channel.
4268 Return a list of table elements with a caption."
4272 "Build a list of figures.
4274 INFO is a plist used as a communication channel. PREDICATE is
4275 a function which accepts one argument: a paragraph element and
4276 whose return value is non-nil when that element should be
4277 collected.
4279 A figure is a paragraph type element, with a caption, verifying
4281 a vague concept that may depend on back-end.
4283 Return a list of elements recognized as figures."
4287 "Build a list of src blocks.
4289 INFO is a plist used as a communication channel.
4291 Return a list of src-block elements with a caption."
4295 ;;;; For Timestamps
4296 ;;
4297 ;; `org-export-timestamp-has-time-p' is a predicate to know if hours
4298 ;; and minutes are defined in a given timestamp.
4299 ;;
4300 ;; `org-export-format-timestamp' allows to format a timestamp object
4301 ;; with an arbitrary format string.
4304 "Non-nil when TIMESTAMP has a time specified."
4308 "Format a TIMESTAMP element into a string.
4310 FORMAT is a format specifier to be passed to
4311 `format-time-string'.
4313 When optional argument END is non-nil, use end of date-range or
4314 time-range, if possible.
4316 When optional argument UTC is non-nil, time will be expressed as
4317 Universal Time."
4319 format
4327 utc))
4330 "Extract a timestamp object from a date or time range.
4332 TIMESTAMP is a timestamp object. END, when non-nil, means extract
4333 the end of the range. Otherwise, extract its start.
4335 Return a new timestamp object sharing the same parent as
4336 TIMESTAMP."
4340 ;; Set new type.
4343 ;; Copy start properties over end properties if END is
4344 ;; non-nil. Otherwise, copy end properties over `start' ones.
4352 split-ts
4356 ;; Eventually refresh `:raw-value'.
4362 "Apply `org-translate-time' on a TIMESTAMP object.
4363 When optional argument BOUNDARY is non-nil, it is either the
4364 symbol `start' or `end'. In this case, only translate the
4365 starting or ending part of TIMESTAMP if it is a date or time
4366 range. Otherwise, translate both parts."
4374 "--"
4380 :raw-value
4385 ;;;; Smart Quotes
4386 ;;
4387 ;; The main function for the smart quotes sub-system is
4388 ;; `org-export-activate-smart-quotes', which replaces every quote in
4389 ;; a given string from the parse tree with its "smart" counterpart.
4390 ;;
4391 ;; Dictionary for smart quotes is stored in
4392 ;; `org-export-smart-quotes-alist'.
4393 ;;
4394 ;; Internally, regexps matching potential smart quotes (checks at
4395 ;; string boundaries are also necessary) are defined in
4396 ;; `org-export-smart-quotes-regexps'.
4433 "Smart quotes translations.
4435 Alist whose CAR is a language string and CDR is an alist with
4436 quote type as key and a plist associating various encodings to
4437 their translation as value.
4439 A quote type can be any symbol among `opening-double-quote',
4440 `closing-double-quote', `opening-single-quote',
4441 `closing-single-quote' and `apostrophe'.
4443 Valid encodings include `:utf-8', `:html', `:latex' and
4444 `:texinfo'.
4450 ;; Possible opening quote at beginning of string.
4452 ;; Possible closing quote at beginning of string.
4454 ;; Possible apostrophe at beginning of string.
4456 ;; Opening single and double quotes.
4458 ;; Closing single and double quotes.
4460 ;; Apostrophe.
4462 ;; Possible opening quote at end of string.
4464 ;; Possible closing quote at end of string.
4466 ;; Possible apostrophe at end of string.
4468 "List of regexps matching a quote or an apostrophe.
4474 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4475 `:utf-8'. INFO is a plist used as a communication channel.
4477 The function has to retrieve information about string
4478 surroundings in parse tree. It can only happen with an
4479 unmodified string. Thus, if S has already been through another
4480 process, a non-nil ORIGINAL optional argument will provide that
4481 original string.
4483 Return the new string."
4490 ;; Return smart quote associated to a give quote Q, as
4491 ;; a string. TYPE is a symbol among `open', `close' and
4492 ;; `apostrophe'.
4502 org-export-smart-quotes-alist))))
4503 encoding)
4504 q)))))
4506 ;; Only a quote: no regexp can match. We have to check both
4507 ;; sides and decide what to do.
4515 ;; 1. Replace quote character at the beginning of S.
4517 ;; Apostrophe?
4523 ;; Closing quote?
4529 ;; Opening quote?
4535 ;; 2. Replace quotes in the middle of the string.
4537 ;; Opening quotes.
4543 ;; Closing quotes.
4549 ;; Apostrophes.
4554 ;; 3. Replace quote character at the end of S.
4556 ;; Apostrophe?
4561 ;; Closing quote?
4567 ;; Opening quote?
4572 ;; Return string with smart quotes.
4573 s))))
4575 ;;;; Topology
4576 ;;
4577 ;; Here are various functions to retrieve information about the
4578 ;; neighbourhood of a given element or object. Neighbours of interest
4579 ;; are direct parent (`org-export-get-parent'), parent headline
4580 ;; (`org-export-get-parent-headline'), first element containing an
4581 ;; object, (`org-export-get-parent-element'), parent table
4582 ;; (`org-export-get-parent-table'), previous element or object
4583 ;; (`org-export-get-previous-element') and next element or object
4584 ;; (`org-export-get-next-element').
4585 ;;
4586 ;; `org-export-get-genealogy' returns the full genealogy of a given
4587 ;; element or object, from closest parent to full parse tree.
4590 "Return BLOB parent or nil.
4591 BLOB is the element or object considered."
4595 "Return full genealogy relative to a given element or object.
4597 BLOB is the element or object being considered.
4599 Ancestors are returned from closest to farthest, the last one
4600 being the full parse tree."
4607 "Return BLOB parent headline or nil.
4608 BLOB is the element or object being considered."
4612 parent))
4615 "Return first element containing OBJECT or nil.
4616 OBJECT is the object to consider."
4620 parent))
4623 "Return OBJECT parent table or nil.
4624 OBJECT is either a `table-cell' or `table-element' type object."
4628 parent))
4631 "Return previous element or object.
4632 BLOB is an element or object. INFO is a plist used as
4633 a communication channel. Return previous exportable element or
4634 object, a string, or nil."
4641 ;; An object can belong to the contents of its parent or
4642 ;; to a secondary string. We check the latter option
4643 ;; first.
4646 org-element-all-elements))
4650 org-element-secondary-value-alist))
4651 parent)))
4656 "Return next element or object.
4657 BLOB is an element or object. INFO is a plist used as
4658 a communication channel. Return next exportable element or
4659 object, a string, or nil."
4664 ;; An object can belong to the contents of its parent or to
4665 ;; a secondary string. We check the latter option first.
4668 org-element-all-objects))
4672 org-element-secondary-value-alist))
4673 parent)))
4676 nil))
4679 ;;;; Translation
4680 ;;
4681 ;; `org-export-translate' translates a string according to language
4682 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4683 ;; variable and a specified charset. `org-export-dictionary' contains
4684 ;; the dictionary used for the translation.
4806 "Dictionary for export engine.
4808 Alist whose CAR is the string to translate and CDR is an alist
4809 whose CAR is the language string and CDR is a plist whose
4810 properties are possible charsets and values translated terms.
4812 It is used as a database for `org-export-translate'. Since this
4813 function returns the string as-is if no translation was found,
4814 the variable only needs to record values different from the
4818 "Translate string S according to language specification.
4820 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4821 and `:utf-8'. INFO is a plist used as a communication channel.
4823 Translation depends on `:language' property. Return the
4824 translated string. If no translation is found, try to fall back
4825 to `:default' encoding. If it fails, return S."
4831 s)))
4834 \f
4835 ;;; The Dispatcher
4836 ;;
4837 ;; `org-export-dispatch' is the standard interactive way to start an
4838 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4839 ;; for its interface, which, in turn, delegates response to key
4840 ;; pressed to `org-export-dispatch-action'.
4842 ;;;###autoload
4844 "Export dispatcher for Org mode.
4846 It provides an access to common export related tasks in a buffer.
4847 Its interface comes in two flavours: standard and expert. While
4848 both share the same set of bindings, only the former displays the
4849 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4850 to switch to one or the other.
4852 When called with C-u prefix ARG, repeat the last export action,
4853 with the same set of options used back then, on the current
4854 buffer."
4859 ;; Store this export command.
4863 nil
4864 org-export-dispatch-use-expert-ui))
4870 ;; First handle special hard-coded actions.
4876 "Publish project: "
4877 org-e-publish-project-alist nil t)
4878 org-e-publish-project-alist)
4888 "Handle interface for `org-export-dispatch'.
4890 OPTIONS is a list containing current interactive options set for
4891 export. It can contain any of the following symbols:
4892 `body' toggles a body-only export
4893 `subtree' restricts export to current subtree
4894 `visible' restricts export to visible part of buffer.
4895 `force' force publishing files.
4897 FIRST-KEY is the key pressed to select the first level menu. It
4898 is nil when this menu hasn't been selected yet.
4900 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4901 buffer is provided, but indications about currently active
4902 options are given in the prompt. Moreover, \[?] allows to switch
4903 back to standard interface."
4906 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4907 ;; non-nil is the required first-level key to activate
4908 ;; KEY. When its value is t, activate KEY independently
4909 ;; on the first key, if any. A nil value means KEY will
4910 ;; only be activated at first level.
4914 ;; Prepare menu entries by extracting them from
4915 ;; `org-export-registered-backends', and sorting them by
4916 ;; access key and by ordinal, if any.
4922 org-export-registered-backends))
4930 ;; Compute a list of allowed keys based on the first key
4931 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4932 ;; always available.
4944 ;; Build the help menu for standard UI.
4948 ;; Options are hard-coded.
4950 [%s] Body only: %s [%s] Visible only: %s
4960 ;; Display registered back-end entries. When a key
4961 ;; appears for the second time, do not create another
4962 ;; entry, but append its sub-menu to existing menu.
4975 ;; Split sub-menu into two columns.
4986 top-key)
4991 ;; Publishing menu is hard-coded.
4993 [%s] Current file [%s] Current project
5003 ;; Build prompts for both standard and expert UI.
5008 "Export command (Options: %s%s%s%s) [%s]: "
5014 ;; With expert UI, just read key with a fancy prompt. In standard
5015 ;; UI, display an intrusive help buffer.
5018 expert-prompt allowed-keys backends options first-key expertp)
5019 ;; At first call, create frame layout in order to display menu.
5025 ;; At this point, the buffer containing the menu exists and is
5026 ;; visible in the current window. So, refresh it.
5032 standard-prompt allowed-keys backends options first-key expertp))))
5036 "Read a character from command input and act accordingly.
5038 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5039 a list of characters available at a given step in the process.
5040 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5041 EXPERTP are the same as defined in `org-export-dispatch-ui',
5042 which see.
5044 Toggle export options when required. Otherwise, return value is
5045 a list with action as CAR and a list of interactive export
5046 options as CDR."
5048 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
5049 ;; depending on user's key pressed.
5052 ;; Ignore non-standard characters (i.e. "M-a") and
5053 ;; undefined associations.
5058 ;; q key at first level aborts export. At second
5059 ;; level, cancel first key instead.
5062 ;; Help key: Switch back to standard interface if
5063 ;; expert UI was active.
5065 ;; Toggle export options.
5072 first-key expertp))
5073 ;; Action selected: Send key and options back to
5074 ;; `org-export-dispatch'.
5078 ;; Publishing actions are hard-coded. Send a special
5079 ;; signal to `org-export-dispatch'.
5086 ;; Return first action associated to FIRST-KEY + KEY
5087 ;; path. Indeed, derived backends can share the same
5088 ;; FIRST-KEY.
5094 options))
5095 ;; Otherwise, enter sub-menu.
5100 ;;; org-export.el ends here