| blob | b331225d3c95614b29fbf100d4e69c2596933719 |
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
679 be passed the FORCE argument). Also, \[?] allows to switch back
680 to standard mode."
685 \f
686 ;;; Defining New Back-ends
687 ;;
688 ;; `org-export-define-backend' is the standard way to define an export
689 ;; back-end. It allows to specify translators, filters, buffer
690 ;; options and a menu entry. If the new back-end shares translators
691 ;; with another back-end, `org-export-define-derived-backend' may be
692 ;; used instead.
693 ;;
694 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
695 ;; when a given back-end hasn't been registered yet.
698 "Define a new back-end BACKEND.
700 TRANSLATORS is an alist between object or element types and
701 functions handling them.
703 These functions should return a string without any trailing
704 space, or nil. They must accept three arguments: the object or
705 element itself, its contents or nil when it isn't recursive and
706 the property list used as a communication channel.
708 Contents, when not nil, are stripped from any global indentation
709 \(although the relative one is preserved). They also always end
710 with a single newline character.
712 If, for a given type, no function is found, that element or
713 object type will simply be ignored, along with any blank line or
714 white space at its end. The same will happen if the function
715 returns the nil value. If that function returns the empty
716 string, the type will be ignored, but the blank lines or white
717 spaces will be kept.
719 In addition to element and object types, one function can be
720 associated to the `template' symbol and another one to the
721 `plain-text' symbol.
723 The former returns the final transcoded string, and can be used
724 to add a preamble and a postamble to document's body. It must
725 accept two arguments: the transcoded string and the property list
726 containing export options.
728 The latter, when defined, is to be called on every text not
729 recognized as an element or an object. It must accept two
730 arguments: the text string and the information channel. It is an
731 appropriate place to protect special chars relative to the
732 back-end.
734 BODY can start with pre-defined keyword arguments. The following
735 keywords are understood:
737 :export-block
739 String, or list of strings, representing block names that
740 will not be parsed. This is used to specify blocks that will
741 contain raw code specific to the back-end. These blocks
742 still have to be handled by the relative `export-block' type
743 translator.
745 :filters-alist
747 Alist between filters and function, or list of functions,
748 specific to the back-end. See `org-export-filters-alist' for
749 a list of all allowed filters. Filters defined here
750 shouldn't make a back-end test, as it may prevent back-ends
751 derived from this one to behave properly.
753 :menu-entry
755 Menu entry for the export dispatcher. It should be a list
756 like:
758 \(KEY DESCRIPTION ACTION-OR-MENU)
760 where :
762 KEY is a free character selecting the back-end.
763 DESCRIPTION is a string naming the back-end.
764 ACTION-OR-MENU is either a function or an alist.
766 If it is an action, it will be called with three arguments:
767 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
768 for further explanations.
770 If it is an alist, associations should follow the
771 pattern:
773 \(KEY DESCRIPTION ACTION)
775 where KEY, DESCRIPTION and ACTION are described above.
777 Valid values include:
781 or
788 \(lambda (subtree visible body-only)
789 \(org-open-file
790 \(org-e-latex-export-to-pdf subtree visible body-only))))))
792 :options-alist
794 Alist between back-end specific properties introduced in
795 communication channel and how their value are acquired. See
796 `org-export-options-alist' for more information about
797 structure of the values."
812 ;; Define translators.
815 ;; Define options.
819 See `org-export-options-alist' for more information on the
820 structure of the values."
821 backend)))
822 ;; Define filters.
825 "Alist between filters keywords and back-end specific filters.
827 ;; Tell parser to not parse EXPORT-BLOCK blocks.
834 ;; 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'.
972 org-export-dispatch-menu-entries))))
976 ;; Splice in the body, if any.
980 "Signal an error if BACKEND isn't defined."
985 \f
986 ;;; The Communication Channel
987 ;;
988 ;; During export process, every function has access to a number of
989 ;; properties. They are of two types:
990 ;;
991 ;; 1. Environment options are collected once at the very beginning of
992 ;; the process, out of the original buffer and configuration.
993 ;; Collecting them is handled by `org-export-get-environment'
994 ;; function.
995 ;;
996 ;; Most environment options are defined through the
997 ;; `org-export-options-alist' variable.
998 ;;
999 ;; 2. Tree properties are extracted directly from the parsed tree,
1000 ;; just before export, by `org-export-collect-tree-properties'.
1001 ;;
1002 ;; Here is the full list of properties available during transcode
1003 ;; process, with their category and their value type.
1004 ;;
1005 ;; + `:author' :: Author's name.
1006 ;; - category :: option
1007 ;; - type :: string
1008 ;;
1009 ;; + `:back-end' :: Current back-end used for transcoding.
1010 ;; - category :: tree
1011 ;; - type :: symbol
1012 ;;
1013 ;; + `:creator' :: String to write as creation information.
1014 ;; - category :: option
1015 ;; - type :: string
1016 ;;
1017 ;; + `:date' :: String to use as date.
1018 ;; - category :: option
1019 ;; - type :: string
1020 ;;
1021 ;; + `:description' :: Description text for the current data.
1022 ;; - category :: option
1023 ;; - type :: string
1024 ;;
1025 ;; + `:email' :: Author's email.
1026 ;; - category :: option
1027 ;; - type :: string
1028 ;;
1029 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1030 ;; process.
1031 ;; - category :: option
1032 ;; - type :: list of strings
1033 ;;
1034 ;; + `:exported-data' :: Hash table used for memoizing
1035 ;; `org-export-data'.
1036 ;; - category :: tree
1037 ;; - type :: hash table
1038 ;;
1039 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1040 ;; their definition, as parsed data. Only non-inlined footnotes
1041 ;; are represented in this alist. Also, every definition isn't
1042 ;; guaranteed to be referenced in the parse tree. The purpose of
1043 ;; this property is to preserve definitions from oblivion
1044 ;; (i.e. when the parse tree comes from a part of the original
1045 ;; buffer), it isn't meant for direct use in a back-end. To
1046 ;; retrieve a definition relative to a reference, use
1047 ;; `org-export-get-footnote-definition' instead.
1048 ;; - category :: option
1049 ;; - type :: alist (STRING . LIST)
1050 ;;
1051 ;; + `:headline-levels' :: Maximum level being exported as an
1052 ;; headline. Comparison is done with the relative level of
1053 ;; headlines in the parse tree, not necessarily with their
1054 ;; actual level.
1055 ;; - category :: option
1056 ;; - type :: integer
1057 ;;
1058 ;; + `:headline-offset' :: Difference between relative and real level
1059 ;; of headlines in the parse tree. For example, a value of -1
1060 ;; means a level 2 headline should be considered as level
1061 ;; 1 (cf. `org-export-get-relative-level').
1062 ;; - category :: tree
1063 ;; - type :: integer
1064 ;;
1065 ;; + `:headline-numbering' :: Alist between headlines and their
1066 ;; numbering, as a list of numbers
1067 ;; (cf. `org-export-get-headline-number').
1068 ;; - category :: tree
1069 ;; - type :: alist (INTEGER . LIST)
1070 ;;
1071 ;; + `:id-alist' :: Alist between ID strings and destination file's
1072 ;; path, relative to current directory. It is used by
1073 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1074 ;; external file.
1075 ;; - category :: option
1076 ;; - type :: alist (STRING . STRING)
1077 ;;
1078 ;; + `:ignore-list' :: List of elements and objects that should be
1079 ;; ignored during export.
1080 ;; - category :: tree
1081 ;; - type :: list of elements and objects
1082 ;;
1083 ;; + `:input-file' :: Full path to input file, if any.
1084 ;; - category :: option
1085 ;; - type :: string or nil
1086 ;;
1087 ;; + `:keywords' :: List of keywords attached to data.
1088 ;; - category :: option
1089 ;; - type :: string
1090 ;;
1091 ;; + `:language' :: Default language used for translations.
1092 ;; - category :: option
1093 ;; - type :: string
1094 ;;
1095 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1096 ;; transcoding.
1097 ;; - category :: option
1098 ;; - type :: list (as returned by `org-element-parse-buffer')
1099 ;;
1100 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1101 ;; all line breaks.
1102 ;; - category :: option
1103 ;; - type :: symbol (nil, t)
1104 ;;
1105 ;; + `:section-numbers' :: Non-nil means transcoding should add
1106 ;; section numbers to headlines.
1107 ;; - category :: option
1108 ;; - type :: symbol (nil, t)
1109 ;;
1110 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1111 ;; in transcoding. When such a tag is present, subtrees without
1112 ;; it are de facto excluded from the process. See
1113 ;; `use-select-tags'.
1114 ;; - category :: option
1115 ;; - type :: list of strings
1116 ;;
1117 ;; + `:target-list' :: List of targets encountered in the parse tree.
1118 ;; This is used to partly resolve "fuzzy" links
1119 ;; (cf. `org-export-resolve-fuzzy-link').
1120 ;; - category :: tree
1121 ;; - type :: list of strings
1122 ;;
1123 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1124 ;; a time stamp in the output.
1125 ;; - category :: option
1126 ;; - type :: symbol (nil, t)
1127 ;;
1128 ;; + `:translate-alist' :: Alist between element and object types and
1129 ;; transcoding functions relative to the current back-end.
1130 ;; Special keys `template' and `plain-text' are also possible.
1131 ;; - category :: option
1132 ;; - type :: alist (SYMBOL . FUNCTION)
1133 ;;
1134 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1135 ;; also be transcoded. If it is set to the `headline' symbol,
1136 ;; only the archived headline's name is retained.
1137 ;; - category :: option
1138 ;; - type :: symbol (nil, t, `headline')
1139 ;;
1140 ;; + `:with-author' :: Non-nil means author's name should be included
1141 ;; in the output.
1142 ;; - category :: option
1143 ;; - type :: symbol (nil, t)
1144 ;;
1145 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
1146 ;; - category :: option
1147 ;; - type :: symbol (nil, t)
1148 ;;
1149 ;; + `:with-creator' :: Non-nild means a creation sentence should be
1150 ;; inserted at the end of the transcoded string. If the value
1151 ;; is `comment', it should be commented.
1152 ;; - category :: option
1153 ;; - type :: symbol (`comment', nil, t)
1154 ;;
1155 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1156 ;; its value is a list of names, only drawers with such names
1157 ;; will be transcoded.
1158 ;; - category :: option
1159 ;; - type :: symbol (nil, t) or list of strings
1160 ;;
1161 ;; + `:with-email' :: Non-nil means output should contain author's
1162 ;; email.
1163 ;; - category :: option
1164 ;; - type :: symbol (nil, t)
1165 ;;
1166 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1167 ;; interpreted.
1168 ;; - category :: option
1169 ;; - type :: symbol (nil, t)
1170 ;;
1171 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1172 ;; strings starting with a colon as a fixed-with (verbatim) area.
1173 ;; - category :: option
1174 ;; - type :: symbol (nil, t)
1175 ;;
1176 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1177 ;; footnotes.
1178 ;; - category :: option
1179 ;; - type :: symbol (nil, t)
1180 ;;
1181 ;; + `:with-plannings' :: Non-nil means transcoding should include
1182 ;; planning info.
1183 ;; - category :: option
1184 ;; - type :: symbol (nil, t)
1185 ;;
1186 ;; + `:with-priority' :: Non-nil means transcoding should include
1187 ;; priority cookies.
1188 ;; - category :: option
1189 ;; - type :: symbol (nil, t)
1190 ;;
1191 ;; + `:with-special-strings' :: Non-nil means transcoding should
1192 ;; interpret special strings in plain text.
1193 ;; - category :: option
1194 ;; - type :: symbol (nil, t)
1195 ;;
1196 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1197 ;; interpret subscript and superscript. With a value of "{}",
1198 ;; only interpret those using curly brackets.
1199 ;; - category :: option
1200 ;; - type :: symbol (nil, {}, t)
1201 ;;
1202 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1203 ;; tables.
1204 ;; - category :: option
1205 ;; - type :: symbol (nil, t)
1206 ;;
1207 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1208 ;; headlines. A `not-in-toc' value will remove them from the
1209 ;; table of contents, if any, nonetheless.
1210 ;; - category :: option
1211 ;; - type :: symbol (nil, t, `not-in-toc')
1212 ;;
1213 ;; + `:with-tasks' :: Non-nil means transcoding should include
1214 ;; headlines with a TODO keyword. A `todo' value will only
1215 ;; include headlines with a todo type keyword while a `done'
1216 ;; value will do the contrary. If a list of strings is provided,
1217 ;; only tasks with keywords belonging to that list will be kept.
1218 ;; - category :: option
1219 ;; - type :: symbol (t, todo, done, nil) or list of strings
1220 ;;
1221 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1222 ;; time stamps. Special value `active' (resp. `inactive') ask to
1223 ;; export only active (resp. inactive) timestamps. Otherwise,
1224 ;; completely remove them.
1225 ;; - category :: option
1226 ;; - type :: symbol: (`active', `inactive', t, nil)
1227 ;;
1228 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1229 ;; added to the output. An integer value limits its depth.
1230 ;; - category :: option
1231 ;; - type :: symbol (nil, t or integer)
1232 ;;
1233 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1234 ;; include TODO keywords.
1235 ;; - category :: option
1236 ;; - type :: symbol (nil, t)
1239 ;;;; Environment Options
1240 ;;
1241 ;; Environment options encompass all parameters defined outside the
1242 ;; scope of the parsed data. They come from five sources, in
1243 ;; increasing precedence order:
1244 ;;
1245 ;; - Global variables,
1246 ;; - Buffer's attributes,
1247 ;; - Options keyword symbols,
1248 ;; - Buffer keywords,
1249 ;; - Subtree properties.
1250 ;;
1251 ;; The central internal function with regards to environment options
1252 ;; is `org-export-get-environment'. It updates global variables with
1253 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1254 ;; the different sources.
1255 ;;
1256 ;; The internal functions doing the retrieval are:
1257 ;; `org-export--get-global-options',
1258 ;; `org-export--get-buffer-attributes',
1259 ;; `org-export--parse-option-keyword',
1260 ;; `org-export--get-subtree-options' and
1261 ;; `org-export--get-inbuffer-options'
1262 ;;
1263 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1264 ;; take care of the part relative to "#+BIND:" keywords.
1267 "Collect export options from the current buffer.
1269 Optional argument BACKEND is a symbol specifying which back-end
1270 specific options to read, if any.
1272 When optional argument SUBTREEP is non-nil, assume the export is
1273 done against the current sub-tree.
1275 Third optional argument EXT-PLIST is a property list with
1276 external parameters overriding Org default settings, but still
1277 inferior to file-local settings."
1278 ;; First install #+BIND variables.
1280 ;; Get and prioritize export options...
1282 ;; ... from global variables...
1284 ;; ... from buffer's attributes...
1286 ;; ... from an external property list...
1287 ext-plist
1288 ;; ... from in-buffer settings...
1290 backend
1292 ;; ... and from subtree, when appropriate.
1294 ;; Eventually install back-end symbol and its translation table.
1295 `(:back-end
1296 ,backend
1297 :translate-alist
1302 "Parse an OPTIONS line and return values as a plist.
1303 Optional argument BACKEND is a symbol specifying which back-end
1304 specific items to read, if any."
1311 ;; Build an alist between #+OPTION: item and property-name.
1316 all)))
1317 plist)
1322 options)
1327 alist)
1328 plist))
1331 "Get export options in subtree at point.
1332 Optional argument BACKEND is a symbol specifying back-end used
1333 for export. Return options as a plist."
1334 ;; For each buffer keyword, create an headline property setting the
1335 ;; same property in communication channel. The name for the property
1336 ;; is the keyword with "EXPORT_" appended to it.
1339 ;; Make sure point is at an heading.
1341 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1342 ;; title as its fallback value.
1349 plist :title
1352 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1356 ;; Handle other keywords. TITLE keyword is excluded as it has
1357 ;; already been handled already.
1364 ;; Export properties are not case-sensitive.
1371 plist
1373 ;; Parse VALUE if required.
1377 value))))))))
1378 ;; Also look for both general keywords and back-end specific
1379 ;; options if BACKEND is provided.
1384 org-export-options-alist)))
1385 ;; Return value.
1386 plist)))
1389 "Return current buffer export options, as a plist.
1391 Optional argument BACKEND, when non-nil, is a symbol specifying
1392 which back-end specific options should also be read in the
1393 process.
1395 Optional argument FILES is a list of setup files names read so
1396 far, used to avoid circular dependencies.
1398 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1402 ;; 1. Special keywords, as in `org-export-special-keywords'.
1416 ;; Avoid circular dependencies.
1426 ;; 2. Standard options, as in `org-export-options-alist'.
1428 ;; Also look for back-end specific options
1429 ;; if BACKEND is defined.
1435 ;; Build ALIST between keyword name and property name.
1439 all)))
1440 ;; Build regexp matching all keywords associated to export
1441 ;; options. Note: the search is case insensitive.
1455 plist prop
1456 ;; Handle value depending on specified BEHAVIOUR.
1469 ;; Parse keywords specified in
1470 ;; `org-element-document-properties'.
1478 plist prop
1481 org-element-document-properties))
1482 ;; 3. Return final value.
1483 plist)))
1486 "Return properties related to buffer attributes, as a plist."
1489 ;; Store full path of input file name, or nil. For internal use.
1490 :input-file visited-file
1495 :footnote-definition-alist
1496 ;; Footnotes definitions must be collected in the original
1497 ;; buffer, as there's no insurance that they will still be in the
1498 ;; parse tree, due to possible narrowing.
1512 alist))))
1513 alist))
1514 :id-alist
1515 ;; Collect id references.
1526 alist))))
1529 "Return global export options as a plist.
1531 Optional argument BACKEND, if non-nil, is a symbol specifying
1532 which back-end specific export options should also be read in the
1533 process."
1539 ;; Output value.
1540 plist)
1545 plist
1547 ;; Eval default value provided. If keyword is a member
1548 ;; of `org-element-document-properties', parse it as
1549 ;; a secondary string before storing it.
1554 value
1557 all)
1558 ;; Return value.
1559 plist))
1563 "Can we use #+BIND values during export?
1564 By default this will ask for confirmation by the user, to divert
1565 possible security risks."
1570 org-export--allow-BIND-local)
1575 "Install the values from #+BIND lines as local variables.
1576 Variables must be installed before in-buffer options are
1577 retrieved."
1592 ;;;; Tree Properties
1593 ;;
1594 ;; Tree properties are information extracted from parse tree. They
1595 ;; are initialized at the beginning of the transcoding process by
1596 ;; `org-export-collect-tree-properties'.
1597 ;;
1598 ;; Dedicated functions focus on computing the value of specific tree
1599 ;; properties during initialization. Thus,
1600 ;; `org-export--populate-ignore-list' lists elements and objects that
1601 ;; should be skipped during export, `org-export--get-min-level' gets
1602 ;; the minimal exportable level, used as a basis to compute relative
1603 ;; level for headlines. Eventually
1604 ;; `org-export--collect-headline-numbering' builds an alist between
1605 ;; headlines and their numbering.
1608 "Extract tree properties from parse tree.
1610 DATA is the parse tree from which information is retrieved. INFO
1611 is a list holding export options.
1613 Following tree properties are set or updated:
1615 `:exported-data' Hash table used to memoize results from
1616 `org-export-data'.
1618 `:footnote-definition-alist' List of footnotes definitions in
1619 original buffer and current parse tree.
1621 `:headline-offset' Offset between true level of headlines and
1622 local level. An offset of -1 means an headline
1623 of level 2 should be considered as a level
1624 1 headline in the context.
1626 `:headline-numbering' Alist of all headlines as key an the
1627 associated numbering as value.
1629 `:ignore-list' List of elements that should be ignored during
1630 export.
1632 `:target-list' List of all targets in the parse tree.
1634 Return updated plist."
1635 ;; Install the parse tree in the communication channel, in order to
1636 ;; use `org-export-get-genealogy' and al.
1638 ;; Get the list of elements and objects to ignore, and put it into
1639 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1640 ;; been done during parse tree filtering.
1643 :ignore-list
1646 ;; Compute `:headline-offset' in order to be able to use
1647 ;; `org-export-get-relative-level'.
1650 :headline-offset
1652 ;; Update footnotes definitions list with definitions in parse tree.
1653 ;; This is required since buffer expansion might have modified
1654 ;; boundaries of footnote definitions contained in the parse tree.
1655 ;; This way, definitions in `footnote-definition-alist' are bound to
1656 ;; match those in the parse tree.
1659 data 'footnote-definition
1663 defs)))
1665 ;; Properties order doesn't matter: get the rest of the tree
1666 ;; properties.
1668 `(:target-list
1677 info))
1680 "Return minimum exportable headline's level in DATA.
1681 DATA is parsed tree as returned by `org-element-parse-buffer'.
1682 OPTIONS is a plist holding export options."
1693 ;; If no headline was found, for the sake of consistency, set
1694 ;; minimum level to 1 nonetheless.
1698 "Return numbering of all exportable headlines in a parse tree.
1700 DATA is the parse tree. OPTIONS is the plist holding export
1701 options.
1703 Return an alist whose key is an headline and value is its
1704 associated numbering \(in the shape of a list of numbers\)."
1707 data
1708 'headline
1713 headline
1715 for idx from 0 to org-export-max-depth
1719 options)))
1722 "Return list of elements and objects to ignore during export.
1723 DATA is the parse tree to traverse. OPTIONS is the plist holding
1724 export options."
1726 walk-data
1727 ;; First find trees containing a select tag, if any.
1731 ;; Collect ignored elements or objects into IGNORE-LIST.
1737 ;; If headline is archived but tree below has
1738 ;; to be skipped, add it to ignore list.
1741 ;; Move into secondary string, if any.
1746 ;; Move into recursive objects/elements.
1748 ;; Main call.
1750 ;; Return value.
1751 ignore))
1754 "Return list of headlines containing a select tag in their tree.
1755 DATA is parsed data as returned by `org-element-parse-buffer'.
1756 INFO is a plist holding export options."
1758 walk-data ; for byte-compiler.
1769 ;; When a select tag is found, mark full
1770 ;; genealogy and every headline within the tree
1771 ;; as acceptable.
1774 genealogy
1776 selected-trees))
1777 ;; Else, continue searching in tree, recursively.
1784 "Non-nil when element or object BLOB should be skipped during export.
1785 OPTIONS is the plist holding export options. SELECTED, when
1786 non-nil, is a list of headlines belonging to a tree with a select
1787 tag."
1802 ;; Ignore subtrees with an exclude tag.
1805 ;; When a select tag is present in the buffer, ignore any tree
1806 ;; without it.
1808 ;; Ignore commented sub-trees.
1810 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1812 ;; Ignore tasks, if specified by `:with-tasks' property.
1828 ;; No timestamp allowed.
1830 ;; Only active timestamps allowed and the current one isn't
1831 ;; active.
1835 ;; Only inactive timestamps allowed and the current one isn't
1836 ;; inactive.
1842 \f
1843 ;;; The Transcoder
1844 ;;
1845 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1846 ;; `org-element-parse-buffer') and transcodes it into a specified
1847 ;; back-end output. It takes care of filtering out elements or
1848 ;; objects according to export options and organizing the output blank
1849 ;; lines and white space are preserved. The function memoizes its
1850 ;; results, so it is cheap to call it within translators.
1851 ;;
1852 ;; Internally, three functions handle the filtering of objects and
1853 ;; elements during the export. In particular,
1854 ;; `org-export-ignore-element' marks an element or object so future
1855 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1856 ;; elements or objects should be seen as real Org syntax and
1857 ;; `org-export-expand' transforms the others back into their original
1858 ;; shape
1859 ;;
1860 ;; `org-export-transcoder' is an accessor returning appropriate
1861 ;; translator function for a given element or object.
1864 "Return appropriate transcoder for BLOB.
1865 INFO is a plist containing export directives."
1867 ;; Return contents only for complete parse trees.
1873 "Convert DATA into current back-end format.
1875 DATA is a parse tree, an element or an object or a secondary
1876 string. INFO is a plist holding export options.
1878 Return transcoded string."
1884 ;; Ignored element/object.
1886 ;; Plain text.
1892 info))
1893 ;; Uninterpreted element/object: change it back to Org
1894 ;; syntax and export again resulting raw string.
1898 data
1902 info))
1903 ;; Secondary string.
1906 ;; Element/Object without contents or, as a special case,
1907 ;; headline with archive tag and archived trees restricted
1908 ;; to title only.
1916 ;; Element/Object with contents.
1929 ;; Elements directly containing objects
1930 ;; must have their indentation normalized
1931 ;; first.
1933 data
1934 ;; When normalizing contents of the first
1935 ;; paragraph in an item or a footnote
1936 ;; definition, ignore first line's
1937 ;; indentation: there is none and it
1938 ;; might be misleading.
1943 data)
1950 info))))))))
1951 ;; Final result will be memoized before being returned.
1953 data
1957 ;; Append the same white space between elements or objects as in
1958 ;; the original buffer, and call appropriate filters.
1969 info)))
1970 results)))
1974 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1975 Check is done according to export options INFO, stored as
1976 a plist."
1978 ;; ... entities...
1980 ;; ... emphasis...
1982 ;; ... fixed-width areas.
1984 ;; ... footnotes...
1987 ;; ... sub/superscripts...
1993 ;; ... tables...
1998 "Expand a parsed element or object to its original state.
1999 BLOB is either an element or an object. CONTENTS is its
2000 contents, as a string or nil."
2003 blob contents))
2006 "Add ELEMENT to `:ignore-list' in INFO.
2008 Any element in `:ignore-list' will be skipped when using
2009 `org-element-map'. INFO is modified by side effects."
2013 \f
2014 ;;; The Filter System
2015 ;;
2016 ;; Filters allow end-users to tweak easily the transcoded output.
2017 ;; They are the functional counterpart of hooks, as every filter in
2018 ;; a set is applied to the return value of the previous one.
2019 ;;
2020 ;; Every set is back-end agnostic. Although, a filter is always
2021 ;; called, in addition to the string it applies to, with the back-end
2022 ;; used as argument, so it's easy for the end-user to add back-end
2023 ;; specific filters in the set. The communication channel, as
2024 ;; a plist, is required as the third argument.
2025 ;;
2026 ;; From the developer side, filters sets can be installed in the
2027 ;; process with the help of `org-export-define-backend', which
2028 ;; internally sets `org-BACKEND-filters-alist' variable. Each
2029 ;; association has a key among the following symbols and a function or
2030 ;; a list of functions as value.
2031 ;;
2032 ;; - `:filter-parse-tree' applies directly on the complete parsed
2033 ;; tree. It's the only filters set that doesn't apply to a string.
2034 ;; Users can set it through `org-export-filter-parse-tree-functions'
2035 ;; variable.
2036 ;;
2037 ;; - `:filter-final-output' applies to the final transcoded string.
2038 ;; Users can set it with `org-export-filter-final-output-functions'
2039 ;; variable
2040 ;;
2041 ;; - `:filter-plain-text' applies to any string not recognized as Org
2042 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2043 ;; configure it.
2044 ;;
2045 ;; - `:filter-TYPE' applies on the string returned after an element or
2046 ;; object of type TYPE has been transcoded. An user can modify
2047 ;; `org-export-filter-TYPE-functions'
2048 ;;
2049 ;; All filters sets are applied with
2050 ;; `org-export-filter-apply-functions' function. Filters in a set are
2051 ;; applied in a LIFO fashion. It allows developers to be sure that
2052 ;; their filters will be applied first.
2053 ;;
2054 ;; Filters properties are installed in communication channel with
2055 ;; `org-export-install-filters' function.
2056 ;;
2057 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
2058 ;; before parsing to allow for heavy structure modifications.
2061 ;;;; Before Parsing Hook
2064 "Hook run before parsing an export buffer.
2066 This is run after include keywords have been expanded and Babel
2067 code executed, on a copy of original buffer's area being
2068 exported. Visibility is the same as in the original one. Point
2069 is left at the beginning of the new one.
2071 Every function in this hook will be called with one argument: the
2075 ;;;; Special Filters
2078 "List of functions applied to the parsed tree.
2079 Each filter is called with three arguments: the parse tree, as
2080 returned by `org-element-parse-buffer', the back-end, as
2081 a symbol, and the communication channel, as a plist. It must
2085 "List of functions applied to the transcoded string.
2086 Each filter is called with three arguments: the full transcoded
2087 string, the back-end, as a symbol, and the communication channel,
2088 as a plist. It must return a string that will be used as the
2092 "List of functions applied to plain text.
2093 Each filter is called with three arguments: a string which
2094 contains no Org syntax, the back-end, as a symbol, and the
2095 communication channel, as a plist. It must return a string or
2099 ;;;; Elements Filters
2102 "List of functions applied to a transcoded babel-call.
2103 Each filter is called with three arguments: the transcoded data,
2104 as a string, the back-end, as a symbol, and the communication
2108 "List of functions applied to a transcoded center block.
2109 Each filter is called with three arguments: the transcoded data,
2110 as a string, the back-end, as a symbol, and the communication
2114 "List of functions applied to a transcoded clock.
2115 Each filter is called with three arguments: the transcoded data,
2116 as a string, the back-end, as a symbol, and the communication
2120 "List of functions applied to a transcoded comment.
2121 Each filter is called with three arguments: the transcoded data,
2122 as a string, the back-end, as a symbol, and the communication
2126 "List of functions applied to a transcoded comment-comment.
2127 Each filter is called with three arguments: the transcoded data,
2128 as a string, the back-end, as a symbol, and the communication
2132 "List of functions applied to a transcoded drawer.
2133 Each filter is called with three arguments: the transcoded data,
2134 as a string, the back-end, as a symbol, and the communication
2138 "List of functions applied to a transcoded dynamic-block.
2139 Each filter is called with three arguments: the transcoded data,
2140 as a string, the back-end, as a symbol, and the communication
2144 "List of functions applied to a transcoded example-block.
2145 Each filter is called with three arguments: the transcoded data,
2146 as a string, the back-end, as a symbol, and the communication
2150 "List of functions applied to a transcoded export-block.
2151 Each filter is called with three arguments: the transcoded data,
2152 as a string, the back-end, as a symbol, and the communication
2156 "List of functions applied to a transcoded fixed-width.
2157 Each filter is called with three arguments: the transcoded data,
2158 as a string, the back-end, as a symbol, and the communication
2162 "List of functions applied to a transcoded footnote-definition.
2163 Each filter is called with three arguments: the transcoded data,
2164 as a string, the back-end, as a symbol, and the communication
2168 "List of functions applied to a transcoded headline.
2169 Each filter is called with three arguments: the transcoded data,
2170 as a string, the back-end, as a symbol, and the communication
2174 "List of functions applied to a transcoded horizontal-rule.
2175 Each filter is called with three arguments: the transcoded data,
2176 as a string, the back-end, as a symbol, and the communication
2180 "List of functions applied to a transcoded inlinetask.
2181 Each filter is called with three arguments: the transcoded data,
2182 as a string, the back-end, as a symbol, and the communication
2186 "List of functions applied to a transcoded item.
2187 Each filter is called with three arguments: the transcoded data,
2188 as a string, the back-end, as a symbol, and the communication
2192 "List of functions applied to a transcoded keyword.
2193 Each filter is called with three arguments: the transcoded data,
2194 as a string, the back-end, as a symbol, and the communication
2198 "List of functions applied to a transcoded latex-environment.
2199 Each filter is called with three arguments: the transcoded data,
2200 as a string, the back-end, as a symbol, and the communication
2204 "List of functions applied to a transcoded node-property.
2205 Each filter is called with three arguments: the transcoded data,
2206 as a string, the back-end, as a symbol, and the communication
2210 "List of functions applied to a transcoded paragraph.
2211 Each filter is called with three arguments: the transcoded data,
2212 as a string, the back-end, as a symbol, and the communication
2216 "List of functions applied to a transcoded plain-list.
2217 Each filter is called with three arguments: the transcoded data,
2218 as a string, the back-end, as a symbol, and the communication
2222 "List of functions applied to a transcoded planning.
2223 Each filter is called with three arguments: the transcoded data,
2224 as a string, the back-end, as a symbol, and the communication
2228 "List of functions applied to a transcoded property-drawer.
2229 Each filter is called with three arguments: the transcoded data,
2230 as a string, the back-end, as a symbol, and the communication
2234 "List of functions applied to a transcoded quote block.
2235 Each filter is called with three arguments: the transcoded quote
2236 data, as a string, the back-end, as a symbol, and the
2237 communication channel, as a plist. It must return a string or
2241 "List of functions applied to a transcoded quote-section.
2242 Each filter is called with three arguments: the transcoded data,
2243 as a string, the back-end, as a symbol, and the communication
2247 "List of functions applied to a transcoded section.
2248 Each filter is called with three arguments: the transcoded data,
2249 as a string, the back-end, as a symbol, and the communication
2253 "List of functions applied to a transcoded special block.
2254 Each filter is called with three arguments: the transcoded data,
2255 as a string, the back-end, as a symbol, and the communication
2259 "List of functions applied to a transcoded src-block.
2260 Each filter is called with three arguments: the transcoded data,
2261 as a string, the back-end, as a symbol, and the communication
2265 "List of functions applied to a transcoded table.
2266 Each filter is called with three arguments: the transcoded data,
2267 as a string, the back-end, as a symbol, and the communication
2271 "List of functions applied to a transcoded table-cell.
2272 Each filter is called with three arguments: the transcoded data,
2273 as a string, the back-end, as a symbol, and the communication
2277 "List of functions applied to a transcoded table-row.
2278 Each filter is called with three arguments: the transcoded data,
2279 as a string, the back-end, as a symbol, and the communication
2283 "List of functions applied to a transcoded verse block.
2284 Each filter is called with three arguments: the transcoded data,
2285 as a string, the back-end, as a symbol, and the communication
2289 ;;;; Objects Filters
2292 "List of functions applied to transcoded bold text.
2293 Each filter is called with three arguments: the transcoded data,
2294 as a string, the back-end, as a symbol, and the communication
2298 "List of functions applied to transcoded code text.
2299 Each filter is called with three arguments: the transcoded data,
2300 as a string, the back-end, as a symbol, and the communication
2304 "List of functions applied to a transcoded entity.
2305 Each filter is called with three arguments: the transcoded data,
2306 as a string, the back-end, as a symbol, and the communication
2310 "List of functions applied to a transcoded export-snippet.
2311 Each filter is called with three arguments: the transcoded data,
2312 as a string, the back-end, as a symbol, and the communication
2316 "List of functions applied to a transcoded footnote-reference.
2317 Each filter is called with three arguments: the transcoded data,
2318 as a string, the back-end, as a symbol, and the communication
2322 "List of functions applied to a transcoded inline-babel-call.
2323 Each filter is called with three arguments: the transcoded data,
2324 as a string, the back-end, as a symbol, and the communication
2328 "List of functions applied to a transcoded inline-src-block.
2329 Each filter is called with three arguments: the transcoded data,
2330 as a string, the back-end, as a symbol, and the communication
2334 "List of functions applied to transcoded italic text.
2335 Each filter is called with three arguments: the transcoded data,
2336 as a string, the back-end, as a symbol, and the communication
2340 "List of functions applied to a transcoded latex-fragment.
2341 Each filter is called with three arguments: the transcoded data,
2342 as a string, the back-end, as a symbol, and the communication
2346 "List of functions applied to a transcoded line-break.
2347 Each filter is called with three arguments: the transcoded data,
2348 as a string, the back-end, as a symbol, and the communication
2352 "List of functions applied to a transcoded link.
2353 Each filter is called with three arguments: the transcoded data,
2354 as a string, the back-end, as a symbol, and the communication
2358 "List of functions applied to a transcoded macro.
2359 Each filter is called with three arguments: the transcoded data,
2360 as a string, the back-end, as a symbol, and the communication
2364 "List of functions applied to a transcoded radio-target.
2365 Each filter is called with three arguments: the transcoded data,
2366 as a string, the back-end, as a symbol, and the communication
2370 "List of functions applied to a transcoded statistics-cookie.
2371 Each filter is called with three arguments: the transcoded data,
2372 as a string, the back-end, as a symbol, and the communication
2376 "List of functions applied to transcoded strike-through text.
2377 Each filter is called with three arguments: the transcoded data,
2378 as a string, the back-end, as a symbol, and the communication
2382 "List of functions applied to a transcoded subscript.
2383 Each filter is called with three arguments: the transcoded data,
2384 as a string, the back-end, as a symbol, and the communication
2388 "List of functions applied to a transcoded superscript.
2389 Each filter is called with three arguments: the transcoded data,
2390 as a string, the back-end, as a symbol, and the communication
2394 "List of functions applied to a transcoded target.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2400 "List of functions applied to a transcoded timestamp.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2406 "List of functions applied to transcoded underline text.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2412 "List of functions applied to transcoded verbatim text.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2418 ;;;; Filters Tools
2419 ;;
2420 ;; Internal function `org-export-install-filters' installs filters
2421 ;; hard-coded in back-ends (developer filters) and filters from global
2422 ;; variables (user filters) in the communication channel.
2423 ;;
2424 ;; Internal function `org-export-filter-apply-functions' takes care
2425 ;; about applying each filter in order to a given data. It ignores
2426 ;; filters returning a nil value but stops whenever a filter returns
2427 ;; an empty string.
2430 "Call every function in FILTERS.
2432 Functions are called with arguments VALUE, current export
2433 back-end and INFO. A function returning a nil value will be
2434 skipped. If it returns the empty string, the process ends and
2435 VALUE is ignored.
2437 Call is done in a LIFO fashion, to be sure that developer
2438 specified filters, if any, are called first."
2447 "Install filters properties in communication channel.
2449 INFO is a plist containing the current communication channel.
2451 Return the updated communication channel."
2453 ;; Install user defined filters with `org-export-filters-alist'.
2456 org-export-filters-alist)
2457 ;; Prepend back-end specific filters to that list.
2462 ;; Single values get consed, lists are prepended.
2467 plist key
2471 ;; Return new communication channel.
2475 \f
2476 ;;; Core functions
2477 ;;
2478 ;; This is the room for the main function, `org-export-as', along with
2479 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2480 ;; They differ only by the way they output the resulting code.
2481 ;;
2482 ;; `org-export-output-file-name' is an auxiliary function meant to be
2483 ;; used with `org-export-to-file'. With a given extension, it tries
2484 ;; to provide a canonical file name to write export output to.
2485 ;;
2486 ;; Note that `org-export-as' doesn't really parse the current buffer,
2487 ;; but a copy of it (with the same buffer-local variables and
2488 ;; visibility), where macros and include keywords are expanded and
2489 ;; Babel blocks are executed, if appropriate.
2490 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2491 ;;
2492 ;; File inclusion is taken care of by
2493 ;; `org-export-expand-include-keyword' and
2494 ;; `org-export--prepare-file-contents'. Structure wise, including
2495 ;; a whole Org file in a buffer often makes little sense. For
2496 ;; example, if the file contains an headline and the include keyword
2497 ;; was within an item, the item should contain the headline. That's
2498 ;; why file inclusion should be done before any structure can be
2499 ;; associated to the file, that is before parsing.
2500 ;;
2501 ;; Macro are expanded with `org-export-expand-macro'.
2505 "Transcode current Org buffer into BACKEND code.
2507 If narrowing is active in the current buffer, only transcode its
2508 narrowed part.
2510 If a region is active, transcode that region.
2512 When optional argument SUBTREEP is non-nil, transcode the
2513 sub-tree at point, extracting information from the headline
2514 properties first.
2516 When optional argument VISIBLE-ONLY is non-nil, don't export
2517 contents of hidden elements.
2519 When optional argument BODY-ONLY is non-nil, only return body
2520 code, without preamble nor postamble.
2522 Optional argument EXT-PLIST, when provided, is a property list
2523 with external parameters overriding Org default settings, but
2524 still inferior to file-local settings.
2526 Optional argument NOEXPAND, when non-nil, prevents included files
2527 to be expanded and Babel code to be executed.
2529 Return code as a string."
2530 ;; Barf if BACKEND isn't registered.
2534 ;; Narrow buffer to an appropriate region or subtree for
2535 ;; parsing. If parsing subtree, be sure to remove main headline
2536 ;; too.
2544 ;; 1. Get export environment from original buffer. Also install
2545 ;; user's and developer's filters.
2548 ;; 2. Get parse tree. Buffer isn't parsed directly.
2549 ;; Instead, a temporary copy is created, where include
2550 ;; keywords and macros are expanded and code blocks
2551 ;; are evaluated.
2557 ;; Update radio targets since keyword
2558 ;; inclusion might have added some more.
2561 ;; TODO: Setting `org-current-export-file' is
2562 ;; required by Org Babel to properly resolve
2563 ;; noweb references. Once "org-exp.el" is
2564 ;; removed, modify
2565 ;; `org-export-blocks-preprocess' so it
2566 ;; accepts the value as an argument instead.
2570 ;; Run hook
2571 ;; `org-export-before-parsing-hook'. with current
2572 ;; back-end as argument.
2575 ;; Eventually parse buffer.
2577 ;; 3. Call parse-tree filters to get the final tree.
2581 ;; 4. Now tree is complete, compute its properties and add
2582 ;; them to communication channel.
2586 ;; 5. Eventually transcode TREE. Wrap the resulting string
2587 ;; into a template, if required. Eventually call
2588 ;; final-output filter.
2596 info)))
2597 ;; Maybe add final OUTPUT to kill ring, then return it.
2599 output)))))
2603 "Call `org-export-as' with output to a specified buffer.
2605 BACKEND is the back-end used for transcoding, as a symbol.
2607 BUFFER is the output buffer. If it already exists, it will be
2608 erased first, otherwise, it will be created.
2610 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2611 and NOEXPAND are similar to those used in `org-export-as', which
2612 see.
2614 Return buffer."
2616 backend subtreep visible-only body-only ext-plist noexpand))
2622 buffer))
2626 "Call `org-export-as' with output to a specified file.
2628 BACKEND is the back-end used for transcoding, as a symbol. FILE
2629 is the name of the output file, as a string.
2631 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2632 and NOEXPAND are similar to those used in `org-export-as', which
2633 see.
2635 Return output file's name."
2636 ;; Checks for FILE permissions. `write-file' would do the same, but
2637 ;; we'd rather avoid needless transcoding of parse tree.
2639 ;; Insert contents to a temporary buffer and write it to FILE.
2641 backend subtreep visible-only body-only ext-plist noexpand)))
2646 ;; Return full path.
2647 file)
2650 "Return output file's name according to buffer specifications.
2652 EXTENSION is a string representing the output file extension,
2653 with the leading dot.
2655 With a non-nil optional argument SUBTREEP, try to determine
2657 of subtree at point.
2659 When optional argument PUB-DIR is set, use it as the publishing
2660 directory.
2662 When optional argument VISIBLE-ONLY is non-nil, don't export
2663 contents of hidden elements.
2665 Return file name as a string, or nil if it couldn't be
2666 determined."
2668 ;; File name may come from EXPORT_FILE_NAME subtree property,
2669 ;; assuming point is at beginning of said sub-tree.
2676 ;; File name may be extracted from buffer's associated
2677 ;; file, if any.
2679 ;; Can't determine file name on our own: Ask user.
2683 "Output file: " pub-dir nil nil nil
2686 ;; Build file name. Enforce EXTENSION over whatever user may have
2687 ;; come up with. PUB-DIR, if defined, always has precedence over
2688 ;; any provided path.
2693 extension))
2699 "Apply BODY in a copy of the current buffer.
2701 The copy preserves local variables and visibility of the original
2702 buffer.
2704 Point is at buffer's beginning when BODY is applied."
2714 ,original-buffer
2719 ov
2729 "Expand every macro in buffer.
2730 INFO is a plist containing export options and buffer properties."
2731 ;; First update macro templates since #+INCLUDE keywords might have
2732 ;; added some new ones.
2735 ;; Before expanding macros, install {{{author}}}, {{{date}}},
2736 ;; {{{email}}} and {{{title}}} templates.
2742 ;; EMAIL is not a parsed keyword: store it as-is.
2746 org-macro-templates)))
2749 "Expand every include keyword in buffer.
2750 Optional argument INCLUDED is a list of included file names along
2751 with their line restriction, when appropriate. It is used to
2752 avoid infinite recursion. Optional argument DIR is the current
2753 working directory. It is used to properly resolve relative
2754 paths."
2761 ;; Extract arguments from keyword's value.
2775 ;; Minimal level of included file defaults to the child
2776 ;; level of the current headline, if any, or one. It
2777 ;; only applies is the file is meant to be included as
2778 ;; an Org one.
2786 ;; Remove keyword.
2790 ;; Check if files has already been parsed. Look after
2791 ;; inclusion lines too, as different parts of the same file
2792 ;; can be included too.
2804 ind-str contents ind-str))))
2812 ind-str env contents ind-str))))
2825 "Prepare the contents of FILE for inclusion and return them as a string.
2827 When optional argument LINES is a string specifying a range of
2828 lines, include only those lines.
2830 Optional argument IND, when non-nil, is an integer specifying the
2831 global indentation of returned contents. Since its purpose is to
2832 allow an included file to stay in the same environment it was
2833 created \(i.e. a list item), it doesn't apply past the first
2834 headline encountered.
2836 Optional argument MINLEVEL, when non-nil, is an integer
2837 specifying the level that any top-level headline in the included
2838 file should have."
2854 ;; Remove blank lines at beginning and end of contents. The logic
2855 ;; behind that removal is that blank lines around include keyword
2856 ;; override blank lines in included file.
2865 ;; If IND is set, preserve indentation of include keyword until
2866 ;; the first headline encountered.
2872 ;; Do not move footnote definitions out of column 0.
2878 ;; When MINLEVEL is specified, compute minimal level for headlines
2879 ;; in the file (CUR-MIN), and remove stars to each headline so
2880 ;; that headlines with minimal level have a level of MINLEVEL.
2890 ;; Only change stars, don't bother moving whole
2891 ;; sections.
2897 \f
2898 ;;; Tools For Back-Ends
2899 ;;
2900 ;; A whole set of tools is available to help build new exporters. Any
2901 ;; function general enough to have its use across many back-ends
2902 ;; should be added here.
2904 ;;;; For Affiliated Keywords
2905 ;;
2906 ;; `org-export-read-attribute' reads a property from a given element
2907 ;; as a plist. It can be used to normalize affiliated keywords'
2908 ;; syntax.
2909 ;;
2910 ;; Since captions can span over multiple lines and accept dual values,
2911 ;; their internal representation is a bit tricky. Therefore,
2912 ;; `org-export-get-caption' transparently returns a given element's
2913 ;; caption as a secondary string.
2916 "Turn ATTRIBUTE property from ELEMENT into a plist.
2918 When optional argument PROPERTY is non-nil, return the value of
2919 that property within attributes.
2923 properties."
2931 "Return caption from ELEMENT as a secondary string.
2933 When optional argument SHORTP is non-nil, return short caption,
2934 as a secondary string, instead.
2936 Caption lines are separated by a white space."
2944 ;;;; For Export Snippets
2945 ;;
2946 ;; Every export snippet is transmitted to the back-end. Though, the
2947 ;; latter will only retain one type of export-snippet, ignoring
2948 ;; others, based on the former's target back-end. The function
2949 ;; `org-export-snippet-backend' returns that back-end for a given
2950 ;; export-snippet.
2953 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2954 Translation, with `org-export-snippet-translation-alist', is
2955 applied."
2959 back-end))))
2962 ;;;; For Footnotes
2963 ;;
2964 ;; `org-export-collect-footnote-definitions' is a tool to list
2965 ;; actually used footnotes definitions in the whole parse tree, or in
2966 ;; an headline, in order to add footnote listings throughout the
2967 ;; transcoded data.
2968 ;;
2969 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2970 ;; back-ends, when they need to attach the footnote definition only to
2971 ;; the first occurrence of the corresponding label.
2972 ;;
2973 ;; `org-export-get-footnote-definition' and
2974 ;; `org-export-get-footnote-number' provide easier access to
2975 ;; additional information relative to a footnote reference.
2978 "Return an alist between footnote numbers, labels and definitions.
2980 DATA is the parse tree from which definitions are collected.
2981 INFO is the plist used as a communication channel.
2983 Definitions are sorted by order of references. They either
2984 appear as Org data or as a secondary string for inlined
2985 footnotes. Unreferenced definitions are ignored."
2987 collect-fn ; for byte-compiler.
2991 ;; Collect footnote number, label and definition in DATA.
2993 data 'footnote-reference
3000 def)
3001 num-alist)
3002 ;; Also search in definition for nested footnotes.
3005 ;; Don't enter footnote definitions since it will happen
3006 ;; when their first reference is found.
3012 "Non-nil when a footnote reference is the first one for its label.
3014 FOOTNOTE-REFERENCE is the footnote reference being considered.
3015 INFO is the plist used as a communication channel."
3017 ;; Anonymous footnotes are always a first reference.
3019 ;; Otherwise, return the first footnote with the same LABEL and
3020 ;; test if it is equal to FOOTNOTE-REFERENCE.
3026 data 'footnote-reference
3031 ;; If FN isn't inlined, be sure to traverse its
3032 ;; definition before resuming search. See
3033 ;; comments in `org-export-get-footnote-number'
3034 ;; for more information.
3038 ;; Don't enter footnote definitions since it will
3039 ;; happen when their first reference is found.
3042 footnote-reference)))))
3045 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3046 INFO is the plist used as a communication channel."
3052 "Return number associated to a footnote.
3054 FOOTNOTE is either a footnote reference or a footnote definition.
3055 INFO is the plist used as a communication channel."
3057 seen-refs
3058 search-ref ; For byte-compiler.
3062 ;; Search footnote references through DATA, filling
3063 ;; SEEN-REFS along the way.
3065 data 'footnote-reference
3069 ;; Anonymous footnote match: return number.
3072 ;; Labels match: return number.
3075 ;; Anonymous footnote: it's always a new one. Also,
3076 ;; be sure to return nil from the `cond' so
3077 ;; `first-match' doesn't get us out of the loop.
3079 ;; Label not seen so far: add it so SEEN-REFS.
3080 ;;
3081 ;; Also search for subsequent references in
3082 ;; footnote definition so numbering follows reading
3083 ;; logic. Note that we don't have to care about
3084 ;; inline definitions, since `org-element-map'
3085 ;; already traverses them at the right time.
3086 ;;
3087 ;; Once again, return nil to stay in the loop.
3092 nil))))
3093 ;; Don't enter footnote definitions since it will happen
3094 ;; when their first reference is found.
3099 ;;;; For Headlines
3100 ;;
3101 ;; `org-export-get-relative-level' is a shortcut to get headline
3102 ;; level, relatively to the lower headline level in the parsed tree.
3103 ;;
3104 ;; `org-export-get-headline-number' returns the section number of an
3105 ;; headline, while `org-export-number-to-roman' allows to convert it
3106 ;; to roman numbers.
3107 ;;
3108 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3109 ;; `org-export-last-sibling-p' are three useful predicates when it
3110 ;; comes to fulfill the `:headline-levels' property.
3113 "Return HEADLINE relative level within current parsed tree.
3114 INFO is a plist holding contextual information."
3119 "Non-nil when HEADLINE is considered as low level.
3121 INFO is a plist used as a communication channel.
3123 A low level headlines has a relative level greater than
3124 `:headline-levels' property value.
3126 Return value is the difference between HEADLINE relative level
3127 and the last level being considered as high enough, or nil."
3134 "Return HEADLINE numbering as a list of numbers.
3135 INFO is a plist holding contextual information."
3139 "Return a non-nil value if HEADLINE element should be numbered.
3140 INFO is a plist used as a communication channel."
3146 "Convert integer N into a roman numeral."
3159 res)))
3162 "Return list of tags associated to ELEMENT.
3164 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3165 is a plist used as a communication channel.
3167 Select tags (see `org-export-select-tags') and exclude tags (see
3168 `org-export-exclude-tags') are removed from the list.
3170 When non-nil, optional argument TAGS should be a list of strings.
3171 Any tag belonging to this list will also be removed.
3173 When optional argument INHERITED is non-nil, tags can also be
3174 inherited from parent headlines.."
3180 ;; Build complete list of inherited tags.
3191 current-tag-list))))
3194 "Return node PROPERTY value for BLOB.
3196 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3197 element or object.
3199 If optional argument INHERITED is non-nil, the value can be
3200 inherited from a parent headline.
3202 Return value is a string or nil."
3214 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3215 INFO is a plist used as a communication channel."
3220 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3221 INFO is a plist used as a communication channel."
3225 ;;;; For Links
3226 ;;
3227 ;; `org-export-solidify-link-text' turns a string into a safer version
3228 ;; for links, replacing most non-standard characters with hyphens.
3229 ;;
3230 ;; `org-export-get-coderef-format' returns an appropriate format
3231 ;; string for coderefs.
3232 ;;
3233 ;; `org-export-inline-image-p' returns a non-nil value when the link
3234 ;; provided should be considered as an inline image.
3235 ;;
3236 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3237 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3238 ;; returns an appropriate unique identifier when found, or nil.
3239 ;;
3240 ;; `org-export-resolve-id-link' returns the first headline with
3241 ;; specified id or custom-id in parse tree, the path to the external
3242 ;; file with the id or nil when neither was found.
3243 ;;
3244 ;; `org-export-resolve-coderef' associates a reference to a line
3245 ;; number in the element it belongs, or returns the reference itself
3246 ;; when the element isn't numbered.
3249 "Take link text S and make a safe target out of it."
3254 "Return format string for code reference link.
3255 PATH is the link path. DESC is its description."
3263 "Non-nil if LINK object points to an inline image.
3265 Optional argument is a set of RULES defining inline images. It
3266 is an alist where associations have the following shape:
3268 \(TYPE . REGEXP)
3270 Applying a rule means apply REGEXP against LINK's path when its
3271 type is TYPE. The function will return a non-nil value if any of
3272 the provided rules is non-nil. The default rule is
3273 `org-export-default-inline-image-rule'.
3275 This only applies to links without a description."
3286 rules)
3287 ;; Return nil if no rule matched.
3288 nil))))
3291 "Resolve a code reference REF.
3293 INFO is a plist used as a communication channel.
3295 Return associated line number in source code, or REF itself,
3296 depending on src-block or example element's switches."
3304 org-coderef-label-format)))
3308 ;; Element containing REF is found. Resolve it to either
3309 ;; a label or a line number, as needed.
3319 "Return LINK destination.
3321 INFO is a plist holding contextual information.
3323 Return value can be an object, an element, or nil:
3325 - If LINK path matches a target object (i.e. <<path>>) or
3328 - If LINK path exactly matches the name affiliated keyword
3329 \(i.e. #+NAME: path) of an element, return that element.
3331 - If LINK path exactly matches any headline name, return that
3332 element. If more than one headline share that name, priority
3333 will be given to the one with the closest common ancestor, if
3334 any, or the first one in the parse tree otherwise.
3336 - Otherwise, return nil.
3342 ;; First try to find a matching "<<path>>" unless user specified
3343 ;; he was looking for an headline (path starts with a *
3344 ;; character).
3348 return target)))
3349 ;; Then try to find an element with a matching "#+NAME: path"
3350 ;; affiliated keyword.
3357 ;; Last case: link either points to an headline or to
3358 ;; nothingness. Try to find the source, with priority given to
3359 ;; headlines with the closest common ancestor. If such candidate
3360 ;; is found, return it, otherwise return nil.
3364 ;; Return first headline whose `:raw-value' property
3365 ;; is NAME in parse tree DATA, or nil.
3368 data 'headline
3372 name)
3373 headline))
3375 ;; Search among headlines sharing an ancestor with link,
3376 ;; from closest to farthest.
3384 ;; No match with a common ancestor: try the full parse-tree.
3390 "Return headline referenced as LINK destination.
3392 INFO is a plist used as a communication channel.
3394 Return value can be the headline element matched in current parse
3398 ;; First check if id is within the current parse tree.
3404 headline))
3406 ;; Otherwise, look for external files.
3410 "Return radio-target object referenced as LINK destination.
3412 INFO is a plist used as a communication channel.
3414 Return value can be a radio-target object or nil. Assume LINK
3424 ;;;; For References
3425 ;;
3426 ;; `org-export-get-ordinal' associates a sequence number to any object
3427 ;; or element.
3430 "Return ordinal number of an element or object.
3432 ELEMENT is the element or object considered. INFO is the plist
3433 used as a communication channel.
3435 Optional argument TYPES, when non-nil, is a list of element or
3436 object types, as symbols, that should also be counted in.
3437 Otherwise, only provided element's type is considered.
3439 Optional argument PREDICATE is a function returning a non-nil
3440 value if the current element or object should be counted in. It
3441 accepts two arguments: the element or object being considered and
3442 the plist used as a communication channel. This allows to count
3443 only a certain type of objects (i.e. inline images).
3445 Return value is a list of numbers if ELEMENT is an headline or an
3446 item. It is nil for keywords. It represents the footnote number
3447 for footnote definitions and footnote references. If ELEMENT is
3448 a target, return the same value as if ELEMENT was the closest
3449 table, item or headline containing the target. In any other
3450 case, return the sequence number of ELEMENT among elements or
3451 objects of the same type."
3452 ;; A target keyword, representing an invisible target, never has
3453 ;; a sequence number.
3455 ;; Ordinal of a target object refer to the ordinal of the closest
3456 ;; table, item, or headline containing the object.
3460 when
3464 table))
3465 return parent)))
3467 ;; Special case 1: An headline returns its number as a list.
3469 ;; Special case 2: An item returns its number as a list.
3473 struct
3480 ;; Increment counter until ELEMENT is found again.
3491 ;;;; For Src-Blocks
3492 ;;
3493 ;; `org-export-get-loc' counts number of code lines accumulated in
3494 ;; src-block or example-block elements with a "+n" switch until
3495 ;; a given element, excluded. Note: "-n" switches reset that count.
3496 ;;
3497 ;; `org-export-unravel-code' extracts source code (along with a code
3498 ;; references alist) from an `element-block' or `src-block' type
3499 ;; element.
3500 ;;
3501 ;; `org-export-format-code' applies a formatting function to each line
3502 ;; of code, providing relative line number and code reference when
3503 ;; appropriate. Since it doesn't access the original element from
3504 ;; which the source code is coming, it expects from the code calling
3505 ;; it to know if lines should be numbered and if code references
3506 ;; should appear.
3507 ;;
3508 ;; Eventually, `org-export-format-code-default' is a higher-level
3509 ;; function (it makes use of the two previous functions) which handles
3510 ;; line numbering and code references inclusion, and returns source
3511 ;; code in a format suitable for plain text or verbatim output.
3514 "Return accumulated lines of code up to ELEMENT.
3516 INFO is the plist used as a communication channel.
3518 ELEMENT is excluded from count."
3525 ;; ELEMENT is reached: Quit the loop.
3527 ;; Only count lines from src-block and example-block elements
3528 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3532 ;; Accumulate locs or reset them.
3536 ;; Return nil to stay in the loop.
3537 nil)))
3539 ;; Return value.
3540 loc))
3543 "Clean source code and extract references out of it.
3545 ELEMENT has either a `src-block' an `example-block' type.
3547 Return a cons cell whose CAR is the source code, cleaned from any
3548 reference and protective comma and CDR is an alist between
3549 relative line number (integer) and name of code reference on that
3550 line (string)."
3552 ;; Get code and clean it. Remove blank lines at its
3553 ;; beginning and end.
3559 ;; If appropriate, remove global indentation.
3562 c
3564 ;; Get format used for references.
3567 org-coderef-label-format)))
3568 ;; Build a regexp matching a loc with a reference.
3573 ;; Return value.
3575 ;; Code with references removed.
3581 ;; Ref line: remove ref, and signal its position in REFS.
3585 ;; Reference alist.
3586 refs)))
3589 "Format CODE by applying FUN line-wise and return it.
3591 CODE is a string representing the code to format. FUN is
3592 a function. It must accept three arguments: a line of
3593 code (string), the current line number (integer) or nil and the
3594 reference associated to the current line (string) or nil.
3596 Optional argument NUM-LINES can be an integer representing the
3597 number of code lines accumulated until the current code. Line
3598 numbers passed to FUN will take it into account. If it is nil,
3599 FUN's second argument will always be nil. This number can be
3600 obtained with `org-export-get-loc' function.
3602 Optional argument REF-ALIST can be an alist between relative line
3603 number (i.e. ignoring NUM-LINES) and the name of the code
3604 reference on it. If it is nil, FUN's third argument will always
3605 be nil. It can be obtained through the use of
3606 `org-export-unravel-code' function."
3618 "Return source code from ELEMENT, formatted in a standard way.
3620 ELEMENT is either a `src-block' or `example-block' element. INFO
3621 is a plist used as a communication channel.
3623 This function takes care of line numbering and code references
3624 inclusion. Line numbers, when applicable, appear at the
3625 beginning of the line, separated from the code by two white
3626 spaces. Code references, on the other hand, appear flushed to
3627 the right, separated by six white spaces from the widest line of
3628 code."
3629 ;; Extract code and references.
3635 ;; Handle line numbering.
3644 ;; Prepare references display, if required. Any reference
3645 ;; should start six columns after the widest line of code,
3646 ;; wrapped with parenthesis.
3651 code
3655 number-str
3656 loc
3662 num-start refs)))
3665 ;;;; For Tables
3666 ;;
3667 ;; `org-export-table-has-special-column-p' and and
3668 ;; `org-export-table-row-is-special-p' are predicates used to look for
3669 ;; meta-information about the table structure.
3670 ;;
3671 ;; `org-table-has-header-p' tells when the rows before the first rule
3672 ;; should be considered as table's header.
3673 ;;
3674 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3675 ;; and `org-export-table-cell-borders' extract information from
3676 ;; a table-cell element.
3677 ;;
3678 ;; `org-export-table-dimensions' gives the number on rows and columns
3679 ;; in the table, ignoring horizontal rules and special columns.
3680 ;; `org-export-table-cell-address', given a table-cell object, returns
3681 ;; the absolute address of a cell. On the other hand,
3682 ;; `org-export-get-table-cell-at' does the contrary.
3683 ;;
3684 ;; `org-export-table-cell-starts-colgroup-p',
3685 ;; `org-export-table-cell-ends-colgroup-p',
3686 ;; `org-export-table-row-starts-rowgroup-p',
3687 ;; `org-export-table-row-ends-rowgroup-p',
3688 ;; `org-export-table-row-starts-header-p' and
3689 ;; `org-export-table-row-ends-header-p' indicate position of current
3690 ;; row or cell within the table.
3693 "Non-nil when TABLE has a special column.
3694 All special columns will be ignored during export."
3695 ;; The table has a special column when every first cell of every row
3696 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3697 ;; "*" "_" and "^". Though, do not consider a first row containing
3698 ;; only empty cells as special.
3714 "Non-nil when TABLE has an header.
3716 INFO is a plist used as a communication channel.
3718 A table has an header when it contains at least two row groups."
3721 table 'table-row
3729 info)))
3732 "Non-nil if TABLE-ROW is considered special.
3734 INFO is a plist used as the communication channel.
3736 All special rows will be ignored during export."
3740 ;; A row is special either when...
3742 ;; ... it starts with a field only containing "/",
3744 ;; ... the table contains a special column and the row start
3745 ;; with a marking character among, "^", "_", "$" or "!",
3749 ;; ... it contains only alignment cookies and empty cells.
3755 ;; Since VALUE is a secondary string, the following
3756 ;; checks avoid expanding it with `org-export-data'.
3768 "Return TABLE-ROW's group.
3770 INFO is a plist used as the communication channel.
3772 Return value is the group number, as an integer, or nil special
3773 rows and table rules. Group 1 is also table's header."
3790 "Return TABLE-CELL contents width.
3792 INFO is a plist used as the communication channel.
3794 Return value is the width given by the last width cookie in the
3795 same column as TABLE-CELL, or nil."
3800 cookie-width)
3804 ;; In a special row, try to find a width cookie at COLUMN.
3808 ;; The following checks avoid expanding unnecessarily the
3809 ;; cell with `org-export-data'
3817 ;; Ignore table rules.
3820 ;; Return value.
3821 cookie-width))
3824 "Return TABLE-CELL contents alignment.
3826 INFO is a plist used as the communication channel.
3828 Return alignment as specified by the last alignment cookie in the
3829 same column as TABLE-CELL. If no such cookie is found, a default
3830 alignment value will be deduced from fraction of numbers in the
3831 column (see `org-table-number-fraction' for more information).
3832 Possible values are `left', `right' and `center'."
3839 cookie-align)
3843 ;; In a special row, try to find an alignment cookie at
3844 ;; COLUMN.
3848 ;; Since VALUE is a secondary string, the following checks
3849 ;; avoid useless expansion through `org-export-data'.
3857 ;; Ignore table rules.
3859 ;; In a standard row, check if cell's contents are expressing
3860 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3861 ;; Though, don't bother if an alignment cookie has already
3862 ;; defined cell's alignment.
3867 info)))
3872 ;; Return value. Alignment specified by cookies has precedence
3873 ;; over alignment deduced from cells contents.
3882 "Return TABLE-CELL borders.
3884 INFO is a plist used as a communication channel.
3886 Return value is a list of symbols, or nil. Possible values are:
3887 `top', `bottom', `above', `below', `left' and `right'. Note:
3888 `top' (resp. `bottom') only happen for a cell in the first
3889 row (resp. last row) of the table, ignoring table rules, if any.
3891 Returned borders ignore special rows."
3894 borders)
3895 ;; Top/above border? TABLE-CELL has a border above when a rule
3896 ;; used to demarcate row groups can be found above. Hence,
3897 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3898 ;; another regular row has to be found above that rule.
3907 ;; Look at every row before the current one.
3909 ;; No rule above, or rule found starts the table (ignoring any
3910 ;; special row): TABLE-CELL is at the top of the table.
3913 ;; Bottom/below border? TABLE-CELL has a border below when next
3914 ;; non-regular row below is a rule.
3923 ;; Look at every row after the current one.
3925 ;; No rule below, or rule found ends the table (modulo some
3926 ;; special row): TABLE-CELL is at the bottom of the table.
3929 ;; Right/left borders? They can only be specified by column
3930 ;; groups. Column groups are defined in a row starting with "/".
3931 ;; Also a column groups row only contains "<", "<>", ">" or blank
3932 ;; cells.
3949 ;; There's a left border when previous cell, if
3950 ;; any, ends a group, or current one starts one.
3956 ;; There's a right border when next cell, if any,
3957 ;; starts a group, or current one ends one.
3964 ;; Table rows are read in reverse order so last column groups
3965 ;; row has precedence over any previous one.
3967 ;; Return value.
3968 borders))
3971 "Non-nil when TABLE-CELL is at the beginning of a row group.
3972 INFO is a plist used as a communication channel."
3973 ;; A cell starts a column group either when it is at the beginning
3974 ;; of a row (or after the special column, if any) or when it has
3975 ;; a left border.
3979 table-cell)
3983 "Non-nil when TABLE-CELL is at the end of a row group.
3984 INFO is a plist used as a communication channel."
3985 ;; A cell ends a column group either when it is at the end of a row
3986 ;; or when it has a right border.
3989 table-cell)
3993 "Non-nil when TABLE-ROW is at the beginning of a column group.
3994 INFO is a plist used as a communication channel."
4002 "Non-nil when TABLE-ROW is at the end of a column group.
4003 INFO is a plist used as a communication channel."
4011 "Non-nil when TABLE-ROW is the first table header's row.
4012 INFO is a plist used as a communication channel."
4019 "Non-nil when TABLE-ROW is the last table header's row.
4020 INFO is a plist used as a communication channel."
4027 "Return TABLE dimensions.
4029 INFO is a plist used as a communication channel.
4031 Return value is a CONS like (ROWS . COLUMNS) where
4032 ROWS (resp. COLUMNS) is the number of exportable
4033 rows (resp. columns)."
4035 ;; Set number of rows, and extract first one.
4037 table 'table-row
4042 ;; Set number of columns.
4044 ;; Return value.
4048 "Return address of a regular TABLE-CELL object.
4050 TABLE-CELL is the cell considered. INFO is a plist used as
4051 a communication channel.
4053 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4054 zero-based index. Only exportable cells are considered. The
4055 function returns nil for other cells."
4058 ;; Ignore cells in special rows or in special column.
4063 ;; Row number.
4066 table 'table-row
4072 ;; Column number.
4075 table-row 'table-cell
4081 "Return regular table-cell object at ADDRESS in TABLE.
4083 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4084 zero-based index. TABLE is a table type element. INFO is
4085 a plist used as a communication channel.
4087 If no table-cell, among exportable cells, is found at ADDRESS,
4088 return nil."
4091 ;; Row at (car address) or nil.
4094 table 'table-row
4100 'table-cell
4107 ;;;; For Tables Of Contents
4108 ;;
4109 ;; `org-export-collect-headlines' builds a list of all exportable
4110 ;; headline elements, maybe limited to a certain depth. One can then
4111 ;; easily parse it and transcode it.
4112 ;;
4113 ;; Building lists of tables, figures or listings is quite similar.
4114 ;; Once the generic function `org-export-collect-elements' is defined,
4115 ;; `org-export-collect-tables', `org-export-collect-figures' and
4116 ;; `org-export-collect-listings' can be derived from it.
4119 "Collect headlines in order to build a table of contents.
4121 INFO is a plist used as a communication channel.
4123 When optional argument N is an integer, it specifies the depth of
4124 the table of contents. Otherwise, it is set to the value of the
4125 last headline level. See `org-export-headline-levels' for more
4126 information.
4128 Return a list of all exportable headlines as parsed elements."
4132 'headline
4134 ;; Strip contents from HEADLINE.
4137 info))
4140 "Collect referenceable elements of a determined type.
4142 TYPE can be a symbol or a list of symbols specifying element
4143 types to search. Only elements with a caption are collected.
4145 INFO is a plist used as a communication channel.
4147 When non-nil, optional argument PREDICATE is a function accepting
4148 one argument, an element of type TYPE. It returns a non-nil
4149 value when that element should be collected.
4151 Return a list of all elements found, in order of appearance."
4157 element))
4158 info))
4161 "Build a list of tables.
4162 INFO is a plist used as a communication channel.
4164 Return a list of table elements with a caption."
4168 "Build a list of figures.
4170 INFO is a plist used as a communication channel. PREDICATE is
4171 a function which accepts one argument: a paragraph element and
4172 whose return value is non-nil when that element should be
4173 collected.
4175 A figure is a paragraph type element, with a caption, verifying
4177 a vague concept that may depend on back-end.
4179 Return a list of elements recognized as figures."
4183 "Build a list of src blocks.
4185 INFO is a plist used as a communication channel.
4187 Return a list of src-block elements with a caption."
4191 ;;;; Topology
4192 ;;
4193 ;; Here are various functions to retrieve information about the
4194 ;; neighbourhood of a given element or object. Neighbours of interest
4195 ;; are direct parent (`org-export-get-parent'), parent headline
4196 ;; (`org-export-get-parent-headline'), first element containing an
4197 ;; object, (`org-export-get-parent-element'), parent table
4198 ;; (`org-export-get-parent-table'), previous element or object
4199 ;; (`org-export-get-previous-element') and next element or object
4200 ;; (`org-export-get-next-element').
4201 ;;
4202 ;; `org-export-get-genealogy' returns the full genealogy of a given
4203 ;; element or object, from closest parent to full parse tree.
4206 "Return BLOB parent or nil.
4207 BLOB is the element or object considered."
4211 "Return full genealogy relative to a given element or object.
4213 BLOB is the element or object being considered.
4215 Ancestors are returned from closest to farthest, the last one
4216 being the full parse tree."
4223 "Return BLOB parent headline or nil.
4224 BLOB is the element or object being considered."
4228 parent))
4231 "Return first element containing OBJECT or nil.
4232 OBJECT is the object to consider."
4236 parent))
4239 "Return OBJECT parent table or nil.
4240 OBJECT is either a `table-cell' or `table-element' type object."
4244 parent))
4247 "Return previous element or object.
4248 BLOB is an element or object. INFO is a plist used as
4249 a communication channel. Return previous exportable element or
4250 object, a string, or nil."
4260 "Return next element or object.
4261 BLOB is an element or object. INFO is a plist used as
4262 a communication channel. Return next exportable element or
4263 object, a string, or nil."
4269 nil))
4272 ;;;; Translation
4273 ;;
4274 ;; `org-export-translate' translates a string according to language
4275 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4276 ;; variable and a specified charset. `org-export-dictionary' contains
4277 ;; the dictionary used for the translation.
4399 "Dictionary for export engine.
4401 Alist whose CAR is the string to translate and CDR is an alist
4402 whose CAR is the language string and CDR is a plist whose
4403 properties are possible charsets and values translated terms.
4405 It is used as a database for `org-export-translate'. Since this
4406 function returns the string as-is if no translation was found,
4407 the variable only needs to record values different from the
4411 "Translate string S according to language specification.
4413 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4414 and `:utf-8'. INFO is a plist used as a communication channel.
4416 Translation depends on `:language' property. Return the
4417 translated string. If no translation is found, try to fall back
4418 to `:default' encoding. If it fails, return S."
4424 s)))
4427 \f
4428 ;;; The Dispatcher
4429 ;;
4430 ;; `org-export-dispatch' is the standard interactive way to start an
4431 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4432 ;; for its interface, which, in turn, delegates response to key
4433 ;; pressed to `org-export-dispatch-action'.
4436 "List of menu entries available for `org-export-dispatch'.
4437 This variable shouldn't be set directly. Set-up :menu-entry
4438 keyword in either `org-export-define-backend' or
4441 ;;;###autoload
4443 "Export dispatcher for Org mode.
4445 It provides an access to common export related tasks in a buffer.
4446 Its interface comes in two flavours: standard and expert. While
4447 both share the same set of bindings, only the former displays the
4448 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4449 to switch to one or the other."
4454 nil
4455 org-export-dispatch-use-expert-ui)
4461 ;; First handle special hard-coded actions.
4467 "Publish project: "
4468 org-e-publish-project-alist nil t)
4469 org-e-publish-project-alist)
4479 "Handle interface for `org-export-dispatch'.
4481 OPTIONS is a list containing current interactive options set for
4482 export. It can contain any of the following symbols:
4483 `body' toggles a body-only export
4484 `subtree' restricts export to current subtree
4485 `visible' restricts export to visible part of buffer.
4486 `force' force publishing files.
4488 FIRST-KEY is the key pressed to select the first level menu. It
4489 is nil when this menu hasn't been selected yet.
4491 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4492 buffer is provided, but indications about currently active
4493 options are given in the prompt. Moreover, \[?] allows to switch
4494 back to standard interface."
4497 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4498 ;; non-nil is the required first-level key to activate
4499 ;; KEY. When its value is t, activate KEY independently
4500 ;; on the first key, if any. A nil value means KEY will
4501 ;; only be activated at first level.
4505 ;; Make sure order of menu doesn't depend on the order in
4506 ;; which back-ends are loaded.
4509 ;; Compute a list of allowed keys based on the first key
4510 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4511 ;; always available.
4521 ;; Build the help menu for standard UI.
4525 ;; Options are hard-coded.
4527 [%s] Body only: %s [%s] Visible only: %s
4537 ;; Display registered back-end entries.
4547 ;; Split sub-menu into two columns.
4557 top-key)
4562 ;; Publishing menu is hard-coded.
4564 [%s] Current file [%s] Current project
4574 ;; Build prompts for both standard and expert UI.
4579 "Export command (Options: %s%s%s%s) [%s]: "
4585 ;; With expert UI, just read key with a fancy prompt. In standard
4586 ;; UI, display an intrusive help buffer.
4589 expert-prompt allowed-keys backends options first-key expertp)
4590 ;; At first call, create frame layout in order to display menu.
4597 ;; At this point, the buffer containing the menu exists and is
4598 ;; visible in the current window. So, refresh it.
4603 standard-prompt allowed-keys backends options first-key expertp))))
4607 "Read a character from command input and act accordingly.
4609 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
4610 a list of characters available at a given step in the process.
4611 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
4612 EXPERTP are the same as defined in `org-export-dispatch-ui',
4613 which see.
4615 Toggle export options when required. Otherwise, return value is
4616 a list with action as CAR and a list of interactive export
4617 options as CDR."
4619 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4620 ;; depending on user's key pressed.
4623 ;; Ignore non-standard characters (i.e. "M-a") and
4624 ;; undefined associations.
4629 ;; q key at first level aborts export. At second
4630 ;; level, cancel first key instead.
4633 ;; Help key: Switch back to standard interface if
4634 ;; expert UI was active.
4636 ;; Toggle export options.
4643 first-key expertp))
4644 ;; Action selected: Send key and options back to
4645 ;; `org-export-dispatch'.
4651 ;; Publishing actions are hard-coded. Send a special
4652 ;; signal to `org-export-dispatch'.
4660 options))
4661 ;; Otherwise, enter sub-menu.
4666 ;;; org-export.el ends here