| blob | b1b5f9a8d07b4787f545b025a549b6144ad30f86 |
1 ;;; org-export.el --- Generic Export Engine For Org
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
22 ;;
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
25 ;;
26 ;; Besides that parser, the generic exporter is made of three distinct
27 ;; parts:
28 ;;
29 ;; - The communication channel consists in a property list, which is
30 ;; created and updated during the process. Its use is to offer
31 ;; every piece of information, would it be about initial environment
32 ;; or contextual data, all in a single place. The exhaustive list
33 ;; of properties is given in "The Communication Channel" section of
34 ;; this file.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core function is `org-export-as'. It returns the transcoded
48 ;; buffer as a string.
49 ;;
50 ;; An export back-end is defined with `org-export-define-backend',
51 ;; which sets one mandatory variable: his translation table. Its name
52 ;; is always `org-BACKEND-translate-alist' where BACKEND stands for
53 ;; the name chosen for the back-end. Its value is an alist whose keys
54 ;; are elements and objects types and values translator functions.
55 ;; See function's docstring for more information about translators.
56 ;;
57 ;; Optionally, `org-export-define-backend' can also support specific
58 ;; buffer keywords, OPTION keyword's items and filters. Also refer to
59 ;; function documentation for more information.
60 ;;
61 ;; If the new back-end shares most properties with another one,
62 ;; `org-export-define-derived-backend' can be used to simplify the
63 ;; process.
64 ;;
65 ;; Any back-end can define its own variables. Among them, those
66 ;; customizable should belong to the `org-export-BACKEND' group.
67 ;;
68 ;; Tools for common tasks across back-ends are implemented in the
69 ;; penultimate part of this file. A dispatcher for standard back-ends
70 ;; is provided in the last one.
72 ;;; Code:
89 \f
90 ;;; Internal Variables
91 ;;
92 ;; Among internal variables, the most important is
93 ;; `org-export-options-alist'. This variable define the global export
94 ;; options, shared between every exporter, and how they are acquired.
136 "Alist between export properties and ways to set them.
138 The CAR of the alist is the property name, and the CDR is a list
139 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
141 KEYWORD is a string representing a buffer keyword, or nil. Each
142 property defined this way can also be set, during subtree
143 export, through an headline property named after the keyword
145 property).
146 OPTION is a string that could be found in an #+OPTIONS: line.
147 DEFAULT is the default value for the property.
148 BEHAVIOUR determine how Org should handle multiple keywords for
149 the same property. It is a symbol among:
150 nil Keep old value and discard the new one.
151 t Replace old value with the new one.
152 `space' Concatenate the values, separating them with a space.
153 `newline' Concatenate the values, separating them with
154 a newline.
155 `split' Split values at white spaces, and cons them to the
156 previous list.
158 KEYWORD and OPTION have precedence over DEFAULT.
160 All these properties should be back-end agnostic. Back-end
161 specific properties are set through `org-export-define-backend'.
165 "List of in-buffer keywords that require special treatment.
166 These keywords are not directly associated to a property. The
167 way they are handled must be hard-coded into
226 "Alist between filters properties and initial values.
228 The key of each association is a property name accessible through
229 the communication channel. Its value is a configurable global
230 variable defining initial filters.
232 This list is meant to install user specified filters. Back-end
233 developers may install their own filters using
234 `org-export-define-backend'. Filters defined there will always
235 be prepended to the current list, so they always get applied
244 "Default rule for link matching an inline image.
245 This rule applies to links with no description. By default, it
246 will be considered as an inline image if it targets a local file
249 See `org-export-inline-image-p' for more information about
253 \f
254 ;;; User-configurable Variables
255 ;;
256 ;; Configuration for the masses.
257 ;;
258 ;; They should never be accessed directly, as their value is to be
259 ;; stored in a property list (cf. `org-export-options-alist').
260 ;; Back-ends will read their value from there instead.
263 "Options for exporting Org mode files."
268 "General options for export engine."
273 "Whether sub-trees with the ARCHIVE tag should be exported.
275 This can have three different values:
276 nil Do not export, pretend this tree is not present.
277 t Do export the entire tree.
278 `headline' Only export the headline, but skip the tree below it.
280 This option can also be set with the #+OPTIONS line,
289 "Non-nil means insert author name into the exported file.
290 This option can also be set with the #+OPTIONS line,
296 "Non-nil means export CLOCK keywords.
297 This option can also be set with the #+OPTIONS line,
303 "Non-nil means the postamble should contain a creator sentence.
305 The sentence can be set in `org-export-creator-string' and
308 If the value is `comment' insert it as a comment."
318 emacs-version)
319 "String to insert at the end of the generated document."
324 "Non-nil means export contents of standard drawers.
326 When t, all drawers are exported. This may also be a list of
327 drawer names to export. This variable doesn't apply to
328 properties drawers.
330 This option can also be set with the #+OPTIONS line,
340 "Non-nil means insert author email into the exported file.
341 This option can also be set with the #+OPTIONS line,
347 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
349 If the export target supports emphasizing text, the word will be
350 typeset in bold, italic, or underlined, respectively. Not all
351 export backends support this.
358 "Tags that exclude a tree from export.
360 All trees carrying any of these tags will be excluded from
361 export. This is without condition, so even subtrees inside that
362 carry one of the `org-export-select-tags' will be removed.
364 This option can also be set with the #+EXCLUDE_TAGS: keyword."
371 This can be used to have pre-formatted text, fragments of code
372 etc. For example:
373 : ;; Some Lisp examples
374 : (while (defc cnt)
375 : (ding))
376 will be looking just like this in also HTML. See also the QUOTE
377 keyword. Not all export backends support this.
384 "Non-nil means Org footnotes should be exported.
385 This option can also be set with the #+OPTIONS line,
391 "The last level which is still exported as a headline.
393 Inferior levels will produce itemize lists when exported.
400 "The default language for export and clocktable translations, as a string.
401 This may have an association in
402 `org-clock-clocktable-language-setup'."
407 "Non-nil means preserve all line breaks when exporting.
409 Normally, in HTML output paragraphs will be reformatted.
411 This option can also be set with the #+OPTIONS line,
417 "Non-nil means interpret entities when exporting.
420 Å.
422 For a list of supported names, see the constant `org-entities'
423 and the user option `org-entities-user'.
425 This option can also be set with the #+OPTIONS line,
431 "Non-nil means inlinetasks should be exported.
432 This option can also be set with the #+OPTIONS line,
438 "Non-nil means include planning info in export.
439 This option can also be set with the #+OPTIONS: line,
445 "Non-nil means include priority cookies in export.
446 This option can also be set with the #+OPTIONS line,
452 "Non-nil means add section numbers to headlines when exporting.
454 When set to an integer n, numbering will only happen for
455 headlines whose relative level is higher or equal to n.
457 This option can also be set with the #+OPTIONS line,
463 "Tags that select a tree for export.
465 If any such tag is found in a buffer, all trees that do not carry
466 one of these tags will be ignored during export. Inside trees
467 that are selected like this, you can still deselect a subtree by
468 tagging it with one of the `org-export-exclude-tags'.
470 This option can also be set with the #+SELECT_TAGS: keyword."
477 When this option is turned on, these strings will be exported as:
479 Org HTML LaTeX UTF-8
480 -----+----------+--------+-------
482 -- – -- –
483 --- — --- —
486 This option can also be set with the #+OPTIONS line,
492 "Non-nil means include statistics cookies in export.
493 This option can also be set with the #+OPTIONS: line,
501 When this option is turned on, you can use TeX-like syntax for
503 will be considered as a single item - so grouping with {} is
504 normally not needed. For example, the following things will be
505 parsed as single sub- or superscripts.
507 10^24 or 10^tau several digits will be considered 1 item.
508 10^-12 or 10^-tau a leading sign with digits or a word
509 x^2-y^3 will be read as x^2 - y^3, because items are
510 terminated by almost any nonword/nondigit char.
511 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
513 Still, ambiguity is possible - so when in doubt use {} to enclose
514 the sub/superscript. If you set this variable to the symbol
515 `{}', the braces are *required* in order to trigger
516 interpretations as sub/superscript. This can be helpful in
519 This option can also be set with the #+OPTIONS line,
528 "Non-nil means create a table of contents in exported files.
530 The TOC contains headlines with levels up
531 to`org-export-headline-levels'. When an integer, include levels
532 up to N in the toc, this may then be different from
533 `org-export-headline-levels', but it will not be allowed to be
534 larger than the number of headline levels. When nil, no table of
535 contents is made.
537 This option can also be set with the #+OPTIONS line,
547 For example:
549 | Name | Address | Birthday |
550 |-------------+----------+-----------|
551 | Arthur Dent | England | 29.2.2100 |
558 "If nil, do not export tags, just remove them from headlines.
560 If this is the symbol `not-in-toc', tags will be removed from
561 table of contents entries, but still be shown in the headlines of
562 the document.
564 This option can also be set with the #+OPTIONS line,
573 "Non-nil means include TODO items for export.
574 This may have the following values:
575 t include tasks independent of state.
576 todo include only tasks that are not yet done.
577 done include only tasks that are already done.
578 nil remove all tasks before export
579 list of keywords keep only tasks with these keywords"
590 "Non-nil means insert a time stamp into the exported file.
591 The time stamp shows when the file was created.
593 This option can also be set with the #+OPTIONS line,
599 "Non nil means allow timestamps in export.
601 It can be set to `active', `inactive', t or nil, in order to
602 export, respectively, only active timestamps, only inactive ones,
603 all of them or none.
605 This option can also be set with the #+OPTIONS line, e.g.
615 "Non-nil means include TODO keywords in export.
616 When nil, remove all these keywords from the export."
621 "Non-nil means allow #+BIND to define local variable values for export.
622 This is a potential security risk, which is why the user must
623 confirm the use of these lines."
631 "Alist between export snippets back-ends and exporter back-ends.
633 This variable allows to provide shortcuts for export snippets.
637 HTML code while every other back-end will ignore it."
645 "Coding system for the exported file."
650 "Non-nil means exported stuff will also be pushed onto the kill ring."
655 "The initial scope when exporting with `org-export-dispatch'.
656 This variable can be either set to `buffer' or `subtree'."
663 "Non-nil means show buffer after exporting to temp buffer.
664 When Org exports to a file, the buffer visiting that file is ever
665 shown, but remains buried. However, when exporting to
666 a temporary buffer, that buffer is popped up in a second window.
667 When this variable is nil, the buffer remains buried also in
668 these cases."
673 "Non-nil means using a non-intrusive `org-export-dispatch'.
674 In that case, no help buffer is displayed. Though, an indicator
678 considered for export\). Also, \[?] allows to switch back to
679 standard mode."
684 \f
685 ;;; Defining New Back-ends
686 ;;
687 ;; `org-export-define-backend' is the standard way to define an export
688 ;; back-end. It allows to specify translators, filters, buffer
689 ;; options and a menu entry. If the new back-end shares translators
690 ;; with another back-end, `org-export-define-derived-backend' may be
691 ;; used instead.
692 ;;
693 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
694 ;; when a given back-end hasn't been registered yet.
697 "Define a new back-end BACKEND.
699 TRANSLATORS is an alist between object or element types and
700 functions handling them.
702 These functions should return a string without any trailing
703 space, or nil. They must accept three arguments: the object or
704 element itself, its contents or nil when it isn't recursive and
705 the property list used as a communication channel.
707 Contents, when not nil, are stripped from any global indentation
708 \(although the relative one is preserved). They also always end
709 with a single newline character.
711 If, for a given type, no function is found, that element or
712 object type will simply be ignored, along with any blank line or
713 white space at its end. The same will happen if the function
714 returns the nil value. If that function returns the empty
715 string, the type will be ignored, but the blank lines or white
716 spaces will be kept.
718 In addition to element and object types, one function can be
719 associated to the `template' symbol and another one to the
720 `plain-text' symbol.
722 The former returns the final transcoded string, and can be used
723 to add a preamble and a postamble to document's body. It must
724 accept two arguments: the transcoded string and the property list
725 containing export options.
727 The latter, when defined, is to be called on every text not
728 recognized as an element or an object. It must accept two
729 arguments: the text string and the information channel. It is an
730 appropriate place to protect special chars relative to the
731 back-end.
733 BODY can start with pre-defined keyword arguments. The following
734 keywords are understood:
736 :export-block
738 String, or list of strings, representing block names that
739 will not be parsed. This is used to specify blocks that will
740 contain raw code specific to the back-end. These blocks
741 still have to be handled by the relative `export-block' type
742 translator.
744 :filters-alist
746 Alist between filters and function, or list of functions,
747 specific to the back-end. See `org-export-filters-alist' for
748 a list of all allowed filters. Filters defined here
749 shouldn't make a back-end test, as it may prevent back-ends
750 derived from this one to behave properly.
752 :menu-entry
754 Menu entry for the export dispatcher. It should be a list
755 like:
757 \(KEY DESCRIPTION ACTION-OR-MENU)
759 where :
761 KEY is a free character selecting the back-end.
762 DESCRIPTION is a string naming the back-end.
763 ACTION-OR-MENU is either a function or an alist.
765 If it is an action, it will be called with three arguments:
766 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
767 for further explanations.
769 If it is an alist, associations should follow the
770 pattern:
772 \(KEY DESCRIPTION ACTION)
774 where KEY, DESCRIPTION and ACTION are described above.
776 Valid values include:
780 or
787 \(lambda (subtree visible body-only)
788 \(org-open-file
789 \(org-e-latex-export-to-pdf subtree visible body-only))))))
791 :options-alist
793 Alist between back-end specific properties introduced in
794 communication channel and how their value are acquired. See
795 `org-export-options-alist' for more information about
796 structure of the values."
811 ;; Define translators.
814 ;; Define options.
818 See `org-export-options-alist' for more information on the
819 structure of the values."
820 backend)))
821 ;; Define filters.
824 "Alist between filters keywords and back-end specific filters.
826 ;; Tell parser to not parse EXPORT-BLOCK blocks.
833 ;; Add an entry for back-end in `org-export-dispatch'.
838 ;; Splice in the body, if any.
842 "Create a new back-end as a variant of an existing one.
844 CHILD is the name of the derived back-end. PARENT is the name of
845 the parent back-end.
847 BODY can start with pre-defined keyword arguments. The following
848 keywords are understood:
850 :export-block
852 String, or list of strings, representing block names that
853 will not be parsed. This is used to specify blocks that will
854 contain raw code specific to the back-end. These blocks
855 still have to be handled by the relative `export-block' type
856 translator.
858 :filters-alist
860 Alist of filters that will overwrite or complete filters
861 defined in PARENT back-end. See `org-export-filters-alist'
862 for a list of allowed filters.
864 :menu-entry
866 Menu entry for the export dispatcher. See
867 `org-export-define-backend' for more information about the
868 expected value.
870 :options-alist
872 Alist of back-end specific properties that will overwrite or
873 complete those defined in PARENT back-end. Refer to
874 `org-export-options-alist' for more information about
875 structure of the values.
877 :sub-menu-entry
879 Append entries to an existing menu in the export dispatcher.
880 The associated value should be a list whose CAR is the
881 character selecting the menu to expand and CDR a list of
882 entries following the pattern:
884 \(KEY DESCRIPTION ACTION)
886 where KEY is a free character triggering the action,
887 DESCRIPTION is a string defining the action, and ACTION is
888 a function that will be called with three arguments:
889 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
890 for further explanations.
892 Valid values include:
896 \(lambda (s v b)
897 \(org-open-file (org-e-beamer-export-to-pdf s v b)))))
899 :translate-alist
901 Alist of element and object types and transcoders that will
902 overwrite or complete transcode table from PARENT back-end.
903 Refer to `org-export-define-backend' for detailed information
904 about transcoders.
907 as a variant of `e-latex' back-end with a custom template
908 function:
910 \(org-export-define-derived-backend my-latex e-latex
911 :translate-alist ((template . my-latex-template-fun)))
913 The back-end could then be called with, for example:
932 ;; Tell parser to not parse EXPORT-BLOCK blocks.
939 ;; Define filters.
946 "Alist between filters keywords and back-end specific filters.
948 ;; Define options.
956 See `org-export-options-alist' for more information on the
957 structure of the values."
958 child))))
959 ;; Define translators.
966 ;; Add an entry for back-end in `org-export-dispatch'.
973 org-export-dispatch-menu-entries))))
977 ;; Splice in the body, if any.
981 "Signal an error if BACKEND isn't defined."
986 \f
987 ;;; The Communication Channel
988 ;;
989 ;; During export process, every function has access to a number of
990 ;; properties. They are of two types:
991 ;;
992 ;; 1. Environment options are collected once at the very beginning of
993 ;; the process, out of the original buffer and configuration.
994 ;; Collecting them is handled by `org-export-get-environment'
995 ;; function.
996 ;;
997 ;; Most environment options are defined through the
998 ;; `org-export-options-alist' variable.
999 ;;
1000 ;; 2. Tree properties are extracted directly from the parsed tree,
1001 ;; just before export, by `org-export-collect-tree-properties'.
1002 ;;
1003 ;; Here is the full list of properties available during transcode
1004 ;; process, with their category and their value type.
1005 ;;
1006 ;; + `:author' :: Author's name.
1007 ;; - category :: option
1008 ;; - type :: string
1009 ;;
1010 ;; + `:back-end' :: Current back-end used for transcoding.
1011 ;; - category :: tree
1012 ;; - type :: symbol
1013 ;;
1014 ;; + `:creator' :: String to write as creation information.
1015 ;; - category :: option
1016 ;; - type :: string
1017 ;;
1018 ;; + `:date' :: String to use as date.
1019 ;; - category :: option
1020 ;; - type :: string
1021 ;;
1022 ;; + `:description' :: Description text for the current data.
1023 ;; - category :: option
1024 ;; - type :: string
1025 ;;
1026 ;; + `:email' :: Author's email.
1027 ;; - category :: option
1028 ;; - type :: string
1029 ;;
1030 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1031 ;; process.
1032 ;; - category :: option
1033 ;; - type :: list of strings
1034 ;;
1035 ;; + `:exported-data' :: Hash table used for memoizing
1036 ;; `org-export-data'.
1037 ;; - category :: tree
1038 ;; - type :: hash table
1039 ;;
1040 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1041 ;; their definition, as parsed data. Only non-inlined footnotes
1042 ;; are represented in this alist. Also, every definition isn't
1043 ;; guaranteed to be referenced in the parse tree. The purpose of
1044 ;; this property is to preserve definitions from oblivion
1045 ;; (i.e. when the parse tree comes from a part of the original
1046 ;; buffer), it isn't meant for direct use in a back-end. To
1047 ;; retrieve a definition relative to a reference, use
1048 ;; `org-export-get-footnote-definition' instead.
1049 ;; - category :: option
1050 ;; - type :: alist (STRING . LIST)
1051 ;;
1052 ;; + `:headline-levels' :: Maximum level being exported as an
1053 ;; headline. Comparison is done with the relative level of
1054 ;; headlines in the parse tree, not necessarily with their
1055 ;; actual level.
1056 ;; - category :: option
1057 ;; - type :: integer
1058 ;;
1059 ;; + `:headline-offset' :: Difference between relative and real level
1060 ;; of headlines in the parse tree. For example, a value of -1
1061 ;; means a level 2 headline should be considered as level
1062 ;; 1 (cf. `org-export-get-relative-level').
1063 ;; - category :: tree
1064 ;; - type :: integer
1065 ;;
1066 ;; + `:headline-numbering' :: Alist between headlines and their
1067 ;; numbering, as a list of numbers
1068 ;; (cf. `org-export-get-headline-number').
1069 ;; - category :: tree
1070 ;; - type :: alist (INTEGER . LIST)
1071 ;;
1072 ;; + `:id-alist' :: Alist between ID strings and destination file's
1073 ;; path, relative to current directory. It is used by
1074 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1075 ;; external file.
1076 ;; - category :: option
1077 ;; - type :: alist (STRING . STRING)
1078 ;;
1079 ;; + `:ignore-list' :: List of elements and objects that should be
1080 ;; ignored during export.
1081 ;; - category :: tree
1082 ;; - type :: list of elements and objects
1083 ;;
1084 ;; + `:input-file' :: Full path to input file, if any.
1085 ;; - category :: option
1086 ;; - type :: string or nil
1087 ;;
1088 ;; + `:keywords' :: List of keywords attached to data.
1089 ;; - category :: option
1090 ;; - type :: string
1091 ;;
1092 ;; + `:language' :: Default language used for translations.
1093 ;; - category :: option
1094 ;; - type :: string
1095 ;;
1096 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1097 ;; transcoding.
1098 ;; - category :: option
1099 ;; - type :: list (as returned by `org-element-parse-buffer')
1100 ;;
1101 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1102 ;; all line breaks.
1103 ;; - category :: option
1104 ;; - type :: symbol (nil, t)
1105 ;;
1106 ;; + `:section-numbers' :: Non-nil means transcoding should add
1107 ;; section numbers to headlines.
1108 ;; - category :: option
1109 ;; - type :: symbol (nil, t)
1110 ;;
1111 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1112 ;; in transcoding. When such a tag is present, subtrees without
1113 ;; it are de facto excluded from the process. See
1114 ;; `use-select-tags'.
1115 ;; - category :: option
1116 ;; - type :: list of strings
1117 ;;
1118 ;; + `:target-list' :: List of targets encountered in the parse tree.
1119 ;; This is used to partly resolve "fuzzy" links
1120 ;; (cf. `org-export-resolve-fuzzy-link').
1121 ;; - category :: tree
1122 ;; - type :: list of strings
1123 ;;
1124 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1125 ;; a time stamp in the output.
1126 ;; - category :: option
1127 ;; - type :: symbol (nil, t)
1128 ;;
1129 ;; + `:translate-alist' :: Alist between element and object types and
1130 ;; transcoding functions relative to the current back-end.
1131 ;; Special keys `template' and `plain-text' are also possible.
1132 ;; - category :: option
1133 ;; - type :: alist (SYMBOL . FUNCTION)
1134 ;;
1135 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1136 ;; also be transcoded. If it is set to the `headline' symbol,
1137 ;; only the archived headline's name is retained.
1138 ;; - category :: option
1139 ;; - type :: symbol (nil, t, `headline')
1140 ;;
1141 ;; + `:with-author' :: Non-nil means author's name should be included
1142 ;; in the output.
1143 ;; - category :: option
1144 ;; - type :: symbol (nil, t)
1145 ;;
1146 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
1147 ;; - category :: option
1148 ;; - type :: symbol (nil, t)
1149 ;;
1150 ;; + `:with-creator' :: Non-nild means a creation sentence should be
1151 ;; inserted at the end of the transcoded string. If the value
1152 ;; is `comment', it should be commented.
1153 ;; - category :: option
1154 ;; - type :: symbol (`comment', nil, t)
1155 ;;
1156 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1157 ;; its value is a list of names, only drawers with such names
1158 ;; will be transcoded.
1159 ;; - category :: option
1160 ;; - type :: symbol (nil, t) or list of strings
1161 ;;
1162 ;; + `:with-email' :: Non-nil means output should contain author's
1163 ;; email.
1164 ;; - category :: option
1165 ;; - type :: symbol (nil, t)
1166 ;;
1167 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1168 ;; interpreted.
1169 ;; - category :: option
1170 ;; - type :: symbol (nil, t)
1171 ;;
1172 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1173 ;; strings starting with a colon as a fixed-with (verbatim) area.
1174 ;; - category :: option
1175 ;; - type :: symbol (nil, t)
1176 ;;
1177 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1178 ;; footnotes.
1179 ;; - category :: option
1180 ;; - type :: symbol (nil, t)
1181 ;;
1182 ;; + `:with-plannings' :: Non-nil means transcoding should include
1183 ;; planning info.
1184 ;; - category :: option
1185 ;; - type :: symbol (nil, t)
1186 ;;
1187 ;; + `:with-priority' :: Non-nil means transcoding should include
1188 ;; priority cookies.
1189 ;; - category :: option
1190 ;; - type :: symbol (nil, t)
1191 ;;
1192 ;; + `:with-special-strings' :: Non-nil means transcoding should
1193 ;; interpret special strings in plain text.
1194 ;; - category :: option
1195 ;; - type :: symbol (nil, t)
1196 ;;
1197 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1198 ;; interpret subscript and superscript. With a value of "{}",
1199 ;; only interpret those using curly brackets.
1200 ;; - category :: option
1201 ;; - type :: symbol (nil, {}, t)
1202 ;;
1203 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1204 ;; tables.
1205 ;; - category :: option
1206 ;; - type :: symbol (nil, t)
1207 ;;
1208 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1209 ;; headlines. A `not-in-toc' value will remove them from the
1210 ;; table of contents, if any, nonetheless.
1211 ;; - category :: option
1212 ;; - type :: symbol (nil, t, `not-in-toc')
1213 ;;
1214 ;; + `:with-tasks' :: Non-nil means transcoding should include
1215 ;; headlines with a TODO keyword. A `todo' value will only
1216 ;; include headlines with a todo type keyword while a `done'
1217 ;; value will do the contrary. If a list of strings is provided,
1218 ;; only tasks with keywords belonging to that list will be kept.
1219 ;; - category :: option
1220 ;; - type :: symbol (t, todo, done, nil) or list of strings
1221 ;;
1222 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1223 ;; time stamps. Special value `active' (resp. `inactive') ask to
1224 ;; export only active (resp. inactive) timestamps. Otherwise,
1225 ;; completely remove them.
1226 ;; - category :: option
1227 ;; - type :: symbol: (`active', `inactive', t, nil)
1228 ;;
1229 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1230 ;; added to the output. An integer value limits its depth.
1231 ;; - category :: option
1232 ;; - type :: symbol (nil, t or integer)
1233 ;;
1234 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1235 ;; include TODO keywords.
1236 ;; - category :: option
1237 ;; - type :: symbol (nil, t)
1240 ;;;; Environment Options
1241 ;;
1242 ;; Environment options encompass all parameters defined outside the
1243 ;; scope of the parsed data. They come from five sources, in
1244 ;; increasing precedence order:
1245 ;;
1246 ;; - Global variables,
1247 ;; - Buffer's attributes,
1248 ;; - Options keyword symbols,
1249 ;; - Buffer keywords,
1250 ;; - Subtree properties.
1251 ;;
1252 ;; The central internal function with regards to environment options
1253 ;; is `org-export-get-environment'. It updates global variables with
1254 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1255 ;; the different sources.
1256 ;;
1257 ;; The internal functions doing the retrieval are:
1258 ;; `org-export--get-global-options',
1259 ;; `org-export--get-buffer-attributes',
1260 ;; `org-export--parse-option-keyword',
1261 ;; `org-export--get-subtree-options' and
1262 ;; `org-export--get-inbuffer-options'
1263 ;;
1264 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1265 ;; take care of the part relative to "#+BIND:" keywords.
1268 "Collect export options from the current buffer.
1270 Optional argument BACKEND is a symbol specifying which back-end
1271 specific options to read, if any.
1273 When optional argument SUBTREEP is non-nil, assume the export is
1274 done against the current sub-tree.
1276 Third optional argument EXT-PLIST is a property list with
1277 external parameters overriding Org default settings, but still
1278 inferior to file-local settings."
1279 ;; First install #+BIND variables.
1281 ;; Get and prioritize export options...
1283 ;; ... from global variables...
1285 ;; ... from buffer's attributes...
1287 ;; ... from an external property list...
1288 ext-plist
1289 ;; ... from in-buffer settings...
1291 backend
1293 ;; ... and from subtree, when appropriate.
1295 ;; Eventually install back-end symbol and its translation table.
1296 `(:back-end
1297 ,backend
1298 :translate-alist
1303 "Parse an OPTIONS line and return values as a plist.
1304 Optional argument BACKEND is a symbol specifying which back-end
1305 specific items to read, if any."
1312 ;; Build an alist between #+OPTION: item and property-name.
1317 all)))
1318 plist)
1323 options)
1328 alist)
1329 plist))
1332 "Get export options in subtree at point.
1333 Optional argument BACKEND is a symbol specifying back-end used
1334 for export. Return options as a plist."
1335 ;; For each buffer keyword, create an headline property setting the
1336 ;; same property in communication channel. The name for the property
1337 ;; is the keyword with "EXPORT_" appended to it.
1340 ;; Make sure point is at an heading.
1342 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1343 ;; title as its fallback value.
1350 plist :title
1353 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1357 ;; Handle other keywords. TITLE keyword is excluded as it has
1358 ;; already been handled already.
1365 ;; Export properties are not case-sensitive.
1372 plist
1374 ;; Parse VALUE if required.
1378 value))))))))
1379 ;; Also look for both general keywords and back-end specific
1380 ;; options if BACKEND is provided.
1385 org-export-options-alist)))
1386 ;; Return value.
1387 plist)))
1390 "Return current buffer export options, as a plist.
1392 Optional argument BACKEND, when non-nil, is a symbol specifying
1393 which back-end specific options should also be read in the
1394 process.
1396 Optional argument FILES is a list of setup files names read so
1397 far, used to avoid circular dependencies.
1399 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1403 ;; 1. Special keywords, as in `org-export-special-keywords'.
1417 ;; Avoid circular dependencies.
1427 ;; 2. Standard options, as in `org-export-options-alist'.
1429 ;; Also look for back-end specific options
1430 ;; if BACKEND is defined.
1436 ;; Build ALIST between keyword name and property name.
1440 all)))
1441 ;; Build regexp matching all keywords associated to export
1442 ;; options. Note: the search is case insensitive.
1456 plist prop
1457 ;; Handle value depending on specified BEHAVIOUR.
1470 ;; Parse keywords specified in
1471 ;; `org-element-document-properties'.
1479 plist prop
1482 org-element-document-properties))
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.
1513 alist))))
1514 alist))
1515 :id-alist
1516 ;; Collect id references.
1527 alist))))
1530 "Return global export options as a plist.
1532 Optional argument BACKEND, if non-nil, is a symbol specifying
1533 which back-end specific export options should also be read in the
1534 process."
1540 ;; Output value.
1541 plist)
1546 plist
1548 ;; Eval default value provided. If keyword is a member
1549 ;; of `org-element-document-properties', parse it as
1550 ;; a secondary string before storing it.
1555 value
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 information 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 babel-call.
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 center block.
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 clock.
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 comment.
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 comment-comment.
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 drawer.
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 dynamic-block.
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 example-block.
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 export-block.
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 fixed-width.
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 footnote-definition.
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 headline.
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 horizontal-rule.
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 inlinetask.
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 item.
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 node-property.
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 plain-list.
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 planning.
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 property-drawer.
2230 Each filter is called with three arguments: the transcoded data,
2231 as a string, the back-end, as a symbol, and the communication
2235 "List of functions applied to a transcoded quote block.
2236 Each filter is called with three arguments: the transcoded quote
2237 data, as a string, the back-end, as a symbol, and the
2238 communication channel, as a plist. It must return a string or
2242 "List of functions applied to a transcoded quote-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 section.
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 special 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 src-block.
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.
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-cell.
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 table-row.
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 "List of functions applied to a transcoded verse block.
2285 Each filter is called with three arguments: the transcoded data,
2286 as a string, the back-end, as a symbol, and the communication
2290 ;;;; Objects Filters
2293 "List of functions applied to transcoded bold 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 transcoded code text.
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 entity.
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 export-snippet.
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 footnote-reference.
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-babel-call.
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 a transcoded inline-src-block.
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 transcoded italic text.
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 latex-fragment.
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 line-break.
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 link.
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 macro.
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 radio-target.
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 a transcoded statistics-cookie.
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 transcoded strike-through text.
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 subscript.
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 superscript.
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 target.
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 a transcoded timestamp.
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 underline 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 "List of functions applied to transcoded verbatim text.
2414 Each filter is called with three arguments: the transcoded data,
2415 as a string, the back-end, as a symbol, and the communication
2419 ;;;; Filters Tools
2420 ;;
2421 ;; Internal function `org-export-install-filters' installs filters
2422 ;; hard-coded in back-ends (developer filters) and filters from global
2423 ;; variables (user filters) in the communication channel.
2424 ;;
2425 ;; Internal function `org-export-filter-apply-functions' takes care
2426 ;; about applying each filter in order to a given data. It ignores
2427 ;; filters returning a nil value but stops whenever a filter returns
2428 ;; an empty string.
2431 "Call every function in FILTERS.
2433 Functions are called with arguments VALUE, current export
2434 back-end and INFO. A function returning a nil value will be
2435 skipped. If it returns the empty string, the process ends and
2436 VALUE is ignored.
2438 Call is done in a LIFO fashion, to be sure that developer
2439 specified filters, if any, are called first."
2448 "Install filters properties in communication channel.
2450 INFO is a plist containing the current communication channel.
2452 Return the updated communication channel."
2454 ;; Install user defined filters with `org-export-filters-alist'.
2457 org-export-filters-alist)
2458 ;; Prepend back-end specific filters to that list.
2463 ;; Single values get consed, lists are prepended.
2468 plist key
2472 ;; Return new communication channel.
2476 \f
2477 ;;; Core functions
2478 ;;
2479 ;; This is the room for the main function, `org-export-as', along with
2480 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2481 ;; They differ only by the way they output the resulting code.
2482 ;;
2483 ;; `org-export-output-file-name' is an auxiliary function meant to be
2484 ;; used with `org-export-to-file'. With a given extension, it tries
2485 ;; to provide a canonical file name to write export output to.
2486 ;;
2487 ;; Note that `org-export-as' doesn't really parse the current buffer,
2488 ;; but a copy of it (with the same buffer-local variables and
2489 ;; visibility), where macros and include keywords are expanded and
2490 ;; Babel blocks are executed, if appropriate.
2491 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2492 ;;
2493 ;; File inclusion is taken care of by
2494 ;; `org-export-expand-include-keyword' and
2495 ;; `org-export--prepare-file-contents'. Structure wise, including
2496 ;; a whole Org file in a buffer often makes little sense. For
2497 ;; example, if the file contains an headline and the include keyword
2498 ;; was within an item, the item should contain the headline. That's
2499 ;; why file inclusion should be done before any structure can be
2500 ;; associated to the file, that is before parsing.
2501 ;;
2502 ;; Macro are expanded with `org-export-expand-macro'.
2506 "Transcode current Org buffer into BACKEND code.
2508 If narrowing is active in the current buffer, only transcode its
2509 narrowed part.
2511 If a region is active, transcode that region.
2513 When optional argument SUBTREEP is non-nil, transcode the
2514 sub-tree at point, extracting information from the headline
2515 properties first.
2517 When optional argument VISIBLE-ONLY is non-nil, don't export
2518 contents of hidden elements.
2520 When optional argument BODY-ONLY is non-nil, only return body
2521 code, without preamble nor postamble.
2523 Optional argument EXT-PLIST, when provided, is a property list
2524 with external parameters overriding Org default settings, but
2525 still inferior to file-local settings.
2527 Optional argument NOEXPAND, when non-nil, prevents included files
2528 to be expanded and Babel code to be executed.
2530 Return code as a string."
2531 ;; Barf if BACKEND isn't registered.
2535 ;; Narrow buffer to an appropriate region or subtree for
2536 ;; parsing. If parsing subtree, be sure to remove main headline
2537 ;; too.
2545 ;; 1. Get export environment from original buffer. Also install
2546 ;; user's and developer's filters.
2549 ;; 2. Get parse tree. Buffer isn't parsed directly.
2550 ;; Instead, a temporary copy is created, where macros
2551 ;; and include keywords are expanded and code blocks
2552 ;; are evaluated.
2559 ;; TODO: Setting `org-current-export-file' is
2560 ;; required by Org Babel to properly resolve
2561 ;; noweb references. Once "org-exp.el" is
2562 ;; removed, modify
2563 ;; `org-export-blocks-preprocess' so it
2564 ;; accepts the value as an argument instead.
2568 ;; Run hook
2569 ;; `org-export-before-parsing-hook'. with current
2570 ;; back-end as argument.
2573 ;; Eventually parse buffer.
2575 ;; 3. Call parse-tree filters to get the final tree.
2579 ;; 4. Now tree is complete, compute its properties and add
2580 ;; them to communication channel.
2584 ;; 5. Eventually transcode TREE. Wrap the resulting string
2585 ;; into a template, if required. Eventually call
2586 ;; final-output filter.
2594 info)))
2595 ;; Maybe add final OUTPUT to kill ring, then return it.
2597 output)))))
2601 "Call `org-export-as' with output to a specified buffer.
2603 BACKEND is the back-end used for transcoding, as a symbol.
2605 BUFFER is the output buffer. If it already exists, it will be
2606 erased first, otherwise, it will be created.
2608 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2609 and NOEXPAND are similar to those used in `org-export-as', which
2610 see.
2612 Return buffer."
2614 backend subtreep visible-only body-only ext-plist noexpand))
2620 buffer))
2624 "Call `org-export-as' with output to a specified file.
2626 BACKEND is the back-end used for transcoding, as a symbol. FILE
2627 is the name of the output file, as a string.
2629 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2630 and NOEXPAND are similar to those used in `org-export-as', which
2631 see.
2633 Return output file's name."
2634 ;; Checks for FILE permissions. `write-file' would do the same, but
2635 ;; we'd rather avoid needless transcoding of parse tree.
2637 ;; Insert contents to a temporary buffer and write it to FILE.
2639 backend subtreep visible-only body-only ext-plist noexpand)))
2644 ;; Return full path.
2645 file)
2648 "Return output file's name according to buffer specifications.
2650 EXTENSION is a string representing the output file extension,
2651 with the leading dot.
2653 With a non-nil optional argument SUBTREEP, try to determine
2655 of subtree at point.
2657 When optional argument PUB-DIR is set, use it as the publishing
2658 directory.
2660 When optional argument VISIBLE-ONLY is non-nil, don't export
2661 contents of hidden elements.
2663 Return file name as a string, or nil if it couldn't be
2664 determined."
2666 ;; File name may come from EXPORT_FILE_NAME subtree property,
2667 ;; assuming point is at beginning of said sub-tree.
2674 ;; File name may be extracted from buffer's associated
2675 ;; file, if any.
2677 ;; Can't determine file name on our own: Ask user.
2681 "Output file: " pub-dir nil nil nil
2684 ;; Build file name. Enforce EXTENSION over whatever user may have
2685 ;; come up with. PUB-DIR, if defined, always has precedence over
2686 ;; any provided path.
2691 extension))
2697 "Apply BODY in a copy of the current buffer.
2699 The copy preserves local variables and visibility of the original
2700 buffer.
2702 Point is at buffer's beginning when BODY is applied."
2712 ,original-buffer
2717 ov
2727 "Expand every macro in buffer.
2728 INFO is a plist containing export options and buffer properties."
2730 ;; Before expanding macros, install {{{author}}}, {{{date}}},
2731 ;; {{{email}}} and {{{title}}} templates.
2737 ;; EMAIL is not a parsed keyword: store it as-is.
2741 org-macro-templates)))
2744 "Expand every include keyword in buffer.
2745 Optional argument INCLUDED is a list of included file names along
2746 with their line restriction, when appropriate. It is used to
2747 avoid infinite recursion. Optional argument DIR is the current
2748 working directory. It is used to properly resolve relative
2749 paths."
2756 ;; Extract arguments from keyword's value.
2770 ;; Minimal level of included file defaults to the child
2771 ;; level of the current headline, if any, or one. It
2772 ;; only applies is the file is meant to be included as
2773 ;; an Org one.
2781 ;; Remove keyword.
2785 ;; Check if files has already been parsed. Look after
2786 ;; inclusion lines too, as different parts of the same file
2787 ;; can be included too.
2799 ind-str contents ind-str))))
2807 ind-str env contents ind-str))))
2820 "Prepare the contents of FILE for inclusion and return them as a string.
2822 When optional argument LINES is a string specifying a range of
2823 lines, include only those lines.
2825 Optional argument IND, when non-nil, is an integer specifying the
2826 global indentation of returned contents. Since its purpose is to
2827 allow an included file to stay in the same environment it was
2828 created \(i.e. a list item), it doesn't apply past the first
2829 headline encountered.
2831 Optional argument MINLEVEL, when non-nil, is an integer
2832 specifying the level that any top-level headline in the included
2833 file should have."
2849 ;; Remove blank lines at beginning and end of contents. The logic
2850 ;; behind that removal is that blank lines around include keyword
2851 ;; override blank lines in included file.
2860 ;; If IND is set, preserve indentation of include keyword until
2861 ;; the first headline encountered.
2867 ;; Do not move footnote definitions out of column 0.
2873 ;; When MINLEVEL is specified, compute minimal level for headlines
2874 ;; in the file (CUR-MIN), and remove stars to each headline so
2875 ;; that headlines with minimal level have a level of MINLEVEL.
2884 ;; Only change stars, don't bother moving whole
2885 ;; sections.
2891 \f
2892 ;;; Tools For Back-Ends
2893 ;;
2894 ;; A whole set of tools is available to help build new exporters. Any
2895 ;; function general enough to have its use across many back-ends
2896 ;; should be added here.
2898 ;;;; For Affiliated Keywords
2899 ;;
2900 ;; `org-export-read-attribute' reads a property from a given element
2901 ;; as a plist. It can be used to normalize affiliated keywords'
2902 ;; syntax.
2903 ;;
2904 ;; Since captions can span over multiple lines and accept dual values,
2905 ;; their internal representation is a bit tricky. Therefore,
2906 ;; `org-export-get-caption' transparently returns a given element's
2907 ;; caption as a secondary string.
2910 "Turn ATTRIBUTE property from ELEMENT into a plist.
2912 When optional argument PROPERTY is non-nil, return the value of
2913 that property within attributes.
2917 properties."
2925 "Return caption from ELEMENT as a secondary string.
2927 When optional argument SHORTP is non-nil, return short caption,
2928 as a secondary string, instead.
2930 Caption lines are separated by a white space."
2938 ;;;; For Export Snippets
2939 ;;
2940 ;; Every export snippet is transmitted to the back-end. Though, the
2941 ;; latter will only retain one type of export-snippet, ignoring
2942 ;; others, based on the former's target back-end. The function
2943 ;; `org-export-snippet-backend' returns that back-end for a given
2944 ;; export-snippet.
2947 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2948 Translation, with `org-export-snippet-translation-alist', is
2949 applied."
2953 back-end))))
2956 ;;;; For Footnotes
2957 ;;
2958 ;; `org-export-collect-footnote-definitions' is a tool to list
2959 ;; actually used footnotes definitions in the whole parse tree, or in
2960 ;; an headline, in order to add footnote listings throughout the
2961 ;; transcoded data.
2962 ;;
2963 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2964 ;; back-ends, when they need to attach the footnote definition only to
2965 ;; the first occurrence of the corresponding label.
2966 ;;
2967 ;; `org-export-get-footnote-definition' and
2968 ;; `org-export-get-footnote-number' provide easier access to
2969 ;; additional information relative to a footnote reference.
2972 "Return an alist between footnote numbers, labels and definitions.
2974 DATA is the parse tree from which definitions are collected.
2975 INFO is the plist used as a communication channel.
2977 Definitions are sorted by order of references. They either
2978 appear as Org data or as a secondary string for inlined
2979 footnotes. Unreferenced definitions are ignored."
2981 collect-fn ; for byte-compiler.
2985 ;; Collect footnote number, label and definition in DATA.
2987 data 'footnote-reference
2994 def)
2995 num-alist)
2996 ;; Also search in definition for nested footnotes.
2999 ;; Don't enter footnote definitions since it will happen
3000 ;; when their first reference is found.
3006 "Non-nil when a footnote reference is the first one for its label.
3008 FOOTNOTE-REFERENCE is the footnote reference being considered.
3009 INFO is the plist used as a communication channel."
3011 ;; Anonymous footnotes are always a first reference.
3013 ;; Otherwise, return the first footnote with the same LABEL and
3014 ;; test if it is equal to FOOTNOTE-REFERENCE.
3020 data 'footnote-reference
3025 ;; If FN isn't inlined, be sure to traverse its
3026 ;; definition before resuming search. See
3027 ;; comments in `org-export-get-footnote-number'
3028 ;; for more information.
3032 ;; Don't enter footnote definitions since it will
3033 ;; happen when their first reference is found.
3036 footnote-reference)))))
3039 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3040 INFO is the plist used as a communication channel."
3046 "Return number associated to a footnote.
3048 FOOTNOTE is either a footnote reference or a footnote definition.
3049 INFO is the plist used as a communication channel."
3051 seen-refs
3052 search-ref ; For byte-compiler.
3056 ;; Search footnote references through DATA, filling
3057 ;; SEEN-REFS along the way.
3059 data 'footnote-reference
3063 ;; Anonymous footnote match: return number.
3066 ;; Labels match: return number.
3069 ;; Anonymous footnote: it's always a new one. Also,
3070 ;; be sure to return nil from the `cond' so
3071 ;; `first-match' doesn't get us out of the loop.
3073 ;; Label not seen so far: add it so SEEN-REFS.
3074 ;;
3075 ;; Also search for subsequent references in
3076 ;; footnote definition so numbering follows reading
3077 ;; logic. Note that we don't have to care about
3078 ;; inline definitions, since `org-element-map'
3079 ;; already traverses them at the right time.
3080 ;;
3081 ;; Once again, return nil to stay in the loop.
3086 nil))))
3087 ;; Don't enter footnote definitions since it will happen
3088 ;; when their first reference is found.
3093 ;;;; For Headlines
3094 ;;
3095 ;; `org-export-get-relative-level' is a shortcut to get headline
3096 ;; level, relatively to the lower headline level in the parsed tree.
3097 ;;
3098 ;; `org-export-get-headline-number' returns the section number of an
3099 ;; headline, while `org-export-number-to-roman' allows to convert it
3100 ;; to roman numbers.
3101 ;;
3102 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3103 ;; `org-export-last-sibling-p' are three useful predicates when it
3104 ;; comes to fulfill the `:headline-levels' property.
3107 "Return HEADLINE relative level within current parsed tree.
3108 INFO is a plist holding contextual information."
3113 "Non-nil when HEADLINE is considered as low level.
3115 INFO is a plist used as a communication channel.
3117 A low level headlines has a relative level greater than
3118 `:headline-levels' property value.
3120 Return value is the difference between HEADLINE relative level
3121 and the last level being considered as high enough, or nil."
3128 "Return HEADLINE numbering as a list of numbers.
3129 INFO is a plist holding contextual information."
3133 "Return a non-nil value if HEADLINE element should be numbered.
3134 INFO is a plist used as a communication channel."
3140 "Convert integer N into a roman numeral."
3153 res)))
3156 "Return list of tags associated to ELEMENT.
3158 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3159 is a plist used as a communication channel.
3161 Select tags (see `org-export-select-tags') and exclude tags (see
3162 `org-export-exclude-tags') are removed from the list.
3164 When non-nil, optional argument TAGS should be a list of strings.
3165 Any tag belonging to this list will also be removed."
3172 "Return node PROPERTY value for BLOB.
3174 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3175 element or object.
3177 If optional argument INHERITED is non-nil, the value can be
3178 inherited from a parent headline.
3180 Return value is a string or nil."
3192 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3193 INFO is a plist used as a communication channel."
3198 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3199 INFO is a plist used as a communication channel."
3203 ;;;; For Links
3204 ;;
3205 ;; `org-export-solidify-link-text' turns a string into a safer version
3206 ;; for links, replacing most non-standard characters with hyphens.
3207 ;;
3208 ;; `org-export-get-coderef-format' returns an appropriate format
3209 ;; string for coderefs.
3210 ;;
3211 ;; `org-export-inline-image-p' returns a non-nil value when the link
3212 ;; provided should be considered as an inline image.
3213 ;;
3214 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3215 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3216 ;; returns an appropriate unique identifier when found, or nil.
3217 ;;
3218 ;; `org-export-resolve-id-link' returns the first headline with
3219 ;; specified id or custom-id in parse tree, the path to the external
3220 ;; file with the id or nil when neither was found.
3221 ;;
3222 ;; `org-export-resolve-coderef' associates a reference to a line
3223 ;; number in the element it belongs, or returns the reference itself
3224 ;; when the element isn't numbered.
3227 "Take link text S and make a safe target out of it."
3232 "Return format string for code reference link.
3233 PATH is the link path. DESC is its description."
3241 "Non-nil if LINK object points to an inline image.
3243 Optional argument is a set of RULES defining inline images. It
3244 is an alist where associations have the following shape:
3246 \(TYPE . REGEXP)
3248 Applying a rule means apply REGEXP against LINK's path when its
3249 type is TYPE. The function will return a non-nil value if any of
3250 the provided rules is non-nil. The default rule is
3251 `org-export-default-inline-image-rule'.
3253 This only applies to links without a description."
3264 rules)
3265 ;; Return nil if no rule matched.
3266 nil))))
3269 "Resolve a code reference REF.
3271 INFO is a plist used as a communication channel.
3273 Return associated line number in source code, or REF itself,
3274 depending on src-block or example element's switches."
3282 org-coderef-label-format)))
3286 ;; Element containing REF is found. Resolve it to either
3287 ;; a label or a line number, as needed.
3297 "Return LINK destination.
3299 INFO is a plist holding contextual information.
3301 Return value can be an object, an element, or nil:
3303 - If LINK path matches a target object (i.e. <<path>>) or
3306 - If LINK path exactly matches the name affiliated keyword
3307 \(i.e. #+NAME: path) of an element, return that element.
3309 - If LINK path exactly matches any headline name, return that
3310 element. If more than one headline share that name, priority
3311 will be given to the one with the closest common ancestor, if
3312 any, or the first one in the parse tree otherwise.
3314 - Otherwise, return nil.
3320 ;; First try to find a matching "<<path>>" unless user specified
3321 ;; he was looking for an headline (path starts with a *
3322 ;; character).
3326 return target)))
3327 ;; Then try to find an element with a matching "#+NAME: path"
3328 ;; affiliated keyword.
3335 ;; Last case: link either points to an headline or to
3336 ;; nothingness. Try to find the source, with priority given to
3337 ;; headlines with the closest common ancestor. If such candidate
3338 ;; is found, return it, otherwise return nil.
3342 ;; Return first headline whose `:raw-value' property
3343 ;; is NAME in parse tree DATA, or nil.
3346 data 'headline
3350 name)
3351 headline))
3353 ;; Search among headlines sharing an ancestor with link,
3354 ;; from closest to farthest.
3362 ;; No match with a common ancestor: try the full parse-tree.
3368 "Return headline referenced as LINK destination.
3370 INFO is a plist used as a communication channel.
3372 Return value can be the headline element matched in current parse
3376 ;; First check if id is within the current parse tree.
3382 headline))
3384 ;; Otherwise, look for external files.
3388 "Return radio-target object referenced as LINK destination.
3390 INFO is a plist used as a communication channel.
3392 Return value can be a radio-target object or nil. Assume LINK
3402 ;;;; For References
3403 ;;
3404 ;; `org-export-get-ordinal' associates a sequence number to any object
3405 ;; or element.
3408 "Return ordinal number of an element or object.
3410 ELEMENT is the element or object considered. INFO is the plist
3411 used as a communication channel.
3413 Optional argument TYPES, when non-nil, is a list of element or
3414 object types, as symbols, that should also be counted in.
3415 Otherwise, only provided element's type is considered.
3417 Optional argument PREDICATE is a function returning a non-nil
3418 value if the current element or object should be counted in. It
3419 accepts two arguments: the element or object being considered and
3420 the plist used as a communication channel. This allows to count
3421 only a certain type of objects (i.e. inline images).
3423 Return value is a list of numbers if ELEMENT is an headline or an
3424 item. It is nil for keywords. It represents the footnote number
3425 for footnote definitions and footnote references. If ELEMENT is
3426 a target, return the same value as if ELEMENT was the closest
3427 table, item or headline containing the target. In any other
3428 case, return the sequence number of ELEMENT among elements or
3429 objects of the same type."
3430 ;; A target keyword, representing an invisible target, never has
3431 ;; a sequence number.
3433 ;; Ordinal of a target object refer to the ordinal of the closest
3434 ;; table, item, or headline containing the object.
3438 when
3442 table))
3443 return parent)))
3445 ;; Special case 1: An headline returns its number as a list.
3447 ;; Special case 2: An item returns its number as a list.
3451 struct
3458 ;; Increment counter until ELEMENT is found again.
3469 ;;;; For Src-Blocks
3470 ;;
3471 ;; `org-export-get-loc' counts number of code lines accumulated in
3472 ;; src-block or example-block elements with a "+n" switch until
3473 ;; a given element, excluded. Note: "-n" switches reset that count.
3474 ;;
3475 ;; `org-export-unravel-code' extracts source code (along with a code
3476 ;; references alist) from an `element-block' or `src-block' type
3477 ;; element.
3478 ;;
3479 ;; `org-export-format-code' applies a formatting function to each line
3480 ;; of code, providing relative line number and code reference when
3481 ;; appropriate. Since it doesn't access the original element from
3482 ;; which the source code is coming, it expects from the code calling
3483 ;; it to know if lines should be numbered and if code references
3484 ;; should appear.
3485 ;;
3486 ;; Eventually, `org-export-format-code-default' is a higher-level
3487 ;; function (it makes use of the two previous functions) which handles
3488 ;; line numbering and code references inclusion, and returns source
3489 ;; code in a format suitable for plain text or verbatim output.
3492 "Return accumulated lines of code up to ELEMENT.
3494 INFO is the plist used as a communication channel.
3496 ELEMENT is excluded from count."
3503 ;; ELEMENT is reached: Quit the loop.
3505 ;; Only count lines from src-block and example-block elements
3506 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3510 ;; Accumulate locs or reset them.
3514 ;; Return nil to stay in the loop.
3515 nil)))
3517 ;; Return value.
3518 loc))
3521 "Clean source code and extract references out of it.
3523 ELEMENT has either a `src-block' an `example-block' type.
3525 Return a cons cell whose CAR is the source code, cleaned from any
3526 reference and protective comma and CDR is an alist between
3527 relative line number (integer) and name of code reference on that
3528 line (string)."
3530 ;; Get code and clean it. Remove blank lines at its
3531 ;; beginning and end.
3537 ;; If appropriate, remove global indentation.
3540 c
3542 ;; Get format used for references.
3545 org-coderef-label-format)))
3546 ;; Build a regexp matching a loc with a reference.
3551 ;; Return value.
3553 ;; Code with references removed.
3559 ;; Ref line: remove ref, and signal its position in REFS.
3563 ;; Reference alist.
3564 refs)))
3567 "Format CODE by applying FUN line-wise and return it.
3569 CODE is a string representing the code to format. FUN is
3570 a function. It must accept three arguments: a line of
3571 code (string), the current line number (integer) or nil and the
3572 reference associated to the current line (string) or nil.
3574 Optional argument NUM-LINES can be an integer representing the
3575 number of code lines accumulated until the current code. Line
3576 numbers passed to FUN will take it into account. If it is nil,
3577 FUN's second argument will always be nil. This number can be
3578 obtained with `org-export-get-loc' function.
3580 Optional argument REF-ALIST can be an alist between relative line
3581 number (i.e. ignoring NUM-LINES) and the name of the code
3582 reference on it. If it is nil, FUN's third argument will always
3583 be nil. It can be obtained through the use of
3584 `org-export-unravel-code' function."
3596 "Return source code from ELEMENT, formatted in a standard way.
3598 ELEMENT is either a `src-block' or `example-block' element. INFO
3599 is a plist used as a communication channel.
3601 This function takes care of line numbering and code references
3602 inclusion. Line numbers, when applicable, appear at the
3603 beginning of the line, separated from the code by two white
3604 spaces. Code references, on the other hand, appear flushed to
3605 the right, separated by six white spaces from the widest line of
3606 code."
3607 ;; Extract code and references.
3613 ;; Handle line numbering.
3622 ;; Prepare references display, if required. Any reference
3623 ;; should start six columns after the widest line of code,
3624 ;; wrapped with parenthesis.
3629 code
3633 number-str
3634 loc
3640 num-start refs)))
3643 ;;;; For Tables
3644 ;;
3645 ;; `org-export-table-has-special-column-p' and and
3646 ;; `org-export-table-row-is-special-p' are predicates used to look for
3647 ;; meta-information about the table structure.
3648 ;;
3649 ;; `org-table-has-header-p' tells when the rows before the first rule
3650 ;; should be considered as table's header.
3651 ;;
3652 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3653 ;; and `org-export-table-cell-borders' extract information from
3654 ;; a table-cell element.
3655 ;;
3656 ;; `org-export-table-dimensions' gives the number on rows and columns
3657 ;; in the table, ignoring horizontal rules and special columns.
3658 ;; `org-export-table-cell-address', given a table-cell object, returns
3659 ;; the absolute address of a cell. On the other hand,
3660 ;; `org-export-get-table-cell-at' does the contrary.
3661 ;;
3662 ;; `org-export-table-cell-starts-colgroup-p',
3663 ;; `org-export-table-cell-ends-colgroup-p',
3664 ;; `org-export-table-row-starts-rowgroup-p',
3665 ;; `org-export-table-row-ends-rowgroup-p',
3666 ;; `org-export-table-row-starts-header-p' and
3667 ;; `org-export-table-row-ends-header-p' indicate position of current
3668 ;; row or cell within the table.
3671 "Non-nil when TABLE has a special column.
3672 All special columns will be ignored during export."
3673 ;; The table has a special column when every first cell of every row
3674 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3675 ;; "*" "_" and "^". Though, do not consider a first row containing
3676 ;; only empty cells as special.
3692 "Non-nil when TABLE has an header.
3694 INFO is a plist used as a communication channel.
3696 A table has an header when it contains at least two row groups."
3699 table 'table-row
3707 info)))
3710 "Non-nil if TABLE-ROW is considered special.
3712 INFO is a plist used as the communication channel.
3714 All special rows will be ignored during export."
3718 ;; A row is special either when...
3720 ;; ... it starts with a field only containing "/",
3722 ;; ... the table contains a special column and the row start
3723 ;; with a marking character among, "^", "_", "$" or "!",
3727 ;; ... it contains only alignment cookies and empty cells.
3733 ;; Since VALUE is a secondary string, the following
3734 ;; checks avoid expanding it with `org-export-data'.
3746 "Return TABLE-ROW's group.
3748 INFO is a plist used as the communication channel.
3750 Return value is the group number, as an integer, or nil special
3751 rows and table rules. Group 1 is also table's header."
3768 "Return TABLE-CELL contents width.
3770 INFO is a plist used as the communication channel.
3772 Return value is the width given by the last width cookie in the
3773 same column as TABLE-CELL, or nil."
3778 cookie-width)
3782 ;; In a special row, try to find a width cookie at COLUMN.
3786 ;; The following checks avoid expanding unnecessarily the
3787 ;; cell with `org-export-data'
3795 ;; Ignore table rules.
3798 ;; Return value.
3799 cookie-width))
3802 "Return TABLE-CELL contents alignment.
3804 INFO is a plist used as the communication channel.
3806 Return alignment as specified by the last alignment cookie in the
3807 same column as TABLE-CELL. If no such cookie is found, a default
3808 alignment value will be deduced from fraction of numbers in the
3809 column (see `org-table-number-fraction' for more information).
3810 Possible values are `left', `right' and `center'."
3817 cookie-align)
3821 ;; In a special row, try to find an alignment cookie at
3822 ;; COLUMN.
3826 ;; Since VALUE is a secondary string, the following checks
3827 ;; avoid useless expansion through `org-export-data'.
3835 ;; Ignore table rules.
3837 ;; In a standard row, check if cell's contents are expressing
3838 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3839 ;; Though, don't bother if an alignment cookie has already
3840 ;; defined cell's alignment.
3845 info)))
3850 ;; Return value. Alignment specified by cookies has precedence
3851 ;; over alignment deduced from cells contents.
3860 "Return TABLE-CELL borders.
3862 INFO is a plist used as a communication channel.
3864 Return value is a list of symbols, or nil. Possible values are:
3865 `top', `bottom', `above', `below', `left' and `right'. Note:
3866 `top' (resp. `bottom') only happen for a cell in the first
3867 row (resp. last row) of the table, ignoring table rules, if any.
3869 Returned borders ignore special rows."
3872 borders)
3873 ;; Top/above border? TABLE-CELL has a border above when a rule
3874 ;; used to demarcate row groups can be found above. Hence,
3875 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3876 ;; another regular row has to be found above that rule.
3885 ;; Look at every row before the current one.
3887 ;; No rule above, or rule found starts the table (ignoring any
3888 ;; special row): TABLE-CELL is at the top of the table.
3891 ;; Bottom/below border? TABLE-CELL has a border below when next
3892 ;; non-regular row below is a rule.
3901 ;; Look at every row after the current one.
3903 ;; No rule below, or rule found ends the table (modulo some
3904 ;; special row): TABLE-CELL is at the bottom of the table.
3907 ;; Right/left borders? They can only be specified by column
3908 ;; groups. Column groups are defined in a row starting with "/".
3909 ;; Also a column groups row only contains "<", "<>", ">" or blank
3910 ;; cells.
3927 ;; There's a left border when previous cell, if
3928 ;; any, ends a group, or current one starts one.
3934 ;; There's a right border when next cell, if any,
3935 ;; starts a group, or current one ends one.
3942 ;; Table rows are read in reverse order so last column groups
3943 ;; row has precedence over any previous one.
3945 ;; Return value.
3946 borders))
3949 "Non-nil when TABLE-CELL is at the beginning of a row group.
3950 INFO is a plist used as a communication channel."
3951 ;; A cell starts a column group either when it is at the beginning
3952 ;; of a row (or after the special column, if any) or when it has
3953 ;; a left border.
3957 table-cell)
3961 "Non-nil when TABLE-CELL is at the end of a row group.
3962 INFO is a plist used as a communication channel."
3963 ;; A cell ends a column group either when it is at the end of a row
3964 ;; or when it has a right border.
3967 table-cell)
3971 "Non-nil when TABLE-ROW is at the beginning of a column group.
3972 INFO is a plist used as a communication channel."
3980 "Non-nil when TABLE-ROW is at the end of a column group.
3981 INFO is a plist used as a communication channel."
3989 "Non-nil when TABLE-ROW is the first table header's row.
3990 INFO is a plist used as a communication channel."
3997 "Non-nil when TABLE-ROW is the last table header's row.
3998 INFO is a plist used as a communication channel."
4005 "Return TABLE dimensions.
4007 INFO is a plist used as a communication channel.
4009 Return value is a CONS like (ROWS . COLUMNS) where
4010 ROWS (resp. COLUMNS) is the number of exportable
4011 rows (resp. columns)."
4013 ;; Set number of rows, and extract first one.
4015 table 'table-row
4020 ;; Set number of columns.
4022 ;; Return value.
4026 "Return address of a regular TABLE-CELL object.
4028 TABLE-CELL is the cell considered. INFO is a plist used as
4029 a communication channel.
4031 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4032 zero-based index. Only exportable cells are considered. The
4033 function returns nil for other cells."
4036 ;; Ignore cells in special rows or in special column.
4041 ;; Row number.
4044 table 'table-row
4050 ;; Column number.
4053 table-row 'table-cell
4059 "Return regular table-cell object at ADDRESS in TABLE.
4061 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4062 zero-based index. TABLE is a table type element. INFO is
4063 a plist used as a communication channel.
4065 If no table-cell, among exportable cells, is found at ADDRESS,
4066 return nil."
4069 ;; Row at (car address) or nil.
4072 table 'table-row
4078 'table-cell
4085 ;;;; For Tables Of Contents
4086 ;;
4087 ;; `org-export-collect-headlines' builds a list of all exportable
4088 ;; headline elements, maybe limited to a certain depth. One can then
4089 ;; easily parse it and transcode it.
4090 ;;
4091 ;; Building lists of tables, figures or listings is quite similar.
4092 ;; Once the generic function `org-export-collect-elements' is defined,
4093 ;; `org-export-collect-tables', `org-export-collect-figures' and
4094 ;; `org-export-collect-listings' can be derived from it.
4097 "Collect headlines in order to build a table of contents.
4099 INFO is a plist used as a communication channel.
4101 When optional argument N is an integer, it specifies the depth of
4102 the table of contents. Otherwise, it is set to the value of the
4103 last headline level. See `org-export-headline-levels' for more
4104 information.
4106 Return a list of all exportable headlines as parsed elements."
4110 'headline
4112 ;; Strip contents from HEADLINE.
4115 info))
4118 "Collect referenceable elements of a determined type.
4120 TYPE can be a symbol or a list of symbols specifying element
4121 types to search. Only elements with a caption are collected.
4123 INFO is a plist used as a communication channel.
4125 When non-nil, optional argument PREDICATE is a function accepting
4126 one argument, an element of type TYPE. It returns a non-nil
4127 value when that element should be collected.
4129 Return a list of all elements found, in order of appearance."
4135 element))
4136 info))
4139 "Build a list of tables.
4140 INFO is a plist used as a communication channel.
4142 Return a list of table elements with a caption."
4146 "Build a list of figures.
4148 INFO is a plist used as a communication channel. PREDICATE is
4149 a function which accepts one argument: a paragraph element and
4150 whose return value is non-nil when that element should be
4151 collected.
4153 A figure is a paragraph type element, with a caption, verifying
4155 a vague concept that may depend on back-end.
4157 Return a list of elements recognized as figures."
4161 "Build a list of src blocks.
4163 INFO is a plist used as a communication channel.
4165 Return a list of src-block elements with a caption."
4169 ;;;; Topology
4170 ;;
4171 ;; Here are various functions to retrieve information about the
4172 ;; neighbourhood of a given element or object. Neighbours of interest
4173 ;; are direct parent (`org-export-get-parent'), parent headline
4174 ;; (`org-export-get-parent-headline'), first element containing an
4175 ;; object, (`org-export-get-parent-element'), parent table
4176 ;; (`org-export-get-parent-table'), previous element or object
4177 ;; (`org-export-get-previous-element') and next element or object
4178 ;; (`org-export-get-next-element').
4179 ;;
4180 ;; `org-export-get-genealogy' returns the full genealogy of a given
4181 ;; element or object, from closest parent to full parse tree.
4184 "Return BLOB parent or nil.
4185 BLOB is the element or object considered."
4189 "Return full genealogy relative to a given element or object.
4191 BLOB is the element or object being considered.
4193 Ancestors are returned from closest to farthest, the last one
4194 being the full parse tree."
4201 "Return BLOB parent headline or nil.
4202 BLOB is the element or object being considered."
4206 parent))
4209 "Return first element containing OBJECT or nil.
4210 OBJECT is the object to consider."
4214 parent))
4217 "Return OBJECT parent table or nil.
4218 OBJECT is either a `table-cell' or `table-element' type object."
4222 parent))
4225 "Return previous element or object.
4226 BLOB is an element or object. INFO is a plist used as
4227 a communication channel. Return previous exportable element or
4228 object, a string, or nil."
4238 "Return next element or object.
4239 BLOB is an element or object. INFO is a plist used as
4240 a communication channel. Return next exportable element or
4241 object, a string, or nil."
4247 nil))
4250 ;;;; Translation
4251 ;;
4252 ;; `org-export-translate' translates a string according to language
4253 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4254 ;; variable and a specified charset. `org-export-dictionary' contains
4255 ;; the dictionary used for the translation.
4377 "Dictionary for export engine.
4379 Alist whose CAR is the string to translate and CDR is an alist
4380 whose CAR is the language string and CDR is a plist whose
4381 properties are possible charsets and values translated terms.
4383 It is used as a database for `org-export-translate'. Since this
4384 function returns the string as-is if no translation was found,
4385 the variable only needs to record values different from the
4389 "Translate string S according to language specification.
4391 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4392 and `:utf-8'. INFO is a plist used as a communication channel.
4394 Translation depends on `:language' property. Return the
4395 translated string. If no translation is found, try to fall back
4396 to `:default' encoding. If it fails, return S."
4402 s)))
4405 \f
4406 ;;; The Dispatcher
4407 ;;
4408 ;; `org-export-dispatch' is the standard interactive way to start an
4409 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4410 ;; for its interface, which, in turn, delegates response to key
4411 ;; pressed to `org-export-dispatch-action'.
4414 "List of menu entries available for `org-export-dispatch'.
4415 This variable shouldn't be set directly. Set-up :menu-entry
4416 keyword in either `org-export-define-backend' or
4419 ;;;###autoload
4421 "Export dispatcher for Org mode.
4423 It provides an access to common export related tasks in a buffer.
4424 Its interface comes in two flavours: standard and expert. While
4425 both share the same set of bindings, only the former displays the
4426 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4427 to switch to one or the other.
4429 Return an error if key pressed has no associated command."
4432 nil
4433 org-export-dispatch-use-expert-ui))
4437 ;; First handle special hard-coded actions.
4443 "Publish project: "
4444 org-e-publish-project-alist nil t)
4445 org-e-publish-project-alist)
4455 "Handle interface for `org-export-dispatch'.
4457 OPTIONS is a list containing current interactive options set for
4458 export. It can contain any of the following symbols:
4459 `body' toggles a body-only export
4460 `subtree' restricts export to current subtree
4461 `visible' restricts export to visible part of buffer.
4462 `force' force publishing files.
4464 FIRST-KEY is the key pressed to select the first level menu. It
4465 is nil when this menu hasn't been selected yet.
4467 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4468 buffer is provided, but indications about currently active
4469 options are given in the prompt. Moreover, \[?] allows to switch
4470 back to standard interface."
4473 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4474 ;; non-nil is the required first-level key to activate
4475 ;; KEY. When its value is t, activate KEY independently
4476 ;; on the first key, if any. A nil value means KEY will
4477 ;; only be activated at first level.
4481 ;; Make sure order of menu doesn't depend on the order in
4482 ;; which back-ends are loaded.
4485 ;; Compute a list of allowed keys based on the first key
4486 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4487 ;; always available.
4497 ;; Build the help menu for standard UI.
4501 ;; Options are hard-coded.
4503 [%s] Body only: %s [%s] Visible only: %s
4513 ;; Display registered back-end entries.
4523 ;; Split sub-menu into two columns.
4533 top-key)
4538 ;; Publishing menu is hard-coded.
4540 [%s] Current file [%s] Current project
4550 ;; Build prompts for both standard and expert UI.
4555 "Export command (Options: %s%s%s%s) [%s]: "
4561 ;; With expert UI, just read key with a fancy prompt. In standard
4562 ;; UI, display an intrusive help buffer.
4565 expert-prompt allowed-keys backends options first-key expertp)
4577 standard-prompt allowed-keys backends options first-key expertp))
4583 "Read a character from command input and act accordingly.
4585 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
4586 a list of characters available at a given step in the process.
4587 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
4588 EXPERTP are the same as defined in `org-export-dispatch-ui',
4589 which see.
4591 Toggle export options when required. Otherwise, return value is
4592 a list with action as CAR and a list of interactive export
4593 options as CDR."
4595 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4596 ;; depending on user's key pressed.
4599 ;; Ignore non-standard characters (i.e. "M-a") and
4600 ;; undefined associations.
4603 ;; q key at first level aborts export. At second
4604 ;; level, cancel first key instead.
4607 ;; Help key: Switch back to standard interface if
4608 ;; expert UI was active.
4610 ;; Toggle export options.
4617 first-key expertp))
4618 ;; Action selected: Send key and options back to
4619 ;; `org-export-dispatch'.
4625 ;; Publishing actions are hard-coded. Send a special
4626 ;; signal to `org-export-dispatch'.
4634 options))
4635 ;; Otherwise, enter sub-menu.
4640 ;;; org-export.el ends here