| blob | 520567c84f779168733b3d440c81252359a345db |
1 ;;; org-export.el --- Generic Export Engine For Org
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
22 ;;
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
25 ;;
26 ;; Besides that parser, the generic exporter is made of three distinct
27 ;; parts:
28 ;;
29 ;; - The communication channel consists in a property list, which is
30 ;; created and updated during the process. Its use is to offer
31 ;; every piece of information, would it be about initial environment
32 ;; or contextual data, all in a single place. The exhaustive list
33 ;; of properties is given in "The Communication Channel" section of
34 ;; this file.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core function is `org-export-as'. It returns the transcoded
48 ;; buffer as a string.
49 ;;
50 ;; An export back-end is defined with `org-export-define-backend',
51 ;; which sets one mandatory variable: his translation table. Its name
52 ;; is always `org-BACKEND-translate-alist' where BACKEND stands for
53 ;; the name chosen for the back-end. Its value is an alist whose keys
54 ;; are elements and objects types and values translator functions.
55 ;; See function's docstring for more information about translators.
56 ;;
57 ;; Optionally, `org-export-define-backend' can also support specific
58 ;; buffer keywords, OPTION keyword's items and filters. Also refer to
59 ;; function documentation for more information.
60 ;;
61 ;; If the new back-end shares most properties with another one,
62 ;; `org-export-define-derived-backend' can be used to simplify the
63 ;; process.
64 ;;
65 ;; Any back-end can define its own variables. Among them, those
66 ;; customizable should belong to the `org-export-BACKEND' group.
67 ;;
68 ;; Tools for common tasks across back-ends are implemented in the
69 ;; penultimate part of this file. A dispatcher for standard back-ends
70 ;; is provided in the last one.
72 ;;; Code:
106 \f
107 ;;; Internal Variables
108 ;;
109 ;; Among internal variables, the most important is
110 ;; `org-export-options-alist'. This variable define the global export
111 ;; options, shared between every exporter, and how they are acquired.
153 "Alist between export properties and ways to set them.
155 The CAR of the alist is the property name, and the CDR is a list
156 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
158 KEYWORD is a string representing a buffer keyword, or nil. Each
159 property defined this way can also be set, during subtree
160 export, through an headline property named after the keyword
162 property).
163 OPTION is a string that could be found in an #+OPTIONS: line.
164 DEFAULT is the default value for the property.
165 BEHAVIOUR determine how Org should handle multiple keywords for
166 the same property. It is a symbol among:
167 nil Keep old value and discard the new one.
168 t Replace old value with the new one.
169 `space' Concatenate the values, separating them with a space.
170 `newline' Concatenate the values, separating them with
171 a newline.
172 `split' Split values at white spaces, and cons them to the
173 previous list.
175 KEYWORD and OPTION have precedence over DEFAULT.
177 All these properties should be back-end agnostic. Back-end
178 specific properties are set through `org-export-define-backend'.
182 "List of in-buffer keywords that require special treatment.
183 These keywords are not directly associated to a property. The
184 way they are handled must be hard-coded into
243 "Alist between filters properties and initial values.
245 The key of each association is a property name accessible through
246 the communication channel. Its value is a configurable global
247 variable defining initial filters.
249 This list is meant to install user specified filters. Back-end
250 developers may install their own filters using
251 `org-export-define-backend'. Filters defined there will always
252 be prepended to the current list, so they always get applied
261 "Default rule for link matching an inline image.
262 This rule applies to links with no description. By default, it
263 will be considered as an inline image if it targets a local file
266 See `org-export-inline-image-p' for more information about
270 \f
271 ;;; User-configurable Variables
272 ;;
273 ;; Configuration for the masses.
274 ;;
275 ;; They should never be accessed directly, as their value is to be
276 ;; stored in a property list (cf. `org-export-options-alist').
277 ;; Back-ends will read their value from there instead.
280 "Options for exporting Org mode files."
285 "General options for export engine."
290 "Whether sub-trees with the ARCHIVE tag should be exported.
292 This can have three different values:
293 nil Do not export, pretend this tree is not present.
294 t Do export the entire tree.
295 `headline' Only export the headline, but skip the tree below it.
297 This option can also be set with the #+OPTIONS line,
306 "Non-nil means insert author name into the exported file.
307 This option can also be set with the #+OPTIONS line,
313 "Non-nil means export CLOCK keywords.
314 This option can also be set with the #+OPTIONS line,
320 "Non-nil means the postamble should contain a creator sentence.
322 The sentence can be set in `org-export-creator-string' and
325 If the value is `comment' insert it as a comment."
335 emacs-version)
336 "String to insert at the end of the generated document."
341 "Non-nil means export contents of standard drawers.
343 When t, all drawers are exported. This may also be a list of
344 drawer names to export. This variable doesn't apply to
345 properties drawers.
347 This option can also be set with the #+OPTIONS line,
357 "Non-nil means insert author email into the exported file.
358 This option can also be set with the #+OPTIONS line,
364 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
366 If the export target supports emphasizing text, the word will be
367 typeset in bold, italic, or underlined, respectively. Not all
368 export backends support this.
375 "Tags that exclude a tree from export.
377 All trees carrying any of these tags will be excluded from
378 export. This is without condition, so even subtrees inside that
379 carry one of the `org-export-select-tags' will be removed.
381 This option can also be set with the #+EXCLUDE_TAGS: keyword."
388 This can be used to have pre-formatted text, fragments of code
389 etc. For example:
390 : ;; Some Lisp examples
391 : (while (defc cnt)
392 : (ding))
393 will be looking just like this in also HTML. See also the QUOTE
394 keyword. Not all export backends support this.
401 "Non-nil means Org footnotes should be exported.
402 This option can also be set with the #+OPTIONS line,
408 "The last level which is still exported as a headline.
410 Inferior levels will produce itemize lists when exported.
417 "The default language for export and clocktable translations, as a string.
418 This may have an association in
419 `org-clock-clocktable-language-setup'."
424 "Non-nil means preserve all line breaks when exporting.
426 Normally, in HTML output paragraphs will be reformatted.
428 This option can also be set with the #+OPTIONS line,
434 "Non-nil means interpret entities when exporting.
437 Å.
439 For a list of supported names, see the constant `org-entities'
440 and the user option `org-entities-user'.
442 This option can also be set with the #+OPTIONS line,
448 "Non-nil means inlinetasks should be exported.
449 This option can also be set with the #+OPTIONS line,
455 "Non-nil means include planning info in export.
456 This option can also be set with the #+OPTIONS: line,
462 "Non-nil means include priority cookies in export.
463 This option can also be set with the #+OPTIONS line,
469 "Non-nil means add section numbers to headlines when exporting.
471 When set to an integer n, numbering will only happen for
472 headlines whose relative level is higher or equal to n.
474 This option can also be set with the #+OPTIONS line,
480 "Tags that select a tree for export.
482 If any such tag is found in a buffer, all trees that do not carry
483 one of these tags will be ignored during export. Inside trees
484 that are selected like this, you can still deselect a subtree by
485 tagging it with one of the `org-export-exclude-tags'.
487 This option can also be set with the #+SELECT_TAGS: keyword."
494 When this option is turned on, these strings will be exported as:
496 Org HTML LaTeX UTF-8
497 -----+----------+--------+-------
499 -- – -- –
500 --- — --- —
503 This option can also be set with the #+OPTIONS line,
509 "Non-nil means include statistics cookies in export.
510 This option can also be set with the #+OPTIONS: line,
518 When this option is turned on, you can use TeX-like syntax for
520 will be considered as a single item - so grouping with {} is
521 normally not needed. For example, the following things will be
522 parsed as single sub- or superscripts.
524 10^24 or 10^tau several digits will be considered 1 item.
525 10^-12 or 10^-tau a leading sign with digits or a word
526 x^2-y^3 will be read as x^2 - y^3, because items are
527 terminated by almost any nonword/nondigit char.
528 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
530 Still, ambiguity is possible - so when in doubt use {} to enclose
531 the sub/superscript. If you set this variable to the symbol
532 `{}', the braces are *required* in order to trigger
533 interpretations as sub/superscript. This can be helpful in
536 This option can also be set with the #+OPTIONS line,
545 "Non-nil means create a table of contents in exported files.
547 The TOC contains headlines with levels up
548 to`org-export-headline-levels'. When an integer, include levels
549 up to N in the toc, this may then be different from
550 `org-export-headline-levels', but it will not be allowed to be
551 larger than the number of headline levels. When nil, no table of
552 contents is made.
554 This option can also be set with the #+OPTIONS line,
564 For example:
566 | Name | Address | Birthday |
567 |-------------+----------+-----------|
568 | Arthur Dent | England | 29.2.2100 |
575 "If nil, do not export tags, just remove them from headlines.
577 If this is the symbol `not-in-toc', tags will be removed from
578 table of contents entries, but still be shown in the headlines of
579 the document.
581 This option can also be set with the #+OPTIONS line,
590 "Non-nil means include TODO items for export.
591 This may have the following values:
592 t include tasks independent of state.
593 todo include only tasks that are not yet done.
594 done include only tasks that are already done.
595 nil remove all tasks before export
596 list of keywords keep only tasks with these keywords"
607 "Non-nil means insert a time stamp into the exported file.
608 The time stamp shows when the file was created.
610 This option can also be set with the #+OPTIONS line,
616 "Non nil means allow timestamps in export.
618 It can be set to `active', `inactive', t or nil, in order to
619 export, respectively, only active timestamps, only inactive ones,
620 all of them or none.
622 This option can also be set with the #+OPTIONS line, e.g.
632 "Non-nil means include TODO keywords in export.
633 When nil, remove all these keywords from the export."
638 "Non-nil means allow #+BIND to define local variable values for export.
639 This is a potential security risk, which is why the user must
640 confirm the use of these lines."
648 "Alist between export snippets back-ends and exporter back-ends.
650 This variable allows to provide shortcuts for export snippets.
654 HTML code while every other back-end will ignore it."
662 "Coding system for the exported file."
667 "Non-nil means exported stuff will also be pushed onto the kill ring."
672 "The initial scope when exporting with `org-export-dispatch'.
673 This variable can be either set to `buffer' or `subtree'."
680 "Non-nil means show buffer after exporting to temp buffer.
681 When Org exports to a file, the buffer visiting that file is ever
682 shown, but remains buried. However, when exporting to
683 a temporary buffer, that buffer is popped up in a second window.
684 When this variable is nil, the buffer remains buried also in
685 these cases."
690 "Non-nil means using a non-intrusive `org-export-dispatch'.
691 In that case, no help buffer is displayed. Though, an indicator
695 considered for export\). Also, \[?] allows to switch back to
696 standard mode."
701 \f
702 ;;; Defining New Back-ends
705 "Define a new back-end BACKEND.
707 TRANSLATORS is an alist between object or element types and
708 functions handling them.
710 These functions should return a string without any trailing
711 space, or nil. They must accept three arguments: the object or
712 element itself, its contents or nil when it isn't recursive and
713 the property list used as a communication channel.
715 Contents, when not nil, are stripped from any global indentation
716 \(although the relative one is preserved). They also always end
717 with a single newline character.
719 If, for a given type, no function is found, that element or
720 object type will simply be ignored, along with any blank line or
721 white space at its end. The same will happen if the function
722 returns the nil value. If that function returns the empty
723 string, the type will be ignored, but the blank lines or white
724 spaces will be kept.
726 In addition to element and object types, one function can be
727 associated to the `template' symbol and another one to the
728 `plain-text' symbol.
730 The former returns the final transcoded string, and can be used
731 to add a preamble and a postamble to document's body. It must
732 accept two arguments: the transcoded string and the property list
733 containing export options.
735 The latter, when defined, is to be called on every text not
736 recognized as an element or an object. It must accept two
737 arguments: the text string and the information channel. It is an
738 appropriate place to protect special chars relative to the
739 back-end.
741 BODY can start with pre-defined keyword arguments. The following
742 keywords are understood:
744 :export-block
746 String, or list of strings, representing block names that
747 will not be parsed. This is used to specify blocks that will
748 contain raw code specific to the back-end. These blocks
749 still have to be handled by the relative `export-block' type
750 translator.
752 :filters-alist
754 Alist between filters and function, or list of functions,
755 specific to the back-end. See `org-export-filters-alist' for
756 a list of all allowed filters. Filters defined here
757 shouldn't make a back-end test, as it may prevent back-ends
758 derived from this one to behave properly.
760 :menu-entry
762 Menu entry for the export dispatcher. It should be a list
763 like:
765 \(KEY DESCRIPTION ACTION-OR-MENU)
767 where :
769 KEY is a free character selecting the back-end.
770 DESCRIPTION is a string naming the back-end.
771 ACTION-OR-MENU is either a function or an alist.
773 If it is an action, it will be called with three arguments:
774 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
775 for further explanations.
777 If it is an alist, associations should follow the
778 pattern:
780 \(KEY DESCRIPTION ACTION)
782 where KEY, DESCRIPTION and ACTION are described above.
784 Valid values include:
788 or
795 \(lambda (subtree visible body-only)
796 \(org-open-file
797 \(org-e-latex-export-to-pdf subtree visible body-only))))))
799 :options-alist
801 Alist between back-end specific properties introduced in
802 communication channel and how their value are acquired. See
803 `org-export-options-alist' for more information about
804 structure of the values."
819 ;; Define translators.
822 ;; Define options.
826 See `org-export-options-alist' for more information on the
827 structure of the values."
828 backend)))
829 ;; Define filters.
832 "Alist between filters keywords and back-end specific filters.
834 ;; Tell parser to not parse EXPORT-BLOCK blocks.
841 ;; Add an entry for back-end in `org-export-dispatch'.
846 ;; Splice in the body, if any.
850 "Create a new back-end as a variant of an existing one.
852 CHILD is the name of the derived back-end. PARENT is the name of
853 the parent back-end.
855 BODY can start with pre-defined keyword arguments. The following
856 keywords are understood:
858 :export-block
860 String, or list of strings, representing block names that
861 will not be parsed. This is used to specify blocks that will
862 contain raw code specific to the back-end. These blocks
863 still have to be handled by the relative `export-block' type
864 translator.
866 :filters-alist
868 Alist of filters that will overwrite or complete filters
869 defined in PARENT back-end. See `org-export-filters-alist'
870 for a list of allowed filters.
872 :menu-entry
874 Menu entry for the export dispatcher. See
875 `org-export-define-backend' for more information about the
876 expected value.
878 :options-alist
880 Alist of back-end specific properties that will overwrite or
881 complete those defined in PARENT back-end. Refer to
882 `org-export-options-alist' for more information about
883 structure of the values.
885 :sub-menu-entry
887 Append entries to an existing menu in the export dispatcher.
888 The associated value should be a list whose CAR is the
889 character selecting the menu to expand and CDR a list of
890 entries following the pattern:
892 \(KEY DESCRIPTION ACTION)
894 where KEY is a free character triggering the action,
895 DESCRIPTION is a string defining the action, and ACTION is
896 a function that will be called with three arguments:
897 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
898 for further explanations.
900 Valid values include:
904 \(lambda (s v b)
905 \(org-open-file (org-e-beamer-export-to-pdf s v b)))))
907 :translate-alist
909 Alist of element and object types and transcoders that will
910 overwrite or complete transcode table from PARENT back-end.
911 Refer to `org-export-define-backend' for detailed information
912 about transcoders.
915 as a variant of `e-latex' back-end with a custom template
916 function:
918 \(org-export-define-derived-backend my-latex e-latex
919 :translate-alist ((template . my-latex-template-fun)))
921 The back-end could then be called with, for example:
940 ;; Tell parser to not parse EXPORT-BLOCK blocks.
947 ;; Define filters.
954 "Alist between filters keywords and back-end specific filters.
956 ;; Define options.
964 See `org-export-options-alist' for more information on the
965 structure of the values."
966 child))))
967 ;; Define translators.
974 ;; Add an entry for back-end in `org-export-dispatch'.
981 org-export-dispatch-menu-entries))))
985 ;; Splice in the body, if any.
989 \f
990 ;;; The Communication Channel
991 ;;
992 ;; During export process, every function has access to a number of
993 ;; properties. They are of two types:
994 ;;
995 ;; 1. Environment options are collected once at the very beginning of
996 ;; the process, out of the original buffer and configuration.
997 ;; Collecting them is handled by `org-export-get-environment'
998 ;; function.
999 ;;
1000 ;; Most environment options are defined through the
1001 ;; `org-export-options-alist' variable.
1002 ;;
1003 ;; 2. Tree properties are extracted directly from the parsed tree,
1004 ;; just before export, by `org-export-collect-tree-properties'.
1005 ;;
1006 ;; Here is the full list of properties available during transcode
1007 ;; process, with their category and their value type.
1008 ;;
1009 ;; + `:author' :: Author's name.
1010 ;; - category :: option
1011 ;; - type :: string
1012 ;;
1013 ;; + `:back-end' :: Current back-end used for transcoding.
1014 ;; - category :: tree
1015 ;; - type :: symbol
1016 ;;
1017 ;; + `:creator' :: String to write as creation information.
1018 ;; - category :: option
1019 ;; - type :: string
1020 ;;
1021 ;; + `:date' :: String to use as date.
1022 ;; - category :: option
1023 ;; - type :: string
1024 ;;
1025 ;; + `:description' :: Description text for the current data.
1026 ;; - category :: option
1027 ;; - type :: string
1028 ;;
1029 ;; + `:email' :: Author's email.
1030 ;; - category :: option
1031 ;; - type :: string
1032 ;;
1033 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1034 ;; process.
1035 ;; - category :: option
1036 ;; - type :: list of strings
1037 ;;
1038 ;; + `:exported-data' :: Hash table used for memoizing
1039 ;; `org-export-data'.
1040 ;; - category :: tree
1041 ;; - type :: hash table
1042 ;;
1043 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1044 ;; their definition, as parsed data. Only non-inlined footnotes
1045 ;; are represented in this alist. Also, every definition isn't
1046 ;; guaranteed to be referenced in the parse tree. The purpose of
1047 ;; this property is to preserve definitions from oblivion
1048 ;; (i.e. when the parse tree comes from a part of the original
1049 ;; buffer), it isn't meant for direct use in a back-end. To
1050 ;; retrieve a definition relative to a reference, use
1051 ;; `org-export-get-footnote-definition' instead.
1052 ;; - category :: option
1053 ;; - type :: alist (STRING . LIST)
1054 ;;
1055 ;; + `:headline-levels' :: Maximum level being exported as an
1056 ;; headline. Comparison is done with the relative level of
1057 ;; headlines in the parse tree, not necessarily with their
1058 ;; actual level.
1059 ;; - category :: option
1060 ;; - type :: integer
1061 ;;
1062 ;; + `:headline-offset' :: Difference between relative and real level
1063 ;; of headlines in the parse tree. For example, a value of -1
1064 ;; means a level 2 headline should be considered as level
1065 ;; 1 (cf. `org-export-get-relative-level').
1066 ;; - category :: tree
1067 ;; - type :: integer
1068 ;;
1069 ;; + `:headline-numbering' :: Alist between headlines and their
1070 ;; numbering, as a list of numbers
1071 ;; (cf. `org-export-get-headline-number').
1072 ;; - category :: tree
1073 ;; - type :: alist (INTEGER . LIST)
1074 ;;
1075 ;; + `:id-alist' :: Alist between ID strings and destination file's
1076 ;; path, relative to current directory. It is used by
1077 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1078 ;; external file.
1079 ;; - category :: option
1080 ;; - type :: alist (STRING . STRING)
1081 ;;
1082 ;; + `:ignore-list' :: List of elements and objects that should be
1083 ;; ignored during export.
1084 ;; - category :: tree
1085 ;; - type :: list of elements and objects
1086 ;;
1087 ;; + `:input-file' :: Full path to input file, if any.
1088 ;; - category :: option
1089 ;; - type :: string or nil
1090 ;;
1091 ;; + `:keywords' :: List of keywords attached to data.
1092 ;; - category :: option
1093 ;; - type :: string
1094 ;;
1095 ;; + `:language' :: Default language used for translations.
1096 ;; - category :: option
1097 ;; - type :: string
1098 ;;
1099 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1100 ;; transcoding.
1101 ;; - category :: option
1102 ;; - type :: list (as returned by `org-element-parse-buffer')
1103 ;;
1104 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1105 ;; all line breaks.
1106 ;; - category :: option
1107 ;; - type :: symbol (nil, t)
1108 ;;
1109 ;; + `:section-numbers' :: Non-nil means transcoding should add
1110 ;; section numbers to headlines.
1111 ;; - category :: option
1112 ;; - type :: symbol (nil, t)
1113 ;;
1114 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1115 ;; in transcoding. When such a tag is present, subtrees without
1116 ;; it are de facto excluded from the process. See
1117 ;; `use-select-tags'.
1118 ;; - category :: option
1119 ;; - type :: list of strings
1120 ;;
1121 ;; + `:target-list' :: List of targets encountered in the parse tree.
1122 ;; This is used to partly resolve "fuzzy" links
1123 ;; (cf. `org-export-resolve-fuzzy-link').
1124 ;; - category :: tree
1125 ;; - type :: list of strings
1126 ;;
1127 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1128 ;; a time stamp in the output.
1129 ;; - category :: option
1130 ;; - type :: symbol (nil, t)
1131 ;;
1132 ;; + `:translate-alist' :: Alist between element and object types and
1133 ;; transcoding functions relative to the current back-end.
1134 ;; Special keys `template' and `plain-text' are also possible.
1135 ;; - category :: option
1136 ;; - type :: alist (SYMBOL . FUNCTION)
1137 ;;
1138 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1139 ;; also be transcoded. If it is set to the `headline' symbol,
1140 ;; only the archived headline's name is retained.
1141 ;; - category :: option
1142 ;; - type :: symbol (nil, t, `headline')
1143 ;;
1144 ;; + `:with-author' :: Non-nil means author's name should be included
1145 ;; in the output.
1146 ;; - category :: option
1147 ;; - type :: symbol (nil, t)
1148 ;;
1149 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
1150 ;; - category :: option
1151 ;; - type :: symbol (nil, t)
1152 ;;
1153 ;; + `:with-creator' :: Non-nild means a creation sentence should be
1154 ;; inserted at the end of the transcoded string. If the value
1155 ;; is `comment', it should be commented.
1156 ;; - category :: option
1157 ;; - type :: symbol (`comment', nil, t)
1158 ;;
1159 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1160 ;; its value is a list of names, only drawers with such names
1161 ;; will be transcoded.
1162 ;; - category :: option
1163 ;; - type :: symbol (nil, t) or list of strings
1164 ;;
1165 ;; + `:with-email' :: Non-nil means output should contain author's
1166 ;; email.
1167 ;; - category :: option
1168 ;; - type :: symbol (nil, t)
1169 ;;
1170 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1171 ;; interpreted.
1172 ;; - category :: option
1173 ;; - type :: symbol (nil, t)
1174 ;;
1175 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1176 ;; strings starting with a colon as a fixed-with (verbatim) area.
1177 ;; - category :: option
1178 ;; - type :: symbol (nil, t)
1179 ;;
1180 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1181 ;; footnotes.
1182 ;; - category :: option
1183 ;; - type :: symbol (nil, t)
1184 ;;
1185 ;; + `:with-plannings' :: Non-nil means transcoding should include
1186 ;; planning info.
1187 ;; - category :: option
1188 ;; - type :: symbol (nil, t)
1189 ;;
1190 ;; + `:with-priority' :: Non-nil means transcoding should include
1191 ;; priority cookies.
1192 ;; - category :: option
1193 ;; - type :: symbol (nil, t)
1194 ;;
1195 ;; + `:with-special-strings' :: Non-nil means transcoding should
1196 ;; interpret special strings in plain text.
1197 ;; - category :: option
1198 ;; - type :: symbol (nil, t)
1199 ;;
1200 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1201 ;; interpret subscript and superscript. With a value of "{}",
1202 ;; only interpret those using curly brackets.
1203 ;; - category :: option
1204 ;; - type :: symbol (nil, {}, t)
1205 ;;
1206 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1207 ;; tables.
1208 ;; - category :: option
1209 ;; - type :: symbol (nil, t)
1210 ;;
1211 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1212 ;; headlines. A `not-in-toc' value will remove them from the
1213 ;; table of contents, if any, nonetheless.
1214 ;; - category :: option
1215 ;; - type :: symbol (nil, t, `not-in-toc')
1216 ;;
1217 ;; + `:with-tasks' :: Non-nil means transcoding should include
1218 ;; headlines with a TODO keyword. A `todo' value will only
1219 ;; include headlines with a todo type keyword while a `done'
1220 ;; value will do the contrary. If a list of strings is provided,
1221 ;; only tasks with keywords belonging to that list will be kept.
1222 ;; - category :: option
1223 ;; - type :: symbol (t, todo, done, nil) or list of strings
1224 ;;
1225 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1226 ;; time stamps. Special value `active' (resp. `inactive') ask to
1227 ;; export only active (resp. inactive) timestamps. Otherwise,
1228 ;; completely remove them.
1229 ;; - category :: option
1230 ;; - type :: symbol: (`active', `inactive', t, nil)
1231 ;;
1232 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1233 ;; added to the output. An integer value limits its depth.
1234 ;; - category :: option
1235 ;; - type :: symbol (nil, t or integer)
1236 ;;
1237 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1238 ;; include TODO keywords.
1239 ;; - category :: option
1240 ;; - type :: symbol (nil, t)
1243 ;;;; Environment Options
1244 ;;
1245 ;; Environment options encompass all parameters defined outside the
1246 ;; scope of the parsed data. They come from five sources, in
1247 ;; increasing precedence order:
1248 ;;
1249 ;; - Global variables,
1250 ;; - Buffer's attributes,
1251 ;; - Options keyword symbols,
1252 ;; - Buffer keywords,
1253 ;; - Subtree properties.
1254 ;;
1255 ;; The central internal function with regards to environment options
1256 ;; is `org-export-get-environment'. It updates global variables with
1257 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1258 ;; the different sources.
1259 ;;
1260 ;; The internal functions doing the retrieval are:
1261 ;; `org-export--get-global-options',
1262 ;; `org-export--get-buffer-attributes',
1263 ;; `org-export--parse-option-keyword',
1264 ;; `org-export--get-subtree-options' and
1265 ;; `org-export--get-inbuffer-options'
1266 ;;
1267 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1268 ;; take care of the part relative to "#+BIND:" keywords.
1271 "Collect export options from the current buffer.
1273 Optional argument BACKEND is a symbol specifying which back-end
1274 specific options to read, if any.
1276 When optional argument SUBTREEP is non-nil, assume the export is
1277 done against the current sub-tree.
1279 Third optional argument EXT-PLIST is a property list with
1280 external parameters overriding Org default settings, but still
1281 inferior to file-local settings."
1282 ;; First install #+BIND variables.
1284 ;; Get and prioritize export options...
1286 ;; ... from global variables...
1288 ;; ... from buffer's attributes...
1290 ;; ... from an external property list...
1291 ext-plist
1292 ;; ... from in-buffer settings...
1294 backend
1296 ;; ... and from subtree, when appropriate.
1298 ;; Eventually install back-end symbol and its translation table.
1299 `(:back-end
1300 ,backend
1301 :translate-alist
1306 "Parse an OPTIONS line and return values as a plist.
1307 Optional argument BACKEND is a symbol specifying which back-end
1308 specific items to read, if any."
1315 ;; Build an alist between #+OPTION: item and property-name.
1320 all)))
1321 plist)
1326 options)
1331 alist)
1332 plist))
1335 "Get export options in subtree at point.
1336 Optional argument BACKEND is a symbol specifying back-end used
1337 for export. Return options as a plist."
1338 ;; For each buffer keyword, create an headline property setting the
1339 ;; same property in communication channel. The name for the property
1340 ;; is the keyword with "EXPORT_" appended to it.
1343 ;; Make sure point is at an heading.
1345 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1346 ;; title as its fallback value.
1353 plist :title
1356 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1360 ;; Handle other keywords.
1367 ;; Export properties are not case-sensitive.
1374 plist
1376 ;; Parse VALUE if required.
1380 value))))))))
1381 ;; Also look for both general keywords and back-end specific
1382 ;; options if BACKEND is provided.
1387 org-export-options-alist)))
1388 ;; Return value.
1389 plist)))
1392 "Return current buffer export options, as a plist.
1394 Optional argument BACKEND, when non-nil, is a symbol specifying
1395 which back-end specific options should also be read in the
1396 process.
1398 Optional argument FILES is a list of setup files names read so
1399 far, used to avoid circular dependencies.
1401 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1405 ;; 1. Special keywords, as in `org-export-special-keywords'.
1419 ;; Avoid circular dependencies.
1429 ;; 2. Standard options, as in `org-export-options-alist'.
1431 ;; Also look for back-end specific options
1432 ;; if BACKEND is defined.
1438 ;; Build ALIST between keyword name and property name.
1442 all)))
1443 ;; Build regexp matching all keywords associated to export
1444 ;; options. Note: the search is case insensitive.
1458 plist prop
1459 ;; Handle value depending on specified BEHAVIOUR.
1472 ;; Parse keywords specified in `org-element-parsed-keywords'.
1480 plist prop
1483 org-element-parsed-keywords))
1484 ;; 3. Return final value.
1485 plist)))
1488 "Return properties related to buffer attributes, as a plist."
1491 ;; Store full path of input file name, or nil. For internal use.
1492 :input-file visited-file
1497 :footnote-definition-alist
1498 ;; Footnotes definitions must be collected in the original
1499 ;; buffer, as there's no insurance that they will still be in the
1500 ;; parse tree, due to possible narrowing.
1511 ;; Like `org-element-parse-buffer', but
1512 ;; makes sure the definition doesn't start
1513 ;; with a section element.
1517 alist))))
1518 alist))
1519 :id-alist
1520 ;; Collect id references.
1529 alist))))
1532 "Return global export options as a plist.
1534 Optional argument BACKEND, if non-nil, is a symbol specifying
1535 which back-end specific export options should also be read in the
1536 process."
1542 ;; Output value.
1543 plist)
1548 plist
1550 ;; Eval default value provided. If keyword is a member
1551 ;; of `org-element-parsed-keywords', parse it as
1552 ;; a secondary string before storing it.
1559 all)
1560 ;; Return value.
1561 plist))
1565 "Can we use #+BIND values during export?
1566 By default this will ask for confirmation by the user, to divert
1567 possible security risks."
1572 org-export--allow-BIND-local)
1577 "Install the values from #+BIND lines as local variables.
1578 Variables must be installed before in-buffer options are
1579 retrieved."
1594 ;;;; Tree Properties
1595 ;;
1596 ;; Tree properties are infromation extracted from parse tree. They
1597 ;; are initialized at the beginning of the transcoding process by
1598 ;; `org-export-collect-tree-properties'.
1599 ;;
1600 ;; Dedicated functions focus on computing the value of specific tree
1601 ;; properties during initialization. Thus,
1602 ;; `org-export--populate-ignore-list' lists elements and objects that
1603 ;; should be skipped during export, `org-export--get-min-level' gets
1604 ;; the minimal exportable level, used as a basis to compute relative
1605 ;; level for headlines. Eventually
1606 ;; `org-export--collect-headline-numbering' builds an alist between
1607 ;; headlines and their numbering.
1610 "Extract tree properties from parse tree.
1612 DATA is the parse tree from which information is retrieved. INFO
1613 is a list holding export options.
1615 Following tree properties are set or updated:
1617 `:exported-data' Hash table used to memoize results from
1618 `org-export-data'.
1620 `:footnote-definition-alist' List of footnotes definitions in
1621 original buffer and current parse tree.
1623 `:headline-offset' Offset between true level of headlines and
1624 local level. An offset of -1 means an headline
1625 of level 2 should be considered as a level
1626 1 headline in the context.
1628 `:headline-numbering' Alist of all headlines as key an the
1629 associated numbering as value.
1631 `:ignore-list' List of elements that should be ignored during
1632 export.
1634 `:target-list' List of all targets in the parse tree.
1636 Return updated plist."
1637 ;; Install the parse tree in the communication channel, in order to
1638 ;; use `org-export-get-genealogy' and al.
1640 ;; Get the list of elements and objects to ignore, and put it into
1641 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1642 ;; been done during parse tree filtering.
1645 :ignore-list
1648 ;; Compute `:headline-offset' in order to be able to use
1649 ;; `org-export-get-relative-level'.
1652 :headline-offset
1654 ;; Update footnotes definitions list with definitions in parse tree.
1655 ;; This is required since buffer expansion might have modified
1656 ;; boundaries of footnote definitions contained in the parse tree.
1657 ;; This way, definitions in `footnote-definition-alist' are bound to
1658 ;; match those in the parse tree.
1661 data 'footnote-definition
1665 defs)))
1667 ;; Properties order doesn't matter: get the rest of the tree
1668 ;; properties.
1670 `(:target-list
1679 info))
1682 "Return minimum exportable headline's level in DATA.
1683 DATA is parsed tree as returned by `org-element-parse-buffer'.
1684 OPTIONS is a plist holding export options."
1695 ;; If no headline was found, for the sake of consistency, set
1696 ;; minimum level to 1 nonetheless.
1700 "Return numbering of all exportable headlines in a parse tree.
1702 DATA is the parse tree. OPTIONS is the plist holding export
1703 options.
1705 Return an alist whose key is an headline and value is its
1706 associated numbering \(in the shape of a list of numbers\)."
1709 data
1710 'headline
1715 headline
1717 for idx from 0 to org-export-max-depth
1721 options)))
1724 "Return list of elements and objects to ignore during export.
1725 DATA is the parse tree to traverse. OPTIONS is the plist holding
1726 export options."
1728 walk-data
1729 ;; First find trees containing a select tag, if any.
1733 ;; Collect ignored elements or objects into IGNORE-LIST.
1739 ;; If headline is archived but tree below has
1740 ;; to be skipped, add it to ignore list.
1743 ;; Move into secondary string, if any.
1748 ;; Move into recursive objects/elements.
1750 ;; Main call.
1752 ;; Return value.
1753 ignore))
1756 "Return list of headlines containing a select tag in their tree.
1757 DATA is parsed data as returned by `org-element-parse-buffer'.
1758 INFO is a plist holding export options."
1760 walk-data ; for byte-compiler.
1771 ;; When a select tag is found, mark full
1772 ;; genealogy and every headline within the tree
1773 ;; as acceptable.
1776 genealogy
1778 selected-trees))
1779 ;; Else, continue searching in tree, recursively.
1786 "Non-nil when element or object BLOB should be skipped during export.
1787 OPTIONS is the plist holding export options. SELECTED, when
1788 non-nil, is a list of headlines belonging to a tree with a select
1789 tag."
1804 ;; Ignore subtrees with an exclude tag.
1807 ;; When a select tag is present in the buffer, ignore any tree
1808 ;; without it.
1810 ;; Ignore commented sub-trees.
1812 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1814 ;; Ignore tasks, if specified by `:with-tasks' property.
1830 ;; No timestamp allowed.
1832 ;; Only active timestamps allowed and the current one isn't
1833 ;; active.
1837 ;; Only inactive timestamps allowed and the current one isn't
1838 ;; inactive.
1844 \f
1845 ;;; The Transcoder
1846 ;;
1847 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1848 ;; `org-element-parse-buffer') and transcodes it into a specified
1849 ;; back-end output. It takes care of filtering out elements or
1850 ;; objects according to export options and organizing the output blank
1851 ;; lines and white space are preserved. The function memoizes its
1852 ;; results, so it is cheap to call it within translators.
1853 ;;
1854 ;; Internally, three functions handle the filtering of objects and
1855 ;; elements during the export. In particular,
1856 ;; `org-export-ignore-element' marks an element or object so future
1857 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1858 ;; elements or objects should be seen as real Org syntax and
1859 ;; `org-export-expand' transforms the others back into their original
1860 ;; shape
1861 ;;
1862 ;; `org-export-transcoder' is an accessor returning appropriate
1863 ;; translator function for a given element or object.
1866 "Return appropriate transcoder for BLOB.
1867 INFO is a plist containing export directives."
1869 ;; Return contents only for complete parse trees.
1875 "Convert DATA into current back-end format.
1877 DATA is a parse tree, an element or an object or a secondary
1878 string. INFO is a plist holding export options.
1880 Return transcoded string."
1886 ;; Ignored element/object.
1888 ;; Plain text.
1894 info))
1895 ;; Uninterpreted element/object: change it back to Org
1896 ;; syntax and export again resulting raw string.
1900 data
1904 info))
1905 ;; Secondary string.
1908 ;; Element/Object without contents or, as a special case,
1909 ;; headline with archive tag and archived trees restricted
1910 ;; to title only.
1918 ;; Element/Object with contents.
1931 ;; Elements directly containing objects
1932 ;; must have their indentation normalized
1933 ;; first.
1935 data
1936 ;; When normalizing contents of the first
1937 ;; paragraph in an item or a footnote
1938 ;; definition, ignore first line's
1939 ;; indentation: there is none and it
1940 ;; might be misleading.
1945 data)
1952 info))))))))
1953 ;; Final result will be memoized before being returned.
1955 data
1959 ;; Append the same white space between elements or objects as in
1960 ;; the original buffer, and call appropriate filters.
1971 info)))
1972 results)))
1976 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1977 Check is done according to export options INFO, stored as
1978 a plist."
1980 ;; ... entities...
1982 ;; ... emphasis...
1984 ;; ... fixed-width areas.
1986 ;; ... footnotes...
1989 ;; ... sub/superscripts...
1995 ;; ... tables...
2000 "Expand a parsed element or object to its original state.
2001 BLOB is either an element or an object. CONTENTS is its
2002 contents, as a string or nil."
2005 blob contents))
2008 "Add ELEMENT to `:ignore-list' in INFO.
2010 Any element in `:ignore-list' will be skipped when using
2011 `org-element-map'. INFO is modified by side effects."
2015 \f
2016 ;;; The Filter System
2017 ;;
2018 ;; Filters allow end-users to tweak easily the transcoded output.
2019 ;; They are the functional counterpart of hooks, as every filter in
2020 ;; a set is applied to the return value of the previous one.
2021 ;;
2022 ;; Every set is back-end agnostic. Although, a filter is always
2023 ;; called, in addition to the string it applies to, with the back-end
2024 ;; used as argument, so it's easy for the end-user to add back-end
2025 ;; specific filters in the set. The communication channel, as
2026 ;; a plist, is required as the third argument.
2027 ;;
2028 ;; From the developer side, filters sets can be installed in the
2029 ;; process with the help of `org-export-define-backend', which
2030 ;; internally sets `org-BACKEND-filters-alist' variable. Each
2031 ;; association has a key among the following symbols and a function or
2032 ;; a list of functions as value.
2033 ;;
2034 ;; - `:filter-parse-tree' applies directly on the complete parsed
2035 ;; tree. It's the only filters set that doesn't apply to a string.
2036 ;; Users can set it through `org-export-filter-parse-tree-functions'
2037 ;; variable.
2038 ;;
2039 ;; - `:filter-final-output' applies to the final transcoded string.
2040 ;; Users can set it with `org-export-filter-final-output-functions'
2041 ;; variable
2042 ;;
2043 ;; - `:filter-plain-text' applies to any string not recognized as Org
2044 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2045 ;; configure it.
2046 ;;
2047 ;; - `:filter-TYPE' applies on the string returned after an element or
2048 ;; object of type TYPE has been transcoded. An user can modify
2049 ;; `org-export-filter-TYPE-functions'
2050 ;;
2051 ;; All filters sets are applied with
2052 ;; `org-export-filter-apply-functions' function. Filters in a set are
2053 ;; applied in a LIFO fashion. It allows developers to be sure that
2054 ;; their filters will be applied first.
2055 ;;
2056 ;; Filters properties are installed in communication channel with
2057 ;; `org-export-install-filters' function.
2058 ;;
2059 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
2060 ;; before parsing to allow for heavy structure modifications.
2063 ;;;; Before Parsing Hook
2066 "Hook run before parsing an export buffer.
2068 This is run after include keywords have been expanded and Babel
2069 code executed, on a copy of original buffer's area being
2070 exported. Visibility is the same as in the original one. Point
2071 is left at the beginning of the new one.
2073 Every function in this hook will be called with one argument: the
2077 ;;;; Special Filters
2080 "List of functions applied to the parsed tree.
2081 Each filter is called with three arguments: the parse tree, as
2082 returned by `org-element-parse-buffer', the back-end, as
2083 a symbol, and the communication channel, as a plist. It must
2087 "List of functions applied to the transcoded string.
2088 Each filter is called with three arguments: the full transcoded
2089 string, the back-end, as a symbol, and the communication channel,
2090 as a plist. It must return a string that will be used as the
2094 "List of functions applied to plain text.
2095 Each filter is called with three arguments: a string which
2096 contains no Org syntax, the back-end, as a symbol, and the
2097 communication channel, as a plist. It must return a string or
2101 ;;;; Elements Filters
2104 "List of functions applied to a transcoded center block.
2105 Each filter is called with three arguments: the transcoded data,
2106 as a string, the back-end, as a symbol, and the communication
2110 "List of functions applied to a transcoded clock.
2111 Each filter is called with three arguments: the transcoded data,
2112 as a string, the back-end, as a symbol, and the communication
2116 "List of functions applied to a transcoded drawer.
2117 Each filter is called with three arguments: the transcoded data,
2118 as a string, the back-end, as a symbol, and the communication
2122 "List of functions applied to a transcoded dynamic-block.
2123 Each filter is called with three arguments: the transcoded data,
2124 as a string, the back-end, as a symbol, and the communication
2128 "List of functions applied to a transcoded headline.
2129 Each filter is called with three arguments: the transcoded data,
2130 as a string, the back-end, as a symbol, and the communication
2134 "List of functions applied to a transcoded inlinetask.
2135 Each filter is called with three arguments: the transcoded data,
2136 as a string, the back-end, as a symbol, and the communication
2140 "List of functions applied to a transcoded plain-list.
2141 Each filter is called with three arguments: the transcoded data,
2142 as a string, the back-end, as a symbol, and the communication
2146 "List of functions applied to a transcoded item.
2147 Each filter is called with three arguments: the transcoded data,
2148 as a string, the back-end, as a symbol, and the communication
2152 "List of functions applied to a transcoded comment.
2153 Each filter is called with three arguments: the transcoded data,
2154 as a string, the back-end, as a symbol, and the communication
2158 "List of functions applied to a transcoded comment-comment.
2159 Each filter is called with three arguments: the transcoded data,
2160 as a string, the back-end, as a symbol, and the communication
2164 "List of functions applied to a transcoded example-block.
2165 Each filter is called with three arguments: the transcoded data,
2166 as a string, the back-end, as a symbol, and the communication
2170 "List of functions applied to a transcoded export-block.
2171 Each filter is called with three arguments: the transcoded data,
2172 as a string, the back-end, as a symbol, and the communication
2176 "List of functions applied to a transcoded fixed-width.
2177 Each filter is called with three arguments: the transcoded data,
2178 as a string, the back-end, as a symbol, and the communication
2182 "List of functions applied to a transcoded footnote-definition.
2183 Each filter is called with three arguments: the transcoded data,
2184 as a string, the back-end, as a symbol, and the communication
2188 "List of functions applied to a transcoded horizontal-rule.
2189 Each filter is called with three arguments: the transcoded data,
2190 as a string, the back-end, as a symbol, and the communication
2194 "List of functions applied to a transcoded keyword.
2195 Each filter is called with three arguments: the transcoded data,
2196 as a string, the back-end, as a symbol, and the communication
2200 "List of functions applied to a transcoded latex-environment.
2201 Each filter is called with three arguments: the transcoded data,
2202 as a string, the back-end, as a symbol, and the communication
2206 "List of functions applied to a transcoded babel-call.
2207 Each filter is called with three arguments: the transcoded data,
2208 as a string, the back-end, as a symbol, and the communication
2212 "List of functions applied to a transcoded node-property.
2213 Each filter is called with three arguments: the transcoded data,
2214 as a string, the back-end, as a symbol, and the communication
2218 "List of functions applied to a transcoded paragraph.
2219 Each filter is called with three arguments: the transcoded data,
2220 as a string, the back-end, as a symbol, and the communication
2224 "List of functions applied to a transcoded planning.
2225 Each filter is called with three arguments: the transcoded data,
2226 as a string, the back-end, as a symbol, and the communication
2230 "List of functions applied to a transcoded property-drawer.
2231 Each filter is called with three arguments: the transcoded data,
2232 as a string, the back-end, as a symbol, and the communication
2236 "List of functions applied to a transcoded quote block.
2237 Each filter is called with three arguments: the transcoded quote
2238 data, as a string, the back-end, as a symbol, and the
2239 communication channel, as a plist. It must return a string or
2243 "List of functions applied to a transcoded quote-section.
2244 Each filter is called with three arguments: the transcoded data,
2245 as a string, the back-end, as a symbol, and the communication
2249 "List of functions applied to a transcoded section.
2250 Each filter is called with three arguments: the transcoded data,
2251 as a string, the back-end, as a symbol, and the communication
2255 "List of functions applied to a transcoded special block.
2256 Each filter is called with three arguments: the transcoded data,
2257 as a string, the back-end, as a symbol, and the communication
2261 "List of functions applied to a transcoded src-block.
2262 Each filter is called with three arguments: the transcoded data,
2263 as a string, the back-end, as a symbol, and the communication
2267 "List of functions applied to a transcoded table.
2268 Each filter is called with three arguments: the transcoded data,
2269 as a string, the back-end, as a symbol, and the communication
2273 "List of functions applied to a transcoded table-cell.
2274 Each filter is called with three arguments: the transcoded data,
2275 as a string, the back-end, as a symbol, and the communication
2279 "List of functions applied to a transcoded table-row.
2280 Each filter is called with three arguments: the transcoded data,
2281 as a string, the back-end, as a symbol, and the communication
2285 "List of functions applied to a transcoded verse block.
2286 Each filter is called with three arguments: the transcoded data,
2287 as a string, the back-end, as a symbol, and the communication
2291 ;;;; Objects Filters
2294 "List of functions applied to transcoded bold text.
2295 Each filter is called with three arguments: the transcoded data,
2296 as a string, the back-end, as a symbol, and the communication
2300 "List of functions applied to transcoded code text.
2301 Each filter is called with three arguments: the transcoded data,
2302 as a string, the back-end, as a symbol, and the communication
2306 "List of functions applied to a transcoded entity.
2307 Each filter is called with three arguments: the transcoded data,
2308 as a string, the back-end, as a symbol, and the communication
2312 "List of functions applied to a transcoded export-snippet.
2313 Each filter is called with three arguments: the transcoded data,
2314 as a string, the back-end, as a symbol, and the communication
2318 "List of functions applied to a transcoded footnote-reference.
2319 Each filter is called with three arguments: the transcoded data,
2320 as a string, the back-end, as a symbol, and the communication
2324 "List of functions applied to a transcoded inline-babel-call.
2325 Each filter is called with three arguments: the transcoded data,
2326 as a string, the back-end, as a symbol, and the communication
2330 "List of functions applied to a transcoded inline-src-block.
2331 Each filter is called with three arguments: the transcoded data,
2332 as a string, the back-end, as a symbol, and the communication
2336 "List of functions applied to transcoded italic text.
2337 Each filter is called with three arguments: the transcoded data,
2338 as a string, the back-end, as a symbol, and the communication
2342 "List of functions applied to a transcoded latex-fragment.
2343 Each filter is called with three arguments: the transcoded data,
2344 as a string, the back-end, as a symbol, and the communication
2348 "List of functions applied to a transcoded line-break.
2349 Each filter is called with three arguments: the transcoded data,
2350 as a string, the back-end, as a symbol, and the communication
2354 "List of functions applied to a transcoded link.
2355 Each filter is called with three arguments: the transcoded data,
2356 as a string, the back-end, as a symbol, and the communication
2360 "List of functions applied to a transcoded macro.
2361 Each filter is called with three arguments: the transcoded data,
2362 as a string, the back-end, as a symbol, and the communication
2366 "List of functions applied to a transcoded radio-target.
2367 Each filter is called with three arguments: the transcoded data,
2368 as a string, the back-end, as a symbol, and the communication
2372 "List of functions applied to a transcoded statistics-cookie.
2373 Each filter is called with three arguments: the transcoded data,
2374 as a string, the back-end, as a symbol, and the communication
2378 "List of functions applied to transcoded strike-through text.
2379 Each filter is called with three arguments: the transcoded data,
2380 as a string, the back-end, as a symbol, and the communication
2384 "List of functions applied to a transcoded subscript.
2385 Each filter is called with three arguments: the transcoded data,
2386 as a string, the back-end, as a symbol, and the communication
2390 "List of functions applied to a transcoded superscript.
2391 Each filter is called with three arguments: the transcoded data,
2392 as a string, the back-end, as a symbol, and the communication
2396 "List of functions applied to a transcoded target.
2397 Each filter is called with three arguments: the transcoded data,
2398 as a string, the back-end, as a symbol, and the communication
2402 "List of functions applied to a transcoded timestamp.
2403 Each filter is called with three arguments: the transcoded data,
2404 as a string, the back-end, as a symbol, and the communication
2408 "List of functions applied to transcoded underline text.
2409 Each filter is called with three arguments: the transcoded data,
2410 as a string, the back-end, as a symbol, and the communication
2414 "List of functions applied to transcoded verbatim text.
2415 Each filter is called with three arguments: the transcoded data,
2416 as a string, the back-end, as a symbol, and the communication
2420 ;;;; Filters Tools
2421 ;;
2422 ;; Internal function `org-export-install-filters' installs filters
2423 ;; hard-coded in back-ends (developer filters) and filters from global
2424 ;; variables (user filters) in the communication channel.
2425 ;;
2426 ;; Internal function `org-export-filter-apply-functions' takes care
2427 ;; about applying each filter in order to a given data. It ignores
2428 ;; filters returning a nil value but stops whenever a filter returns
2429 ;; an empty string.
2432 "Call every function in FILTERS.
2434 Functions are called with arguments VALUE, current export
2435 back-end and INFO. A function returning a nil value will be
2436 skipped. If it returns the empty string, the process ends and
2437 VALUE is ignored.
2439 Call is done in a LIFO fashion, to be sure that developer
2440 specified filters, if any, are called first."
2449 "Install filters properties in communication channel.
2451 INFO is a plist containing the current communication channel.
2453 Return the updated communication channel."
2455 ;; Install user defined filters with `org-export-filters-alist'.
2458 org-export-filters-alist)
2459 ;; Prepend back-end specific filters to that list.
2464 ;; Single values get consed, lists are prepended.
2469 plist key
2473 ;; Return new communication channel.
2477 \f
2478 ;;; Core functions
2479 ;;
2480 ;; This is the room for the main function, `org-export-as', along with
2481 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2482 ;; They differ only by the way they output the resulting code.
2483 ;;
2484 ;; `org-export-output-file-name' is an auxiliary function meant to be
2485 ;; used with `org-export-to-file'. With a given extension, it tries
2486 ;; to provide a canonical file name to write export output to.
2487 ;;
2488 ;; Note that `org-export-as' doesn't really parse the current buffer,
2489 ;; but a copy of it (with the same buffer-local variables and
2490 ;; visibility), where macros and include keywords are expanded and
2491 ;; Babel blocks are executed, if appropriate.
2492 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2493 ;;
2494 ;; File inclusion is taken care of by
2495 ;; `org-export-expand-include-keyword' and
2496 ;; `org-export--prepare-file-contents'. Structure wise, including
2497 ;; a whole Org file in a buffer often makes little sense. For
2498 ;; example, if the file contains an headline and the include keyword
2499 ;; was within an item, the item should contain the headline. That's
2500 ;; why file inclusion should be done before any structure can be
2501 ;; associated to the file, that is before parsing.
2505 "Transcode current Org buffer into BACKEND code.
2507 If narrowing is active in the current buffer, only transcode its
2508 narrowed part.
2510 If a region is active, transcode that region.
2512 When optional argument SUBTREEP is non-nil, transcode the
2513 sub-tree at point, extracting information from the headline
2514 properties first.
2516 When optional argument VISIBLE-ONLY is non-nil, don't export
2517 contents of hidden elements.
2519 When optional argument BODY-ONLY is non-nil, only return body
2520 code, without preamble nor postamble.
2522 Optional argument EXT-PLIST, when provided, is a property list
2523 with external parameters overriding Org default settings, but
2524 still inferior to file-local settings.
2526 Optional argument NOEXPAND, when non-nil, prevents included files
2527 to be expanded and Babel code to be executed.
2529 Return code as a string."
2532 ;; Narrow buffer to an appropriate region or subtree for
2533 ;; parsing. If parsing subtree, be sure to remove main headline
2534 ;; too.
2542 ;; 1. Get export environment from original buffer. Also install
2543 ;; user's and developer's filters.
2546 ;; 2. Get parse tree. Buffer isn't parsed directly.
2547 ;; Instead, a temporary copy is created, where macros
2548 ;; and include keywords are expanded and code blocks
2549 ;; are evaluated.
2556 ;; TODO: Setting `org-current-export-file' is
2557 ;; required by Org Babel to properly resolve
2558 ;; noweb references. Once "org-exp.el" is
2559 ;; removed, modify
2560 ;; `org-export-blocks-preprocess' so it accepts
2561 ;; the value as an argument instead.
2565 ;; Run hook
2566 ;; `org-export-before-parsing-hook'. with current
2567 ;; back-end as argument.
2570 ;; Eventually parse buffer.
2572 ;; 3. Call parse-tree filters to get the final tree.
2576 ;; 4. Now tree is complete, compute its properties and add
2577 ;; them to communication channel.
2581 ;; 5. Eventually transcode TREE. Wrap the resulting string
2582 ;; into a template, if required. Eventually call
2583 ;; final-output filter.
2591 info)))
2592 ;; Maybe add final OUTPUT to kill ring, then return it.
2594 output)))))
2598 "Call `org-export-as' with output to a specified buffer.
2600 BACKEND is the back-end used for transcoding, as a symbol.
2602 BUFFER is the output buffer. If it already exists, it will be
2603 erased first, otherwise, it will be created.
2605 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2606 and NOEXPAND are similar to those used in `org-export-as', which
2607 see.
2609 Return buffer."
2611 backend subtreep visible-only body-only ext-plist noexpand))
2617 buffer))
2621 "Call `org-export-as' with output to a specified file.
2623 BACKEND is the back-end used for transcoding, as a symbol. FILE
2624 is the name of the output file, as a string.
2626 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2627 and NOEXPAND are similar to those used in `org-export-as', which
2628 see.
2630 Return output file's name."
2631 ;; Checks for FILE permissions. `write-file' would do the same, but
2632 ;; we'd rather avoid needless transcoding of parse tree.
2634 ;; Insert contents to a temporary buffer and write it to FILE.
2636 backend subtreep visible-only body-only ext-plist noexpand)))
2641 ;; Return full path.
2642 file)
2645 "Return output file's name according to buffer specifications.
2647 EXTENSION is a string representing the output file extension,
2648 with the leading dot.
2650 With a non-nil optional argument SUBTREEP, try to determine
2652 of subtree at point.
2654 When optional argument PUB-DIR is set, use it as the publishing
2655 directory.
2657 When optional argument VISIBLE-ONLY is non-nil, don't export
2658 contents of hidden elements.
2660 Return file name as a string, or nil if it couldn't be
2661 determined."
2663 ;; File name may come from EXPORT_FILE_NAME subtree property,
2664 ;; assuming point is at beginning of said sub-tree.
2671 ;; File name may be extracted from buffer's associated
2672 ;; file, if any.
2674 ;; Can't determine file name on our own: Ask user.
2678 "Output file: " pub-dir nil nil nil
2681 ;; Build file name. Enforce EXTENSION over whatever user may have
2682 ;; come up with. PUB-DIR, if defined, always has precedence over
2683 ;; any provided path.
2688 extension))
2694 "Apply BODY in a copy of the current buffer.
2696 The copy preserves local variables and visibility of the original
2697 buffer.
2699 Point is at buffer's beginning when BODY is applied."
2709 ,original-buffer
2714 ov
2724 "Expand every include keyword in buffer.
2725 Optional argument INCLUDED is a list of included file names along
2726 with their line restriction, when appropriate. It is used to
2727 avoid infinite recursion. Optional argument DIR is the current
2728 working directory. It is used to properly resolve relative
2729 paths."
2736 ;; Extract arguments from keyword's value.
2750 ;; Minimal level of included file defaults to the child
2751 ;; level of the current headline, if any, or one. It
2752 ;; only applies is the file is meant to be included as
2753 ;; an Org one.
2761 ;; Remove keyword.
2765 ;; Check if files has already been parsed. Look after
2766 ;; inclusion lines too, as different parts of the same file
2767 ;; can be included too.
2776 ;; Protect sensitive contents with commas.
2782 ind-str contents ind-str))))
2787 ;; Protect sensitive contents with commas.
2794 ind-str env contents ind-str))))
2807 "Prepare the contents of FILE for inclusion and return them as a string.
2809 When optional argument LINES is a string specifying a range of
2810 lines, include only those lines.
2812 Optional argument IND, when non-nil, is an integer specifying the
2813 global indentation of returned contents. Since its purpose is to
2814 allow an included file to stay in the same environment it was
2815 created \(i.e. a list item), it doesn't apply past the first
2816 headline encountered.
2818 Optional argument MINLEVEL, when non-nil, is an integer
2819 specifying the level that any top-level headline in the included
2820 file should have."
2836 ;; Remove blank lines at beginning and end of contents. The logic
2837 ;; behind that removal is that blank lines around include keyword
2838 ;; override blank lines in included file.
2847 ;; If IND is set, preserve indentation of include keyword until
2848 ;; the first headline encountered.
2854 ;; Do not move footnote definitions out of column 0.
2860 ;; When MINLEVEL is specified, compute minimal level for headlines
2861 ;; in the file (CUR-MIN), and remove stars to each headline so
2862 ;; that headlines with minimal level have a level of MINLEVEL.
2871 ;; Only change stars, don't bother moving whole
2872 ;; sections.
2878 \f
2879 ;;; Tools For Back-Ends
2880 ;;
2881 ;; A whole set of tools is available to help build new exporters. Any
2882 ;; function general enough to have its use across many back-ends
2883 ;; should be added here.
2885 ;;;; For Affiliated Keywords
2886 ;;
2887 ;; `org-export-read-attribute' reads a property from a given element
2888 ;; as a plist. It can be used to normalize affiliated keywords'
2889 ;; syntax.
2890 ;;
2891 ;; Since captions can span over multiple lines and accept dual values,
2892 ;; their internal representation is a bit tricky. Therefore,
2893 ;; `org-export-get-caption' transparently returns a given element's
2894 ;; caption as a secondary string.
2897 "Turn ATTRIBUTE property from ELEMENT into a plist.
2899 When optional argument PROPERTY is non-nil, return the value of
2900 that property within attributes.
2904 properties."
2912 "Return caption from ELEMENT as a secondary string.
2914 When optional argument SHORTP is non-nil, return short caption,
2915 as a secondary string, instead.
2917 Caption lines are separated by a white space."
2925 ;;;; For Export Snippets
2926 ;;
2927 ;; Every export snippet is transmitted to the back-end. Though, the
2928 ;; latter will only retain one type of export-snippet, ignoring
2929 ;; others, based on the former's target back-end. The function
2930 ;; `org-export-snippet-backend' returns that back-end for a given
2931 ;; export-snippet.
2934 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2935 Translation, with `org-export-snippet-translation-alist', is
2936 applied."
2940 back-end))))
2943 ;;;; For Footnotes
2944 ;;
2945 ;; `org-export-collect-footnote-definitions' is a tool to list
2946 ;; actually used footnotes definitions in the whole parse tree, or in
2947 ;; an headline, in order to add footnote listings throughout the
2948 ;; transcoded data.
2949 ;;
2950 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2951 ;; back-ends, when they need to attach the footnote definition only to
2952 ;; the first occurrence of the corresponding label.
2953 ;;
2954 ;; `org-export-get-footnote-definition' and
2955 ;; `org-export-get-footnote-number' provide easier access to
2956 ;; additional information relative to a footnote reference.
2959 "Return an alist between footnote numbers, labels and definitions.
2961 DATA is the parse tree from which definitions are collected.
2962 INFO is the plist used as a communication channel.
2964 Definitions are sorted by order of references. They either
2965 appear as Org data or as a secondary string for inlined
2966 footnotes. Unreferenced definitions are ignored."
2968 collect-fn ; for byte-compiler.
2972 ;; Collect footnote number, label and definition in DATA.
2974 data 'footnote-reference
2981 def)
2982 num-alist)
2983 ;; Also search in definition for nested footnotes.
2986 ;; Don't enter footnote definitions since it will happen
2987 ;; when their first reference is found.
2993 "Non-nil when a footnote reference is the first one for its label.
2995 FOOTNOTE-REFERENCE is the footnote reference being considered.
2996 INFO is the plist used as a communication channel."
2998 ;; Anonymous footnotes are always a first reference.
3000 ;; Otherwise, return the first footnote with the same LABEL and
3001 ;; test if it is equal to FOOTNOTE-REFERENCE.
3007 data 'footnote-reference
3012 ;; If FN isn't inlined, be sure to traverse its
3013 ;; definition before resuming search. See
3014 ;; comments in `org-export-get-footnote-number'
3015 ;; for more information.
3019 ;; Don't enter footnote definitions since it will
3020 ;; happen when their first reference is found.
3023 footnote-reference)))))
3026 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3027 INFO is the plist used as a communication channel."
3033 "Return number associated to a footnote.
3035 FOOTNOTE is either a footnote reference or a footnote definition.
3036 INFO is the plist used as a communication channel."
3038 seen-refs
3039 search-ref ; For byte-compiler.
3043 ;; Search footnote references through DATA, filling
3044 ;; SEEN-REFS along the way.
3046 data 'footnote-reference
3050 ;; Anonymous footnote match: return number.
3053 ;; Labels match: return number.
3056 ;; Anonymous footnote: it's always a new one. Also,
3057 ;; be sure to return nil from the `cond' so
3058 ;; `first-match' doesn't get us out of the loop.
3060 ;; Label not seen so far: add it so SEEN-REFS.
3061 ;;
3062 ;; Also search for subsequent references in
3063 ;; footnote definition so numbering follows reading
3064 ;; logic. Note that we don't have to care about
3065 ;; inline definitions, since `org-element-map'
3066 ;; already traverses them at the right time.
3067 ;;
3068 ;; Once again, return nil to stay in the loop.
3073 nil))))
3074 ;; Don't enter footnote definitions since it will happen
3075 ;; when their first reference is found.
3080 ;;;; For Headlines
3081 ;;
3082 ;; `org-export-get-relative-level' is a shortcut to get headline
3083 ;; level, relatively to the lower headline level in the parsed tree.
3084 ;;
3085 ;; `org-export-get-headline-number' returns the section number of an
3086 ;; headline, while `org-export-number-to-roman' allows to convert it
3087 ;; to roman numbers.
3088 ;;
3089 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3090 ;; `org-export-last-sibling-p' are three useful predicates when it
3091 ;; comes to fulfill the `:headline-levels' property.
3094 "Return HEADLINE relative level within current parsed tree.
3095 INFO is a plist holding contextual information."
3100 "Non-nil when HEADLINE is considered as low level.
3102 INFO is a plist used as a communication channel.
3104 A low level headlines has a relative level greater than
3105 `:headline-levels' property value.
3107 Return value is the difference between HEADLINE relative level
3108 and the last level being considered as high enough, or nil."
3115 "Return HEADLINE numbering as a list of numbers.
3116 INFO is a plist holding contextual information."
3120 "Return a non-nil value if HEADLINE element should be numbered.
3121 INFO is a plist used as a communication channel."
3127 "Convert integer N into a roman numeral."
3140 res)))
3143 "Return list of tags associated to ELEMENT.
3145 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3146 is a plist used as a communication channel.
3148 Select tags (see `org-export-select-tags') and exclude tags (see
3149 `org-export-exclude-tags') are removed from the list.
3151 When non-nil, optional argument TAGS should be a list of strings.
3152 Any tag belonging to this list will also be removed."
3159 "Return node PROPERTY value for BLOB.
3161 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3162 element or object.
3164 If optional argument INHERITED is non-nil, the value can be
3165 inherited from a parent headline.
3167 Return value is a string or nil."
3179 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3180 INFO is a plist used as a communication channel."
3185 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3186 INFO is a plist used as a communication channel."
3190 ;;;; For Links
3191 ;;
3192 ;; `org-export-solidify-link-text' turns a string into a safer version
3193 ;; for links, replacing most non-standard characters with hyphens.
3194 ;;
3195 ;; `org-export-get-coderef-format' returns an appropriate format
3196 ;; string for coderefs.
3197 ;;
3198 ;; `org-export-inline-image-p' returns a non-nil value when the link
3199 ;; provided should be considered as an inline image.
3200 ;;
3201 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3202 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3203 ;; returns an appropriate unique identifier when found, or nil.
3204 ;;
3205 ;; `org-export-resolve-id-link' returns the first headline with
3206 ;; specified id or custom-id in parse tree, the path to the external
3207 ;; file with the id or nil when neither was found.
3208 ;;
3209 ;; `org-export-resolve-coderef' associates a reference to a line
3210 ;; number in the element it belongs, or returns the reference itself
3211 ;; when the element isn't numbered.
3214 "Take link text S and make a safe target out of it."
3219 "Return format string for code reference link.
3220 PATH is the link path. DESC is its description."
3228 "Non-nil if LINK object points to an inline image.
3230 Optional argument is a set of RULES defining inline images. It
3231 is an alist where associations have the following shape:
3233 \(TYPE . REGEXP)
3235 Applying a rule means apply REGEXP against LINK's path when its
3236 type is TYPE. The function will return a non-nil value if any of
3237 the provided rules is non-nil. The default rule is
3238 `org-export-default-inline-image-rule'.
3240 This only applies to links without a description."
3251 rules)
3252 ;; Return nil if no rule matched.
3253 nil))))
3256 "Resolve a code reference REF.
3258 INFO is a plist used as a communication channel.
3260 Return associated line number in source code, or REF itself,
3261 depending on src-block or example element's switches."
3269 org-coderef-label-format)))
3273 ;; Element containing REF is found. Resolve it to either
3274 ;; a label or a line number, as needed.
3284 "Return LINK destination.
3286 INFO is a plist holding contextual information.
3288 Return value can be an object, an element, or nil:
3290 - If LINK path matches a target object (i.e. <<path>>) or
3293 - If LINK path exactly matches the name affiliated keyword
3294 \(i.e. #+NAME: path) of an element, return that element.
3296 - If LINK path exactly matches any headline name, return that
3297 element. If more than one headline share that name, priority
3298 will be given to the one with the closest common ancestor, if
3299 any, or the first one in the parse tree otherwise.
3301 - Otherwise, return nil.
3307 ;; First try to find a matching "<<path>>" unless user specified
3308 ;; he was looking for an headline (path starts with a *
3309 ;; character).
3313 return target)))
3314 ;; Then try to find an element with a matching "#+NAME: path"
3315 ;; affiliated keyword.
3322 ;; Last case: link either points to an headline or to
3323 ;; nothingness. Try to find the source, with priority given to
3324 ;; headlines with the closest common ancestor. If such candidate
3325 ;; is found, return it, otherwise return nil.
3329 ;; Return first headline whose `:raw-value' property
3330 ;; is NAME in parse tree DATA, or nil.
3333 data 'headline
3337 name)
3338 headline))
3340 ;; Search among headlines sharing an ancestor with link,
3341 ;; from closest to farthest.
3349 ;; No match with a common ancestor: try the full parse-tree.
3355 "Return headline referenced as LINK destination.
3357 INFO is a plist used as a communication channel.
3359 Return value can be the headline element matched in current parse
3363 ;; First check if id is within the current parse tree.
3369 headline))
3371 ;; Otherwise, look for external files.
3375 "Return radio-target object referenced as LINK destination.
3377 INFO is a plist used as a communication channel.
3379 Return value can be a radio-target object or nil. Assume LINK
3389 ;;;; For References
3390 ;;
3391 ;; `org-export-get-ordinal' associates a sequence number to any object
3392 ;; or element.
3395 "Return ordinal number of an element or object.
3397 ELEMENT is the element or object considered. INFO is the plist
3398 used as a communication channel.
3400 Optional argument TYPES, when non-nil, is a list of element or
3401 object types, as symbols, that should also be counted in.
3402 Otherwise, only provided element's type is considered.
3404 Optional argument PREDICATE is a function returning a non-nil
3405 value if the current element or object should be counted in. It
3406 accepts two arguments: the element or object being considered and
3407 the plist used as a communication channel. This allows to count
3408 only a certain type of objects (i.e. inline images).
3410 Return value is a list of numbers if ELEMENT is an headline or an
3411 item. It is nil for keywords. It represents the footnote number
3412 for footnote definitions and footnote references. If ELEMENT is
3413 a target, return the same value as if ELEMENT was the closest
3414 table, item or headline containing the target. In any other
3415 case, return the sequence number of ELEMENT among elements or
3416 objects of the same type."
3417 ;; A target keyword, representing an invisible target, never has
3418 ;; a sequence number.
3420 ;; Ordinal of a target object refer to the ordinal of the closest
3421 ;; table, item, or headline containing the object.
3425 when
3429 table))
3430 return parent)))
3432 ;; Special case 1: An headline returns its number as a list.
3434 ;; Special case 2: An item returns its number as a list.
3438 struct
3445 ;; Increment counter until ELEMENT is found again.
3456 ;;;; For Src-Blocks
3457 ;;
3458 ;; `org-export-get-loc' counts number of code lines accumulated in
3459 ;; src-block or example-block elements with a "+n" switch until
3460 ;; a given element, excluded. Note: "-n" switches reset that count.
3461 ;;
3462 ;; `org-export-unravel-code' extracts source code (along with a code
3463 ;; references alist) from an `element-block' or `src-block' type
3464 ;; element.
3465 ;;
3466 ;; `org-export-format-code' applies a formatting function to each line
3467 ;; of code, providing relative line number and code reference when
3468 ;; appropriate. Since it doesn't access the original element from
3469 ;; which the source code is coming, it expects from the code calling
3470 ;; it to know if lines should be numbered and if code references
3471 ;; should appear.
3472 ;;
3473 ;; Eventually, `org-export-format-code-default' is a higher-level
3474 ;; function (it makes use of the two previous functions) which handles
3475 ;; line numbering and code references inclusion, and returns source
3476 ;; code in a format suitable for plain text or verbatim output.
3479 "Return accumulated lines of code up to ELEMENT.
3481 INFO is the plist used as a communication channel.
3483 ELEMENT is excluded from count."
3490 ;; ELEMENT is reached: Quit the loop.
3492 ;; Only count lines from src-block and example-block elements
3493 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3497 ;; Accumulate locs or reset them.
3501 ;; Return nil to stay in the loop.
3502 nil)))
3504 ;; Return value.
3505 loc))
3508 "Clean source code and extract references out of it.
3510 ELEMENT has either a `src-block' an `example-block' type.
3512 Return a cons cell whose CAR is the source code, cleaned from any
3513 reference and protective comma and CDR is an alist between
3514 relative line number (integer) and name of code reference on that
3515 line (string)."
3517 ;; Get code and clean it. Remove blank lines at its
3518 ;; beginning and end. Also remove protective commas.
3524 ;; If appropriate, remove global indentation.
3528 ;; Free up the protected lines. Note: Org blocks
3529 ;; have commas at the beginning or every line.
3534 ;; Get format used for references.
3537 org-coderef-label-format)))
3538 ;; Build a regexp matching a loc with a reference.
3543 ;; Return value.
3545 ;; Code with references removed.
3551 ;; Ref line: remove ref, and signal its position in REFS.
3555 ;; Reference alist.
3556 refs)))
3559 "Format CODE by applying FUN line-wise and return it.
3561 CODE is a string representing the code to format. FUN is
3562 a function. It must accept three arguments: a line of
3563 code (string), the current line number (integer) or nil and the
3564 reference associated to the current line (string) or nil.
3566 Optional argument NUM-LINES can be an integer representing the
3567 number of code lines accumulated until the current code. Line
3568 numbers passed to FUN will take it into account. If it is nil,
3569 FUN's second argument will always be nil. This number can be
3570 obtained with `org-export-get-loc' function.
3572 Optional argument REF-ALIST can be an alist between relative line
3573 number (i.e. ignoring NUM-LINES) and the name of the code
3574 reference on it. If it is nil, FUN's third argument will always
3575 be nil. It can be obtained through the use of
3576 `org-export-unravel-code' function."
3588 "Return source code from ELEMENT, formatted in a standard way.
3590 ELEMENT is either a `src-block' or `example-block' element. INFO
3591 is a plist used as a communication channel.
3593 This function takes care of line numbering and code references
3594 inclusion. Line numbers, when applicable, appear at the
3595 beginning of the line, separated from the code by two white
3596 spaces. Code references, on the other hand, appear flushed to
3597 the right, separated by six white spaces from the widest line of
3598 code."
3599 ;; Extract code and references.
3605 ;; Handle line numbering.
3614 ;; Prepare references display, if required. Any reference
3615 ;; should start six columns after the widest line of code,
3616 ;; wrapped with parenthesis.
3621 code
3625 number-str
3626 loc
3632 num-start refs)))
3635 ;;;; For Tables
3636 ;;
3637 ;; `org-export-table-has-special-column-p' and and
3638 ;; `org-export-table-row-is-special-p' are predicates used to look for
3639 ;; meta-information about the table structure.
3640 ;;
3641 ;; `org-table-has-header-p' tells when the rows before the first rule
3642 ;; should be considered as table's header.
3643 ;;
3644 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3645 ;; and `org-export-table-cell-borders' extract information from
3646 ;; a table-cell element.
3647 ;;
3648 ;; `org-export-table-dimensions' gives the number on rows and columns
3649 ;; in the table, ignoring horizontal rules and special columns.
3650 ;; `org-export-table-cell-address', given a table-cell object, returns
3651 ;; the absolute address of a cell. On the other hand,
3652 ;; `org-export-get-table-cell-at' does the contrary.
3653 ;;
3654 ;; `org-export-table-cell-starts-colgroup-p',
3655 ;; `org-export-table-cell-ends-colgroup-p',
3656 ;; `org-export-table-row-starts-rowgroup-p',
3657 ;; `org-export-table-row-ends-rowgroup-p',
3658 ;; `org-export-table-row-starts-header-p' and
3659 ;; `org-export-table-row-ends-header-p' indicate position of current
3660 ;; row or cell within the table.
3663 "Non-nil when TABLE has a special column.
3664 All special columns will be ignored during export."
3665 ;; The table has a special column when every first cell of every row
3666 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3667 ;; "*" "_" and "^". Though, do not consider a first row containing
3668 ;; only empty cells as special.
3684 "Non-nil when TABLE has an header.
3686 INFO is a plist used as a communication channel.
3688 A table has an header when it contains at least two row groups."
3691 table 'table-row
3699 info)))
3702 "Non-nil if TABLE-ROW is considered special.
3704 INFO is a plist used as the communication channel.
3706 All special rows will be ignored during export."
3710 ;; A row is special either when...
3712 ;; ... it starts with a field only containing "/",
3714 ;; ... the table contains a special column and the row start
3715 ;; with a marking character among, "^", "_", "$" or "!",
3719 ;; ... it contains only alignment cookies and empty cells.
3725 ;; Since VALUE is a secondary string, the following
3726 ;; checks avoid expanding it with `org-export-data'.
3738 "Return TABLE-ROW's group.
3740 INFO is a plist used as the communication channel.
3742 Return value is the group number, as an integer, or nil special
3743 rows and table rules. Group 1 is also table's header."
3760 "Return TABLE-CELL contents width.
3762 INFO is a plist used as the communication channel.
3764 Return value is the width given by the last width cookie in the
3765 same column as TABLE-CELL, or nil."
3770 cookie-width)
3774 ;; In a special row, try to find a width cookie at COLUMN.
3778 ;; The following checks avoid expanding unnecessarily the
3779 ;; cell with `org-export-data'
3787 ;; Ignore table rules.
3790 ;; Return value.
3791 cookie-width))
3794 "Return TABLE-CELL contents alignment.
3796 INFO is a plist used as the communication channel.
3798 Return alignment as specified by the last alignment cookie in the
3799 same column as TABLE-CELL. If no such cookie is found, a default
3800 alignment value will be deduced from fraction of numbers in the
3801 column (see `org-table-number-fraction' for more information).
3802 Possible values are `left', `right' and `center'."
3809 cookie-align)
3813 ;; In a special row, try to find an alignment cookie at
3814 ;; COLUMN.
3818 ;; Since VALUE is a secondary string, the following checks
3819 ;; avoid useless expansion through `org-export-data'.
3827 ;; Ignore table rules.
3829 ;; In a standard row, check if cell's contents are expressing
3830 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3831 ;; Though, don't bother if an alignment cookie has already
3832 ;; defined cell's alignment.
3837 info)))
3842 ;; Return value. Alignment specified by cookies has precedence
3843 ;; over alignment deduced from cells contents.
3852 "Return TABLE-CELL borders.
3854 INFO is a plist used as a communication channel.
3856 Return value is a list of symbols, or nil. Possible values are:
3857 `top', `bottom', `above', `below', `left' and `right'. Note:
3858 `top' (resp. `bottom') only happen for a cell in the first
3859 row (resp. last row) of the table, ignoring table rules, if any.
3861 Returned borders ignore special rows."
3864 borders)
3865 ;; Top/above border? TABLE-CELL has a border above when a rule
3866 ;; used to demarcate row groups can be found above. Hence,
3867 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3868 ;; another regular row has to be found above that rule.
3877 ;; Look at every row before the current one.
3879 ;; No rule above, or rule found starts the table (ignoring any
3880 ;; special row): TABLE-CELL is at the top of the table.
3883 ;; Bottom/below border? TABLE-CELL has a border below when next
3884 ;; non-regular row below is a rule.
3893 ;; Look at every row after the current one.
3895 ;; No rule below, or rule found ends the table (modulo some
3896 ;; special row): TABLE-CELL is at the bottom of the table.
3899 ;; Right/left borders? They can only be specified by column
3900 ;; groups. Column groups are defined in a row starting with "/".
3901 ;; Also a column groups row only contains "<", "<>", ">" or blank
3902 ;; cells.
3919 ;; There's a left border when previous cell, if
3920 ;; any, ends a group, or current one starts one.
3926 ;; There's a right border when next cell, if any,
3927 ;; starts a group, or current one ends one.
3934 ;; Table rows are read in reverse order so last column groups
3935 ;; row has precedence over any previous one.
3937 ;; Return value.
3938 borders))
3941 "Non-nil when TABLE-CELL is at the beginning of a row group.
3942 INFO is a plist used as a communication channel."
3943 ;; A cell starts a column group either when it is at the beginning
3944 ;; of a row (or after the special column, if any) or when it has
3945 ;; a left border.
3949 table-cell)
3953 "Non-nil when TABLE-CELL is at the end of a row group.
3954 INFO is a plist used as a communication channel."
3955 ;; A cell ends a column group either when it is at the end of a row
3956 ;; or when it has a right border.
3959 table-cell)
3963 "Non-nil when TABLE-ROW is at the beginning of a column group.
3964 INFO is a plist used as a communication channel."
3972 "Non-nil when TABLE-ROW is at the end of a column group.
3973 INFO is a plist used as a communication channel."
3981 "Non-nil when TABLE-ROW is the first table header's row.
3982 INFO is a plist used as a communication channel."
3989 "Non-nil when TABLE-ROW is the last table header's row.
3990 INFO is a plist used as a communication channel."
3997 "Return TABLE dimensions.
3999 INFO is a plist used as a communication channel.
4001 Return value is a CONS like (ROWS . COLUMNS) where
4002 ROWS (resp. COLUMNS) is the number of exportable
4003 rows (resp. columns)."
4005 ;; Set number of rows, and extract first one.
4007 table 'table-row
4012 ;; Set number of columns.
4014 ;; Return value.
4018 "Return address of a regular TABLE-CELL object.
4020 TABLE-CELL is the cell considered. INFO is a plist used as
4021 a communication channel.
4023 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4024 zero-based index. Only exportable cells are considered. The
4025 function returns nil for other cells."
4028 ;; Ignore cells in special rows or in special column.
4033 ;; Row number.
4036 table 'table-row
4042 ;; Column number.
4045 table-row 'table-cell
4051 "Return regular table-cell object at ADDRESS in TABLE.
4053 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4054 zero-based index. TABLE is a table type element. INFO is
4055 a plist used as a communication channel.
4057 If no table-cell, among exportable cells, is found at ADDRESS,
4058 return nil."
4061 ;; Row at (car address) or nil.
4064 table 'table-row
4070 'table-cell
4077 ;;;; For Tables Of Contents
4078 ;;
4079 ;; `org-export-collect-headlines' builds a list of all exportable
4080 ;; headline elements, maybe limited to a certain depth. One can then
4081 ;; easily parse it and transcode it.
4082 ;;
4083 ;; Building lists of tables, figures or listings is quite similar.
4084 ;; Once the generic function `org-export-collect-elements' is defined,
4085 ;; `org-export-collect-tables', `org-export-collect-figures' and
4086 ;; `org-export-collect-listings' can be derived from it.
4089 "Collect headlines in order to build a table of contents.
4091 INFO is a plist used as a communication channel.
4093 When optional argument N is an integer, it specifies the depth of
4094 the table of contents. Otherwise, it is set to the value of the
4095 last headline level. See `org-export-headline-levels' for more
4096 information.
4098 Return a list of all exportable headlines as parsed elements."
4102 'headline
4104 ;; Strip contents from HEADLINE.
4107 info))
4110 "Collect referenceable elements of a determined type.
4112 TYPE can be a symbol or a list of symbols specifying element
4113 types to search. Only elements with a caption are collected.
4115 INFO is a plist used as a communication channel.
4117 When non-nil, optional argument PREDICATE is a function accepting
4118 one argument, an element of type TYPE. It returns a non-nil
4119 value when that element should be collected.
4121 Return a list of all elements found, in order of appearance."
4127 element))
4128 info))
4131 "Build a list of tables.
4132 INFO is a plist used as a communication channel.
4134 Return a list of table elements with a caption."
4138 "Build a list of figures.
4140 INFO is a plist used as a communication channel. PREDICATE is
4141 a function which accepts one argument: a paragraph element and
4142 whose return value is non-nil when that element should be
4143 collected.
4145 A figure is a paragraph type element, with a caption, verifying
4147 a vague concept that may depend on back-end.
4149 Return a list of elements recognized as figures."
4153 "Build a list of src blocks.
4155 INFO is a plist used as a communication channel.
4157 Return a list of src-block elements with a caption."
4161 ;;;; Topology
4162 ;;
4163 ;; Here are various functions to retrieve information about the
4164 ;; neighbourhood of a given element or object. Neighbours of interest
4165 ;; are direct parent (`org-export-get-parent'), parent headline
4166 ;; (`org-export-get-parent-headline'), first element containing an
4167 ;; object, (`org-export-get-parent-element'), parent table
4168 ;; (`org-export-get-parent-table'), previous element or object
4169 ;; (`org-export-get-previous-element') and next element or object
4170 ;; (`org-export-get-next-element').
4171 ;;
4172 ;; `org-export-get-genealogy' returns the full genealogy of a given
4173 ;; element or object, from closest parent to full parse tree.
4176 "Return BLOB parent or nil.
4177 BLOB is the element or object considered."
4181 "Return full genealogy relative to a given element or object.
4183 BLOB is the element or object being considered.
4185 Ancestors are returned from closest to farthest, the last one
4186 being the full parse tree."
4193 "Return BLOB parent headline or nil.
4194 BLOB is the element or object being considered."
4198 parent))
4201 "Return first element containing OBJECT or nil.
4202 OBJECT is the object to consider."
4206 parent))
4209 "Return OBJECT parent table or nil.
4210 OBJECT is either a `table-cell' or `table-element' type object."
4214 parent))
4217 "Return previous element or object.
4218 BLOB is an element or object. INFO is a plist used as
4219 a communication channel. Return previous exportable element or
4220 object, a string, or nil."
4230 "Return next element or object.
4231 BLOB is an element or object. INFO is a plist used as
4232 a communication channel. Return next exportable element or
4233 object, a string, or nil."
4239 nil))
4242 ;;;; Translation
4243 ;;
4244 ;; `org-export-translate' translates a string according to language
4245 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4246 ;; variable and a specified charset. `org-export-dictionary' contains
4247 ;; the dictionary used for the translation.
4369 "Dictionary for export engine.
4371 Alist whose CAR is the string to translate and CDR is an alist
4372 whose CAR is the language string and CDR is a plist whose
4373 properties are possible charsets and values translated terms.
4375 It is used as a database for `org-export-translate'. Since this
4376 function returns the string as-is if no translation was found,
4377 the variable only needs to record values different from the
4381 "Translate string S according to language specification.
4383 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4384 and `:utf-8'. INFO is a plist used as a communication channel.
4386 Translation depends on `:language' property. Return the
4387 translated string. If no translation is found, try to fall back
4388 to `:default' encoding. If it fails, return S."
4394 s)))
4397 \f
4398 ;;; The Dispatcher
4399 ;;
4400 ;; `org-export-dispatch' is the standard interactive way to start an
4401 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4402 ;; for its interface, which, in turn, delegates response to key
4403 ;; pressed to `org-export-dispatch-action'.
4406 "List of menu entries available for `org-export-dispatch'.
4407 This variable shouldn't be set directly. Set-up :menu-entry
4408 keyword in either `org-export-define-backend' or
4411 ;;;###autoload
4413 "Export dispatcher for Org mode.
4415 It provides an access to common export related tasks in a buffer.
4416 Its interface comes in two flavours: standard and expert. While
4417 both share the same set of bindings, only the former displays the
4418 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4419 to switch to one or the other.
4421 Return an error if key pressed has no associated command."
4424 nil
4425 org-export-dispatch-use-expert-ui))
4429 ;; First handle special hard-coded actions.
4435 "Publish project: "
4436 org-e-publish-project-alist nil t)
4437 org-e-publish-project-alist)
4447 "Handle interface for `org-export-dispatch'.
4449 OPTIONS is a list containing current interactive options set for
4450 export. It can contain any of the following symbols:
4451 `body' toggles a body-only export
4452 `subtree' restricts export to current subtree
4453 `visible' restricts export to visible part of buffer.
4454 `force' force publishing files.
4456 FIRST-KEY is the key pressed to select the first level menu. It
4457 is nil when this menu hasn't been selected yet.
4459 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4460 buffer is provided, but indications about currently active
4461 options are given in the prompt. Moreover, \[?] allows to switch
4462 back to standard interface."
4465 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4466 ;; non-nil is the required first-level key to activate
4467 ;; KEY. When its value is t, activate KEY independently
4468 ;; on the first key, if any. A nil value means KEY will
4469 ;; only be activated at first level.
4473 ;; Make sure order of menu doesn't depend on the order in
4474 ;; which back-ends are loaded.
4477 ;; Compute a list of allowed keys based on the first key
4478 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4479 ;; always available.
4489 ;; Build the help menu for standard UI.
4493 ;; Options are hard-coded.
4495 [%s] Body only: %s [%s] Visible only: %s
4505 ;; Display registered back-end entries.
4515 ;; Split sub-menu into two columns.
4525 top-key)
4530 ;; Publishing menu is hard-coded.
4532 [%s] Current file [%s] Current project
4542 ;; Build prompts for both standard and expert UI.
4547 "Export command (Options: %s%s%s%s) [%s]: "
4553 ;; With expert UI, just read key with a fancy prompt. In standard
4554 ;; UI, display an intrusive help buffer.
4557 expert-prompt allowed-keys backends options first-key expertp)
4569 standard-prompt allowed-keys backends options first-key expertp))
4575 "Read a character from command input and act accordingly.
4577 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
4578 a list of characters available at a given step in the process.
4579 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
4580 EXPERTP are the same as defined in `org-export-dispatch-ui',
4581 which see.
4583 Toggle export options when required. Otherwise, return value is
4584 a list with action as CAR and a list of interactive export
4585 options as CDR."
4587 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4588 ;; depending on user's key pressed.
4591 ;; Ignore non-standard characters (i.e. "M-a") and
4592 ;; undefined associations.
4595 ;; q key at first level aborts export. At second
4596 ;; level, cancel first key instead.
4599 ;; Help key: Switch back to standard interface if
4600 ;; expert UI was active.
4602 ;; Toggle export options.
4609 first-key expertp))
4610 ;; Action selected: Send key and options back to
4611 ;; `org-export-dispatch'.
4617 ;; Publishing actions are hard-coded. Send a special
4618 ;; signal to `org-export-dispatch'.
4626 options))
4627 ;; Otherwise, enter sub-menu.
4632 ;;; org-export.el ends here