| blob | 886d1bcff07fc416268f0a4f7b6670a8f3d24916 |
1 ;;; org-export.el --- Generic Export Engine For Org
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
22 ;;
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
25 ;;
26 ;; Besides that parser, the generic exporter is made of three distinct
27 ;; parts:
28 ;;
29 ;; - The communication channel consists in a property list, which is
30 ;; created and updated during the process. Its use is to offer
31 ;; every piece of information, would it be about initial environment
32 ;; or contextual data, all in a single place. The exhaustive list
33 ;; of properties is given in "The Communication Channel" section of
34 ;; this file.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core function is `org-export-as'. It returns the transcoded
48 ;; buffer as a string.
49 ;;
50 ;; An export back-end is defined with `org-export-define-backend',
51 ;; which sets one mandatory variable: his translation table. Its name
52 ;; is always `org-BACKEND-translate-alist' where BACKEND stands for
53 ;; the name chosen for the back-end. Its value is an alist whose keys
54 ;; are elements and objects types and values translator functions.
55 ;; See function's docstring for more information about translators.
56 ;;
57 ;; Optionally, `org-export-define-backend' can also support specific
58 ;; buffer keywords, OPTION keyword's items and filters. Also refer to
59 ;; function documentation for more information.
60 ;;
61 ;; If the new back-end shares most properties with another one,
62 ;; `org-export-define-derived-backend' can be used to simplify the
63 ;; process.
64 ;;
65 ;; Any back-end can define its own variables. Among them, those
66 ;; customizable should belong to the `org-export-BACKEND' group.
67 ;;
68 ;; Tools for common tasks across back-ends are implemented in the
69 ;; penultimate part of this file. A dispatcher for standard back-ends
70 ;; is provided in the last one.
72 ;;; Code:
106 \f
107 ;;; Internal Variables
108 ;;
109 ;; Among internal variables, the most important is
110 ;; `org-export-options-alist'. This variable define the global export
111 ;; options, shared between every exporter, and how they are acquired.
153 "Alist between export properties and ways to set them.
155 The CAR of the alist is the property name, and the CDR is a list
156 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
158 KEYWORD is a string representing a buffer keyword, or nil. Each
159 property defined this way can also be set, during subtree
160 export, through an headline property named after the keyword
162 property).
163 OPTION is a string that could be found in an #+OPTIONS: line.
164 DEFAULT is the default value for the property.
165 BEHAVIOUR determine how Org should handle multiple keywords for
166 the same property. It is a symbol among:
167 nil Keep old value and discard the new one.
168 t Replace old value with the new one.
169 `space' Concatenate the values, separating them with a space.
170 `newline' Concatenate the values, separating them with
171 a newline.
172 `split' Split values at white spaces, and cons them to the
173 previous list.
175 KEYWORD and OPTION have precedence over DEFAULT.
177 All these properties should be back-end agnostic. Back-end
178 specific properties are set through `org-export-define-backend'.
182 "List of in-buffer keywords that require special treatment.
183 These keywords are not directly associated to a property. The
184 way they are handled must be hard-coded into
242 "Alist between filters properties and initial values.
244 The key of each association is a property name accessible through
245 the communication channel. Its value is a configurable global
246 variable defining initial filters.
248 This list is meant to install user specified filters. Back-end
249 developers may install their own filters using
250 `org-export-define-backend'. Filters defined there will always
251 be prepended to the current list, so they always get applied
260 "Default rule for link matching an inline image.
261 This rule applies to links with no description. By default, it
262 will be considered as an inline image if it targets a local file
265 See `org-export-inline-image-p' for more information about
269 \f
270 ;;; User-configurable Variables
271 ;;
272 ;; Configuration for the masses.
273 ;;
274 ;; They should never be accessed directly, as their value is to be
275 ;; stored in a property list (cf. `org-export-options-alist').
276 ;; Back-ends will read their value from there instead.
279 "Options for exporting Org mode files."
284 "General options for export engine."
289 "Whether sub-trees with the ARCHIVE tag should be exported.
291 This can have three different values:
292 nil Do not export, pretend this tree is not present.
293 t Do export the entire tree.
294 `headline' Only export the headline, but skip the tree below it.
296 This option can also be set with the #+OPTIONS line,
305 "Non-nil means insert author name into the exported file.
306 This option can also be set with the #+OPTIONS line,
312 "Non-nil means export CLOCK keywords.
313 This option can also be set with the #+OPTIONS line,
319 "Non-nil means the postamble should contain a creator sentence.
321 The sentence can be set in `org-export-creator-string' and
324 If the value is `comment' insert it as a comment."
334 emacs-version)
335 "String to insert at the end of the generated document."
340 "Non-nil means export contents of standard drawers.
342 When t, all drawers are exported. This may also be a list of
343 drawer names to export. This variable doesn't apply to
344 properties drawers.
346 This option can also be set with the #+OPTIONS line,
356 "Non-nil means insert author email into the exported file.
357 This option can also be set with the #+OPTIONS line,
363 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
365 If the export target supports emphasizing text, the word will be
366 typeset in bold, italic, or underlined, respectively. Not all
367 export backends support this.
374 "Tags that exclude a tree from export.
376 All trees carrying any of these tags will be excluded from
377 export. This is without condition, so even subtrees inside that
378 carry one of the `org-export-select-tags' will be removed.
380 This option can also be set with the #+EXCLUDE_TAGS: keyword."
387 This can be used to have pre-formatted text, fragments of code
388 etc. For example:
389 : ;; Some Lisp examples
390 : (while (defc cnt)
391 : (ding))
392 will be looking just like this in also HTML. See also the QUOTE
393 keyword. Not all export backends support this.
400 "Non-nil means Org footnotes should be exported.
401 This option can also be set with the #+OPTIONS line,
407 "The last level which is still exported as a headline.
409 Inferior levels will produce itemize lists when exported.
416 "The default language for export and clocktable translations, as a string.
417 This may have an association in
418 `org-clock-clocktable-language-setup'."
423 "Non-nil means preserve all line breaks when exporting.
425 Normally, in HTML output paragraphs will be reformatted.
427 This option can also be set with the #+OPTIONS line,
433 "Non-nil means interpret entities when exporting.
436 Å.
438 For a list of supported names, see the constant `org-entities'
439 and the user option `org-entities-user'.
441 This option can also be set with the #+OPTIONS line,
447 "Non-nil means inlinetasks should be exported.
448 This option can also be set with the #+OPTIONS line,
454 "Non-nil means include planning info in export.
455 This option can also be set with the #+OPTIONS: line,
461 "Non-nil means include priority cookies in export.
462 This option can also be set with the #+OPTIONS line,
468 "Non-nil means add section numbers to headlines when exporting.
470 When set to an integer n, numbering will only happen for
471 headlines whose relative level is higher or equal to n.
473 This option can also be set with the #+OPTIONS line,
479 "Tags that select a tree for export.
481 If any such tag is found in a buffer, all trees that do not carry
482 one of these tags will be ignored during export. Inside trees
483 that are selected like this, you can still deselect a subtree by
484 tagging it with one of the `org-export-exclude-tags'.
486 This option can also be set with the #+SELECT_TAGS: keyword."
493 When this option is turned on, these strings will be exported as:
495 Org HTML LaTeX UTF-8
496 -----+----------+--------+-------
498 -- – -- –
499 --- — --- —
502 This option can also be set with the #+OPTIONS line,
508 "Non-nil means include statistics cookies in export.
509 This option can also be set with the #+OPTIONS: line,
517 When this option is turned on, you can use TeX-like syntax for
519 will be considered as a single item - so grouping with {} is
520 normally not needed. For example, the following things will be
521 parsed as single sub- or superscripts.
523 10^24 or 10^tau several digits will be considered 1 item.
524 10^-12 or 10^-tau a leading sign with digits or a word
525 x^2-y^3 will be read as x^2 - y^3, because items are
526 terminated by almost any nonword/nondigit char.
527 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
529 Still, ambiguity is possible - so when in doubt use {} to enclose
530 the sub/superscript. If you set this variable to the symbol
531 `{}', the braces are *required* in order to trigger
532 interpretations as sub/superscript. This can be helpful in
535 This option can also be set with the #+OPTIONS line,
544 "Non-nil means create a table of contents in exported files.
546 The TOC contains headlines with levels up
547 to`org-export-headline-levels'. When an integer, include levels
548 up to N in the toc, this may then be different from
549 `org-export-headline-levels', but it will not be allowed to be
550 larger than the number of headline levels. When nil, no table of
551 contents is made.
553 This option can also be set with the #+OPTIONS line,
563 For example:
565 | Name | Address | Birthday |
566 |-------------+----------+-----------|
567 | Arthur Dent | England | 29.2.2100 |
574 "If nil, do not export tags, just remove them from headlines.
576 If this is the symbol `not-in-toc', tags will be removed from
577 table of contents entries, but still be shown in the headlines of
578 the document.
580 This option can also be set with the #+OPTIONS line,
589 "Non-nil means include TODO items for export.
590 This may have the following values:
591 t include tasks independent of state.
592 todo include only tasks that are not yet done.
593 done include only tasks that are already done.
594 nil remove all tasks before export
595 list of keywords keep only tasks with these keywords"
606 "Non-nil means insert a time stamp into the exported file.
607 The time stamp shows when the file was created.
609 This option can also be set with the #+OPTIONS line,
615 "Non nil means allow timestamps in export.
617 It can be set to `active', `inactive', t or nil, in order to
618 export, respectively, only active timestamps, only inactive ones,
619 all of them or none.
621 This option can also be set with the #+OPTIONS line, e.g.
631 "Non-nil means include TODO keywords in export.
632 When nil, remove all these keywords from the export."
637 "Non-nil means allow #+BIND to define local variable values for export.
638 This is a potential security risk, which is why the user must
639 confirm the use of these lines."
647 "Alist between export snippets back-ends and exporter back-ends.
649 This variable allows to provide shortcuts for export snippets.
653 HTML code while every other back-end will ignore it."
661 "Coding system for the exported file."
666 "Non-nil means exported stuff will also be pushed onto the kill ring."
671 "The initial scope when exporting with `org-export-dispatch'.
672 This variable can be either set to `buffer' or `subtree'."
679 "Non-nil means show buffer after exporting to temp buffer.
680 When Org exports to a file, the buffer visiting that file is ever
681 shown, but remains buried. However, when exporting to
682 a temporary buffer, that buffer is popped up in a second window.
683 When this variable is nil, the buffer remains buried also in
684 these cases."
689 "Non-nil means using a non-intrusive `org-export-dispatch'.
690 In that case, no help buffer is displayed. Though, an indicator
694 considered for export\). Also, \[?] allows to switch back to
695 standard mode."
700 \f
701 ;;; Defining New Back-ends
704 "Define a new back-end BACKEND.
706 TRANSLATORS is an alist between object or element types and
707 functions handling them.
709 These functions should return a string without any trailing
710 space, or nil. They must accept three arguments: the object or
711 element itself, its contents or nil when it isn't recursive and
712 the property list used as a communication channel.
714 Contents, when not nil, are stripped from any global indentation
715 \(although the relative one is preserved). They also always end
716 with a single newline character.
718 If, for a given type, no function is found, that element or
719 object type will simply be ignored, along with any blank line or
720 white space at its end. The same will happen if the function
721 returns the nil value. If that function returns the empty
722 string, the type will be ignored, but the blank lines or white
723 spaces will be kept.
725 In addition to element and object types, one function can be
726 associated to the `template' symbol and another one to the
727 `plain-text' symbol.
729 The former returns the final transcoded string, and can be used
730 to add a preamble and a postamble to document's body. It must
731 accept two arguments: the transcoded string and the property list
732 containing export options.
734 The latter, when defined, is to be called on every text not
735 recognized as an element or an object. It must accept two
736 arguments: the text string and the information channel. It is an
737 appropriate place to protect special chars relative to the
738 back-end.
740 BODY can start with pre-defined keyword arguments. The following
741 keywords are understood:
743 :export-block
745 String, or list of strings, representing block names that
746 will not be parsed. This is used to specify blocks that will
747 contain raw code specific to the back-end. These blocks
748 still have to be handled by the relative `export-block' type
749 translator.
751 :filters-alist
753 Alist between filters and function, or list of functions,
754 specific to the back-end. See `org-export-filters-alist' for
755 a list of all allowed filters. Filters defined here
756 shouldn't make a back-end test, as it may prevent back-ends
757 derived from this one to behave properly.
759 :menu-entry
761 Menu entry for the export dispatcher. It should be a list
762 like:
764 \(KEY DESCRIPTION ACTION-OR-MENU)
766 where :
768 KEY is a free character selecting the back-end.
769 DESCRIPTION is a string naming the back-end.
770 ACTION-OR-MENU is either a function or an alist.
772 If it is an action, it will be called with three arguments:
773 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
774 for further explanations.
776 If it is an alist, associations should follow the
777 pattern:
779 \(KEY DESCRIPTION ACTION)
781 where KEY, DESCRIPTION and ACTION are described above.
783 Valid values include:
787 or
794 \(lambda (subtree visible body-only)
795 \(org-open-file
796 \(org-e-latex-export-to-pdf subtree visible body-only))))))
798 :options-alist
800 Alist between back-end specific properties introduced in
801 communication channel and how their value are acquired. See
802 `org-export-options-alist' for more information about
803 structure of the values."
818 ;; Define translators.
821 ;; Define options.
825 See `org-export-options-alist' for more information on the
826 structure of the values."
827 backend)))
828 ;; Define filters.
831 "Alist between filters keywords and back-end specific filters.
833 ;; Tell parser to not parse EXPORT-BLOCK blocks.
840 ;; Add an entry for back-end in `org-export-dispatch'.
845 ;; Splice in the body, if any.
849 "Create a new back-end as a variant of an existing one.
851 CHILD is the name of the derived back-end. PARENT is the name of
852 the parent back-end.
854 BODY can start with pre-defined keyword arguments. The following
855 keywords are understood:
857 :export-block
859 String, or list of strings, representing block names that
860 will not be parsed. This is used to specify blocks that will
861 contain raw code specific to the back-end. These blocks
862 still have to be handled by the relative `export-block' type
863 translator.
865 :filters-alist
867 Alist of filters that will overwrite or complete filters
868 defined in PARENT back-end. See `org-export-filters-alist'
869 for a list of allowed filters.
871 :menu-entry
873 Menu entry for the export dispatcher. See
874 `org-export-define-backend' for more information about the
875 expected value.
877 :options-alist
879 Alist of back-end specific properties that will overwrite or
880 complete those defined in PARENT back-end. Refer to
881 `org-export-options-alist' for more information about
882 structure of the values.
884 :sub-menu-entry
886 Append entries to an existing menu in the export dispatcher.
887 The associated value should be a list whose CAR is the
888 character selecting the menu to expand and CDR a list of
889 entries following the pattern:
891 \(KEY DESCRIPTION ACTION)
893 where KEY is a free character triggering the action,
894 DESCRIPTION is a string defining the action, and ACTION is
895 a function that will be called with three arguments:
896 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
897 for further explanations.
899 Valid values include:
903 \(lambda (s v b)
904 \(org-open-file (org-e-beamer-export-to-pdf s v b)))))
906 :translate-alist
908 Alist of element and object types and transcoders that will
909 overwrite or complete transcode table from PARENT back-end.
910 Refer to `org-export-define-backend' for detailed information
911 about transcoders.
914 as a variant of `e-latex' back-end with a custom template
915 function:
917 \(org-export-define-derived-backend my-latex e-latex
918 :translate-alist ((template . my-latex-template-fun)))
920 The back-end could then be called with, for example:
939 ;; Tell parser to not parse EXPORT-BLOCK blocks.
946 ;; Define filters.
953 "Alist between filters keywords and back-end specific filters.
955 ;; Define options.
963 See `org-export-options-alist' for more information on the
964 structure of the values."
965 child))))
966 ;; Define translators.
973 ;; Add an entry for back-end in `org-export-dispatch'.
980 org-export-dispatch-menu-entries))))
984 ;; Splice in the body, if any.
988 \f
989 ;;; The Communication Channel
990 ;;
991 ;; During export process, every function has access to a number of
992 ;; properties. They are of two types:
993 ;;
994 ;; 1. Environment options are collected once at the very beginning of
995 ;; the process, out of the original buffer and configuration.
996 ;; Collecting them is handled by `org-export-get-environment'
997 ;; function.
998 ;;
999 ;; Most environment options are defined through the
1000 ;; `org-export-options-alist' variable.
1001 ;;
1002 ;; 2. Tree properties are extracted directly from the parsed tree,
1003 ;; just before export, by `org-export-collect-tree-properties'.
1004 ;;
1005 ;; Here is the full list of properties available during transcode
1006 ;; process, with their category and their value type.
1007 ;;
1008 ;; + `:author' :: Author's name.
1009 ;; - category :: option
1010 ;; - type :: string
1011 ;;
1012 ;; + `:back-end' :: Current back-end used for transcoding.
1013 ;; - category :: tree
1014 ;; - type :: symbol
1015 ;;
1016 ;; + `:creator' :: String to write as creation information.
1017 ;; - category :: option
1018 ;; - type :: string
1019 ;;
1020 ;; + `:date' :: String to use as date.
1021 ;; - category :: option
1022 ;; - type :: string
1023 ;;
1024 ;; + `:description' :: Description text for the current data.
1025 ;; - category :: option
1026 ;; - type :: string
1027 ;;
1028 ;; + `:email' :: Author's email.
1029 ;; - category :: option
1030 ;; - type :: string
1031 ;;
1032 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1033 ;; process.
1034 ;; - category :: option
1035 ;; - type :: list of strings
1036 ;;
1037 ;; + `:exported-data' :: Hash table used for memoizing
1038 ;; `org-export-data'.
1039 ;; - category :: tree
1040 ;; - type :: hash table
1041 ;;
1042 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1043 ;; their definition, as parsed data. Only non-inlined footnotes
1044 ;; are represented in this alist. Also, every definition isn't
1045 ;; guaranteed to be referenced in the parse tree. The purpose of
1046 ;; this property is to preserve definitions from oblivion
1047 ;; (i.e. when the parse tree comes from a part of the original
1048 ;; buffer), it isn't meant for direct use in a back-end. To
1049 ;; retrieve a definition relative to a reference, use
1050 ;; `org-export-get-footnote-definition' instead.
1051 ;; - category :: option
1052 ;; - type :: alist (STRING . LIST)
1053 ;;
1054 ;; + `:headline-levels' :: Maximum level being exported as an
1055 ;; headline. Comparison is done with the relative level of
1056 ;; headlines in the parse tree, not necessarily with their
1057 ;; actual level.
1058 ;; - category :: option
1059 ;; - type :: integer
1060 ;;
1061 ;; + `:headline-offset' :: Difference between relative and real level
1062 ;; of headlines in the parse tree. For example, a value of -1
1063 ;; means a level 2 headline should be considered as level
1064 ;; 1 (cf. `org-export-get-relative-level').
1065 ;; - category :: tree
1066 ;; - type :: integer
1067 ;;
1068 ;; + `:headline-numbering' :: Alist between headlines and their
1069 ;; numbering, as a list of numbers
1070 ;; (cf. `org-export-get-headline-number').
1071 ;; - category :: tree
1072 ;; - type :: alist (INTEGER . LIST)
1073 ;;
1074 ;; + `:id-alist' :: Alist between ID strings and destination file's
1075 ;; path, relative to current directory. It is used by
1076 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1077 ;; external file.
1078 ;; - category :: option
1079 ;; - type :: alist (STRING . STRING)
1080 ;;
1081 ;; + `:ignore-list' :: List of elements and objects that should be
1082 ;; ignored during export.
1083 ;; - category :: tree
1084 ;; - type :: list of elements and objects
1085 ;;
1086 ;; + `:input-file' :: Full path to input file, if any.
1087 ;; - category :: option
1088 ;; - type :: string or nil
1089 ;;
1090 ;; + `:keywords' :: List of keywords attached to data.
1091 ;; - category :: option
1092 ;; - type :: string
1093 ;;
1094 ;; + `:language' :: Default language used for translations.
1095 ;; - category :: option
1096 ;; - type :: string
1097 ;;
1098 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1099 ;; transcoding.
1100 ;; - category :: option
1101 ;; - type :: list (as returned by `org-element-parse-buffer')
1102 ;;
1103 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1104 ;; all line breaks.
1105 ;; - category :: option
1106 ;; - type :: symbol (nil, t)
1107 ;;
1108 ;; + `:section-numbers' :: Non-nil means transcoding should add
1109 ;; section numbers to headlines.
1110 ;; - category :: option
1111 ;; - type :: symbol (nil, t)
1112 ;;
1113 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1114 ;; in transcoding. When such a tag is present, subtrees without
1115 ;; it are de facto excluded from the process. See
1116 ;; `use-select-tags'.
1117 ;; - category :: option
1118 ;; - type :: list of strings
1119 ;;
1120 ;; + `:target-list' :: List of targets encountered in the parse tree.
1121 ;; This is used to partly resolve "fuzzy" links
1122 ;; (cf. `org-export-resolve-fuzzy-link').
1123 ;; - category :: tree
1124 ;; - type :: list of strings
1125 ;;
1126 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1127 ;; a time stamp in the output.
1128 ;; - category :: option
1129 ;; - type :: symbol (nil, t)
1130 ;;
1131 ;; + `:translate-alist' :: Alist between element and object types and
1132 ;; transcoding functions relative to the current back-end.
1133 ;; Special keys `template' and `plain-text' are also possible.
1134 ;; - category :: option
1135 ;; - type :: alist (SYMBOL . FUNCTION)
1136 ;;
1137 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1138 ;; also be transcoded. If it is set to the `headline' symbol,
1139 ;; only the archived headline's name is retained.
1140 ;; - category :: option
1141 ;; - type :: symbol (nil, t, `headline')
1142 ;;
1143 ;; + `:with-author' :: Non-nil means author's name should be included
1144 ;; in the output.
1145 ;; - category :: option
1146 ;; - type :: symbol (nil, t)
1147 ;;
1148 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
1149 ;; - category :: option
1150 ;; - type :: symbol (nil, t)
1151 ;;
1152 ;; + `:with-creator' :: Non-nild means a creation sentence should be
1153 ;; inserted at the end of the transcoded string. If the value
1154 ;; is `comment', it should be commented.
1155 ;; - category :: option
1156 ;; - type :: symbol (`comment', nil, t)
1157 ;;
1158 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1159 ;; its value is a list of names, only drawers with such names
1160 ;; will be transcoded.
1161 ;; - category :: option
1162 ;; - type :: symbol (nil, t) or list of strings
1163 ;;
1164 ;; + `:with-email' :: Non-nil means output should contain author's
1165 ;; email.
1166 ;; - category :: option
1167 ;; - type :: symbol (nil, t)
1168 ;;
1169 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1170 ;; interpreted.
1171 ;; - category :: option
1172 ;; - type :: symbol (nil, t)
1173 ;;
1174 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1175 ;; strings starting with a colon as a fixed-with (verbatim) area.
1176 ;; - category :: option
1177 ;; - type :: symbol (nil, t)
1178 ;;
1179 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1180 ;; footnotes.
1181 ;; - category :: option
1182 ;; - type :: symbol (nil, t)
1183 ;;
1184 ;; + `:with-plannings' :: Non-nil means transcoding should include
1185 ;; planning info.
1186 ;; - category :: option
1187 ;; - type :: symbol (nil, t)
1188 ;;
1189 ;; + `:with-priority' :: Non-nil means transcoding should include
1190 ;; priority cookies.
1191 ;; - category :: option
1192 ;; - type :: symbol (nil, t)
1193 ;;
1194 ;; + `:with-special-strings' :: Non-nil means transcoding should
1195 ;; interpret special strings in plain text.
1196 ;; - category :: option
1197 ;; - type :: symbol (nil, t)
1198 ;;
1199 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1200 ;; interpret subscript and superscript. With a value of "{}",
1201 ;; only interpret those using curly brackets.
1202 ;; - category :: option
1203 ;; - type :: symbol (nil, {}, t)
1204 ;;
1205 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1206 ;; tables.
1207 ;; - category :: option
1208 ;; - type :: symbol (nil, t)
1209 ;;
1210 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1211 ;; headlines. A `not-in-toc' value will remove them from the
1212 ;; table of contents, if any, nonetheless.
1213 ;; - category :: option
1214 ;; - type :: symbol (nil, t, `not-in-toc')
1215 ;;
1216 ;; + `:with-tasks' :: Non-nil means transcoding should include
1217 ;; headlines with a TODO keyword. A `todo' value will only
1218 ;; include headlines with a todo type keyword while a `done'
1219 ;; value will do the contrary. If a list of strings is provided,
1220 ;; only tasks with keywords belonging to that list will be kept.
1221 ;; - category :: option
1222 ;; - type :: symbol (t, todo, done, nil) or list of strings
1223 ;;
1224 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1225 ;; time stamps. Special value `active' (resp. `inactive') ask to
1226 ;; export only active (resp. inactive) timestamps. Otherwise,
1227 ;; completely remove them.
1228 ;; - category :: option
1229 ;; - type :: symbol: (`active', `inactive', t, nil)
1230 ;;
1231 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1232 ;; added to the output. An integer value limits its depth.
1233 ;; - category :: option
1234 ;; - type :: symbol (nil, t or integer)
1235 ;;
1236 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1237 ;; include TODO keywords.
1238 ;; - category :: option
1239 ;; - type :: symbol (nil, t)
1242 ;;;; Environment Options
1243 ;;
1244 ;; Environment options encompass all parameters defined outside the
1245 ;; scope of the parsed data. They come from five sources, in
1246 ;; increasing precedence order:
1247 ;;
1248 ;; - Global variables,
1249 ;; - Buffer's attributes,
1250 ;; - Options keyword symbols,
1251 ;; - Buffer keywords,
1252 ;; - Subtree properties.
1253 ;;
1254 ;; The central internal function with regards to environment options
1255 ;; is `org-export-get-environment'. It updates global variables with
1256 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1257 ;; the different sources.
1258 ;;
1259 ;; The internal functions doing the retrieval are:
1260 ;; `org-export--get-global-options',
1261 ;; `org-export--get-buffer-attributes',
1262 ;; `org-export--parse-option-keyword',
1263 ;; `org-export--get-subtree-options' and
1264 ;; `org-export--get-inbuffer-options'
1265 ;;
1266 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1267 ;; take care of the part relative to "#+BIND:" keywords.
1270 "Collect export options from the current buffer.
1272 Optional argument BACKEND is a symbol specifying which back-end
1273 specific options to read, if any.
1275 When optional argument SUBTREEP is non-nil, assume the export is
1276 done against the current sub-tree.
1278 Third optional argument EXT-PLIST is a property list with
1279 external parameters overriding Org default settings, but still
1280 inferior to file-local settings."
1281 ;; First install #+BIND variables.
1283 ;; Get and prioritize export options...
1285 ;; ... from global variables...
1287 ;; ... from buffer's attributes...
1289 ;; ... from an external property list...
1290 ext-plist
1291 ;; ... from in-buffer settings...
1293 backend
1295 ;; ... and from subtree, when appropriate.
1297 ;; Eventually install back-end symbol and its translation table.
1298 `(:back-end
1299 ,backend
1300 :translate-alist
1305 "Parse an OPTIONS line and return values as a plist.
1306 Optional argument BACKEND is a symbol specifying which back-end
1307 specific items to read, if any."
1314 ;; Build an alist between #+OPTION: item and property-name.
1319 all)))
1320 plist)
1325 options)
1330 alist)
1331 plist))
1334 "Get export options in subtree at point.
1335 Optional argument BACKEND is a symbol specifying back-end used
1336 for export. Return options as a plist."
1337 ;; For each buffer keyword, create an headline property setting the
1338 ;; same property in communication channel. The name for the property
1339 ;; is the keyword with "EXPORT_" appended to it.
1342 ;; Make sure point is at an heading.
1344 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1345 ;; title as its fallback value.
1352 plist :title
1355 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1359 ;; Handle other keywords.
1366 ;; Export properties are not case-sensitive.
1373 plist
1375 ;; Parse VALUE if required.
1379 value))))))))
1380 ;; Also look for both general keywords and back-end specific
1381 ;; options if BACKEND is provided.
1386 org-export-options-alist)))
1387 ;; Return value.
1388 plist)))
1391 "Return current buffer export options, as a plist.
1393 Optional argument BACKEND, when non-nil, is a symbol specifying
1394 which back-end specific options should also be read in the
1395 process.
1397 Optional argument FILES is a list of setup files names read so
1398 far, used to avoid circular dependencies.
1400 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1404 ;; 1. Special keywords, as in `org-export-special-keywords'.
1418 ;; Avoid circular dependencies.
1428 ;; 2. Standard options, as in `org-export-options-alist'.
1430 ;; Also look for back-end specific options
1431 ;; if BACKEND is defined.
1437 ;; Build ALIST between keyword name and property name.
1441 all)))
1442 ;; Build regexp matching all keywords associated to export
1443 ;; options. Note: the search is case insensitive.
1457 plist prop
1458 ;; Handle value depending on specified BEHAVIOUR.
1471 ;; Parse keywords specified in `org-element-parsed-keywords'.
1479 plist prop
1482 org-element-parsed-keywords))
1483 ;; 3. Return final value.
1484 plist)))
1487 "Return properties related to buffer attributes, as a plist."
1490 ;; Store full path of input file name, or nil. For internal use.
1491 :input-file visited-file
1496 :footnote-definition-alist
1497 ;; Footnotes definitions must be collected in the original
1498 ;; buffer, as there's no insurance that they will still be in the
1499 ;; parse tree, due to possible narrowing.
1510 ;; Like `org-element-parse-buffer', but
1511 ;; makes sure the definition doesn't start
1512 ;; with a section element.
1516 alist))))
1517 alist))
1518 :id-alist
1519 ;; Collect id references.
1528 alist))))
1531 "Return global export options as a plist.
1533 Optional argument BACKEND, if non-nil, is a symbol specifying
1534 which back-end specific export options should also be read in the
1535 process."
1541 ;; Output value.
1542 plist)
1547 plist
1549 ;; Eval default value provided. If keyword is a member
1550 ;; of `org-element-parsed-keywords', parse it as
1551 ;; a secondary string before storing it.
1558 all)
1559 ;; Return value.
1560 plist))
1564 "Can we use #+BIND values during export?
1565 By default this will ask for confirmation by the user, to divert
1566 possible security risks."
1571 org-export--allow-BIND-local)
1576 "Install the values from #+BIND lines as local variables.
1577 Variables must be installed before in-buffer options are
1578 retrieved."
1593 ;;;; Tree Properties
1594 ;;
1595 ;; Tree properties are infromation extracted from parse tree. They
1596 ;; are initialized at the beginning of the transcoding process by
1597 ;; `org-export-collect-tree-properties'.
1598 ;;
1599 ;; Dedicated functions focus on computing the value of specific tree
1600 ;; properties during initialization. Thus,
1601 ;; `org-export--populate-ignore-list' lists elements and objects that
1602 ;; should be skipped during export, `org-export--get-min-level' gets
1603 ;; the minimal exportable level, used as a basis to compute relative
1604 ;; level for headlines. Eventually
1605 ;; `org-export--collect-headline-numbering' builds an alist between
1606 ;; headlines and their numbering.
1609 "Extract tree properties from parse tree.
1611 DATA is the parse tree from which information is retrieved. INFO
1612 is a list holding export options.
1614 Following tree properties are set or updated:
1616 `:exported-data' Hash table used to memoize results from
1617 `org-export-data'.
1619 `:footnote-definition-alist' List of footnotes definitions in
1620 original buffer and current parse tree.
1622 `:headline-offset' Offset between true level of headlines and
1623 local level. An offset of -1 means an headline
1624 of level 2 should be considered as a level
1625 1 headline in the context.
1627 `:headline-numbering' Alist of all headlines as key an the
1628 associated numbering as value.
1630 `:ignore-list' List of elements that should be ignored during
1631 export.
1633 `:target-list' List of all targets in the parse tree.
1635 Return updated plist."
1636 ;; Install the parse tree in the communication channel, in order to
1637 ;; use `org-export-get-genealogy' and al.
1639 ;; Get the list of elements and objects to ignore, and put it into
1640 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1641 ;; been done during parse tree filtering.
1644 :ignore-list
1647 ;; Compute `:headline-offset' in order to be able to use
1648 ;; `org-export-get-relative-level'.
1651 :headline-offset
1653 ;; Update footnotes definitions list with definitions in parse tree.
1654 ;; This is required since buffer expansion might have modified
1655 ;; boundaries of footnote definitions contained in the parse tree.
1656 ;; This way, definitions in `footnote-definition-alist' are bound to
1657 ;; match those in the parse tree.
1660 data 'footnote-definition
1664 defs)))
1666 ;; Properties order doesn't matter: get the rest of the tree
1667 ;; properties.
1669 `(:target-list
1678 info))
1681 "Return minimum exportable headline's level in DATA.
1682 DATA is parsed tree as returned by `org-element-parse-buffer'.
1683 OPTIONS is a plist holding export options."
1694 ;; If no headline was found, for the sake of consistency, set
1695 ;; minimum level to 1 nonetheless.
1699 "Return numbering of all exportable headlines in a parse tree.
1701 DATA is the parse tree. OPTIONS is the plist holding export
1702 options.
1704 Return an alist whose key is an headline and value is its
1705 associated numbering \(in the shape of a list of numbers\)."
1708 data
1709 'headline
1714 headline
1716 for idx from 0 to org-export-max-depth
1720 options)))
1723 "Return list of elements and objects to ignore during export.
1724 DATA is the parse tree to traverse. OPTIONS is the plist holding
1725 export options."
1727 walk-data
1728 ;; First find trees containing a select tag, if any.
1732 ;; Collect ignored elements or objects into IGNORE-LIST.
1738 ;; If headline is archived but tree below has
1739 ;; to be skipped, add it to ignore list.
1742 ;; Move into secondary string, if any.
1747 ;; Move into recursive objects/elements.
1749 ;; Main call.
1751 ;; Return value.
1752 ignore))
1755 "Return list of headlines containing a select tag in their tree.
1756 DATA is parsed data as returned by `org-element-parse-buffer'.
1757 INFO is a plist holding export options."
1759 walk-data ; for byte-compiler.
1770 ;; When a select tag is found, mark full
1771 ;; genealogy and every headline within the tree
1772 ;; as acceptable.
1775 genealogy
1777 selected-trees))
1778 ;; Else, continue searching in tree, recursively.
1785 "Non-nil when element or object BLOB should be skipped during export.
1786 OPTIONS is the plist holding export options. SELECTED, when
1787 non-nil, is a list of headlines belonging to a tree with a select
1788 tag."
1803 ;; Ignore subtrees with an exclude tag.
1806 ;; When a select tag is present in the buffer, ignore any tree
1807 ;; without it.
1809 ;; Ignore commented sub-trees.
1811 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1813 ;; Ignore tasks, if specified by `:with-tasks' property.
1829 ;; No timestamp allowed.
1831 ;; Only active timestamps allowed and the current one isn't
1832 ;; active.
1836 ;; Only inactive timestamps allowed and the current one isn't
1837 ;; inactive.
1843 \f
1844 ;;; The Transcoder
1845 ;;
1846 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1847 ;; `org-element-parse-buffer') and transcodes it into a specified
1848 ;; back-end output. It takes care of filtering out elements or
1849 ;; objects according to export options and organizing the output blank
1850 ;; lines and white space are preserved. The function memoizes its
1851 ;; results, so it is cheap to call it within translators.
1852 ;;
1853 ;; Internally, three functions handle the filtering of objects and
1854 ;; elements during the export. In particular,
1855 ;; `org-export-ignore-element' marks an element or object so future
1856 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1857 ;; elements or objects should be seen as real Org syntax and
1858 ;; `org-export-expand' transforms the others back into their original
1859 ;; shape
1860 ;;
1861 ;; `org-export-transcoder' is an accessor returning appropriate
1862 ;; translator function for a given element or object.
1865 "Return appropriate transcoder for BLOB.
1866 INFO is a plist containing export directives."
1868 ;; Return contents only for complete parse trees.
1874 "Convert DATA into current back-end format.
1876 DATA is a parse tree, an element or an object or a secondary
1877 string. INFO is a plist holding export options.
1879 Return transcoded string."
1885 ;; Ignored element/object.
1887 ;; Plain text.
1893 info))
1894 ;; Uninterpreted element/object: change it back to Org
1895 ;; syntax and export again resulting raw string.
1899 data
1903 info))
1904 ;; Secondary string.
1907 ;; Element/Object without contents or, as a special case,
1908 ;; headline with archive tag and archived trees restricted
1909 ;; to title only.
1917 ;; Element/Object with contents.
1930 ;; Elements directly containing objects
1931 ;; must have their indentation normalized
1932 ;; first.
1934 data
1935 ;; When normalizing contents of the first
1936 ;; paragraph in an item or a footnote
1937 ;; definition, ignore first line's
1938 ;; indentation: there is none and it
1939 ;; might be misleading.
1944 data)
1951 info))))))))
1952 ;; Final result will be memoized before being returned.
1954 data
1958 ;; Append the same white space between elements or objects as in
1959 ;; the original buffer, and call appropriate filters.
1970 info)))
1971 results)))
1975 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1976 Check is done according to export options INFO, stored as
1977 a plist."
1979 ;; ... entities...
1981 ;; ... emphasis...
1983 ;; ... fixed-width areas.
1985 ;; ... footnotes...
1988 ;; ... sub/superscripts...
1994 ;; ... tables...
1999 "Expand a parsed element or object to its original state.
2000 BLOB is either an element or an object. CONTENTS is its
2001 contents, as a string or nil."
2004 blob contents))
2007 "Add ELEMENT to `:ignore-list' in INFO.
2009 Any element in `:ignore-list' will be skipped when using
2010 `org-element-map'. INFO is modified by side effects."
2014 \f
2015 ;;; The Filter System
2016 ;;
2017 ;; Filters allow end-users to tweak easily the transcoded output.
2018 ;; They are the functional counterpart of hooks, as every filter in
2019 ;; a set is applied to the return value of the previous one.
2020 ;;
2021 ;; Every set is back-end agnostic. Although, a filter is always
2022 ;; called, in addition to the string it applies to, with the back-end
2023 ;; used as argument, so it's easy for the end-user to add back-end
2024 ;; specific filters in the set. The communication channel, as
2025 ;; a plist, is required as the third argument.
2026 ;;
2027 ;; From the developer side, filters sets can be installed in the
2028 ;; process with the help of `org-export-define-backend', which
2029 ;; internally sets `org-BACKEND-filters-alist' variable. Each
2030 ;; association has a key among the following symbols and a function or
2031 ;; a list of functions as value.
2032 ;;
2033 ;; - `:filter-parse-tree' applies directly on the complete parsed
2034 ;; tree. It's the only filters set that doesn't apply to a string.
2035 ;; Users can set it through `org-export-filter-parse-tree-functions'
2036 ;; variable.
2037 ;;
2038 ;; - `:filter-final-output' applies to the final transcoded string.
2039 ;; Users can set it with `org-export-filter-final-output-functions'
2040 ;; variable
2041 ;;
2042 ;; - `:filter-plain-text' applies to any string not recognized as Org
2043 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2044 ;; configure it.
2045 ;;
2046 ;; - `:filter-TYPE' applies on the string returned after an element or
2047 ;; object of type TYPE has been transcoded. An user can modify
2048 ;; `org-export-filter-TYPE-functions'
2049 ;;
2050 ;; All filters sets are applied with
2051 ;; `org-export-filter-apply-functions' function. Filters in a set are
2052 ;; applied in a LIFO fashion. It allows developers to be sure that
2053 ;; their filters will be applied first.
2054 ;;
2055 ;; Filters properties are installed in communication channel with
2056 ;; `org-export-install-filters' function.
2057 ;;
2058 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
2059 ;; before parsing to allow for heavy structure modifications.
2062 ;;;; Before Parsing Hook
2065 "Hook run before parsing an export buffer.
2067 This is run after include keywords have been expanded and Babel
2068 code executed, on a copy of original buffer's area being
2069 exported. Visibility is the same as in the original one. Point
2070 is left at the beginning of the new one.
2072 Every function in this hook will be called with one argument: the
2076 ;;;; Special Filters
2079 "List of functions applied to the parsed tree.
2080 Each filter is called with three arguments: the parse tree, as
2081 returned by `org-element-parse-buffer', the back-end, as
2082 a symbol, and the communication channel, as a plist. It must
2086 "List of functions applied to the transcoded string.
2087 Each filter is called with three arguments: the full transcoded
2088 string, the back-end, as a symbol, and the communication channel,
2089 as a plist. It must return a string that will be used as the
2093 "List of functions applied to plain text.
2094 Each filter is called with three arguments: a string which
2095 contains no Org syntax, the back-end, as a symbol, and the
2096 communication channel, as a plist. It must return a string or
2100 ;;;; Elements Filters
2103 "List of functions applied to a transcoded center block.
2104 Each filter is called with three arguments: the transcoded data,
2105 as a string, the back-end, as a symbol, and the communication
2109 "List of functions applied to a transcoded clock.
2110 Each filter is called with three arguments: the transcoded data,
2111 as a string, the back-end, as a symbol, and the communication
2115 "List of functions applied to a transcoded drawer.
2116 Each filter is called with three arguments: the transcoded data,
2117 as a string, the back-end, as a symbol, and the communication
2121 "List of functions applied to a transcoded dynamic-block.
2122 Each filter is called with three arguments: the transcoded data,
2123 as a string, the back-end, as a symbol, and the communication
2127 "List of functions applied to a transcoded headline.
2128 Each filter is called with three arguments: the transcoded data,
2129 as a string, the back-end, as a symbol, and the communication
2133 "List of functions applied to a transcoded inlinetask.
2134 Each filter is called with three arguments: the transcoded data,
2135 as a string, the back-end, as a symbol, and the communication
2139 "List of functions applied to a transcoded plain-list.
2140 Each filter is called with three arguments: the transcoded data,
2141 as a string, the back-end, as a symbol, and the communication
2145 "List of functions applied to a transcoded item.
2146 Each filter is called with three arguments: the transcoded data,
2147 as a string, the back-end, as a symbol, and the communication
2151 "List of functions applied to a transcoded comment.
2152 Each filter is called with three arguments: the transcoded data,
2153 as a string, the back-end, as a symbol, and the communication
2157 "List of functions applied to a transcoded comment-comment.
2158 Each filter is called with three arguments: the transcoded data,
2159 as a string, the back-end, as a symbol, and the communication
2163 "List of functions applied to a transcoded example-block.
2164 Each filter is called with three arguments: the transcoded data,
2165 as a string, the back-end, as a symbol, and the communication
2169 "List of functions applied to a transcoded export-block.
2170 Each filter is called with three arguments: the transcoded data,
2171 as a string, the back-end, as a symbol, and the communication
2175 "List of functions applied to a transcoded fixed-width.
2176 Each filter is called with three arguments: the transcoded data,
2177 as a string, the back-end, as a symbol, and the communication
2181 "List of functions applied to a transcoded footnote-definition.
2182 Each filter is called with three arguments: the transcoded data,
2183 as a string, the back-end, as a symbol, and the communication
2187 "List of functions applied to a transcoded horizontal-rule.
2188 Each filter is called with three arguments: the transcoded data,
2189 as a string, the back-end, as a symbol, and the communication
2193 "List of functions applied to a transcoded keyword.
2194 Each filter is called with three arguments: the transcoded data,
2195 as a string, the back-end, as a symbol, and the communication
2199 "List of functions applied to a transcoded latex-environment.
2200 Each filter is called with three arguments: the transcoded data,
2201 as a string, the back-end, as a symbol, and the communication
2205 "List of functions applied to a transcoded babel-call.
2206 Each filter is called with three arguments: the transcoded data,
2207 as a string, the back-end, as a symbol, and the communication
2211 "List of functions applied to a transcoded paragraph.
2212 Each filter is called with three arguments: the transcoded data,
2213 as a string, the back-end, as a symbol, and the communication
2217 "List of functions applied to a transcoded planning.
2218 Each filter is called with three arguments: the transcoded data,
2219 as a string, the back-end, as a symbol, and the communication
2223 "List of functions applied to a transcoded property-drawer.
2224 Each filter is called with three arguments: the transcoded data,
2225 as a string, the back-end, as a symbol, and the communication
2229 "List of functions applied to a transcoded quote block.
2230 Each filter is called with three arguments: the transcoded quote
2231 data, as a string, the back-end, as a symbol, and the
2232 communication channel, as a plist. It must return a string or
2236 "List of functions applied to a transcoded quote-section.
2237 Each filter is called with three arguments: the transcoded data,
2238 as a string, the back-end, as a symbol, and the communication
2242 "List of functions applied to a transcoded section.
2243 Each filter is called with three arguments: the transcoded data,
2244 as a string, the back-end, as a symbol, and the communication
2248 "List of functions applied to a transcoded special block.
2249 Each filter is called with three arguments: the transcoded data,
2250 as a string, the back-end, as a symbol, and the communication
2254 "List of functions applied to a transcoded src-block.
2255 Each filter is called with three arguments: the transcoded data,
2256 as a string, the back-end, as a symbol, and the communication
2260 "List of functions applied to a transcoded table.
2261 Each filter is called with three arguments: the transcoded data,
2262 as a string, the back-end, as a symbol, and the communication
2266 "List of functions applied to a transcoded table-cell.
2267 Each filter is called with three arguments: the transcoded data,
2268 as a string, the back-end, as a symbol, and the communication
2272 "List of functions applied to a transcoded table-row.
2273 Each filter is called with three arguments: the transcoded data,
2274 as a string, the back-end, as a symbol, and the communication
2278 "List of functions applied to a transcoded verse block.
2279 Each filter is called with three arguments: the transcoded data,
2280 as a string, the back-end, as a symbol, and the communication
2284 ;;;; Objects Filters
2287 "List of functions applied to transcoded bold text.
2288 Each filter is called with three arguments: the transcoded data,
2289 as a string, the back-end, as a symbol, and the communication
2293 "List of functions applied to transcoded code text.
2294 Each filter is called with three arguments: the transcoded data,
2295 as a string, the back-end, as a symbol, and the communication
2299 "List of functions applied to a transcoded entity.
2300 Each filter is called with three arguments: the transcoded data,
2301 as a string, the back-end, as a symbol, and the communication
2305 "List of functions applied to a transcoded export-snippet.
2306 Each filter is called with three arguments: the transcoded data,
2307 as a string, the back-end, as a symbol, and the communication
2311 "List of functions applied to a transcoded footnote-reference.
2312 Each filter is called with three arguments: the transcoded data,
2313 as a string, the back-end, as a symbol, and the communication
2317 "List of functions applied to a transcoded inline-babel-call.
2318 Each filter is called with three arguments: the transcoded data,
2319 as a string, the back-end, as a symbol, and the communication
2323 "List of functions applied to a transcoded inline-src-block.
2324 Each filter is called with three arguments: the transcoded data,
2325 as a string, the back-end, as a symbol, and the communication
2329 "List of functions applied to transcoded italic text.
2330 Each filter is called with three arguments: the transcoded data,
2331 as a string, the back-end, as a symbol, and the communication
2335 "List of functions applied to a transcoded latex-fragment.
2336 Each filter is called with three arguments: the transcoded data,
2337 as a string, the back-end, as a symbol, and the communication
2341 "List of functions applied to a transcoded line-break.
2342 Each filter is called with three arguments: the transcoded data,
2343 as a string, the back-end, as a symbol, and the communication
2347 "List of functions applied to a transcoded link.
2348 Each filter is called with three arguments: the transcoded data,
2349 as a string, the back-end, as a symbol, and the communication
2353 "List of functions applied to a transcoded macro.
2354 Each filter is called with three arguments: the transcoded data,
2355 as a string, the back-end, as a symbol, and the communication
2359 "List of functions applied to a transcoded radio-target.
2360 Each filter is called with three arguments: the transcoded data,
2361 as a string, the back-end, as a symbol, and the communication
2365 "List of functions applied to a transcoded statistics-cookie.
2366 Each filter is called with three arguments: the transcoded data,
2367 as a string, the back-end, as a symbol, and the communication
2371 "List of functions applied to transcoded strike-through text.
2372 Each filter is called with three arguments: the transcoded data,
2373 as a string, the back-end, as a symbol, and the communication
2377 "List of functions applied to a transcoded subscript.
2378 Each filter is called with three arguments: the transcoded data,
2379 as a string, the back-end, as a symbol, and the communication
2383 "List of functions applied to a transcoded superscript.
2384 Each filter is called with three arguments: the transcoded data,
2385 as a string, the back-end, as a symbol, and the communication
2389 "List of functions applied to a transcoded target.
2390 Each filter is called with three arguments: the transcoded data,
2391 as a string, the back-end, as a symbol, and the communication
2395 "List of functions applied to a transcoded timestamp.
2396 Each filter is called with three arguments: the transcoded data,
2397 as a string, the back-end, as a symbol, and the communication
2401 "List of functions applied to transcoded underline text.
2402 Each filter is called with three arguments: the transcoded data,
2403 as a string, the back-end, as a symbol, and the communication
2407 "List of functions applied to transcoded verbatim text.
2408 Each filter is called with three arguments: the transcoded data,
2409 as a string, the back-end, as a symbol, and the communication
2413 ;;;; Filters Tools
2414 ;;
2415 ;; Internal function `org-export-install-filters' installs filters
2416 ;; hard-coded in back-ends (developer filters) and filters from global
2417 ;; variables (user filters) in the communication channel.
2418 ;;
2419 ;; Internal function `org-export-filter-apply-functions' takes care
2420 ;; about applying each filter in order to a given data. It ignores
2421 ;; filters returning a nil value but stops whenever a filter returns
2422 ;; an empty string.
2425 "Call every function in FILTERS.
2427 Functions are called with arguments VALUE, current export
2428 back-end and INFO. A function returning a nil value will be
2429 skipped. If it returns the empty string, the process ends and
2430 VALUE is ignored.
2432 Call is done in a LIFO fashion, to be sure that developer
2433 specified filters, if any, are called first."
2442 "Install filters properties in communication channel.
2444 INFO is a plist containing the current communication channel.
2446 Return the updated communication channel."
2448 ;; Install user defined filters with `org-export-filters-alist'.
2451 org-export-filters-alist)
2452 ;; Prepend back-end specific filters to that list.
2457 ;; Single values get consed, lists are prepended.
2462 plist key
2466 ;; Return new communication channel.
2470 \f
2471 ;;; Core functions
2472 ;;
2473 ;; This is the room for the main function, `org-export-as', along with
2474 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2475 ;; They differ only by the way they output the resulting code.
2476 ;;
2477 ;; `org-export-output-file-name' is an auxiliary function meant to be
2478 ;; used with `org-export-to-file'. With a given extension, it tries
2479 ;; to provide a canonical file name to write export output to.
2480 ;;
2481 ;; Note that `org-export-as' doesn't really parse the current buffer,
2482 ;; but a copy of it (with the same buffer-local variables and
2483 ;; visibility), where macros and include keywords are expanded and
2484 ;; Babel blocks are executed, if appropriate.
2485 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2486 ;;
2487 ;; File inclusion is taken care of by
2488 ;; `org-export-expand-include-keyword' and
2489 ;; `org-export--prepare-file-contents'. Structure wise, including
2490 ;; a whole Org file in a buffer often makes little sense. For
2491 ;; example, if the file contains an headline and the include keyword
2492 ;; was within an item, the item should contain the headline. That's
2493 ;; why file inclusion should be done before any structure can be
2494 ;; associated to the file, that is before parsing.
2498 "Transcode current Org buffer into BACKEND code.
2500 If narrowing is active in the current buffer, only transcode its
2501 narrowed part.
2503 If a region is active, transcode that region.
2505 When optional argument SUBTREEP is non-nil, transcode the
2506 sub-tree at point, extracting information from the headline
2507 properties first.
2509 When optional argument VISIBLE-ONLY is non-nil, don't export
2510 contents of hidden elements.
2512 When optional argument BODY-ONLY is non-nil, only return body
2513 code, without preamble nor postamble.
2515 Optional argument EXT-PLIST, when provided, is a property list
2516 with external parameters overriding Org default settings, but
2517 still inferior to file-local settings.
2519 Optional argument NOEXPAND, when non-nil, prevents included files
2520 to be expanded and Babel code to be executed.
2522 Return code as a string."
2525 ;; Narrow buffer to an appropriate region or subtree for
2526 ;; parsing. If parsing subtree, be sure to remove main headline
2527 ;; too.
2535 ;; 1. Get export environment from original buffer. Also install
2536 ;; user's and developer's filters.
2539 ;; 2. Get parse tree. Buffer isn't parsed directly.
2540 ;; Instead, a temporary copy is created, where macros
2541 ;; and include keywords are expanded and code blocks
2542 ;; are evaluated.
2549 ;; TODO: Setting `org-current-export-file' is
2550 ;; required by Org Babel to properly resolve
2551 ;; noweb references. Once "org-exp.el" is
2552 ;; removed, modify
2553 ;; `org-export-blocks-preprocess' so it accepts
2554 ;; the value as an argument instead.
2558 ;; Run hook
2559 ;; `org-export-before-parsing-hook'. with current
2560 ;; back-end as argument.
2563 ;; Eventually parse buffer.
2565 ;; 3. Call parse-tree filters to get the final tree.
2569 ;; 4. Now tree is complete, compute its properties and add
2570 ;; them to communication channel.
2574 ;; 5. Eventually transcode TREE. Wrap the resulting string
2575 ;; into a template, if required. Eventually call
2576 ;; final-output filter.
2584 info)))
2585 ;; Maybe add final OUTPUT to kill ring, then return it.
2587 output)))))
2591 "Call `org-export-as' with output to a specified buffer.
2593 BACKEND is the back-end used for transcoding, as a symbol.
2595 BUFFER is the output buffer. If it already exists, it will be
2596 erased first, otherwise, it will be created.
2598 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2599 and NOEXPAND are similar to those used in `org-export-as', which
2600 see.
2602 Return buffer."
2604 backend subtreep visible-only body-only ext-plist noexpand))
2610 buffer))
2614 "Call `org-export-as' with output to a specified file.
2616 BACKEND is the back-end used for transcoding, as a symbol. FILE
2617 is the name of the output file, as a string.
2619 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2620 and NOEXPAND are similar to those used in `org-export-as', which
2621 see.
2623 Return output file's name."
2624 ;; Checks for FILE permissions. `write-file' would do the same, but
2625 ;; we'd rather avoid needless transcoding of parse tree.
2627 ;; Insert contents to a temporary buffer and write it to FILE.
2629 backend subtreep visible-only body-only ext-plist noexpand)))
2634 ;; Return full path.
2635 file)
2638 "Return output file's name according to buffer specifications.
2640 EXTENSION is a string representing the output file extension,
2641 with the leading dot.
2643 With a non-nil optional argument SUBTREEP, try to determine
2645 of subtree at point.
2647 When optional argument PUB-DIR is set, use it as the publishing
2648 directory.
2650 When optional argument VISIBLE-ONLY is non-nil, don't export
2651 contents of hidden elements.
2653 Return file name as a string, or nil if it couldn't be
2654 determined."
2656 ;; File name may come from EXPORT_FILE_NAME subtree property,
2657 ;; assuming point is at beginning of said sub-tree.
2664 ;; File name may be extracted from buffer's associated
2665 ;; file, if any.
2667 ;; Can't determine file name on our own: Ask user.
2671 "Output file: " pub-dir nil nil nil
2674 ;; Build file name. Enforce EXTENSION over whatever user may have
2675 ;; come up with. PUB-DIR, if defined, always has precedence over
2676 ;; any provided path.
2681 extension))
2687 "Apply BODY in a copy of the current buffer.
2689 The copy preserves local variables and visibility of the original
2690 buffer.
2692 Point is at buffer's beginning when BODY is applied."
2702 ,original-buffer
2707 ov
2717 "Expand every include keyword in buffer.
2718 Optional argument INCLUDED is a list of included file names along
2719 with their line restriction, when appropriate. It is used to
2720 avoid infinite recursion. Optional argument DIR is the current
2721 working directory. It is used to properly resolve relative
2722 paths."
2729 ;; Extract arguments from keyword's value.
2743 ;; Minimal level of included file defaults to the child
2744 ;; level of the current headline, if any, or one. It
2745 ;; only applies is the file is meant to be included as
2746 ;; an Org one.
2754 ;; Remove keyword.
2758 ;; Check if files has already been parsed. Look after
2759 ;; inclusion lines too, as different parts of the same file
2760 ;; can be included too.
2769 ;; Protect sensitive contents with commas.
2775 ind-str contents ind-str))))
2780 ;; Protect sensitive contents with commas.
2787 ind-str env contents ind-str))))
2800 "Prepare the contents of FILE for inclusion and return them as a string.
2802 When optional argument LINES is a string specifying a range of
2803 lines, include only those lines.
2805 Optional argument IND, when non-nil, is an integer specifying the
2806 global indentation of returned contents. Since its purpose is to
2807 allow an included file to stay in the same environment it was
2808 created \(i.e. a list item), it doesn't apply past the first
2809 headline encountered.
2811 Optional argument MINLEVEL, when non-nil, is an integer
2812 specifying the level that any top-level headline in the included
2813 file should have."
2829 ;; Remove blank lines at beginning and end of contents. The logic
2830 ;; behind that removal is that blank lines around include keyword
2831 ;; override blank lines in included file.
2840 ;; If IND is set, preserve indentation of include keyword until
2841 ;; the first headline encountered.
2847 ;; Do not move footnote definitions out of column 0.
2853 ;; When MINLEVEL is specified, compute minimal level for headlines
2854 ;; in the file (CUR-MIN), and remove stars to each headline so
2855 ;; that headlines with minimal level have a level of MINLEVEL.
2864 ;; Only change stars, don't bother moving whole
2865 ;; sections.
2871 \f
2872 ;;; Tools For Back-Ends
2873 ;;
2874 ;; A whole set of tools is available to help build new exporters. Any
2875 ;; function general enough to have its use across many back-ends
2876 ;; should be added here.
2878 ;;;; For Affiliated Keywords
2879 ;;
2880 ;; `org-export-read-attribute' reads a property from a given element
2881 ;; as a plist. It can be used to normalize affiliated keywords'
2882 ;; syntax.
2883 ;;
2884 ;; Since captions can span over multiple lines and accept dual values,
2885 ;; their internal representation is a bit tricky. Therefore,
2886 ;; `org-export-get-caption' transparently returns a given element's
2887 ;; caption as a secondary string.
2890 "Turn ATTRIBUTE property from ELEMENT into a plist.
2892 When optional argument PROPERTY is non-nil, return the value of
2893 that property within attributes.
2897 properties."
2905 "Return caption from ELEMENT as a secondary string.
2907 When optional argument SHORTP is non-nil, return short caption,
2908 as a secondary string, instead.
2910 Caption lines are separated by a white space."
2918 ;;;; For Export Snippets
2919 ;;
2920 ;; Every export snippet is transmitted to the back-end. Though, the
2921 ;; latter will only retain one type of export-snippet, ignoring
2922 ;; others, based on the former's target back-end. The function
2923 ;; `org-export-snippet-backend' returns that back-end for a given
2924 ;; export-snippet.
2927 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2928 Translation, with `org-export-snippet-translation-alist', is
2929 applied."
2933 back-end))))
2936 ;;;; For Footnotes
2937 ;;
2938 ;; `org-export-collect-footnote-definitions' is a tool to list
2939 ;; actually used footnotes definitions in the whole parse tree, or in
2940 ;; an headline, in order to add footnote listings throughout the
2941 ;; transcoded data.
2942 ;;
2943 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2944 ;; back-ends, when they need to attach the footnote definition only to
2945 ;; the first occurrence of the corresponding label.
2946 ;;
2947 ;; `org-export-get-footnote-definition' and
2948 ;; `org-export-get-footnote-number' provide easier access to
2949 ;; additional information relative to a footnote reference.
2952 "Return an alist between footnote numbers, labels and definitions.
2954 DATA is the parse tree from which definitions are collected.
2955 INFO is the plist used as a communication channel.
2957 Definitions are sorted by order of references. They either
2958 appear as Org data or as a secondary string for inlined
2959 footnotes. Unreferenced definitions are ignored."
2961 collect-fn ; for byte-compiler.
2965 ;; Collect footnote number, label and definition in DATA.
2967 data 'footnote-reference
2974 def)
2975 num-alist)
2976 ;; Also search in definition for nested footnotes.
2979 ;; Don't enter footnote definitions since it will happen
2980 ;; when their first reference is found.
2986 "Non-nil when a footnote reference is the first one for its label.
2988 FOOTNOTE-REFERENCE is the footnote reference being considered.
2989 INFO is the plist used as a communication channel."
2991 ;; Anonymous footnotes are always a first reference.
2993 ;; Otherwise, return the first footnote with the same LABEL and
2994 ;; test if it is equal to FOOTNOTE-REFERENCE.
3000 data 'footnote-reference
3005 ;; If FN isn't inlined, be sure to traverse its
3006 ;; definition before resuming search. See
3007 ;; comments in `org-export-get-footnote-number'
3008 ;; for more information.
3012 ;; Don't enter footnote definitions since it will
3013 ;; happen when their first reference is found.
3016 footnote-reference)))))
3019 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3020 INFO is the plist used as a communication channel."
3026 "Return number associated to a footnote.
3028 FOOTNOTE is either a footnote reference or a footnote definition.
3029 INFO is the plist used as a communication channel."
3031 seen-refs
3032 search-ref ; For byte-compiler.
3036 ;; Search footnote references through DATA, filling
3037 ;; SEEN-REFS along the way.
3039 data 'footnote-reference
3043 ;; Anonymous footnote match: return number.
3046 ;; Labels match: return number.
3049 ;; Anonymous footnote: it's always a new one. Also,
3050 ;; be sure to return nil from the `cond' so
3051 ;; `first-match' doesn't get us out of the loop.
3053 ;; Label not seen so far: add it so SEEN-REFS.
3054 ;;
3055 ;; Also search for subsequent references in
3056 ;; footnote definition so numbering follows reading
3057 ;; logic. Note that we don't have to care about
3058 ;; inline definitions, since `org-element-map'
3059 ;; already traverses them at the right time.
3060 ;;
3061 ;; Once again, return nil to stay in the loop.
3066 nil))))
3067 ;; Don't enter footnote definitions since it will happen
3068 ;; when their first reference is found.
3073 ;;;; For Headlines
3074 ;;
3075 ;; `org-export-get-relative-level' is a shortcut to get headline
3076 ;; level, relatively to the lower headline level in the parsed tree.
3077 ;;
3078 ;; `org-export-get-headline-number' returns the section number of an
3079 ;; headline, while `org-export-number-to-roman' allows to convert it
3080 ;; to roman numbers.
3081 ;;
3082 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3083 ;; `org-export-last-sibling-p' are three useful predicates when it
3084 ;; comes to fulfill the `:headline-levels' property.
3087 "Return HEADLINE relative level within current parsed tree.
3088 INFO is a plist holding contextual information."
3093 "Non-nil when HEADLINE is considered as low level.
3095 INFO is a plist used as a communication channel.
3097 A low level headlines has a relative level greater than
3098 `:headline-levels' property value.
3100 Return value is the difference between HEADLINE relative level
3101 and the last level being considered as high enough, or nil."
3108 "Return HEADLINE numbering as a list of numbers.
3109 INFO is a plist holding contextual information."
3113 "Return a non-nil value if HEADLINE element should be numbered.
3114 INFO is a plist used as a communication channel."
3120 "Convert integer N into a roman numeral."
3133 res)))
3136 "Return list of tags associated to ELEMENT.
3138 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3139 is a plist used as a communication channel.
3141 Select tags (see `org-export-select-tags') and exclude tags (see
3142 `org-export-exclude-tags') are removed from the list.
3144 When non-nil, optional argument TAGS should be a list of strings.
3145 Any tag belonging to this list will also be removed."
3152 "Return node PROPERTY value for BLOB.
3154 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3155 element or object.
3157 If optional argument INHERITED is non-nil, the value can be
3158 inherited from a parent headline.
3160 Return value is a string or nil."
3172 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3173 INFO is a plist used as a communication channel."
3178 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3179 INFO is a plist used as a communication channel."
3183 ;;;; For Links
3184 ;;
3185 ;; `org-export-solidify-link-text' turns a string into a safer version
3186 ;; for links, replacing most non-standard characters with hyphens.
3187 ;;
3188 ;; `org-export-get-coderef-format' returns an appropriate format
3189 ;; string for coderefs.
3190 ;;
3191 ;; `org-export-inline-image-p' returns a non-nil value when the link
3192 ;; provided should be considered as an inline image.
3193 ;;
3194 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3195 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3196 ;; returns an appropriate unique identifier when found, or nil.
3197 ;;
3198 ;; `org-export-resolve-id-link' returns the first headline with
3199 ;; specified id or custom-id in parse tree, the path to the external
3200 ;; file with the id or nil when neither was found.
3201 ;;
3202 ;; `org-export-resolve-coderef' associates a reference to a line
3203 ;; number in the element it belongs, or returns the reference itself
3204 ;; when the element isn't numbered.
3207 "Take link text S and make a safe target out of it."
3212 "Return format string for code reference link.
3213 PATH is the link path. DESC is its description."
3221 "Non-nil if LINK object points to an inline image.
3223 Optional argument is a set of RULES defining inline images. It
3224 is an alist where associations have the following shape:
3226 \(TYPE . REGEXP)
3228 Applying a rule means apply REGEXP against LINK's path when its
3229 type is TYPE. The function will return a non-nil value if any of
3230 the provided rules is non-nil. The default rule is
3231 `org-export-default-inline-image-rule'.
3233 This only applies to links without a description."
3244 rules)
3245 ;; Return nil if no rule matched.
3246 nil))))
3249 "Resolve a code reference REF.
3251 INFO is a plist used as a communication channel.
3253 Return associated line number in source code, or REF itself,
3254 depending on src-block or example element's switches."
3262 org-coderef-label-format)))
3266 ;; Element containing REF is found. Resolve it to either
3267 ;; a label or a line number, as needed.
3277 "Return LINK destination.
3279 INFO is a plist holding contextual information.
3281 Return value can be an object, an element, or nil:
3283 - If LINK path matches a target object (i.e. <<path>>) or
3286 - If LINK path exactly matches the name affiliated keyword
3287 \(i.e. #+NAME: path) of an element, return that element.
3289 - If LINK path exactly matches any headline name, return that
3290 element. If more than one headline share that name, priority
3291 will be given to the one with the closest common ancestor, if
3292 any, or the first one in the parse tree otherwise.
3294 - Otherwise, return nil.
3300 ;; First try to find a matching "<<path>>" unless user specified
3301 ;; he was looking for an headline (path starts with a *
3302 ;; character).
3306 return target)))
3307 ;; Then try to find an element with a matching "#+NAME: path"
3308 ;; affiliated keyword.
3315 ;; Last case: link either points to an headline or to
3316 ;; nothingness. Try to find the source, with priority given to
3317 ;; headlines with the closest common ancestor. If such candidate
3318 ;; is found, return it, otherwise return nil.
3322 ;; Return first headline whose `:raw-value' property
3323 ;; is NAME in parse tree DATA, or nil.
3326 data 'headline
3330 name)
3331 headline))
3333 ;; Search among headlines sharing an ancestor with link,
3334 ;; from closest to farthest.
3342 ;; No match with a common ancestor: try the full parse-tree.
3348 "Return headline referenced as LINK destination.
3350 INFO is a plist used as a communication channel.
3352 Return value can be the headline element matched in current parse
3356 ;; First check if id is within the current parse tree.
3362 headline))
3364 ;; Otherwise, look for external files.
3368 "Return radio-target object referenced as LINK destination.
3370 INFO is a plist used as a communication channel.
3372 Return value can be a radio-target object or nil. Assume LINK
3382 ;;;; For References
3383 ;;
3384 ;; `org-export-get-ordinal' associates a sequence number to any object
3385 ;; or element.
3388 "Return ordinal number of an element or object.
3390 ELEMENT is the element or object considered. INFO is the plist
3391 used as a communication channel.
3393 Optional argument TYPES, when non-nil, is a list of element or
3394 object types, as symbols, that should also be counted in.
3395 Otherwise, only provided element's type is considered.
3397 Optional argument PREDICATE is a function returning a non-nil
3398 value if the current element or object should be counted in. It
3399 accepts two arguments: the element or object being considered and
3400 the plist used as a communication channel. This allows to count
3401 only a certain type of objects (i.e. inline images).
3403 Return value is a list of numbers if ELEMENT is an headline or an
3404 item. It is nil for keywords. It represents the footnote number
3405 for footnote definitions and footnote references. If ELEMENT is
3406 a target, return the same value as if ELEMENT was the closest
3407 table, item or headline containing the target. In any other
3408 case, return the sequence number of ELEMENT among elements or
3409 objects of the same type."
3410 ;; A target keyword, representing an invisible target, never has
3411 ;; a sequence number.
3413 ;; Ordinal of a target object refer to the ordinal of the closest
3414 ;; table, item, or headline containing the object.
3418 when
3422 table))
3423 return parent)))
3425 ;; Special case 1: An headline returns its number as a list.
3427 ;; Special case 2: An item returns its number as a list.
3431 struct
3438 ;; Increment counter until ELEMENT is found again.
3449 ;;;; For Src-Blocks
3450 ;;
3451 ;; `org-export-get-loc' counts number of code lines accumulated in
3452 ;; src-block or example-block elements with a "+n" switch until
3453 ;; a given element, excluded. Note: "-n" switches reset that count.
3454 ;;
3455 ;; `org-export-unravel-code' extracts source code (along with a code
3456 ;; references alist) from an `element-block' or `src-block' type
3457 ;; element.
3458 ;;
3459 ;; `org-export-format-code' applies a formatting function to each line
3460 ;; of code, providing relative line number and code reference when
3461 ;; appropriate. Since it doesn't access the original element from
3462 ;; which the source code is coming, it expects from the code calling
3463 ;; it to know if lines should be numbered and if code references
3464 ;; should appear.
3465 ;;
3466 ;; Eventually, `org-export-format-code-default' is a higher-level
3467 ;; function (it makes use of the two previous functions) which handles
3468 ;; line numbering and code references inclusion, and returns source
3469 ;; code in a format suitable for plain text or verbatim output.
3472 "Return accumulated lines of code up to ELEMENT.
3474 INFO is the plist used as a communication channel.
3476 ELEMENT is excluded from count."
3483 ;; ELEMENT is reached: Quit the loop.
3485 ;; Only count lines from src-block and example-block elements
3486 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3490 ;; Accumulate locs or reset them.
3494 ;; Return nil to stay in the loop.
3495 nil)))
3497 ;; Return value.
3498 loc))
3501 "Clean source code and extract references out of it.
3503 ELEMENT has either a `src-block' an `example-block' type.
3505 Return a cons cell whose CAR is the source code, cleaned from any
3506 reference and protective comma and CDR is an alist between
3507 relative line number (integer) and name of code reference on that
3508 line (string)."
3510 ;; Get code and clean it. Remove blank lines at its
3511 ;; beginning and end. Also remove protective commas.
3517 ;; If appropriate, remove global indentation.
3521 ;; Free up the protected lines. Note: Org blocks
3522 ;; have commas at the beginning or every line.
3527 ;; Get format used for references.
3530 org-coderef-label-format)))
3531 ;; Build a regexp matching a loc with a reference.
3536 ;; Return value.
3538 ;; Code with references removed.
3544 ;; Ref line: remove ref, and signal its position in REFS.
3548 ;; Reference alist.
3549 refs)))
3552 "Format CODE by applying FUN line-wise and return it.
3554 CODE is a string representing the code to format. FUN is
3555 a function. It must accept three arguments: a line of
3556 code (string), the current line number (integer) or nil and the
3557 reference associated to the current line (string) or nil.
3559 Optional argument NUM-LINES can be an integer representing the
3560 number of code lines accumulated until the current code. Line
3561 numbers passed to FUN will take it into account. If it is nil,
3562 FUN's second argument will always be nil. This number can be
3563 obtained with `org-export-get-loc' function.
3565 Optional argument REF-ALIST can be an alist between relative line
3566 number (i.e. ignoring NUM-LINES) and the name of the code
3567 reference on it. If it is nil, FUN's third argument will always
3568 be nil. It can be obtained through the use of
3569 `org-export-unravel-code' function."
3581 "Return source code from ELEMENT, formatted in a standard way.
3583 ELEMENT is either a `src-block' or `example-block' element. INFO
3584 is a plist used as a communication channel.
3586 This function takes care of line numbering and code references
3587 inclusion. Line numbers, when applicable, appear at the
3588 beginning of the line, separated from the code by two white
3589 spaces. Code references, on the other hand, appear flushed to
3590 the right, separated by six white spaces from the widest line of
3591 code."
3592 ;; Extract code and references.
3598 ;; Handle line numbering.
3607 ;; Prepare references display, if required. Any reference
3608 ;; should start six columns after the widest line of code,
3609 ;; wrapped with parenthesis.
3614 code
3618 number-str
3619 loc
3625 num-start refs)))
3628 ;;;; For Tables
3629 ;;
3630 ;; `org-export-table-has-special-column-p' and and
3631 ;; `org-export-table-row-is-special-p' are predicates used to look for
3632 ;; meta-information about the table structure.
3633 ;;
3634 ;; `org-table-has-header-p' tells when the rows before the first rule
3635 ;; should be considered as table's header.
3636 ;;
3637 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3638 ;; and `org-export-table-cell-borders' extract information from
3639 ;; a table-cell element.
3640 ;;
3641 ;; `org-export-table-dimensions' gives the number on rows and columns
3642 ;; in the table, ignoring horizontal rules and special columns.
3643 ;; `org-export-table-cell-address', given a table-cell object, returns
3644 ;; the absolute address of a cell. On the other hand,
3645 ;; `org-export-get-table-cell-at' does the contrary.
3646 ;;
3647 ;; `org-export-table-cell-starts-colgroup-p',
3648 ;; `org-export-table-cell-ends-colgroup-p',
3649 ;; `org-export-table-row-starts-rowgroup-p',
3650 ;; `org-export-table-row-ends-rowgroup-p',
3651 ;; `org-export-table-row-starts-header-p' and
3652 ;; `org-export-table-row-ends-header-p' indicate position of current
3653 ;; row or cell within the table.
3656 "Non-nil when TABLE has a special column.
3657 All special columns will be ignored during export."
3658 ;; The table has a special column when every first cell of every row
3659 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3660 ;; "*" "_" and "^". Though, do not consider a first row containing
3661 ;; only empty cells as special.
3677 "Non-nil when TABLE has an header.
3679 INFO is a plist used as a communication channel.
3681 A table has an header when it contains at least two row groups."
3684 table 'table-row
3692 info)))
3695 "Non-nil if TABLE-ROW is considered special.
3697 INFO is a plist used as the communication channel.
3699 All special rows will be ignored during export."
3703 ;; A row is special either when...
3705 ;; ... it starts with a field only containing "/",
3707 ;; ... the table contains a special column and the row start
3708 ;; with a marking character among, "^", "_", "$" or "!",
3712 ;; ... it contains only alignment cookies and empty cells.
3718 ;; Since VALUE is a secondary string, the following
3719 ;; checks avoid expanding it with `org-export-data'.
3731 "Return TABLE-ROW's group.
3733 INFO is a plist used as the communication channel.
3735 Return value is the group number, as an integer, or nil special
3736 rows and table rules. Group 1 is also table's header."
3753 "Return TABLE-CELL contents width.
3755 INFO is a plist used as the communication channel.
3757 Return value is the width given by the last width cookie in the
3758 same column as TABLE-CELL, or nil."
3763 cookie-width)
3767 ;; In a special row, try to find a width cookie at COLUMN.
3771 ;; The following checks avoid expanding unnecessarily the
3772 ;; cell with `org-export-data'
3780 ;; Ignore table rules.
3783 ;; Return value.
3784 cookie-width))
3787 "Return TABLE-CELL contents alignment.
3789 INFO is a plist used as the communication channel.
3791 Return alignment as specified by the last alignment cookie in the
3792 same column as TABLE-CELL. If no such cookie is found, a default
3793 alignment value will be deduced from fraction of numbers in the
3794 column (see `org-table-number-fraction' for more information).
3795 Possible values are `left', `right' and `center'."
3802 cookie-align)
3806 ;; In a special row, try to find an alignment cookie at
3807 ;; COLUMN.
3811 ;; Since VALUE is a secondary string, the following checks
3812 ;; avoid useless expansion through `org-export-data'.
3820 ;; Ignore table rules.
3822 ;; In a standard row, check if cell's contents are expressing
3823 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3824 ;; Though, don't bother if an alignment cookie has already
3825 ;; defined cell's alignment.
3830 info)))
3835 ;; Return value. Alignment specified by cookies has precedence
3836 ;; over alignment deduced from cells contents.
3845 "Return TABLE-CELL borders.
3847 INFO is a plist used as a communication channel.
3849 Return value is a list of symbols, or nil. Possible values are:
3850 `top', `bottom', `above', `below', `left' and `right'. Note:
3851 `top' (resp. `bottom') only happen for a cell in the first
3852 row (resp. last row) of the table, ignoring table rules, if any.
3854 Returned borders ignore special rows."
3857 borders)
3858 ;; Top/above border? TABLE-CELL has a border above when a rule
3859 ;; used to demarcate row groups can be found above. Hence,
3860 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3861 ;; another regular row has to be found above that rule.
3870 ;; Look at every row before the current one.
3872 ;; No rule above, or rule found starts the table (ignoring any
3873 ;; special row): TABLE-CELL is at the top of the table.
3876 ;; Bottom/below border? TABLE-CELL has a border below when next
3877 ;; non-regular row below is a rule.
3886 ;; Look at every row after the current one.
3888 ;; No rule below, or rule found ends the table (modulo some
3889 ;; special row): TABLE-CELL is at the bottom of the table.
3892 ;; Right/left borders? They can only be specified by column
3893 ;; groups. Column groups are defined in a row starting with "/".
3894 ;; Also a column groups row only contains "<", "<>", ">" or blank
3895 ;; cells.
3912 ;; There's a left border when previous cell, if
3913 ;; any, ends a group, or current one starts one.
3919 ;; There's a right border when next cell, if any,
3920 ;; starts a group, or current one ends one.
3927 ;; Table rows are read in reverse order so last column groups
3928 ;; row has precedence over any previous one.
3930 ;; Return value.
3931 borders))
3934 "Non-nil when TABLE-CELL is at the beginning of a row group.
3935 INFO is a plist used as a communication channel."
3936 ;; A cell starts a column group either when it is at the beginning
3937 ;; of a row (or after the special column, if any) or when it has
3938 ;; a left border.
3942 table-cell)
3946 "Non-nil when TABLE-CELL is at the end of a row group.
3947 INFO is a plist used as a communication channel."
3948 ;; A cell ends a column group either when it is at the end of a row
3949 ;; or when it has a right border.
3952 table-cell)
3956 "Non-nil when TABLE-ROW is at the beginning of a column group.
3957 INFO is a plist used as a communication channel."
3965 "Non-nil when TABLE-ROW is at the end of a column group.
3966 INFO is a plist used as a communication channel."
3974 "Non-nil when TABLE-ROW is the first table header's row.
3975 INFO is a plist used as a communication channel."
3982 "Non-nil when TABLE-ROW is the last table header's row.
3983 INFO is a plist used as a communication channel."
3990 "Return TABLE dimensions.
3992 INFO is a plist used as a communication channel.
3994 Return value is a CONS like (ROWS . COLUMNS) where
3995 ROWS (resp. COLUMNS) is the number of exportable
3996 rows (resp. columns)."
3998 ;; Set number of rows, and extract first one.
4000 table 'table-row
4005 ;; Set number of columns.
4007 ;; Return value.
4011 "Return address of a regular TABLE-CELL object.
4013 TABLE-CELL is the cell considered. INFO is a plist used as
4014 a communication channel.
4016 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4017 zero-based index. Only exportable cells are considered. The
4018 function returns nil for other cells."
4021 ;; Ignore cells in special rows or in special column.
4026 ;; Row number.
4029 table 'table-row
4035 ;; Column number.
4038 table-row 'table-cell
4044 "Return regular table-cell object at ADDRESS in TABLE.
4046 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4047 zero-based index. TABLE is a table type element. INFO is
4048 a plist used as a communication channel.
4050 If no table-cell, among exportable cells, is found at ADDRESS,
4051 return nil."
4054 ;; Row at (car address) or nil.
4057 table 'table-row
4063 'table-cell
4070 ;;;; For Tables Of Contents
4071 ;;
4072 ;; `org-export-collect-headlines' builds a list of all exportable
4073 ;; headline elements, maybe limited to a certain depth. One can then
4074 ;; easily parse it and transcode it.
4075 ;;
4076 ;; Building lists of tables, figures or listings is quite similar.
4077 ;; Once the generic function `org-export-collect-elements' is defined,
4078 ;; `org-export-collect-tables', `org-export-collect-figures' and
4079 ;; `org-export-collect-listings' can be derived from it.
4082 "Collect headlines in order to build a table of contents.
4084 INFO is a plist used as a communication channel.
4086 When optional argument N is an integer, it specifies the depth of
4087 the table of contents. Otherwise, it is set to the value of the
4088 last headline level. See `org-export-headline-levels' for more
4089 information.
4091 Return a list of all exportable headlines as parsed elements."
4095 'headline
4097 ;; Strip contents from HEADLINE.
4100 info))
4103 "Collect referenceable elements of a determined type.
4105 TYPE can be a symbol or a list of symbols specifying element
4106 types to search. Only elements with a caption are collected.
4108 INFO is a plist used as a communication channel.
4110 When non-nil, optional argument PREDICATE is a function accepting
4111 one argument, an element of type TYPE. It returns a non-nil
4112 value when that element should be collected.
4114 Return a list of all elements found, in order of appearance."
4120 element))
4121 info))
4124 "Build a list of tables.
4125 INFO is a plist used as a communication channel.
4127 Return a list of table elements with a caption."
4131 "Build a list of figures.
4133 INFO is a plist used as a communication channel. PREDICATE is
4134 a function which accepts one argument: a paragraph element and
4135 whose return value is non-nil when that element should be
4136 collected.
4138 A figure is a paragraph type element, with a caption, verifying
4140 a vague concept that may depend on back-end.
4142 Return a list of elements recognized as figures."
4146 "Build a list of src blocks.
4148 INFO is a plist used as a communication channel.
4150 Return a list of src-block elements with a caption."
4154 ;;;; Topology
4155 ;;
4156 ;; Here are various functions to retrieve information about the
4157 ;; neighbourhood of a given element or object. Neighbours of interest
4158 ;; are direct parent (`org-export-get-parent'), parent headline
4159 ;; (`org-export-get-parent-headline'), first element containing an
4160 ;; object, (`org-export-get-parent-element'), parent table
4161 ;; (`org-export-get-parent-table'), previous element or object
4162 ;; (`org-export-get-previous-element') and next element or object
4163 ;; (`org-export-get-next-element').
4164 ;;
4165 ;; `org-export-get-genealogy' returns the full genealogy of a given
4166 ;; element or object, from closest parent to full parse tree.
4169 "Return BLOB parent or nil.
4170 BLOB is the element or object considered."
4174 "Return full genealogy relative to a given element or object.
4176 BLOB is the element or object being considered.
4178 Ancestors are returned from closest to farthest, the last one
4179 being the full parse tree."
4186 "Return BLOB parent headline or nil.
4187 BLOB is the element or object being considered."
4191 parent))
4194 "Return first element containing OBJECT or nil.
4195 OBJECT is the object to consider."
4199 parent))
4202 "Return OBJECT parent table or nil.
4203 OBJECT is either a `table-cell' or `table-element' type object."
4207 parent))
4210 "Return previous element or object.
4211 BLOB is an element or object. INFO is a plist used as
4212 a communication channel. Return previous exportable element or
4213 object, a string, or nil."
4223 "Return next element or object.
4224 BLOB is an element or object. INFO is a plist used as
4225 a communication channel. Return next exportable element or
4226 object, a string, or nil."
4232 nil))
4235 ;;;; Translation
4236 ;;
4237 ;; `org-export-translate' translates a string according to language
4238 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4239 ;; variable and a specified charset. `org-export-dictionary' contains
4240 ;; the dictionary used for the translation.
4362 "Dictionary for export engine.
4364 Alist whose CAR is the string to translate and CDR is an alist
4365 whose CAR is the language string and CDR is a plist whose
4366 properties are possible charsets and values translated terms.
4368 It is used as a database for `org-export-translate'. Since this
4369 function returns the string as-is if no translation was found,
4370 the variable only needs to record values different from the
4374 "Translate string S according to language specification.
4376 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4377 and `:utf-8'. INFO is a plist used as a communication channel.
4379 Translation depends on `:language' property. Return the
4380 translated string. If no translation is found, try to fall back
4381 to `:default' encoding. If it fails, return S."
4387 s)))
4390 \f
4391 ;;; The Dispatcher
4392 ;;
4393 ;; `org-export-dispatch' is the standard interactive way to start an
4394 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4395 ;; for its interface, which, in turn, delegates response to key
4396 ;; pressed to `org-export-dispatch-action'.
4399 "List of menu entries available for `org-export-dispatch'.
4400 This variable shouldn't be set directly. Set-up :menu-entry
4401 keyword in either `org-export-define-backend' or
4404 ;;;###autoload
4406 "Export dispatcher for Org mode.
4408 It provides an access to common export related tasks in a buffer.
4409 Its interface comes in two flavours: standard and expert. While
4410 both share the same set of bindings, only the former displays the
4411 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4412 to switch to one or the other.
4414 Return an error if key pressed has no associated command."
4417 nil
4418 org-export-dispatch-use-expert-ui))
4422 ;; First handle special hard-coded actions.
4428 "Publish project: "
4429 org-e-publish-project-alist nil t)
4430 org-e-publish-project-alist)
4440 "Handle interface for `org-export-dispatch'.
4442 OPTIONS is a list containing current interactive options set for
4443 export. It can contain any of the following symbols:
4444 `body' toggles a body-only export
4445 `subtree' restricts export to current subtree
4446 `visible' restricts export to visible part of buffer.
4447 `force' force publishing files.
4449 FIRST-KEY is the key pressed to select the first level menu. It
4450 is nil when this menu hasn't been selected yet.
4452 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4453 buffer is provided, but indications about currently active
4454 options are given in the prompt. Moreover, \[?] allows to switch
4455 back to standard interface."
4458 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4459 ;; non-nil is the required first-level key to activate
4460 ;; KEY. When its value is t, activate KEY independently
4461 ;; on the first key, if any. A nil value means KEY will
4462 ;; only be activated at first level.
4466 ;; Make sure order of menu doesn't depend on the order in
4467 ;; which back-ends are loaded.
4470 ;; Compute a list of allowed keys based on the first key
4471 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4472 ;; always available.
4482 ;; Build the help menu for standard UI.
4486 ;; Options are hard-coded.
4488 [%s] Body only: %s [%s] Visible only: %s
4498 ;; Display registered back-end entries.
4508 ;; Split sub-menu into two columns.
4518 top-key)
4523 ;; Publishing menu is hard-coded.
4525 [%s] Current file [%s] Current project
4535 ;; Build prompts for both standard and expert UI.
4540 "Export command (Options: %s%s%s%s) [%s]: "
4546 ;; With expert UI, just read key with a fancy prompt. In standard
4547 ;; UI, display an intrusive help buffer.
4550 expert-prompt allowed-keys backends options first-key expertp)
4562 standard-prompt allowed-keys backends options first-key expertp))
4568 "Read a character from command input and act accordingly.
4570 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
4571 a list of characters available at a given step in the process.
4572 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
4573 EXPERTP are the same as defined in `org-export-dispatch-ui',
4574 which see.
4576 Toggle export options when required. Otherwise, return value is
4577 a list with action as CAR and a list of interactive export
4578 options as CDR."
4580 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4581 ;; depending on user's key pressed.
4584 ;; Ignore non-standard characters (i.e. "M-a") and
4585 ;; undefined associations.
4588 ;; q key at first level aborts export. At second
4589 ;; level, cancel first key instead.
4592 ;; Help key: Switch back to standard interface if
4593 ;; expert UI was active.
4595 ;; Toggle export options.
4602 first-key expertp))
4603 ;; Action selected: Send key and options back to
4604 ;; `org-export-dispatch'.
4610 ;; Publishing actions are hard-coded. Send a special
4611 ;; signal to `org-export-dispatch'.
4619 options))
4620 ;; Otherwise, enter sub-menu.
4625 ;;; org-export.el ends here