| blob | 8c4e00352798b7ded28bafff2557a33ed1b21e31 |
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. TITLE keyword is excluded as it has
1375 ;; already been handled already.
1382 ;; Export properties are not case-sensitive.
1389 plist
1391 ;; Parse VALUE if required.
1395 value))))))))
1396 ;; Also look for both general keywords and back-end specific
1397 ;; options if BACKEND is provided.
1402 org-export-options-alist)))
1403 ;; Return value.
1404 plist)))
1407 "Return current buffer export options, as a plist.
1409 Optional argument BACKEND, when non-nil, is a symbol specifying
1410 which back-end specific options should also be read in the
1411 process.
1413 Optional argument FILES is a list of setup files names read so
1414 far, used to avoid circular dependencies.
1416 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1420 ;; 1. Special keywords, as in `org-export-special-keywords'.
1434 ;; Avoid circular dependencies.
1444 ;; 2. Standard options, as in `org-export-options-alist'.
1446 ;; Also look for back-end specific options
1447 ;; if BACKEND is defined.
1453 ;; Build ALIST between keyword name and property name.
1457 all)))
1458 ;; Build regexp matching all keywords associated to export
1459 ;; options. Note: the search is case insensitive.
1473 plist prop
1474 ;; Handle value depending on specified BEHAVIOUR.
1487 ;; Parse keywords specified in
1488 ;; `org-element-document-properties'.
1496 plist prop
1499 org-element-document-properties))
1500 ;; 3. Return final value.
1501 plist)))
1504 "Return properties related to buffer attributes, as a plist."
1507 ;; Store full path of input file name, or nil. For internal use.
1508 :input-file visited-file
1513 :footnote-definition-alist
1514 ;; Footnotes definitions must be collected in the original
1515 ;; buffer, as there's no insurance that they will still be in the
1516 ;; parse tree, due to possible narrowing.
1530 alist))))
1531 alist))
1532 :id-alist
1533 ;; Collect id references.
1544 alist))))
1547 "Return global export options as a plist.
1549 Optional argument BACKEND, if non-nil, is a symbol specifying
1550 which back-end specific export options should also be read in the
1551 process."
1557 ;; Output value.
1558 plist)
1563 plist
1565 ;; Eval default value provided. If keyword is a member
1566 ;; of `org-element-document-properties', parse it as
1567 ;; a secondary string before storing it.
1572 value
1575 all)
1576 ;; Return value.
1577 plist))
1581 "Can we use #+BIND values during export?
1582 By default this will ask for confirmation by the user, to divert
1583 possible security risks."
1588 org-export--allow-BIND-local)
1593 "Install the values from #+BIND lines as local variables.
1594 Variables must be installed before in-buffer options are
1595 retrieved."
1610 ;;;; Tree Properties
1611 ;;
1612 ;; Tree properties are information extracted from parse tree. They
1613 ;; are initialized at the beginning of the transcoding process by
1614 ;; `org-export-collect-tree-properties'.
1615 ;;
1616 ;; Dedicated functions focus on computing the value of specific tree
1617 ;; properties during initialization. Thus,
1618 ;; `org-export--populate-ignore-list' lists elements and objects that
1619 ;; should be skipped during export, `org-export--get-min-level' gets
1620 ;; the minimal exportable level, used as a basis to compute relative
1621 ;; level for headlines. Eventually
1622 ;; `org-export--collect-headline-numbering' builds an alist between
1623 ;; headlines and their numbering.
1626 "Extract tree properties from parse tree.
1628 DATA is the parse tree from which information is retrieved. INFO
1629 is a list holding export options.
1631 Following tree properties are set or updated:
1633 `:exported-data' Hash table used to memoize results from
1634 `org-export-data'.
1636 `:footnote-definition-alist' List of footnotes definitions in
1637 original buffer and current parse tree.
1639 `:headline-offset' Offset between true level of headlines and
1640 local level. An offset of -1 means an headline
1641 of level 2 should be considered as a level
1642 1 headline in the context.
1644 `:headline-numbering' Alist of all headlines as key an the
1645 associated numbering as value.
1647 `:ignore-list' List of elements that should be ignored during
1648 export.
1650 `:target-list' List of all targets in the parse tree.
1652 Return updated plist."
1653 ;; Install the parse tree in the communication channel, in order to
1654 ;; use `org-export-get-genealogy' and al.
1656 ;; Get the list of elements and objects to ignore, and put it into
1657 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1658 ;; been done during parse tree filtering.
1661 :ignore-list
1664 ;; Compute `:headline-offset' in order to be able to use
1665 ;; `org-export-get-relative-level'.
1668 :headline-offset
1670 ;; Update footnotes definitions list with definitions in parse tree.
1671 ;; This is required since buffer expansion might have modified
1672 ;; boundaries of footnote definitions contained in the parse tree.
1673 ;; This way, definitions in `footnote-definition-alist' are bound to
1674 ;; match those in the parse tree.
1677 data 'footnote-definition
1681 defs)))
1683 ;; Properties order doesn't matter: get the rest of the tree
1684 ;; properties.
1686 `(:target-list
1695 info))
1698 "Return minimum exportable headline's level in DATA.
1699 DATA is parsed tree as returned by `org-element-parse-buffer'.
1700 OPTIONS is a plist holding export options."
1711 ;; If no headline was found, for the sake of consistency, set
1712 ;; minimum level to 1 nonetheless.
1716 "Return numbering of all exportable headlines in a parse tree.
1718 DATA is the parse tree. OPTIONS is the plist holding export
1719 options.
1721 Return an alist whose key is an headline and value is its
1722 associated numbering \(in the shape of a list of numbers\)."
1725 data
1726 'headline
1731 headline
1733 for idx from 0 to org-export-max-depth
1737 options)))
1740 "Return list of elements and objects to ignore during export.
1741 DATA is the parse tree to traverse. OPTIONS is the plist holding
1742 export options."
1744 walk-data
1745 ;; First find trees containing a select tag, if any.
1749 ;; Collect ignored elements or objects into IGNORE-LIST.
1755 ;; If headline is archived but tree below has
1756 ;; to be skipped, add it to ignore list.
1759 ;; Move into secondary string, if any.
1764 ;; Move into recursive objects/elements.
1766 ;; Main call.
1768 ;; Return value.
1769 ignore))
1772 "Return list of headlines containing a select tag in their tree.
1773 DATA is parsed data as returned by `org-element-parse-buffer'.
1774 INFO is a plist holding export options."
1776 walk-data ; for byte-compiler.
1787 ;; When a select tag is found, mark full
1788 ;; genealogy and every headline within the tree
1789 ;; as acceptable.
1792 genealogy
1794 selected-trees))
1795 ;; Else, continue searching in tree, recursively.
1802 "Non-nil when element or object BLOB should be skipped during export.
1803 OPTIONS is the plist holding export options. SELECTED, when
1804 non-nil, is a list of headlines belonging to a tree with a select
1805 tag."
1820 ;; Ignore subtrees with an exclude tag.
1823 ;; When a select tag is present in the buffer, ignore any tree
1824 ;; without it.
1826 ;; Ignore commented sub-trees.
1828 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1830 ;; Ignore tasks, if specified by `:with-tasks' property.
1846 ;; No timestamp allowed.
1848 ;; Only active timestamps allowed and the current one isn't
1849 ;; active.
1853 ;; Only inactive timestamps allowed and the current one isn't
1854 ;; inactive.
1860 \f
1861 ;;; The Transcoder
1862 ;;
1863 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1864 ;; `org-element-parse-buffer') and transcodes it into a specified
1865 ;; back-end output. It takes care of filtering out elements or
1866 ;; objects according to export options and organizing the output blank
1867 ;; lines and white space are preserved. The function memoizes its
1868 ;; results, so it is cheap to call it within translators.
1869 ;;
1870 ;; Internally, three functions handle the filtering of objects and
1871 ;; elements during the export. In particular,
1872 ;; `org-export-ignore-element' marks an element or object so future
1873 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1874 ;; elements or objects should be seen as real Org syntax and
1875 ;; `org-export-expand' transforms the others back into their original
1876 ;; shape
1877 ;;
1878 ;; `org-export-transcoder' is an accessor returning appropriate
1879 ;; translator function for a given element or object.
1882 "Return appropriate transcoder for BLOB.
1883 INFO is a plist containing export directives."
1885 ;; Return contents only for complete parse trees.
1891 "Convert DATA into current back-end format.
1893 DATA is a parse tree, an element or an object or a secondary
1894 string. INFO is a plist holding export options.
1896 Return transcoded string."
1902 ;; Ignored element/object.
1904 ;; Plain text.
1910 info))
1911 ;; Uninterpreted element/object: change it back to Org
1912 ;; syntax and export again resulting raw string.
1916 data
1920 info))
1921 ;; Secondary string.
1924 ;; Element/Object without contents or, as a special case,
1925 ;; headline with archive tag and archived trees restricted
1926 ;; to title only.
1934 ;; Element/Object with contents.
1947 ;; Elements directly containing objects
1948 ;; must have their indentation normalized
1949 ;; first.
1951 data
1952 ;; When normalizing contents of the first
1953 ;; paragraph in an item or a footnote
1954 ;; definition, ignore first line's
1955 ;; indentation: there is none and it
1956 ;; might be misleading.
1961 data)
1968 info))))))))
1969 ;; Final result will be memoized before being returned.
1971 data
1975 ;; Append the same white space between elements or objects as in
1976 ;; the original buffer, and call appropriate filters.
1987 info)))
1988 results)))
1992 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1993 Check is done according to export options INFO, stored as
1994 a plist."
1996 ;; ... entities...
1998 ;; ... emphasis...
2000 ;; ... fixed-width areas.
2002 ;; ... footnotes...
2005 ;; ... sub/superscripts...
2011 ;; ... tables...
2016 "Expand a parsed element or object to its original state.
2017 BLOB is either an element or an object. CONTENTS is its
2018 contents, as a string or nil."
2021 blob contents))
2024 "Add ELEMENT to `:ignore-list' in INFO.
2026 Any element in `:ignore-list' will be skipped when using
2027 `org-element-map'. INFO is modified by side effects."
2031 \f
2032 ;;; The Filter System
2033 ;;
2034 ;; Filters allow end-users to tweak easily the transcoded output.
2035 ;; They are the functional counterpart of hooks, as every filter in
2036 ;; a set is applied to the return value of the previous one.
2037 ;;
2038 ;; Every set is back-end agnostic. Although, a filter is always
2039 ;; called, in addition to the string it applies to, with the back-end
2040 ;; used as argument, so it's easy for the end-user to add back-end
2041 ;; specific filters in the set. The communication channel, as
2042 ;; a plist, is required as the third argument.
2043 ;;
2044 ;; From the developer side, filters sets can be installed in the
2045 ;; process with the help of `org-export-define-backend', which
2046 ;; internally sets `org-BACKEND-filters-alist' variable. Each
2047 ;; association has a key among the following symbols and a function or
2048 ;; a list of functions as value.
2049 ;;
2050 ;; - `:filter-parse-tree' applies directly on the complete parsed
2051 ;; tree. It's the only filters set that doesn't apply to a string.
2052 ;; Users can set it through `org-export-filter-parse-tree-functions'
2053 ;; variable.
2054 ;;
2055 ;; - `:filter-final-output' applies to the final transcoded string.
2056 ;; Users can set it with `org-export-filter-final-output-functions'
2057 ;; variable
2058 ;;
2059 ;; - `:filter-plain-text' applies to any string not recognized as Org
2060 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2061 ;; configure it.
2062 ;;
2063 ;; - `:filter-TYPE' applies on the string returned after an element or
2064 ;; object of type TYPE has been transcoded. An user can modify
2065 ;; `org-export-filter-TYPE-functions'
2066 ;;
2067 ;; All filters sets are applied with
2068 ;; `org-export-filter-apply-functions' function. Filters in a set are
2069 ;; applied in a LIFO fashion. It allows developers to be sure that
2070 ;; their filters will be applied first.
2071 ;;
2072 ;; Filters properties are installed in communication channel with
2073 ;; `org-export-install-filters' function.
2074 ;;
2075 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
2076 ;; before parsing to allow for heavy structure modifications.
2079 ;;;; Before Parsing Hook
2082 "Hook run before parsing an export buffer.
2084 This is run after include keywords have been expanded and Babel
2085 code executed, on a copy of original buffer's area being
2086 exported. Visibility is the same as in the original one. Point
2087 is left at the beginning of the new one.
2089 Every function in this hook will be called with one argument: the
2093 ;;;; Special Filters
2096 "List of functions applied to the parsed tree.
2097 Each filter is called with three arguments: the parse tree, as
2098 returned by `org-element-parse-buffer', the back-end, as
2099 a symbol, and the communication channel, as a plist. It must
2103 "List of functions applied to the transcoded string.
2104 Each filter is called with three arguments: the full transcoded
2105 string, the back-end, as a symbol, and the communication channel,
2106 as a plist. It must return a string that will be used as the
2110 "List of functions applied to plain text.
2111 Each filter is called with three arguments: a string which
2112 contains no Org syntax, the back-end, as a symbol, and the
2113 communication channel, as a plist. It must return a string or
2117 ;;;; Elements Filters
2120 "List of functions applied to a transcoded babel-call.
2121 Each filter is called with three arguments: the transcoded data,
2122 as a string, the back-end, as a symbol, and the communication
2126 "List of functions applied to a transcoded center block.
2127 Each filter is called with three arguments: the transcoded data,
2128 as a string, the back-end, as a symbol, and the communication
2132 "List of functions applied to a transcoded clock.
2133 Each filter is called with three arguments: the transcoded data,
2134 as a string, the back-end, as a symbol, and the communication
2138 "List of functions applied to a transcoded comment.
2139 Each filter is called with three arguments: the transcoded data,
2140 as a string, the back-end, as a symbol, and the communication
2144 "List of functions applied to a transcoded comment-comment.
2145 Each filter is called with three arguments: the transcoded data,
2146 as a string, the back-end, as a symbol, and the communication
2150 "List of functions applied to a transcoded drawer.
2151 Each filter is called with three arguments: the transcoded data,
2152 as a string, the back-end, as a symbol, and the communication
2156 "List of functions applied to a transcoded dynamic-block.
2157 Each filter is called with three arguments: the transcoded data,
2158 as a string, the back-end, as a symbol, and the communication
2162 "List of functions applied to a transcoded example-block.
2163 Each filter is called with three arguments: the transcoded data,
2164 as a string, the back-end, as a symbol, and the communication
2168 "List of functions applied to a transcoded export-block.
2169 Each filter is called with three arguments: the transcoded data,
2170 as a string, the back-end, as a symbol, and the communication
2174 "List of functions applied to a transcoded fixed-width.
2175 Each filter is called with three arguments: the transcoded data,
2176 as a string, the back-end, as a symbol, and the communication
2180 "List of functions applied to a transcoded footnote-definition.
2181 Each filter is called with three arguments: the transcoded data,
2182 as a string, the back-end, as a symbol, and the communication
2186 "List of functions applied to a transcoded headline.
2187 Each filter is called with three arguments: the transcoded data,
2188 as a string, the back-end, as a symbol, and the communication
2192 "List of functions applied to a transcoded horizontal-rule.
2193 Each filter is called with three arguments: the transcoded data,
2194 as a string, the back-end, as a symbol, and the communication
2198 "List of functions applied to a transcoded inlinetask.
2199 Each filter is called with three arguments: the transcoded data,
2200 as a string, the back-end, as a symbol, and the communication
2204 "List of functions applied to a transcoded item.
2205 Each filter is called with three arguments: the transcoded data,
2206 as a string, the back-end, as a symbol, and the communication
2210 "List of functions applied to a transcoded keyword.
2211 Each filter is called with three arguments: the transcoded data,
2212 as a string, the back-end, as a symbol, and the communication
2216 "List of functions applied to a transcoded latex-environment.
2217 Each filter is called with three arguments: the transcoded data,
2218 as a string, the back-end, as a symbol, and the communication
2222 "List of functions applied to a transcoded node-property.
2223 Each filter is called with three arguments: the transcoded data,
2224 as a string, the back-end, as a symbol, and the communication
2228 "List of functions applied to a transcoded paragraph.
2229 Each filter is called with three arguments: the transcoded data,
2230 as a string, the back-end, as a symbol, and the communication
2234 "List of functions applied to a transcoded plain-list.
2235 Each filter is called with three arguments: the transcoded data,
2236 as a string, the back-end, as a symbol, and the communication
2240 "List of functions applied to a transcoded planning.
2241 Each filter is called with three arguments: the transcoded data,
2242 as a string, the back-end, as a symbol, and the communication
2246 "List of functions applied to a transcoded property-drawer.
2247 Each filter is called with three arguments: the transcoded data,
2248 as a string, the back-end, as a symbol, and the communication
2252 "List of functions applied to a transcoded quote block.
2253 Each filter is called with three arguments: the transcoded quote
2254 data, as a string, the back-end, as a symbol, and the
2255 communication channel, as a plist. It must return a string or
2259 "List of functions applied to a transcoded quote-section.
2260 Each filter is called with three arguments: the transcoded data,
2261 as a string, the back-end, as a symbol, and the communication
2265 "List of functions applied to a transcoded section.
2266 Each filter is called with three arguments: the transcoded data,
2267 as a string, the back-end, as a symbol, and the communication
2271 "List of functions applied to a transcoded special block.
2272 Each filter is called with three arguments: the transcoded data,
2273 as a string, the back-end, as a symbol, and the communication
2277 "List of functions applied to a transcoded src-block.
2278 Each filter is called with three arguments: the transcoded data,
2279 as a string, the back-end, as a symbol, and the communication
2283 "List of functions applied to a transcoded table.
2284 Each filter is called with three arguments: the transcoded data,
2285 as a string, the back-end, as a symbol, and the communication
2289 "List of functions applied to a transcoded table-cell.
2290 Each filter is called with three arguments: the transcoded data,
2291 as a string, the back-end, as a symbol, and the communication
2295 "List of functions applied to a transcoded table-row.
2296 Each filter is called with three arguments: the transcoded data,
2297 as a string, the back-end, as a symbol, and the communication
2301 "List of functions applied to a transcoded verse block.
2302 Each filter is called with three arguments: the transcoded data,
2303 as a string, the back-end, as a symbol, and the communication
2307 ;;;; Objects Filters
2310 "List of functions applied to transcoded bold text.
2311 Each filter is called with three arguments: the transcoded data,
2312 as a string, the back-end, as a symbol, and the communication
2316 "List of functions applied to transcoded code text.
2317 Each filter is called with three arguments: the transcoded data,
2318 as a string, the back-end, as a symbol, and the communication
2322 "List of functions applied to a transcoded entity.
2323 Each filter is called with three arguments: the transcoded data,
2324 as a string, the back-end, as a symbol, and the communication
2328 "List of functions applied to a transcoded export-snippet.
2329 Each filter is called with three arguments: the transcoded data,
2330 as a string, the back-end, as a symbol, and the communication
2334 "List of functions applied to a transcoded footnote-reference.
2335 Each filter is called with three arguments: the transcoded data,
2336 as a string, the back-end, as a symbol, and the communication
2340 "List of functions applied to a transcoded inline-babel-call.
2341 Each filter is called with three arguments: the transcoded data,
2342 as a string, the back-end, as a symbol, and the communication
2346 "List of functions applied to a transcoded inline-src-block.
2347 Each filter is called with three arguments: the transcoded data,
2348 as a string, the back-end, as a symbol, and the communication
2352 "List of functions applied to transcoded italic text.
2353 Each filter is called with three arguments: the transcoded data,
2354 as a string, the back-end, as a symbol, and the communication
2358 "List of functions applied to a transcoded latex-fragment.
2359 Each filter is called with three arguments: the transcoded data,
2360 as a string, the back-end, as a symbol, and the communication
2364 "List of functions applied to a transcoded line-break.
2365 Each filter is called with three arguments: the transcoded data,
2366 as a string, the back-end, as a symbol, and the communication
2370 "List of functions applied to a transcoded link.
2371 Each filter is called with three arguments: the transcoded data,
2372 as a string, the back-end, as a symbol, and the communication
2376 "List of functions applied to a transcoded macro.
2377 Each filter is called with three arguments: the transcoded data,
2378 as a string, the back-end, as a symbol, and the communication
2382 "List of functions applied to a transcoded radio-target.
2383 Each filter is called with three arguments: the transcoded data,
2384 as a string, the back-end, as a symbol, and the communication
2388 "List of functions applied to a transcoded statistics-cookie.
2389 Each filter is called with three arguments: the transcoded data,
2390 as a string, the back-end, as a symbol, and the communication
2394 "List of functions applied to transcoded strike-through text.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2400 "List of functions applied to a transcoded subscript.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2406 "List of functions applied to a transcoded superscript.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2412 "List of functions applied to a transcoded target.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2418 "List of functions applied to a transcoded timestamp.
2419 Each filter is called with three arguments: the transcoded data,
2420 as a string, the back-end, as a symbol, and the communication
2424 "List of functions applied to transcoded underline text.
2425 Each filter is called with three arguments: the transcoded data,
2426 as a string, the back-end, as a symbol, and the communication
2430 "List of functions applied to transcoded verbatim text.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2436 ;;;; Filters Tools
2437 ;;
2438 ;; Internal function `org-export-install-filters' installs filters
2439 ;; hard-coded in back-ends (developer filters) and filters from global
2440 ;; variables (user filters) in the communication channel.
2441 ;;
2442 ;; Internal function `org-export-filter-apply-functions' takes care
2443 ;; about applying each filter in order to a given data. It ignores
2444 ;; filters returning a nil value but stops whenever a filter returns
2445 ;; an empty string.
2448 "Call every function in FILTERS.
2450 Functions are called with arguments VALUE, current export
2451 back-end and INFO. A function returning a nil value will be
2452 skipped. If it returns the empty string, the process ends and
2453 VALUE is ignored.
2455 Call is done in a LIFO fashion, to be sure that developer
2456 specified filters, if any, are called first."
2465 "Install filters properties in communication channel.
2467 INFO is a plist containing the current communication channel.
2469 Return the updated communication channel."
2471 ;; Install user defined filters with `org-export-filters-alist'.
2474 org-export-filters-alist)
2475 ;; Prepend back-end specific filters to that list.
2480 ;; Single values get consed, lists are prepended.
2485 plist key
2489 ;; Return new communication channel.
2493 \f
2494 ;;; Core functions
2495 ;;
2496 ;; This is the room for the main function, `org-export-as', along with
2497 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2498 ;; They differ only by the way they output the resulting code.
2499 ;;
2500 ;; `org-export-output-file-name' is an auxiliary function meant to be
2501 ;; used with `org-export-to-file'. With a given extension, it tries
2502 ;; to provide a canonical file name to write export output to.
2503 ;;
2504 ;; Note that `org-export-as' doesn't really parse the current buffer,
2505 ;; but a copy of it (with the same buffer-local variables and
2506 ;; visibility), where macros and include keywords are expanded and
2507 ;; Babel blocks are executed, if appropriate.
2508 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2509 ;;
2510 ;; File inclusion is taken care of by
2511 ;; `org-export-expand-include-keyword' and
2512 ;; `org-export--prepare-file-contents'. Structure wise, including
2513 ;; a whole Org file in a buffer often makes little sense. For
2514 ;; example, if the file contains an headline and the include keyword
2515 ;; was within an item, the item should contain the headline. That's
2516 ;; why file inclusion should be done before any structure can be
2517 ;; associated to the file, that is before parsing.
2521 "Transcode current Org buffer into BACKEND code.
2523 If narrowing is active in the current buffer, only transcode its
2524 narrowed part.
2526 If a region is active, transcode that region.
2528 When optional argument SUBTREEP is non-nil, transcode the
2529 sub-tree at point, extracting information from the headline
2530 properties first.
2532 When optional argument VISIBLE-ONLY is non-nil, don't export
2533 contents of hidden elements.
2535 When optional argument BODY-ONLY is non-nil, only return body
2536 code, without preamble nor postamble.
2538 Optional argument EXT-PLIST, when provided, is a property list
2539 with external parameters overriding Org default settings, but
2540 still inferior to file-local settings.
2542 Optional argument NOEXPAND, when non-nil, prevents included files
2543 to be expanded and Babel code to be executed.
2545 Return code as a string."
2546 ;; Barf if BACKEND isn't registered.
2550 ;; Narrow buffer to an appropriate region or subtree for
2551 ;; parsing. If parsing subtree, be sure to remove main headline
2552 ;; too.
2560 ;; 1. Get export environment from original buffer. Also install
2561 ;; user's and developer's filters.
2564 ;; 2. Get parse tree. Buffer isn't parsed directly.
2565 ;; Instead, a temporary copy is created, where macros
2566 ;; and include keywords are expanded and code blocks
2567 ;; are evaluated.
2574 ;; TODO: Setting `org-current-export-file' is
2575 ;; required by Org Babel to properly resolve
2576 ;; noweb references. Once "org-exp.el" is
2577 ;; removed, modify
2578 ;; `org-export-blocks-preprocess' so it accepts
2579 ;; the value as an argument instead.
2583 ;; Run hook
2584 ;; `org-export-before-parsing-hook'. with current
2585 ;; back-end as argument.
2588 ;; Eventually parse buffer.
2590 ;; 3. Call parse-tree filters to get the final tree.
2594 ;; 4. Now tree is complete, compute its properties and add
2595 ;; them to communication channel.
2599 ;; 5. Eventually transcode TREE. Wrap the resulting string
2600 ;; into a template, if required. Eventually call
2601 ;; final-output filter.
2609 info)))
2610 ;; Maybe add final OUTPUT to kill ring, then return it.
2612 output)))))
2616 "Call `org-export-as' with output to a specified buffer.
2618 BACKEND is the back-end used for transcoding, as a symbol.
2620 BUFFER is the output buffer. If it already exists, it will be
2621 erased first, otherwise, it will be created.
2623 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2624 and NOEXPAND are similar to those used in `org-export-as', which
2625 see.
2627 Return buffer."
2629 backend subtreep visible-only body-only ext-plist noexpand))
2635 buffer))
2639 "Call `org-export-as' with output to a specified file.
2641 BACKEND is the back-end used for transcoding, as a symbol. FILE
2642 is the name of the output file, as a string.
2644 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2645 and NOEXPAND are similar to those used in `org-export-as', which
2646 see.
2648 Return output file's name."
2649 ;; Checks for FILE permissions. `write-file' would do the same, but
2650 ;; we'd rather avoid needless transcoding of parse tree.
2652 ;; Insert contents to a temporary buffer and write it to FILE.
2654 backend subtreep visible-only body-only ext-plist noexpand)))
2659 ;; Return full path.
2660 file)
2663 "Return output file's name according to buffer specifications.
2665 EXTENSION is a string representing the output file extension,
2666 with the leading dot.
2668 With a non-nil optional argument SUBTREEP, try to determine
2670 of subtree at point.
2672 When optional argument PUB-DIR is set, use it as the publishing
2673 directory.
2675 When optional argument VISIBLE-ONLY is non-nil, don't export
2676 contents of hidden elements.
2678 Return file name as a string, or nil if it couldn't be
2679 determined."
2681 ;; File name may come from EXPORT_FILE_NAME subtree property,
2682 ;; assuming point is at beginning of said sub-tree.
2689 ;; File name may be extracted from buffer's associated
2690 ;; file, if any.
2692 ;; Can't determine file name on our own: Ask user.
2696 "Output file: " pub-dir nil nil nil
2699 ;; Build file name. Enforce EXTENSION over whatever user may have
2700 ;; come up with. PUB-DIR, if defined, always has precedence over
2701 ;; any provided path.
2706 extension))
2712 "Apply BODY in a copy of the current buffer.
2714 The copy preserves local variables and visibility of the original
2715 buffer.
2717 Point is at buffer's beginning when BODY is applied."
2727 ,original-buffer
2732 ov
2742 "Expand every include keyword in buffer.
2743 Optional argument INCLUDED is a list of included file names along
2744 with their line restriction, when appropriate. It is used to
2745 avoid infinite recursion. Optional argument DIR is the current
2746 working directory. It is used to properly resolve relative
2747 paths."
2754 ;; Extract arguments from keyword's value.
2768 ;; Minimal level of included file defaults to the child
2769 ;; level of the current headline, if any, or one. It
2770 ;; only applies is the file is meant to be included as
2771 ;; an Org one.
2779 ;; Remove keyword.
2783 ;; Check if files has already been parsed. Look after
2784 ;; inclusion lines too, as different parts of the same file
2785 ;; can be included too.
2794 ;; Protect sensitive contents with commas.
2800 ind-str contents ind-str))))
2805 ;; Protect sensitive contents with commas.
2812 ind-str env contents ind-str))))
2825 "Prepare the contents of FILE for inclusion and return them as a string.
2827 When optional argument LINES is a string specifying a range of
2828 lines, include only those lines.
2830 Optional argument IND, when non-nil, is an integer specifying the
2831 global indentation of returned contents. Since its purpose is to
2832 allow an included file to stay in the same environment it was
2833 created \(i.e. a list item), it doesn't apply past the first
2834 headline encountered.
2836 Optional argument MINLEVEL, when non-nil, is an integer
2837 specifying the level that any top-level headline in the included
2838 file should have."
2854 ;; Remove blank lines at beginning and end of contents. The logic
2855 ;; behind that removal is that blank lines around include keyword
2856 ;; override blank lines in included file.
2865 ;; If IND is set, preserve indentation of include keyword until
2866 ;; the first headline encountered.
2872 ;; Do not move footnote definitions out of column 0.
2878 ;; When MINLEVEL is specified, compute minimal level for headlines
2879 ;; in the file (CUR-MIN), and remove stars to each headline so
2880 ;; that headlines with minimal level have a level of MINLEVEL.
2889 ;; Only change stars, don't bother moving whole
2890 ;; sections.
2896 \f
2897 ;;; Tools For Back-Ends
2898 ;;
2899 ;; A whole set of tools is available to help build new exporters. Any
2900 ;; function general enough to have its use across many back-ends
2901 ;; should be added here.
2903 ;;;; For Affiliated Keywords
2904 ;;
2905 ;; `org-export-read-attribute' reads a property from a given element
2906 ;; as a plist. It can be used to normalize affiliated keywords'
2907 ;; syntax.
2908 ;;
2909 ;; Since captions can span over multiple lines and accept dual values,
2910 ;; their internal representation is a bit tricky. Therefore,
2911 ;; `org-export-get-caption' transparently returns a given element's
2912 ;; caption as a secondary string.
2915 "Turn ATTRIBUTE property from ELEMENT into a plist.
2917 When optional argument PROPERTY is non-nil, return the value of
2918 that property within attributes.
2922 properties."
2930 "Return caption from ELEMENT as a secondary string.
2932 When optional argument SHORTP is non-nil, return short caption,
2933 as a secondary string, instead.
2935 Caption lines are separated by a white space."
2943 ;;;; For Export Snippets
2944 ;;
2945 ;; Every export snippet is transmitted to the back-end. Though, the
2946 ;; latter will only retain one type of export-snippet, ignoring
2947 ;; others, based on the former's target back-end. The function
2948 ;; `org-export-snippet-backend' returns that back-end for a given
2949 ;; export-snippet.
2952 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2953 Translation, with `org-export-snippet-translation-alist', is
2954 applied."
2958 back-end))))
2961 ;;;; For Footnotes
2962 ;;
2963 ;; `org-export-collect-footnote-definitions' is a tool to list
2964 ;; actually used footnotes definitions in the whole parse tree, or in
2965 ;; an headline, in order to add footnote listings throughout the
2966 ;; transcoded data.
2967 ;;
2968 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2969 ;; back-ends, when they need to attach the footnote definition only to
2970 ;; the first occurrence of the corresponding label.
2971 ;;
2972 ;; `org-export-get-footnote-definition' and
2973 ;; `org-export-get-footnote-number' provide easier access to
2974 ;; additional information relative to a footnote reference.
2977 "Return an alist between footnote numbers, labels and definitions.
2979 DATA is the parse tree from which definitions are collected.
2980 INFO is the plist used as a communication channel.
2982 Definitions are sorted by order of references. They either
2983 appear as Org data or as a secondary string for inlined
2984 footnotes. Unreferenced definitions are ignored."
2986 collect-fn ; for byte-compiler.
2990 ;; Collect footnote number, label and definition in DATA.
2992 data 'footnote-reference
2999 def)
3000 num-alist)
3001 ;; Also search in definition for nested footnotes.
3004 ;; Don't enter footnote definitions since it will happen
3005 ;; when their first reference is found.
3011 "Non-nil when a footnote reference is the first one for its label.
3013 FOOTNOTE-REFERENCE is the footnote reference being considered.
3014 INFO is the plist used as a communication channel."
3016 ;; Anonymous footnotes are always a first reference.
3018 ;; Otherwise, return the first footnote with the same LABEL and
3019 ;; test if it is equal to FOOTNOTE-REFERENCE.
3025 data 'footnote-reference
3030 ;; If FN isn't inlined, be sure to traverse its
3031 ;; definition before resuming search. See
3032 ;; comments in `org-export-get-footnote-number'
3033 ;; for more information.
3037 ;; Don't enter footnote definitions since it will
3038 ;; happen when their first reference is found.
3041 footnote-reference)))))
3044 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3045 INFO is the plist used as a communication channel."
3051 "Return number associated to a footnote.
3053 FOOTNOTE is either a footnote reference or a footnote definition.
3054 INFO is the plist used as a communication channel."
3056 seen-refs
3057 search-ref ; For byte-compiler.
3061 ;; Search footnote references through DATA, filling
3062 ;; SEEN-REFS along the way.
3064 data 'footnote-reference
3068 ;; Anonymous footnote match: return number.
3071 ;; Labels match: return number.
3074 ;; Anonymous footnote: it's always a new one. Also,
3075 ;; be sure to return nil from the `cond' so
3076 ;; `first-match' doesn't get us out of the loop.
3078 ;; Label not seen so far: add it so SEEN-REFS.
3079 ;;
3080 ;; Also search for subsequent references in
3081 ;; footnote definition so numbering follows reading
3082 ;; logic. Note that we don't have to care about
3083 ;; inline definitions, since `org-element-map'
3084 ;; already traverses them at the right time.
3085 ;;
3086 ;; Once again, return nil to stay in the loop.
3091 nil))))
3092 ;; Don't enter footnote definitions since it will happen
3093 ;; when their first reference is found.
3098 ;;;; For Headlines
3099 ;;
3100 ;; `org-export-get-relative-level' is a shortcut to get headline
3101 ;; level, relatively to the lower headline level in the parsed tree.
3102 ;;
3103 ;; `org-export-get-headline-number' returns the section number of an
3104 ;; headline, while `org-export-number-to-roman' allows to convert it
3105 ;; to roman numbers.
3106 ;;
3107 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3108 ;; `org-export-last-sibling-p' are three useful predicates when it
3109 ;; comes to fulfill the `:headline-levels' property.
3112 "Return HEADLINE relative level within current parsed tree.
3113 INFO is a plist holding contextual information."
3118 "Non-nil when HEADLINE is considered as low level.
3120 INFO is a plist used as a communication channel.
3122 A low level headlines has a relative level greater than
3123 `:headline-levels' property value.
3125 Return value is the difference between HEADLINE relative level
3126 and the last level being considered as high enough, or nil."
3133 "Return HEADLINE numbering as a list of numbers.
3134 INFO is a plist holding contextual information."
3138 "Return a non-nil value if HEADLINE element should be numbered.
3139 INFO is a plist used as a communication channel."
3145 "Convert integer N into a roman numeral."
3158 res)))
3161 "Return list of tags associated to ELEMENT.
3163 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3164 is a plist used as a communication channel.
3166 Select tags (see `org-export-select-tags') and exclude tags (see
3167 `org-export-exclude-tags') are removed from the list.
3169 When non-nil, optional argument TAGS should be a list of strings.
3170 Any tag belonging to this list will also be removed."
3177 "Return node PROPERTY value for BLOB.
3179 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3180 element or object.
3182 If optional argument INHERITED is non-nil, the value can be
3183 inherited from a parent headline.
3185 Return value is a string or nil."
3197 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3198 INFO is a plist used as a communication channel."
3203 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3204 INFO is a plist used as a communication channel."
3208 ;;;; For Links
3209 ;;
3210 ;; `org-export-solidify-link-text' turns a string into a safer version
3211 ;; for links, replacing most non-standard characters with hyphens.
3212 ;;
3213 ;; `org-export-get-coderef-format' returns an appropriate format
3214 ;; string for coderefs.
3215 ;;
3216 ;; `org-export-inline-image-p' returns a non-nil value when the link
3217 ;; provided should be considered as an inline image.
3218 ;;
3219 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3220 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3221 ;; returns an appropriate unique identifier when found, or nil.
3222 ;;
3223 ;; `org-export-resolve-id-link' returns the first headline with
3224 ;; specified id or custom-id in parse tree, the path to the external
3225 ;; file with the id or nil when neither was found.
3226 ;;
3227 ;; `org-export-resolve-coderef' associates a reference to a line
3228 ;; number in the element it belongs, or returns the reference itself
3229 ;; when the element isn't numbered.
3232 "Take link text S and make a safe target out of it."
3237 "Return format string for code reference link.
3238 PATH is the link path. DESC is its description."
3246 "Non-nil if LINK object points to an inline image.
3248 Optional argument is a set of RULES defining inline images. It
3249 is an alist where associations have the following shape:
3251 \(TYPE . REGEXP)
3253 Applying a rule means apply REGEXP against LINK's path when its
3254 type is TYPE. The function will return a non-nil value if any of
3255 the provided rules is non-nil. The default rule is
3256 `org-export-default-inline-image-rule'.
3258 This only applies to links without a description."
3269 rules)
3270 ;; Return nil if no rule matched.
3271 nil))))
3274 "Resolve a code reference REF.
3276 INFO is a plist used as a communication channel.
3278 Return associated line number in source code, or REF itself,
3279 depending on src-block or example element's switches."
3287 org-coderef-label-format)))
3291 ;; Element containing REF is found. Resolve it to either
3292 ;; a label or a line number, as needed.
3302 "Return LINK destination.
3304 INFO is a plist holding contextual information.
3306 Return value can be an object, an element, or nil:
3308 - If LINK path matches a target object (i.e. <<path>>) or
3311 - If LINK path exactly matches the name affiliated keyword
3312 \(i.e. #+NAME: path) of an element, return that element.
3314 - If LINK path exactly matches any headline name, return that
3315 element. If more than one headline share that name, priority
3316 will be given to the one with the closest common ancestor, if
3317 any, or the first one in the parse tree otherwise.
3319 - Otherwise, return nil.
3325 ;; First try to find a matching "<<path>>" unless user specified
3326 ;; he was looking for an headline (path starts with a *
3327 ;; character).
3331 return target)))
3332 ;; Then try to find an element with a matching "#+NAME: path"
3333 ;; affiliated keyword.
3340 ;; Last case: link either points to an headline or to
3341 ;; nothingness. Try to find the source, with priority given to
3342 ;; headlines with the closest common ancestor. If such candidate
3343 ;; is found, return it, otherwise return nil.
3347 ;; Return first headline whose `:raw-value' property
3348 ;; is NAME in parse tree DATA, or nil.
3351 data 'headline
3355 name)
3356 headline))
3358 ;; Search among headlines sharing an ancestor with link,
3359 ;; from closest to farthest.
3367 ;; No match with a common ancestor: try the full parse-tree.
3373 "Return headline referenced as LINK destination.
3375 INFO is a plist used as a communication channel.
3377 Return value can be the headline element matched in current parse
3381 ;; First check if id is within the current parse tree.
3387 headline))
3389 ;; Otherwise, look for external files.
3393 "Return radio-target object referenced as LINK destination.
3395 INFO is a plist used as a communication channel.
3397 Return value can be a radio-target object or nil. Assume LINK
3407 ;;;; For References
3408 ;;
3409 ;; `org-export-get-ordinal' associates a sequence number to any object
3410 ;; or element.
3413 "Return ordinal number of an element or object.
3415 ELEMENT is the element or object considered. INFO is the plist
3416 used as a communication channel.
3418 Optional argument TYPES, when non-nil, is a list of element or
3419 object types, as symbols, that should also be counted in.
3420 Otherwise, only provided element's type is considered.
3422 Optional argument PREDICATE is a function returning a non-nil
3423 value if the current element or object should be counted in. It
3424 accepts two arguments: the element or object being considered and
3425 the plist used as a communication channel. This allows to count
3426 only a certain type of objects (i.e. inline images).
3428 Return value is a list of numbers if ELEMENT is an headline or an
3429 item. It is nil for keywords. It represents the footnote number
3430 for footnote definitions and footnote references. If ELEMENT is
3431 a target, return the same value as if ELEMENT was the closest
3432 table, item or headline containing the target. In any other
3433 case, return the sequence number of ELEMENT among elements or
3434 objects of the same type."
3435 ;; A target keyword, representing an invisible target, never has
3436 ;; a sequence number.
3438 ;; Ordinal of a target object refer to the ordinal of the closest
3439 ;; table, item, or headline containing the object.
3443 when
3447 table))
3448 return parent)))
3450 ;; Special case 1: An headline returns its number as a list.
3452 ;; Special case 2: An item returns its number as a list.
3456 struct
3463 ;; Increment counter until ELEMENT is found again.
3474 ;;;; For Src-Blocks
3475 ;;
3476 ;; `org-export-get-loc' counts number of code lines accumulated in
3477 ;; src-block or example-block elements with a "+n" switch until
3478 ;; a given element, excluded. Note: "-n" switches reset that count.
3479 ;;
3480 ;; `org-export-unravel-code' extracts source code (along with a code
3481 ;; references alist) from an `element-block' or `src-block' type
3482 ;; element.
3483 ;;
3484 ;; `org-export-format-code' applies a formatting function to each line
3485 ;; of code, providing relative line number and code reference when
3486 ;; appropriate. Since it doesn't access the original element from
3487 ;; which the source code is coming, it expects from the code calling
3488 ;; it to know if lines should be numbered and if code references
3489 ;; should appear.
3490 ;;
3491 ;; Eventually, `org-export-format-code-default' is a higher-level
3492 ;; function (it makes use of the two previous functions) which handles
3493 ;; line numbering and code references inclusion, and returns source
3494 ;; code in a format suitable for plain text or verbatim output.
3497 "Return accumulated lines of code up to ELEMENT.
3499 INFO is the plist used as a communication channel.
3501 ELEMENT is excluded from count."
3508 ;; ELEMENT is reached: Quit the loop.
3510 ;; Only count lines from src-block and example-block elements
3511 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3515 ;; Accumulate locs or reset them.
3519 ;; Return nil to stay in the loop.
3520 nil)))
3522 ;; Return value.
3523 loc))
3526 "Clean source code and extract references out of it.
3528 ELEMENT has either a `src-block' an `example-block' type.
3530 Return a cons cell whose CAR is the source code, cleaned from any
3531 reference and protective comma and CDR is an alist between
3532 relative line number (integer) and name of code reference on that
3533 line (string)."
3535 ;; Get code and clean it. Remove blank lines at its
3536 ;; beginning and end.
3542 ;; If appropriate, remove global indentation.
3545 c
3547 ;; Get format used for references.
3550 org-coderef-label-format)))
3551 ;; Build a regexp matching a loc with a reference.
3556 ;; Return value.
3558 ;; Code with references removed.
3564 ;; Ref line: remove ref, and signal its position in REFS.
3568 ;; Reference alist.
3569 refs)))
3572 "Format CODE by applying FUN line-wise and return it.
3574 CODE is a string representing the code to format. FUN is
3575 a function. It must accept three arguments: a line of
3576 code (string), the current line number (integer) or nil and the
3577 reference associated to the current line (string) or nil.
3579 Optional argument NUM-LINES can be an integer representing the
3580 number of code lines accumulated until the current code. Line
3581 numbers passed to FUN will take it into account. If it is nil,
3582 FUN's second argument will always be nil. This number can be
3583 obtained with `org-export-get-loc' function.
3585 Optional argument REF-ALIST can be an alist between relative line
3586 number (i.e. ignoring NUM-LINES) and the name of the code
3587 reference on it. If it is nil, FUN's third argument will always
3588 be nil. It can be obtained through the use of
3589 `org-export-unravel-code' function."
3601 "Return source code from ELEMENT, formatted in a standard way.
3603 ELEMENT is either a `src-block' or `example-block' element. INFO
3604 is a plist used as a communication channel.
3606 This function takes care of line numbering and code references
3607 inclusion. Line numbers, when applicable, appear at the
3608 beginning of the line, separated from the code by two white
3609 spaces. Code references, on the other hand, appear flushed to
3610 the right, separated by six white spaces from the widest line of
3611 code."
3612 ;; Extract code and references.
3618 ;; Handle line numbering.
3627 ;; Prepare references display, if required. Any reference
3628 ;; should start six columns after the widest line of code,
3629 ;; wrapped with parenthesis.
3634 code
3638 number-str
3639 loc
3645 num-start refs)))
3648 ;;;; For Tables
3649 ;;
3650 ;; `org-export-table-has-special-column-p' and and
3651 ;; `org-export-table-row-is-special-p' are predicates used to look for
3652 ;; meta-information about the table structure.
3653 ;;
3654 ;; `org-table-has-header-p' tells when the rows before the first rule
3655 ;; should be considered as table's header.
3656 ;;
3657 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3658 ;; and `org-export-table-cell-borders' extract information from
3659 ;; a table-cell element.
3660 ;;
3661 ;; `org-export-table-dimensions' gives the number on rows and columns
3662 ;; in the table, ignoring horizontal rules and special columns.
3663 ;; `org-export-table-cell-address', given a table-cell object, returns
3664 ;; the absolute address of a cell. On the other hand,
3665 ;; `org-export-get-table-cell-at' does the contrary.
3666 ;;
3667 ;; `org-export-table-cell-starts-colgroup-p',
3668 ;; `org-export-table-cell-ends-colgroup-p',
3669 ;; `org-export-table-row-starts-rowgroup-p',
3670 ;; `org-export-table-row-ends-rowgroup-p',
3671 ;; `org-export-table-row-starts-header-p' and
3672 ;; `org-export-table-row-ends-header-p' indicate position of current
3673 ;; row or cell within the table.
3676 "Non-nil when TABLE has a special column.
3677 All special columns will be ignored during export."
3678 ;; The table has a special column when every first cell of every row
3679 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3680 ;; "*" "_" and "^". Though, do not consider a first row containing
3681 ;; only empty cells as special.
3697 "Non-nil when TABLE has an header.
3699 INFO is a plist used as a communication channel.
3701 A table has an header when it contains at least two row groups."
3704 table 'table-row
3712 info)))
3715 "Non-nil if TABLE-ROW is considered special.
3717 INFO is a plist used as the communication channel.
3719 All special rows will be ignored during export."
3723 ;; A row is special either when...
3725 ;; ... it starts with a field only containing "/",
3727 ;; ... the table contains a special column and the row start
3728 ;; with a marking character among, "^", "_", "$" or "!",
3732 ;; ... it contains only alignment cookies and empty cells.
3738 ;; Since VALUE is a secondary string, the following
3739 ;; checks avoid expanding it with `org-export-data'.
3751 "Return TABLE-ROW's group.
3753 INFO is a plist used as the communication channel.
3755 Return value is the group number, as an integer, or nil special
3756 rows and table rules. Group 1 is also table's header."
3773 "Return TABLE-CELL contents width.
3775 INFO is a plist used as the communication channel.
3777 Return value is the width given by the last width cookie in the
3778 same column as TABLE-CELL, or nil."
3783 cookie-width)
3787 ;; In a special row, try to find a width cookie at COLUMN.
3791 ;; The following checks avoid expanding unnecessarily the
3792 ;; cell with `org-export-data'
3800 ;; Ignore table rules.
3803 ;; Return value.
3804 cookie-width))
3807 "Return TABLE-CELL contents alignment.
3809 INFO is a plist used as the communication channel.
3811 Return alignment as specified by the last alignment cookie in the
3812 same column as TABLE-CELL. If no such cookie is found, a default
3813 alignment value will be deduced from fraction of numbers in the
3814 column (see `org-table-number-fraction' for more information).
3815 Possible values are `left', `right' and `center'."
3822 cookie-align)
3826 ;; In a special row, try to find an alignment cookie at
3827 ;; COLUMN.
3831 ;; Since VALUE is a secondary string, the following checks
3832 ;; avoid useless expansion through `org-export-data'.
3840 ;; Ignore table rules.
3842 ;; In a standard row, check if cell's contents are expressing
3843 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3844 ;; Though, don't bother if an alignment cookie has already
3845 ;; defined cell's alignment.
3850 info)))
3855 ;; Return value. Alignment specified by cookies has precedence
3856 ;; over alignment deduced from cells contents.
3865 "Return TABLE-CELL borders.
3867 INFO is a plist used as a communication channel.
3869 Return value is a list of symbols, or nil. Possible values are:
3870 `top', `bottom', `above', `below', `left' and `right'. Note:
3871 `top' (resp. `bottom') only happen for a cell in the first
3872 row (resp. last row) of the table, ignoring table rules, if any.
3874 Returned borders ignore special rows."
3877 borders)
3878 ;; Top/above border? TABLE-CELL has a border above when a rule
3879 ;; used to demarcate row groups can be found above. Hence,
3880 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3881 ;; another regular row has to be found above that rule.
3890 ;; Look at every row before the current one.
3892 ;; No rule above, or rule found starts the table (ignoring any
3893 ;; special row): TABLE-CELL is at the top of the table.
3896 ;; Bottom/below border? TABLE-CELL has a border below when next
3897 ;; non-regular row below is a rule.
3906 ;; Look at every row after the current one.
3908 ;; No rule below, or rule found ends the table (modulo some
3909 ;; special row): TABLE-CELL is at the bottom of the table.
3912 ;; Right/left borders? They can only be specified by column
3913 ;; groups. Column groups are defined in a row starting with "/".
3914 ;; Also a column groups row only contains "<", "<>", ">" or blank
3915 ;; cells.
3932 ;; There's a left border when previous cell, if
3933 ;; any, ends a group, or current one starts one.
3939 ;; There's a right border when next cell, if any,
3940 ;; starts a group, or current one ends one.
3947 ;; Table rows are read in reverse order so last column groups
3948 ;; row has precedence over any previous one.
3950 ;; Return value.
3951 borders))
3954 "Non-nil when TABLE-CELL is at the beginning of a row group.
3955 INFO is a plist used as a communication channel."
3956 ;; A cell starts a column group either when it is at the beginning
3957 ;; of a row (or after the special column, if any) or when it has
3958 ;; a left border.
3962 table-cell)
3966 "Non-nil when TABLE-CELL is at the end of a row group.
3967 INFO is a plist used as a communication channel."
3968 ;; A cell ends a column group either when it is at the end of a row
3969 ;; or when it has a right border.
3972 table-cell)
3976 "Non-nil when TABLE-ROW is at the beginning of a column group.
3977 INFO is a plist used as a communication channel."
3985 "Non-nil when TABLE-ROW is at the end of a column group.
3986 INFO is a plist used as a communication channel."
3994 "Non-nil when TABLE-ROW is the first table header's row.
3995 INFO is a plist used as a communication channel."
4002 "Non-nil when TABLE-ROW is the last table header's row.
4003 INFO is a plist used as a communication channel."
4010 "Return TABLE dimensions.
4012 INFO is a plist used as a communication channel.
4014 Return value is a CONS like (ROWS . COLUMNS) where
4015 ROWS (resp. COLUMNS) is the number of exportable
4016 rows (resp. columns)."
4018 ;; Set number of rows, and extract first one.
4020 table 'table-row
4025 ;; Set number of columns.
4027 ;; Return value.
4031 "Return address of a regular TABLE-CELL object.
4033 TABLE-CELL is the cell considered. INFO is a plist used as
4034 a communication channel.
4036 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4037 zero-based index. Only exportable cells are considered. The
4038 function returns nil for other cells."
4041 ;; Ignore cells in special rows or in special column.
4046 ;; Row number.
4049 table 'table-row
4055 ;; Column number.
4058 table-row 'table-cell
4064 "Return regular table-cell object at ADDRESS in TABLE.
4066 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4067 zero-based index. TABLE is a table type element. INFO is
4068 a plist used as a communication channel.
4070 If no table-cell, among exportable cells, is found at ADDRESS,
4071 return nil."
4074 ;; Row at (car address) or nil.
4077 table 'table-row
4083 'table-cell
4090 ;;;; For Tables Of Contents
4091 ;;
4092 ;; `org-export-collect-headlines' builds a list of all exportable
4093 ;; headline elements, maybe limited to a certain depth. One can then
4094 ;; easily parse it and transcode it.
4095 ;;
4096 ;; Building lists of tables, figures or listings is quite similar.
4097 ;; Once the generic function `org-export-collect-elements' is defined,
4098 ;; `org-export-collect-tables', `org-export-collect-figures' and
4099 ;; `org-export-collect-listings' can be derived from it.
4102 "Collect headlines in order to build a table of contents.
4104 INFO is a plist used as a communication channel.
4106 When optional argument N is an integer, it specifies the depth of
4107 the table of contents. Otherwise, it is set to the value of the
4108 last headline level. See `org-export-headline-levels' for more
4109 information.
4111 Return a list of all exportable headlines as parsed elements."
4115 'headline
4117 ;; Strip contents from HEADLINE.
4120 info))
4123 "Collect referenceable elements of a determined type.
4125 TYPE can be a symbol or a list of symbols specifying element
4126 types to search. Only elements with a caption are collected.
4128 INFO is a plist used as a communication channel.
4130 When non-nil, optional argument PREDICATE is a function accepting
4131 one argument, an element of type TYPE. It returns a non-nil
4132 value when that element should be collected.
4134 Return a list of all elements found, in order of appearance."
4140 element))
4141 info))
4144 "Build a list of tables.
4145 INFO is a plist used as a communication channel.
4147 Return a list of table elements with a caption."
4151 "Build a list of figures.
4153 INFO is a plist used as a communication channel. PREDICATE is
4154 a function which accepts one argument: a paragraph element and
4155 whose return value is non-nil when that element should be
4156 collected.
4158 A figure is a paragraph type element, with a caption, verifying
4160 a vague concept that may depend on back-end.
4162 Return a list of elements recognized as figures."
4166 "Build a list of src blocks.
4168 INFO is a plist used as a communication channel.
4170 Return a list of src-block elements with a caption."
4174 ;;;; Topology
4175 ;;
4176 ;; Here are various functions to retrieve information about the
4177 ;; neighbourhood of a given element or object. Neighbours of interest
4178 ;; are direct parent (`org-export-get-parent'), parent headline
4179 ;; (`org-export-get-parent-headline'), first element containing an
4180 ;; object, (`org-export-get-parent-element'), parent table
4181 ;; (`org-export-get-parent-table'), previous element or object
4182 ;; (`org-export-get-previous-element') and next element or object
4183 ;; (`org-export-get-next-element').
4184 ;;
4185 ;; `org-export-get-genealogy' returns the full genealogy of a given
4186 ;; element or object, from closest parent to full parse tree.
4189 "Return BLOB parent or nil.
4190 BLOB is the element or object considered."
4194 "Return full genealogy relative to a given element or object.
4196 BLOB is the element or object being considered.
4198 Ancestors are returned from closest to farthest, the last one
4199 being the full parse tree."
4206 "Return BLOB parent headline or nil.
4207 BLOB is the element or object being considered."
4211 parent))
4214 "Return first element containing OBJECT or nil.
4215 OBJECT is the object to consider."
4219 parent))
4222 "Return OBJECT parent table or nil.
4223 OBJECT is either a `table-cell' or `table-element' type object."
4227 parent))
4230 "Return previous element or object.
4231 BLOB is an element or object. INFO is a plist used as
4232 a communication channel. Return previous exportable element or
4233 object, a string, or nil."
4243 "Return next element or object.
4244 BLOB is an element or object. INFO is a plist used as
4245 a communication channel. Return next exportable element or
4246 object, a string, or nil."
4252 nil))
4255 ;;;; Translation
4256 ;;
4257 ;; `org-export-translate' translates a string according to language
4258 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4259 ;; variable and a specified charset. `org-export-dictionary' contains
4260 ;; the dictionary used for the translation.
4382 "Dictionary for export engine.
4384 Alist whose CAR is the string to translate and CDR is an alist
4385 whose CAR is the language string and CDR is a plist whose
4386 properties are possible charsets and values translated terms.
4388 It is used as a database for `org-export-translate'. Since this
4389 function returns the string as-is if no translation was found,
4390 the variable only needs to record values different from the
4394 "Translate string S according to language specification.
4396 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4397 and `:utf-8'. INFO is a plist used as a communication channel.
4399 Translation depends on `:language' property. Return the
4400 translated string. If no translation is found, try to fall back
4401 to `:default' encoding. If it fails, return S."
4407 s)))
4410 \f
4411 ;;; The Dispatcher
4412 ;;
4413 ;; `org-export-dispatch' is the standard interactive way to start an
4414 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4415 ;; for its interface, which, in turn, delegates response to key
4416 ;; pressed to `org-export-dispatch-action'.
4419 "List of menu entries available for `org-export-dispatch'.
4420 This variable shouldn't be set directly. Set-up :menu-entry
4421 keyword in either `org-export-define-backend' or
4424 ;;;###autoload
4426 "Export dispatcher for Org mode.
4428 It provides an access to common export related tasks in a buffer.
4429 Its interface comes in two flavours: standard and expert. While
4430 both share the same set of bindings, only the former displays the
4431 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4432 to switch to one or the other.
4434 Return an error if key pressed has no associated command."
4437 nil
4438 org-export-dispatch-use-expert-ui))
4442 ;; First handle special hard-coded actions.
4448 "Publish project: "
4449 org-e-publish-project-alist nil t)
4450 org-e-publish-project-alist)
4460 "Handle interface for `org-export-dispatch'.
4462 OPTIONS is a list containing current interactive options set for
4463 export. It can contain any of the following symbols:
4464 `body' toggles a body-only export
4465 `subtree' restricts export to current subtree
4466 `visible' restricts export to visible part of buffer.
4467 `force' force publishing files.
4469 FIRST-KEY is the key pressed to select the first level menu. It
4470 is nil when this menu hasn't been selected yet.
4472 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4473 buffer is provided, but indications about currently active
4474 options are given in the prompt. Moreover, \[?] allows to switch
4475 back to standard interface."
4478 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4479 ;; non-nil is the required first-level key to activate
4480 ;; KEY. When its value is t, activate KEY independently
4481 ;; on the first key, if any. A nil value means KEY will
4482 ;; only be activated at first level.
4486 ;; Make sure order of menu doesn't depend on the order in
4487 ;; which back-ends are loaded.
4490 ;; Compute a list of allowed keys based on the first key
4491 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4492 ;; always available.
4502 ;; Build the help menu for standard UI.
4506 ;; Options are hard-coded.
4508 [%s] Body only: %s [%s] Visible only: %s
4518 ;; Display registered back-end entries.
4528 ;; Split sub-menu into two columns.
4538 top-key)
4543 ;; Publishing menu is hard-coded.
4545 [%s] Current file [%s] Current project
4555 ;; Build prompts for both standard and expert UI.
4560 "Export command (Options: %s%s%s%s) [%s]: "
4566 ;; With expert UI, just read key with a fancy prompt. In standard
4567 ;; UI, display an intrusive help buffer.
4570 expert-prompt allowed-keys backends options first-key expertp)
4582 standard-prompt allowed-keys backends options first-key expertp))
4588 "Read a character from command input and act accordingly.
4590 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
4591 a list of characters available at a given step in the process.
4592 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
4593 EXPERTP are the same as defined in `org-export-dispatch-ui',
4594 which see.
4596 Toggle export options when required. Otherwise, return value is
4597 a list with action as CAR and a list of interactive export
4598 options as CDR."
4600 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4601 ;; depending on user's key pressed.
4604 ;; Ignore non-standard characters (i.e. "M-a") and
4605 ;; undefined associations.
4608 ;; q key at first level aborts export. At second
4609 ;; level, cancel first key instead.
4612 ;; Help key: Switch back to standard interface if
4613 ;; expert UI was active.
4615 ;; Toggle export options.
4622 first-key expertp))
4623 ;; Action selected: Send key and options back to
4624 ;; `org-export-dispatch'.
4630 ;; Publishing actions are hard-coded. Send a special
4631 ;; signal to `org-export-dispatch'.
4639 options))
4640 ;; Otherwise, enter sub-menu.
4645 ;;; org-export.el ends here