| blob | 067abe10d9101ea86af5cffaaed59287a76a751e |
1 ;;; org-export.el --- Generic Export Engine For Org
3 ;; Copyright (C) 2012, 2013 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 defines one mandatory information: his translation table.
52 ;; Its value is an alist whose keys are elements and objects types and
53 ;; values translator functions. See function's docstring for more
54 ;; information about translators.
55 ;;
56 ;; Optionally, `org-export-define-backend' can also support specific
57 ;; buffer keywords, OPTION keyword's items and filters. Also refer to
58 ;; function documentation for more information.
59 ;;
60 ;; If the new back-end shares most properties with another one,
61 ;; `org-export-define-derived-backend' can be used to simplify the
62 ;; process.
63 ;;
64 ;; Any back-end can define its own variables. Among them, those
65 ;; customizable should belong to the `org-export-BACKEND' group.
66 ;;
67 ;; Tools for common tasks across back-ends are implemented in the
68 ;; following part of then file.
69 ;;
70 ;; Then, a wrapper macro for asynchronous export,
71 ;; `org-export-async-start', along with tools to display results. are
72 ;; given in the penultimate part.
73 ;;
74 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
75 ;; back-ends is provided in the last one.
77 ;;; Code:
95 \f
96 ;;; Internal Variables
97 ;;
98 ;; Among internal variables, the most important is
99 ;; `org-export-options-alist'. This variable define the global export
100 ;; options, shared between every exporter, and how they are acquired.
144 "Alist between export properties and ways to set them.
146 The CAR of the alist is the property name, and the CDR is a list
147 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
149 KEYWORD is a string representing a buffer keyword, or nil. Each
150 property defined this way can also be set, during subtree
151 export, through an headline property named after the keyword
153 property).
154 OPTION is a string that could be found in an #+OPTIONS: line.
155 DEFAULT is the default value for the property.
156 BEHAVIOUR determines how Org should handle multiple keywords for
157 the same property. It is a symbol among:
158 nil Keep old value and discard the new one.
159 t Replace old value with the new one.
160 `space' Concatenate the values, separating them with a space.
161 `newline' Concatenate the values, separating them with
162 a newline.
163 `split' Split values at white spaces, and cons them to the
164 previous list.
166 Values set through KEYWORD and OPTION have precedence over
167 DEFAULT.
169 All these properties should be back-end agnostic. Back-end
170 specific properties are set through `org-export-define-backend'.
174 "List of in-buffer keywords that require special treatment.
175 These keywords are not directly associated to a property. The
176 way they are handled must be hard-coded into
236 "Alist between filters properties and initial values.
238 The key of each association is a property name accessible through
239 the communication channel. Its value is a configurable global
240 variable defining initial filters.
242 This list is meant to install user specified filters. Back-end
243 developers may install their own filters using
244 `org-export-define-backend'. Filters defined there will always
245 be prepended to the current list, so they always get applied
254 "Default rule for link matching an inline image.
255 This rule applies to links with no description. By default, it
256 will be considered as an inline image if it targets a local file
259 See `org-export-inline-image-p' for more information about
263 "Non-nil means asynchronous export process should leave data behind.
267 located in `temporary-file-directory'.
269 When non-nil, it will also set `debug-on-error' to a non-nil
273 "Record asynchronously generated export results and processes.
274 This is an alist: its CAR is the source of the
275 result (destination file or buffer for a finished process,
276 original buffer for a running one) and its CDR is a list
277 containing the back-end used, as a symbol, and either a process
278 or the time at which it finished. It is used to build the menu
282 "List of backends currently available in the exporter.
284 A backend is stored as a list where CAR is its name, as a symbol,
285 and CDR is a plist with the following properties:
286 `:filters-alist', `:menu-entry', `:options-alist' and
287 `:translate-alist'.
289 This variable is set with `org-export-define-backend' and
293 "Last command called from the dispatcher.
294 The value should be a list. Its CAR is the action, as a symbol,
298 \f
299 ;;; User-configurable Variables
300 ;;
301 ;; Configuration for the masses.
302 ;;
303 ;; They should never be accessed directly, as their value is to be
304 ;; stored in a property list (cf. `org-export-options-alist').
305 ;; Back-ends will read their value from there instead.
308 "Options for exporting Org mode files."
313 "General options for export engine."
318 "Whether sub-trees with the ARCHIVE tag should be exported.
320 This can have three different values:
321 nil Do not export, pretend this tree is not present.
322 t Do export the entire tree.
323 `headline' Only export the headline, but skip the tree below it.
325 This option can also be set with the #+OPTIONS line,
334 "Non-nil means insert author name into the exported file.
335 This option can also be set with the #+OPTIONS line,
341 "Non-nil means export CLOCK keywords.
342 This option can also be set with the #+OPTIONS line,
348 "Non-nil means the postamble should contain a creator sentence.
350 The sentence can be set in `org-export-creator-string' and
353 If the value is `comment' insert it as a comment."
361 "Non-nil means insert date in the exported document.
362 This options can also be set with the OPTIONS keyword,
368 emacs-version)
369 "String to insert at the end of the generated document."
374 "Non-nil means export contents of standard drawers.
376 When t, all drawers are exported. This may also be a list of
377 drawer names to export. This variable doesn't apply to
378 properties drawers.
380 This option can also be set with the #+OPTIONS line,
390 "Non-nil means insert author email into the exported file.
391 This option can also be set with the #+OPTIONS line,
397 "Non-nil means interpret *word*, /word/, _word_ and +word+.
399 If the export target supports emphasizing text, the word will be
400 typeset in bold, italic, with an underline or strike-through,
401 respectively.
408 "Tags that exclude a tree from export.
410 All trees carrying any of these tags will be excluded from
411 export. This is without condition, so even subtrees inside that
412 carry one of the `org-export-select-tags' will be removed.
414 This option can also be set with the #+EXCLUDE_TAGS: keyword."
421 This can be used to have pre-formatted text, fragments of code
422 etc. For example:
423 : ;; Some Lisp examples
424 : (while (defc cnt)
425 : (ding))
426 will be looking just like this in also HTML. See also the QUOTE
427 keyword. Not all export backends support this.
434 "Non-nil means Org footnotes should be exported.
435 This option can also be set with the #+OPTIONS line,
441 "The last level which is still exported as a headline.
443 Inferior levels will produce itemize lists when exported.
450 "The default language for export and clocktable translations, as a string.
451 This may have an association in
452 `org-clock-clocktable-language-setup'."
457 "Non-nil means preserve all line breaks when exporting.
459 Normally, in HTML output paragraphs will be reformatted.
461 This option can also be set with the #+OPTIONS line,
467 "Non-nil means interpret entities when exporting.
470 Å.
472 For a list of supported names, see the constant `org-entities'
473 and the user option `org-entities-user'.
475 This option can also be set with the #+OPTIONS line,
481 "Non-nil means inlinetasks should be exported.
482 This option can also be set with the #+OPTIONS line,
488 "Non-nil means include planning info in export.
489 This option can also be set with the #+OPTIONS: line,
495 "Non-nil means include priority cookies in export.
496 This option can also be set with the #+OPTIONS line,
502 "Non-nil means add section numbers to headlines when exporting.
504 When set to an integer n, numbering will only happen for
505 headlines whose relative level is higher or equal to n.
507 This option can also be set with the #+OPTIONS line,
513 "Tags that select a tree for export.
515 If any such tag is found in a buffer, all trees that do not carry
516 one of these tags will be ignored during export. Inside trees
517 that are selected like this, you can still deselect a subtree by
518 tagging it with one of the `org-export-exclude-tags'.
520 This option can also be set with the #+SELECT_TAGS: keyword."
525 "Non-nil means activate smart quotes during export.
526 This option can also be set with the #+OPTIONS: line,
534 When this option is turned on, these strings will be exported as:
536 Org HTML LaTeX UTF-8
537 -----+----------+--------+-------
539 -- – -- –
540 --- — --- —
543 This option can also be set with the #+OPTIONS line,
549 "Non-nil means include statistics cookies in export.
550 This option can also be set with the #+OPTIONS: line,
558 When this option is turned on, you can use TeX-like syntax for
560 will be considered as a single item - so grouping with {} is
561 normally not needed. For example, the following things will be
562 parsed as single sub- or superscripts.
564 10^24 or 10^tau several digits will be considered 1 item.
565 10^-12 or 10^-tau a leading sign with digits or a word
566 x^2-y^3 will be read as x^2 - y^3, because items are
567 terminated by almost any nonword/nondigit char.
568 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
570 Still, ambiguity is possible - so when in doubt use {} to enclose
571 the sub/superscript. If you set this variable to the symbol
572 `{}', the braces are *required* in order to trigger
573 interpretations as sub/superscript. This can be helpful in
576 This option can also be set with the #+OPTIONS line,
585 "Non-nil means create a table of contents in exported files.
587 The TOC contains headlines with levels up
588 to`org-export-headline-levels'. When an integer, include levels
589 up to N in the toc, this may then be different from
590 `org-export-headline-levels', but it will not be allowed to be
591 larger than the number of headline levels. When nil, no table of
592 contents is made.
594 This option can also be set with the #+OPTIONS line,
604 For example:
606 | Name | Address | Birthday |
607 |-------------+----------+-----------|
608 | Arthur Dent | England | 29.2.2100 |
615 "If nil, do not export tags, just remove them from headlines.
617 If this is the symbol `not-in-toc', tags will be removed from
618 table of contents entries, but still be shown in the headlines of
619 the document.
621 This option can also be set with the #+OPTIONS line,
630 "Non-nil means include TODO items for export.
632 This may have the following values:
633 t include tasks independent of state.
634 `todo' include only tasks that are not yet done.
635 `done' include only tasks that are already done.
636 nil ignore all tasks.
637 list of keywords include tasks with these keywords.
639 This option can also be set with the #+OPTIONS line,
651 "Non-nil means insert a time stamp into the exported file.
652 The time stamp shows when the file was created.
654 This option can also be set with the #+OPTIONS line,
660 "Non nil means allow timestamps in export.
662 It can be set to `active', `inactive', t or nil, in order to
663 export, respectively, only active timestamps, only inactive ones,
664 all of them or none.
666 This option can also be set with the #+OPTIONS line, e.g.
676 "Non-nil means include TODO keywords in export.
677 When nil, remove all these keywords from the export."
682 "Non-nil means allow #+BIND to define local variable values for export.
683 This is a potential security risk, which is why the user must
684 confirm the use of these lines."
692 "Alist between export snippets back-ends and exporter back-ends.
694 This variable allows to provide shortcuts for export snippets.
698 HTML code while every other back-end will ignore it."
706 "Coding system for the exported file."
711 "Non-nil means exported stuff will also be pushed onto the kill ring."
716 "The initial scope when exporting with `org-export-dispatch'.
717 This variable can be either set to `buffer' or `subtree'."
724 "Non-nil means show buffer after exporting to temp buffer.
725 When Org exports to a file, the buffer visiting that file is ever
726 shown, but remains buried. However, when exporting to
727 a temporary buffer, that buffer is popped up in a second window.
728 When this variable is nil, the buffer remains buried also in
729 these cases."
734 "Non-nil means export and publishing commands will run in background.
735 Results from an asynchronous export are never displayed. You can
741 "File used to initialize external export process.
742 Value must be an absolute file name. It defaults to user's
743 initialization file. Though, a specific configuration makes the
744 process faster and the export more portable."
749 "Non-nil means using a non-intrusive `org-export-dispatch'.
750 In that case, no help buffer is displayed. Though, an indicator
755 be passed the FORCE argument). Also, \[?] allows to switch back
756 to standard mode."
761 \f
762 ;;; Defining Back-ends
763 ;;
764 ;; `org-export-define-backend' is the standard way to define an export
765 ;; back-end. It allows to specify translators, filters, buffer
766 ;; options and a menu entry. If the new back-end shares translators
767 ;; with another back-end, `org-export-define-derived-backend' may be
768 ;; used instead.
769 ;;
770 ;; Internally, a back-end is stored as a list, of which CAR is the
771 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
772 ;; properties of a given back-end are: `org-export-backend-filters',
773 ;; `org-export-backend-menu', `org-export-backend-options' and
774 ;; `org-export-backend-translate-table'.
775 ;;
776 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
777 ;; when a given back-end hasn't been registered yet.
780 "Define a new back-end BACKEND.
782 TRANSLATORS is an alist between object or element types and
783 functions handling them.
785 These functions should return a string without any trailing
786 space, or nil. They must accept three arguments: the object or
787 element itself, its contents or nil when it isn't recursive and
788 the property list used as a communication channel.
790 Contents, when not nil, are stripped from any global indentation
791 \(although the relative one is preserved). They also always end
792 with a single newline character.
794 If, for a given type, no function is found, that element or
795 object type will simply be ignored, along with any blank line or
796 white space at its end. The same will happen if the function
797 returns the nil value. If that function returns the empty
798 string, the type will be ignored, but the blank lines or white
799 spaces will be kept.
801 In addition to element and object types, one function can be
802 associated to the `template' symbol and another one to the
803 `plain-text' symbol.
805 The former returns the final transcoded string, and can be used
806 to add a preamble and a postamble to document's body. It must
807 accept two arguments: the transcoded string and the property list
808 containing export options.
810 The latter, when defined, is to be called on every text not
811 recognized as an element or an object. It must accept two
812 arguments: the text string and the information channel. It is an
813 appropriate place to protect special chars relative to the
814 back-end.
816 BODY can start with pre-defined keyword arguments. The following
817 keywords are understood:
819 :export-block
821 String, or list of strings, representing block names that
822 will not be parsed. This is used to specify blocks that will
823 contain raw code specific to the back-end. These blocks
824 still have to be handled by the relative `export-block' type
825 translator.
827 :filters-alist
829 Alist between filters and function, or list of functions,
830 specific to the back-end. See `org-export-filters-alist' for
831 a list of all allowed filters. Filters defined here
832 shouldn't make a back-end test, as it may prevent back-ends
833 derived from this one to behave properly.
835 :menu-entry
837 Menu entry for the export dispatcher. It should be a list
838 like:
840 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
842 where :
844 KEY is a free character selecting the back-end.
846 DESCRIPTION-OR-ORDINAL is either a string or a number.
848 If it is a string, is will be used to name the back-end in
849 its menu entry. If it is a number, the following menu will
850 be displayed as a sub-menu of the back-end with the same
851 KEY. Also, the number will be used to determine in which
852 order such sub-menus will appear (lowest first).
854 ACTION-OR-MENU is either a function or an alist.
856 If it is an action, it will be called with four
857 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
858 BODY-ONLY. See `org-export-as' for further explanations on
859 some of them.
861 If it is an alist, associations should follow the
862 pattern:
864 \(KEY DESCRIPTION ACTION)
866 where KEY, DESCRIPTION and ACTION are described above.
868 Valid values include:
872 or
877 \(lambda (a s v b)
878 \(if a (org-e-latex-export-to-pdf t s v b)
879 \(org-open-file
880 \(org-e-latex-export-to-pdf nil s v b)))))))
882 or the following, which will be added to the previous
883 sub-menu,
885 \(?l 1
889 :options-alist
891 Alist between back-end specific properties introduced in
892 communication channel and how their value are acquired. See
893 `org-export-options-alist' for more information about
894 structure of the values."
913 ;; Register back-end.
917 ;; Tell parser to not parse EXPORT-BLOCK blocks.
924 ;; Splice in the body, if any.
928 "Create a new back-end as a variant of an existing one.
930 CHILD is the name of the derived back-end. PARENT is the name of
931 the parent back-end.
933 BODY can start with pre-defined keyword arguments. The following
934 keywords are understood:
936 :export-block
938 String, or list of strings, representing block names that
939 will not be parsed. This is used to specify blocks that will
940 contain raw code specific to the back-end. These blocks
941 still have to be handled by the relative `export-block' type
942 translator.
944 :filters-alist
946 Alist of filters that will overwrite or complete filters
947 defined in PARENT back-end. See `org-export-filters-alist'
948 for a list of allowed filters.
950 :menu-entry
952 Menu entry for the export dispatcher. See
953 `org-export-define-backend' for more information about the
954 expected value.
956 :options-alist
958 Alist of back-end specific properties that will overwrite or
959 complete those defined in PARENT back-end. Refer to
960 `org-export-options-alist' for more information about
961 structure of the values.
963 :translate-alist
965 Alist of element and object types and transcoders that will
966 overwrite or complete transcode table from PARENT back-end.
967 Refer to `org-export-define-backend' for detailed information
968 about transcoders.
971 as a variant of `e-latex' back-end with a custom template
972 function:
974 \(org-export-define-derived-backend my-latex e-latex
975 :translate-alist ((template . my-latex-template-fun)))
977 The back-end could then be called with, for example:
1005 ;; Register back-end.
1009 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1016 ;; Splice in the body, if any.
1020 "Return filters for BACKEND."
1025 "Return menu entry for BACKEND."
1030 "Return export options for BACKEND."
1035 "Return translate table for BACKEND."
1040 "Signal an error if BACKEND isn't defined."
1045 "Non-nil if BACKEND is derived from one of BACKENDS."
1050 org-export-registered-backends))
1052 parent))
1055 \f
1056 ;;; The Communication Channel
1057 ;;
1058 ;; During export process, every function has access to a number of
1059 ;; properties. They are of two types:
1060 ;;
1061 ;; 1. Environment options are collected once at the very beginning of
1062 ;; the process, out of the original buffer and configuration.
1063 ;; Collecting them is handled by `org-export-get-environment'
1064 ;; function.
1065 ;;
1066 ;; Most environment options are defined through the
1067 ;; `org-export-options-alist' variable.
1068 ;;
1069 ;; 2. Tree properties are extracted directly from the parsed tree,
1070 ;; just before export, by `org-export-collect-tree-properties'.
1071 ;;
1072 ;; Here is the full list of properties available during transcode
1073 ;; process, with their category and their value type.
1074 ;;
1075 ;; + `:author' :: Author's name.
1076 ;; - category :: option
1077 ;; - type :: string
1078 ;;
1079 ;; + `:back-end' :: Current back-end used for transcoding.
1080 ;; - category :: tree
1081 ;; - type :: symbol
1082 ;;
1083 ;; + `:creator' :: String to write as creation information.
1084 ;; - category :: option
1085 ;; - type :: string
1086 ;;
1087 ;; + `:date' :: String to use as date.
1088 ;; - category :: option
1089 ;; - type :: string
1090 ;;
1091 ;; + `:description' :: Description text for the current data.
1092 ;; - category :: option
1093 ;; - type :: string
1094 ;;
1095 ;; + `:email' :: Author's email.
1096 ;; - category :: option
1097 ;; - type :: string
1098 ;;
1099 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1100 ;; process.
1101 ;; - category :: option
1102 ;; - type :: list of strings
1103 ;;
1104 ;; + `:exported-data' :: Hash table used for memoizing
1105 ;; `org-export-data'.
1106 ;; - category :: tree
1107 ;; - type :: hash table
1108 ;;
1109 ;; + `:filetags' :: List of global tags for buffer. Used by
1110 ;; `org-export-get-tags' to get tags with inheritance.
1111 ;; - category :: option
1112 ;; - type :: list of strings
1113 ;;
1114 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1115 ;; their definition, as parsed data. Only non-inlined footnotes
1116 ;; are represented in this alist. Also, every definition isn't
1117 ;; guaranteed to be referenced in the parse tree. The purpose of
1118 ;; this property is to preserve definitions from oblivion
1119 ;; (i.e. when the parse tree comes from a part of the original
1120 ;; buffer), it isn't meant for direct use in a back-end. To
1121 ;; retrieve a definition relative to a reference, use
1122 ;; `org-export-get-footnote-definition' instead.
1123 ;; - category :: option
1124 ;; - type :: alist (STRING . LIST)
1125 ;;
1126 ;; + `:headline-levels' :: Maximum level being exported as an
1127 ;; headline. Comparison is done with the relative level of
1128 ;; headlines in the parse tree, not necessarily with their
1129 ;; actual level.
1130 ;; - category :: option
1131 ;; - type :: integer
1132 ;;
1133 ;; + `:headline-offset' :: Difference between relative and real level
1134 ;; of headlines in the parse tree. For example, a value of -1
1135 ;; means a level 2 headline should be considered as level
1136 ;; 1 (cf. `org-export-get-relative-level').
1137 ;; - category :: tree
1138 ;; - type :: integer
1139 ;;
1140 ;; + `:headline-numbering' :: Alist between headlines and their
1141 ;; numbering, as a list of numbers
1142 ;; (cf. `org-export-get-headline-number').
1143 ;; - category :: tree
1144 ;; - type :: alist (INTEGER . LIST)
1145 ;;
1146 ;; + `:id-alist' :: Alist between ID strings and destination file's
1147 ;; path, relative to current directory. It is used by
1148 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1149 ;; external file.
1150 ;; - category :: option
1151 ;; - type :: alist (STRING . STRING)
1152 ;;
1153 ;; + `:ignore-list' :: List of elements and objects that should be
1154 ;; ignored during export.
1155 ;; - category :: tree
1156 ;; - type :: list of elements and objects
1157 ;;
1158 ;; + `:input-file' :: Full path to input file, if any.
1159 ;; - category :: option
1160 ;; - type :: string or nil
1161 ;;
1162 ;; + `:keywords' :: List of keywords attached to data.
1163 ;; - category :: option
1164 ;; - type :: string
1165 ;;
1166 ;; + `:language' :: Default language used for translations.
1167 ;; - category :: option
1168 ;; - type :: string
1169 ;;
1170 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1171 ;; transcoding.
1172 ;; - category :: option
1173 ;; - type :: list (as returned by `org-element-parse-buffer')
1174 ;;
1175 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1176 ;; all line breaks.
1177 ;; - category :: option
1178 ;; - type :: symbol (nil, t)
1179 ;;
1180 ;; + `:section-numbers' :: Non-nil means transcoding should add
1181 ;; section numbers to headlines.
1182 ;; - category :: option
1183 ;; - type :: symbol (nil, t)
1184 ;;
1185 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1186 ;; in transcoding. When such a tag is present, subtrees without
1187 ;; it are de facto excluded from the process. See
1188 ;; `use-select-tags'.
1189 ;; - category :: option
1190 ;; - type :: list of strings
1191 ;;
1192 ;; + `:target-list' :: List of targets encountered in the parse tree.
1193 ;; This is used to partly resolve "fuzzy" links
1194 ;; (cf. `org-export-resolve-fuzzy-link').
1195 ;; - category :: tree
1196 ;; - type :: list of strings
1197 ;;
1198 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1199 ;; a time stamp in the output.
1200 ;; - category :: option
1201 ;; - type :: symbol (nil, t)
1202 ;;
1203 ;; + `:translate-alist' :: Alist between element and object types and
1204 ;; transcoding functions relative to the current back-end.
1205 ;; Special keys `template' and `plain-text' are also possible.
1206 ;; - category :: option
1207 ;; - type :: alist (SYMBOL . FUNCTION)
1208 ;;
1209 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1210 ;; also be transcoded. If it is set to the `headline' symbol,
1211 ;; only the archived headline's name is retained.
1212 ;; - category :: option
1213 ;; - type :: symbol (nil, t, `headline')
1214 ;;
1215 ;; + `:with-author' :: Non-nil means author's name should be included
1216 ;; in the output.
1217 ;; - category :: option
1218 ;; - type :: symbol (nil, t)
1219 ;;
1220 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1221 ;; - category :: option
1222 ;; - type :: symbol (nil, t)
1223 ;;
1224 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1225 ;; inserted at the end of the transcoded string. If the value
1226 ;; is `comment', it should be commented.
1227 ;; - category :: option
1228 ;; - type :: symbol (`comment', nil, t)
1229 ;;
1230 ;; + `:with-date' :: Non-nil means output should contain a date.
1231 ;; - category :: option
1232 ;; - type :. symbol (nil, t)
1233 ;;
1234 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1235 ;; its value is a list of names, only drawers with such names
1236 ;; will be transcoded.
1237 ;; - category :: option
1238 ;; - type :: symbol (nil, t) or list of strings
1239 ;;
1240 ;; + `:with-email' :: Non-nil means output should contain author's
1241 ;; email.
1242 ;; - category :: option
1243 ;; - type :: symbol (nil, t)
1244 ;;
1245 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1246 ;; interpreted.
1247 ;; - category :: option
1248 ;; - type :: symbol (nil, t)
1249 ;;
1250 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1251 ;; strings starting with a colon as a fixed-with (verbatim) area.
1252 ;; - category :: option
1253 ;; - type :: symbol (nil, t)
1254 ;;
1255 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1256 ;; footnotes.
1257 ;; - category :: option
1258 ;; - type :: symbol (nil, t)
1259 ;;
1260 ;; + `:with-plannings' :: Non-nil means transcoding should include
1261 ;; planning info.
1262 ;; - category :: option
1263 ;; - type :: symbol (nil, t)
1264 ;;
1265 ;; + `:with-priority' :: Non-nil means transcoding should include
1266 ;; priority cookies.
1267 ;; - category :: option
1268 ;; - type :: symbol (nil, t)
1269 ;;
1270 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1271 ;; plain text.
1272 ;; - category :: option
1273 ;; - type :: symbol (nil, t)
1274 ;;
1275 ;; + `:with-special-strings' :: Non-nil means transcoding should
1276 ;; interpret special strings in plain text.
1277 ;; - category :: option
1278 ;; - type :: symbol (nil, t)
1279 ;;
1280 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1281 ;; interpret subscript and superscript. With a value of "{}",
1282 ;; only interpret those using curly brackets.
1283 ;; - category :: option
1284 ;; - type :: symbol (nil, {}, t)
1285 ;;
1286 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1287 ;; tables.
1288 ;; - category :: option
1289 ;; - type :: symbol (nil, t)
1290 ;;
1291 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1292 ;; headlines. A `not-in-toc' value will remove them from the
1293 ;; table of contents, if any, nonetheless.
1294 ;; - category :: option
1295 ;; - type :: symbol (nil, t, `not-in-toc')
1296 ;;
1297 ;; + `:with-tasks' :: Non-nil means transcoding should include
1298 ;; headlines with a TODO keyword. A `todo' value will only
1299 ;; include headlines with a todo type keyword while a `done'
1300 ;; value will do the contrary. If a list of strings is provided,
1301 ;; only tasks with keywords belonging to that list will be kept.
1302 ;; - category :: option
1303 ;; - type :: symbol (t, todo, done, nil) or list of strings
1304 ;;
1305 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1306 ;; time stamps. Special value `active' (resp. `inactive') ask to
1307 ;; export only active (resp. inactive) timestamps. Otherwise,
1308 ;; completely remove them.
1309 ;; - category :: option
1310 ;; - type :: symbol: (`active', `inactive', t, nil)
1311 ;;
1312 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1313 ;; added to the output. An integer value limits its depth.
1314 ;; - category :: option
1315 ;; - type :: symbol (nil, t or integer)
1316 ;;
1317 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1318 ;; include TODO keywords.
1319 ;; - category :: option
1320 ;; - type :: symbol (nil, t)
1323 ;;;; Environment Options
1324 ;;
1325 ;; Environment options encompass all parameters defined outside the
1326 ;; scope of the parsed data. They come from five sources, in
1327 ;; increasing precedence order:
1328 ;;
1329 ;; - Global variables,
1330 ;; - Buffer's attributes,
1331 ;; - Options keyword symbols,
1332 ;; - Buffer keywords,
1333 ;; - Subtree properties.
1334 ;;
1335 ;; The central internal function with regards to environment options
1336 ;; is `org-export-get-environment'. It updates global variables with
1337 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1338 ;; the different sources.
1339 ;;
1340 ;; The internal functions doing the retrieval are:
1341 ;; `org-export--get-global-options',
1342 ;; `org-export--get-buffer-attributes',
1343 ;; `org-export--parse-option-keyword',
1344 ;; `org-export--get-subtree-options' and
1345 ;; `org-export--get-inbuffer-options'
1346 ;;
1347 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1348 ;; take care of the part relative to "#+BIND:" keywords.
1351 "Collect export options from the current buffer.
1353 Optional argument BACKEND is a symbol specifying which back-end
1354 specific options to read, if any.
1356 When optional argument SUBTREEP is non-nil, assume the export is
1357 done against the current sub-tree.
1359 Third optional argument EXT-PLIST is a property list with
1360 external parameters overriding Org default settings, but still
1361 inferior to file-local settings."
1362 ;; First install #+BIND variables.
1364 ;; Get and prioritize export options...
1366 ;; ... from global variables...
1368 ;; ... from an external property list...
1369 ext-plist
1370 ;; ... from in-buffer settings...
1372 backend
1374 ;; ... and from subtree, when appropriate.
1376 ;; Eventually add misc. properties.
1378 :back-end
1379 backend
1380 :translate-alist
1382 :footnote-definition-alist
1383 ;; Footnotes definitions must be collected in the original
1384 ;; buffer, as there's no insurance that they will still be in
1385 ;; the parse tree, due to possible narrowing.
1399 alist))))
1400 alist))
1401 :id-alist
1402 ;; Collect id references.
1413 alist))))
1416 "Parse an OPTIONS line and return values as a plist.
1417 Optional argument BACKEND is a symbol specifying which back-end
1418 specific items to read, if any."
1421 ;; Build an alist between #+OPTION: item and property-name.
1426 all)))
1427 plist)
1432 options)
1437 alist)
1438 plist))
1441 "Get export options in subtree at point.
1442 Optional argument BACKEND is a symbol specifying back-end used
1443 for export. Return options as a plist."
1444 ;; For each buffer keyword, create an headline property setting the
1445 ;; same property in communication channel. The name for the property
1446 ;; is the keyword with "EXPORT_" appended to it.
1449 ;; Make sure point is at an heading.
1451 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1452 ;; title as its fallback value.
1458 plist :title
1461 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1465 ;; Handle other keywords. TITLE keyword is excluded as it has
1466 ;; been handled already.
1473 ;; Export properties are not case-sensitive.
1480 plist
1483 ;; Parse VALUE if required.
1487 ;; If BEHAVIOUR is `split' expected value is
1488 ;; a list of strings, not a string.
1491 ;; Also look for both general keywords and back-end specific
1492 ;; options if BACKEND is provided.
1494 org-export-options-alist)))
1495 ;; Return value.
1496 plist)))
1499 "Return current buffer export options, as a plist.
1501 Optional argument BACKEND, when non-nil, is a symbol specifying
1502 which back-end specific options should also be read in the
1503 process.
1505 Optional argument FILES is a list of setup files names read so
1506 far, used to avoid circular dependencies.
1508 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1512 ;; 1. Special keywords, as in `org-export-special-keywords'.
1526 ;; Avoid circular dependencies.
1541 ;; 2. Standard options, as in `org-export-options-alist'.
1543 ;; Also look for back-end specific options if
1544 ;; BACKEND is defined.
1546 ;; Build ALIST between keyword name and property name.
1550 all)))
1551 ;; Build regexp matching all keywords associated to export
1552 ;; options. Note: the search is case insensitive.
1566 plist prop
1567 ;; Handle value depending on specified BEHAVIOUR.
1580 ;; Parse keywords specified in
1581 ;; `org-element-document-properties'.
1589 plist prop
1592 org-element-document-properties))
1593 ;; 3. Return final value.
1594 plist)))
1597 "Return properties related to buffer attributes, as a plist."
1600 ;; Store full path of input file name, or nil. For internal use.
1601 :input-file visited-file
1608 "Return global export options as a plist.
1610 Optional argument BACKEND, if non-nil, is a symbol specifying
1611 which back-end specific export options should also be read in the
1612 process."
1615 ;; Output value.
1616 plist)
1621 plist
1623 ;; Eval default value provided. If keyword is a member
1624 ;; of `org-element-document-properties', parse it as
1625 ;; a secondary string before storing it.
1630 value
1633 all)
1634 ;; Return value.
1635 plist))
1639 "Can we use #+BIND values during export?
1640 By default this will ask for confirmation by the user, to divert
1641 possible security risks."
1646 org-export--allow-BIND-local)
1651 "Install the values from #+BIND lines as local variables.
1652 Variables must be installed before in-buffer options are
1653 retrieved."
1668 ;;;; Tree Properties
1669 ;;
1670 ;; Tree properties are information extracted from parse tree. They
1671 ;; are initialized at the beginning of the transcoding process by
1672 ;; `org-export-collect-tree-properties'.
1673 ;;
1674 ;; Dedicated functions focus on computing the value of specific tree
1675 ;; properties during initialization. Thus,
1676 ;; `org-export--populate-ignore-list' lists elements and objects that
1677 ;; should be skipped during export, `org-export--get-min-level' gets
1678 ;; the minimal exportable level, used as a basis to compute relative
1679 ;; level for headlines. Eventually
1680 ;; `org-export--collect-headline-numbering' builds an alist between
1681 ;; headlines and their numbering.
1684 "Extract tree properties from parse tree.
1686 DATA is the parse tree from which information is retrieved. INFO
1687 is a list holding export options.
1689 Following tree properties are set or updated:
1691 `:exported-data' Hash table used to memoize results from
1692 `org-export-data'.
1694 `:footnote-definition-alist' List of footnotes definitions in
1695 original buffer and current parse tree.
1697 `:headline-offset' Offset between true level of headlines and
1698 local level. An offset of -1 means an headline
1699 of level 2 should be considered as a level
1700 1 headline in the context.
1702 `:headline-numbering' Alist of all headlines as key an the
1703 associated numbering as value.
1705 `:ignore-list' List of elements that should be ignored during
1706 export.
1708 `:target-list' List of all targets in the parse tree.
1710 Return updated plist."
1711 ;; Install the parse tree in the communication channel, in order to
1712 ;; use `org-export-get-genealogy' and al.
1714 ;; Get the list of elements and objects to ignore, and put it into
1715 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1716 ;; been done during parse tree filtering.
1719 :ignore-list
1722 ;; Compute `:headline-offset' in order to be able to use
1723 ;; `org-export-get-relative-level'.
1726 :headline-offset
1728 ;; Update footnotes definitions list with definitions in parse tree.
1729 ;; This is required since buffer expansion might have modified
1730 ;; boundaries of footnote definitions contained in the parse tree.
1731 ;; This way, definitions in `footnote-definition-alist' are bound to
1732 ;; match those in the parse tree.
1735 data 'footnote-definition
1739 defs)))
1741 ;; Properties order doesn't matter: get the rest of the tree
1742 ;; properties.
1744 `(:target-list
1753 info))
1756 "Return minimum exportable headline's level in DATA.
1757 DATA is parsed tree as returned by `org-element-parse-buffer'.
1758 OPTIONS is a plist holding export options."
1769 ;; If no headline was found, for the sake of consistency, set
1770 ;; minimum level to 1 nonetheless.
1774 "Return numbering of all exportable headlines in a parse tree.
1776 DATA is the parse tree. OPTIONS is the plist holding export
1777 options.
1779 Return an alist whose key is an headline and value is its
1780 associated numbering \(in the shape of a list of numbers\)."
1783 data
1784 'headline
1789 headline
1791 for idx from 0 to org-export-max-depth
1795 options)))
1798 "Return list of elements and objects to ignore during export.
1799 DATA is the parse tree to traverse. OPTIONS is the plist holding
1800 export options."
1802 walk-data
1803 ;; First find trees containing a select tag, if any.
1807 ;; Collect ignored elements or objects into IGNORE-LIST.
1813 ;; If headline is archived but tree below has
1814 ;; to be skipped, add it to ignore list.
1817 ;; Move into secondary string, if any.
1822 ;; Move into recursive objects/elements.
1824 ;; Main call.
1826 ;; Return value.
1827 ignore))
1830 "Return list of headlines containing a select tag in their tree.
1831 DATA is parsed data as returned by `org-element-parse-buffer'.
1832 INFO is a plist holding export options."
1834 walk-data ; for byte-compiler.
1845 ;; When a select tag is found, mark full
1846 ;; genealogy and every headline within the tree
1847 ;; as acceptable.
1850 genealogy
1852 selected-trees))
1853 ;; Else, continue searching in tree, recursively.
1860 "Non-nil when element or object BLOB should be skipped during export.
1861 OPTIONS is the plist holding export options. SELECTED, when
1862 non-nil, is a list of headlines belonging to a tree with a select
1863 tag."
1878 ;; Ignore subtrees with an exclude tag.
1881 ;; When a select tag is present in the buffer, ignore any tree
1882 ;; without it.
1884 ;; Ignore commented sub-trees.
1886 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1888 ;; Ignore tasks, if specified by `:with-tasks' property.
1904 ;; No timestamp allowed.
1906 ;; Only active timestamps allowed and the current one isn't
1907 ;; active.
1911 ;; Only inactive timestamps allowed and the current one isn't
1912 ;; inactive.
1918 \f
1919 ;;; The Transcoder
1920 ;;
1921 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1922 ;; `org-element-parse-buffer') and transcodes it into a specified
1923 ;; back-end output. It takes care of filtering out elements or
1924 ;; objects according to export options and organizing the output blank
1925 ;; lines and white space are preserved. The function memoizes its
1926 ;; results, so it is cheap to call it within translators.
1927 ;;
1928 ;; It is possible to modify locally the back-end used by
1929 ;; `org-export-data' or even use a temporary back-end by using
1930 ;; `org-export-data-with-translations' and
1931 ;; `org-export-data-with-backend'.
1932 ;;
1933 ;; Internally, three functions handle the filtering of objects and
1934 ;; elements during the export. In particular,
1935 ;; `org-export-ignore-element' marks an element or object so future
1936 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1937 ;; elements or objects should be seen as real Org syntax and
1938 ;; `org-export-expand' transforms the others back into their original
1939 ;; shape
1940 ;;
1941 ;; `org-export-transcoder' is an accessor returning appropriate
1942 ;; translator function for a given element or object.
1945 "Return appropriate transcoder for BLOB.
1946 INFO is a plist containing export directives."
1948 ;; Return contents only for complete parse trees.
1954 "Convert DATA into current back-end format.
1956 DATA is a parse tree, an element or an object or a secondary
1957 string. INFO is a plist holding export options.
1959 Return transcoded string."
1965 ;; Ignored element/object.
1967 ;; Plain text.
1973 info))
1974 ;; Uninterpreted element/object: change it back to Org
1975 ;; syntax and export again resulting raw string.
1979 data
1983 info))
1984 ;; Secondary string.
1987 ;; Element/Object without contents or, as a special case,
1988 ;; headline with archive tag and archived trees restricted
1989 ;; to title only.
1997 ;; Element/Object with contents.
2010 ;; Elements directly containing objects
2011 ;; must have their indentation normalized
2012 ;; first.
2014 data
2015 ;; When normalizing contents of the first
2016 ;; paragraph in an item or a footnote
2017 ;; definition, ignore first line's
2018 ;; indentation: there is none and it
2019 ;; might be misleading.
2024 data)
2031 info))))))))
2032 ;; Final result will be memoized before being returned.
2034 data
2038 ;; Append the same white space between elements or objects as in
2039 ;; the original buffer, and call appropriate filters.
2050 info)))
2051 results)))
2055 "Convert DATA into another format using a given translation table.
2056 DATA is an element, an object, a secondary string or a string.
2057 TRANSLATIONS is an alist between element or object types and
2058 a functions handling them. See `org-export-define-backend' for
2059 more information. INFO is a plist used as a communication
2060 channel."
2062 data
2063 ;; Set-up a new communication channel with TRANSLATIONS as the
2064 ;; translate table and a new hash table for memoization.
2066 info
2068 ;; Size of the hash table is reduced since this function
2069 ;; will probably be used on short trees.
2073 "Convert DATA into BACKEND format.
2075 DATA is an element, an object, a secondary string or a string.
2076 BACKEND is a symbol. INFO is a plist used as a communication
2077 channel.
2079 Unlike to `org-export-with-backend', this function will
2080 recursively convert DATA using BACKEND translation table."
2086 "Non-nil if element or object BLOB should be interpreted as Org syntax.
2087 Check is done according to export options INFO, stored as
2088 a plist."
2090 ;; ... entities...
2092 ;; ... emphasis...
2095 ;; ... fixed-width areas.
2097 ;; ... footnotes...
2100 ;; ... sub/superscripts...
2106 ;; ... tables...
2111 "Expand a parsed element or object to its original state.
2112 BLOB is either an element or an object. CONTENTS is its
2113 contents, as a string or nil."
2116 blob contents))
2119 "Add ELEMENT to `:ignore-list' in INFO.
2121 Any element in `:ignore-list' will be skipped when using
2122 `org-element-map'. INFO is modified by side effects."
2126 \f
2127 ;;; The Filter System
2128 ;;
2129 ;; Filters allow end-users to tweak easily the transcoded output.
2130 ;; They are the functional counterpart of hooks, as every filter in
2131 ;; a set is applied to the return value of the previous one.
2132 ;;
2133 ;; Every set is back-end agnostic. Although, a filter is always
2134 ;; called, in addition to the string it applies to, with the back-end
2135 ;; used as argument, so it's easy for the end-user to add back-end
2136 ;; specific filters in the set. The communication channel, as
2137 ;; a plist, is required as the third argument.
2138 ;;
2139 ;; From the developer side, filters sets can be installed in the
2140 ;; process with the help of `org-export-define-backend', which
2141 ;; internally stores filters as an alist. Each association has a key
2142 ;; among the following symbols and a function or a list of functions
2143 ;; as value.
2144 ;;
2145 ;; - `:filter-parse-tree' applies directly on the complete parsed
2146 ;; tree. It's the only filters set that doesn't apply to a string.
2147 ;; Users can set it through `org-export-filter-parse-tree-functions'
2148 ;; variable.
2149 ;;
2150 ;; - `:filter-final-output' applies to the final transcoded string.
2151 ;; Users can set it with `org-export-filter-final-output-functions'
2152 ;; variable
2153 ;;
2154 ;; - `:filter-plain-text' applies to any string not recognized as Org
2155 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2156 ;; configure it.
2157 ;;
2158 ;; - `:filter-TYPE' applies on the string returned after an element or
2159 ;; object of type TYPE has been transcoded. An user can modify
2160 ;; `org-export-filter-TYPE-functions'
2161 ;;
2162 ;; All filters sets are applied with
2163 ;; `org-export-filter-apply-functions' function. Filters in a set are
2164 ;; applied in a LIFO fashion. It allows developers to be sure that
2165 ;; their filters will be applied first.
2166 ;;
2167 ;; Filters properties are installed in communication channel with
2168 ;; `org-export-install-filters' function.
2169 ;;
2170 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2171 ;; `org-export-before-parsing-hook') are run at the beginning of the
2172 ;; export process and just before parsing to allow for heavy structure
2173 ;; modifications.
2176 ;;;; Hooks
2179 "Hook run at the beginning of the export process.
2181 This is run before include keywords and macros are expanded and
2182 Babel code blocks executed, on a copy of the original buffer
2183 being exported. Visibility and narrowing are preserved. Point
2184 is at the beginning of the buffer.
2186 Every function in this hook will be called with one argument: the
2190 "Hook run before parsing an export buffer.
2192 This is run after include keywords and macros have been expanded
2193 and Babel code blocks executed, on a copy of the original buffer
2194 being exported. Visibility and narrowing are preserved. Point
2195 is at the beginning of the buffer.
2197 Every function in this hook will be called with one argument: the
2201 ;;;; Special Filters
2204 "List of functions applied to the parsed tree.
2205 Each filter is called with three arguments: the parse tree, as
2206 returned by `org-element-parse-buffer', the back-end, as
2207 a symbol, and the communication channel, as a plist. It must
2211 "List of functions applied to the transcoded string.
2212 Each filter is called with three arguments: the full transcoded
2213 string, the back-end, as a symbol, and the communication channel,
2214 as a plist. It must return a string that will be used as the
2218 "List of functions applied to plain text.
2219 Each filter is called with three arguments: a string which
2220 contains no Org syntax, the back-end, as a symbol, and the
2221 communication channel, as a plist. It must return a string or
2225 ;;;; Elements Filters
2228 "List of functions applied to a transcoded babel-call.
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 center block.
2235 Each filter is called with three arguments: the transcoded data,
2236 as a string, the back-end, as a symbol, and the communication
2240 "List of functions applied to a transcoded clock.
2241 Each filter is called with three arguments: the transcoded data,
2242 as a string, the back-end, as a symbol, and the communication
2246 "List of functions applied to a transcoded comment.
2247 Each filter is called with three arguments: the transcoded data,
2248 as a string, the back-end, as a symbol, and the communication
2252 "List of functions applied to a transcoded comment-block.
2253 Each filter is called with three arguments: the transcoded data,
2254 as a string, the back-end, as a symbol, and the communication
2258 "List of functions applied to a transcoded diary-sexp.
2259 Each filter is called with three arguments: the transcoded data,
2260 as a string, the back-end, as a symbol, and the communication
2264 "List of functions applied to a transcoded drawer.
2265 Each filter is called with three arguments: the transcoded data,
2266 as a string, the back-end, as a symbol, and the communication
2270 "List of functions applied to a transcoded dynamic-block.
2271 Each filter is called with three arguments: the transcoded data,
2272 as a string, the back-end, as a symbol, and the communication
2276 "List of functions applied to a transcoded example-block.
2277 Each filter is called with three arguments: the transcoded data,
2278 as a string, the back-end, as a symbol, and the communication
2282 "List of functions applied to a transcoded export-block.
2283 Each filter is called with three arguments: the transcoded data,
2284 as a string, the back-end, as a symbol, and the communication
2288 "List of functions applied to a transcoded fixed-width.
2289 Each filter is called with three arguments: the transcoded data,
2290 as a string, the back-end, as a symbol, and the communication
2294 "List of functions applied to a transcoded footnote-definition.
2295 Each filter is called with three arguments: the transcoded data,
2296 as a string, the back-end, as a symbol, and the communication
2300 "List of functions applied to a transcoded headline.
2301 Each filter is called with three arguments: the transcoded data,
2302 as a string, the back-end, as a symbol, and the communication
2306 "List of functions applied to a transcoded horizontal-rule.
2307 Each filter is called with three arguments: the transcoded data,
2308 as a string, the back-end, as a symbol, and the communication
2312 "List of functions applied to a transcoded inlinetask.
2313 Each filter is called with three arguments: the transcoded data,
2314 as a string, the back-end, as a symbol, and the communication
2318 "List of functions applied to a transcoded item.
2319 Each filter is called with three arguments: the transcoded data,
2320 as a string, the back-end, as a symbol, and the communication
2324 "List of functions applied to a transcoded keyword.
2325 Each filter is called with three arguments: the transcoded data,
2326 as a string, the back-end, as a symbol, and the communication
2330 "List of functions applied to a transcoded latex-environment.
2331 Each filter is called with three arguments: the transcoded data,
2332 as a string, the back-end, as a symbol, and the communication
2336 "List of functions applied to a transcoded node-property.
2337 Each filter is called with three arguments: the transcoded data,
2338 as a string, the back-end, as a symbol, and the communication
2342 "List of functions applied to a transcoded paragraph.
2343 Each filter is called with three arguments: the transcoded data,
2344 as a string, the back-end, as a symbol, and the communication
2348 "List of functions applied to a transcoded plain-list.
2349 Each filter is called with three arguments: the transcoded data,
2350 as a string, the back-end, as a symbol, and the communication
2354 "List of functions applied to a transcoded planning.
2355 Each filter is called with three arguments: the transcoded data,
2356 as a string, the back-end, as a symbol, and the communication
2360 "List of functions applied to a transcoded property-drawer.
2361 Each filter is called with three arguments: the transcoded data,
2362 as a string, the back-end, as a symbol, and the communication
2366 "List of functions applied to a transcoded quote block.
2367 Each filter is called with three arguments: the transcoded quote
2368 data, as a string, the back-end, as a symbol, and the
2369 communication channel, as a plist. It must return a string or
2373 "List of functions applied to a transcoded quote-section.
2374 Each filter is called with three arguments: the transcoded data,
2375 as a string, the back-end, as a symbol, and the communication
2379 "List of functions applied to a transcoded section.
2380 Each filter is called with three arguments: the transcoded data,
2381 as a string, the back-end, as a symbol, and the communication
2385 "List of functions applied to a transcoded special block.
2386 Each filter is called with three arguments: the transcoded data,
2387 as a string, the back-end, as a symbol, and the communication
2391 "List of functions applied to a transcoded src-block.
2392 Each filter is called with three arguments: the transcoded data,
2393 as a string, the back-end, as a symbol, and the communication
2397 "List of functions applied to a transcoded table.
2398 Each filter is called with three arguments: the transcoded data,
2399 as a string, the back-end, as a symbol, and the communication
2403 "List of functions applied to a transcoded table-cell.
2404 Each filter is called with three arguments: the transcoded data,
2405 as a string, the back-end, as a symbol, and the communication
2409 "List of functions applied to a transcoded table-row.
2410 Each filter is called with three arguments: the transcoded data,
2411 as a string, the back-end, as a symbol, and the communication
2415 "List of functions applied to a transcoded verse block.
2416 Each filter is called with three arguments: the transcoded data,
2417 as a string, the back-end, as a symbol, and the communication
2421 ;;;; Objects Filters
2424 "List of functions applied to transcoded bold text.
2425 Each filter is called with three arguments: the transcoded data,
2426 as a string, the back-end, as a symbol, and the communication
2430 "List of functions applied to transcoded code text.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2436 "List of functions applied to a transcoded entity.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2442 "List of functions applied to a transcoded export-snippet.
2443 Each filter is called with three arguments: the transcoded data,
2444 as a string, the back-end, as a symbol, and the communication
2448 "List of functions applied to a transcoded footnote-reference.
2449 Each filter is called with three arguments: the transcoded data,
2450 as a string, the back-end, as a symbol, and the communication
2454 "List of functions applied to a transcoded inline-babel-call.
2455 Each filter is called with three arguments: the transcoded data,
2456 as a string, the back-end, as a symbol, and the communication
2460 "List of functions applied to a transcoded inline-src-block.
2461 Each filter is called with three arguments: the transcoded data,
2462 as a string, the back-end, as a symbol, and the communication
2466 "List of functions applied to transcoded italic text.
2467 Each filter is called with three arguments: the transcoded data,
2468 as a string, the back-end, as a symbol, and the communication
2472 "List of functions applied to a transcoded latex-fragment.
2473 Each filter is called with three arguments: the transcoded data,
2474 as a string, the back-end, as a symbol, and the communication
2478 "List of functions applied to a transcoded line-break.
2479 Each filter is called with three arguments: the transcoded data,
2480 as a string, the back-end, as a symbol, and the communication
2484 "List of functions applied to a transcoded link.
2485 Each filter is called with three arguments: the transcoded data,
2486 as a string, the back-end, as a symbol, and the communication
2490 "List of functions applied to a transcoded macro.
2491 Each filter is called with three arguments: the transcoded data,
2492 as a string, the back-end, as a symbol, and the communication
2496 "List of functions applied to a transcoded radio-target.
2497 Each filter is called with three arguments: the transcoded data,
2498 as a string, the back-end, as a symbol, and the communication
2502 "List of functions applied to a transcoded statistics-cookie.
2503 Each filter is called with three arguments: the transcoded data,
2504 as a string, the back-end, as a symbol, and the communication
2508 "List of functions applied to transcoded strike-through text.
2509 Each filter is called with three arguments: the transcoded data,
2510 as a string, the back-end, as a symbol, and the communication
2514 "List of functions applied to a transcoded subscript.
2515 Each filter is called with three arguments: the transcoded data,
2516 as a string, the back-end, as a symbol, and the communication
2520 "List of functions applied to a transcoded superscript.
2521 Each filter is called with three arguments: the transcoded data,
2522 as a string, the back-end, as a symbol, and the communication
2526 "List of functions applied to a transcoded target.
2527 Each filter is called with three arguments: the transcoded data,
2528 as a string, the back-end, as a symbol, and the communication
2532 "List of functions applied to a transcoded timestamp.
2533 Each filter is called with three arguments: the transcoded data,
2534 as a string, the back-end, as a symbol, and the communication
2538 "List of functions applied to transcoded underline text.
2539 Each filter is called with three arguments: the transcoded data,
2540 as a string, the back-end, as a symbol, and the communication
2544 "List of functions applied to transcoded verbatim text.
2545 Each filter is called with three arguments: the transcoded data,
2546 as a string, the back-end, as a symbol, and the communication
2550 ;;;; Filters Tools
2551 ;;
2552 ;; Internal function `org-export-install-filters' installs filters
2553 ;; hard-coded in back-ends (developer filters) and filters from global
2554 ;; variables (user filters) in the communication channel.
2555 ;;
2556 ;; Internal function `org-export-filter-apply-functions' takes care
2557 ;; about applying each filter in order to a given data. It ignores
2558 ;; filters returning a nil value but stops whenever a filter returns
2559 ;; an empty string.
2562 "Call every function in FILTERS.
2564 Functions are called with arguments VALUE, current export
2565 back-end and INFO. A function returning a nil value will be
2566 skipped. If it returns the empty string, the process ends and
2567 VALUE is ignored.
2569 Call is done in a LIFO fashion, to be sure that developer
2570 specified filters, if any, are called first."
2579 "Install filters properties in communication channel.
2581 INFO is a plist containing the current communication channel.
2583 Return the updated communication channel."
2585 ;; Install user defined filters with `org-export-filters-alist'.
2588 org-export-filters-alist)
2589 ;; Prepend back-end specific filters to that list.
2591 ;; Single values get consed, lists are prepended.
2596 plist key
2600 ;; Return new communication channel.
2604 \f
2605 ;;; Core functions
2606 ;;
2607 ;; This is the room for the main function, `org-export-as', along with
2608 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2609 ;; They differ only by the way they output the resulting code.
2610 ;;
2611 ;; `org-export-output-file-name' is an auxiliary function meant to be
2612 ;; used with `org-export-to-file'. With a given extension, it tries
2613 ;; to provide a canonical file name to write export output to.
2614 ;;
2615 ;; Note that `org-export-as' doesn't really parse the current buffer,
2616 ;; but a copy of it (with the same buffer-local variables and
2617 ;; visibility), where macros and include keywords are expanded and
2618 ;; Babel blocks are executed, if appropriate.
2619 ;; `org-export-with-buffer-copy' macro prepares that copy.
2620 ;;
2621 ;; File inclusion is taken care of by
2622 ;; `org-export-expand-include-keyword' and
2623 ;; `org-export--prepare-file-contents'. Structure wise, including
2624 ;; a whole Org file in a buffer often makes little sense. For
2625 ;; example, if the file contains an headline and the include keyword
2626 ;; was within an item, the item should contain the headline. That's
2627 ;; why file inclusion should be done before any structure can be
2628 ;; associated to the file, that is before parsing.
2632 "Transcode current Org buffer into BACKEND code.
2634 If narrowing is active in the current buffer, only transcode its
2635 narrowed part.
2637 If a region is active, transcode that region.
2639 When optional argument SUBTREEP is non-nil, transcode the
2640 sub-tree at point, extracting information from the headline
2641 properties first.
2643 When optional argument VISIBLE-ONLY is non-nil, don't export
2644 contents of hidden elements.
2646 When optional argument BODY-ONLY is non-nil, only return body
2647 code, without preamble nor postamble.
2649 Optional argument EXT-PLIST, when provided, is a property list
2650 with external parameters overriding Org default settings, but
2651 still inferior to file-local settings.
2653 Return code as a string."
2654 ;; Barf if BACKEND isn't registered.
2658 ;; Narrow buffer to an appropriate region or subtree for
2659 ;; parsing. If parsing subtree, be sure to remove main headline
2660 ;; too.
2668 ;; Initialize communication channel with original buffer
2669 ;; attributes, unavailable in its copy.
2671 ;; Update communication channel and get parse tree. Buffer
2672 ;; isn't parsed directly. Instead, a temporary copy is
2673 ;; created, where include keywords, macros are expanded and
2674 ;; code blocks are evaluated.
2676 ;; Run first hook with current back-end as argument.
2679 ;; Update macro templates since #+INCLUDE keywords might have
2680 ;; added some new ones.
2684 ;; Update radio targets since keyword inclusion might have
2685 ;; added some more.
2687 ;; Run last hook with current back-end as argument.
2690 ;; Update communication channel with environment. Also
2691 ;; install user's and developer's filters.
2696 ;; Expand export-specific set of macros: {{{author}}},
2697 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2698 ;; once regular macros have been expanded, since document
2699 ;; keywords may contain one of them.
2705 ;; EMAIL is not a parsed keyword: store it as-is.
2709 ;; Eventually parse buffer. Call parse-tree filters to get
2710 ;; the final tree.
2715 ;; Now tree is complete, compute its properties and add them
2716 ;; to communication channel.
2720 ;; Eventually transcode TREE. Wrap the resulting string into
2721 ;; a template, if required. Finally call final-output filter.
2726 ;; Remove all text properties since they cannot be
2727 ;; retrieved from an external process.
2733 info))))
2734 ;; Maybe add final OUTPUT to kill ring, then return it.
2737 output)))))
2741 "Call `org-export-as' with output to a specified buffer.
2743 BACKEND is the back-end used for transcoding, as a symbol.
2745 BUFFER is the output buffer. If it already exists, it will be
2746 erased first, otherwise, it will be created.
2748 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2749 EXT-PLIST are similar to those used in `org-export-as', which
2750 see.
2752 Return buffer."
2759 buffer))
2763 "Call `org-export-as' with output to a specified file.
2765 BACKEND is the back-end used for transcoding, as a symbol. FILE
2766 is the name of the output file, as a string.
2768 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2769 EXT-PLIST are similar to those used in `org-export-as', which
2770 see.
2772 Return output file's name."
2773 ;; Checks for FILE permissions. `write-file' would do the same, but
2774 ;; we'd rather avoid needless transcoding of parse tree.
2776 ;; Insert contents to a temporary buffer and write it to FILE.
2782 ;; Return full path.
2783 file)
2786 "Return output file's name according to buffer specifications.
2788 EXTENSION is a string representing the output file extension,
2789 with the leading dot.
2791 With a non-nil optional argument SUBTREEP, try to determine
2793 of subtree at point.
2795 When optional argument PUB-DIR is set, use it as the publishing
2796 directory.
2798 When optional argument VISIBLE-ONLY is non-nil, don't export
2799 contents of hidden elements.
2801 Return file name as a string, or nil if it couldn't be
2802 determined."
2804 ;; File name may come from EXPORT_FILE_NAME subtree property,
2805 ;; assuming point is at beginning of said sub-tree.
2812 ;; File name may be extracted from buffer's associated
2813 ;; file, if any.
2816 ;; Can't determine file name on our own: Ask user.
2820 "Output file: " pub-dir nil nil nil
2823 ;; Build file name. Enforce EXTENSION over whatever user may have
2824 ;; come up with. PUB-DIR, if defined, always has precedence over
2825 ;; any provided path.
2830 extension))
2835 "Return a copy of the current buffer.
2836 The copy preserves Org buffer-local variables, visibility and
2837 narrowing."
2843 new-buf))
2846 "Apply BODY in a copy of the current buffer.
2847 The copy preserves local variables, visibility and contents of
2848 the original buffer. Point is at the beginning of the buffer
2849 when BODY is applied."
2858 ;; Kill copy without confirmation.
2864 "Generate a function duplicating BUFFER.
2866 The copy will preserve local variables, visibility, contents and
2867 narrowing of the original buffer. If a region was active in
2868 BUFFER, contents will be narrowed to that region instead.
2870 The resulting function can be eval'ed at a later time, from
2871 another buffer, effectively cloning the original buffer there."
2875 ;; Buffer local variables.
2885 buffer-file-name outline-level
2886 outline-regexp
2887 buffer-invisibility-spec))
2890 ;; Skip unreadable values, as they cannot be
2891 ;; sent to external process.
2895 local-vars)))))
2897 local-vars)
2898 ;; Whole buffer contents.
2903 ;; Narrowing.
2907 ;; Current position of point.
2909 ;; Overlays with invisible property.
2919 ov-set))))
2921 ov-set)))))
2924 "Expand every include keyword in buffer.
2925 Optional argument INCLUDED is a list of included file names along
2926 with their line restriction, when appropriate. It is used to
2927 avoid infinite recursion. Optional argument DIR is the current
2928 working directory. It is used to properly resolve relative
2929 paths."
2936 ;; Extract arguments from keyword's value.
2950 ;; Minimal level of included file defaults to the child
2951 ;; level of the current headline, if any, or one. It
2952 ;; only applies is the file is meant to be included as
2953 ;; an Org one.
2961 ;; Remove keyword.
2966 ;; Check if files has already been parsed. Look after
2967 ;; inclusion lines too, as different parts of the same file
2968 ;; can be included too.
2980 ind-str contents ind-str))))
2988 ind-str env contents ind-str))))
3001 "Prepare the contents of FILE for inclusion and return them as a string.
3003 When optional argument LINES is a string specifying a range of
3004 lines, include only those lines.
3006 Optional argument IND, when non-nil, is an integer specifying the
3007 global indentation of returned contents. Since its purpose is to
3008 allow an included file to stay in the same environment it was
3009 created \(i.e. a list item), it doesn't apply past the first
3010 headline encountered.
3012 Optional argument MINLEVEL, when non-nil, is an integer
3013 specifying the level that any top-level headline in the included
3014 file should have."
3030 ;; Remove blank lines at beginning and end of contents. The logic
3031 ;; behind that removal is that blank lines around include keyword
3032 ;; override blank lines in included file.
3041 ;; If IND is set, preserve indentation of include keyword until
3042 ;; the first headline encountered.
3048 ;; Do not move footnote definitions out of column 0.
3054 ;; When MINLEVEL is specified, compute minimal level for headlines
3055 ;; in the file (CUR-MIN), and remove stars to each headline so
3056 ;; that headlines with minimal level have a level of MINLEVEL.
3066 ;; Only change stars, don't bother moving whole
3067 ;; sections.
3074 "Execute every Babel code in the visible part of current buffer.
3075 This function will return an error if the current buffer is
3076 visiting a file."
3077 ;; Get a pristine copy of current buffer so Babel references can be
3078 ;; properly resolved.
3085 \f
3086 ;;; Tools For Back-Ends
3087 ;;
3088 ;; A whole set of tools is available to help build new exporters. Any
3089 ;; function general enough to have its use across many back-ends
3090 ;; should be added here.
3092 ;;;; For Affiliated Keywords
3093 ;;
3094 ;; `org-export-read-attribute' reads a property from a given element
3095 ;; as a plist. It can be used to normalize affiliated keywords'
3096 ;; syntax.
3097 ;;
3098 ;; Since captions can span over multiple lines and accept dual values,
3099 ;; their internal representation is a bit tricky. Therefore,
3100 ;; `org-export-get-caption' transparently returns a given element's
3101 ;; caption as a secondary string.
3104 "Turn ATTRIBUTE property from ELEMENT into a plist.
3106 When optional argument PROPERTY is non-nil, return the value of
3107 that property within attributes.
3111 properties."
3119 "Return caption from ELEMENT as a secondary string.
3121 When optional argument SHORTP is non-nil, return short caption,
3122 as a secondary string, instead.
3124 Caption lines are separated by a white space."
3132 ;;;; For Derived Back-ends
3133 ;;
3134 ;; `org-export-with-backend' is a function allowing to locally use
3135 ;; another back-end to transcode some object or element. In a derived
3136 ;; back-end, it may be used as a fall-back function once all specific
3137 ;; cases have been treated.
3140 "Call a transcoder from BACK-END on DATA.
3141 CONTENTS, when non-nil, is the transcoded contents of DATA
3142 element, as a string. INFO, when non-nil, is the communication
3143 channel used for export, as a plist.."
3153 ;;;; For Export Snippets
3154 ;;
3155 ;; Every export snippet is transmitted to the back-end. Though, the
3156 ;; latter will only retain one type of export-snippet, ignoring
3157 ;; others, based on the former's target back-end. The function
3158 ;; `org-export-snippet-backend' returns that back-end for a given
3159 ;; export-snippet.
3162 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3163 Translation, with `org-export-snippet-translation-alist', is
3164 applied."
3168 back-end))))
3171 ;;;; For Footnotes
3172 ;;
3173 ;; `org-export-collect-footnote-definitions' is a tool to list
3174 ;; actually used footnotes definitions in the whole parse tree, or in
3175 ;; an headline, in order to add footnote listings throughout the
3176 ;; transcoded data.
3177 ;;
3178 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3179 ;; back-ends, when they need to attach the footnote definition only to
3180 ;; the first occurrence of the corresponding label.
3181 ;;
3182 ;; `org-export-get-footnote-definition' and
3183 ;; `org-export-get-footnote-number' provide easier access to
3184 ;; additional information relative to a footnote reference.
3187 "Return an alist between footnote numbers, labels and definitions.
3189 DATA is the parse tree from which definitions are collected.
3190 INFO is the plist used as a communication channel.
3192 Definitions are sorted by order of references. They either
3193 appear as Org data or as a secondary string for inlined
3194 footnotes. Unreferenced definitions are ignored."
3196 collect-fn ; for byte-compiler.
3200 ;; Collect footnote number, label and definition in DATA.
3202 data 'footnote-reference
3209 def)
3210 num-alist)
3211 ;; Also search in definition for nested footnotes.
3214 ;; Don't enter footnote definitions since it will happen
3215 ;; when their first reference is found.
3221 "Non-nil when a footnote reference is the first one for its label.
3223 FOOTNOTE-REFERENCE is the footnote reference being considered.
3224 INFO is the plist used as a communication channel."
3226 ;; Anonymous footnotes are always a first reference.
3228 ;; Otherwise, return the first footnote with the same LABEL and
3229 ;; test if it is equal to FOOTNOTE-REFERENCE.
3235 data 'footnote-reference
3240 ;; If FN isn't inlined, be sure to traverse its
3241 ;; definition before resuming search. See
3242 ;; comments in `org-export-get-footnote-number'
3243 ;; for more information.
3247 ;; Don't enter footnote definitions since it will
3248 ;; happen when their first reference is found.
3251 footnote-reference)))))
3254 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3255 INFO is the plist used as a communication channel."
3261 "Return number associated to a footnote.
3263 FOOTNOTE is either a footnote reference or a footnote definition.
3264 INFO is the plist used as a communication channel."
3266 seen-refs
3267 search-ref ; For byte-compiler.
3271 ;; Search footnote references through DATA, filling
3272 ;; SEEN-REFS along the way.
3274 data 'footnote-reference
3278 ;; Anonymous footnote match: return number.
3281 ;; Labels match: return number.
3284 ;; Anonymous footnote: it's always a new one. Also,
3285 ;; be sure to return nil from the `cond' so
3286 ;; `first-match' doesn't get us out of the loop.
3288 ;; Label not seen so far: add it so SEEN-REFS.
3289 ;;
3290 ;; Also search for subsequent references in
3291 ;; footnote definition so numbering follows reading
3292 ;; logic. Note that we don't have to care about
3293 ;; inline definitions, since `org-element-map'
3294 ;; already traverses them at the right time.
3295 ;;
3296 ;; Once again, return nil to stay in the loop.
3301 nil))))
3302 ;; Don't enter footnote definitions since it will happen
3303 ;; when their first reference is found.
3308 ;;;; For Headlines
3309 ;;
3310 ;; `org-export-get-relative-level' is a shortcut to get headline
3311 ;; level, relatively to the lower headline level in the parsed tree.
3312 ;;
3313 ;; `org-export-get-headline-number' returns the section number of an
3314 ;; headline, while `org-export-number-to-roman' allows to convert it
3315 ;; to roman numbers.
3316 ;;
3317 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3318 ;; `org-export-last-sibling-p' are three useful predicates when it
3319 ;; comes to fulfill the `:headline-levels' property.
3320 ;;
3321 ;; `org-export-get-tags', `org-export-get-category' and
3322 ;; `org-export-get-node-property' extract useful information from an
3323 ;; headline or a parent headline. They all handle inheritance.
3326 "Return HEADLINE relative level within current parsed tree.
3327 INFO is a plist holding contextual information."
3332 "Non-nil when HEADLINE is considered as low level.
3334 INFO is a plist used as a communication channel.
3336 A low level headlines has a relative level greater than
3337 `:headline-levels' property value.
3339 Return value is the difference between HEADLINE relative level
3340 and the last level being considered as high enough, or nil."
3347 "Return HEADLINE numbering as a list of numbers.
3348 INFO is a plist holding contextual information."
3352 "Return a non-nil value if HEADLINE element should be numbered.
3353 INFO is a plist used as a communication channel."
3359 "Convert integer N into a roman numeral."
3372 res)))
3375 "Return list of tags associated to ELEMENT.
3377 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3378 is a plist used as a communication channel.
3380 Select tags (see `org-export-select-tags') and exclude tags (see
3381 `org-export-exclude-tags') are removed from the list.
3383 When non-nil, optional argument TAGS should be a list of strings.
3384 Any tag belonging to this list will also be removed.
3386 When optional argument INHERITED is non-nil, tags can also be
3387 inherited from parent headlines and FILETAGS keywords."
3393 ;; Build complete list of inherited tags.
3404 ;; Add FILETAGS keywords and return results.
3408 "Return node PROPERTY value for BLOB.
3410 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3411 element or object.
3413 If optional argument INHERITED is non-nil, the value can be
3414 inherited from a parent headline.
3416 Return value is a string or nil."
3428 "Return category for element or object BLOB.
3430 INFO is a plist used as a communication channel.
3432 CATEGORY is automatically inherited from a parent headline, from
3433 #+CATEGORY: keyword or created out of original file name. If all
3437 ;; Almost like `org-export-node-property', but we cannot trust
3438 ;; `plist-member' as every headline has a `:category'
3439 ;; property, would it be nil or equal to "???" (which has the
3440 ;; same meaning).
3459 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3460 INFO is a plist used as a communication channel."
3465 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3466 INFO is a plist used as a communication channel."
3470 ;;;; For Links
3471 ;;
3472 ;; `org-export-solidify-link-text' turns a string into a safer version
3473 ;; for links, replacing most non-standard characters with hyphens.
3474 ;;
3475 ;; `org-export-get-coderef-format' returns an appropriate format
3476 ;; string for coderefs.
3477 ;;
3478 ;; `org-export-inline-image-p' returns a non-nil value when the link
3479 ;; provided should be considered as an inline image.
3480 ;;
3481 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3482 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3483 ;; returns an appropriate unique identifier when found, or nil.
3484 ;;
3485 ;; `org-export-resolve-id-link' returns the first headline with
3486 ;; specified id or custom-id in parse tree, the path to the external
3487 ;; file with the id or nil when neither was found.
3488 ;;
3489 ;; `org-export-resolve-coderef' associates a reference to a line
3490 ;; number in the element it belongs, or returns the reference itself
3491 ;; when the element isn't numbered.
3494 "Take link text S and make a safe target out of it."
3499 "Return format string for code reference link.
3500 PATH is the link path. DESC is its description."
3508 "Non-nil if LINK object points to an inline image.
3510 Optional argument is a set of RULES defining inline images. It
3511 is an alist where associations have the following shape:
3513 \(TYPE . REGEXP)
3515 Applying a rule means apply REGEXP against LINK's path when its
3516 type is TYPE. The function will return a non-nil value if any of
3517 the provided rules is non-nil. The default rule is
3518 `org-export-default-inline-image-rule'.
3520 This only applies to links without a description."
3531 rules)
3532 ;; Return nil if no rule matched.
3533 nil))))
3536 "Resolve a code reference REF.
3538 INFO is a plist used as a communication channel.
3540 Return associated line number in source code, or REF itself,
3541 depending on src-block or example element's switches."
3549 org-coderef-label-format)))
3553 ;; Element containing REF is found. Resolve it to either
3554 ;; a label or a line number, as needed.
3564 "Return LINK destination.
3566 INFO is a plist holding contextual information.
3568 Return value can be an object, an element, or nil:
3570 - If LINK path matches a target object (i.e. <<path>>) or
3573 - If LINK path exactly matches the name affiliated keyword
3574 \(i.e. #+NAME: path) of an element, return that element.
3576 - If LINK path exactly matches any headline name, return that
3577 element. If more than one headline share that name, priority
3578 will be given to the one with the closest common ancestor, if
3579 any, or the first one in the parse tree otherwise.
3581 - Otherwise, return nil.
3587 ;; First try to find a matching "<<path>>" unless user specified
3588 ;; he was looking for an headline (path starts with a *
3589 ;; character).
3593 return target)))
3594 ;; Then try to find an element with a matching "#+NAME: path"
3595 ;; affiliated keyword.
3602 ;; Last case: link either points to an headline or to
3603 ;; nothingness. Try to find the source, with priority given to
3604 ;; headlines with the closest common ancestor. If such candidate
3605 ;; is found, return it, otherwise return nil.
3609 ;; Return first headline whose `:raw-value' property
3610 ;; is NAME in parse tree DATA, or nil.
3613 data 'headline
3617 name)
3618 headline))
3620 ;; Search among headlines sharing an ancestor with link,
3621 ;; from closest to farthest.
3629 ;; No match with a common ancestor: try the full parse-tree.
3635 "Return headline referenced as LINK destination.
3637 INFO is a plist used as a communication channel.
3639 Return value can be the headline element matched in current parse
3643 ;; First check if id is within the current parse tree.
3649 headline))
3651 ;; Otherwise, look for external files.
3655 "Return radio-target object referenced as LINK destination.
3657 INFO is a plist used as a communication channel.
3659 Return value can be a radio-target object or nil. Assume LINK
3669 ;;;; For References
3670 ;;
3671 ;; `org-export-get-ordinal' associates a sequence number to any object
3672 ;; or element.
3675 "Return ordinal number of an element or object.
3677 ELEMENT is the element or object considered. INFO is the plist
3678 used as a communication channel.
3680 Optional argument TYPES, when non-nil, is a list of element or
3681 object types, as symbols, that should also be counted in.
3682 Otherwise, only provided element's type is considered.
3684 Optional argument PREDICATE is a function returning a non-nil
3685 value if the current element or object should be counted in. It
3686 accepts two arguments: the element or object being considered and
3687 the plist used as a communication channel. This allows to count
3688 only a certain type of objects (i.e. inline images).
3690 Return value is a list of numbers if ELEMENT is an headline or an
3691 item. It is nil for keywords. It represents the footnote number
3692 for footnote definitions and footnote references. If ELEMENT is
3693 a target, return the same value as if ELEMENT was the closest
3694 table, item or headline containing the target. In any other
3695 case, return the sequence number of ELEMENT among elements or
3696 objects of the same type."
3697 ;; A target keyword, representing an invisible target, never has
3698 ;; a sequence number.
3700 ;; Ordinal of a target object refer to the ordinal of the closest
3701 ;; table, item, or headline containing the object.
3705 when
3709 table))
3710 return parent)))
3712 ;; Special case 1: An headline returns its number as a list.
3714 ;; Special case 2: An item returns its number as a list.
3718 struct
3725 ;; Increment counter until ELEMENT is found again.
3736 ;;;; For Src-Blocks
3737 ;;
3738 ;; `org-export-get-loc' counts number of code lines accumulated in
3739 ;; src-block or example-block elements with a "+n" switch until
3740 ;; a given element, excluded. Note: "-n" switches reset that count.
3741 ;;
3742 ;; `org-export-unravel-code' extracts source code (along with a code
3743 ;; references alist) from an `element-block' or `src-block' type
3744 ;; element.
3745 ;;
3746 ;; `org-export-format-code' applies a formatting function to each line
3747 ;; of code, providing relative line number and code reference when
3748 ;; appropriate. Since it doesn't access the original element from
3749 ;; which the source code is coming, it expects from the code calling
3750 ;; it to know if lines should be numbered and if code references
3751 ;; should appear.
3752 ;;
3753 ;; Eventually, `org-export-format-code-default' is a higher-level
3754 ;; function (it makes use of the two previous functions) which handles
3755 ;; line numbering and code references inclusion, and returns source
3756 ;; code in a format suitable for plain text or verbatim output.
3759 "Return accumulated lines of code up to ELEMENT.
3761 INFO is the plist used as a communication channel.
3763 ELEMENT is excluded from count."
3770 ;; ELEMENT is reached: Quit the loop.
3772 ;; Only count lines from src-block and example-block elements
3773 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3777 ;; Accumulate locs or reset them.
3781 ;; Return nil to stay in the loop.
3782 nil)))
3784 ;; Return value.
3785 loc))
3788 "Clean source code and extract references out of it.
3790 ELEMENT has either a `src-block' an `example-block' type.
3792 Return a cons cell whose CAR is the source code, cleaned from any
3793 reference and protective comma and CDR is an alist between
3794 relative line number (integer) and name of code reference on that
3795 line (string)."
3797 ;; Get code and clean it. Remove blank lines at its
3798 ;; beginning and end.
3804 ;; If appropriate, remove global indentation.
3807 c
3809 ;; Get format used for references.
3812 org-coderef-label-format)))
3813 ;; Build a regexp matching a loc with a reference.
3818 ;; Return value.
3820 ;; Code with references removed.
3826 ;; Ref line: remove ref, and signal its position in REFS.
3830 ;; Reference alist.
3831 refs)))
3834 "Format CODE by applying FUN line-wise and return it.
3836 CODE is a string representing the code to format. FUN is
3837 a function. It must accept three arguments: a line of
3838 code (string), the current line number (integer) or nil and the
3839 reference associated to the current line (string) or nil.
3841 Optional argument NUM-LINES can be an integer representing the
3842 number of code lines accumulated until the current code. Line
3843 numbers passed to FUN will take it into account. If it is nil,
3844 FUN's second argument will always be nil. This number can be
3845 obtained with `org-export-get-loc' function.
3847 Optional argument REF-ALIST can be an alist between relative line
3848 number (i.e. ignoring NUM-LINES) and the name of the code
3849 reference on it. If it is nil, FUN's third argument will always
3850 be nil. It can be obtained through the use of
3851 `org-export-unravel-code' function."
3863 "Return source code from ELEMENT, formatted in a standard way.
3865 ELEMENT is either a `src-block' or `example-block' element. INFO
3866 is a plist used as a communication channel.
3868 This function takes care of line numbering and code references
3869 inclusion. Line numbers, when applicable, appear at the
3870 beginning of the line, separated from the code by two white
3871 spaces. Code references, on the other hand, appear flushed to
3872 the right, separated by six white spaces from the widest line of
3873 code."
3874 ;; Extract code and references.
3880 ;; Handle line numbering.
3889 ;; Prepare references display, if required. Any reference
3890 ;; should start six columns after the widest line of code,
3891 ;; wrapped with parenthesis.
3896 code
3900 number-str
3901 loc
3907 num-start refs)))
3910 ;;;; For Tables
3911 ;;
3912 ;; `org-export-table-has-special-column-p' and and
3913 ;; `org-export-table-row-is-special-p' are predicates used to look for
3914 ;; meta-information about the table structure.
3915 ;;
3916 ;; `org-table-has-header-p' tells when the rows before the first rule
3917 ;; should be considered as table's header.
3918 ;;
3919 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3920 ;; and `org-export-table-cell-borders' extract information from
3921 ;; a table-cell element.
3922 ;;
3923 ;; `org-export-table-dimensions' gives the number on rows and columns
3924 ;; in the table, ignoring horizontal rules and special columns.
3925 ;; `org-export-table-cell-address', given a table-cell object, returns
3926 ;; the absolute address of a cell. On the other hand,
3927 ;; `org-export-get-table-cell-at' does the contrary.
3928 ;;
3929 ;; `org-export-table-cell-starts-colgroup-p',
3930 ;; `org-export-table-cell-ends-colgroup-p',
3931 ;; `org-export-table-row-starts-rowgroup-p',
3932 ;; `org-export-table-row-ends-rowgroup-p',
3933 ;; `org-export-table-row-starts-header-p' and
3934 ;; `org-export-table-row-ends-header-p' indicate position of current
3935 ;; row or cell within the table.
3938 "Non-nil when TABLE has a special column.
3939 All special columns will be ignored during export."
3940 ;; The table has a special column when every first cell of every row
3941 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3942 ;; "*" "_" and "^". Though, do not consider a first row containing
3943 ;; only empty cells as special.
3959 "Non-nil when TABLE has an header.
3961 INFO is a plist used as a communication channel.
3963 A table has an header when it contains at least two row groups."
3966 table 'table-row
3974 info)))
3977 "Non-nil if TABLE-ROW is considered special.
3979 INFO is a plist used as the communication channel.
3981 All special rows will be ignored during export."
3985 ;; A row is special either when...
3987 ;; ... it starts with a field only containing "/",
3989 ;; ... the table contains a special column and the row start
3990 ;; with a marking character among, "^", "_", "$" or "!",
3994 ;; ... it contains only alignment cookies and empty cells.
4000 ;; Since VALUE is a secondary string, the following
4001 ;; checks avoid expanding it with `org-export-data'.
4013 "Return TABLE-ROW's group.
4015 INFO is a plist used as the communication channel.
4017 Return value is the group number, as an integer, or nil special
4018 rows and table rules. Group 1 is also table's header."
4035 "Return TABLE-CELL contents width.
4037 INFO is a plist used as the communication channel.
4039 Return value is the width given by the last width cookie in the
4040 same column as TABLE-CELL, or nil."
4045 cookie-width)
4049 ;; In a special row, try to find a width cookie at COLUMN.
4053 ;; The following checks avoid expanding unnecessarily the
4054 ;; cell with `org-export-data'
4062 ;; Ignore table rules.
4065 ;; Return value.
4066 cookie-width))
4069 "Return TABLE-CELL contents alignment.
4071 INFO is a plist used as the communication channel.
4073 Return alignment as specified by the last alignment cookie in the
4074 same column as TABLE-CELL. If no such cookie is found, a default
4075 alignment value will be deduced from fraction of numbers in the
4076 column (see `org-table-number-fraction' for more information).
4077 Possible values are `left', `right' and `center'."
4084 cookie-align)
4088 ;; In a special row, try to find an alignment cookie at
4089 ;; COLUMN.
4093 ;; Since VALUE is a secondary string, the following checks
4094 ;; avoid useless expansion through `org-export-data'.
4102 ;; Ignore table rules.
4104 ;; In a standard row, check if cell's contents are expressing
4105 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4106 ;; Though, don't bother if an alignment cookie has already
4107 ;; defined cell's alignment.
4112 info)))
4117 ;; Return value. Alignment specified by cookies has precedence
4118 ;; over alignment deduced from cells contents.
4127 "Return TABLE-CELL borders.
4129 INFO is a plist used as a communication channel.
4131 Return value is a list of symbols, or nil. Possible values are:
4132 `top', `bottom', `above', `below', `left' and `right'. Note:
4133 `top' (resp. `bottom') only happen for a cell in the first
4134 row (resp. last row) of the table, ignoring table rules, if any.
4136 Returned borders ignore special rows."
4139 borders)
4140 ;; Top/above border? TABLE-CELL has a border above when a rule
4141 ;; used to demarcate row groups can be found above. Hence,
4142 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4143 ;; another regular row has to be found above that rule.
4152 ;; Look at every row before the current one.
4154 ;; No rule above, or rule found starts the table (ignoring any
4155 ;; special row): TABLE-CELL is at the top of the table.
4158 ;; Bottom/below border? TABLE-CELL has a border below when next
4159 ;; non-regular row below is a rule.
4168 ;; Look at every row after the current one.
4170 ;; No rule below, or rule found ends the table (modulo some
4171 ;; special row): TABLE-CELL is at the bottom of the table.
4174 ;; Right/left borders? They can only be specified by column
4175 ;; groups. Column groups are defined in a row starting with "/".
4176 ;; Also a column groups row only contains "<", "<>", ">" or blank
4177 ;; cells.
4194 ;; There's a left border when previous cell, if
4195 ;; any, ends a group, or current one starts one.
4201 ;; There's a right border when next cell, if any,
4202 ;; starts a group, or current one ends one.
4209 ;; Table rows are read in reverse order so last column groups
4210 ;; row has precedence over any previous one.
4212 ;; Return value.
4213 borders))
4216 "Non-nil when TABLE-CELL is at the beginning of a row group.
4217 INFO is a plist used as a communication channel."
4218 ;; A cell starts a column group either when it is at the beginning
4219 ;; of a row (or after the special column, if any) or when it has
4220 ;; a left border.
4224 table-cell)
4228 "Non-nil when TABLE-CELL is at the end of a row group.
4229 INFO is a plist used as a communication channel."
4230 ;; A cell ends a column group either when it is at the end of a row
4231 ;; or when it has a right border.
4234 table-cell)
4238 "Non-nil when TABLE-ROW is at the beginning of a column group.
4239 INFO is a plist used as a communication channel."
4247 "Non-nil when TABLE-ROW is at the end of a column group.
4248 INFO is a plist used as a communication channel."
4256 "Non-nil when TABLE-ROW is the first table header's row.
4257 INFO is a plist used as a communication channel."
4264 "Non-nil when TABLE-ROW is the last table header's row.
4265 INFO is a plist used as a communication channel."
4272 "Return TABLE dimensions.
4274 INFO is a plist used as a communication channel.
4276 Return value is a CONS like (ROWS . COLUMNS) where
4277 ROWS (resp. COLUMNS) is the number of exportable
4278 rows (resp. columns)."
4280 ;; Set number of rows, and extract first one.
4282 table 'table-row
4287 ;; Set number of columns.
4289 ;; Return value.
4293 "Return address of a regular TABLE-CELL object.
4295 TABLE-CELL is the cell considered. INFO is a plist used as
4296 a communication channel.
4298 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4299 zero-based index. Only exportable cells are considered. The
4300 function returns nil for other cells."
4303 ;; Ignore cells in special rows or in special column.
4308 ;; Row number.
4311 table 'table-row
4317 ;; Column number.
4320 table-row 'table-cell
4326 "Return regular table-cell object at ADDRESS in TABLE.
4328 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4329 zero-based index. TABLE is a table type element. INFO is
4330 a plist used as a communication channel.
4332 If no table-cell, among exportable cells, is found at ADDRESS,
4333 return nil."
4336 ;; Row at (car address) or nil.
4339 table 'table-row
4345 'table-cell
4352 ;;;; For Tables Of Contents
4353 ;;
4354 ;; `org-export-collect-headlines' builds a list of all exportable
4355 ;; headline elements, maybe limited to a certain depth. One can then
4356 ;; easily parse it and transcode it.
4357 ;;
4358 ;; Building lists of tables, figures or listings is quite similar.
4359 ;; Once the generic function `org-export-collect-elements' is defined,
4360 ;; `org-export-collect-tables', `org-export-collect-figures' and
4361 ;; `org-export-collect-listings' can be derived from it.
4364 "Collect headlines in order to build a table of contents.
4366 INFO is a plist used as a communication channel.
4368 When optional argument N is an integer, it specifies the depth of
4369 the table of contents. Otherwise, it is set to the value of the
4370 last headline level. See `org-export-headline-levels' for more
4371 information.
4373 Return a list of all exportable headlines as parsed elements."
4377 'headline
4379 ;; Strip contents from HEADLINE.
4382 info))
4385 "Collect referenceable elements of a determined type.
4387 TYPE can be a symbol or a list of symbols specifying element
4388 types to search. Only elements with a caption are collected.
4390 INFO is a plist used as a communication channel.
4392 When non-nil, optional argument PREDICATE is a function accepting
4393 one argument, an element of type TYPE. It returns a non-nil
4394 value when that element should be collected.
4396 Return a list of all elements found, in order of appearance."
4402 element))
4403 info))
4406 "Build a list of tables.
4407 INFO is a plist used as a communication channel.
4409 Return a list of table elements with a caption."
4413 "Build a list of figures.
4415 INFO is a plist used as a communication channel. PREDICATE is
4416 a function which accepts one argument: a paragraph element and
4417 whose return value is non-nil when that element should be
4418 collected.
4420 A figure is a paragraph type element, with a caption, verifying
4422 a vague concept that may depend on back-end.
4424 Return a list of elements recognized as figures."
4428 "Build a list of src blocks.
4430 INFO is a plist used as a communication channel.
4432 Return a list of src-block elements with a caption."
4436 ;;;; Smart Quotes
4437 ;;
4438 ;; The main function for the smart quotes sub-system is
4439 ;; `org-export-activate-smart-quotes', which replaces every quote in
4440 ;; a given string from the parse tree with its "smart" counterpart.
4441 ;;
4442 ;; Dictionary for smart quotes is stored in
4443 ;; `org-export-smart-quotes-alist'.
4444 ;;
4445 ;; Internally, regexps matching potential smart quotes (checks at
4446 ;; string boundaries are also necessary) are defined in
4447 ;; `org-export-smart-quotes-regexps'.
4484 "Smart quotes translations.
4486 Alist whose CAR is a language string and CDR is an alist with
4487 quote type as key and a plist associating various encodings to
4488 their translation as value.
4490 A quote type can be any symbol among `opening-double-quote',
4491 `closing-double-quote', `opening-single-quote',
4492 `closing-single-quote' and `apostrophe'.
4494 Valid encodings include `:utf-8', `:html', `:latex' and
4495 `:texinfo'.
4501 ;; Possible opening quote at beginning of string.
4503 ;; Possible closing quote at beginning of string.
4505 ;; Possible apostrophe at beginning of string.
4507 ;; Opening single and double quotes.
4509 ;; Closing single and double quotes.
4511 ;; Apostrophe.
4513 ;; Possible opening quote at end of string.
4515 ;; Possible closing quote at end of string.
4517 ;; Possible apostrophe at end of string.
4519 "List of regexps matching a quote or an apostrophe.
4525 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4526 `:utf-8'. INFO is a plist used as a communication channel.
4528 The function has to retrieve information about string
4529 surroundings in parse tree. It can only happen with an
4530 unmodified string. Thus, if S has already been through another
4531 process, a non-nil ORIGINAL optional argument will provide that
4532 original string.
4534 Return the new string."
4541 ;; Return smart quote associated to a give quote Q, as
4542 ;; a string. TYPE is a symbol among `open', `close' and
4543 ;; `apostrophe'.
4553 org-export-smart-quotes-alist))))
4554 encoding)
4555 q)))))
4557 ;; Only a quote: no regexp can match. We have to check both
4558 ;; sides and decide what to do.
4566 ;; 1. Replace quote character at the beginning of S.
4568 ;; Apostrophe?
4574 ;; Closing quote?
4580 ;; Opening quote?
4586 ;; 2. Replace quotes in the middle of the string.
4588 ;; Opening quotes.
4594 ;; Closing quotes.
4600 ;; Apostrophes.
4605 ;; 3. Replace quote character at the end of S.
4607 ;; Apostrophe?
4612 ;; Closing quote?
4618 ;; Opening quote?
4623 ;; Return string with smart quotes.
4624 s))))
4626 ;;;; Topology
4627 ;;
4628 ;; Here are various functions to retrieve information about the
4629 ;; neighbourhood of a given element or object. Neighbours of interest
4630 ;; are direct parent (`org-export-get-parent'), parent headline
4631 ;; (`org-export-get-parent-headline'), first element containing an
4632 ;; object, (`org-export-get-parent-element'), parent table
4633 ;; (`org-export-get-parent-table'), previous element or object
4634 ;; (`org-export-get-previous-element') and next element or object
4635 ;; (`org-export-get-next-element').
4636 ;;
4637 ;; `org-export-get-genealogy' returns the full genealogy of a given
4638 ;; element or object, from closest parent to full parse tree.
4641 "Return BLOB parent or nil.
4642 BLOB is the element or object considered."
4646 "Return full genealogy relative to a given element or object.
4648 BLOB is the element or object being considered.
4650 Ancestors are returned from closest to farthest, the last one
4651 being the full parse tree."
4658 "Return BLOB parent headline or nil.
4659 BLOB is the element or object being considered."
4663 parent))
4666 "Return first element containing OBJECT or nil.
4667 OBJECT is the object to consider."
4671 parent))
4674 "Return OBJECT parent table or nil.
4675 OBJECT is either a `table-cell' or `table-element' type object."
4679 parent))
4682 "Return previous element or object.
4684 BLOB is an element or object. INFO is a plist used as
4685 a communication channel. Return previous exportable element or
4686 object, a string, or nil.
4688 When optional argument N is a positive integer, return a list
4689 containing up to N siblings before BLOB, from closest to
4690 farthest. With any other non-nil value, return a list containing
4691 all of them."
4693 ;; An object can belong to the contents of its parent or
4694 ;; to a secondary string. We check the latter option
4695 ;; first.
4698 org-element-all-elements))
4702 org-element-secondary-value-alist))
4703 parent)))
4706 prev)
4718 "Return next element or object.
4720 BLOB is an element or object. INFO is a plist used as
4721 a communication channel. Return next exportable element or
4722 object, a string, or nil.
4724 When optional argument N is a positive integer, return a list
4725 containing up to N siblings after BLOB, from closest to farthest.
4726 With any other non-nil value, return a list containing all of
4727 them."
4729 ;; An object can belong to the contents of its parent or to
4730 ;; a secondary string. We check the latter option first.
4733 org-element-all-objects))
4737 org-element-secondary-value-alist))
4738 parent)))
4741 next)
4749 siblings)
4753 ;;;; Translation
4754 ;;
4755 ;; `org-export-translate' translates a string according to language
4756 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4757 ;; variable and a specified charset. `org-export-dictionary' contains
4758 ;; the dictionary used for the translation.
4880 "Dictionary for export engine.
4882 Alist whose CAR is the string to translate and CDR is an alist
4883 whose CAR is the language string and CDR is a plist whose
4884 properties are possible charsets and values translated terms.
4886 It is used as a database for `org-export-translate'. Since this
4887 function returns the string as-is if no translation was found,
4888 the variable only needs to record values different from the
4892 "Translate string S according to language specification.
4894 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4895 and `:utf-8'. INFO is a plist used as a communication channel.
4897 Translation depends on `:language' property. Return the
4898 translated string. If no translation is found, try to fall back
4899 to `:default' encoding. If it fails, return S."
4905 s)))
4908 \f
4909 ;;; Asynchronous Export
4910 ;;
4911 ;; `org-export-async-start' is the entry point for asynchronous
4912 ;; export. It recreates current buffer (including visibility,
4913 ;; narrowing and visited file) in an external Emacs process, and
4914 ;; evaluates a command there. It then applies a function on the
4915 ;; returned results in the current process.
4916 ;;
4917 ;; Asynchronously generated results are never displayed directly.
4918 ;; Instead, they are stored in `org-export-stack-contents'. They can
4919 ;; then be retrieved by calling `org-export-stack'.
4920 ;;
4921 ;; Export Stack is viewed through a dedicated major mode
4922 ;;`org-export-stack-mode' and tools: `org-export--stack-refresh',
4923 ;;`org-export--stack-delete', `org-export--stack-view' and
4924 ;;`org-export--stack-clear'.
4925 ;;
4926 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
4927 ;; It should used whenever `org-export-async-start' is called.
4930 "Call function FUN on the results returned by BODY evaluation.
4932 BODY evaluation happens in an asynchronous process, from a buffer
4933 which is an exact copy of the current one.
4935 Use `org-export-add-to-stack' in FUN in order to register results
4936 in the stack. Examples for, respectively a temporary buffer and
4937 a file are:
4939 \(org-export-async-start
4940 \(lambda (output)
4942 \(erase-buffer)
4943 \(insert output)
4944 \(goto-char (point-min))
4945 \(org-export-add-to-stack (current-buffer) 'backend)))
4946 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
4948 and
4950 \(org-export-async-start
4951 \(lambda (f) (org-export-add-to-stack f 'backend))
4952 `(expand-file-name
4953 \(org-export-to-file
4954 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
4957 ;; Write the full sexp evaluating BODY in a copy of the current
4958 ;; buffer to a temporary file, as it may be too long for program
4959 ;; args in `start-process'.
4966 "%S"
4969 ;; Initialize `org-mode' in the external process.
4971 ;; Re-create current buffer there.
4974 ;; Sexp to evaluate in the buffer.
4976 ;; Start external process.
4979 (,process
4984 "-l" org-export-async-init-file
4986 ;; Register running process in stack.
4988 ;; Set-up sentinel in order to catch results.
4990 ,process
5014 "Add a new result to export stack if not present already.
5016 SOURCE is a buffer or a file name containing export results.
5017 BACKEND is a symbol representing export back-end used to generate
5018 it.
5020 Entries already pointing to SOURCE and unavailable entries are
5021 removed beforehand. Return the new stack."
5027 "Menu for asynchronous export results and running processes."
5037 "Return source from export results at point in stack."
5044 source
5045 ;; SOURCE is not consistent with current line. The stack
5046 ;; view is outdated.
5050 "Remove all entries from export stack."
5055 "Refresh the asynchronous export stack.
5056 DUMMY is ignored. Unavailable sources are removed from the list.
5057 Return the new stack."
5067 ;; Back-end.
5069 ;; Age.
5072 ;; Compute age of the results.
5074 "%4h:%.2m "
5076 ;; Source.
5081 ;; Clear stack from exited processes, dead buffers or
5082 ;; non-existent files.
5094 "Remove export results at point from stack.
5095 If optional argument SOURCE is non-nil, remove it instead."
5100 org-export-stack-contents))))
5103 "View export results at point in stack.
5104 With an optional prefix argument IN-EMACS, force viewing files
5105 within Emacs."
5119 (define-key km "p" 'previous-line)
5120 (define-key km "\C-p" 'previous-line)
5121 (define-key km "\C-?" 'previous-line)
5122 (define-key km [up] 'previous-line)
5123 (define-key km "C" 'org-export--stack-clear)
5124 (define-key km "v" 'org-export--stack-view)
5125 (define-key km (kbd "RET") 'org-export--stack-view)
5126 (define-key km "d" 'org-export--stack-remove)
5127 km)
5128 "Keymap for Org Export Stack.")
5130 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5131 "Mode for displaying asynchronous export stack.
5134 stack.
5136 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export--stack-view] to view export output
5137 on current line, \\[org-export--stack-remove] to remove it from the stack and \\[org-export--stack-clear] to clear
5138 stack completely.
5140 Removal entries in an Org Export Stack buffer doesn't affect
5141 files or buffers, only view in the stack.
5144 (abbrev-mode 0)
5145 (auto-fill-mode 0)
5146 (setq buffer-read-only t
5147 buffer-undo-list t
5148 truncate-lines t
5149 header-line-format
5150 '(:eval
5151 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5152 (add-hook 'post-command-hook 'org-export--stack-refresh nil t)
5153 (set (make-local-variable 'revert-buffer-function)
5154 'org-export--stack-refresh))
5157 \f
5158 ;;; The Dispatcher
5159 ;;
5160 ;; `org-export-dispatch' is the standard interactive way to start an
5161 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
5162 ;; for its interface, which, in turn, delegates response to key
5163 ;; pressed to `org-export-dispatch-action'.
5165 ;;;###autoload
5166 (defun org-export-dispatch (&optional arg)
5167 "Export dispatcher for Org mode.
5169 It provides an access to common export related tasks in a buffer.
5170 Its interface comes in two flavours: standard and expert. While
5171 both share the same set of bindings, only the former displays the
5172 valid keys associations. Set `org-export-dispatch-use-expert-ui'
5173 to switch to one or the other.
5175 When called with C-u prefix ARG, repeat the last export action,
5176 with the same set of options used back then, on the current
5177 buffer.
5179 When called with a double universal argument, display the
5180 asynchronous export stack directly."
5181 (interactive "P")
5182 (let* ((input
5183 (cond ((equal arg '(16)) '(stack))
5184 ((and arg org-export-dispatch-last-action))
5185 (t (save-window-excursion
5186 (unwind-protect
5187 ;; Store this export command.
5188 (setq org-export-dispatch-last-action
5189 (org-export-dispatch-ui
5190 (list org-export-initial-scope
5191 (and org-export-in-background 'async))
5192 nil
5193 org-export-dispatch-use-expert-ui))
5194 (and (get-buffer "*Org Export Dispatcher*")
5195 (kill-buffer "*Org Export Dispatcher*")))))))
5196 (action (car input))
5197 (optns (cdr input)))
5198 (case action
5199 ;; First handle special hard-coded actions.
5200 (stack (org-export-stack))
5201 (publish-current-file
5202 (org-e-publish-current-file (memq 'force optns) (memq 'async optns)))
5203 (publish-current-project
5204 (org-e-publish-current-project (memq 'force optns) (memq 'async optns)))
5205 (publish-choose-project
5206 (org-e-publish (assoc (org-icompleting-read
5207 "Publish project: "
5208 org-e-publish-project-alist nil t)
5209 org-e-publish-project-alist)
5210 (memq 'force optns)
5211 (memq 'async optns)))
5212 (publish-all (org-e-publish-all (memq 'force optns) (memq 'async optns)))
5213 (otherwise (funcall action
5214 ;; Return a symbol instead of a list to ease
5215 ;; asynchronous export macro use.
5216 (and (memq 'async optns) t)
5217 (and (memq 'subtree optns) t)
5218 (and (memq 'visible optns) t)
5219 (and (memq 'body optns) t))))))
5221 (defun org-export-dispatch-ui (options first-key expertp)
5222 "Handle interface for `org-export-dispatch'.
5224 OPTIONS is a list containing current interactive options set for
5225 export. It can contain any of the following symbols:
5226 `body' toggles a body-only export
5227 `subtree' restricts export to current subtree
5228 `visible' restricts export to visible part of buffer.
5229 `force' force publishing files.
5230 `async' use asynchronous export process
5232 FIRST-KEY is the key pressed to select the first level menu. It
5233 is nil when this menu hasn't been selected yet.
5235 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5236 buffer is provided, but indications about currently active
5237 options are given in the prompt. Moreover, \[?] allows to switch
5238 back to standard interface."
5239 (let* ((fontify-key
5240 (lambda (key &optional access-key)
5241 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5242 ;; non-nil is the required first-level key to activate
5243 ;; KEY. When its value is t, activate KEY independently
5244 ;; on the first key, if any. A nil value means KEY will
5245 ;; only be activated at first level.
5246 (if (or (eq access-key t) (eq access-key first-key))
5247 (org-add-props key nil 'face 'org-warning)
5248 (org-no-properties key))))
5249 ;; Prepare menu entries by extracting them from
5250 ;; `org-export-registered-backends', and sorting them by
5251 ;; access key and by ordinal, if any.
5252 (backends (sort
5253 (sort
5254 (delq nil
5255 (mapcar (lambda (b)
5256 (org-export-backend-menu (car b)))
5257 org-export-registered-backends))
5258 (lambda (a b)
5259 (let ((key-a (nth 1 a))
5260 (key-b (nth 1 b)))
5261 (cond ((and (numberp key-a) (numberp key-b))
5262 (< key-a key-b))
5263 ((numberp key-b) t)))))
5264 (lambda (a b) (< (car a) (car b)))))
5265 ;; Compute a list of allowed keys based on the first key
5266 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4, ?5 and ?q)
5267 ;; are always available.
5268 (allowed-keys
5269 (nconc (list ?1 ?2 ?3 ?4 ?5)
5270 (if (not first-key) (org-uniquify (mapcar 'car backends))
5271 (let (sub-menu)
5272 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5273 (when (eq (car backend) first-key)
5274 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5275 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5276 ((not first-key) (list ?P)))
5277 (list ?&)
5278 (when expertp (list ??))
5279 (list ?q)))
5280 ;; Build the help menu for standard UI.
5281 (help
5282 (unless expertp
5283 (concat
5284 ;; Options are hard-coded.
5285 (format "Options
5286 [%s] Body only: %s [%s] Visible only: %s
5287 [%s] Export scope: %s [%s] Force publishing: %s
5289 (funcall fontify-key "1" t)
5290 (if (memq 'body options) "On " "Off")
5291 (funcall fontify-key "2" t)
5292 (if (memq 'visible options) "On " "Off")
5293 (funcall fontify-key "3" t)
5294 (if (memq 'subtree options) "Subtree" "Buffer ")
5295 (funcall fontify-key "4" t)
5296 (if (memq 'force options) "On " "Off")
5297 (funcall fontify-key "5" t)
5298 (if (memq 'async options) "On " "Off"))
5299 ;; Display registered back-end entries. When a key
5300 ;; appears for the second time, do not create another
5301 ;; entry, but append its sub-menu to existing menu.
5302 (let (last-key)
5303 (mapconcat
5304 (lambda (entry)
5305 (let ((top-key (car entry)))
5306 (concat
5307 (unless (eq top-key last-key)
5308 (setq last-key top-key)
5310 (funcall fontify-key (char-to-string top-key))
5311 (nth 1 entry)))
5312 (let ((sub-menu (nth 2 entry)))
5313 (unless (functionp sub-menu)
5314 ;; Split sub-menu into two columns.
5315 (let ((index -1))
5316 (concat
5317 (mapconcat
5318 (lambda (sub-entry)
5319 (incf index)
5320 (format
5321 (if (zerop (mod index 2)) " [%s] %-24s"
5323 (funcall fontify-key
5324 (char-to-string (car sub-entry))
5325 top-key)
5326 (nth 1 sub-entry)))
5327 sub-menu "")
5329 backends ""))
5330 ;; Publishing menu is hard-coded.
5332 [%s] Current file [%s] Current project
5334 (funcall fontify-key "P")
5335 (funcall fontify-key "f" ?P)
5336 (funcall fontify-key "p" ?P)
5337 (funcall fontify-key "x" ?P)
5338 (funcall fontify-key "a" ?P))
5340 (format "\[%s] %s"
5341 (funcall fontify-key "q" t)
5342 (if first-key "Main menu" "Exit")))))
5343 ;; Build prompts for both standard and expert UI.
5344 (standard-prompt (unless expertp "Export command: "))
5345 (expert-prompt
5346 (when expertp
5347 (format
5348 "Export command (Options: %s%s%s%s%s) [%s]: "
5349 (if (memq 'body options) (funcall fontify-key "b" t) "-")
5350 (if (memq 'visible options) (funcall fontify-key "v" t) "-")
5351 (if (memq 'subtree options) (funcall fontify-key "s" t) "-")
5352 (if (memq 'force options) (funcall fontify-key "f" t) "-")
5353 (if (memq 'async options) (funcall fontify-key "a" t) "-")
5354 (concat allowed-keys)))))
5355 ;; With expert UI, just read key with a fancy prompt. In standard
5356 ;; UI, display an intrusive help buffer.
5357 (if expertp
5358 (org-export-dispatch-action
5359 expert-prompt allowed-keys backends options first-key expertp)
5360 ;; At first call, create frame layout in order to display menu.
5361 (unless (get-buffer "*Org Export Dispatcher*")
5362 (delete-other-windows)
5363 (org-switch-to-buffer-other-window
5364 (get-buffer-create "*Org Export Dispatcher*"))
5365 (setq cursor-type nil))
5366 ;; At this point, the buffer containing the menu exists and is
5367 ;; visible in the current window. So, refresh it.
5368 (with-current-buffer "*Org Export Dispatcher*"
5369 (erase-buffer)
5370 (insert help))
5371 (org-fit-window-to-buffer)
5372 (org-export-dispatch-action
5373 standard-prompt allowed-keys backends options first-key expertp))))
5375 (defun org-export-dispatch-action
5376 (prompt allowed-keys backends options first-key expertp)
5377 "Read a character from command input and act accordingly.
5379 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5380 a list of characters available at a given step in the process.
5381 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5382 EXPERTP are the same as defined in `org-export-dispatch-ui',
5383 which see.
5385 Toggle export options when required. Otherwise, return value is
5386 a list with action as CAR and a list of interactive export
5387 options as CDR."
5388 (let ((key (let ((k (read-char-exclusive prompt)))
5389 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
5390 ;; depending on user's key pressed.
5391 (if (< k 27) (+ k 96) k))))
5392 (cond
5393 ;; Ignore non-standard characters (i.e. "M-a") and
5394 ;; undefined associations.
5395 ((not (memq key allowed-keys))
5396 (ding)
5397 (unless expertp (message "Invalid key") (sit-for 1))
5398 (org-export-dispatch-ui options first-key expertp))
5399 ;; q key at first level aborts export. At second
5400 ;; level, cancel first key instead.
5401 ((eq key ?q) (if (not first-key) (error "Export aborted")
5402 (org-export-dispatch-ui options nil expertp)))
5403 ;; Help key: Switch back to standard interface if
5404 ;; expert UI was active.
5405 ((eq key ??) (org-export-dispatch-ui options first-key nil))
5406 ;; Switch to asynchronous export stack.
5407 ((eq key ?&) '(stack))
5408 ;; Toggle export options.
5409 ((memq key '(?1 ?2 ?3 ?4 ?5))
5410 (org-export-dispatch-ui
5411 (let ((option (case key (?1 'body) (?2 'visible) (?3 'subtree)
5412 (?4 'force) (?5 'async))))
5413 (if (memq option options) (remq option options)
5414 (cons option options)))
5415 first-key expertp))
5416 ;; Action selected: Send key and options back to
5417 ;; `org-export-dispatch'.
5418 ((or first-key (functionp (nth 2 (assq key backends))))
5419 (cons (cond
5420 ((not first-key) (nth 2 (assq key backends)))
5421 ;; Publishing actions are hard-coded. Send a special
5422 ;; signal to `org-export-dispatch'.
5423 ((eq first-key ?P)
5424 (case key
5425 (?f 'publish-current-file)
5426 (?p 'publish-current-project)
5427 (?x 'publish-choose-project)
5428 (?a 'publish-all)))
5429 ;; Return first action associated to FIRST-KEY + KEY
5430 ;; path. Indeed, derived backends can share the same
5431 ;; FIRST-KEY.
5432 (t (catch 'found
5433 (mapc (lambda (backend)
5434 (let ((match (assq key (nth 2 backend))))
5435 (when match (throw 'found (nth 2 match)))))
5436 (member (assq first-key backends) backends)))))
5437 options))
5438 ;; Otherwise, enter sub-menu.
5439 (t (org-export-dispatch-ui options key expertp)))))
5442 (provide 'org-export)
5443 ;;; org-export.el ends here