| blob | c004fb4a47957fd2a1bf928b2d76d2b4cfbb1d78 |
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:
89 \f
90 ;;; Internal Variables
91 ;;
92 ;; Among internal variables, the most important is
93 ;; `org-export-options-alist'. This variable define the global export
94 ;; options, shared between every exporter, and how they are acquired.
137 "Alist between export properties and ways to set them.
139 The CAR of the alist is the property name, and the CDR is a list
140 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
142 KEYWORD is a string representing a buffer keyword, or nil. Each
143 property defined this way can also be set, during subtree
144 export, through an headline property named after the keyword
146 property).
147 OPTION is a string that could be found in an #+OPTIONS: line.
148 DEFAULT is the default value for the property.
149 BEHAVIOUR determine how Org should handle multiple keywords for
150 the same property. It is a symbol among:
151 nil Keep old value and discard the new one.
152 t Replace old value with the new one.
153 `space' Concatenate the values, separating them with a space.
154 `newline' Concatenate the values, separating them with
155 a newline.
156 `split' Split values at white spaces, and cons them to the
157 previous list.
159 KEYWORD and OPTION have precedence over DEFAULT.
161 All these properties should be back-end agnostic. Back-end
162 specific properties are set through `org-export-define-backend'.
166 "List of in-buffer keywords that require special treatment.
167 These keywords are not directly associated to a property. The
168 way they are handled must be hard-coded into
227 "Alist between filters properties and initial values.
229 The key of each association is a property name accessible through
230 the communication channel. Its value is a configurable global
231 variable defining initial filters.
233 This list is meant to install user specified filters. Back-end
234 developers may install their own filters using
235 `org-export-define-backend'. Filters defined there will always
236 be prepended to the current list, so they always get applied
245 "Default rule for link matching an inline image.
246 This rule applies to links with no description. By default, it
247 will be considered as an inline image if it targets a local file
250 See `org-export-inline-image-p' for more information about
254 \f
255 ;;; User-configurable Variables
256 ;;
257 ;; Configuration for the masses.
258 ;;
259 ;; They should never be accessed directly, as their value is to be
260 ;; stored in a property list (cf. `org-export-options-alist').
261 ;; Back-ends will read their value from there instead.
264 "Options for exporting Org mode files."
269 "General options for export engine."
274 "Whether sub-trees with the ARCHIVE tag should be exported.
276 This can have three different values:
277 nil Do not export, pretend this tree is not present.
278 t Do export the entire tree.
279 `headline' Only export the headline, but skip the tree below it.
281 This option can also be set with the #+OPTIONS line,
290 "Non-nil means insert author name into the exported file.
291 This option can also be set with the #+OPTIONS line,
297 "Non-nil means export CLOCK keywords.
298 This option can also be set with the #+OPTIONS line,
304 "Non-nil means the postamble should contain a creator sentence.
306 The sentence can be set in `org-export-creator-string' and
309 If the value is `comment' insert it as a comment."
319 emacs-version)
320 "String to insert at the end of the generated document."
325 "Non-nil means export contents of standard drawers.
327 When t, all drawers are exported. This may also be a list of
328 drawer names to export. This variable doesn't apply to
329 properties drawers.
331 This option can also be set with the #+OPTIONS line,
341 "Non-nil means insert author email into the exported file.
342 This option can also be set with the #+OPTIONS line,
348 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
350 If the export target supports emphasizing text, the word will be
351 typeset in bold, italic, or underlined, respectively. Not all
352 export backends support this.
359 "Tags that exclude a tree from export.
361 All trees carrying any of these tags will be excluded from
362 export. This is without condition, so even subtrees inside that
363 carry one of the `org-export-select-tags' will be removed.
365 This option can also be set with the #+EXCLUDE_TAGS: keyword."
372 This can be used to have pre-formatted text, fragments of code
373 etc. For example:
374 : ;; Some Lisp examples
375 : (while (defc cnt)
376 : (ding))
377 will be looking just like this in also HTML. See also the QUOTE
378 keyword. Not all export backends support this.
385 "Non-nil means Org footnotes should be exported.
386 This option can also be set with the #+OPTIONS line,
392 "The last level which is still exported as a headline.
394 Inferior levels will produce itemize lists when exported.
401 "The default language for export and clocktable translations, as a string.
402 This may have an association in
403 `org-clock-clocktable-language-setup'."
408 "Non-nil means preserve all line breaks when exporting.
410 Normally, in HTML output paragraphs will be reformatted.
412 This option can also be set with the #+OPTIONS line,
418 "Non-nil means interpret entities when exporting.
421 Å.
423 For a list of supported names, see the constant `org-entities'
424 and the user option `org-entities-user'.
426 This option can also be set with the #+OPTIONS line,
432 "Non-nil means inlinetasks should be exported.
433 This option can also be set with the #+OPTIONS line,
439 "Non-nil means include planning info in export.
440 This option can also be set with the #+OPTIONS: line,
446 "Non-nil means include priority cookies in export.
447 This option can also be set with the #+OPTIONS line,
453 "Non-nil means add section numbers to headlines when exporting.
455 When set to an integer n, numbering will only happen for
456 headlines whose relative level is higher or equal to n.
458 This option can also be set with the #+OPTIONS line,
464 "Tags that select a tree for export.
466 If any such tag is found in a buffer, all trees that do not carry
467 one of these tags will be ignored during export. Inside trees
468 that are selected like this, you can still deselect a subtree by
469 tagging it with one of the `org-export-exclude-tags'.
471 This option can also be set with the #+SELECT_TAGS: keyword."
476 "Non-nil means activate smart quotes during export.
477 This option can also be set with the #+OPTIONS: line,
485 When this option is turned on, these strings will be exported as:
487 Org HTML LaTeX UTF-8
488 -----+----------+--------+-------
490 -- – -- –
491 --- — --- —
494 This option can also be set with the #+OPTIONS line,
500 "Non-nil means include statistics cookies in export.
501 This option can also be set with the #+OPTIONS: line,
509 When this option is turned on, you can use TeX-like syntax for
511 will be considered as a single item - so grouping with {} is
512 normally not needed. For example, the following things will be
513 parsed as single sub- or superscripts.
515 10^24 or 10^tau several digits will be considered 1 item.
516 10^-12 or 10^-tau a leading sign with digits or a word
517 x^2-y^3 will be read as x^2 - y^3, because items are
518 terminated by almost any nonword/nondigit char.
519 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
521 Still, ambiguity is possible - so when in doubt use {} to enclose
522 the sub/superscript. If you set this variable to the symbol
523 `{}', the braces are *required* in order to trigger
524 interpretations as sub/superscript. This can be helpful in
527 This option can also be set with the #+OPTIONS line,
536 "Non-nil means create a table of contents in exported files.
538 The TOC contains headlines with levels up
539 to`org-export-headline-levels'. When an integer, include levels
540 up to N in the toc, this may then be different from
541 `org-export-headline-levels', but it will not be allowed to be
542 larger than the number of headline levels. When nil, no table of
543 contents is made.
545 This option can also be set with the #+OPTIONS line,
555 For example:
557 | Name | Address | Birthday |
558 |-------------+----------+-----------|
559 | Arthur Dent | England | 29.2.2100 |
566 "If nil, do not export tags, just remove them from headlines.
568 If this is the symbol `not-in-toc', tags will be removed from
569 table of contents entries, but still be shown in the headlines of
570 the document.
572 This option can also be set with the #+OPTIONS line,
581 "Non-nil means include TODO items for export.
582 This may have the following values:
583 t include tasks independent of state.
584 todo include only tasks that are not yet done.
585 done include only tasks that are already done.
586 nil remove all tasks before export
587 list of keywords keep only tasks with these keywords"
598 "Non-nil means insert a time stamp into the exported file.
599 The time stamp shows when the file was created.
601 This option can also be set with the #+OPTIONS line,
607 "Non nil means allow timestamps in export.
609 It can be set to `active', `inactive', t or nil, in order to
610 export, respectively, only active timestamps, only inactive ones,
611 all of them or none.
613 This option can also be set with the #+OPTIONS line, e.g.
623 "Non-nil means include TODO keywords in export.
624 When nil, remove all these keywords from the export."
629 "Non-nil means allow #+BIND to define local variable values for export.
630 This is a potential security risk, which is why the user must
631 confirm the use of these lines."
639 "Alist between export snippets back-ends and exporter back-ends.
641 This variable allows to provide shortcuts for export snippets.
645 HTML code while every other back-end will ignore it."
653 "Coding system for the exported file."
658 "Non-nil means exported stuff will also be pushed onto the kill ring."
663 "The initial scope when exporting with `org-export-dispatch'.
664 This variable can be either set to `buffer' or `subtree'."
671 "Non-nil means show buffer after exporting to temp buffer.
672 When Org exports to a file, the buffer visiting that file is ever
673 shown, but remains buried. However, when exporting to
674 a temporary buffer, that buffer is popped up in a second window.
675 When this variable is nil, the buffer remains buried also in
676 these cases."
681 "Non-nil means using a non-intrusive `org-export-dispatch'.
682 In that case, no help buffer is displayed. Though, an indicator
687 be passed the FORCE argument). Also, \[?] allows to switch back
688 to standard mode."
693 \f
694 ;;; Defining New Back-ends
695 ;;
696 ;; `org-export-define-backend' is the standard way to define an export
697 ;; back-end. It allows to specify translators, filters, buffer
698 ;; options and a menu entry. If the new back-end shares translators
699 ;; with another back-end, `org-export-define-derived-backend' may be
700 ;; used instead.
701 ;;
702 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
703 ;; when a given back-end hasn't been registered yet.
706 "Define a new back-end BACKEND.
708 TRANSLATORS is an alist between object or element types and
709 functions handling them.
711 These functions should return a string without any trailing
712 space, or nil. They must accept three arguments: the object or
713 element itself, its contents or nil when it isn't recursive and
714 the property list used as a communication channel.
716 Contents, when not nil, are stripped from any global indentation
717 \(although the relative one is preserved). They also always end
718 with a single newline character.
720 If, for a given type, no function is found, that element or
721 object type will simply be ignored, along with any blank line or
722 white space at its end. The same will happen if the function
723 returns the nil value. If that function returns the empty
724 string, the type will be ignored, but the blank lines or white
725 spaces will be kept.
727 In addition to element and object types, one function can be
728 associated to the `template' symbol and another one to the
729 `plain-text' symbol.
731 The former returns the final transcoded string, and can be used
732 to add a preamble and a postamble to document's body. It must
733 accept two arguments: the transcoded string and the property list
734 containing export options.
736 The latter, when defined, is to be called on every text not
737 recognized as an element or an object. It must accept two
738 arguments: the text string and the information channel. It is an
739 appropriate place to protect special chars relative to the
740 back-end.
742 BODY can start with pre-defined keyword arguments. The following
743 keywords are understood:
745 :export-block
747 String, or list of strings, representing block names that
748 will not be parsed. This is used to specify blocks that will
749 contain raw code specific to the back-end. These blocks
750 still have to be handled by the relative `export-block' type
751 translator.
753 :filters-alist
755 Alist between filters and function, or list of functions,
756 specific to the back-end. See `org-export-filters-alist' for
757 a list of all allowed filters. Filters defined here
758 shouldn't make a back-end test, as it may prevent back-ends
759 derived from this one to behave properly.
761 :menu-entry
763 Menu entry for the export dispatcher. It should be a list
764 like:
766 \(KEY DESCRIPTION ACTION-OR-MENU)
768 where :
770 KEY is a free character selecting the back-end.
771 DESCRIPTION is a string naming the back-end.
772 ACTION-OR-MENU is either a function or an alist.
774 If it is an action, it will be called with three arguments:
775 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
776 for further explanations.
778 If it is an alist, associations should follow the
779 pattern:
781 \(KEY DESCRIPTION ACTION)
783 where KEY, DESCRIPTION and ACTION are described above.
785 Valid values include:
789 or
796 \(lambda (subtree visible body-only)
797 \(org-open-file
798 \(org-e-latex-export-to-pdf subtree visible body-only))))))
800 :options-alist
802 Alist between back-end specific properties introduced in
803 communication channel and how their value are acquired. See
804 `org-export-options-alist' for more information about
805 structure of the values."
820 ;; Define translators.
823 ;; Define options.
827 See `org-export-options-alist' for more information on the
828 structure of the values."
829 backend)))
830 ;; Define filters.
833 "Alist between filters keywords and back-end specific filters.
835 ;; Tell parser to not parse EXPORT-BLOCK blocks.
842 ;; Add an entry for back-end in `org-export-dispatch'.
846 ;; Splice in the body, if any.
850 "Create a new back-end as a variant of an existing one.
852 CHILD is the name of the derived back-end. PARENT is the name of
853 the parent back-end.
855 BODY can start with pre-defined keyword arguments. The following
856 keywords are understood:
858 :export-block
860 String, or list of strings, representing block names that
861 will not be parsed. This is used to specify blocks that will
862 contain raw code specific to the back-end. These blocks
863 still have to be handled by the relative `export-block' type
864 translator.
866 :filters-alist
868 Alist of filters that will overwrite or complete filters
869 defined in PARENT back-end. See `org-export-filters-alist'
870 for a list of allowed filters.
872 :menu-entry
874 Menu entry for the export dispatcher. See
875 `org-export-define-backend' for more information about the
876 expected value.
878 :options-alist
880 Alist of back-end specific properties that will overwrite or
881 complete those defined in PARENT back-end. Refer to
882 `org-export-options-alist' for more information about
883 structure of the values.
885 :sub-menu-entry
887 Append entries to an existing menu in the export dispatcher.
888 The associated value should be a list whose CAR is the
889 character selecting the menu to expand and CDR a list of
890 entries following the pattern:
892 \(KEY DESCRIPTION ACTION)
894 where KEY is a free character triggering the action,
895 DESCRIPTION is a string defining the action, and ACTION is
896 a function that will be called with three arguments:
897 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
898 for further explanations.
900 Valid values include:
904 \(lambda (s v b)
905 \(org-open-file (org-e-beamer-export-to-pdf s v b)))))
907 :translate-alist
909 Alist of element and object types and transcoders that will
910 overwrite or complete transcode table from PARENT back-end.
911 Refer to `org-export-define-backend' for detailed information
912 about transcoders.
915 as a variant of `e-latex' back-end with a custom template
916 function:
918 \(org-export-define-derived-backend my-latex e-latex
919 :translate-alist ((template . my-latex-template-fun)))
921 The back-end could then be called with, for example:
940 ;; Tell parser to not parse EXPORT-BLOCK blocks.
947 ;; Define filters.
954 "Alist between filters keywords and back-end specific filters.
956 ;; Define options.
964 See `org-export-options-alist' for more information on the
965 structure of the values."
966 child))))
967 ;; Define translators.
974 ;; Add an entry for back-end in `org-export-dispatch'.
980 org-export-dispatch-menu-entries))))
984 ;; Splice in the body, if any.
988 "Signal an error if BACKEND isn't defined."
993 \f
994 ;;; The Communication Channel
995 ;;
996 ;; During export process, every function has access to a number of
997 ;; properties. They are of two types:
998 ;;
999 ;; 1. Environment options are collected once at the very beginning of
1000 ;; the process, out of the original buffer and configuration.
1001 ;; Collecting them is handled by `org-export-get-environment'
1002 ;; function.
1003 ;;
1004 ;; Most environment options are defined through the
1005 ;; `org-export-options-alist' variable.
1006 ;;
1007 ;; 2. Tree properties are extracted directly from the parsed tree,
1008 ;; just before export, by `org-export-collect-tree-properties'.
1009 ;;
1010 ;; Here is the full list of properties available during transcode
1011 ;; process, with their category and their value type.
1012 ;;
1013 ;; + `:author' :: Author's name.
1014 ;; - category :: option
1015 ;; - type :: string
1016 ;;
1017 ;; + `:back-end' :: Current back-end used for transcoding.
1018 ;; - category :: tree
1019 ;; - type :: symbol
1020 ;;
1021 ;; + `:creator' :: String to write as creation information.
1022 ;; - category :: option
1023 ;; - type :: string
1024 ;;
1025 ;; + `:date' :: String to use as date.
1026 ;; - category :: option
1027 ;; - type :: string
1028 ;;
1029 ;; + `:description' :: Description text for the current data.
1030 ;; - category :: option
1031 ;; - type :: string
1032 ;;
1033 ;; + `:email' :: Author's email.
1034 ;; - category :: option
1035 ;; - type :: string
1036 ;;
1037 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1038 ;; process.
1039 ;; - category :: option
1040 ;; - type :: list of strings
1041 ;;
1042 ;; + `:exported-data' :: Hash table used for memoizing
1043 ;; `org-export-data'.
1044 ;; - category :: tree
1045 ;; - type :: hash table
1046 ;;
1047 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1048 ;; their definition, as parsed data. Only non-inlined footnotes
1049 ;; are represented in this alist. Also, every definition isn't
1050 ;; guaranteed to be referenced in the parse tree. The purpose of
1051 ;; this property is to preserve definitions from oblivion
1052 ;; (i.e. when the parse tree comes from a part of the original
1053 ;; buffer), it isn't meant for direct use in a back-end. To
1054 ;; retrieve a definition relative to a reference, use
1055 ;; `org-export-get-footnote-definition' instead.
1056 ;; - category :: option
1057 ;; - type :: alist (STRING . LIST)
1058 ;;
1059 ;; + `:headline-levels' :: Maximum level being exported as an
1060 ;; headline. Comparison is done with the relative level of
1061 ;; headlines in the parse tree, not necessarily with their
1062 ;; actual level.
1063 ;; - category :: option
1064 ;; - type :: integer
1065 ;;
1066 ;; + `:headline-offset' :: Difference between relative and real level
1067 ;; of headlines in the parse tree. For example, a value of -1
1068 ;; means a level 2 headline should be considered as level
1069 ;; 1 (cf. `org-export-get-relative-level').
1070 ;; - category :: tree
1071 ;; - type :: integer
1072 ;;
1073 ;; + `:headline-numbering' :: Alist between headlines and their
1074 ;; numbering, as a list of numbers
1075 ;; (cf. `org-export-get-headline-number').
1076 ;; - category :: tree
1077 ;; - type :: alist (INTEGER . LIST)
1078 ;;
1079 ;; + `:id-alist' :: Alist between ID strings and destination file's
1080 ;; path, relative to current directory. It is used by
1081 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1082 ;; external file.
1083 ;; - category :: option
1084 ;; - type :: alist (STRING . STRING)
1085 ;;
1086 ;; + `:ignore-list' :: List of elements and objects that should be
1087 ;; ignored during export.
1088 ;; - category :: tree
1089 ;; - type :: list of elements and objects
1090 ;;
1091 ;; + `:input-file' :: Full path to input file, if any.
1092 ;; - category :: option
1093 ;; - type :: string or nil
1094 ;;
1095 ;; + `:keywords' :: List of keywords attached to data.
1096 ;; - category :: option
1097 ;; - type :: string
1098 ;;
1099 ;; + `:language' :: Default language used for translations.
1100 ;; - category :: option
1101 ;; - type :: string
1102 ;;
1103 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1104 ;; transcoding.
1105 ;; - category :: option
1106 ;; - type :: list (as returned by `org-element-parse-buffer')
1107 ;;
1108 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1109 ;; all line breaks.
1110 ;; - category :: option
1111 ;; - type :: symbol (nil, t)
1112 ;;
1113 ;; + `:section-numbers' :: Non-nil means transcoding should add
1114 ;; section numbers to headlines.
1115 ;; - category :: option
1116 ;; - type :: symbol (nil, t)
1117 ;;
1118 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1119 ;; in transcoding. When such a tag is present, subtrees without
1120 ;; it are de facto excluded from the process. See
1121 ;; `use-select-tags'.
1122 ;; - category :: option
1123 ;; - type :: list of strings
1124 ;;
1125 ;; + `:target-list' :: List of targets encountered in the parse tree.
1126 ;; This is used to partly resolve "fuzzy" links
1127 ;; (cf. `org-export-resolve-fuzzy-link').
1128 ;; - category :: tree
1129 ;; - type :: list of strings
1130 ;;
1131 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1132 ;; a time stamp in the output.
1133 ;; - category :: option
1134 ;; - type :: symbol (nil, t)
1135 ;;
1136 ;; + `:translate-alist' :: Alist between element and object types and
1137 ;; transcoding functions relative to the current back-end.
1138 ;; Special keys `template' and `plain-text' are also possible.
1139 ;; - category :: option
1140 ;; - type :: alist (SYMBOL . FUNCTION)
1141 ;;
1142 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1143 ;; also be transcoded. If it is set to the `headline' symbol,
1144 ;; only the archived headline's name is retained.
1145 ;; - category :: option
1146 ;; - type :: symbol (nil, t, `headline')
1147 ;;
1148 ;; + `:with-author' :: Non-nil means author's name should be included
1149 ;; in the output.
1150 ;; - category :: option
1151 ;; - type :: symbol (nil, t)
1152 ;;
1153 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
1154 ;; - category :: option
1155 ;; - type :: symbol (nil, t)
1156 ;;
1157 ;; + `:with-creator' :: Non-nild means a creation sentence should be
1158 ;; inserted at the end of the transcoded string. If the value
1159 ;; is `comment', it should be commented.
1160 ;; - category :: option
1161 ;; - type :: symbol (`comment', nil, t)
1162 ;;
1163 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1164 ;; its value is a list of names, only drawers with such names
1165 ;; will be transcoded.
1166 ;; - category :: option
1167 ;; - type :: symbol (nil, t) or list of strings
1168 ;;
1169 ;; + `:with-email' :: Non-nil means output should contain author's
1170 ;; email.
1171 ;; - category :: option
1172 ;; - type :: symbol (nil, t)
1173 ;;
1174 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1175 ;; interpreted.
1176 ;; - category :: option
1177 ;; - type :: symbol (nil, t)
1178 ;;
1179 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1180 ;; strings starting with a colon as a fixed-with (verbatim) area.
1181 ;; - category :: option
1182 ;; - type :: symbol (nil, t)
1183 ;;
1184 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1185 ;; footnotes.
1186 ;; - category :: option
1187 ;; - type :: symbol (nil, t)
1188 ;;
1189 ;; + `:with-plannings' :: Non-nil means transcoding should include
1190 ;; planning info.
1191 ;; - category :: option
1192 ;; - type :: symbol (nil, t)
1193 ;;
1194 ;; + `:with-priority' :: Non-nil means transcoding should include
1195 ;; priority cookies.
1196 ;; - category :: option
1197 ;; - type :: symbol (nil, t)
1198 ;;
1199 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1200 ;; plain text.
1201 ;; - category :: option
1202 ;; - type :: symbol (nil, t)
1203 ;;
1204 ;; + `:with-special-strings' :: Non-nil means transcoding should
1205 ;; interpret special strings in plain text.
1206 ;; - category :: option
1207 ;; - type :: symbol (nil, t)
1208 ;;
1209 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1210 ;; interpret subscript and superscript. With a value of "{}",
1211 ;; only interpret those using curly brackets.
1212 ;; - category :: option
1213 ;; - type :: symbol (nil, {}, t)
1214 ;;
1215 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1216 ;; tables.
1217 ;; - category :: option
1218 ;; - type :: symbol (nil, t)
1219 ;;
1220 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1221 ;; headlines. A `not-in-toc' value will remove them from the
1222 ;; table of contents, if any, nonetheless.
1223 ;; - category :: option
1224 ;; - type :: symbol (nil, t, `not-in-toc')
1225 ;;
1226 ;; + `:with-tasks' :: Non-nil means transcoding should include
1227 ;; headlines with a TODO keyword. A `todo' value will only
1228 ;; include headlines with a todo type keyword while a `done'
1229 ;; value will do the contrary. If a list of strings is provided,
1230 ;; only tasks with keywords belonging to that list will be kept.
1231 ;; - category :: option
1232 ;; - type :: symbol (t, todo, done, nil) or list of strings
1233 ;;
1234 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1235 ;; time stamps. Special value `active' (resp. `inactive') ask to
1236 ;; export only active (resp. inactive) timestamps. Otherwise,
1237 ;; completely remove them.
1238 ;; - category :: option
1239 ;; - type :: symbol: (`active', `inactive', t, nil)
1240 ;;
1241 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1242 ;; added to the output. An integer value limits its depth.
1243 ;; - category :: option
1244 ;; - type :: symbol (nil, t or integer)
1245 ;;
1246 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1247 ;; include TODO keywords.
1248 ;; - category :: option
1249 ;; - type :: symbol (nil, t)
1252 ;;;; Environment Options
1253 ;;
1254 ;; Environment options encompass all parameters defined outside the
1255 ;; scope of the parsed data. They come from five sources, in
1256 ;; increasing precedence order:
1257 ;;
1258 ;; - Global variables,
1259 ;; - Buffer's attributes,
1260 ;; - Options keyword symbols,
1261 ;; - Buffer keywords,
1262 ;; - Subtree properties.
1263 ;;
1264 ;; The central internal function with regards to environment options
1265 ;; is `org-export-get-environment'. It updates global variables with
1266 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1267 ;; the different sources.
1268 ;;
1269 ;; The internal functions doing the retrieval are:
1270 ;; `org-export--get-global-options',
1271 ;; `org-export--get-buffer-attributes',
1272 ;; `org-export--parse-option-keyword',
1273 ;; `org-export--get-subtree-options' and
1274 ;; `org-export--get-inbuffer-options'
1275 ;;
1276 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1277 ;; take care of the part relative to "#+BIND:" keywords.
1280 "Collect export options from the current buffer.
1282 Optional argument BACKEND is a symbol specifying which back-end
1283 specific options to read, if any.
1285 When optional argument SUBTREEP is non-nil, assume the export is
1286 done against the current sub-tree.
1288 Third optional argument EXT-PLIST is a property list with
1289 external parameters overriding Org default settings, but still
1290 inferior to file-local settings."
1291 ;; First install #+BIND variables.
1293 ;; Get and prioritize export options...
1295 ;; ... from global variables...
1297 ;; ... from buffer's attributes...
1299 ;; ... from an external property list...
1300 ext-plist
1301 ;; ... from in-buffer settings...
1303 backend
1305 ;; ... and from subtree, when appropriate.
1307 ;; Eventually install back-end symbol and its translation table.
1308 `(:back-end
1309 ,backend
1310 :translate-alist
1315 "Parse an OPTIONS line and return values as a plist.
1316 Optional argument BACKEND is a symbol specifying which back-end
1317 specific items to read, if any."
1324 ;; Build an alist between #+OPTION: item and property-name.
1329 all)))
1330 plist)
1335 options)
1340 alist)
1341 plist))
1344 "Get export options in subtree at point.
1345 Optional argument BACKEND is a symbol specifying back-end used
1346 for export. Return options as a plist."
1347 ;; For each buffer keyword, create an headline property setting the
1348 ;; same property in communication channel. The name for the property
1349 ;; is the keyword with "EXPORT_" appended to it.
1352 ;; Make sure point is at an heading.
1354 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1355 ;; title as its fallback value.
1362 plist :title
1365 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1369 ;; Handle other keywords. TITLE keyword is excluded as it has
1370 ;; already been handled already.
1377 ;; Export properties are not case-sensitive.
1384 plist
1386 ;; Parse VALUE if required.
1390 value))))))))
1391 ;; Also look for both general keywords and back-end specific
1392 ;; options if BACKEND is provided.
1397 org-export-options-alist)))
1398 ;; Return value.
1399 plist)))
1402 "Return current buffer export options, as a plist.
1404 Optional argument BACKEND, when non-nil, is a symbol specifying
1405 which back-end specific options should also be read in the
1406 process.
1408 Optional argument FILES is a list of setup files names read so
1409 far, used to avoid circular dependencies.
1411 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1415 ;; 1. Special keywords, as in `org-export-special-keywords'.
1429 ;; Avoid circular dependencies.
1439 ;; 2. Standard options, as in `org-export-options-alist'.
1441 ;; Also look for back-end specific options
1442 ;; if BACKEND is defined.
1448 ;; Build ALIST between keyword name and property name.
1452 all)))
1453 ;; Build regexp matching all keywords associated to export
1454 ;; options. Note: the search is case insensitive.
1468 plist prop
1469 ;; Handle value depending on specified BEHAVIOUR.
1482 ;; Parse keywords specified in
1483 ;; `org-element-document-properties'.
1491 plist prop
1494 org-element-document-properties))
1495 ;; 3. Return final value.
1496 plist)))
1499 "Return properties related to buffer attributes, as a plist."
1502 ;; Store full path of input file name, or nil. For internal use.
1503 :input-file visited-file
1508 :footnote-definition-alist
1509 ;; Footnotes definitions must be collected in the original
1510 ;; buffer, as there's no insurance that they will still be in the
1511 ;; parse tree, due to possible narrowing.
1525 alist))))
1526 alist))
1527 :id-alist
1528 ;; Collect id references.
1539 alist))))
1542 "Return global export options as a plist.
1544 Optional argument BACKEND, if non-nil, is a symbol specifying
1545 which back-end specific export options should also be read in the
1546 process."
1552 ;; Output value.
1553 plist)
1558 plist
1560 ;; Eval default value provided. If keyword is a member
1561 ;; of `org-element-document-properties', parse it as
1562 ;; a secondary string before storing it.
1567 value
1570 all)
1571 ;; Return value.
1572 plist))
1576 "Can we use #+BIND values during export?
1577 By default this will ask for confirmation by the user, to divert
1578 possible security risks."
1583 org-export--allow-BIND-local)
1588 "Install the values from #+BIND lines as local variables.
1589 Variables must be installed before in-buffer options are
1590 retrieved."
1605 ;;;; Tree Properties
1606 ;;
1607 ;; Tree properties are information extracted from parse tree. They
1608 ;; are initialized at the beginning of the transcoding process by
1609 ;; `org-export-collect-tree-properties'.
1610 ;;
1611 ;; Dedicated functions focus on computing the value of specific tree
1612 ;; properties during initialization. Thus,
1613 ;; `org-export--populate-ignore-list' lists elements and objects that
1614 ;; should be skipped during export, `org-export--get-min-level' gets
1615 ;; the minimal exportable level, used as a basis to compute relative
1616 ;; level for headlines. Eventually
1617 ;; `org-export--collect-headline-numbering' builds an alist between
1618 ;; headlines and their numbering.
1621 "Extract tree properties from parse tree.
1623 DATA is the parse tree from which information is retrieved. INFO
1624 is a list holding export options.
1626 Following tree properties are set or updated:
1628 `:exported-data' Hash table used to memoize results from
1629 `org-export-data'.
1631 `:footnote-definition-alist' List of footnotes definitions in
1632 original buffer and current parse tree.
1634 `:headline-offset' Offset between true level of headlines and
1635 local level. An offset of -1 means an headline
1636 of level 2 should be considered as a level
1637 1 headline in the context.
1639 `:headline-numbering' Alist of all headlines as key an the
1640 associated numbering as value.
1642 `:ignore-list' List of elements that should be ignored during
1643 export.
1645 `:target-list' List of all targets in the parse tree.
1647 Return updated plist."
1648 ;; Install the parse tree in the communication channel, in order to
1649 ;; use `org-export-get-genealogy' and al.
1651 ;; Get the list of elements and objects to ignore, and put it into
1652 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1653 ;; been done during parse tree filtering.
1656 :ignore-list
1659 ;; Compute `:headline-offset' in order to be able to use
1660 ;; `org-export-get-relative-level'.
1663 :headline-offset
1665 ;; Update footnotes definitions list with definitions in parse tree.
1666 ;; This is required since buffer expansion might have modified
1667 ;; boundaries of footnote definitions contained in the parse tree.
1668 ;; This way, definitions in `footnote-definition-alist' are bound to
1669 ;; match those in the parse tree.
1672 data 'footnote-definition
1676 defs)))
1678 ;; Properties order doesn't matter: get the rest of the tree
1679 ;; properties.
1681 `(:target-list
1690 info))
1693 "Return minimum exportable headline's level in DATA.
1694 DATA is parsed tree as returned by `org-element-parse-buffer'.
1695 OPTIONS is a plist holding export options."
1706 ;; If no headline was found, for the sake of consistency, set
1707 ;; minimum level to 1 nonetheless.
1711 "Return numbering of all exportable headlines in a parse tree.
1713 DATA is the parse tree. OPTIONS is the plist holding export
1714 options.
1716 Return an alist whose key is an headline and value is its
1717 associated numbering \(in the shape of a list of numbers\)."
1720 data
1721 'headline
1726 headline
1728 for idx from 0 to org-export-max-depth
1732 options)))
1735 "Return list of elements and objects to ignore during export.
1736 DATA is the parse tree to traverse. OPTIONS is the plist holding
1737 export options."
1739 walk-data
1740 ;; First find trees containing a select tag, if any.
1744 ;; Collect ignored elements or objects into IGNORE-LIST.
1750 ;; If headline is archived but tree below has
1751 ;; to be skipped, add it to ignore list.
1754 ;; Move into secondary string, if any.
1759 ;; Move into recursive objects/elements.
1761 ;; Main call.
1763 ;; Return value.
1764 ignore))
1767 "Return list of headlines containing a select tag in their tree.
1768 DATA is parsed data as returned by `org-element-parse-buffer'.
1769 INFO is a plist holding export options."
1771 walk-data ; for byte-compiler.
1782 ;; When a select tag is found, mark full
1783 ;; genealogy and every headline within the tree
1784 ;; as acceptable.
1787 genealogy
1789 selected-trees))
1790 ;; Else, continue searching in tree, recursively.
1797 "Non-nil when element or object BLOB should be skipped during export.
1798 OPTIONS is the plist holding export options. SELECTED, when
1799 non-nil, is a list of headlines belonging to a tree with a select
1800 tag."
1815 ;; Ignore subtrees with an exclude tag.
1818 ;; When a select tag is present in the buffer, ignore any tree
1819 ;; without it.
1821 ;; Ignore commented sub-trees.
1823 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1825 ;; Ignore tasks, if specified by `:with-tasks' property.
1841 ;; No timestamp allowed.
1843 ;; Only active timestamps allowed and the current one isn't
1844 ;; active.
1848 ;; Only inactive timestamps allowed and the current one isn't
1849 ;; inactive.
1855 \f
1856 ;;; The Transcoder
1857 ;;
1858 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1859 ;; `org-element-parse-buffer') and transcodes it into a specified
1860 ;; back-end output. It takes care of filtering out elements or
1861 ;; objects according to export options and organizing the output blank
1862 ;; lines and white space are preserved. The function memoizes its
1863 ;; results, so it is cheap to call it within translators.
1864 ;;
1865 ;; Internally, three functions handle the filtering of objects and
1866 ;; elements during the export. In particular,
1867 ;; `org-export-ignore-element' marks an element or object so future
1868 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1869 ;; elements or objects should be seen as real Org syntax and
1870 ;; `org-export-expand' transforms the others back into their original
1871 ;; shape
1872 ;;
1873 ;; `org-export-transcoder' is an accessor returning appropriate
1874 ;; translator function for a given element or object.
1877 "Return appropriate transcoder for BLOB.
1878 INFO is a plist containing export directives."
1880 ;; Return contents only for complete parse trees.
1886 "Convert DATA into current back-end format.
1888 DATA is a parse tree, an element or an object or a secondary
1889 string. INFO is a plist holding export options.
1891 Return transcoded string."
1897 ;; Ignored element/object.
1899 ;; Plain text. All residual text properties from parse
1900 ;; tree (i.e. `:parent' property) are removed.
1907 info)))
1908 ;; Uninterpreted element/object: change it back to Org
1909 ;; syntax and export again resulting raw string.
1913 data
1917 info))
1918 ;; Secondary string.
1921 ;; Element/Object without contents or, as a special case,
1922 ;; headline with archive tag and archived trees restricted
1923 ;; to title only.
1931 ;; Element/Object with contents.
1944 ;; Elements directly containing objects
1945 ;; must have their indentation normalized
1946 ;; first.
1948 data
1949 ;; When normalizing contents of the first
1950 ;; paragraph in an item or a footnote
1951 ;; definition, ignore first line's
1952 ;; indentation: there is none and it
1953 ;; might be misleading.
1958 data)
1965 info))))))))
1966 ;; Final result will be memoized before being returned.
1968 data
1972 ;; Append the same white space between elements or objects as in
1973 ;; the original buffer, and call appropriate filters.
1984 info)))
1985 results)))
1989 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1990 Check is done according to export options INFO, stored as
1991 a plist."
1993 ;; ... entities...
1995 ;; ... emphasis...
1997 ;; ... fixed-width areas.
1999 ;; ... footnotes...
2002 ;; ... sub/superscripts...
2008 ;; ... tables...
2013 "Expand a parsed element or object to its original state.
2014 BLOB is either an element or an object. CONTENTS is its
2015 contents, as a string or nil."
2018 blob contents))
2021 "Add ELEMENT to `:ignore-list' in INFO.
2023 Any element in `:ignore-list' will be skipped when using
2024 `org-element-map'. INFO is modified by side effects."
2028 \f
2029 ;;; The Filter System
2030 ;;
2031 ;; Filters allow end-users to tweak easily the transcoded output.
2032 ;; They are the functional counterpart of hooks, as every filter in
2033 ;; a set is applied to the return value of the previous one.
2034 ;;
2035 ;; Every set is back-end agnostic. Although, a filter is always
2036 ;; called, in addition to the string it applies to, with the back-end
2037 ;; used as argument, so it's easy for the end-user to add back-end
2038 ;; specific filters in the set. The communication channel, as
2039 ;; a plist, is required as the third argument.
2040 ;;
2041 ;; From the developer side, filters sets can be installed in the
2042 ;; process with the help of `org-export-define-backend', which
2043 ;; internally sets `org-BACKEND-filters-alist' variable. Each
2044 ;; association has a key among the following symbols and a function or
2045 ;; a list of functions as value.
2046 ;;
2047 ;; - `:filter-parse-tree' applies directly on the complete parsed
2048 ;; tree. It's the only filters set that doesn't apply to a string.
2049 ;; Users can set it through `org-export-filter-parse-tree-functions'
2050 ;; variable.
2051 ;;
2052 ;; - `:filter-final-output' applies to the final transcoded string.
2053 ;; Users can set it with `org-export-filter-final-output-functions'
2054 ;; variable
2055 ;;
2056 ;; - `:filter-plain-text' applies to any string not recognized as Org
2057 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2058 ;; configure it.
2059 ;;
2060 ;; - `:filter-TYPE' applies on the string returned after an element or
2061 ;; object of type TYPE has been transcoded. An user can modify
2062 ;; `org-export-filter-TYPE-functions'
2063 ;;
2064 ;; All filters sets are applied with
2065 ;; `org-export-filter-apply-functions' function. Filters in a set are
2066 ;; applied in a LIFO fashion. It allows developers to be sure that
2067 ;; their filters will be applied first.
2068 ;;
2069 ;; Filters properties are installed in communication channel with
2070 ;; `org-export-install-filters' function.
2071 ;;
2072 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
2073 ;; before parsing to allow for heavy structure modifications.
2076 ;;;; Before Parsing Hook
2079 "Hook run before parsing an export buffer.
2081 This is run after include keywords have been expanded and Babel
2082 code executed, on a copy of original buffer's area being
2083 exported. Visibility is the same as in the original one. Point
2084 is left at the beginning of the new one.
2086 Every function in this hook will be called with one argument: the
2090 ;;;; Special Filters
2093 "List of functions applied to the parsed tree.
2094 Each filter is called with three arguments: the parse tree, as
2095 returned by `org-element-parse-buffer', the back-end, as
2096 a symbol, and the communication channel, as a plist. It must
2100 "List of functions applied to the transcoded string.
2101 Each filter is called with three arguments: the full transcoded
2102 string, the back-end, as a symbol, and the communication channel,
2103 as a plist. It must return a string that will be used as the
2107 "List of functions applied to plain text.
2108 Each filter is called with three arguments: a string which
2109 contains no Org syntax, the back-end, as a symbol, and the
2110 communication channel, as a plist. It must return a string or
2114 ;;;; Elements Filters
2117 "List of functions applied to a transcoded babel-call.
2118 Each filter is called with three arguments: the transcoded data,
2119 as a string, the back-end, as a symbol, and the communication
2123 "List of functions applied to a transcoded center block.
2124 Each filter is called with three arguments: the transcoded data,
2125 as a string, the back-end, as a symbol, and the communication
2129 "List of functions applied to a transcoded clock.
2130 Each filter is called with three arguments: the transcoded data,
2131 as a string, the back-end, as a symbol, and the communication
2135 "List of functions applied to a transcoded comment.
2136 Each filter is called with three arguments: the transcoded data,
2137 as a string, the back-end, as a symbol, and the communication
2141 "List of functions applied to a transcoded comment-comment.
2142 Each filter is called with three arguments: the transcoded data,
2143 as a string, the back-end, as a symbol, and the communication
2147 "List of functions applied to a transcoded drawer.
2148 Each filter is called with three arguments: the transcoded data,
2149 as a string, the back-end, as a symbol, and the communication
2153 "List of functions applied to a transcoded dynamic-block.
2154 Each filter is called with three arguments: the transcoded data,
2155 as a string, the back-end, as a symbol, and the communication
2159 "List of functions applied to a transcoded example-block.
2160 Each filter is called with three arguments: the transcoded data,
2161 as a string, the back-end, as a symbol, and the communication
2165 "List of functions applied to a transcoded export-block.
2166 Each filter is called with three arguments: the transcoded data,
2167 as a string, the back-end, as a symbol, and the communication
2171 "List of functions applied to a transcoded fixed-width.
2172 Each filter is called with three arguments: the transcoded data,
2173 as a string, the back-end, as a symbol, and the communication
2177 "List of functions applied to a transcoded footnote-definition.
2178 Each filter is called with three arguments: the transcoded data,
2179 as a string, the back-end, as a symbol, and the communication
2183 "List of functions applied to a transcoded headline.
2184 Each filter is called with three arguments: the transcoded data,
2185 as a string, the back-end, as a symbol, and the communication
2189 "List of functions applied to a transcoded horizontal-rule.
2190 Each filter is called with three arguments: the transcoded data,
2191 as a string, the back-end, as a symbol, and the communication
2195 "List of functions applied to a transcoded inlinetask.
2196 Each filter is called with three arguments: the transcoded data,
2197 as a string, the back-end, as a symbol, and the communication
2201 "List of functions applied to a transcoded item.
2202 Each filter is called with three arguments: the transcoded data,
2203 as a string, the back-end, as a symbol, and the communication
2207 "List of functions applied to a transcoded keyword.
2208 Each filter is called with three arguments: the transcoded data,
2209 as a string, the back-end, as a symbol, and the communication
2213 "List of functions applied to a transcoded latex-environment.
2214 Each filter is called with three arguments: the transcoded data,
2215 as a string, the back-end, as a symbol, and the communication
2219 "List of functions applied to a transcoded node-property.
2220 Each filter is called with three arguments: the transcoded data,
2221 as a string, the back-end, as a symbol, and the communication
2225 "List of functions applied to a transcoded paragraph.
2226 Each filter is called with three arguments: the transcoded data,
2227 as a string, the back-end, as a symbol, and the communication
2231 "List of functions applied to a transcoded plain-list.
2232 Each filter is called with three arguments: the transcoded data,
2233 as a string, the back-end, as a symbol, and the communication
2237 "List of functions applied to a transcoded planning.
2238 Each filter is called with three arguments: the transcoded data,
2239 as a string, the back-end, as a symbol, and the communication
2243 "List of functions applied to a transcoded property-drawer.
2244 Each filter is called with three arguments: the transcoded data,
2245 as a string, the back-end, as a symbol, and the communication
2249 "List of functions applied to a transcoded quote block.
2250 Each filter is called with three arguments: the transcoded quote
2251 data, as a string, the back-end, as a symbol, and the
2252 communication channel, as a plist. It must return a string or
2256 "List of functions applied to a transcoded quote-section.
2257 Each filter is called with three arguments: the transcoded data,
2258 as a string, the back-end, as a symbol, and the communication
2262 "List of functions applied to a transcoded section.
2263 Each filter is called with three arguments: the transcoded data,
2264 as a string, the back-end, as a symbol, and the communication
2268 "List of functions applied to a transcoded special block.
2269 Each filter is called with three arguments: the transcoded data,
2270 as a string, the back-end, as a symbol, and the communication
2274 "List of functions applied to a transcoded src-block.
2275 Each filter is called with three arguments: the transcoded data,
2276 as a string, the back-end, as a symbol, and the communication
2280 "List of functions applied to a transcoded table.
2281 Each filter is called with three arguments: the transcoded data,
2282 as a string, the back-end, as a symbol, and the communication
2286 "List of functions applied to a transcoded table-cell.
2287 Each filter is called with three arguments: the transcoded data,
2288 as a string, the back-end, as a symbol, and the communication
2292 "List of functions applied to a transcoded table-row.
2293 Each filter is called with three arguments: the transcoded data,
2294 as a string, the back-end, as a symbol, and the communication
2298 "List of functions applied to a transcoded verse block.
2299 Each filter is called with three arguments: the transcoded data,
2300 as a string, the back-end, as a symbol, and the communication
2304 ;;;; Objects Filters
2307 "List of functions applied to transcoded bold text.
2308 Each filter is called with three arguments: the transcoded data,
2309 as a string, the back-end, as a symbol, and the communication
2313 "List of functions applied to transcoded code text.
2314 Each filter is called with three arguments: the transcoded data,
2315 as a string, the back-end, as a symbol, and the communication
2319 "List of functions applied to a transcoded entity.
2320 Each filter is called with three arguments: the transcoded data,
2321 as a string, the back-end, as a symbol, and the communication
2325 "List of functions applied to a transcoded export-snippet.
2326 Each filter is called with three arguments: the transcoded data,
2327 as a string, the back-end, as a symbol, and the communication
2331 "List of functions applied to a transcoded footnote-reference.
2332 Each filter is called with three arguments: the transcoded data,
2333 as a string, the back-end, as a symbol, and the communication
2337 "List of functions applied to a transcoded inline-babel-call.
2338 Each filter is called with three arguments: the transcoded data,
2339 as a string, the back-end, as a symbol, and the communication
2343 "List of functions applied to a transcoded inline-src-block.
2344 Each filter is called with three arguments: the transcoded data,
2345 as a string, the back-end, as a symbol, and the communication
2349 "List of functions applied to transcoded italic text.
2350 Each filter is called with three arguments: the transcoded data,
2351 as a string, the back-end, as a symbol, and the communication
2355 "List of functions applied to a transcoded latex-fragment.
2356 Each filter is called with three arguments: the transcoded data,
2357 as a string, the back-end, as a symbol, and the communication
2361 "List of functions applied to a transcoded line-break.
2362 Each filter is called with three arguments: the transcoded data,
2363 as a string, the back-end, as a symbol, and the communication
2367 "List of functions applied to a transcoded link.
2368 Each filter is called with three arguments: the transcoded data,
2369 as a string, the back-end, as a symbol, and the communication
2373 "List of functions applied to a transcoded macro.
2374 Each filter is called with three arguments: the transcoded data,
2375 as a string, the back-end, as a symbol, and the communication
2379 "List of functions applied to a transcoded radio-target.
2380 Each filter is called with three arguments: the transcoded data,
2381 as a string, the back-end, as a symbol, and the communication
2385 "List of functions applied to a transcoded statistics-cookie.
2386 Each filter is called with three arguments: the transcoded data,
2387 as a string, the back-end, as a symbol, and the communication
2391 "List of functions applied to transcoded strike-through text.
2392 Each filter is called with three arguments: the transcoded data,
2393 as a string, the back-end, as a symbol, and the communication
2397 "List of functions applied to a transcoded subscript.
2398 Each filter is called with three arguments: the transcoded data,
2399 as a string, the back-end, as a symbol, and the communication
2403 "List of functions applied to a transcoded superscript.
2404 Each filter is called with three arguments: the transcoded data,
2405 as a string, the back-end, as a symbol, and the communication
2409 "List of functions applied to a transcoded target.
2410 Each filter is called with three arguments: the transcoded data,
2411 as a string, the back-end, as a symbol, and the communication
2415 "List of functions applied to a transcoded timestamp.
2416 Each filter is called with three arguments: the transcoded data,
2417 as a string, the back-end, as a symbol, and the communication
2421 "List of functions applied to transcoded underline text.
2422 Each filter is called with three arguments: the transcoded data,
2423 as a string, the back-end, as a symbol, and the communication
2427 "List of functions applied to transcoded verbatim text.
2428 Each filter is called with three arguments: the transcoded data,
2429 as a string, the back-end, as a symbol, and the communication
2433 ;;;; Filters Tools
2434 ;;
2435 ;; Internal function `org-export-install-filters' installs filters
2436 ;; hard-coded in back-ends (developer filters) and filters from global
2437 ;; variables (user filters) in the communication channel.
2438 ;;
2439 ;; Internal function `org-export-filter-apply-functions' takes care
2440 ;; about applying each filter in order to a given data. It ignores
2441 ;; filters returning a nil value but stops whenever a filter returns
2442 ;; an empty string.
2445 "Call every function in FILTERS.
2447 Functions are called with arguments VALUE, current export
2448 back-end and INFO. A function returning a nil value will be
2449 skipped. If it returns the empty string, the process ends and
2450 VALUE is ignored.
2452 Call is done in a LIFO fashion, to be sure that developer
2453 specified filters, if any, are called first."
2462 "Install filters properties in communication channel.
2464 INFO is a plist containing the current communication channel.
2466 Return the updated communication channel."
2468 ;; Install user defined filters with `org-export-filters-alist'.
2471 org-export-filters-alist)
2472 ;; Prepend back-end specific filters to that list.
2477 ;; Single values get consed, lists are prepended.
2482 plist key
2486 ;; Return new communication channel.
2490 \f
2491 ;;; Core functions
2492 ;;
2493 ;; This is the room for the main function, `org-export-as', along with
2494 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2495 ;; They differ only by the way they output the resulting code.
2496 ;;
2497 ;; `org-export-output-file-name' is an auxiliary function meant to be
2498 ;; used with `org-export-to-file'. With a given extension, it tries
2499 ;; to provide a canonical file name to write export output to.
2500 ;;
2501 ;; Note that `org-export-as' doesn't really parse the current buffer,
2502 ;; but a copy of it (with the same buffer-local variables and
2503 ;; visibility), where macros and include keywords are expanded and
2504 ;; Babel blocks are executed, if appropriate.
2505 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2506 ;;
2507 ;; File inclusion is taken care of by
2508 ;; `org-export-expand-include-keyword' and
2509 ;; `org-export--prepare-file-contents'. Structure wise, including
2510 ;; a whole Org file in a buffer often makes little sense. For
2511 ;; example, if the file contains an headline and the include keyword
2512 ;; was within an item, the item should contain the headline. That's
2513 ;; why file inclusion should be done before any structure can be
2514 ;; associated to the file, that is before parsing.
2515 ;;
2516 ;; Macro are expanded with `org-export-expand-macro'.
2520 "Transcode current Org buffer into BACKEND code.
2522 If narrowing is active in the current buffer, only transcode its
2523 narrowed part.
2525 If a region is active, transcode that region.
2527 When optional argument SUBTREEP is non-nil, transcode the
2528 sub-tree at point, extracting information from the headline
2529 properties first.
2531 When optional argument VISIBLE-ONLY is non-nil, don't export
2532 contents of hidden elements.
2534 When optional argument BODY-ONLY is non-nil, only return body
2535 code, without preamble nor postamble.
2537 Optional argument EXT-PLIST, when provided, is a property list
2538 with external parameters overriding Org default settings, but
2539 still inferior to file-local settings.
2541 Optional argument NOEXPAND, when non-nil, prevents included files
2542 to be expanded and Babel code to be executed.
2544 Return code as a string."
2545 ;; Barf if BACKEND isn't registered.
2549 ;; Narrow buffer to an appropriate region or subtree for
2550 ;; parsing. If parsing subtree, be sure to remove main headline
2551 ;; too.
2559 ;; 1. Get export environment from original buffer. Also install
2560 ;; user's and developer's filters.
2563 ;; 2. Get parse tree. Buffer isn't parsed directly.
2564 ;; Instead, a temporary copy is created, where include
2565 ;; keywords and macros are expanded and code blocks
2566 ;; are evaluated.
2570 ;; Update radio targets since keyword
2571 ;; inclusion might have added some more.
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
2579 ;; accepts 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.
2693 ;; Can't determine file name on our own: Ask user.
2697 "Output file: " pub-dir nil nil nil
2700 ;; Build file name. Enforce EXTENSION over whatever user may have
2701 ;; come up with. PUB-DIR, if defined, always has precedence over
2702 ;; any provided path.
2707 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
2739 "Expand every macro in buffer.
2740 INFO is a plist containing export options and buffer properties."
2741 ;; First update macro templates since #+INCLUDE keywords might have
2742 ;; added some new ones.
2745 ;; Before expanding macros, install {{{author}}}, {{{date}}},
2746 ;; {{{email}}} and {{{title}}} templates.
2752 ;; EMAIL is not a parsed keyword: store it as-is.
2756 org-macro-templates)))
2759 "Expand every include keyword in buffer.
2760 Optional argument INCLUDED is a list of included file names along
2761 with their line restriction, when appropriate. It is used to
2762 avoid infinite recursion. Optional argument DIR is the current
2763 working directory. It is used to properly resolve relative
2764 paths."
2771 ;; Extract arguments from keyword's value.
2785 ;; Minimal level of included file defaults to the child
2786 ;; level of the current headline, if any, or one. It
2787 ;; only applies is the file is meant to be included as
2788 ;; an Org one.
2796 ;; Remove keyword.
2800 ;; Check if files has already been parsed. Look after
2801 ;; inclusion lines too, as different parts of the same file
2802 ;; can be included too.
2814 ind-str contents ind-str))))
2822 ind-str env contents ind-str))))
2835 "Prepare the contents of FILE for inclusion and return them as a string.
2837 When optional argument LINES is a string specifying a range of
2838 lines, include only those lines.
2840 Optional argument IND, when non-nil, is an integer specifying the
2841 global indentation of returned contents. Since its purpose is to
2842 allow an included file to stay in the same environment it was
2843 created \(i.e. a list item), it doesn't apply past the first
2844 headline encountered.
2846 Optional argument MINLEVEL, when non-nil, is an integer
2847 specifying the level that any top-level headline in the included
2848 file should have."
2864 ;; Remove blank lines at beginning and end of contents. The logic
2865 ;; behind that removal is that blank lines around include keyword
2866 ;; override blank lines in included file.
2875 ;; If IND is set, preserve indentation of include keyword until
2876 ;; the first headline encountered.
2882 ;; Do not move footnote definitions out of column 0.
2888 ;; When MINLEVEL is specified, compute minimal level for headlines
2889 ;; in the file (CUR-MIN), and remove stars to each headline so
2890 ;; that headlines with minimal level have a level of MINLEVEL.
2900 ;; Only change stars, don't bother moving whole
2901 ;; sections.
2907 \f
2908 ;;; Tools For Back-Ends
2909 ;;
2910 ;; A whole set of tools is available to help build new exporters. Any
2911 ;; function general enough to have its use across many back-ends
2912 ;; should be added here.
2914 ;;;; For Affiliated Keywords
2915 ;;
2916 ;; `org-export-read-attribute' reads a property from a given element
2917 ;; as a plist. It can be used to normalize affiliated keywords'
2918 ;; syntax.
2919 ;;
2920 ;; Since captions can span over multiple lines and accept dual values,
2921 ;; their internal representation is a bit tricky. Therefore,
2922 ;; `org-export-get-caption' transparently returns a given element's
2923 ;; caption as a secondary string.
2926 "Turn ATTRIBUTE property from ELEMENT into a plist.
2928 When optional argument PROPERTY is non-nil, return the value of
2929 that property within attributes.
2933 properties."
2941 "Return caption from ELEMENT as a secondary string.
2943 When optional argument SHORTP is non-nil, return short caption,
2944 as a secondary string, instead.
2946 Caption lines are separated by a white space."
2954 ;;;; For Export Snippets
2955 ;;
2956 ;; Every export snippet is transmitted to the back-end. Though, the
2957 ;; latter will only retain one type of export-snippet, ignoring
2958 ;; others, based on the former's target back-end. The function
2959 ;; `org-export-snippet-backend' returns that back-end for a given
2960 ;; export-snippet.
2963 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2964 Translation, with `org-export-snippet-translation-alist', is
2965 applied."
2969 back-end))))
2972 ;;;; For Footnotes
2973 ;;
2974 ;; `org-export-collect-footnote-definitions' is a tool to list
2975 ;; actually used footnotes definitions in the whole parse tree, or in
2976 ;; an headline, in order to add footnote listings throughout the
2977 ;; transcoded data.
2978 ;;
2979 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2980 ;; back-ends, when they need to attach the footnote definition only to
2981 ;; the first occurrence of the corresponding label.
2982 ;;
2983 ;; `org-export-get-footnote-definition' and
2984 ;; `org-export-get-footnote-number' provide easier access to
2985 ;; additional information relative to a footnote reference.
2988 "Return an alist between footnote numbers, labels and definitions.
2990 DATA is the parse tree from which definitions are collected.
2991 INFO is the plist used as a communication channel.
2993 Definitions are sorted by order of references. They either
2994 appear as Org data or as a secondary string for inlined
2995 footnotes. Unreferenced definitions are ignored."
2997 collect-fn ; for byte-compiler.
3001 ;; Collect footnote number, label and definition in DATA.
3003 data 'footnote-reference
3010 def)
3011 num-alist)
3012 ;; Also search in definition for nested footnotes.
3015 ;; Don't enter footnote definitions since it will happen
3016 ;; when their first reference is found.
3022 "Non-nil when a footnote reference is the first one for its label.
3024 FOOTNOTE-REFERENCE is the footnote reference being considered.
3025 INFO is the plist used as a communication channel."
3027 ;; Anonymous footnotes are always a first reference.
3029 ;; Otherwise, return the first footnote with the same LABEL and
3030 ;; test if it is equal to FOOTNOTE-REFERENCE.
3036 data 'footnote-reference
3041 ;; If FN isn't inlined, be sure to traverse its
3042 ;; definition before resuming search. See
3043 ;; comments in `org-export-get-footnote-number'
3044 ;; for more information.
3048 ;; Don't enter footnote definitions since it will
3049 ;; happen when their first reference is found.
3052 footnote-reference)))))
3055 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3056 INFO is the plist used as a communication channel."
3062 "Return number associated to a footnote.
3064 FOOTNOTE is either a footnote reference or a footnote definition.
3065 INFO is the plist used as a communication channel."
3067 seen-refs
3068 search-ref ; For byte-compiler.
3072 ;; Search footnote references through DATA, filling
3073 ;; SEEN-REFS along the way.
3075 data 'footnote-reference
3079 ;; Anonymous footnote match: return number.
3082 ;; Labels match: return number.
3085 ;; Anonymous footnote: it's always a new one. Also,
3086 ;; be sure to return nil from the `cond' so
3087 ;; `first-match' doesn't get us out of the loop.
3089 ;; Label not seen so far: add it so SEEN-REFS.
3090 ;;
3091 ;; Also search for subsequent references in
3092 ;; footnote definition so numbering follows reading
3093 ;; logic. Note that we don't have to care about
3094 ;; inline definitions, since `org-element-map'
3095 ;; already traverses them at the right time.
3096 ;;
3097 ;; Once again, return nil to stay in the loop.
3102 nil))))
3103 ;; Don't enter footnote definitions since it will happen
3104 ;; when their first reference is found.
3109 ;;;; For Headlines
3110 ;;
3111 ;; `org-export-get-relative-level' is a shortcut to get headline
3112 ;; level, relatively to the lower headline level in the parsed tree.
3113 ;;
3114 ;; `org-export-get-headline-number' returns the section number of an
3115 ;; headline, while `org-export-number-to-roman' allows to convert it
3116 ;; to roman numbers.
3117 ;;
3118 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3119 ;; `org-export-last-sibling-p' are three useful predicates when it
3120 ;; comes to fulfill the `:headline-levels' property.
3123 "Return HEADLINE relative level within current parsed tree.
3124 INFO is a plist holding contextual information."
3129 "Non-nil when HEADLINE is considered as low level.
3131 INFO is a plist used as a communication channel.
3133 A low level headlines has a relative level greater than
3134 `:headline-levels' property value.
3136 Return value is the difference between HEADLINE relative level
3137 and the last level being considered as high enough, or nil."
3144 "Return HEADLINE numbering as a list of numbers.
3145 INFO is a plist holding contextual information."
3149 "Return a non-nil value if HEADLINE element should be numbered.
3150 INFO is a plist used as a communication channel."
3156 "Convert integer N into a roman numeral."
3169 res)))
3172 "Return list of tags associated to ELEMENT.
3174 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3175 is a plist used as a communication channel.
3177 Select tags (see `org-export-select-tags') and exclude tags (see
3178 `org-export-exclude-tags') are removed from the list.
3180 When non-nil, optional argument TAGS should be a list of strings.
3181 Any tag belonging to this list will also be removed.
3183 When optional argument INHERITED is non-nil, tags can also be
3184 inherited from parent headlines.."
3190 ;; Build complete list of inherited tags.
3201 current-tag-list))))
3204 "Return node PROPERTY value for BLOB.
3206 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3207 element or object.
3209 If optional argument INHERITED is non-nil, the value can be
3210 inherited from a parent headline.
3212 Return value is a string or nil."
3224 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3225 INFO is a plist used as a communication channel."
3230 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3231 INFO is a plist used as a communication channel."
3235 ;;;; For Links
3236 ;;
3237 ;; `org-export-solidify-link-text' turns a string into a safer version
3238 ;; for links, replacing most non-standard characters with hyphens.
3239 ;;
3240 ;; `org-export-get-coderef-format' returns an appropriate format
3241 ;; string for coderefs.
3242 ;;
3243 ;; `org-export-inline-image-p' returns a non-nil value when the link
3244 ;; provided should be considered as an inline image.
3245 ;;
3246 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3247 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3248 ;; returns an appropriate unique identifier when found, or nil.
3249 ;;
3250 ;; `org-export-resolve-id-link' returns the first headline with
3251 ;; specified id or custom-id in parse tree, the path to the external
3252 ;; file with the id or nil when neither was found.
3253 ;;
3254 ;; `org-export-resolve-coderef' associates a reference to a line
3255 ;; number in the element it belongs, or returns the reference itself
3256 ;; when the element isn't numbered.
3259 "Take link text S and make a safe target out of it."
3264 "Return format string for code reference link.
3265 PATH is the link path. DESC is its description."
3273 "Non-nil if LINK object points to an inline image.
3275 Optional argument is a set of RULES defining inline images. It
3276 is an alist where associations have the following shape:
3278 \(TYPE . REGEXP)
3280 Applying a rule means apply REGEXP against LINK's path when its
3281 type is TYPE. The function will return a non-nil value if any of
3282 the provided rules is non-nil. The default rule is
3283 `org-export-default-inline-image-rule'.
3285 This only applies to links without a description."
3296 rules)
3297 ;; Return nil if no rule matched.
3298 nil))))
3301 "Resolve a code reference REF.
3303 INFO is a plist used as a communication channel.
3305 Return associated line number in source code, or REF itself,
3306 depending on src-block or example element's switches."
3314 org-coderef-label-format)))
3318 ;; Element containing REF is found. Resolve it to either
3319 ;; a label or a line number, as needed.
3329 "Return LINK destination.
3331 INFO is a plist holding contextual information.
3333 Return value can be an object, an element, or nil:
3335 - If LINK path matches a target object (i.e. <<path>>) or
3338 - If LINK path exactly matches the name affiliated keyword
3339 \(i.e. #+NAME: path) of an element, return that element.
3341 - If LINK path exactly matches any headline name, return that
3342 element. If more than one headline share that name, priority
3343 will be given to the one with the closest common ancestor, if
3344 any, or the first one in the parse tree otherwise.
3346 - Otherwise, return nil.
3352 ;; First try to find a matching "<<path>>" unless user specified
3353 ;; he was looking for an headline (path starts with a *
3354 ;; character).
3358 return target)))
3359 ;; Then try to find an element with a matching "#+NAME: path"
3360 ;; affiliated keyword.
3367 ;; Last case: link either points to an headline or to
3368 ;; nothingness. Try to find the source, with priority given to
3369 ;; headlines with the closest common ancestor. If such candidate
3370 ;; is found, return it, otherwise return nil.
3374 ;; Return first headline whose `:raw-value' property
3375 ;; is NAME in parse tree DATA, or nil.
3378 data 'headline
3382 name)
3383 headline))
3385 ;; Search among headlines sharing an ancestor with link,
3386 ;; from closest to farthest.
3394 ;; No match with a common ancestor: try the full parse-tree.
3400 "Return headline referenced as LINK destination.
3402 INFO is a plist used as a communication channel.
3404 Return value can be the headline element matched in current parse
3408 ;; First check if id is within the current parse tree.
3414 headline))
3416 ;; Otherwise, look for external files.
3420 "Return radio-target object referenced as LINK destination.
3422 INFO is a plist used as a communication channel.
3424 Return value can be a radio-target object or nil. Assume LINK
3434 ;;;; For References
3435 ;;
3436 ;; `org-export-get-ordinal' associates a sequence number to any object
3437 ;; or element.
3440 "Return ordinal number of an element or object.
3442 ELEMENT is the element or object considered. INFO is the plist
3443 used as a communication channel.
3445 Optional argument TYPES, when non-nil, is a list of element or
3446 object types, as symbols, that should also be counted in.
3447 Otherwise, only provided element's type is considered.
3449 Optional argument PREDICATE is a function returning a non-nil
3450 value if the current element or object should be counted in. It
3451 accepts two arguments: the element or object being considered and
3452 the plist used as a communication channel. This allows to count
3453 only a certain type of objects (i.e. inline images).
3455 Return value is a list of numbers if ELEMENT is an headline or an
3456 item. It is nil for keywords. It represents the footnote number
3457 for footnote definitions and footnote references. If ELEMENT is
3458 a target, return the same value as if ELEMENT was the closest
3459 table, item or headline containing the target. In any other
3460 case, return the sequence number of ELEMENT among elements or
3461 objects of the same type."
3462 ;; A target keyword, representing an invisible target, never has
3463 ;; a sequence number.
3465 ;; Ordinal of a target object refer to the ordinal of the closest
3466 ;; table, item, or headline containing the object.
3470 when
3474 table))
3475 return parent)))
3477 ;; Special case 1: An headline returns its number as a list.
3479 ;; Special case 2: An item returns its number as a list.
3483 struct
3490 ;; Increment counter until ELEMENT is found again.
3501 ;;;; For Src-Blocks
3502 ;;
3503 ;; `org-export-get-loc' counts number of code lines accumulated in
3504 ;; src-block or example-block elements with a "+n" switch until
3505 ;; a given element, excluded. Note: "-n" switches reset that count.
3506 ;;
3507 ;; `org-export-unravel-code' extracts source code (along with a code
3508 ;; references alist) from an `element-block' or `src-block' type
3509 ;; element.
3510 ;;
3511 ;; `org-export-format-code' applies a formatting function to each line
3512 ;; of code, providing relative line number and code reference when
3513 ;; appropriate. Since it doesn't access the original element from
3514 ;; which the source code is coming, it expects from the code calling
3515 ;; it to know if lines should be numbered and if code references
3516 ;; should appear.
3517 ;;
3518 ;; Eventually, `org-export-format-code-default' is a higher-level
3519 ;; function (it makes use of the two previous functions) which handles
3520 ;; line numbering and code references inclusion, and returns source
3521 ;; code in a format suitable for plain text or verbatim output.
3524 "Return accumulated lines of code up to ELEMENT.
3526 INFO is the plist used as a communication channel.
3528 ELEMENT is excluded from count."
3535 ;; ELEMENT is reached: Quit the loop.
3537 ;; Only count lines from src-block and example-block elements
3538 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3542 ;; Accumulate locs or reset them.
3546 ;; Return nil to stay in the loop.
3547 nil)))
3549 ;; Return value.
3550 loc))
3553 "Clean source code and extract references out of it.
3555 ELEMENT has either a `src-block' an `example-block' type.
3557 Return a cons cell whose CAR is the source code, cleaned from any
3558 reference and protective comma and CDR is an alist between
3559 relative line number (integer) and name of code reference on that
3560 line (string)."
3562 ;; Get code and clean it. Remove blank lines at its
3563 ;; beginning and end.
3569 ;; If appropriate, remove global indentation.
3572 c
3574 ;; Get format used for references.
3577 org-coderef-label-format)))
3578 ;; Build a regexp matching a loc with a reference.
3583 ;; Return value.
3585 ;; Code with references removed.
3591 ;; Ref line: remove ref, and signal its position in REFS.
3595 ;; Reference alist.
3596 refs)))
3599 "Format CODE by applying FUN line-wise and return it.
3601 CODE is a string representing the code to format. FUN is
3602 a function. It must accept three arguments: a line of
3603 code (string), the current line number (integer) or nil and the
3604 reference associated to the current line (string) or nil.
3606 Optional argument NUM-LINES can be an integer representing the
3607 number of code lines accumulated until the current code. Line
3608 numbers passed to FUN will take it into account. If it is nil,
3609 FUN's second argument will always be nil. This number can be
3610 obtained with `org-export-get-loc' function.
3612 Optional argument REF-ALIST can be an alist between relative line
3613 number (i.e. ignoring NUM-LINES) and the name of the code
3614 reference on it. If it is nil, FUN's third argument will always
3615 be nil. It can be obtained through the use of
3616 `org-export-unravel-code' function."
3628 "Return source code from ELEMENT, formatted in a standard way.
3630 ELEMENT is either a `src-block' or `example-block' element. INFO
3631 is a plist used as a communication channel.
3633 This function takes care of line numbering and code references
3634 inclusion. Line numbers, when applicable, appear at the
3635 beginning of the line, separated from the code by two white
3636 spaces. Code references, on the other hand, appear flushed to
3637 the right, separated by six white spaces from the widest line of
3638 code."
3639 ;; Extract code and references.
3645 ;; Handle line numbering.
3654 ;; Prepare references display, if required. Any reference
3655 ;; should start six columns after the widest line of code,
3656 ;; wrapped with parenthesis.
3661 code
3665 number-str
3666 loc
3672 num-start refs)))
3675 ;;;; For Tables
3676 ;;
3677 ;; `org-export-table-has-special-column-p' and and
3678 ;; `org-export-table-row-is-special-p' are predicates used to look for
3679 ;; meta-information about the table structure.
3680 ;;
3681 ;; `org-table-has-header-p' tells when the rows before the first rule
3682 ;; should be considered as table's header.
3683 ;;
3684 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3685 ;; and `org-export-table-cell-borders' extract information from
3686 ;; a table-cell element.
3687 ;;
3688 ;; `org-export-table-dimensions' gives the number on rows and columns
3689 ;; in the table, ignoring horizontal rules and special columns.
3690 ;; `org-export-table-cell-address', given a table-cell object, returns
3691 ;; the absolute address of a cell. On the other hand,
3692 ;; `org-export-get-table-cell-at' does the contrary.
3693 ;;
3694 ;; `org-export-table-cell-starts-colgroup-p',
3695 ;; `org-export-table-cell-ends-colgroup-p',
3696 ;; `org-export-table-row-starts-rowgroup-p',
3697 ;; `org-export-table-row-ends-rowgroup-p',
3698 ;; `org-export-table-row-starts-header-p' and
3699 ;; `org-export-table-row-ends-header-p' indicate position of current
3700 ;; row or cell within the table.
3703 "Non-nil when TABLE has a special column.
3704 All special columns will be ignored during export."
3705 ;; The table has a special column when every first cell of every row
3706 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3707 ;; "*" "_" and "^". Though, do not consider a first row containing
3708 ;; only empty cells as special.
3724 "Non-nil when TABLE has an header.
3726 INFO is a plist used as a communication channel.
3728 A table has an header when it contains at least two row groups."
3731 table 'table-row
3739 info)))
3742 "Non-nil if TABLE-ROW is considered special.
3744 INFO is a plist used as the communication channel.
3746 All special rows will be ignored during export."
3750 ;; A row is special either when...
3752 ;; ... it starts with a field only containing "/",
3754 ;; ... the table contains a special column and the row start
3755 ;; with a marking character among, "^", "_", "$" or "!",
3759 ;; ... it contains only alignment cookies and empty cells.
3765 ;; Since VALUE is a secondary string, the following
3766 ;; checks avoid expanding it with `org-export-data'.
3778 "Return TABLE-ROW's group.
3780 INFO is a plist used as the communication channel.
3782 Return value is the group number, as an integer, or nil special
3783 rows and table rules. Group 1 is also table's header."
3800 "Return TABLE-CELL contents width.
3802 INFO is a plist used as the communication channel.
3804 Return value is the width given by the last width cookie in the
3805 same column as TABLE-CELL, or nil."
3810 cookie-width)
3814 ;; In a special row, try to find a width cookie at COLUMN.
3818 ;; The following checks avoid expanding unnecessarily the
3819 ;; cell with `org-export-data'
3827 ;; Ignore table rules.
3830 ;; Return value.
3831 cookie-width))
3834 "Return TABLE-CELL contents alignment.
3836 INFO is a plist used as the communication channel.
3838 Return alignment as specified by the last alignment cookie in the
3839 same column as TABLE-CELL. If no such cookie is found, a default
3840 alignment value will be deduced from fraction of numbers in the
3841 column (see `org-table-number-fraction' for more information).
3842 Possible values are `left', `right' and `center'."
3849 cookie-align)
3853 ;; In a special row, try to find an alignment cookie at
3854 ;; COLUMN.
3858 ;; Since VALUE is a secondary string, the following checks
3859 ;; avoid useless expansion through `org-export-data'.
3867 ;; Ignore table rules.
3869 ;; In a standard row, check if cell's contents are expressing
3870 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3871 ;; Though, don't bother if an alignment cookie has already
3872 ;; defined cell's alignment.
3877 info)))
3882 ;; Return value. Alignment specified by cookies has precedence
3883 ;; over alignment deduced from cells contents.
3892 "Return TABLE-CELL borders.
3894 INFO is a plist used as a communication channel.
3896 Return value is a list of symbols, or nil. Possible values are:
3897 `top', `bottom', `above', `below', `left' and `right'. Note:
3898 `top' (resp. `bottom') only happen for a cell in the first
3899 row (resp. last row) of the table, ignoring table rules, if any.
3901 Returned borders ignore special rows."
3904 borders)
3905 ;; Top/above border? TABLE-CELL has a border above when a rule
3906 ;; used to demarcate row groups can be found above. Hence,
3907 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3908 ;; another regular row has to be found above that rule.
3917 ;; Look at every row before the current one.
3919 ;; No rule above, or rule found starts the table (ignoring any
3920 ;; special row): TABLE-CELL is at the top of the table.
3923 ;; Bottom/below border? TABLE-CELL has a border below when next
3924 ;; non-regular row below is a rule.
3933 ;; Look at every row after the current one.
3935 ;; No rule below, or rule found ends the table (modulo some
3936 ;; special row): TABLE-CELL is at the bottom of the table.
3939 ;; Right/left borders? They can only be specified by column
3940 ;; groups. Column groups are defined in a row starting with "/".
3941 ;; Also a column groups row only contains "<", "<>", ">" or blank
3942 ;; cells.
3959 ;; There's a left border when previous cell, if
3960 ;; any, ends a group, or current one starts one.
3966 ;; There's a right border when next cell, if any,
3967 ;; starts a group, or current one ends one.
3974 ;; Table rows are read in reverse order so last column groups
3975 ;; row has precedence over any previous one.
3977 ;; Return value.
3978 borders))
3981 "Non-nil when TABLE-CELL is at the beginning of a row group.
3982 INFO is a plist used as a communication channel."
3983 ;; A cell starts a column group either when it is at the beginning
3984 ;; of a row (or after the special column, if any) or when it has
3985 ;; a left border.
3989 table-cell)
3993 "Non-nil when TABLE-CELL is at the end of a row group.
3994 INFO is a plist used as a communication channel."
3995 ;; A cell ends a column group either when it is at the end of a row
3996 ;; or when it has a right border.
3999 table-cell)
4003 "Non-nil when TABLE-ROW is at the beginning of a column group.
4004 INFO is a plist used as a communication channel."
4012 "Non-nil when TABLE-ROW is at the end of a column group.
4013 INFO is a plist used as a communication channel."
4021 "Non-nil when TABLE-ROW is the first table header's row.
4022 INFO is a plist used as a communication channel."
4029 "Non-nil when TABLE-ROW is the last table header's row.
4030 INFO is a plist used as a communication channel."
4037 "Return TABLE dimensions.
4039 INFO is a plist used as a communication channel.
4041 Return value is a CONS like (ROWS . COLUMNS) where
4042 ROWS (resp. COLUMNS) is the number of exportable
4043 rows (resp. columns)."
4045 ;; Set number of rows, and extract first one.
4047 table 'table-row
4052 ;; Set number of columns.
4054 ;; Return value.
4058 "Return address of a regular TABLE-CELL object.
4060 TABLE-CELL is the cell considered. INFO is a plist used as
4061 a communication channel.
4063 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4064 zero-based index. Only exportable cells are considered. The
4065 function returns nil for other cells."
4068 ;; Ignore cells in special rows or in special column.
4073 ;; Row number.
4076 table 'table-row
4082 ;; Column number.
4085 table-row 'table-cell
4091 "Return regular table-cell object at ADDRESS in TABLE.
4093 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4094 zero-based index. TABLE is a table type element. INFO is
4095 a plist used as a communication channel.
4097 If no table-cell, among exportable cells, is found at ADDRESS,
4098 return nil."
4101 ;; Row at (car address) or nil.
4104 table 'table-row
4110 'table-cell
4117 ;;;; For Tables Of Contents
4118 ;;
4119 ;; `org-export-collect-headlines' builds a list of all exportable
4120 ;; headline elements, maybe limited to a certain depth. One can then
4121 ;; easily parse it and transcode it.
4122 ;;
4123 ;; Building lists of tables, figures or listings is quite similar.
4124 ;; Once the generic function `org-export-collect-elements' is defined,
4125 ;; `org-export-collect-tables', `org-export-collect-figures' and
4126 ;; `org-export-collect-listings' can be derived from it.
4129 "Collect headlines in order to build a table of contents.
4131 INFO is a plist used as a communication channel.
4133 When optional argument N is an integer, it specifies the depth of
4134 the table of contents. Otherwise, it is set to the value of the
4135 last headline level. See `org-export-headline-levels' for more
4136 information.
4138 Return a list of all exportable headlines as parsed elements."
4142 'headline
4144 ;; Strip contents from HEADLINE.
4147 info))
4150 "Collect referenceable elements of a determined type.
4152 TYPE can be a symbol or a list of symbols specifying element
4153 types to search. Only elements with a caption are collected.
4155 INFO is a plist used as a communication channel.
4157 When non-nil, optional argument PREDICATE is a function accepting
4158 one argument, an element of type TYPE. It returns a non-nil
4159 value when that element should be collected.
4161 Return a list of all elements found, in order of appearance."
4167 element))
4168 info))
4171 "Build a list of tables.
4172 INFO is a plist used as a communication channel.
4174 Return a list of table elements with a caption."
4178 "Build a list of figures.
4180 INFO is a plist used as a communication channel. PREDICATE is
4181 a function which accepts one argument: a paragraph element and
4182 whose return value is non-nil when that element should be
4183 collected.
4185 A figure is a paragraph type element, with a caption, verifying
4187 a vague concept that may depend on back-end.
4189 Return a list of elements recognized as figures."
4193 "Build a list of src blocks.
4195 INFO is a plist used as a communication channel.
4197 Return a list of src-block elements with a caption."
4201 ;;;; Smart Quotes
4238 "Smart quotes translations.
4240 Alist whose CAR is a language string and CDR is an alist with
4241 quote type as key and a plist associating various encodings to
4242 their translation as value.
4244 A quote type can be any symbol among `opening-double-quote',
4245 `closing-double-quote', `opening-single-quote',
4246 `closing-single-quote' and `apostrophe'.
4248 Valid encodings include `:utf-8', `:html', `:latex' and
4249 `:texinfo'.
4255 ;; Possible opening quote at beginning of string.
4257 ;; Possible closing quote at beginning of string.
4259 ;; Possible apostrophe at beginning of string.
4261 ;; Opening single and double quotes.
4263 ;; Closing single and double quotes.
4265 ;; Apostrophe.
4267 ;; Possible opening quote at end of string.
4269 ;; Possible closing quote at end of string.
4271 ;; Possible apostrophe at end of string.
4273 "List of regexps matching a quote or an apostrophe.
4279 ENCODING is a symbol among `:html', `:latex' and `:utf-8'. INFO
4280 is a plist used as a communication channel.
4282 The function has to retrieve information about string
4283 surroundings in parse tree. It can only happen with an
4284 unmodified string. Thus, if S has already been through another
4285 process, a non-nil ORIGINAL optional argument will provide that
4286 original string.
4288 Return the new string."
4291 org-export-smart-quotes-alist))))
4292 ;; 1. Replace quote character at the beginning of S.
4296 ;; Apostrophe?
4303 ;; Closing quote?
4308 'closing-single-quote
4310 quotes-alist))
4311 encoding)))
4314 ;; Opening quote?
4319 'opening-single-quote
4321 quotes-alist))
4322 encoding)))
4325 ;; 2. Replace quotes in the middle of the string.
4327 ;; Opening quotes.
4333 'opening-single-quote
4335 quotes-alist))
4336 encoding)
4341 ;; Closing quotes.
4346 'closing-single-quote
4348 quotes-alist))
4349 encoding)
4354 ;; Apostrophes.
4360 ;; 3. Replace quote character at the end of S.
4363 ;; Apostrophe?
4368 ;; Closing quote?
4373 'closing-single-quote
4375 quotes-alist))
4376 encoding)))
4378 ;; Opening quote?
4382 'opening-single-quote
4384 quotes-alist))
4385 encoding)))
4388 ;; Return string with smart quotes.
4389 s)))
4392 ;;;; Topology
4393 ;;
4394 ;; Here are various functions to retrieve information about the
4395 ;; neighbourhood of a given element or object. Neighbours of interest
4396 ;; are direct parent (`org-export-get-parent'), parent headline
4397 ;; (`org-export-get-parent-headline'), first element containing an
4398 ;; object, (`org-export-get-parent-element'), parent table
4399 ;; (`org-export-get-parent-table'), previous element or object
4400 ;; (`org-export-get-previous-element') and next element or object
4401 ;; (`org-export-get-next-element').
4402 ;;
4403 ;; `org-export-get-genealogy' returns the full genealogy of a given
4404 ;; element or object, from closest parent to full parse tree.
4407 "Return BLOB parent or nil.
4408 BLOB is the element or object considered."
4412 "Return full genealogy relative to a given element or object.
4414 BLOB is the element or object being considered.
4416 Ancestors are returned from closest to farthest, the last one
4417 being the full parse tree."
4424 "Return BLOB parent headline or nil.
4425 BLOB is the element or object being considered."
4429 parent))
4432 "Return first element containing OBJECT or nil.
4433 OBJECT is the object to consider."
4437 parent))
4440 "Return OBJECT parent table or nil.
4441 OBJECT is either a `table-cell' or `table-element' type object."
4445 parent))
4448 "Return previous element or object.
4449 BLOB is an element or object. INFO is a plist used as
4450 a communication channel. Return previous exportable element or
4451 object, a string, or nil."
4461 "Return next element or object.
4462 BLOB is an element or object. INFO is a plist used as
4463 a communication channel. Return next exportable element or
4464 object, a string, or nil."
4470 nil))
4473 ;;;; Translation
4474 ;;
4475 ;; `org-export-translate' translates a string according to language
4476 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4477 ;; variable and a specified charset. `org-export-dictionary' contains
4478 ;; the dictionary used for the translation.
4600 "Dictionary for export engine.
4602 Alist whose CAR is the string to translate and CDR is an alist
4603 whose CAR is the language string and CDR is a plist whose
4604 properties are possible charsets and values translated terms.
4606 It is used as a database for `org-export-translate'. Since this
4607 function returns the string as-is if no translation was found,
4608 the variable only needs to record values different from the
4612 "Translate string S according to language specification.
4614 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4615 and `:utf-8'. INFO is a plist used as a communication channel.
4617 Translation depends on `:language' property. Return the
4618 translated string. If no translation is found, try to fall back
4619 to `:default' encoding. If it fails, return S."
4625 s)))
4628 \f
4629 ;;; The Dispatcher
4630 ;;
4631 ;; `org-export-dispatch' is the standard interactive way to start an
4632 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4633 ;; for its interface, which, in turn, delegates response to key
4634 ;; pressed to `org-export-dispatch-action'.
4637 "List of menu entries available for `org-export-dispatch'.
4638 This variable shouldn't be set directly. Set-up :menu-entry
4639 keyword in either `org-export-define-backend' or
4642 ;;;###autoload
4644 "Export dispatcher for Org mode.
4646 It provides an access to common export related tasks in a buffer.
4647 Its interface comes in two flavours: standard and expert. While
4648 both share the same set of bindings, only the former displays the
4649 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4650 to switch to one or the other."
4655 nil
4656 org-export-dispatch-use-expert-ui)
4662 ;; First handle special hard-coded actions.
4668 "Publish project: "
4669 org-e-publish-project-alist nil t)
4670 org-e-publish-project-alist)
4680 "Handle interface for `org-export-dispatch'.
4682 OPTIONS is a list containing current interactive options set for
4683 export. It can contain any of the following symbols:
4684 `body' toggles a body-only export
4685 `subtree' restricts export to current subtree
4686 `visible' restricts export to visible part of buffer.
4687 `force' force publishing files.
4689 FIRST-KEY is the key pressed to select the first level menu. It
4690 is nil when this menu hasn't been selected yet.
4692 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4693 buffer is provided, but indications about currently active
4694 options are given in the prompt. Moreover, \[?] allows to switch
4695 back to standard interface."
4698 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4699 ;; non-nil is the required first-level key to activate
4700 ;; KEY. When its value is t, activate KEY independently
4701 ;; on the first key, if any. A nil value means KEY will
4702 ;; only be activated at first level.
4706 ;; Make sure order of menu doesn't depend on the order in
4707 ;; which back-ends are loaded.
4710 ;; Compute a list of allowed keys based on the first key
4711 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4712 ;; always available.
4722 ;; Build the help menu for standard UI.
4726 ;; Options are hard-coded.
4728 [%s] Body only: %s [%s] Visible only: %s
4738 ;; Display registered back-end entries.
4748 ;; Split sub-menu into two columns.
4758 top-key)
4763 ;; Publishing menu is hard-coded.
4765 [%s] Current file [%s] Current project
4775 ;; Build prompts for both standard and expert UI.
4780 "Export command (Options: %s%s%s%s) [%s]: "
4786 ;; With expert UI, just read key with a fancy prompt. In standard
4787 ;; UI, display an intrusive help buffer.
4790 expert-prompt allowed-keys backends options first-key expertp)
4791 ;; At first call, create frame layout in order to display menu.
4797 ;; At this point, the buffer containing the menu exists and is
4798 ;; visible in the current window. So, refresh it.
4804 standard-prompt allowed-keys backends options first-key expertp))))
4808 "Read a character from command input and act accordingly.
4810 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
4811 a list of characters available at a given step in the process.
4812 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
4813 EXPERTP are the same as defined in `org-export-dispatch-ui',
4814 which see.
4816 Toggle export options when required. Otherwise, return value is
4817 a list with action as CAR and a list of interactive export
4818 options as CDR."
4820 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4821 ;; depending on user's key pressed.
4824 ;; Ignore non-standard characters (i.e. "M-a") and
4825 ;; undefined associations.
4830 ;; q key at first level aborts export. At second
4831 ;; level, cancel first key instead.
4834 ;; Help key: Switch back to standard interface if
4835 ;; expert UI was active.
4837 ;; Toggle export options.
4844 first-key expertp))
4845 ;; Action selected: Send key and options back to
4846 ;; `org-export-dispatch'.
4852 ;; Publishing actions are hard-coded. Send a special
4853 ;; signal to `org-export-dispatch'.
4861 options))
4862 ;; Otherwise, enter sub-menu.
4867 ;;; org-export.el ends here