| blob | 6f885d18df0c61a214a684935f8a900832a0be37 |
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
703 ;;
704 ;; `org-export-define-backend' is the standard way to define an export
705 ;; back-end. It allows to specify translators, filters, buffer
706 ;; options and a menu entry. If the new back-end shares translators
707 ;; with another back-end, `org-export-define-derived-backend' may be
708 ;; used instead.
709 ;;
710 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
711 ;; when a given back-end hasn't been registered yet.
714 "Define a new back-end BACKEND.
716 TRANSLATORS is an alist between object or element types and
717 functions handling them.
719 These functions should return a string without any trailing
720 space, or nil. They must accept three arguments: the object or
721 element itself, its contents or nil when it isn't recursive and
722 the property list used as a communication channel.
724 Contents, when not nil, are stripped from any global indentation
725 \(although the relative one is preserved). They also always end
726 with a single newline character.
728 If, for a given type, no function is found, that element or
729 object type will simply be ignored, along with any blank line or
730 white space at its end. The same will happen if the function
731 returns the nil value. If that function returns the empty
732 string, the type will be ignored, but the blank lines or white
733 spaces will be kept.
735 In addition to element and object types, one function can be
736 associated to the `template' symbol and another one to the
737 `plain-text' symbol.
739 The former returns the final transcoded string, and can be used
740 to add a preamble and a postamble to document's body. It must
741 accept two arguments: the transcoded string and the property list
742 containing export options.
744 The latter, when defined, is to be called on every text not
745 recognized as an element or an object. It must accept two
746 arguments: the text string and the information channel. It is an
747 appropriate place to protect special chars relative to the
748 back-end.
750 BODY can start with pre-defined keyword arguments. The following
751 keywords are understood:
753 :export-block
755 String, or list of strings, representing block names that
756 will not be parsed. This is used to specify blocks that will
757 contain raw code specific to the back-end. These blocks
758 still have to be handled by the relative `export-block' type
759 translator.
761 :filters-alist
763 Alist between filters and function, or list of functions,
764 specific to the back-end. See `org-export-filters-alist' for
765 a list of all allowed filters. Filters defined here
766 shouldn't make a back-end test, as it may prevent back-ends
767 derived from this one to behave properly.
769 :menu-entry
771 Menu entry for the export dispatcher. It should be a list
772 like:
774 \(KEY DESCRIPTION ACTION-OR-MENU)
776 where :
778 KEY is a free character selecting the back-end.
779 DESCRIPTION is a string naming the back-end.
780 ACTION-OR-MENU is either a function or an alist.
782 If it is an action, it will be called with three arguments:
783 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
784 for further explanations.
786 If it is an alist, associations should follow the
787 pattern:
789 \(KEY DESCRIPTION ACTION)
791 where KEY, DESCRIPTION and ACTION are described above.
793 Valid values include:
797 or
804 \(lambda (subtree visible body-only)
805 \(org-open-file
806 \(org-e-latex-export-to-pdf subtree visible body-only))))))
808 :options-alist
810 Alist between back-end specific properties introduced in
811 communication channel and how their value are acquired. See
812 `org-export-options-alist' for more information about
813 structure of the values."
828 ;; Define translators.
831 ;; Define options.
835 See `org-export-options-alist' for more information on the
836 structure of the values."
837 backend)))
838 ;; Define filters.
841 "Alist between filters keywords and back-end specific filters.
843 ;; Tell parser to not parse EXPORT-BLOCK blocks.
850 ;; Add an entry for back-end in `org-export-dispatch'.
855 ;; Splice in the body, if any.
859 "Create a new back-end as a variant of an existing one.
861 CHILD is the name of the derived back-end. PARENT is the name of
862 the parent back-end.
864 BODY can start with pre-defined keyword arguments. The following
865 keywords are understood:
867 :export-block
869 String, or list of strings, representing block names that
870 will not be parsed. This is used to specify blocks that will
871 contain raw code specific to the back-end. These blocks
872 still have to be handled by the relative `export-block' type
873 translator.
875 :filters-alist
877 Alist of filters that will overwrite or complete filters
878 defined in PARENT back-end. See `org-export-filters-alist'
879 for a list of allowed filters.
881 :menu-entry
883 Menu entry for the export dispatcher. See
884 `org-export-define-backend' for more information about the
885 expected value.
887 :options-alist
889 Alist of back-end specific properties that will overwrite or
890 complete those defined in PARENT back-end. Refer to
891 `org-export-options-alist' for more information about
892 structure of the values.
894 :sub-menu-entry
896 Append entries to an existing menu in the export dispatcher.
897 The associated value should be a list whose CAR is the
898 character selecting the menu to expand and CDR a list of
899 entries following the pattern:
901 \(KEY DESCRIPTION ACTION)
903 where KEY is a free character triggering the action,
904 DESCRIPTION is a string defining the action, and ACTION is
905 a function that will be called with three arguments:
906 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
907 for further explanations.
909 Valid values include:
913 \(lambda (s v b)
914 \(org-open-file (org-e-beamer-export-to-pdf s v b)))))
916 :translate-alist
918 Alist of element and object types and transcoders that will
919 overwrite or complete transcode table from PARENT back-end.
920 Refer to `org-export-define-backend' for detailed information
921 about transcoders.
924 as a variant of `e-latex' back-end with a custom template
925 function:
927 \(org-export-define-derived-backend my-latex e-latex
928 :translate-alist ((template . my-latex-template-fun)))
930 The back-end could then be called with, for example:
949 ;; Tell parser to not parse EXPORT-BLOCK blocks.
956 ;; Define filters.
963 "Alist between filters keywords and back-end specific filters.
965 ;; Define options.
973 See `org-export-options-alist' for more information on the
974 structure of the values."
975 child))))
976 ;; Define translators.
983 ;; Add an entry for back-end in `org-export-dispatch'.
990 org-export-dispatch-menu-entries))))
994 ;; Splice in the body, if any.
998 "Signal an error if BACKEND isn't defined."
1003 \f
1004 ;;; The Communication Channel
1005 ;;
1006 ;; During export process, every function has access to a number of
1007 ;; properties. They are of two types:
1008 ;;
1009 ;; 1. Environment options are collected once at the very beginning of
1010 ;; the process, out of the original buffer and configuration.
1011 ;; Collecting them is handled by `org-export-get-environment'
1012 ;; function.
1013 ;;
1014 ;; Most environment options are defined through the
1015 ;; `org-export-options-alist' variable.
1016 ;;
1017 ;; 2. Tree properties are extracted directly from the parsed tree,
1018 ;; just before export, by `org-export-collect-tree-properties'.
1019 ;;
1020 ;; Here is the full list of properties available during transcode
1021 ;; process, with their category and their value type.
1022 ;;
1023 ;; + `:author' :: Author's name.
1024 ;; - category :: option
1025 ;; - type :: string
1026 ;;
1027 ;; + `:back-end' :: Current back-end used for transcoding.
1028 ;; - category :: tree
1029 ;; - type :: symbol
1030 ;;
1031 ;; + `:creator' :: String to write as creation information.
1032 ;; - category :: option
1033 ;; - type :: string
1034 ;;
1035 ;; + `:date' :: String to use as date.
1036 ;; - category :: option
1037 ;; - type :: string
1038 ;;
1039 ;; + `:description' :: Description text for the current data.
1040 ;; - category :: option
1041 ;; - type :: string
1042 ;;
1043 ;; + `:email' :: Author's email.
1044 ;; - category :: option
1045 ;; - type :: string
1046 ;;
1047 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1048 ;; process.
1049 ;; - category :: option
1050 ;; - type :: list of strings
1051 ;;
1052 ;; + `:exported-data' :: Hash table used for memoizing
1053 ;; `org-export-data'.
1054 ;; - category :: tree
1055 ;; - type :: hash table
1056 ;;
1057 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1058 ;; their definition, as parsed data. Only non-inlined footnotes
1059 ;; are represented in this alist. Also, every definition isn't
1060 ;; guaranteed to be referenced in the parse tree. The purpose of
1061 ;; this property is to preserve definitions from oblivion
1062 ;; (i.e. when the parse tree comes from a part of the original
1063 ;; buffer), it isn't meant for direct use in a back-end. To
1064 ;; retrieve a definition relative to a reference, use
1065 ;; `org-export-get-footnote-definition' instead.
1066 ;; - category :: option
1067 ;; - type :: alist (STRING . LIST)
1068 ;;
1069 ;; + `:headline-levels' :: Maximum level being exported as an
1070 ;; headline. Comparison is done with the relative level of
1071 ;; headlines in the parse tree, not necessarily with their
1072 ;; actual level.
1073 ;; - category :: option
1074 ;; - type :: integer
1075 ;;
1076 ;; + `:headline-offset' :: Difference between relative and real level
1077 ;; of headlines in the parse tree. For example, a value of -1
1078 ;; means a level 2 headline should be considered as level
1079 ;; 1 (cf. `org-export-get-relative-level').
1080 ;; - category :: tree
1081 ;; - type :: integer
1082 ;;
1083 ;; + `:headline-numbering' :: Alist between headlines and their
1084 ;; numbering, as a list of numbers
1085 ;; (cf. `org-export-get-headline-number').
1086 ;; - category :: tree
1087 ;; - type :: alist (INTEGER . LIST)
1088 ;;
1089 ;; + `:id-alist' :: Alist between ID strings and destination file's
1090 ;; path, relative to current directory. It is used by
1091 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1092 ;; external file.
1093 ;; - category :: option
1094 ;; - type :: alist (STRING . STRING)
1095 ;;
1096 ;; + `:ignore-list' :: List of elements and objects that should be
1097 ;; ignored during export.
1098 ;; - category :: tree
1099 ;; - type :: list of elements and objects
1100 ;;
1101 ;; + `:input-file' :: Full path to input file, if any.
1102 ;; - category :: option
1103 ;; - type :: string or nil
1104 ;;
1105 ;; + `:keywords' :: List of keywords attached to data.
1106 ;; - category :: option
1107 ;; - type :: string
1108 ;;
1109 ;; + `:language' :: Default language used for translations.
1110 ;; - category :: option
1111 ;; - type :: string
1112 ;;
1113 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1114 ;; transcoding.
1115 ;; - category :: option
1116 ;; - type :: list (as returned by `org-element-parse-buffer')
1117 ;;
1118 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1119 ;; all line breaks.
1120 ;; - category :: option
1121 ;; - type :: symbol (nil, t)
1122 ;;
1123 ;; + `:section-numbers' :: Non-nil means transcoding should add
1124 ;; section numbers to headlines.
1125 ;; - category :: option
1126 ;; - type :: symbol (nil, t)
1127 ;;
1128 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1129 ;; in transcoding. When such a tag is present, subtrees without
1130 ;; it are de facto excluded from the process. See
1131 ;; `use-select-tags'.
1132 ;; - category :: option
1133 ;; - type :: list of strings
1134 ;;
1135 ;; + `:target-list' :: List of targets encountered in the parse tree.
1136 ;; This is used to partly resolve "fuzzy" links
1137 ;; (cf. `org-export-resolve-fuzzy-link').
1138 ;; - category :: tree
1139 ;; - type :: list of strings
1140 ;;
1141 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1142 ;; a time stamp in the output.
1143 ;; - category :: option
1144 ;; - type :: symbol (nil, t)
1145 ;;
1146 ;; + `:translate-alist' :: Alist between element and object types and
1147 ;; transcoding functions relative to the current back-end.
1148 ;; Special keys `template' and `plain-text' are also possible.
1149 ;; - category :: option
1150 ;; - type :: alist (SYMBOL . FUNCTION)
1151 ;;
1152 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1153 ;; also be transcoded. If it is set to the `headline' symbol,
1154 ;; only the archived headline's name is retained.
1155 ;; - category :: option
1156 ;; - type :: symbol (nil, t, `headline')
1157 ;;
1158 ;; + `:with-author' :: Non-nil means author's name should be included
1159 ;; in the output.
1160 ;; - category :: option
1161 ;; - type :: symbol (nil, t)
1162 ;;
1163 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
1164 ;; - category :: option
1165 ;; - type :: symbol (nil, t)
1166 ;;
1167 ;; + `:with-creator' :: Non-nild means a creation sentence should be
1168 ;; inserted at the end of the transcoded string. If the value
1169 ;; is `comment', it should be commented.
1170 ;; - category :: option
1171 ;; - type :: symbol (`comment', nil, t)
1172 ;;
1173 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1174 ;; its value is a list of names, only drawers with such names
1175 ;; will be transcoded.
1176 ;; - category :: option
1177 ;; - type :: symbol (nil, t) or list of strings
1178 ;;
1179 ;; + `:with-email' :: Non-nil means output should contain author's
1180 ;; email.
1181 ;; - category :: option
1182 ;; - type :: symbol (nil, t)
1183 ;;
1184 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1185 ;; interpreted.
1186 ;; - category :: option
1187 ;; - type :: symbol (nil, t)
1188 ;;
1189 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1190 ;; strings starting with a colon as a fixed-with (verbatim) area.
1191 ;; - category :: option
1192 ;; - type :: symbol (nil, t)
1193 ;;
1194 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1195 ;; footnotes.
1196 ;; - category :: option
1197 ;; - type :: symbol (nil, t)
1198 ;;
1199 ;; + `:with-plannings' :: Non-nil means transcoding should include
1200 ;; planning info.
1201 ;; - category :: option
1202 ;; - type :: symbol (nil, t)
1203 ;;
1204 ;; + `:with-priority' :: Non-nil means transcoding should include
1205 ;; priority cookies.
1206 ;; - category :: option
1207 ;; - type :: symbol (nil, t)
1208 ;;
1209 ;; + `:with-special-strings' :: Non-nil means transcoding should
1210 ;; interpret special strings in plain text.
1211 ;; - category :: option
1212 ;; - type :: symbol (nil, t)
1213 ;;
1214 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1215 ;; interpret subscript and superscript. With a value of "{}",
1216 ;; only interpret those using curly brackets.
1217 ;; - category :: option
1218 ;; - type :: symbol (nil, {}, t)
1219 ;;
1220 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1221 ;; tables.
1222 ;; - category :: option
1223 ;; - type :: symbol (nil, t)
1224 ;;
1225 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1226 ;; headlines. A `not-in-toc' value will remove them from the
1227 ;; table of contents, if any, nonetheless.
1228 ;; - category :: option
1229 ;; - type :: symbol (nil, t, `not-in-toc')
1230 ;;
1231 ;; + `:with-tasks' :: Non-nil means transcoding should include
1232 ;; headlines with a TODO keyword. A `todo' value will only
1233 ;; include headlines with a todo type keyword while a `done'
1234 ;; value will do the contrary. If a list of strings is provided,
1235 ;; only tasks with keywords belonging to that list will be kept.
1236 ;; - category :: option
1237 ;; - type :: symbol (t, todo, done, nil) or list of strings
1238 ;;
1239 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1240 ;; time stamps. Special value `active' (resp. `inactive') ask to
1241 ;; export only active (resp. inactive) timestamps. Otherwise,
1242 ;; completely remove them.
1243 ;; - category :: option
1244 ;; - type :: symbol: (`active', `inactive', t, nil)
1245 ;;
1246 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1247 ;; added to the output. An integer value limits its depth.
1248 ;; - category :: option
1249 ;; - type :: symbol (nil, t or integer)
1250 ;;
1251 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1252 ;; include TODO keywords.
1253 ;; - category :: option
1254 ;; - type :: symbol (nil, t)
1257 ;;;; Environment Options
1258 ;;
1259 ;; Environment options encompass all parameters defined outside the
1260 ;; scope of the parsed data. They come from five sources, in
1261 ;; increasing precedence order:
1262 ;;
1263 ;; - Global variables,
1264 ;; - Buffer's attributes,
1265 ;; - Options keyword symbols,
1266 ;; - Buffer keywords,
1267 ;; - Subtree properties.
1268 ;;
1269 ;; The central internal function with regards to environment options
1270 ;; is `org-export-get-environment'. It updates global variables with
1271 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1272 ;; the different sources.
1273 ;;
1274 ;; The internal functions doing the retrieval are:
1275 ;; `org-export--get-global-options',
1276 ;; `org-export--get-buffer-attributes',
1277 ;; `org-export--parse-option-keyword',
1278 ;; `org-export--get-subtree-options' and
1279 ;; `org-export--get-inbuffer-options'
1280 ;;
1281 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1282 ;; take care of the part relative to "#+BIND:" keywords.
1285 "Collect export options from the current buffer.
1287 Optional argument BACKEND is a symbol specifying which back-end
1288 specific options to read, if any.
1290 When optional argument SUBTREEP is non-nil, assume the export is
1291 done against the current sub-tree.
1293 Third optional argument EXT-PLIST is a property list with
1294 external parameters overriding Org default settings, but still
1295 inferior to file-local settings."
1296 ;; First install #+BIND variables.
1298 ;; Get and prioritize export options...
1300 ;; ... from global variables...
1302 ;; ... from buffer's attributes...
1304 ;; ... from an external property list...
1305 ext-plist
1306 ;; ... from in-buffer settings...
1308 backend
1310 ;; ... and from subtree, when appropriate.
1312 ;; Eventually install back-end symbol and its translation table.
1313 `(:back-end
1314 ,backend
1315 :translate-alist
1320 "Parse an OPTIONS line and return values as a plist.
1321 Optional argument BACKEND is a symbol specifying which back-end
1322 specific items to read, if any."
1329 ;; Build an alist between #+OPTION: item and property-name.
1334 all)))
1335 plist)
1340 options)
1345 alist)
1346 plist))
1349 "Get export options in subtree at point.
1350 Optional argument BACKEND is a symbol specifying back-end used
1351 for export. Return options as a plist."
1352 ;; For each buffer keyword, create an headline property setting the
1353 ;; same property in communication channel. The name for the property
1354 ;; is the keyword with "EXPORT_" appended to it.
1357 ;; Make sure point is at an heading.
1359 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1360 ;; title as its fallback value.
1367 plist :title
1370 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1374 ;; Handle other keywords.
1381 ;; Export properties are not case-sensitive.
1388 plist
1390 ;; Parse VALUE if required.
1394 value))))))))
1395 ;; Also look for both general keywords and back-end specific
1396 ;; options if BACKEND is provided.
1401 org-export-options-alist)))
1402 ;; Return value.
1403 plist)))
1406 "Return current buffer export options, as a plist.
1408 Optional argument BACKEND, when non-nil, is a symbol specifying
1409 which back-end specific options should also be read in the
1410 process.
1412 Optional argument FILES is a list of setup files names read so
1413 far, used to avoid circular dependencies.
1415 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1419 ;; 1. Special keywords, as in `org-export-special-keywords'.
1433 ;; Avoid circular dependencies.
1443 ;; 2. Standard options, as in `org-export-options-alist'.
1445 ;; Also look for back-end specific options
1446 ;; if BACKEND is defined.
1452 ;; Build ALIST between keyword name and property name.
1456 all)))
1457 ;; Build regexp matching all keywords associated to export
1458 ;; options. Note: the search is case insensitive.
1472 plist prop
1473 ;; Handle value depending on specified BEHAVIOUR.
1486 ;; Parse keywords specified in `org-element-parsed-keywords'.
1494 plist prop
1497 org-element-parsed-keywords))
1498 ;; 3. Return final value.
1499 plist)))
1502 "Return properties related to buffer attributes, as a plist."
1505 ;; Store full path of input file name, or nil. For internal use.
1506 :input-file visited-file
1511 :footnote-definition-alist
1512 ;; Footnotes definitions must be collected in the original
1513 ;; buffer, as there's no insurance that they will still be in the
1514 ;; parse tree, due to possible narrowing.
1525 ;; Like `org-element-parse-buffer', but
1526 ;; makes sure the definition doesn't start
1527 ;; with a section element.
1531 alist))))
1532 alist))
1533 :id-alist
1534 ;; Collect id references.
1543 alist))))
1546 "Return global export options as a plist.
1548 Optional argument BACKEND, if non-nil, is a symbol specifying
1549 which back-end specific export options should also be read in the
1550 process."
1556 ;; Output value.
1557 plist)
1562 plist
1564 ;; Eval default value provided. If keyword is a member
1565 ;; of `org-element-parsed-keywords', parse it as
1566 ;; a secondary string before storing it.
1573 all)
1574 ;; Return value.
1575 plist))
1579 "Can we use #+BIND values during export?
1580 By default this will ask for confirmation by the user, to divert
1581 possible security risks."
1586 org-export--allow-BIND-local)
1591 "Install the values from #+BIND lines as local variables.
1592 Variables must be installed before in-buffer options are
1593 retrieved."
1608 ;;;; Tree Properties
1609 ;;
1610 ;; Tree properties are infromation extracted from parse tree. They
1611 ;; are initialized at the beginning of the transcoding process by
1612 ;; `org-export-collect-tree-properties'.
1613 ;;
1614 ;; Dedicated functions focus on computing the value of specific tree
1615 ;; properties during initialization. Thus,
1616 ;; `org-export--populate-ignore-list' lists elements and objects that
1617 ;; should be skipped during export, `org-export--get-min-level' gets
1618 ;; the minimal exportable level, used as a basis to compute relative
1619 ;; level for headlines. Eventually
1620 ;; `org-export--collect-headline-numbering' builds an alist between
1621 ;; headlines and their numbering.
1624 "Extract tree properties from parse tree.
1626 DATA is the parse tree from which information is retrieved. INFO
1627 is a list holding export options.
1629 Following tree properties are set or updated:
1631 `:exported-data' Hash table used to memoize results from
1632 `org-export-data'.
1634 `:footnote-definition-alist' List of footnotes definitions in
1635 original buffer and current parse tree.
1637 `:headline-offset' Offset between true level of headlines and
1638 local level. An offset of -1 means an headline
1639 of level 2 should be considered as a level
1640 1 headline in the context.
1642 `:headline-numbering' Alist of all headlines as key an the
1643 associated numbering as value.
1645 `:ignore-list' List of elements that should be ignored during
1646 export.
1648 `:target-list' List of all targets in the parse tree.
1650 Return updated plist."
1651 ;; Install the parse tree in the communication channel, in order to
1652 ;; use `org-export-get-genealogy' and al.
1654 ;; Get the list of elements and objects to ignore, and put it into
1655 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1656 ;; been done during parse tree filtering.
1659 :ignore-list
1662 ;; Compute `:headline-offset' in order to be able to use
1663 ;; `org-export-get-relative-level'.
1666 :headline-offset
1668 ;; Update footnotes definitions list with definitions in parse tree.
1669 ;; This is required since buffer expansion might have modified
1670 ;; boundaries of footnote definitions contained in the parse tree.
1671 ;; This way, definitions in `footnote-definition-alist' are bound to
1672 ;; match those in the parse tree.
1675 data 'footnote-definition
1679 defs)))
1681 ;; Properties order doesn't matter: get the rest of the tree
1682 ;; properties.
1684 `(:target-list
1693 info))
1696 "Return minimum exportable headline's level in DATA.
1697 DATA is parsed tree as returned by `org-element-parse-buffer'.
1698 OPTIONS is a plist holding export options."
1709 ;; If no headline was found, for the sake of consistency, set
1710 ;; minimum level to 1 nonetheless.
1714 "Return numbering of all exportable headlines in a parse tree.
1716 DATA is the parse tree. OPTIONS is the plist holding export
1717 options.
1719 Return an alist whose key is an headline and value is its
1720 associated numbering \(in the shape of a list of numbers\)."
1723 data
1724 'headline
1729 headline
1731 for idx from 0 to org-export-max-depth
1735 options)))
1738 "Return list of elements and objects to ignore during export.
1739 DATA is the parse tree to traverse. OPTIONS is the plist holding
1740 export options."
1742 walk-data
1743 ;; First find trees containing a select tag, if any.
1747 ;; Collect ignored elements or objects into IGNORE-LIST.
1753 ;; If headline is archived but tree below has
1754 ;; to be skipped, add it to ignore list.
1757 ;; Move into secondary string, if any.
1762 ;; Move into recursive objects/elements.
1764 ;; Main call.
1766 ;; Return value.
1767 ignore))
1770 "Return list of headlines containing a select tag in their tree.
1771 DATA is parsed data as returned by `org-element-parse-buffer'.
1772 INFO is a plist holding export options."
1774 walk-data ; for byte-compiler.
1785 ;; When a select tag is found, mark full
1786 ;; genealogy and every headline within the tree
1787 ;; as acceptable.
1790 genealogy
1792 selected-trees))
1793 ;; Else, continue searching in tree, recursively.
1800 "Non-nil when element or object BLOB should be skipped during export.
1801 OPTIONS is the plist holding export options. SELECTED, when
1802 non-nil, is a list of headlines belonging to a tree with a select
1803 tag."
1818 ;; Ignore subtrees with an exclude tag.
1821 ;; When a select tag is present in the buffer, ignore any tree
1822 ;; without it.
1824 ;; Ignore commented sub-trees.
1826 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1828 ;; Ignore tasks, if specified by `:with-tasks' property.
1844 ;; No timestamp allowed.
1846 ;; Only active timestamps allowed and the current one isn't
1847 ;; active.
1851 ;; Only inactive timestamps allowed and the current one isn't
1852 ;; inactive.
1858 \f
1859 ;;; The Transcoder
1860 ;;
1861 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1862 ;; `org-element-parse-buffer') and transcodes it into a specified
1863 ;; back-end output. It takes care of filtering out elements or
1864 ;; objects according to export options and organizing the output blank
1865 ;; lines and white space are preserved. The function memoizes its
1866 ;; results, so it is cheap to call it within translators.
1867 ;;
1868 ;; Internally, three functions handle the filtering of objects and
1869 ;; elements during the export. In particular,
1870 ;; `org-export-ignore-element' marks an element or object so future
1871 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1872 ;; elements or objects should be seen as real Org syntax and
1873 ;; `org-export-expand' transforms the others back into their original
1874 ;; shape
1875 ;;
1876 ;; `org-export-transcoder' is an accessor returning appropriate
1877 ;; translator function for a given element or object.
1880 "Return appropriate transcoder for BLOB.
1881 INFO is a plist containing export directives."
1883 ;; Return contents only for complete parse trees.
1889 "Convert DATA into current back-end format.
1891 DATA is a parse tree, an element or an object or a secondary
1892 string. INFO is a plist holding export options.
1894 Return transcoded string."
1900 ;; Ignored element/object.
1902 ;; Plain text.
1908 info))
1909 ;; Uninterpreted element/object: change it back to Org
1910 ;; syntax and export again resulting raw string.
1914 data
1918 info))
1919 ;; Secondary string.
1922 ;; Element/Object without contents or, as a special case,
1923 ;; headline with archive tag and archived trees restricted
1924 ;; to title only.
1932 ;; Element/Object with contents.
1945 ;; Elements directly containing objects
1946 ;; must have their indentation normalized
1947 ;; first.
1949 data
1950 ;; When normalizing contents of the first
1951 ;; paragraph in an item or a footnote
1952 ;; definition, ignore first line's
1953 ;; indentation: there is none and it
1954 ;; might be misleading.
1959 data)
1966 info))))))))
1967 ;; Final result will be memoized before being returned.
1969 data
1973 ;; Append the same white space between elements or objects as in
1974 ;; the original buffer, and call appropriate filters.
1985 info)))
1986 results)))
1990 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1991 Check is done according to export options INFO, stored as
1992 a plist."
1994 ;; ... entities...
1996 ;; ... emphasis...
1998 ;; ... fixed-width areas.
2000 ;; ... footnotes...
2003 ;; ... sub/superscripts...
2009 ;; ... tables...
2014 "Expand a parsed element or object to its original state.
2015 BLOB is either an element or an object. CONTENTS is its
2016 contents, as a string or nil."
2019 blob contents))
2022 "Add ELEMENT to `:ignore-list' in INFO.
2024 Any element in `:ignore-list' will be skipped when using
2025 `org-element-map'. INFO is modified by side effects."
2029 \f
2030 ;;; The Filter System
2031 ;;
2032 ;; Filters allow end-users to tweak easily the transcoded output.
2033 ;; They are the functional counterpart of hooks, as every filter in
2034 ;; a set is applied to the return value of the previous one.
2035 ;;
2036 ;; Every set is back-end agnostic. Although, a filter is always
2037 ;; called, in addition to the string it applies to, with the back-end
2038 ;; used as argument, so it's easy for the end-user to add back-end
2039 ;; specific filters in the set. The communication channel, as
2040 ;; a plist, is required as the third argument.
2041 ;;
2042 ;; From the developer side, filters sets can be installed in the
2043 ;; process with the help of `org-export-define-backend', which
2044 ;; internally sets `org-BACKEND-filters-alist' variable. Each
2045 ;; association has a key among the following symbols and a function or
2046 ;; a list of functions as value.
2047 ;;
2048 ;; - `:filter-parse-tree' applies directly on the complete parsed
2049 ;; tree. It's the only filters set that doesn't apply to a string.
2050 ;; Users can set it through `org-export-filter-parse-tree-functions'
2051 ;; variable.
2052 ;;
2053 ;; - `:filter-final-output' applies to the final transcoded string.
2054 ;; Users can set it with `org-export-filter-final-output-functions'
2055 ;; variable
2056 ;;
2057 ;; - `:filter-plain-text' applies to any string not recognized as Org
2058 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2059 ;; configure it.
2060 ;;
2061 ;; - `:filter-TYPE' applies on the string returned after an element or
2062 ;; object of type TYPE has been transcoded. An user can modify
2063 ;; `org-export-filter-TYPE-functions'
2064 ;;
2065 ;; All filters sets are applied with
2066 ;; `org-export-filter-apply-functions' function. Filters in a set are
2067 ;; applied in a LIFO fashion. It allows developers to be sure that
2068 ;; their filters will be applied first.
2069 ;;
2070 ;; Filters properties are installed in communication channel with
2071 ;; `org-export-install-filters' function.
2072 ;;
2073 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
2074 ;; before parsing to allow for heavy structure modifications.
2077 ;;;; Before Parsing Hook
2080 "Hook run before parsing an export buffer.
2082 This is run after include keywords have been expanded and Babel
2083 code executed, on a copy of original buffer's area being
2084 exported. Visibility is the same as in the original one. Point
2085 is left at the beginning of the new one.
2087 Every function in this hook will be called with one argument: the
2091 ;;;; Special Filters
2094 "List of functions applied to the parsed tree.
2095 Each filter is called with three arguments: the parse tree, as
2096 returned by `org-element-parse-buffer', the back-end, as
2097 a symbol, and the communication channel, as a plist. It must
2101 "List of functions applied to the transcoded string.
2102 Each filter is called with three arguments: the full transcoded
2103 string, the back-end, as a symbol, and the communication channel,
2104 as a plist. It must return a string that will be used as the
2108 "List of functions applied to plain text.
2109 Each filter is called with three arguments: a string which
2110 contains no Org syntax, the back-end, as a symbol, and the
2111 communication channel, as a plist. It must return a string or
2115 ;;;; Elements Filters
2118 "List of functions applied to a transcoded babel-call.
2119 Each filter is called with three arguments: the transcoded data,
2120 as a string, the back-end, as a symbol, and the communication
2124 "List of functions applied to a transcoded center block.
2125 Each filter is called with three arguments: the transcoded data,
2126 as a string, the back-end, as a symbol, and the communication
2130 "List of functions applied to a transcoded clock.
2131 Each filter is called with three arguments: the transcoded data,
2132 as a string, the back-end, as a symbol, and the communication
2136 "List of functions applied to a transcoded comment.
2137 Each filter is called with three arguments: the transcoded data,
2138 as a string, the back-end, as a symbol, and the communication
2142 "List of functions applied to a transcoded comment-comment.
2143 Each filter is called with three arguments: the transcoded data,
2144 as a string, the back-end, as a symbol, and the communication
2148 "List of functions applied to a transcoded drawer.
2149 Each filter is called with three arguments: the transcoded data,
2150 as a string, the back-end, as a symbol, and the communication
2154 "List of functions applied to a transcoded dynamic-block.
2155 Each filter is called with three arguments: the transcoded data,
2156 as a string, the back-end, as a symbol, and the communication
2160 "List of functions applied to a transcoded example-block.
2161 Each filter is called with three arguments: the transcoded data,
2162 as a string, the back-end, as a symbol, and the communication
2166 "List of functions applied to a transcoded export-block.
2167 Each filter is called with three arguments: the transcoded data,
2168 as a string, the back-end, as a symbol, and the communication
2172 "List of functions applied to a transcoded fixed-width.
2173 Each filter is called with three arguments: the transcoded data,
2174 as a string, the back-end, as a symbol, and the communication
2178 "List of functions applied to a transcoded footnote-definition.
2179 Each filter is called with three arguments: the transcoded data,
2180 as a string, the back-end, as a symbol, and the communication
2184 "List of functions applied to a transcoded headline.
2185 Each filter is called with three arguments: the transcoded data,
2186 as a string, the back-end, as a symbol, and the communication
2190 "List of functions applied to a transcoded horizontal-rule.
2191 Each filter is called with three arguments: the transcoded data,
2192 as a string, the back-end, as a symbol, and the communication
2196 "List of functions applied to a transcoded inlinetask.
2197 Each filter is called with three arguments: the transcoded data,
2198 as a string, the back-end, as a symbol, and the communication
2202 "List of functions applied to a transcoded item.
2203 Each filter is called with three arguments: the transcoded data,
2204 as a string, the back-end, as a symbol, and the communication
2208 "List of functions applied to a transcoded keyword.
2209 Each filter is called with three arguments: the transcoded data,
2210 as a string, the back-end, as a symbol, and the communication
2214 "List of functions applied to a transcoded latex-environment.
2215 Each filter is called with three arguments: the transcoded data,
2216 as a string, the back-end, as a symbol, and the communication
2220 "List of functions applied to a transcoded node-property.
2221 Each filter is called with three arguments: the transcoded data,
2222 as a string, the back-end, as a symbol, and the communication
2226 "List of functions applied to a transcoded paragraph.
2227 Each filter is called with three arguments: the transcoded data,
2228 as a string, the back-end, as a symbol, and the communication
2232 "List of functions applied to a transcoded plain-list.
2233 Each filter is called with three arguments: the transcoded data,
2234 as a string, the back-end, as a symbol, and the communication
2238 "List of functions applied to a transcoded planning.
2239 Each filter is called with three arguments: the transcoded data,
2240 as a string, the back-end, as a symbol, and the communication
2244 "List of functions applied to a transcoded property-drawer.
2245 Each filter is called with three arguments: the transcoded data,
2246 as a string, the back-end, as a symbol, and the communication
2250 "List of functions applied to a transcoded quote block.
2251 Each filter is called with three arguments: the transcoded quote
2252 data, as a string, the back-end, as a symbol, and the
2253 communication channel, as a plist. It must return a string or
2257 "List of functions applied to a transcoded quote-section.
2258 Each filter is called with three arguments: the transcoded data,
2259 as a string, the back-end, as a symbol, and the communication
2263 "List of functions applied to a transcoded section.
2264 Each filter is called with three arguments: the transcoded data,
2265 as a string, the back-end, as a symbol, and the communication
2269 "List of functions applied to a transcoded special block.
2270 Each filter is called with three arguments: the transcoded data,
2271 as a string, the back-end, as a symbol, and the communication
2275 "List of functions applied to a transcoded src-block.
2276 Each filter is called with three arguments: the transcoded data,
2277 as a string, the back-end, as a symbol, and the communication
2281 "List of functions applied to a transcoded table.
2282 Each filter is called with three arguments: the transcoded data,
2283 as a string, the back-end, as a symbol, and the communication
2287 "List of functions applied to a transcoded table-cell.
2288 Each filter is called with three arguments: the transcoded data,
2289 as a string, the back-end, as a symbol, and the communication
2293 "List of functions applied to a transcoded table-row.
2294 Each filter is called with three arguments: the transcoded data,
2295 as a string, the back-end, as a symbol, and the communication
2299 "List of functions applied to a transcoded verse block.
2300 Each filter is called with three arguments: the transcoded data,
2301 as a string, the back-end, as a symbol, and the communication
2305 ;;;; Objects Filters
2308 "List of functions applied to transcoded bold text.
2309 Each filter is called with three arguments: the transcoded data,
2310 as a string, the back-end, as a symbol, and the communication
2314 "List of functions applied to transcoded code text.
2315 Each filter is called with three arguments: the transcoded data,
2316 as a string, the back-end, as a symbol, and the communication
2320 "List of functions applied to a transcoded entity.
2321 Each filter is called with three arguments: the transcoded data,
2322 as a string, the back-end, as a symbol, and the communication
2326 "List of functions applied to a transcoded export-snippet.
2327 Each filter is called with three arguments: the transcoded data,
2328 as a string, the back-end, as a symbol, and the communication
2332 "List of functions applied to a transcoded footnote-reference.
2333 Each filter is called with three arguments: the transcoded data,
2334 as a string, the back-end, as a symbol, and the communication
2338 "List of functions applied to a transcoded inline-babel-call.
2339 Each filter is called with three arguments: the transcoded data,
2340 as a string, the back-end, as a symbol, and the communication
2344 "List of functions applied to a transcoded inline-src-block.
2345 Each filter is called with three arguments: the transcoded data,
2346 as a string, the back-end, as a symbol, and the communication
2350 "List of functions applied to transcoded italic text.
2351 Each filter is called with three arguments: the transcoded data,
2352 as a string, the back-end, as a symbol, and the communication
2356 "List of functions applied to a transcoded latex-fragment.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 "List of functions applied to a transcoded line-break.
2363 Each filter is called with three arguments: the transcoded data,
2364 as a string, the back-end, as a symbol, and the communication
2368 "List of functions applied to a transcoded link.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded macro.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 "List of functions applied to a transcoded radio-target.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to a transcoded statistics-cookie.
2387 Each filter is called with three arguments: the transcoded data,
2388 as a string, the back-end, as a symbol, and the communication
2392 "List of functions applied to transcoded strike-through text.
2393 Each filter is called with three arguments: the transcoded data,
2394 as a string, the back-end, as a symbol, and the communication
2398 "List of functions applied to a transcoded subscript.
2399 Each filter is called with three arguments: the transcoded data,
2400 as a string, the back-end, as a symbol, and the communication
2404 "List of functions applied to a transcoded superscript.
2405 Each filter is called with three arguments: the transcoded data,
2406 as a string, the back-end, as a symbol, and the communication
2410 "List of functions applied to a transcoded target.
2411 Each filter is called with three arguments: the transcoded data,
2412 as a string, the back-end, as a symbol, and the communication
2416 "List of functions applied to a transcoded timestamp.
2417 Each filter is called with three arguments: the transcoded data,
2418 as a string, the back-end, as a symbol, and the communication
2422 "List of functions applied to transcoded underline text.
2423 Each filter is called with three arguments: the transcoded data,
2424 as a string, the back-end, as a symbol, and the communication
2428 "List of functions applied to transcoded verbatim text.
2429 Each filter is called with three arguments: the transcoded data,
2430 as a string, the back-end, as a symbol, and the communication
2434 ;;;; Filters Tools
2435 ;;
2436 ;; Internal function `org-export-install-filters' installs filters
2437 ;; hard-coded in back-ends (developer filters) and filters from global
2438 ;; variables (user filters) in the communication channel.
2439 ;;
2440 ;; Internal function `org-export-filter-apply-functions' takes care
2441 ;; about applying each filter in order to a given data. It ignores
2442 ;; filters returning a nil value but stops whenever a filter returns
2443 ;; an empty string.
2446 "Call every function in FILTERS.
2448 Functions are called with arguments VALUE, current export
2449 back-end and INFO. A function returning a nil value will be
2450 skipped. If it returns the empty string, the process ends and
2451 VALUE is ignored.
2453 Call is done in a LIFO fashion, to be sure that developer
2454 specified filters, if any, are called first."
2463 "Install filters properties in communication channel.
2465 INFO is a plist containing the current communication channel.
2467 Return the updated communication channel."
2469 ;; Install user defined filters with `org-export-filters-alist'.
2472 org-export-filters-alist)
2473 ;; Prepend back-end specific filters to that list.
2478 ;; Single values get consed, lists are prepended.
2483 plist key
2487 ;; Return new communication channel.
2491 \f
2492 ;;; Core functions
2493 ;;
2494 ;; This is the room for the main function, `org-export-as', along with
2495 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2496 ;; They differ only by the way they output the resulting code.
2497 ;;
2498 ;; `org-export-output-file-name' is an auxiliary function meant to be
2499 ;; used with `org-export-to-file'. With a given extension, it tries
2500 ;; to provide a canonical file name to write export output to.
2501 ;;
2502 ;; Note that `org-export-as' doesn't really parse the current buffer,
2503 ;; but a copy of it (with the same buffer-local variables and
2504 ;; visibility), where macros and include keywords are expanded and
2505 ;; Babel blocks are executed, if appropriate.
2506 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2507 ;;
2508 ;; File inclusion is taken care of by
2509 ;; `org-export-expand-include-keyword' and
2510 ;; `org-export--prepare-file-contents'. Structure wise, including
2511 ;; a whole Org file in a buffer often makes little sense. For
2512 ;; example, if the file contains an headline and the include keyword
2513 ;; was within an item, the item should contain the headline. That's
2514 ;; why file inclusion should be done before any structure can be
2515 ;; associated to the file, that is before parsing.
2519 "Transcode current Org buffer into BACKEND code.
2521 If narrowing is active in the current buffer, only transcode its
2522 narrowed part.
2524 If a region is active, transcode that region.
2526 When optional argument SUBTREEP is non-nil, transcode the
2527 sub-tree at point, extracting information from the headline
2528 properties first.
2530 When optional argument VISIBLE-ONLY is non-nil, don't export
2531 contents of hidden elements.
2533 When optional argument BODY-ONLY is non-nil, only return body
2534 code, without preamble nor postamble.
2536 Optional argument EXT-PLIST, when provided, is a property list
2537 with external parameters overriding Org default settings, but
2538 still inferior to file-local settings.
2540 Optional argument NOEXPAND, when non-nil, prevents included files
2541 to be expanded and Babel code to be executed.
2543 Return code as a string."
2544 ;; Barf if BACKEND isn't registered.
2548 ;; Narrow buffer to an appropriate region or subtree for
2549 ;; parsing. If parsing subtree, be sure to remove main headline
2550 ;; too.
2558 ;; 1. Get export environment from original buffer. Also install
2559 ;; user's and developer's filters.
2562 ;; 2. Get parse tree. Buffer isn't parsed directly.
2563 ;; Instead, a temporary copy is created, where macros
2564 ;; and include keywords are expanded and code blocks
2565 ;; are evaluated.
2572 ;; TODO: Setting `org-current-export-file' is
2573 ;; required by Org Babel to properly resolve
2574 ;; noweb references. Once "org-exp.el" is
2575 ;; removed, modify
2576 ;; `org-export-blocks-preprocess' so it accepts
2577 ;; the value as an argument instead.
2581 ;; Run hook
2582 ;; `org-export-before-parsing-hook'. with current
2583 ;; back-end as argument.
2586 ;; Eventually parse buffer.
2588 ;; 3. Call parse-tree filters to get the final tree.
2592 ;; 4. Now tree is complete, compute its properties and add
2593 ;; them to communication channel.
2597 ;; 5. Eventually transcode TREE. Wrap the resulting string
2598 ;; into a template, if required. Eventually call
2599 ;; final-output filter.
2607 info)))
2608 ;; Maybe add final OUTPUT to kill ring, then return it.
2610 output)))))
2614 "Call `org-export-as' with output to a specified buffer.
2616 BACKEND is the back-end used for transcoding, as a symbol.
2618 BUFFER is the output buffer. If it already exists, it will be
2619 erased first, otherwise, it will be created.
2621 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2622 and NOEXPAND are similar to those used in `org-export-as', which
2623 see.
2625 Return buffer."
2627 backend subtreep visible-only body-only ext-plist noexpand))
2633 buffer))
2637 "Call `org-export-as' with output to a specified file.
2639 BACKEND is the back-end used for transcoding, as a symbol. FILE
2640 is the name of the output file, as a string.
2642 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2643 and NOEXPAND are similar to those used in `org-export-as', which
2644 see.
2646 Return output file's name."
2647 ;; Checks for FILE permissions. `write-file' would do the same, but
2648 ;; we'd rather avoid needless transcoding of parse tree.
2650 ;; Insert contents to a temporary buffer and write it to FILE.
2652 backend subtreep visible-only body-only ext-plist noexpand)))
2657 ;; Return full path.
2658 file)
2661 "Return output file's name according to buffer specifications.
2663 EXTENSION is a string representing the output file extension,
2664 with the leading dot.
2666 With a non-nil optional argument SUBTREEP, try to determine
2668 of subtree at point.
2670 When optional argument PUB-DIR is set, use it as the publishing
2671 directory.
2673 When optional argument VISIBLE-ONLY is non-nil, don't export
2674 contents of hidden elements.
2676 Return file name as a string, or nil if it couldn't be
2677 determined."
2679 ;; File name may come from EXPORT_FILE_NAME subtree property,
2680 ;; assuming point is at beginning of said sub-tree.
2687 ;; File name may be extracted from buffer's associated
2688 ;; file, if any.
2690 ;; Can't determine file name on our own: Ask user.
2694 "Output file: " pub-dir nil nil nil
2697 ;; Build file name. Enforce EXTENSION over whatever user may have
2698 ;; come up with. PUB-DIR, if defined, always has precedence over
2699 ;; any provided path.
2704 extension))
2710 "Apply BODY in a copy of the current buffer.
2712 The copy preserves local variables and visibility of the original
2713 buffer.
2715 Point is at buffer's beginning when BODY is applied."
2725 ,original-buffer
2730 ov
2740 "Expand every include keyword in buffer.
2741 Optional argument INCLUDED is a list of included file names along
2742 with their line restriction, when appropriate. It is used to
2743 avoid infinite recursion. Optional argument DIR is the current
2744 working directory. It is used to properly resolve relative
2745 paths."
2752 ;; Extract arguments from keyword's value.
2766 ;; Minimal level of included file defaults to the child
2767 ;; level of the current headline, if any, or one. It
2768 ;; only applies is the file is meant to be included as
2769 ;; an Org one.
2777 ;; Remove keyword.
2781 ;; Check if files has already been parsed. Look after
2782 ;; inclusion lines too, as different parts of the same file
2783 ;; can be included too.
2792 ;; Protect sensitive contents with commas.
2798 ind-str contents ind-str))))
2803 ;; Protect sensitive contents with commas.
2810 ind-str env contents ind-str))))
2823 "Prepare the contents of FILE for inclusion and return them as a string.
2825 When optional argument LINES is a string specifying a range of
2826 lines, include only those lines.
2828 Optional argument IND, when non-nil, is an integer specifying the
2829 global indentation of returned contents. Since its purpose is to
2830 allow an included file to stay in the same environment it was
2831 created \(i.e. a list item), it doesn't apply past the first
2832 headline encountered.
2834 Optional argument MINLEVEL, when non-nil, is an integer
2835 specifying the level that any top-level headline in the included
2836 file should have."
2852 ;; Remove blank lines at beginning and end of contents. The logic
2853 ;; behind that removal is that blank lines around include keyword
2854 ;; override blank lines in included file.
2863 ;; If IND is set, preserve indentation of include keyword until
2864 ;; the first headline encountered.
2870 ;; Do not move footnote definitions out of column 0.
2876 ;; When MINLEVEL is specified, compute minimal level for headlines
2877 ;; in the file (CUR-MIN), and remove stars to each headline so
2878 ;; that headlines with minimal level have a level of MINLEVEL.
2887 ;; Only change stars, don't bother moving whole
2888 ;; sections.
2894 \f
2895 ;;; Tools For Back-Ends
2896 ;;
2897 ;; A whole set of tools is available to help build new exporters. Any
2898 ;; function general enough to have its use across many back-ends
2899 ;; should be added here.
2901 ;;;; For Affiliated Keywords
2902 ;;
2903 ;; `org-export-read-attribute' reads a property from a given element
2904 ;; as a plist. It can be used to normalize affiliated keywords'
2905 ;; syntax.
2906 ;;
2907 ;; Since captions can span over multiple lines and accept dual values,
2908 ;; their internal representation is a bit tricky. Therefore,
2909 ;; `org-export-get-caption' transparently returns a given element's
2910 ;; caption as a secondary string.
2913 "Turn ATTRIBUTE property from ELEMENT into a plist.
2915 When optional argument PROPERTY is non-nil, return the value of
2916 that property within attributes.
2920 properties."
2928 "Return caption from ELEMENT as a secondary string.
2930 When optional argument SHORTP is non-nil, return short caption,
2931 as a secondary string, instead.
2933 Caption lines are separated by a white space."
2941 ;;;; For Export Snippets
2942 ;;
2943 ;; Every export snippet is transmitted to the back-end. Though, the
2944 ;; latter will only retain one type of export-snippet, ignoring
2945 ;; others, based on the former's target back-end. The function
2946 ;; `org-export-snippet-backend' returns that back-end for a given
2947 ;; export-snippet.
2950 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2951 Translation, with `org-export-snippet-translation-alist', is
2952 applied."
2956 back-end))))
2959 ;;;; For Footnotes
2960 ;;
2961 ;; `org-export-collect-footnote-definitions' is a tool to list
2962 ;; actually used footnotes definitions in the whole parse tree, or in
2963 ;; an headline, in order to add footnote listings throughout the
2964 ;; transcoded data.
2965 ;;
2966 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2967 ;; back-ends, when they need to attach the footnote definition only to
2968 ;; the first occurrence of the corresponding label.
2969 ;;
2970 ;; `org-export-get-footnote-definition' and
2971 ;; `org-export-get-footnote-number' provide easier access to
2972 ;; additional information relative to a footnote reference.
2975 "Return an alist between footnote numbers, labels and definitions.
2977 DATA is the parse tree from which definitions are collected.
2978 INFO is the plist used as a communication channel.
2980 Definitions are sorted by order of references. They either
2981 appear as Org data or as a secondary string for inlined
2982 footnotes. Unreferenced definitions are ignored."
2984 collect-fn ; for byte-compiler.
2988 ;; Collect footnote number, label and definition in DATA.
2990 data 'footnote-reference
2997 def)
2998 num-alist)
2999 ;; Also search in definition for nested footnotes.
3002 ;; Don't enter footnote definitions since it will happen
3003 ;; when their first reference is found.
3009 "Non-nil when a footnote reference is the first one for its label.
3011 FOOTNOTE-REFERENCE is the footnote reference being considered.
3012 INFO is the plist used as a communication channel."
3014 ;; Anonymous footnotes are always a first reference.
3016 ;; Otherwise, return the first footnote with the same LABEL and
3017 ;; test if it is equal to FOOTNOTE-REFERENCE.
3023 data 'footnote-reference
3028 ;; If FN isn't inlined, be sure to traverse its
3029 ;; definition before resuming search. See
3030 ;; comments in `org-export-get-footnote-number'
3031 ;; for more information.
3035 ;; Don't enter footnote definitions since it will
3036 ;; happen when their first reference is found.
3039 footnote-reference)))))
3042 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3043 INFO is the plist used as a communication channel."
3049 "Return number associated to a footnote.
3051 FOOTNOTE is either a footnote reference or a footnote definition.
3052 INFO is the plist used as a communication channel."
3054 seen-refs
3055 search-ref ; For byte-compiler.
3059 ;; Search footnote references through DATA, filling
3060 ;; SEEN-REFS along the way.
3062 data 'footnote-reference
3066 ;; Anonymous footnote match: return number.
3069 ;; Labels match: return number.
3072 ;; Anonymous footnote: it's always a new one. Also,
3073 ;; be sure to return nil from the `cond' so
3074 ;; `first-match' doesn't get us out of the loop.
3076 ;; Label not seen so far: add it so SEEN-REFS.
3077 ;;
3078 ;; Also search for subsequent references in
3079 ;; footnote definition so numbering follows reading
3080 ;; logic. Note that we don't have to care about
3081 ;; inline definitions, since `org-element-map'
3082 ;; already traverses them at the right time.
3083 ;;
3084 ;; Once again, return nil to stay in the loop.
3089 nil))))
3090 ;; Don't enter footnote definitions since it will happen
3091 ;; when their first reference is found.
3096 ;;;; For Headlines
3097 ;;
3098 ;; `org-export-get-relative-level' is a shortcut to get headline
3099 ;; level, relatively to the lower headline level in the parsed tree.
3100 ;;
3101 ;; `org-export-get-headline-number' returns the section number of an
3102 ;; headline, while `org-export-number-to-roman' allows to convert it
3103 ;; to roman numbers.
3104 ;;
3105 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3106 ;; `org-export-last-sibling-p' are three useful predicates when it
3107 ;; comes to fulfill the `:headline-levels' property.
3110 "Return HEADLINE relative level within current parsed tree.
3111 INFO is a plist holding contextual information."
3116 "Non-nil when HEADLINE is considered as low level.
3118 INFO is a plist used as a communication channel.
3120 A low level headlines has a relative level greater than
3121 `:headline-levels' property value.
3123 Return value is the difference between HEADLINE relative level
3124 and the last level being considered as high enough, or nil."
3131 "Return HEADLINE numbering as a list of numbers.
3132 INFO is a plist holding contextual information."
3136 "Return a non-nil value if HEADLINE element should be numbered.
3137 INFO is a plist used as a communication channel."
3143 "Convert integer N into a roman numeral."
3156 res)))
3159 "Return list of tags associated to ELEMENT.
3161 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3162 is a plist used as a communication channel.
3164 Select tags (see `org-export-select-tags') and exclude tags (see
3165 `org-export-exclude-tags') are removed from the list.
3167 When non-nil, optional argument TAGS should be a list of strings.
3168 Any tag belonging to this list will also be removed."
3175 "Return node PROPERTY value for BLOB.
3177 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3178 element or object.
3180 If optional argument INHERITED is non-nil, the value can be
3181 inherited from a parent headline.
3183 Return value is a string or nil."
3195 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3196 INFO is a plist used as a communication channel."
3201 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3202 INFO is a plist used as a communication channel."
3206 ;;;; For Links
3207 ;;
3208 ;; `org-export-solidify-link-text' turns a string into a safer version
3209 ;; for links, replacing most non-standard characters with hyphens.
3210 ;;
3211 ;; `org-export-get-coderef-format' returns an appropriate format
3212 ;; string for coderefs.
3213 ;;
3214 ;; `org-export-inline-image-p' returns a non-nil value when the link
3215 ;; provided should be considered as an inline image.
3216 ;;
3217 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3218 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3219 ;; returns an appropriate unique identifier when found, or nil.
3220 ;;
3221 ;; `org-export-resolve-id-link' returns the first headline with
3222 ;; specified id or custom-id in parse tree, the path to the external
3223 ;; file with the id or nil when neither was found.
3224 ;;
3225 ;; `org-export-resolve-coderef' associates a reference to a line
3226 ;; number in the element it belongs, or returns the reference itself
3227 ;; when the element isn't numbered.
3230 "Take link text S and make a safe target out of it."
3235 "Return format string for code reference link.
3236 PATH is the link path. DESC is its description."
3244 "Non-nil if LINK object points to an inline image.
3246 Optional argument is a set of RULES defining inline images. It
3247 is an alist where associations have the following shape:
3249 \(TYPE . REGEXP)
3251 Applying a rule means apply REGEXP against LINK's path when its
3252 type is TYPE. The function will return a non-nil value if any of
3253 the provided rules is non-nil. The default rule is
3254 `org-export-default-inline-image-rule'.
3256 This only applies to links without a description."
3267 rules)
3268 ;; Return nil if no rule matched.
3269 nil))))
3272 "Resolve a code reference REF.
3274 INFO is a plist used as a communication channel.
3276 Return associated line number in source code, or REF itself,
3277 depending on src-block or example element's switches."
3285 org-coderef-label-format)))
3289 ;; Element containing REF is found. Resolve it to either
3290 ;; a label or a line number, as needed.
3300 "Return LINK destination.
3302 INFO is a plist holding contextual information.
3304 Return value can be an object, an element, or nil:
3306 - If LINK path matches a target object (i.e. <<path>>) or
3309 - If LINK path exactly matches the name affiliated keyword
3310 \(i.e. #+NAME: path) of an element, return that element.
3312 - If LINK path exactly matches any headline name, return that
3313 element. If more than one headline share that name, priority
3314 will be given to the one with the closest common ancestor, if
3315 any, or the first one in the parse tree otherwise.
3317 - Otherwise, return nil.
3323 ;; First try to find a matching "<<path>>" unless user specified
3324 ;; he was looking for an headline (path starts with a *
3325 ;; character).
3329 return target)))
3330 ;; Then try to find an element with a matching "#+NAME: path"
3331 ;; affiliated keyword.
3338 ;; Last case: link either points to an headline or to
3339 ;; nothingness. Try to find the source, with priority given to
3340 ;; headlines with the closest common ancestor. If such candidate
3341 ;; is found, return it, otherwise return nil.
3345 ;; Return first headline whose `:raw-value' property
3346 ;; is NAME in parse tree DATA, or nil.
3349 data 'headline
3353 name)
3354 headline))
3356 ;; Search among headlines sharing an ancestor with link,
3357 ;; from closest to farthest.
3365 ;; No match with a common ancestor: try the full parse-tree.
3371 "Return headline referenced as LINK destination.
3373 INFO is a plist used as a communication channel.
3375 Return value can be the headline element matched in current parse
3379 ;; First check if id is within the current parse tree.
3385 headline))
3387 ;; Otherwise, look for external files.
3391 "Return radio-target object referenced as LINK destination.
3393 INFO is a plist used as a communication channel.
3395 Return value can be a radio-target object or nil. Assume LINK
3405 ;;;; For References
3406 ;;
3407 ;; `org-export-get-ordinal' associates a sequence number to any object
3408 ;; or element.
3411 "Return ordinal number of an element or object.
3413 ELEMENT is the element or object considered. INFO is the plist
3414 used as a communication channel.
3416 Optional argument TYPES, when non-nil, is a list of element or
3417 object types, as symbols, that should also be counted in.
3418 Otherwise, only provided element's type is considered.
3420 Optional argument PREDICATE is a function returning a non-nil
3421 value if the current element or object should be counted in. It
3422 accepts two arguments: the element or object being considered and
3423 the plist used as a communication channel. This allows to count
3424 only a certain type of objects (i.e. inline images).
3426 Return value is a list of numbers if ELEMENT is an headline or an
3427 item. It is nil for keywords. It represents the footnote number
3428 for footnote definitions and footnote references. If ELEMENT is
3429 a target, return the same value as if ELEMENT was the closest
3430 table, item or headline containing the target. In any other
3431 case, return the sequence number of ELEMENT among elements or
3432 objects of the same type."
3433 ;; A target keyword, representing an invisible target, never has
3434 ;; a sequence number.
3436 ;; Ordinal of a target object refer to the ordinal of the closest
3437 ;; table, item, or headline containing the object.
3441 when
3445 table))
3446 return parent)))
3448 ;; Special case 1: An headline returns its number as a list.
3450 ;; Special case 2: An item returns its number as a list.
3454 struct
3461 ;; Increment counter until ELEMENT is found again.
3472 ;;;; For Src-Blocks
3473 ;;
3474 ;; `org-export-get-loc' counts number of code lines accumulated in
3475 ;; src-block or example-block elements with a "+n" switch until
3476 ;; a given element, excluded. Note: "-n" switches reset that count.
3477 ;;
3478 ;; `org-export-unravel-code' extracts source code (along with a code
3479 ;; references alist) from an `element-block' or `src-block' type
3480 ;; element.
3481 ;;
3482 ;; `org-export-format-code' applies a formatting function to each line
3483 ;; of code, providing relative line number and code reference when
3484 ;; appropriate. Since it doesn't access the original element from
3485 ;; which the source code is coming, it expects from the code calling
3486 ;; it to know if lines should be numbered and if code references
3487 ;; should appear.
3488 ;;
3489 ;; Eventually, `org-export-format-code-default' is a higher-level
3490 ;; function (it makes use of the two previous functions) which handles
3491 ;; line numbering and code references inclusion, and returns source
3492 ;; code in a format suitable for plain text or verbatim output.
3495 "Return accumulated lines of code up to ELEMENT.
3497 INFO is the plist used as a communication channel.
3499 ELEMENT is excluded from count."
3506 ;; ELEMENT is reached: Quit the loop.
3508 ;; Only count lines from src-block and example-block elements
3509 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3513 ;; Accumulate locs or reset them.
3517 ;; Return nil to stay in the loop.
3518 nil)))
3520 ;; Return value.
3521 loc))
3524 "Clean source code and extract references out of it.
3526 ELEMENT has either a `src-block' an `example-block' type.
3528 Return a cons cell whose CAR is the source code, cleaned from any
3529 reference and protective comma and CDR is an alist between
3530 relative line number (integer) and name of code reference on that
3531 line (string)."
3533 ;; Get code and clean it. Remove blank lines at its
3534 ;; beginning and end. Also remove protective commas.
3540 ;; If appropriate, remove global indentation.
3544 ;; Free up the protected lines. Note: Org blocks
3545 ;; have commas at the beginning or every line.
3550 ;; Get format used for references.
3553 org-coderef-label-format)))
3554 ;; Build a regexp matching a loc with a reference.
3559 ;; Return value.
3561 ;; Code with references removed.
3567 ;; Ref line: remove ref, and signal its position in REFS.
3571 ;; Reference alist.
3572 refs)))
3575 "Format CODE by applying FUN line-wise and return it.
3577 CODE is a string representing the code to format. FUN is
3578 a function. It must accept three arguments: a line of
3579 code (string), the current line number (integer) or nil and the
3580 reference associated to the current line (string) or nil.
3582 Optional argument NUM-LINES can be an integer representing the
3583 number of code lines accumulated until the current code. Line
3584 numbers passed to FUN will take it into account. If it is nil,
3585 FUN's second argument will always be nil. This number can be
3586 obtained with `org-export-get-loc' function.
3588 Optional argument REF-ALIST can be an alist between relative line
3589 number (i.e. ignoring NUM-LINES) and the name of the code
3590 reference on it. If it is nil, FUN's third argument will always
3591 be nil. It can be obtained through the use of
3592 `org-export-unravel-code' function."
3604 "Return source code from ELEMENT, formatted in a standard way.
3606 ELEMENT is either a `src-block' or `example-block' element. INFO
3607 is a plist used as a communication channel.
3609 This function takes care of line numbering and code references
3610 inclusion. Line numbers, when applicable, appear at the
3611 beginning of the line, separated from the code by two white
3612 spaces. Code references, on the other hand, appear flushed to
3613 the right, separated by six white spaces from the widest line of
3614 code."
3615 ;; Extract code and references.
3621 ;; Handle line numbering.
3630 ;; Prepare references display, if required. Any reference
3631 ;; should start six columns after the widest line of code,
3632 ;; wrapped with parenthesis.
3637 code
3641 number-str
3642 loc
3648 num-start refs)))
3651 ;;;; For Tables
3652 ;;
3653 ;; `org-export-table-has-special-column-p' and and
3654 ;; `org-export-table-row-is-special-p' are predicates used to look for
3655 ;; meta-information about the table structure.
3656 ;;
3657 ;; `org-table-has-header-p' tells when the rows before the first rule
3658 ;; should be considered as table's header.
3659 ;;
3660 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3661 ;; and `org-export-table-cell-borders' extract information from
3662 ;; a table-cell element.
3663 ;;
3664 ;; `org-export-table-dimensions' gives the number on rows and columns
3665 ;; in the table, ignoring horizontal rules and special columns.
3666 ;; `org-export-table-cell-address', given a table-cell object, returns
3667 ;; the absolute address of a cell. On the other hand,
3668 ;; `org-export-get-table-cell-at' does the contrary.
3669 ;;
3670 ;; `org-export-table-cell-starts-colgroup-p',
3671 ;; `org-export-table-cell-ends-colgroup-p',
3672 ;; `org-export-table-row-starts-rowgroup-p',
3673 ;; `org-export-table-row-ends-rowgroup-p',
3674 ;; `org-export-table-row-starts-header-p' and
3675 ;; `org-export-table-row-ends-header-p' indicate position of current
3676 ;; row or cell within the table.
3679 "Non-nil when TABLE has a special column.
3680 All special columns will be ignored during export."
3681 ;; The table has a special column when every first cell of every row
3682 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3683 ;; "*" "_" and "^". Though, do not consider a first row containing
3684 ;; only empty cells as special.
3700 "Non-nil when TABLE has an header.
3702 INFO is a plist used as a communication channel.
3704 A table has an header when it contains at least two row groups."
3707 table 'table-row
3715 info)))
3718 "Non-nil if TABLE-ROW is considered special.
3720 INFO is a plist used as the communication channel.
3722 All special rows will be ignored during export."
3726 ;; A row is special either when...
3728 ;; ... it starts with a field only containing "/",
3730 ;; ... the table contains a special column and the row start
3731 ;; with a marking character among, "^", "_", "$" or "!",
3735 ;; ... it contains only alignment cookies and empty cells.
3741 ;; Since VALUE is a secondary string, the following
3742 ;; checks avoid expanding it with `org-export-data'.
3754 "Return TABLE-ROW's group.
3756 INFO is a plist used as the communication channel.
3758 Return value is the group number, as an integer, or nil special
3759 rows and table rules. Group 1 is also table's header."
3776 "Return TABLE-CELL contents width.
3778 INFO is a plist used as the communication channel.
3780 Return value is the width given by the last width cookie in the
3781 same column as TABLE-CELL, or nil."
3786 cookie-width)
3790 ;; In a special row, try to find a width cookie at COLUMN.
3794 ;; The following checks avoid expanding unnecessarily the
3795 ;; cell with `org-export-data'
3803 ;; Ignore table rules.
3806 ;; Return value.
3807 cookie-width))
3810 "Return TABLE-CELL contents alignment.
3812 INFO is a plist used as the communication channel.
3814 Return alignment as specified by the last alignment cookie in the
3815 same column as TABLE-CELL. If no such cookie is found, a default
3816 alignment value will be deduced from fraction of numbers in the
3817 column (see `org-table-number-fraction' for more information).
3818 Possible values are `left', `right' and `center'."
3825 cookie-align)
3829 ;; In a special row, try to find an alignment cookie at
3830 ;; COLUMN.
3834 ;; Since VALUE is a secondary string, the following checks
3835 ;; avoid useless expansion through `org-export-data'.
3843 ;; Ignore table rules.
3845 ;; In a standard row, check if cell's contents are expressing
3846 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3847 ;; Though, don't bother if an alignment cookie has already
3848 ;; defined cell's alignment.
3853 info)))
3858 ;; Return value. Alignment specified by cookies has precedence
3859 ;; over alignment deduced from cells contents.
3868 "Return TABLE-CELL borders.
3870 INFO is a plist used as a communication channel.
3872 Return value is a list of symbols, or nil. Possible values are:
3873 `top', `bottom', `above', `below', `left' and `right'. Note:
3874 `top' (resp. `bottom') only happen for a cell in the first
3875 row (resp. last row) of the table, ignoring table rules, if any.
3877 Returned borders ignore special rows."
3880 borders)
3881 ;; Top/above border? TABLE-CELL has a border above when a rule
3882 ;; used to demarcate row groups can be found above. Hence,
3883 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3884 ;; another regular row has to be found above that rule.
3893 ;; Look at every row before the current one.
3895 ;; No rule above, or rule found starts the table (ignoring any
3896 ;; special row): TABLE-CELL is at the top of the table.
3899 ;; Bottom/below border? TABLE-CELL has a border below when next
3900 ;; non-regular row below is a rule.
3909 ;; Look at every row after the current one.
3911 ;; No rule below, or rule found ends the table (modulo some
3912 ;; special row): TABLE-CELL is at the bottom of the table.
3915 ;; Right/left borders? They can only be specified by column
3916 ;; groups. Column groups are defined in a row starting with "/".
3917 ;; Also a column groups row only contains "<", "<>", ">" or blank
3918 ;; cells.
3935 ;; There's a left border when previous cell, if
3936 ;; any, ends a group, or current one starts one.
3942 ;; There's a right border when next cell, if any,
3943 ;; starts a group, or current one ends one.
3950 ;; Table rows are read in reverse order so last column groups
3951 ;; row has precedence over any previous one.
3953 ;; Return value.
3954 borders))
3957 "Non-nil when TABLE-CELL is at the beginning of a row group.
3958 INFO is a plist used as a communication channel."
3959 ;; A cell starts a column group either when it is at the beginning
3960 ;; of a row (or after the special column, if any) or when it has
3961 ;; a left border.
3965 table-cell)
3969 "Non-nil when TABLE-CELL is at the end of a row group.
3970 INFO is a plist used as a communication channel."
3971 ;; A cell ends a column group either when it is at the end of a row
3972 ;; or when it has a right border.
3975 table-cell)
3979 "Non-nil when TABLE-ROW is at the beginning of a column group.
3980 INFO is a plist used as a communication channel."
3988 "Non-nil when TABLE-ROW is at the end of a column group.
3989 INFO is a plist used as a communication channel."
3997 "Non-nil when TABLE-ROW is the first table header's row.
3998 INFO is a plist used as a communication channel."
4005 "Non-nil when TABLE-ROW is the last table header's row.
4006 INFO is a plist used as a communication channel."
4013 "Return TABLE dimensions.
4015 INFO is a plist used as a communication channel.
4017 Return value is a CONS like (ROWS . COLUMNS) where
4018 ROWS (resp. COLUMNS) is the number of exportable
4019 rows (resp. columns)."
4021 ;; Set number of rows, and extract first one.
4023 table 'table-row
4028 ;; Set number of columns.
4030 ;; Return value.
4034 "Return address of a regular TABLE-CELL object.
4036 TABLE-CELL is the cell considered. INFO is a plist used as
4037 a communication channel.
4039 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4040 zero-based index. Only exportable cells are considered. The
4041 function returns nil for other cells."
4044 ;; Ignore cells in special rows or in special column.
4049 ;; Row number.
4052 table 'table-row
4058 ;; Column number.
4061 table-row 'table-cell
4067 "Return regular table-cell object at ADDRESS in TABLE.
4069 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4070 zero-based index. TABLE is a table type element. INFO is
4071 a plist used as a communication channel.
4073 If no table-cell, among exportable cells, is found at ADDRESS,
4074 return nil."
4077 ;; Row at (car address) or nil.
4080 table 'table-row
4086 'table-cell
4093 ;;;; For Tables Of Contents
4094 ;;
4095 ;; `org-export-collect-headlines' builds a list of all exportable
4096 ;; headline elements, maybe limited to a certain depth. One can then
4097 ;; easily parse it and transcode it.
4098 ;;
4099 ;; Building lists of tables, figures or listings is quite similar.
4100 ;; Once the generic function `org-export-collect-elements' is defined,
4101 ;; `org-export-collect-tables', `org-export-collect-figures' and
4102 ;; `org-export-collect-listings' can be derived from it.
4105 "Collect headlines in order to build a table of contents.
4107 INFO is a plist used as a communication channel.
4109 When optional argument N is an integer, it specifies the depth of
4110 the table of contents. Otherwise, it is set to the value of the
4111 last headline level. See `org-export-headline-levels' for more
4112 information.
4114 Return a list of all exportable headlines as parsed elements."
4118 'headline
4120 ;; Strip contents from HEADLINE.
4123 info))
4126 "Collect referenceable elements of a determined type.
4128 TYPE can be a symbol or a list of symbols specifying element
4129 types to search. Only elements with a caption are collected.
4131 INFO is a plist used as a communication channel.
4133 When non-nil, optional argument PREDICATE is a function accepting
4134 one argument, an element of type TYPE. It returns a non-nil
4135 value when that element should be collected.
4137 Return a list of all elements found, in order of appearance."
4143 element))
4144 info))
4147 "Build a list of tables.
4148 INFO is a plist used as a communication channel.
4150 Return a list of table elements with a caption."
4154 "Build a list of figures.
4156 INFO is a plist used as a communication channel. PREDICATE is
4157 a function which accepts one argument: a paragraph element and
4158 whose return value is non-nil when that element should be
4159 collected.
4161 A figure is a paragraph type element, with a caption, verifying
4163 a vague concept that may depend on back-end.
4165 Return a list of elements recognized as figures."
4169 "Build a list of src blocks.
4171 INFO is a plist used as a communication channel.
4173 Return a list of src-block elements with a caption."
4177 ;;;; Topology
4178 ;;
4179 ;; Here are various functions to retrieve information about the
4180 ;; neighbourhood of a given element or object. Neighbours of interest
4181 ;; are direct parent (`org-export-get-parent'), parent headline
4182 ;; (`org-export-get-parent-headline'), first element containing an
4183 ;; object, (`org-export-get-parent-element'), parent table
4184 ;; (`org-export-get-parent-table'), previous element or object
4185 ;; (`org-export-get-previous-element') and next element or object
4186 ;; (`org-export-get-next-element').
4187 ;;
4188 ;; `org-export-get-genealogy' returns the full genealogy of a given
4189 ;; element or object, from closest parent to full parse tree.
4192 "Return BLOB parent or nil.
4193 BLOB is the element or object considered."
4197 "Return full genealogy relative to a given element or object.
4199 BLOB is the element or object being considered.
4201 Ancestors are returned from closest to farthest, the last one
4202 being the full parse tree."
4209 "Return BLOB parent headline or nil.
4210 BLOB is the element or object being considered."
4214 parent))
4217 "Return first element containing OBJECT or nil.
4218 OBJECT is the object to consider."
4222 parent))
4225 "Return OBJECT parent table or nil.
4226 OBJECT is either a `table-cell' or `table-element' type object."
4230 parent))
4233 "Return previous element or object.
4234 BLOB is an element or object. INFO is a plist used as
4235 a communication channel. Return previous exportable element or
4236 object, a string, or nil."
4246 "Return next element or object.
4247 BLOB is an element or object. INFO is a plist used as
4248 a communication channel. Return next exportable element or
4249 object, a string, or nil."
4255 nil))
4258 ;;;; Translation
4259 ;;
4260 ;; `org-export-translate' translates a string according to language
4261 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4262 ;; variable and a specified charset. `org-export-dictionary' contains
4263 ;; the dictionary used for the translation.
4385 "Dictionary for export engine.
4387 Alist whose CAR is the string to translate and CDR is an alist
4388 whose CAR is the language string and CDR is a plist whose
4389 properties are possible charsets and values translated terms.
4391 It is used as a database for `org-export-translate'. Since this
4392 function returns the string as-is if no translation was found,
4393 the variable only needs to record values different from the
4397 "Translate string S according to language specification.
4399 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4400 and `:utf-8'. INFO is a plist used as a communication channel.
4402 Translation depends on `:language' property. Return the
4403 translated string. If no translation is found, try to fall back
4404 to `:default' encoding. If it fails, return S."
4410 s)))
4413 \f
4414 ;;; The Dispatcher
4415 ;;
4416 ;; `org-export-dispatch' is the standard interactive way to start an
4417 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4418 ;; for its interface, which, in turn, delegates response to key
4419 ;; pressed to `org-export-dispatch-action'.
4422 "List of menu entries available for `org-export-dispatch'.
4423 This variable shouldn't be set directly. Set-up :menu-entry
4424 keyword in either `org-export-define-backend' or
4427 ;;;###autoload
4429 "Export dispatcher for Org mode.
4431 It provides an access to common export related tasks in a buffer.
4432 Its interface comes in two flavours: standard and expert. While
4433 both share the same set of bindings, only the former displays the
4434 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4435 to switch to one or the other.
4437 Return an error if key pressed has no associated command."
4440 nil
4441 org-export-dispatch-use-expert-ui))
4445 ;; First handle special hard-coded actions.
4451 "Publish project: "
4452 org-e-publish-project-alist nil t)
4453 org-e-publish-project-alist)
4463 "Handle interface for `org-export-dispatch'.
4465 OPTIONS is a list containing current interactive options set for
4466 export. It can contain any of the following symbols:
4467 `body' toggles a body-only export
4468 `subtree' restricts export to current subtree
4469 `visible' restricts export to visible part of buffer.
4470 `force' force publishing files.
4472 FIRST-KEY is the key pressed to select the first level menu. It
4473 is nil when this menu hasn't been selected yet.
4475 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4476 buffer is provided, but indications about currently active
4477 options are given in the prompt. Moreover, \[?] allows to switch
4478 back to standard interface."
4481 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4482 ;; non-nil is the required first-level key to activate
4483 ;; KEY. When its value is t, activate KEY independently
4484 ;; on the first key, if any. A nil value means KEY will
4485 ;; only be activated at first level.
4489 ;; Make sure order of menu doesn't depend on the order in
4490 ;; which back-ends are loaded.
4493 ;; Compute a list of allowed keys based on the first key
4494 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4495 ;; always available.
4505 ;; Build the help menu for standard UI.
4509 ;; Options are hard-coded.
4511 [%s] Body only: %s [%s] Visible only: %s
4521 ;; Display registered back-end entries.
4531 ;; Split sub-menu into two columns.
4541 top-key)
4546 ;; Publishing menu is hard-coded.
4548 [%s] Current file [%s] Current project
4558 ;; Build prompts for both standard and expert UI.
4563 "Export command (Options: %s%s%s%s) [%s]: "
4569 ;; With expert UI, just read key with a fancy prompt. In standard
4570 ;; UI, display an intrusive help buffer.
4573 expert-prompt allowed-keys backends options first-key expertp)
4585 standard-prompt allowed-keys backends options first-key expertp))
4591 "Read a character from command input and act accordingly.
4593 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
4594 a list of characters available at a given step in the process.
4595 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
4596 EXPERTP are the same as defined in `org-export-dispatch-ui',
4597 which see.
4599 Toggle export options when required. Otherwise, return value is
4600 a list with action as CAR and a list of interactive export
4601 options as CDR."
4603 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4604 ;; depending on user's key pressed.
4607 ;; Ignore non-standard characters (i.e. "M-a") and
4608 ;; undefined associations.
4611 ;; q key at first level aborts export. At second
4612 ;; level, cancel first key instead.
4615 ;; Help key: Switch back to standard interface if
4616 ;; expert UI was active.
4618 ;; Toggle export options.
4625 first-key expertp))
4626 ;; Action selected: Send key and options back to
4627 ;; `org-export-dispatch'.
4633 ;; Publishing actions are hard-coded. Send a special
4634 ;; signal to `org-export-dispatch'.
4642 options))
4643 ;; Otherwise, enter sub-menu.
4648 ;;; org-export.el ends here