| blob | 00eaad0eded39d58df73f45cf83544fa8c0cef7a |
1 ;;; org-export.el --- Generic Export Engine For Org
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
22 ;;
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
25 ;;
26 ;; Besides that parser, the generic exporter is made of three distinct
27 ;; parts:
28 ;;
29 ;; - The communication channel consists in a property list, which is
30 ;; created and updated during the process. Its use is to offer
31 ;; every piece of information, would it be about initial environment
32 ;; or contextual data, all in a single place. The exhaustive list
33 ;; of properties is given in "The Communication Channel" section of
34 ;; this file.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core function is `org-export-as'. It returns the transcoded
48 ;; buffer as a string.
49 ;;
50 ;; An export back-end is defined with `org-export-define-backend',
51 ;; which 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 determine 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 KEYWORD and OPTION have precedence over DEFAULT.
168 All these properties should be back-end agnostic. Back-end
169 specific properties are set through `org-export-define-backend'.
173 "List of in-buffer keywords that require special treatment.
174 These keywords are not directly associated to a property. The
175 way they are handled must be hard-coded into
235 "Alist between filters properties and initial values.
237 The key of each association is a property name accessible through
238 the communication channel. Its value is a configurable global
239 variable defining initial filters.
241 This list is meant to install user specified filters. Back-end
242 developers may install their own filters using
243 `org-export-define-backend'. Filters defined there will always
244 be prepended to the current list, so they always get applied
253 "Default rule for link matching an inline image.
254 This rule applies to links with no description. By default, it
255 will be considered as an inline image if it targets a local file
258 See `org-export-inline-image-p' for more information about
262 "Non-nil means asynchronous export process should leave data behind.
266 located in `temporary-file-directory'.
268 When non-nil, it will also set `debug-on-error' to a non-nil
272 "Record asynchronously generated export results and processes.
273 This is an alist: its CAR is the source of the
274 result (destination file or buffer for a finished process,
275 original buffer for a running one) and its CDR is a list
276 containing the back-end used, as a symbol, and either a process
277 or the time at which it finished. It is used to build the menu
281 "List of backends currently available in the exporter.
283 A backend is stored as a list where CAR is its name, as a symbol,
284 and CDR is a plist with the following properties:
285 `:filters-alist', `:menu-entry', `:options-alist' and
286 `:translate-alist'.
288 This variable is set with `org-export-define-backend' and
292 "Last command called from the dispatcher.
293 The value should be a list. Its CAR is the action, as a symbol,
297 \f
298 ;;; User-configurable Variables
299 ;;
300 ;; Configuration for the masses.
301 ;;
302 ;; They should never be accessed directly, as their value is to be
303 ;; stored in a property list (cf. `org-export-options-alist').
304 ;; Back-ends will read their value from there instead.
307 "Options for exporting Org mode files."
312 "General options for export engine."
317 "Whether sub-trees with the ARCHIVE tag should be exported.
319 This can have three different values:
320 nil Do not export, pretend this tree is not present.
321 t Do export the entire tree.
322 `headline' Only export the headline, but skip the tree below it.
324 This option can also be set with the #+OPTIONS line,
333 "Non-nil means insert author name into the exported file.
334 This option can also be set with the #+OPTIONS line,
340 "Non-nil means export CLOCK keywords.
341 This option can also be set with the #+OPTIONS line,
347 "Non-nil means the postamble should contain a creator sentence.
349 The sentence can be set in `org-export-creator-string' and
352 If the value is `comment' insert it as a comment."
360 "Non-nil means insert date in the exported document.
361 This options can also be set with the OPTIONS keyword,
367 emacs-version)
368 "String to insert at the end of the generated document."
373 "Non-nil means export contents of standard drawers.
375 When t, all drawers are exported. This may also be a list of
376 drawer names to export. This variable doesn't apply to
377 properties drawers.
379 This option can also be set with the #+OPTIONS line,
389 "Non-nil means insert author email into the exported file.
390 This option can also be set with the #+OPTIONS line,
396 "Non-nil means interpret *word*, /word/, _word_ and +word+.
398 If the export target supports emphasizing text, the word will be
399 typeset in bold, italic, with an underline or strike-through,
400 respectively.
407 "Tags that exclude a tree from export.
409 All trees carrying any of these tags will be excluded from
410 export. This is without condition, so even subtrees inside that
411 carry one of the `org-export-select-tags' will be removed.
413 This option can also be set with the #+EXCLUDE_TAGS: keyword."
420 This can be used to have pre-formatted text, fragments of code
421 etc. For example:
422 : ;; Some Lisp examples
423 : (while (defc cnt)
424 : (ding))
425 will be looking just like this in also HTML. See also the QUOTE
426 keyword. Not all export backends support this.
433 "Non-nil means Org footnotes should be exported.
434 This option can also be set with the #+OPTIONS line,
440 "The last level which is still exported as a headline.
442 Inferior levels will produce itemize lists when exported.
449 "The default language for export and clocktable translations, as a string.
450 This may have an association in
451 `org-clock-clocktable-language-setup'."
456 "Non-nil means preserve all line breaks when exporting.
458 Normally, in HTML output paragraphs will be reformatted.
460 This option can also be set with the #+OPTIONS line,
466 "Non-nil means interpret entities when exporting.
469 Å.
471 For a list of supported names, see the constant `org-entities'
472 and the user option `org-entities-user'.
474 This option can also be set with the #+OPTIONS line,
480 "Non-nil means inlinetasks should be exported.
481 This option can also be set with the #+OPTIONS line,
487 "Non-nil means include planning info in export.
488 This option can also be set with the #+OPTIONS: line,
494 "Non-nil means include priority cookies in export.
495 This option can also be set with the #+OPTIONS line,
501 "Non-nil means add section numbers to headlines when exporting.
503 When set to an integer n, numbering will only happen for
504 headlines whose relative level is higher or equal to n.
506 This option can also be set with the #+OPTIONS line,
512 "Tags that select a tree for export.
514 If any such tag is found in a buffer, all trees that do not carry
515 one of these tags will be ignored during export. Inside trees
516 that are selected like this, you can still deselect a subtree by
517 tagging it with one of the `org-export-exclude-tags'.
519 This option can also be set with the #+SELECT_TAGS: keyword."
524 "Non-nil means activate smart quotes during export.
525 This option can also be set with the #+OPTIONS: line,
533 When this option is turned on, these strings will be exported as:
535 Org HTML LaTeX UTF-8
536 -----+----------+--------+-------
538 -- – -- –
539 --- — --- —
542 This option can also be set with the #+OPTIONS line,
548 "Non-nil means include statistics cookies in export.
549 This option can also be set with the #+OPTIONS: line,
557 When this option is turned on, you can use TeX-like syntax for
559 will be considered as a single item - so grouping with {} is
560 normally not needed. For example, the following things will be
561 parsed as single sub- or superscripts.
563 10^24 or 10^tau several digits will be considered 1 item.
564 10^-12 or 10^-tau a leading sign with digits or a word
565 x^2-y^3 will be read as x^2 - y^3, because items are
566 terminated by almost any nonword/nondigit char.
567 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
569 Still, ambiguity is possible - so when in doubt use {} to enclose
570 the sub/superscript. If you set this variable to the symbol
571 `{}', the braces are *required* in order to trigger
572 interpretations as sub/superscript. This can be helpful in
575 This option can also be set with the #+OPTIONS line,
584 "Non-nil means create a table of contents in exported files.
586 The TOC contains headlines with levels up
587 to`org-export-headline-levels'. When an integer, include levels
588 up to N in the toc, this may then be different from
589 `org-export-headline-levels', but it will not be allowed to be
590 larger than the number of headline levels. When nil, no table of
591 contents is made.
593 This option can also be set with the #+OPTIONS line,
603 For example:
605 | Name | Address | Birthday |
606 |-------------+----------+-----------|
607 | Arthur Dent | England | 29.2.2100 |
614 "If nil, do not export tags, just remove them from headlines.
616 If this is the symbol `not-in-toc', tags will be removed from
617 table of contents entries, but still be shown in the headlines of
618 the document.
620 This option can also be set with the #+OPTIONS line,
629 "Non-nil means include TODO items for export.
631 This may have the following values:
632 t include tasks independent of state.
633 `todo' include only tasks that are not yet done.
634 `done' include only tasks that are already done.
635 nil ignore all tasks.
636 list of keywords include tasks with these keywords.
638 This option can also be set with the #+OPTIONS line,
650 "Non-nil means insert a time stamp into the exported file.
651 The time stamp shows when the file was created.
653 This option can also be set with the #+OPTIONS line,
659 "Non nil means allow timestamps in export.
661 It can be set to `active', `inactive', t or nil, in order to
662 export, respectively, only active timestamps, only inactive ones,
663 all of them or none.
665 This option can also be set with the #+OPTIONS line, e.g.
675 "Non-nil means include TODO keywords in export.
676 When nil, remove all these keywords from the export."
681 "Non-nil means allow #+BIND to define local variable values for export.
682 This is a potential security risk, which is why the user must
683 confirm the use of these lines."
691 "Alist between export snippets back-ends and exporter back-ends.
693 This variable allows to provide shortcuts for export snippets.
697 HTML code while every other back-end will ignore it."
705 "Coding system for the exported file."
710 "Non-nil means exported stuff will also be pushed onto the kill ring."
715 "The initial scope when exporting with `org-export-dispatch'.
716 This variable can be either set to `buffer' or `subtree'."
723 "Non-nil means show buffer after exporting to temp buffer.
724 When Org exports to a file, the buffer visiting that file is ever
725 shown, but remains buried. However, when exporting to
726 a temporary buffer, that buffer is popped up in a second window.
727 When this variable is nil, the buffer remains buried also in
728 these cases."
733 "Non-nil means export and publishing commands will run in background.
734 Results from an asynchronous export are never displayed. You can
740 "File used to initialize external export process.
741 Value must be an absolute file name. It defaults to user's
742 initialization file. Though, a specific configuration makes the
743 process faster and the export more portable."
748 "Non-nil means using a non-intrusive `org-export-dispatch'.
749 In that case, no help buffer is displayed. Though, an indicator
754 be passed the FORCE argument). Also, \[?] allows to switch back
755 to standard mode."
760 \f
761 ;;; Defining Back-ends
762 ;;
763 ;; `org-export-define-backend' is the standard way to define an export
764 ;; back-end. It allows to specify translators, filters, buffer
765 ;; options and a menu entry. If the new back-end shares translators
766 ;; with another back-end, `org-export-define-derived-backend' may be
767 ;; used instead.
768 ;;
769 ;; Internally, a back-end is stored as a list, of which CAR is the
770 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
771 ;; properties of a given back-end are: `org-export-backend-filters',
772 ;; `org-export-backend-menu', `org-export-backend-options' and
773 ;; `org-export-backend-translate-table'.
774 ;;
775 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
776 ;; when a given back-end hasn't been registered yet.
779 "Define a new back-end BACKEND.
781 TRANSLATORS is an alist between object or element types and
782 functions handling them.
784 These functions should return a string without any trailing
785 space, or nil. They must accept three arguments: the object or
786 element itself, its contents or nil when it isn't recursive and
787 the property list used as a communication channel.
789 Contents, when not nil, are stripped from any global indentation
790 \(although the relative one is preserved). They also always end
791 with a single newline character.
793 If, for a given type, no function is found, that element or
794 object type will simply be ignored, along with any blank line or
795 white space at its end. The same will happen if the function
796 returns the nil value. If that function returns the empty
797 string, the type will be ignored, but the blank lines or white
798 spaces will be kept.
800 In addition to element and object types, one function can be
801 associated to the `template' symbol and another one to the
802 `plain-text' symbol.
804 The former returns the final transcoded string, and can be used
805 to add a preamble and a postamble to document's body. It must
806 accept two arguments: the transcoded string and the property list
807 containing export options.
809 The latter, when defined, is to be called on every text not
810 recognized as an element or an object. It must accept two
811 arguments: the text string and the information channel. It is an
812 appropriate place to protect special chars relative to the
813 back-end.
815 BODY can start with pre-defined keyword arguments. The following
816 keywords are understood:
818 :export-block
820 String, or list of strings, representing block names that
821 will not be parsed. This is used to specify blocks that will
822 contain raw code specific to the back-end. These blocks
823 still have to be handled by the relative `export-block' type
824 translator.
826 :filters-alist
828 Alist between filters and function, or list of functions,
829 specific to the back-end. See `org-export-filters-alist' for
830 a list of all allowed filters. Filters defined here
831 shouldn't make a back-end test, as it may prevent back-ends
832 derived from this one to behave properly.
834 :menu-entry
836 Menu entry for the export dispatcher. It should be a list
837 like:
839 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
841 where :
843 KEY is a free character selecting the back-end.
845 DESCRIPTION-OR-ORDINAL is either a string or a number.
847 If it is a string, is will be used to name the back-end in
848 its menu entry. If it is a number, the following menu will
849 be displayed as a sub-menu of the back-end with the same
850 KEY. Also, the number will be used to determine in which
851 order such sub-menus will appear (lowest first).
853 ACTION-OR-MENU is either a function or an alist.
855 If it is an action, it will be called with four
856 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
857 BODY-ONLY. See `org-export-as' for further explanations on
858 some of them.
860 If it is an alist, associations should follow the
861 pattern:
863 \(KEY DESCRIPTION ACTION)
865 where KEY, DESCRIPTION and ACTION are described above.
867 Valid values include:
871 or
876 \(lambda (a s v b)
877 \(if a (org-e-latex-export-to-pdf t s v b)
878 \(org-open-file
879 \(org-e-latex-export-to-pdf nil s v b)))))))
881 or the following, which will be added to the previous
882 sub-menu,
884 \(?l 1
888 :options-alist
890 Alist between back-end specific properties introduced in
891 communication channel and how their value are acquired. See
892 `org-export-options-alist' for more information about
893 structure of the values."
912 ;; Register back-end.
916 ;; Tell parser to not parse EXPORT-BLOCK blocks.
923 ;; Splice in the body, if any.
927 "Create a new back-end as a variant of an existing one.
929 CHILD is the name of the derived back-end. PARENT is the name of
930 the parent back-end.
932 BODY can start with pre-defined keyword arguments. The following
933 keywords are understood:
935 :export-block
937 String, or list of strings, representing block names that
938 will not be parsed. This is used to specify blocks that will
939 contain raw code specific to the back-end. These blocks
940 still have to be handled by the relative `export-block' type
941 translator.
943 :filters-alist
945 Alist of filters that will overwrite or complete filters
946 defined in PARENT back-end. See `org-export-filters-alist'
947 for a list of allowed filters.
949 :menu-entry
951 Menu entry for the export dispatcher. See
952 `org-export-define-backend' for more information about the
953 expected value.
955 :options-alist
957 Alist of back-end specific properties that will overwrite or
958 complete those defined in PARENT back-end. Refer to
959 `org-export-options-alist' for more information about
960 structure of the values.
962 :translate-alist
964 Alist of element and object types and transcoders that will
965 overwrite or complete transcode table from PARENT back-end.
966 Refer to `org-export-define-backend' for detailed information
967 about transcoders.
970 as a variant of `e-latex' back-end with a custom template
971 function:
973 \(org-export-define-derived-backend my-latex e-latex
974 :translate-alist ((template . my-latex-template-fun)))
976 The back-end could then be called with, for example:
1004 ;; Register back-end.
1008 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1015 ;; Splice in the body, if any.
1019 "Return filters for BACKEND."
1024 "Return menu entry for BACKEND."
1029 "Return export options for BACKEND."
1034 "Return translate table for BACKEND."
1039 "Signal an error if BACKEND isn't defined."
1044 "Non-nil if BACKEND is derived from one of BACKENDS."
1049 org-export-registered-backends))
1051 parent))
1054 \f
1055 ;;; The Communication Channel
1056 ;;
1057 ;; During export process, every function has access to a number of
1058 ;; properties. They are of two types:
1059 ;;
1060 ;; 1. Environment options are collected once at the very beginning of
1061 ;; the process, out of the original buffer and configuration.
1062 ;; Collecting them is handled by `org-export-get-environment'
1063 ;; function.
1064 ;;
1065 ;; Most environment options are defined through the
1066 ;; `org-export-options-alist' variable.
1067 ;;
1068 ;; 2. Tree properties are extracted directly from the parsed tree,
1069 ;; just before export, by `org-export-collect-tree-properties'.
1070 ;;
1071 ;; Here is the full list of properties available during transcode
1072 ;; process, with their category and their value type.
1073 ;;
1074 ;; + `:author' :: Author's name.
1075 ;; - category :: option
1076 ;; - type :: string
1077 ;;
1078 ;; + `:back-end' :: Current back-end used for transcoding.
1079 ;; - category :: tree
1080 ;; - type :: symbol
1081 ;;
1082 ;; + `:creator' :: String to write as creation information.
1083 ;; - category :: option
1084 ;; - type :: string
1085 ;;
1086 ;; + `:date' :: String to use as date.
1087 ;; - category :: option
1088 ;; - type :: string
1089 ;;
1090 ;; + `:description' :: Description text for the current data.
1091 ;; - category :: option
1092 ;; - type :: string
1093 ;;
1094 ;; + `:email' :: Author's email.
1095 ;; - category :: option
1096 ;; - type :: string
1097 ;;
1098 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1099 ;; process.
1100 ;; - category :: option
1101 ;; - type :: list of strings
1102 ;;
1103 ;; + `:exported-data' :: Hash table used for memoizing
1104 ;; `org-export-data'.
1105 ;; - category :: tree
1106 ;; - type :: hash table
1107 ;;
1108 ;; + `:filetags' :: List of global tags for buffer. Used by
1109 ;; `org-export-get-tags' to get tags with inheritance.
1110 ;; - category :: option
1111 ;; - type :: list of strings
1112 ;;
1113 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1114 ;; their definition, as parsed data. Only non-inlined footnotes
1115 ;; are represented in this alist. Also, every definition isn't
1116 ;; guaranteed to be referenced in the parse tree. The purpose of
1117 ;; this property is to preserve definitions from oblivion
1118 ;; (i.e. when the parse tree comes from a part of the original
1119 ;; buffer), it isn't meant for direct use in a back-end. To
1120 ;; retrieve a definition relative to a reference, use
1121 ;; `org-export-get-footnote-definition' instead.
1122 ;; - category :: option
1123 ;; - type :: alist (STRING . LIST)
1124 ;;
1125 ;; + `:headline-levels' :: Maximum level being exported as an
1126 ;; headline. Comparison is done with the relative level of
1127 ;; headlines in the parse tree, not necessarily with their
1128 ;; actual level.
1129 ;; - category :: option
1130 ;; - type :: integer
1131 ;;
1132 ;; + `:headline-offset' :: Difference between relative and real level
1133 ;; of headlines in the parse tree. For example, a value of -1
1134 ;; means a level 2 headline should be considered as level
1135 ;; 1 (cf. `org-export-get-relative-level').
1136 ;; - category :: tree
1137 ;; - type :: integer
1138 ;;
1139 ;; + `:headline-numbering' :: Alist between headlines and their
1140 ;; numbering, as a list of numbers
1141 ;; (cf. `org-export-get-headline-number').
1142 ;; - category :: tree
1143 ;; - type :: alist (INTEGER . LIST)
1144 ;;
1145 ;; + `:id-alist' :: Alist between ID strings and destination file's
1146 ;; path, relative to current directory. It is used by
1147 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1148 ;; external file.
1149 ;; - category :: option
1150 ;; - type :: alist (STRING . STRING)
1151 ;;
1152 ;; + `:ignore-list' :: List of elements and objects that should be
1153 ;; ignored during export.
1154 ;; - category :: tree
1155 ;; - type :: list of elements and objects
1156 ;;
1157 ;; + `:input-file' :: Full path to input file, if any.
1158 ;; - category :: option
1159 ;; - type :: string or nil
1160 ;;
1161 ;; + `:keywords' :: List of keywords attached to data.
1162 ;; - category :: option
1163 ;; - type :: string
1164 ;;
1165 ;; + `:language' :: Default language used for translations.
1166 ;; - category :: option
1167 ;; - type :: string
1168 ;;
1169 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1170 ;; transcoding.
1171 ;; - category :: option
1172 ;; - type :: list (as returned by `org-element-parse-buffer')
1173 ;;
1174 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1175 ;; all line breaks.
1176 ;; - category :: option
1177 ;; - type :: symbol (nil, t)
1178 ;;
1179 ;; + `:section-numbers' :: Non-nil means transcoding should add
1180 ;; section numbers to headlines.
1181 ;; - category :: option
1182 ;; - type :: symbol (nil, t)
1183 ;;
1184 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1185 ;; in transcoding. When such a tag is present, subtrees without
1186 ;; it are de facto excluded from the process. See
1187 ;; `use-select-tags'.
1188 ;; - category :: option
1189 ;; - type :: list of strings
1190 ;;
1191 ;; + `:target-list' :: List of targets encountered in the parse tree.
1192 ;; This is used to partly resolve "fuzzy" links
1193 ;; (cf. `org-export-resolve-fuzzy-link').
1194 ;; - category :: tree
1195 ;; - type :: list of strings
1196 ;;
1197 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1198 ;; a time stamp in the output.
1199 ;; - category :: option
1200 ;; - type :: symbol (nil, t)
1201 ;;
1202 ;; + `:translate-alist' :: Alist between element and object types and
1203 ;; transcoding functions relative to the current back-end.
1204 ;; Special keys `template' and `plain-text' are also possible.
1205 ;; - category :: option
1206 ;; - type :: alist (SYMBOL . FUNCTION)
1207 ;;
1208 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1209 ;; also be transcoded. If it is set to the `headline' symbol,
1210 ;; only the archived headline's name is retained.
1211 ;; - category :: option
1212 ;; - type :: symbol (nil, t, `headline')
1213 ;;
1214 ;; + `:with-author' :: Non-nil means author's name should be included
1215 ;; in the output.
1216 ;; - category :: option
1217 ;; - type :: symbol (nil, t)
1218 ;;
1219 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1220 ;; - category :: option
1221 ;; - type :: symbol (nil, t)
1222 ;;
1223 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1224 ;; inserted at the end of the transcoded string. If the value
1225 ;; is `comment', it should be commented.
1226 ;; - category :: option
1227 ;; - type :: symbol (`comment', nil, t)
1228 ;;
1229 ;; + `:with-date' :: Non-nil means output should contain a date.
1230 ;; - category :: option
1231 ;; - type :. symbol (nil, t)
1232 ;;
1233 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1234 ;; its value is a list of names, only drawers with such names
1235 ;; will be transcoded.
1236 ;; - category :: option
1237 ;; - type :: symbol (nil, t) or list of strings
1238 ;;
1239 ;; + `:with-email' :: Non-nil means output should contain author's
1240 ;; email.
1241 ;; - category :: option
1242 ;; - type :: symbol (nil, t)
1243 ;;
1244 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1245 ;; interpreted.
1246 ;; - category :: option
1247 ;; - type :: symbol (nil, t)
1248 ;;
1249 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1250 ;; strings starting with a colon as a fixed-with (verbatim) area.
1251 ;; - category :: option
1252 ;; - type :: symbol (nil, t)
1253 ;;
1254 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1255 ;; footnotes.
1256 ;; - category :: option
1257 ;; - type :: symbol (nil, t)
1258 ;;
1259 ;; + `:with-plannings' :: Non-nil means transcoding should include
1260 ;; planning info.
1261 ;; - category :: option
1262 ;; - type :: symbol (nil, t)
1263 ;;
1264 ;; + `:with-priority' :: Non-nil means transcoding should include
1265 ;; priority cookies.
1266 ;; - category :: option
1267 ;; - type :: symbol (nil, t)
1268 ;;
1269 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1270 ;; plain text.
1271 ;; - category :: option
1272 ;; - type :: symbol (nil, t)
1273 ;;
1274 ;; + `:with-special-strings' :: Non-nil means transcoding should
1275 ;; interpret special strings in plain text.
1276 ;; - category :: option
1277 ;; - type :: symbol (nil, t)
1278 ;;
1279 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1280 ;; interpret subscript and superscript. With a value of "{}",
1281 ;; only interpret those using curly brackets.
1282 ;; - category :: option
1283 ;; - type :: symbol (nil, {}, t)
1284 ;;
1285 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1286 ;; tables.
1287 ;; - category :: option
1288 ;; - type :: symbol (nil, t)
1289 ;;
1290 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1291 ;; headlines. A `not-in-toc' value will remove them from the
1292 ;; table of contents, if any, nonetheless.
1293 ;; - category :: option
1294 ;; - type :: symbol (nil, t, `not-in-toc')
1295 ;;
1296 ;; + `:with-tasks' :: Non-nil means transcoding should include
1297 ;; headlines with a TODO keyword. A `todo' value will only
1298 ;; include headlines with a todo type keyword while a `done'
1299 ;; value will do the contrary. If a list of strings is provided,
1300 ;; only tasks with keywords belonging to that list will be kept.
1301 ;; - category :: option
1302 ;; - type :: symbol (t, todo, done, nil) or list of strings
1303 ;;
1304 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1305 ;; time stamps. Special value `active' (resp. `inactive') ask to
1306 ;; export only active (resp. inactive) timestamps. Otherwise,
1307 ;; completely remove them.
1308 ;; - category :: option
1309 ;; - type :: symbol: (`active', `inactive', t, nil)
1310 ;;
1311 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1312 ;; added to the output. An integer value limits its depth.
1313 ;; - category :: option
1314 ;; - type :: symbol (nil, t or integer)
1315 ;;
1316 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1317 ;; include TODO keywords.
1318 ;; - category :: option
1319 ;; - type :: symbol (nil, t)
1322 ;;;; Environment Options
1323 ;;
1324 ;; Environment options encompass all parameters defined outside the
1325 ;; scope of the parsed data. They come from five sources, in
1326 ;; increasing precedence order:
1327 ;;
1328 ;; - Global variables,
1329 ;; - Buffer's attributes,
1330 ;; - Options keyword symbols,
1331 ;; - Buffer keywords,
1332 ;; - Subtree properties.
1333 ;;
1334 ;; The central internal function with regards to environment options
1335 ;; is `org-export-get-environment'. It updates global variables with
1336 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1337 ;; the different sources.
1338 ;;
1339 ;; The internal functions doing the retrieval are:
1340 ;; `org-export--get-global-options',
1341 ;; `org-export--get-buffer-attributes',
1342 ;; `org-export--parse-option-keyword',
1343 ;; `org-export--get-subtree-options' and
1344 ;; `org-export--get-inbuffer-options'
1345 ;;
1346 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1347 ;; take care of the part relative to "#+BIND:" keywords.
1350 "Collect export options from the current buffer.
1352 Optional argument BACKEND is a symbol specifying which back-end
1353 specific options to read, if any.
1355 When optional argument SUBTREEP is non-nil, assume the export is
1356 done against the current sub-tree.
1358 Third optional argument EXT-PLIST is a property list with
1359 external parameters overriding Org default settings, but still
1360 inferior to file-local settings."
1361 ;; First install #+BIND variables.
1363 ;; Get and prioritize export options...
1365 ;; ... from global variables...
1367 ;; ... from an external property list...
1368 ext-plist
1369 ;; ... from in-buffer settings...
1371 backend
1373 ;; ... and from subtree, when appropriate.
1375 ;; Eventually add misc. properties.
1377 :back-end
1378 backend
1379 :translate-alist
1381 :footnote-definition-alist
1382 ;; Footnotes definitions must be collected in the original
1383 ;; buffer, as there's no insurance that they will still be in
1384 ;; the parse tree, due to possible narrowing.
1398 alist))))
1399 alist))
1400 :id-alist
1401 ;; Collect id references.
1412 alist))))
1415 "Parse an OPTIONS line and return values as a plist.
1416 Optional argument BACKEND is a symbol specifying which back-end
1417 specific items to read, if any."
1420 ;; Build an alist between #+OPTION: item and property-name.
1425 all)))
1426 plist)
1431 options)
1436 alist)
1437 plist))
1440 "Get export options in subtree at point.
1441 Optional argument BACKEND is a symbol specifying back-end used
1442 for export. Return options as a plist."
1443 ;; For each buffer keyword, create an headline property setting the
1444 ;; same property in communication channel. The name for the property
1445 ;; is the keyword with "EXPORT_" appended to it.
1448 ;; Make sure point is at an heading.
1450 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1451 ;; title as its fallback value.
1457 plist :title
1460 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1464 ;; Handle other keywords. TITLE keyword is excluded as it has
1465 ;; been handled already.
1472 ;; Export properties are not case-sensitive.
1479 plist
1482 ;; Parse VALUE if required.
1486 ;; If BEHAVIOUR is `split' expected value is
1487 ;; a list of strings, not a string.
1490 ;; Also look for both general keywords and back-end specific
1491 ;; options if BACKEND is provided.
1493 org-export-options-alist)))
1494 ;; Return value.
1495 plist)))
1498 "Return current buffer export options, as a plist.
1500 Optional argument BACKEND, when non-nil, is a symbol specifying
1501 which back-end specific options should also be read in the
1502 process.
1504 Optional argument FILES is a list of setup files names read so
1505 far, used to avoid circular dependencies.
1507 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1511 ;; 1. Special keywords, as in `org-export-special-keywords'.
1525 ;; Avoid circular dependencies.
1540 ;; 2. Standard options, as in `org-export-options-alist'.
1542 ;; Also look for back-end specific options if
1543 ;; BACKEND is defined.
1545 ;; Build ALIST between keyword name and property name.
1549 all)))
1550 ;; Build regexp matching all keywords associated to export
1551 ;; options. Note: the search is case insensitive.
1565 plist prop
1566 ;; Handle value depending on specified BEHAVIOUR.
1579 ;; Parse keywords specified in
1580 ;; `org-element-document-properties'.
1588 plist prop
1591 org-element-document-properties))
1592 ;; 3. Return final value.
1593 plist)))
1596 "Return properties related to buffer attributes, as a plist."
1599 ;; Store full path of input file name, or nil. For internal use.
1600 :input-file visited-file
1607 "Return global export options as a plist.
1609 Optional argument BACKEND, if non-nil, is a symbol specifying
1610 which back-end specific export options should also be read in the
1611 process."
1614 ;; Output value.
1615 plist)
1620 plist
1622 ;; Eval default value provided. If keyword is a member
1623 ;; of `org-element-document-properties', parse it as
1624 ;; a secondary string before storing it.
1629 value
1632 all)
1633 ;; Return value.
1634 plist))
1638 "Can we use #+BIND values during export?
1639 By default this will ask for confirmation by the user, to divert
1640 possible security risks."
1645 org-export--allow-BIND-local)
1650 "Install the values from #+BIND lines as local variables.
1651 Variables must be installed before in-buffer options are
1652 retrieved."
1667 ;;;; Tree Properties
1668 ;;
1669 ;; Tree properties are information extracted from parse tree. They
1670 ;; are initialized at the beginning of the transcoding process by
1671 ;; `org-export-collect-tree-properties'.
1672 ;;
1673 ;; Dedicated functions focus on computing the value of specific tree
1674 ;; properties during initialization. Thus,
1675 ;; `org-export--populate-ignore-list' lists elements and objects that
1676 ;; should be skipped during export, `org-export--get-min-level' gets
1677 ;; the minimal exportable level, used as a basis to compute relative
1678 ;; level for headlines. Eventually
1679 ;; `org-export--collect-headline-numbering' builds an alist between
1680 ;; headlines and their numbering.
1683 "Extract tree properties from parse tree.
1685 DATA is the parse tree from which information is retrieved. INFO
1686 is a list holding export options.
1688 Following tree properties are set or updated:
1690 `:exported-data' Hash table used to memoize results from
1691 `org-export-data'.
1693 `:footnote-definition-alist' List of footnotes definitions in
1694 original buffer and current parse tree.
1696 `:headline-offset' Offset between true level of headlines and
1697 local level. An offset of -1 means an headline
1698 of level 2 should be considered as a level
1699 1 headline in the context.
1701 `:headline-numbering' Alist of all headlines as key an the
1702 associated numbering as value.
1704 `:ignore-list' List of elements that should be ignored during
1705 export.
1707 `:target-list' List of all targets in the parse tree.
1709 Return updated plist."
1710 ;; Install the parse tree in the communication channel, in order to
1711 ;; use `org-export-get-genealogy' and al.
1713 ;; Get the list of elements and objects to ignore, and put it into
1714 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1715 ;; been done during parse tree filtering.
1718 :ignore-list
1721 ;; Compute `:headline-offset' in order to be able to use
1722 ;; `org-export-get-relative-level'.
1725 :headline-offset
1727 ;; Update footnotes definitions list with definitions in parse tree.
1728 ;; This is required since buffer expansion might have modified
1729 ;; boundaries of footnote definitions contained in the parse tree.
1730 ;; This way, definitions in `footnote-definition-alist' are bound to
1731 ;; match those in the parse tree.
1734 data 'footnote-definition
1738 defs)))
1740 ;; Properties order doesn't matter: get the rest of the tree
1741 ;; properties.
1743 `(:target-list
1752 info))
1755 "Return minimum exportable headline's level in DATA.
1756 DATA is parsed tree as returned by `org-element-parse-buffer'.
1757 OPTIONS is a plist holding export options."
1768 ;; If no headline was found, for the sake of consistency, set
1769 ;; minimum level to 1 nonetheless.
1773 "Return numbering of all exportable headlines in a parse tree.
1775 DATA is the parse tree. OPTIONS is the plist holding export
1776 options.
1778 Return an alist whose key is an headline and value is its
1779 associated numbering \(in the shape of a list of numbers\)."
1782 data
1783 'headline
1788 headline
1790 for idx from 0 to org-export-max-depth
1794 options)))
1797 "Return list of elements and objects to ignore during export.
1798 DATA is the parse tree to traverse. OPTIONS is the plist holding
1799 export options."
1801 walk-data
1802 ;; First find trees containing a select tag, if any.
1806 ;; Collect ignored elements or objects into IGNORE-LIST.
1812 ;; If headline is archived but tree below has
1813 ;; to be skipped, add it to ignore list.
1816 ;; Move into secondary string, if any.
1821 ;; Move into recursive objects/elements.
1823 ;; Main call.
1825 ;; Return value.
1826 ignore))
1829 "Return list of headlines containing a select tag in their tree.
1830 DATA is parsed data as returned by `org-element-parse-buffer'.
1831 INFO is a plist holding export options."
1833 walk-data ; for byte-compiler.
1844 ;; When a select tag is found, mark full
1845 ;; genealogy and every headline within the tree
1846 ;; as acceptable.
1849 genealogy
1851 selected-trees))
1852 ;; Else, continue searching in tree, recursively.
1859 "Non-nil when element or object BLOB should be skipped during export.
1860 OPTIONS is the plist holding export options. SELECTED, when
1861 non-nil, is a list of headlines belonging to a tree with a select
1862 tag."
1877 ;; Ignore subtrees with an exclude tag.
1880 ;; When a select tag is present in the buffer, ignore any tree
1881 ;; without it.
1883 ;; Ignore commented sub-trees.
1885 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1887 ;; Ignore tasks, if specified by `:with-tasks' property.
1903 ;; No timestamp allowed.
1905 ;; Only active timestamps allowed and the current one isn't
1906 ;; active.
1910 ;; Only inactive timestamps allowed and the current one isn't
1911 ;; inactive.
1917 \f
1918 ;;; The Transcoder
1919 ;;
1920 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1921 ;; `org-element-parse-buffer') and transcodes it into a specified
1922 ;; back-end output. It takes care of filtering out elements or
1923 ;; objects according to export options and organizing the output blank
1924 ;; lines and white space are preserved. The function memoizes its
1925 ;; results, so it is cheap to call it within translators.
1926 ;;
1927 ;; Internally, three functions handle the filtering of objects and
1928 ;; elements during the export. In particular,
1929 ;; `org-export-ignore-element' marks an element or object so future
1930 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1931 ;; elements or objects should be seen as real Org syntax and
1932 ;; `org-export-expand' transforms the others back into their original
1933 ;; shape
1934 ;;
1935 ;; `org-export-transcoder' is an accessor returning appropriate
1936 ;; translator function for a given element or object.
1939 "Return appropriate transcoder for BLOB.
1940 INFO is a plist containing export directives."
1942 ;; Return contents only for complete parse trees.
1948 "Convert DATA into current back-end format.
1950 DATA is a parse tree, an element or an object or a secondary
1951 string. INFO is a plist holding export options.
1953 Return transcoded string."
1959 ;; Ignored element/object.
1961 ;; Plain text.
1967 info))
1968 ;; Uninterpreted element/object: change it back to Org
1969 ;; syntax and export again resulting raw string.
1973 data
1977 info))
1978 ;; Secondary string.
1981 ;; Element/Object without contents or, as a special case,
1982 ;; headline with archive tag and archived trees restricted
1983 ;; to title only.
1991 ;; Element/Object with contents.
2004 ;; Elements directly containing objects
2005 ;; must have their indentation normalized
2006 ;; first.
2008 data
2009 ;; When normalizing contents of the first
2010 ;; paragraph in an item or a footnote
2011 ;; definition, ignore first line's
2012 ;; indentation: there is none and it
2013 ;; might be misleading.
2018 data)
2025 info))))))))
2026 ;; Final result will be memoized before being returned.
2028 data
2032 ;; Append the same white space between elements or objects as in
2033 ;; the original buffer, and call appropriate filters.
2044 info)))
2045 results)))
2049 "Non-nil if element or object BLOB should be interpreted as Org syntax.
2050 Check is done according to export options INFO, stored as
2051 a plist."
2053 ;; ... entities...
2055 ;; ... emphasis...
2058 ;; ... fixed-width areas.
2060 ;; ... footnotes...
2063 ;; ... sub/superscripts...
2069 ;; ... tables...
2074 "Expand a parsed element or object to its original state.
2075 BLOB is either an element or an object. CONTENTS is its
2076 contents, as a string or nil."
2079 blob contents))
2082 "Add ELEMENT to `:ignore-list' in INFO.
2084 Any element in `:ignore-list' will be skipped when using
2085 `org-element-map'. INFO is modified by side effects."
2089 \f
2090 ;;; The Filter System
2091 ;;
2092 ;; Filters allow end-users to tweak easily the transcoded output.
2093 ;; They are the functional counterpart of hooks, as every filter in
2094 ;; a set is applied to the return value of the previous one.
2095 ;;
2096 ;; Every set is back-end agnostic. Although, a filter is always
2097 ;; called, in addition to the string it applies to, with the back-end
2098 ;; used as argument, so it's easy for the end-user to add back-end
2099 ;; specific filters in the set. The communication channel, as
2100 ;; a plist, is required as the third argument.
2101 ;;
2102 ;; From the developer side, filters sets can be installed in the
2103 ;; process with the help of `org-export-define-backend', which
2104 ;; internally stores filters as an alist. Each association has a key
2105 ;; among the following symbols and a function or a list of functions
2106 ;; as value.
2107 ;;
2108 ;; - `:filter-parse-tree' applies directly on the complete parsed
2109 ;; tree. It's the only filters set that doesn't apply to a string.
2110 ;; Users can set it through `org-export-filter-parse-tree-functions'
2111 ;; variable.
2112 ;;
2113 ;; - `:filter-final-output' applies to the final transcoded string.
2114 ;; Users can set it with `org-export-filter-final-output-functions'
2115 ;; variable
2116 ;;
2117 ;; - `:filter-plain-text' applies to any string not recognized as Org
2118 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2119 ;; configure it.
2120 ;;
2121 ;; - `:filter-TYPE' applies on the string returned after an element or
2122 ;; object of type TYPE has been transcoded. An user can modify
2123 ;; `org-export-filter-TYPE-functions'
2124 ;;
2125 ;; All filters sets are applied with
2126 ;; `org-export-filter-apply-functions' function. Filters in a set are
2127 ;; applied in a LIFO fashion. It allows developers to be sure that
2128 ;; their filters will be applied first.
2129 ;;
2130 ;; Filters properties are installed in communication channel with
2131 ;; `org-export-install-filters' function.
2132 ;;
2133 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2134 ;; `org-export-before-parsing-hook') are run at the beginning of the
2135 ;; export process and just before parsing to allow for heavy structure
2136 ;; modifications.
2139 ;;;; Hooks
2142 "Hook run at the beginning of the export process.
2144 This is run before include keywords and macros are expanded and
2145 Babel code blocks executed, on a copy of the original buffer
2146 being exported. Visibility and narrowing are preserved. Point
2147 is at the beginning of the buffer.
2149 Every function in this hook will be called with one argument: the
2153 "Hook run before parsing an export buffer.
2155 This is run after include keywords and macros have been expanded
2156 and Babel code blocks executed, on a copy of the original buffer
2157 being exported. Visibility and narrowing are preserved. Point
2158 is at the beginning of the buffer.
2160 Every function in this hook will be called with one argument: the
2164 ;;;; Special Filters
2167 "List of functions applied to the parsed tree.
2168 Each filter is called with three arguments: the parse tree, as
2169 returned by `org-element-parse-buffer', the back-end, as
2170 a symbol, and the communication channel, as a plist. It must
2174 "List of functions applied to the transcoded string.
2175 Each filter is called with three arguments: the full transcoded
2176 string, the back-end, as a symbol, and the communication channel,
2177 as a plist. It must return a string that will be used as the
2181 "List of functions applied to plain text.
2182 Each filter is called with three arguments: a string which
2183 contains no Org syntax, the back-end, as a symbol, and the
2184 communication channel, as a plist. It must return a string or
2188 ;;;; Elements Filters
2191 "List of functions applied to a transcoded babel-call.
2192 Each filter is called with three arguments: the transcoded data,
2193 as a string, the back-end, as a symbol, and the communication
2197 "List of functions applied to a transcoded center block.
2198 Each filter is called with three arguments: the transcoded data,
2199 as a string, the back-end, as a symbol, and the communication
2203 "List of functions applied to a transcoded clock.
2204 Each filter is called with three arguments: the transcoded data,
2205 as a string, the back-end, as a symbol, and the communication
2209 "List of functions applied to a transcoded comment.
2210 Each filter is called with three arguments: the transcoded data,
2211 as a string, the back-end, as a symbol, and the communication
2215 "List of functions applied to a transcoded comment-block.
2216 Each filter is called with three arguments: the transcoded data,
2217 as a string, the back-end, as a symbol, and the communication
2221 "List of functions applied to a transcoded diary-sexp.
2222 Each filter is called with three arguments: the transcoded data,
2223 as a string, the back-end, as a symbol, and the communication
2227 "List of functions applied to a transcoded drawer.
2228 Each filter is called with three arguments: the transcoded data,
2229 as a string, the back-end, as a symbol, and the communication
2233 "List of functions applied to a transcoded dynamic-block.
2234 Each filter is called with three arguments: the transcoded data,
2235 as a string, the back-end, as a symbol, and the communication
2239 "List of functions applied to a transcoded example-block.
2240 Each filter is called with three arguments: the transcoded data,
2241 as a string, the back-end, as a symbol, and the communication
2245 "List of functions applied to a transcoded export-block.
2246 Each filter is called with three arguments: the transcoded data,
2247 as a string, the back-end, as a symbol, and the communication
2251 "List of functions applied to a transcoded fixed-width.
2252 Each filter is called with three arguments: the transcoded data,
2253 as a string, the back-end, as a symbol, and the communication
2257 "List of functions applied to a transcoded footnote-definition.
2258 Each filter is called with three arguments: the transcoded data,
2259 as a string, the back-end, as a symbol, and the communication
2263 "List of functions applied to a transcoded headline.
2264 Each filter is called with three arguments: the transcoded data,
2265 as a string, the back-end, as a symbol, and the communication
2269 "List of functions applied to a transcoded horizontal-rule.
2270 Each filter is called with three arguments: the transcoded data,
2271 as a string, the back-end, as a symbol, and the communication
2275 "List of functions applied to a transcoded inlinetask.
2276 Each filter is called with three arguments: the transcoded data,
2277 as a string, the back-end, as a symbol, and the communication
2281 "List of functions applied to a transcoded item.
2282 Each filter is called with three arguments: the transcoded data,
2283 as a string, the back-end, as a symbol, and the communication
2287 "List of functions applied to a transcoded keyword.
2288 Each filter is called with three arguments: the transcoded data,
2289 as a string, the back-end, as a symbol, and the communication
2293 "List of functions applied to a transcoded latex-environment.
2294 Each filter is called with three arguments: the transcoded data,
2295 as a string, the back-end, as a symbol, and the communication
2299 "List of functions applied to a transcoded node-property.
2300 Each filter is called with three arguments: the transcoded data,
2301 as a string, the back-end, as a symbol, and the communication
2305 "List of functions applied to a transcoded paragraph.
2306 Each filter is called with three arguments: the transcoded data,
2307 as a string, the back-end, as a symbol, and the communication
2311 "List of functions applied to a transcoded plain-list.
2312 Each filter is called with three arguments: the transcoded data,
2313 as a string, the back-end, as a symbol, and the communication
2317 "List of functions applied to a transcoded planning.
2318 Each filter is called with three arguments: the transcoded data,
2319 as a string, the back-end, as a symbol, and the communication
2323 "List of functions applied to a transcoded property-drawer.
2324 Each filter is called with three arguments: the transcoded data,
2325 as a string, the back-end, as a symbol, and the communication
2329 "List of functions applied to a transcoded quote block.
2330 Each filter is called with three arguments: the transcoded quote
2331 data, as a string, the back-end, as a symbol, and the
2332 communication channel, as a plist. It must return a string or
2336 "List of functions applied to a transcoded quote-section.
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 section.
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 special block.
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 src-block.
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 table.
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 table-cell.
2367 Each filter is called with three arguments: the transcoded data,
2368 as a string, the back-end, as a symbol, and the communication
2372 "List of functions applied to a transcoded table-row.
2373 Each filter is called with three arguments: the transcoded data,
2374 as a string, the back-end, as a symbol, and the communication
2378 "List of functions applied to a transcoded verse block.
2379 Each filter is called with three arguments: the transcoded data,
2380 as a string, the back-end, as a symbol, and the communication
2384 ;;;; Objects Filters
2387 "List of functions applied to transcoded bold text.
2388 Each filter is called with three arguments: the transcoded data,
2389 as a string, the back-end, as a symbol, and the communication
2393 "List of functions applied to transcoded code text.
2394 Each filter is called with three arguments: the transcoded data,
2395 as a string, the back-end, as a symbol, and the communication
2399 "List of functions applied to a transcoded entity.
2400 Each filter is called with three arguments: the transcoded data,
2401 as a string, the back-end, as a symbol, and the communication
2405 "List of functions applied to a transcoded export-snippet.
2406 Each filter is called with three arguments: the transcoded data,
2407 as a string, the back-end, as a symbol, and the communication
2411 "List of functions applied to a transcoded footnote-reference.
2412 Each filter is called with three arguments: the transcoded data,
2413 as a string, the back-end, as a symbol, and the communication
2417 "List of functions applied to a transcoded inline-babel-call.
2418 Each filter is called with three arguments: the transcoded data,
2419 as a string, the back-end, as a symbol, and the communication
2423 "List of functions applied to a transcoded inline-src-block.
2424 Each filter is called with three arguments: the transcoded data,
2425 as a string, the back-end, as a symbol, and the communication
2429 "List of functions applied to transcoded italic text.
2430 Each filter is called with three arguments: the transcoded data,
2431 as a string, the back-end, as a symbol, and the communication
2435 "List of functions applied to a transcoded latex-fragment.
2436 Each filter is called with three arguments: the transcoded data,
2437 as a string, the back-end, as a symbol, and the communication
2441 "List of functions applied to a transcoded line-break.
2442 Each filter is called with three arguments: the transcoded data,
2443 as a string, the back-end, as a symbol, and the communication
2447 "List of functions applied to a transcoded link.
2448 Each filter is called with three arguments: the transcoded data,
2449 as a string, the back-end, as a symbol, and the communication
2453 "List of functions applied to a transcoded macro.
2454 Each filter is called with three arguments: the transcoded data,
2455 as a string, the back-end, as a symbol, and the communication
2459 "List of functions applied to a transcoded radio-target.
2460 Each filter is called with three arguments: the transcoded data,
2461 as a string, the back-end, as a symbol, and the communication
2465 "List of functions applied to a transcoded statistics-cookie.
2466 Each filter is called with three arguments: the transcoded data,
2467 as a string, the back-end, as a symbol, and the communication
2471 "List of functions applied to transcoded strike-through text.
2472 Each filter is called with three arguments: the transcoded data,
2473 as a string, the back-end, as a symbol, and the communication
2477 "List of functions applied to a transcoded subscript.
2478 Each filter is called with three arguments: the transcoded data,
2479 as a string, the back-end, as a symbol, and the communication
2483 "List of functions applied to a transcoded superscript.
2484 Each filter is called with three arguments: the transcoded data,
2485 as a string, the back-end, as a symbol, and the communication
2489 "List of functions applied to a transcoded target.
2490 Each filter is called with three arguments: the transcoded data,
2491 as a string, the back-end, as a symbol, and the communication
2495 "List of functions applied to a transcoded timestamp.
2496 Each filter is called with three arguments: the transcoded data,
2497 as a string, the back-end, as a symbol, and the communication
2501 "List of functions applied to transcoded underline text.
2502 Each filter is called with three arguments: the transcoded data,
2503 as a string, the back-end, as a symbol, and the communication
2507 "List of functions applied to transcoded verbatim text.
2508 Each filter is called with three arguments: the transcoded data,
2509 as a string, the back-end, as a symbol, and the communication
2513 ;;;; Filters Tools
2514 ;;
2515 ;; Internal function `org-export-install-filters' installs filters
2516 ;; hard-coded in back-ends (developer filters) and filters from global
2517 ;; variables (user filters) in the communication channel.
2518 ;;
2519 ;; Internal function `org-export-filter-apply-functions' takes care
2520 ;; about applying each filter in order to a given data. It ignores
2521 ;; filters returning a nil value but stops whenever a filter returns
2522 ;; an empty string.
2525 "Call every function in FILTERS.
2527 Functions are called with arguments VALUE, current export
2528 back-end and INFO. A function returning a nil value will be
2529 skipped. If it returns the empty string, the process ends and
2530 VALUE is ignored.
2532 Call is done in a LIFO fashion, to be sure that developer
2533 specified filters, if any, are called first."
2542 "Install filters properties in communication channel.
2544 INFO is a plist containing the current communication channel.
2546 Return the updated communication channel."
2548 ;; Install user defined filters with `org-export-filters-alist'.
2551 org-export-filters-alist)
2552 ;; Prepend back-end specific filters to that list.
2554 ;; Single values get consed, lists are prepended.
2559 plist key
2563 ;; Return new communication channel.
2567 \f
2568 ;;; Core functions
2569 ;;
2570 ;; This is the room for the main function, `org-export-as', along with
2571 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2572 ;; They differ only by the way they output the resulting code.
2573 ;;
2574 ;; `org-export-output-file-name' is an auxiliary function meant to be
2575 ;; used with `org-export-to-file'. With a given extension, it tries
2576 ;; to provide a canonical file name to write export output to.
2577 ;;
2578 ;; Note that `org-export-as' doesn't really parse the current buffer,
2579 ;; but a copy of it (with the same buffer-local variables and
2580 ;; visibility), where macros and include keywords are expanded and
2581 ;; Babel blocks are executed, if appropriate.
2582 ;; `org-export-with-buffer-copy' macro prepares that copy.
2583 ;;
2584 ;; File inclusion is taken care of by
2585 ;; `org-export-expand-include-keyword' and
2586 ;; `org-export--prepare-file-contents'. Structure wise, including
2587 ;; a whole Org file in a buffer often makes little sense. For
2588 ;; example, if the file contains an headline and the include keyword
2589 ;; was within an item, the item should contain the headline. That's
2590 ;; why file inclusion should be done before any structure can be
2591 ;; associated to the file, that is before parsing.
2595 "Transcode current Org buffer into BACKEND code.
2597 If narrowing is active in the current buffer, only transcode its
2598 narrowed part.
2600 If a region is active, transcode that region.
2602 When optional argument SUBTREEP is non-nil, transcode the
2603 sub-tree at point, extracting information from the headline
2604 properties first.
2606 When optional argument VISIBLE-ONLY is non-nil, don't export
2607 contents of hidden elements.
2609 When optional argument BODY-ONLY is non-nil, only return body
2610 code, without preamble nor postamble.
2612 Optional argument EXT-PLIST, when provided, is a property list
2613 with external parameters overriding Org default settings, but
2614 still inferior to file-local settings.
2616 Optional argument NOEXPAND, when non-nil, prevents included files
2617 to be expanded and Babel code to be executed.
2619 Return code as a string."
2620 ;; Barf if BACKEND isn't registered.
2624 ;; Narrow buffer to an appropriate region or subtree for
2625 ;; parsing. If parsing subtree, be sure to remove main headline
2626 ;; too.
2634 ;; Initialize communication channel with original buffer
2635 ;; attributes, unavailable in its copy.
2638 ;; Run first hook with current back-end as argument.
2640 ;; Update communication channel and get parse tree. Buffer
2641 ;; isn't parsed directly. Instead, a temporary copy is
2642 ;; created, where include keywords, macros are expanded and
2643 ;; code blocks are evaluated.
2646 ;; Update macro templates since #+INCLUDE keywords might
2647 ;; have added some new ones.
2651 ;; Update radio targets since keyword inclusion might have
2652 ;; added some more.
2654 ;; Run last hook with current back-end as argument.
2657 ;; Update communication channel with environment. Also
2658 ;; install user's and developer's filters.
2663 ;; Expand export-specific set of macros: {{{author}}},
2664 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2665 ;; once regular macros have been expanded, since document
2666 ;; keywords may contain one of them.
2673 ;; EMAIL is not a parsed keyword: store it as-is.
2677 ;; Eventually parse buffer. Call parse-tree filters to get
2678 ;; the final tree.
2683 ;; Now tree is complete, compute its properties and add them
2684 ;; to communication channel.
2688 ;; Eventually transcode TREE. Wrap the resulting string into
2689 ;; a template, if required. Finally call final-output filter.
2694 ;; Remove all text properties since they cannot be
2695 ;; retrieved from an external process.
2701 info))))
2702 ;; Maybe add final OUTPUT to kill ring, then return it.
2705 output)))))
2709 "Call `org-export-as' with output to a specified buffer.
2711 BACKEND is the back-end used for transcoding, as a symbol.
2713 BUFFER is the output buffer. If it already exists, it will be
2714 erased first, otherwise, it will be created.
2716 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2717 and NOEXPAND are similar to those used in `org-export-as', which
2718 see.
2720 Return buffer."
2722 backend subtreep visible-only body-only ext-plist noexpand))
2728 buffer))
2732 "Call `org-export-as' with output to a specified file.
2734 BACKEND is the back-end used for transcoding, as a symbol. FILE
2735 is the name of the output file, as a string.
2737 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2738 and NOEXPAND are similar to those used in `org-export-as', which
2739 see.
2741 Return output file's name."
2742 ;; Checks for FILE permissions. `write-file' would do the same, but
2743 ;; we'd rather avoid needless transcoding of parse tree.
2745 ;; Insert contents to a temporary buffer and write it to FILE.
2747 backend subtreep visible-only body-only ext-plist noexpand)))
2752 ;; Return full path.
2753 file)
2756 "Return output file's name according to buffer specifications.
2758 EXTENSION is a string representing the output file extension,
2759 with the leading dot.
2761 With a non-nil optional argument SUBTREEP, try to determine
2763 of subtree at point.
2765 When optional argument PUB-DIR is set, use it as the publishing
2766 directory.
2768 When optional argument VISIBLE-ONLY is non-nil, don't export
2769 contents of hidden elements.
2771 Return file name as a string, or nil if it couldn't be
2772 determined."
2774 ;; File name may come from EXPORT_FILE_NAME subtree property,
2775 ;; assuming point is at beginning of said sub-tree.
2782 ;; File name may be extracted from buffer's associated
2783 ;; file, if any.
2786 ;; Can't determine file name on our own: Ask user.
2790 "Output file: " pub-dir nil nil nil
2793 ;; Build file name. Enforce EXTENSION over whatever user may have
2794 ;; come up with. PUB-DIR, if defined, always has precedence over
2795 ;; any provided path.
2800 extension))
2805 "Return a copy of the current buffer.
2806 The copy preserves Org buffer-local variables, visibility and
2807 narrowing."
2813 new-buf))
2816 "Apply BODY in a copy of the current buffer.
2817 The copy preserves local variables, visibility and contents of
2818 the original buffer. Point is at the beginning of the buffer
2819 when BODY is applied."
2828 ;; Kill copy without confirmation.
2834 "Generate a function duplicating BUFFER.
2836 The copy will preserve local variables, visibility, contents and
2837 narrowing of the original buffer. If a region was active in
2838 BUFFER, contents will be narrowed to that region instead.
2840 The resulting function can be eval'ed at a later time, from
2841 another buffer, effectively cloning the original buffer there."
2845 ;; Buffer local variables.
2855 buffer-file-name outline-level
2856 outline-regexp
2857 buffer-invisibility-spec))
2860 ;; Skip unreadable values, as they cannot be
2861 ;; sent to external process.
2865 local-vars)))))
2867 local-vars)
2868 ;; Whole buffer contents.
2873 ;; Narrowing.
2877 ;; Current position of point.
2879 ;; Overlays with invisible property.
2889 ov-set))))
2891 ov-set)))))
2894 "Expand every include keyword in buffer.
2895 Optional argument INCLUDED is a list of included file names along
2896 with their line restriction, when appropriate. It is used to
2897 avoid infinite recursion. Optional argument DIR is the current
2898 working directory. It is used to properly resolve relative
2899 paths."
2906 ;; Extract arguments from keyword's value.
2920 ;; Minimal level of included file defaults to the child
2921 ;; level of the current headline, if any, or one. It
2922 ;; only applies is the file is meant to be included as
2923 ;; an Org one.
2931 ;; Remove keyword.
2936 ;; Check if files has already been parsed. Look after
2937 ;; inclusion lines too, as different parts of the same file
2938 ;; can be included too.
2950 ind-str contents ind-str))))
2958 ind-str env contents ind-str))))
2971 "Prepare the contents of FILE for inclusion and return them as a string.
2973 When optional argument LINES is a string specifying a range of
2974 lines, include only those lines.
2976 Optional argument IND, when non-nil, is an integer specifying the
2977 global indentation of returned contents. Since its purpose is to
2978 allow an included file to stay in the same environment it was
2979 created \(i.e. a list item), it doesn't apply past the first
2980 headline encountered.
2982 Optional argument MINLEVEL, when non-nil, is an integer
2983 specifying the level that any top-level headline in the included
2984 file should have."
3000 ;; Remove blank lines at beginning and end of contents. The logic
3001 ;; behind that removal is that blank lines around include keyword
3002 ;; override blank lines in included file.
3011 ;; If IND is set, preserve indentation of include keyword until
3012 ;; the first headline encountered.
3018 ;; Do not move footnote definitions out of column 0.
3024 ;; When MINLEVEL is specified, compute minimal level for headlines
3025 ;; in the file (CUR-MIN), and remove stars to each headline so
3026 ;; that headlines with minimal level have a level of MINLEVEL.
3036 ;; Only change stars, don't bother moving whole
3037 ;; sections.
3044 "Execute every Babel code in the visible part of current buffer.
3045 This function will return an error if the current buffer is
3046 visiting a file."
3047 ;; Get a pristine copy of current buffer so Babel references can be
3048 ;; properly resolved.
3055 \f
3056 ;;; Tools For Back-Ends
3057 ;;
3058 ;; A whole set of tools is available to help build new exporters. Any
3059 ;; function general enough to have its use across many back-ends
3060 ;; should be added here.
3062 ;;;; For Affiliated Keywords
3063 ;;
3064 ;; `org-export-read-attribute' reads a property from a given element
3065 ;; as a plist. It can be used to normalize affiliated keywords'
3066 ;; syntax.
3067 ;;
3068 ;; Since captions can span over multiple lines and accept dual values,
3069 ;; their internal representation is a bit tricky. Therefore,
3070 ;; `org-export-get-caption' transparently returns a given element's
3071 ;; caption as a secondary string.
3074 "Turn ATTRIBUTE property from ELEMENT into a plist.
3076 When optional argument PROPERTY is non-nil, return the value of
3077 that property within attributes.
3081 properties."
3089 "Return caption from ELEMENT as a secondary string.
3091 When optional argument SHORTP is non-nil, return short caption,
3092 as a secondary string, instead.
3094 Caption lines are separated by a white space."
3102 ;;;; For Derived Back-ends
3103 ;;
3104 ;; `org-export-with-backend' is a function allowing to locally use
3105 ;; another back-end to transcode some object or element. In a derived
3106 ;; back-end, it may be used as a fall-back function once all specific
3107 ;; cases have been treated.
3110 "Call a transcoder from BACK-END on DATA.
3111 CONTENTS, when non-nil, is the transcoded contents of DATA
3112 element, as a string. INFO, when non-nil, is the communication
3113 channel used for export, as a plist.."
3123 ;;;; For Export Snippets
3124 ;;
3125 ;; Every export snippet is transmitted to the back-end. Though, the
3126 ;; latter will only retain one type of export-snippet, ignoring
3127 ;; others, based on the former's target back-end. The function
3128 ;; `org-export-snippet-backend' returns that back-end for a given
3129 ;; export-snippet.
3132 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3133 Translation, with `org-export-snippet-translation-alist', is
3134 applied."
3138 back-end))))
3141 ;;;; For Footnotes
3142 ;;
3143 ;; `org-export-collect-footnote-definitions' is a tool to list
3144 ;; actually used footnotes definitions in the whole parse tree, or in
3145 ;; an headline, in order to add footnote listings throughout the
3146 ;; transcoded data.
3147 ;;
3148 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3149 ;; back-ends, when they need to attach the footnote definition only to
3150 ;; the first occurrence of the corresponding label.
3151 ;;
3152 ;; `org-export-get-footnote-definition' and
3153 ;; `org-export-get-footnote-number' provide easier access to
3154 ;; additional information relative to a footnote reference.
3157 "Return an alist between footnote numbers, labels and definitions.
3159 DATA is the parse tree from which definitions are collected.
3160 INFO is the plist used as a communication channel.
3162 Definitions are sorted by order of references. They either
3163 appear as Org data or as a secondary string for inlined
3164 footnotes. Unreferenced definitions are ignored."
3166 collect-fn ; for byte-compiler.
3170 ;; Collect footnote number, label and definition in DATA.
3172 data 'footnote-reference
3179 def)
3180 num-alist)
3181 ;; Also search in definition for nested footnotes.
3184 ;; Don't enter footnote definitions since it will happen
3185 ;; when their first reference is found.
3191 "Non-nil when a footnote reference is the first one for its label.
3193 FOOTNOTE-REFERENCE is the footnote reference being considered.
3194 INFO is the plist used as a communication channel."
3196 ;; Anonymous footnotes are always a first reference.
3198 ;; Otherwise, return the first footnote with the same LABEL and
3199 ;; test if it is equal to FOOTNOTE-REFERENCE.
3205 data 'footnote-reference
3210 ;; If FN isn't inlined, be sure to traverse its
3211 ;; definition before resuming search. See
3212 ;; comments in `org-export-get-footnote-number'
3213 ;; for more information.
3217 ;; Don't enter footnote definitions since it will
3218 ;; happen when their first reference is found.
3221 footnote-reference)))))
3224 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3225 INFO is the plist used as a communication channel."
3231 "Return number associated to a footnote.
3233 FOOTNOTE is either a footnote reference or a footnote definition.
3234 INFO is the plist used as a communication channel."
3236 seen-refs
3237 search-ref ; For byte-compiler.
3241 ;; Search footnote references through DATA, filling
3242 ;; SEEN-REFS along the way.
3244 data 'footnote-reference
3248 ;; Anonymous footnote match: return number.
3251 ;; Labels match: return number.
3254 ;; Anonymous footnote: it's always a new one. Also,
3255 ;; be sure to return nil from the `cond' so
3256 ;; `first-match' doesn't get us out of the loop.
3258 ;; Label not seen so far: add it so SEEN-REFS.
3259 ;;
3260 ;; Also search for subsequent references in
3261 ;; footnote definition so numbering follows reading
3262 ;; logic. Note that we don't have to care about
3263 ;; inline definitions, since `org-element-map'
3264 ;; already traverses them at the right time.
3265 ;;
3266 ;; Once again, return nil to stay in the loop.
3271 nil))))
3272 ;; Don't enter footnote definitions since it will happen
3273 ;; when their first reference is found.
3278 ;;;; For Headlines
3279 ;;
3280 ;; `org-export-get-relative-level' is a shortcut to get headline
3281 ;; level, relatively to the lower headline level in the parsed tree.
3282 ;;
3283 ;; `org-export-get-headline-number' returns the section number of an
3284 ;; headline, while `org-export-number-to-roman' allows to convert it
3285 ;; to roman numbers.
3286 ;;
3287 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3288 ;; `org-export-last-sibling-p' are three useful predicates when it
3289 ;; comes to fulfill the `:headline-levels' property.
3290 ;;
3291 ;; `org-export-get-tags', `org-export-get-category' and
3292 ;; `org-export-get-node-property' extract useful information from an
3293 ;; headline or a parent headline. They all handle inheritance.
3296 "Return HEADLINE relative level within current parsed tree.
3297 INFO is a plist holding contextual information."
3302 "Non-nil when HEADLINE is considered as low level.
3304 INFO is a plist used as a communication channel.
3306 A low level headlines has a relative level greater than
3307 `:headline-levels' property value.
3309 Return value is the difference between HEADLINE relative level
3310 and the last level being considered as high enough, or nil."
3317 "Return HEADLINE numbering as a list of numbers.
3318 INFO is a plist holding contextual information."
3322 "Return a non-nil value if HEADLINE element should be numbered.
3323 INFO is a plist used as a communication channel."
3329 "Convert integer N into a roman numeral."
3342 res)))
3345 "Return list of tags associated to ELEMENT.
3347 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3348 is a plist used as a communication channel.
3350 Select tags (see `org-export-select-tags') and exclude tags (see
3351 `org-export-exclude-tags') are removed from the list.
3353 When non-nil, optional argument TAGS should be a list of strings.
3354 Any tag belonging to this list will also be removed.
3356 When optional argument INHERITED is non-nil, tags can also be
3357 inherited from parent headlines and FILETAGS keywords."
3363 ;; Build complete list of inherited tags.
3374 ;; Add FILETAGS keywords and return results.
3378 "Return node PROPERTY value for BLOB.
3380 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3381 element or object.
3383 If optional argument INHERITED is non-nil, the value can be
3384 inherited from a parent headline.
3386 Return value is a string or nil."
3398 "Return category for element or object BLOB.
3400 INFO is a plist used as a communication channel.
3402 CATEGORY is automatically inherited from a parent headline, from
3403 #+CATEGORY: keyword or created out of original file name. If all
3407 ;; Almost like `org-export-node-property', but we cannot trust
3408 ;; `plist-member' as every headline has a `:category'
3409 ;; property, would it be nil or equal to "???" (which has the
3410 ;; same meaning).
3429 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3430 INFO is a plist used as a communication channel."
3435 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3436 INFO is a plist used as a communication channel."
3440 ;;;; For Links
3441 ;;
3442 ;; `org-export-solidify-link-text' turns a string into a safer version
3443 ;; for links, replacing most non-standard characters with hyphens.
3444 ;;
3445 ;; `org-export-get-coderef-format' returns an appropriate format
3446 ;; string for coderefs.
3447 ;;
3448 ;; `org-export-inline-image-p' returns a non-nil value when the link
3449 ;; provided should be considered as an inline image.
3450 ;;
3451 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3452 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3453 ;; returns an appropriate unique identifier when found, or nil.
3454 ;;
3455 ;; `org-export-resolve-id-link' returns the first headline with
3456 ;; specified id or custom-id in parse tree, the path to the external
3457 ;; file with the id or nil when neither was found.
3458 ;;
3459 ;; `org-export-resolve-coderef' associates a reference to a line
3460 ;; number in the element it belongs, or returns the reference itself
3461 ;; when the element isn't numbered.
3464 "Take link text S and make a safe target out of it."
3469 "Return format string for code reference link.
3470 PATH is the link path. DESC is its description."
3478 "Non-nil if LINK object points to an inline image.
3480 Optional argument is a set of RULES defining inline images. It
3481 is an alist where associations have the following shape:
3483 \(TYPE . REGEXP)
3485 Applying a rule means apply REGEXP against LINK's path when its
3486 type is TYPE. The function will return a non-nil value if any of
3487 the provided rules is non-nil. The default rule is
3488 `org-export-default-inline-image-rule'.
3490 This only applies to links without a description."
3501 rules)
3502 ;; Return nil if no rule matched.
3503 nil))))
3506 "Resolve a code reference REF.
3508 INFO is a plist used as a communication channel.
3510 Return associated line number in source code, or REF itself,
3511 depending on src-block or example element's switches."
3519 org-coderef-label-format)))
3523 ;; Element containing REF is found. Resolve it to either
3524 ;; a label or a line number, as needed.
3534 "Return LINK destination.
3536 INFO is a plist holding contextual information.
3538 Return value can be an object, an element, or nil:
3540 - If LINK path matches a target object (i.e. <<path>>) or
3543 - If LINK path exactly matches the name affiliated keyword
3544 \(i.e. #+NAME: path) of an element, return that element.
3546 - If LINK path exactly matches any headline name, return that
3547 element. If more than one headline share that name, priority
3548 will be given to the one with the closest common ancestor, if
3549 any, or the first one in the parse tree otherwise.
3551 - Otherwise, return nil.
3557 ;; First try to find a matching "<<path>>" unless user specified
3558 ;; he was looking for an headline (path starts with a *
3559 ;; character).
3563 return target)))
3564 ;; Then try to find an element with a matching "#+NAME: path"
3565 ;; affiliated keyword.
3572 ;; Last case: link either points to an headline or to
3573 ;; nothingness. Try to find the source, with priority given to
3574 ;; headlines with the closest common ancestor. If such candidate
3575 ;; is found, return it, otherwise return nil.
3579 ;; Return first headline whose `:raw-value' property
3580 ;; is NAME in parse tree DATA, or nil.
3583 data 'headline
3587 name)
3588 headline))
3590 ;; Search among headlines sharing an ancestor with link,
3591 ;; from closest to farthest.
3599 ;; No match with a common ancestor: try the full parse-tree.
3605 "Return headline referenced as LINK destination.
3607 INFO is a plist used as a communication channel.
3609 Return value can be the headline element matched in current parse
3613 ;; First check if id is within the current parse tree.
3619 headline))
3621 ;; Otherwise, look for external files.
3625 "Return radio-target object referenced as LINK destination.
3627 INFO is a plist used as a communication channel.
3629 Return value can be a radio-target object or nil. Assume LINK
3639 ;;;; For References
3640 ;;
3641 ;; `org-export-get-ordinal' associates a sequence number to any object
3642 ;; or element.
3645 "Return ordinal number of an element or object.
3647 ELEMENT is the element or object considered. INFO is the plist
3648 used as a communication channel.
3650 Optional argument TYPES, when non-nil, is a list of element or
3651 object types, as symbols, that should also be counted in.
3652 Otherwise, only provided element's type is considered.
3654 Optional argument PREDICATE is a function returning a non-nil
3655 value if the current element or object should be counted in. It
3656 accepts two arguments: the element or object being considered and
3657 the plist used as a communication channel. This allows to count
3658 only a certain type of objects (i.e. inline images).
3660 Return value is a list of numbers if ELEMENT is an headline or an
3661 item. It is nil for keywords. It represents the footnote number
3662 for footnote definitions and footnote references. If ELEMENT is
3663 a target, return the same value as if ELEMENT was the closest
3664 table, item or headline containing the target. In any other
3665 case, return the sequence number of ELEMENT among elements or
3666 objects of the same type."
3667 ;; A target keyword, representing an invisible target, never has
3668 ;; a sequence number.
3670 ;; Ordinal of a target object refer to the ordinal of the closest
3671 ;; table, item, or headline containing the object.
3675 when
3679 table))
3680 return parent)))
3682 ;; Special case 1: An headline returns its number as a list.
3684 ;; Special case 2: An item returns its number as a list.
3688 struct
3695 ;; Increment counter until ELEMENT is found again.
3706 ;;;; For Src-Blocks
3707 ;;
3708 ;; `org-export-get-loc' counts number of code lines accumulated in
3709 ;; src-block or example-block elements with a "+n" switch until
3710 ;; a given element, excluded. Note: "-n" switches reset that count.
3711 ;;
3712 ;; `org-export-unravel-code' extracts source code (along with a code
3713 ;; references alist) from an `element-block' or `src-block' type
3714 ;; element.
3715 ;;
3716 ;; `org-export-format-code' applies a formatting function to each line
3717 ;; of code, providing relative line number and code reference when
3718 ;; appropriate. Since it doesn't access the original element from
3719 ;; which the source code is coming, it expects from the code calling
3720 ;; it to know if lines should be numbered and if code references
3721 ;; should appear.
3722 ;;
3723 ;; Eventually, `org-export-format-code-default' is a higher-level
3724 ;; function (it makes use of the two previous functions) which handles
3725 ;; line numbering and code references inclusion, and returns source
3726 ;; code in a format suitable for plain text or verbatim output.
3729 "Return accumulated lines of code up to ELEMENT.
3731 INFO is the plist used as a communication channel.
3733 ELEMENT is excluded from count."
3740 ;; ELEMENT is reached: Quit the loop.
3742 ;; Only count lines from src-block and example-block elements
3743 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3747 ;; Accumulate locs or reset them.
3751 ;; Return nil to stay in the loop.
3752 nil)))
3754 ;; Return value.
3755 loc))
3758 "Clean source code and extract references out of it.
3760 ELEMENT has either a `src-block' an `example-block' type.
3762 Return a cons cell whose CAR is the source code, cleaned from any
3763 reference and protective comma and CDR is an alist between
3764 relative line number (integer) and name of code reference on that
3765 line (string)."
3767 ;; Get code and clean it. Remove blank lines at its
3768 ;; beginning and end.
3774 ;; If appropriate, remove global indentation.
3777 c
3779 ;; Get format used for references.
3782 org-coderef-label-format)))
3783 ;; Build a regexp matching a loc with a reference.
3788 ;; Return value.
3790 ;; Code with references removed.
3796 ;; Ref line: remove ref, and signal its position in REFS.
3800 ;; Reference alist.
3801 refs)))
3804 "Format CODE by applying FUN line-wise and return it.
3806 CODE is a string representing the code to format. FUN is
3807 a function. It must accept three arguments: a line of
3808 code (string), the current line number (integer) or nil and the
3809 reference associated to the current line (string) or nil.
3811 Optional argument NUM-LINES can be an integer representing the
3812 number of code lines accumulated until the current code. Line
3813 numbers passed to FUN will take it into account. If it is nil,
3814 FUN's second argument will always be nil. This number can be
3815 obtained with `org-export-get-loc' function.
3817 Optional argument REF-ALIST can be an alist between relative line
3818 number (i.e. ignoring NUM-LINES) and the name of the code
3819 reference on it. If it is nil, FUN's third argument will always
3820 be nil. It can be obtained through the use of
3821 `org-export-unravel-code' function."
3833 "Return source code from ELEMENT, formatted in a standard way.
3835 ELEMENT is either a `src-block' or `example-block' element. INFO
3836 is a plist used as a communication channel.
3838 This function takes care of line numbering and code references
3839 inclusion. Line numbers, when applicable, appear at the
3840 beginning of the line, separated from the code by two white
3841 spaces. Code references, on the other hand, appear flushed to
3842 the right, separated by six white spaces from the widest line of
3843 code."
3844 ;; Extract code and references.
3850 ;; Handle line numbering.
3859 ;; Prepare references display, if required. Any reference
3860 ;; should start six columns after the widest line of code,
3861 ;; wrapped with parenthesis.
3866 code
3870 number-str
3871 loc
3877 num-start refs)))
3880 ;;;; For Tables
3881 ;;
3882 ;; `org-export-table-has-special-column-p' and and
3883 ;; `org-export-table-row-is-special-p' are predicates used to look for
3884 ;; meta-information about the table structure.
3885 ;;
3886 ;; `org-table-has-header-p' tells when the rows before the first rule
3887 ;; should be considered as table's header.
3888 ;;
3889 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3890 ;; and `org-export-table-cell-borders' extract information from
3891 ;; a table-cell element.
3892 ;;
3893 ;; `org-export-table-dimensions' gives the number on rows and columns
3894 ;; in the table, ignoring horizontal rules and special columns.
3895 ;; `org-export-table-cell-address', given a table-cell object, returns
3896 ;; the absolute address of a cell. On the other hand,
3897 ;; `org-export-get-table-cell-at' does the contrary.
3898 ;;
3899 ;; `org-export-table-cell-starts-colgroup-p',
3900 ;; `org-export-table-cell-ends-colgroup-p',
3901 ;; `org-export-table-row-starts-rowgroup-p',
3902 ;; `org-export-table-row-ends-rowgroup-p',
3903 ;; `org-export-table-row-starts-header-p' and
3904 ;; `org-export-table-row-ends-header-p' indicate position of current
3905 ;; row or cell within the table.
3908 "Non-nil when TABLE has a special column.
3909 All special columns will be ignored during export."
3910 ;; The table has a special column when every first cell of every row
3911 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3912 ;; "*" "_" and "^". Though, do not consider a first row containing
3913 ;; only empty cells as special.
3929 "Non-nil when TABLE has an header.
3931 INFO is a plist used as a communication channel.
3933 A table has an header when it contains at least two row groups."
3936 table 'table-row
3944 info)))
3947 "Non-nil if TABLE-ROW is considered special.
3949 INFO is a plist used as the communication channel.
3951 All special rows will be ignored during export."
3955 ;; A row is special either when...
3957 ;; ... it starts with a field only containing "/",
3959 ;; ... the table contains a special column and the row start
3960 ;; with a marking character among, "^", "_", "$" or "!",
3964 ;; ... it contains only alignment cookies and empty cells.
3970 ;; Since VALUE is a secondary string, the following
3971 ;; checks avoid expanding it with `org-export-data'.
3983 "Return TABLE-ROW's group.
3985 INFO is a plist used as the communication channel.
3987 Return value is the group number, as an integer, or nil special
3988 rows and table rules. Group 1 is also table's header."
4005 "Return TABLE-CELL contents width.
4007 INFO is a plist used as the communication channel.
4009 Return value is the width given by the last width cookie in the
4010 same column as TABLE-CELL, or nil."
4015 cookie-width)
4019 ;; In a special row, try to find a width cookie at COLUMN.
4023 ;; The following checks avoid expanding unnecessarily the
4024 ;; cell with `org-export-data'
4032 ;; Ignore table rules.
4035 ;; Return value.
4036 cookie-width))
4039 "Return TABLE-CELL contents alignment.
4041 INFO is a plist used as the communication channel.
4043 Return alignment as specified by the last alignment cookie in the
4044 same column as TABLE-CELL. If no such cookie is found, a default
4045 alignment value will be deduced from fraction of numbers in the
4046 column (see `org-table-number-fraction' for more information).
4047 Possible values are `left', `right' and `center'."
4054 cookie-align)
4058 ;; In a special row, try to find an alignment cookie at
4059 ;; COLUMN.
4063 ;; Since VALUE is a secondary string, the following checks
4064 ;; avoid useless expansion through `org-export-data'.
4072 ;; Ignore table rules.
4074 ;; In a standard row, check if cell's contents are expressing
4075 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4076 ;; Though, don't bother if an alignment cookie has already
4077 ;; defined cell's alignment.
4082 info)))
4087 ;; Return value. Alignment specified by cookies has precedence
4088 ;; over alignment deduced from cells contents.
4097 "Return TABLE-CELL borders.
4099 INFO is a plist used as a communication channel.
4101 Return value is a list of symbols, or nil. Possible values are:
4102 `top', `bottom', `above', `below', `left' and `right'. Note:
4103 `top' (resp. `bottom') only happen for a cell in the first
4104 row (resp. last row) of the table, ignoring table rules, if any.
4106 Returned borders ignore special rows."
4109 borders)
4110 ;; Top/above border? TABLE-CELL has a border above when a rule
4111 ;; used to demarcate row groups can be found above. Hence,
4112 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4113 ;; another regular row has to be found above that rule.
4122 ;; Look at every row before the current one.
4124 ;; No rule above, or rule found starts the table (ignoring any
4125 ;; special row): TABLE-CELL is at the top of the table.
4128 ;; Bottom/below border? TABLE-CELL has a border below when next
4129 ;; non-regular row below is a rule.
4138 ;; Look at every row after the current one.
4140 ;; No rule below, or rule found ends the table (modulo some
4141 ;; special row): TABLE-CELL is at the bottom of the table.
4144 ;; Right/left borders? They can only be specified by column
4145 ;; groups. Column groups are defined in a row starting with "/".
4146 ;; Also a column groups row only contains "<", "<>", ">" or blank
4147 ;; cells.
4164 ;; There's a left border when previous cell, if
4165 ;; any, ends a group, or current one starts one.
4171 ;; There's a right border when next cell, if any,
4172 ;; starts a group, or current one ends one.
4179 ;; Table rows are read in reverse order so last column groups
4180 ;; row has precedence over any previous one.
4182 ;; Return value.
4183 borders))
4186 "Non-nil when TABLE-CELL is at the beginning of a row group.
4187 INFO is a plist used as a communication channel."
4188 ;; A cell starts a column group either when it is at the beginning
4189 ;; of a row (or after the special column, if any) or when it has
4190 ;; a left border.
4194 table-cell)
4198 "Non-nil when TABLE-CELL is at the end of a row group.
4199 INFO is a plist used as a communication channel."
4200 ;; A cell ends a column group either when it is at the end of a row
4201 ;; or when it has a right border.
4204 table-cell)
4208 "Non-nil when TABLE-ROW is at the beginning of a column group.
4209 INFO is a plist used as a communication channel."
4217 "Non-nil when TABLE-ROW is at the end of a column group.
4218 INFO is a plist used as a communication channel."
4226 "Non-nil when TABLE-ROW is the first table header's row.
4227 INFO is a plist used as a communication channel."
4234 "Non-nil when TABLE-ROW is the last table header's row.
4235 INFO is a plist used as a communication channel."
4242 "Return TABLE dimensions.
4244 INFO is a plist used as a communication channel.
4246 Return value is a CONS like (ROWS . COLUMNS) where
4247 ROWS (resp. COLUMNS) is the number of exportable
4248 rows (resp. columns)."
4250 ;; Set number of rows, and extract first one.
4252 table 'table-row
4257 ;; Set number of columns.
4259 ;; Return value.
4263 "Return address of a regular TABLE-CELL object.
4265 TABLE-CELL is the cell considered. INFO is a plist used as
4266 a communication channel.
4268 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4269 zero-based index. Only exportable cells are considered. The
4270 function returns nil for other cells."
4273 ;; Ignore cells in special rows or in special column.
4278 ;; Row number.
4281 table 'table-row
4287 ;; Column number.
4290 table-row 'table-cell
4296 "Return regular table-cell object at ADDRESS in TABLE.
4298 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4299 zero-based index. TABLE is a table type element. INFO is
4300 a plist used as a communication channel.
4302 If no table-cell, among exportable cells, is found at ADDRESS,
4303 return nil."
4306 ;; Row at (car address) or nil.
4309 table 'table-row
4315 'table-cell
4322 ;;;; For Tables Of Contents
4323 ;;
4324 ;; `org-export-collect-headlines' builds a list of all exportable
4325 ;; headline elements, maybe limited to a certain depth. One can then
4326 ;; easily parse it and transcode it.
4327 ;;
4328 ;; Building lists of tables, figures or listings is quite similar.
4329 ;; Once the generic function `org-export-collect-elements' is defined,
4330 ;; `org-export-collect-tables', `org-export-collect-figures' and
4331 ;; `org-export-collect-listings' can be derived from it.
4334 "Collect headlines in order to build a table of contents.
4336 INFO is a plist used as a communication channel.
4338 When optional argument N is an integer, it specifies the depth of
4339 the table of contents. Otherwise, it is set to the value of the
4340 last headline level. See `org-export-headline-levels' for more
4341 information.
4343 Return a list of all exportable headlines as parsed elements."
4347 'headline
4349 ;; Strip contents from HEADLINE.
4352 info))
4355 "Collect referenceable elements of a determined type.
4357 TYPE can be a symbol or a list of symbols specifying element
4358 types to search. Only elements with a caption are collected.
4360 INFO is a plist used as a communication channel.
4362 When non-nil, optional argument PREDICATE is a function accepting
4363 one argument, an element of type TYPE. It returns a non-nil
4364 value when that element should be collected.
4366 Return a list of all elements found, in order of appearance."
4372 element))
4373 info))
4376 "Build a list of tables.
4377 INFO is a plist used as a communication channel.
4379 Return a list of table elements with a caption."
4383 "Build a list of figures.
4385 INFO is a plist used as a communication channel. PREDICATE is
4386 a function which accepts one argument: a paragraph element and
4387 whose return value is non-nil when that element should be
4388 collected.
4390 A figure is a paragraph type element, with a caption, verifying
4392 a vague concept that may depend on back-end.
4394 Return a list of elements recognized as figures."
4398 "Build a list of src blocks.
4400 INFO is a plist used as a communication channel.
4402 Return a list of src-block elements with a caption."
4406 ;;;; For Timestamps
4407 ;;
4408 ;; `org-export-timestamp-has-time-p' is a predicate to know if hours
4409 ;; and minutes are defined in a given timestamp.
4410 ;;
4411 ;; `org-export-format-timestamp' allows to format a timestamp object
4412 ;; with an arbitrary format string.
4415 "Non-nil when TIMESTAMP has a time specified."
4419 "Format a TIMESTAMP element into a string.
4421 FORMAT is a format specifier to be passed to
4422 `format-time-string'.
4424 When optional argument END is non-nil, use end of date-range or
4425 time-range, if possible.
4427 When optional argument UTC is non-nil, time will be expressed as
4428 Universal Time."
4430 format
4438 utc))
4441 "Extract a timestamp object from a date or time range.
4443 TIMESTAMP is a timestamp object. END, when non-nil, means extract
4444 the end of the range. Otherwise, extract its start.
4446 Return a new timestamp object sharing the same parent as
4447 TIMESTAMP."
4451 ;; Set new type.
4454 ;; Copy start properties over end properties if END is
4455 ;; non-nil. Otherwise, copy end properties over `start' ones.
4463 split-ts
4467 ;; Eventually refresh `:raw-value'.
4473 "Apply `org-translate-time' on a TIMESTAMP object.
4474 When optional argument BOUNDARY is non-nil, it is either the
4475 symbol `start' or `end'. In this case, only translate the
4476 starting or ending part of TIMESTAMP if it is a date or time
4477 range. Otherwise, translate both parts."
4485 "--"
4491 :raw-value
4496 ;;;; Smart Quotes
4497 ;;
4498 ;; The main function for the smart quotes sub-system is
4499 ;; `org-export-activate-smart-quotes', which replaces every quote in
4500 ;; a given string from the parse tree with its "smart" counterpart.
4501 ;;
4502 ;; Dictionary for smart quotes is stored in
4503 ;; `org-export-smart-quotes-alist'.
4504 ;;
4505 ;; Internally, regexps matching potential smart quotes (checks at
4506 ;; string boundaries are also necessary) are defined in
4507 ;; `org-export-smart-quotes-regexps'.
4544 "Smart quotes translations.
4546 Alist whose CAR is a language string and CDR is an alist with
4547 quote type as key and a plist associating various encodings to
4548 their translation as value.
4550 A quote type can be any symbol among `opening-double-quote',
4551 `closing-double-quote', `opening-single-quote',
4552 `closing-single-quote' and `apostrophe'.
4554 Valid encodings include `:utf-8', `:html', `:latex' and
4555 `:texinfo'.
4561 ;; Possible opening quote at beginning of string.
4563 ;; Possible closing quote at beginning of string.
4565 ;; Possible apostrophe at beginning of string.
4567 ;; Opening single and double quotes.
4569 ;; Closing single and double quotes.
4571 ;; Apostrophe.
4573 ;; Possible opening quote at end of string.
4575 ;; Possible closing quote at end of string.
4577 ;; Possible apostrophe at end of string.
4579 "List of regexps matching a quote or an apostrophe.
4585 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4586 `:utf-8'. INFO is a plist used as a communication channel.
4588 The function has to retrieve information about string
4589 surroundings in parse tree. It can only happen with an
4590 unmodified string. Thus, if S has already been through another
4591 process, a non-nil ORIGINAL optional argument will provide that
4592 original string.
4594 Return the new string."
4601 ;; Return smart quote associated to a give quote Q, as
4602 ;; a string. TYPE is a symbol among `open', `close' and
4603 ;; `apostrophe'.
4613 org-export-smart-quotes-alist))))
4614 encoding)
4615 q)))))
4617 ;; Only a quote: no regexp can match. We have to check both
4618 ;; sides and decide what to do.
4626 ;; 1. Replace quote character at the beginning of S.
4628 ;; Apostrophe?
4634 ;; Closing quote?
4640 ;; Opening quote?
4646 ;; 2. Replace quotes in the middle of the string.
4648 ;; Opening quotes.
4654 ;; Closing quotes.
4660 ;; Apostrophes.
4665 ;; 3. Replace quote character at the end of S.
4667 ;; Apostrophe?
4672 ;; Closing quote?
4678 ;; Opening quote?
4683 ;; Return string with smart quotes.
4684 s))))
4686 ;;;; Topology
4687 ;;
4688 ;; Here are various functions to retrieve information about the
4689 ;; neighbourhood of a given element or object. Neighbours of interest
4690 ;; are direct parent (`org-export-get-parent'), parent headline
4691 ;; (`org-export-get-parent-headline'), first element containing an
4692 ;; object, (`org-export-get-parent-element'), parent table
4693 ;; (`org-export-get-parent-table'), previous element or object
4694 ;; (`org-export-get-previous-element') and next element or object
4695 ;; (`org-export-get-next-element').
4696 ;;
4697 ;; `org-export-get-genealogy' returns the full genealogy of a given
4698 ;; element or object, from closest parent to full parse tree.
4701 "Return BLOB parent or nil.
4702 BLOB is the element or object considered."
4706 "Return full genealogy relative to a given element or object.
4708 BLOB is the element or object being considered.
4710 Ancestors are returned from closest to farthest, the last one
4711 being the full parse tree."
4718 "Return BLOB parent headline or nil.
4719 BLOB is the element or object being considered."
4723 parent))
4726 "Return first element containing OBJECT or nil.
4727 OBJECT is the object to consider."
4731 parent))
4734 "Return OBJECT parent table or nil.
4735 OBJECT is either a `table-cell' or `table-element' type object."
4739 parent))
4742 "Return previous element or object.
4744 BLOB is an element or object. INFO is a plist used as
4745 a communication channel. Return previous exportable element or
4746 object, a string, or nil.
4748 When optional argument N is a positive integer, return a list
4749 containing up to N siblings before BLOB, from closest to
4750 farthest. With any other non-nil value, return a list containing
4751 all of them."
4753 ;; An object can belong to the contents of its parent or
4754 ;; to a secondary string. We check the latter option
4755 ;; first.
4758 org-element-all-elements))
4762 org-element-secondary-value-alist))
4763 parent)))
4766 prev)
4778 "Return next element or object.
4780 BLOB is an element or object. INFO is a plist used as
4781 a communication channel. Return next exportable element or
4782 object, a string, or nil.
4784 When optional argument N is a positive integer, return a list
4785 containing up to N siblings after BLOB, from closest to farthest.
4786 With any other non-nil value, return a list containing all of
4787 them."
4789 ;; An object can belong to the contents of its parent or to
4790 ;; a secondary string. We check the latter option first.
4793 org-element-all-objects))
4797 org-element-secondary-value-alist))
4798 parent)))
4801 next)
4809 siblings)
4813 ;;;; Translation
4814 ;;
4815 ;; `org-export-translate' translates a string according to language
4816 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4817 ;; variable and a specified charset. `org-export-dictionary' contains
4818 ;; the dictionary used for the translation.
4940 "Dictionary for export engine.
4942 Alist whose CAR is the string to translate and CDR is an alist
4943 whose CAR is the language string and CDR is a plist whose
4944 properties are possible charsets and values translated terms.
4946 It is used as a database for `org-export-translate'. Since this
4947 function returns the string as-is if no translation was found,
4948 the variable only needs to record values different from the
4952 "Translate string S according to language specification.
4954 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4955 and `:utf-8'. INFO is a plist used as a communication channel.
4957 Translation depends on `:language' property. Return the
4958 translated string. If no translation is found, try to fall back
4959 to `:default' encoding. If it fails, return S."
4965 s)))
4968 \f
4969 ;;; Asynchronous Export
4970 ;;
4971 ;; `org-export-async-start' is the entry point for asynchronous
4972 ;; export. It recreates current buffer (including visibility,
4973 ;; narrowing and visited file) in an external Emacs process, and
4974 ;; evaluates a command there. It then applies a function on the
4975 ;; returned results in the current process.
4976 ;;
4977 ;; Asynchronously generated results are never displayed directly.
4978 ;; Instead, they are stored in `org-export-stack-contents'. They can
4979 ;; then be retrieved by calling `org-export-stack'.
4980 ;;
4981 ;; Export Stack is viewed through a dedicated major mode
4982 ;;`org-export-stack-mode' and tools: `org-export--stack-refresh',
4983 ;;`org-export--stack-delete', `org-export--stack-view' and
4984 ;;`org-export--stack-clear'.
4985 ;;
4986 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
4987 ;; It should used whenever `org-export-async-start' is called.
4990 "Call function FUN on the results returned by BODY evaluation.
4992 BODY evaluation happens in an asynchronous process, from a buffer
4993 which is an exact copy of the current one.
4995 Use `org-export-add-to-stack' in FUN in order to register results
4996 in the stack. Examples for, respectively a temporary buffer and
4997 a file are:
4999 \(org-export-async-start
5000 \(lambda (output)
5002 \(erase-buffer)
5003 \(insert output)
5004 \(goto-char (point-min))
5005 \(org-export-add-to-stack (current-buffer) 'backend)))
5006 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5008 and
5010 \(org-export-async-start
5011 \(lambda (f) (org-export-add-to-stack f 'backend))
5012 `(expand-file-name
5013 \(org-export-to-file
5014 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5017 ;; Write the full sexp evaluating BODY in a copy of the current
5018 ;; buffer to a temporary file, as it may be too long for program
5019 ;; args in `start-process'.
5026 "%S"
5029 ;; Initialize `org-mode' in the external process.
5031 ;; Re-create current buffer there.
5034 ;; Sexp to evaluate in the buffer.
5036 ;; Start external process.
5039 (,process
5044 "-l" org-export-async-init-file
5046 ;; Register running process in stack.
5048 ;; Set-up sentinel in order to catch results.
5050 ,process
5074 "Add a new result to export stack if not present already.
5076 SOURCE is a buffer or a file name containing export results.
5077 BACKEND is a symbol representing export back-end used to generate
5078 it.
5080 Entries already pointing to SOURCE and unavailable entries are
5081 removed beforehand. Return the new stack."
5087 "Menu for asynchronous export results and running processes."
5097 "Return source from export results at point in stack."
5104 source
5105 ;; SOURCE is not consistent with current line. The stack
5106 ;; view is outdated.
5110 "Remove all entries from export stack."
5115 "Refresh the asynchronous export stack.
5116 DUMMY is ignored. Unavailable sources are removed from the list.
5117 Return the new stack."
5127 ;; Back-end.
5129 ;; Age.
5132 ;; Compute age of the results.
5134 "%4h:%.2m "
5136 ;; Source.
5141 ;; Clear stack from exited processes, dead buffers or
5142 ;; non-existent files.
5154 "Remove export results at point from stack.
5155 If optional argument SOURCE is non-nil, remove it instead."
5160 org-export-stack-contents))))
5163 "View export results at point in stack."
5177 (define-key km "p" 'previous-line)
5178 (define-key km "\C-p" 'previous-line)
5179 (define-key km "\C-?" 'previous-line)
5180 (define-key km [up] 'previous-line)
5181 (define-key km "C" 'org-export--stack-clear)
5182 (define-key km "v" 'org-export--stack-view)
5183 (define-key km (kbd "RET") 'org-export--stack-view)
5184 (define-key km "d" 'org-export--stack-remove)
5185 km)
5186 "Keymap for Org Export Stack.")
5188 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5189 "Mode for displaying asynchronous export stack.
5192 stack.
5194 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export--stack-view] to view export output
5195 on current line, \\[org-export--stack-remove] to remove it from the stack and \\[org-export--stack-clear] to clear
5196 stack completely.
5198 Removal entries in an Org Export Stack buffer doesn't affect
5199 files or buffers, only view in the stack.
5202 (abbrev-mode 0)
5203 (auto-fill-mode 0)
5204 (setq buffer-read-only t
5205 buffer-undo-list t
5206 truncate-lines t
5207 header-line-format
5208 '(:eval
5209 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5210 (add-hook 'post-command-hook 'org-export--stack-refresh nil t)
5211 (set (make-local-variable 'revert-buffer-function)
5212 'org-export--stack-refresh))
5215 \f
5216 ;;; The Dispatcher
5217 ;;
5218 ;; `org-export-dispatch' is the standard interactive way to start an
5219 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
5220 ;; for its interface, which, in turn, delegates response to key
5221 ;; pressed to `org-export-dispatch-action'.
5223 ;;;###autoload
5224 (defun org-export-dispatch (&optional arg)
5225 "Export dispatcher for Org mode.
5227 It provides an access to common export related tasks in a buffer.
5228 Its interface comes in two flavours: standard and expert. While
5229 both share the same set of bindings, only the former displays the
5230 valid keys associations. Set `org-export-dispatch-use-expert-ui'
5231 to switch to one or the other.
5233 When called with C-u prefix ARG, repeat the last export action,
5234 with the same set of options used back then, on the current
5235 buffer.
5237 When called with a double universal argument, display the
5238 asynchronous export stack directly."
5239 (interactive "P")
5240 (let* ((input
5241 (cond ((equal arg '(16)) '(stack))
5242 ((and arg org-export-dispatch-last-action))
5243 (t (save-window-excursion
5244 (unwind-protect
5245 ;; Store this export command.
5246 (setq org-export-dispatch-last-action
5247 (org-export-dispatch-ui
5248 (list org-export-initial-scope
5249 (and org-export-in-background 'async))
5250 nil
5251 org-export-dispatch-use-expert-ui))
5252 (and (get-buffer "*Org Export Dispatcher*")
5253 (kill-buffer "*Org Export Dispatcher*")))))))
5254 (action (car input))
5255 (optns (cdr input)))
5256 (case action
5257 ;; First handle special hard-coded actions.
5258 (stack (org-export-stack))
5259 (publish-current-file
5260 (org-e-publish-current-file (memq 'force optns) (memq 'async optns)))
5261 (publish-current-project
5262 (org-e-publish-current-project (memq 'force optns) (memq 'async optns)))
5263 (publish-choose-project
5264 (org-e-publish (assoc (org-icompleting-read
5265 "Publish project: "
5266 org-e-publish-project-alist nil t)
5267 org-e-publish-project-alist)
5268 (memq 'force optns)
5269 (memq 'async optns)))
5270 (publish-all (org-e-publish-all (memq 'force optns) (memq 'async optns)))
5271 (otherwise (funcall action
5272 ;; Return a symbol instead of a list to ease
5273 ;; asynchronous export macro use.
5274 (and (memq 'async optns) t)
5275 (and (memq 'subtree optns) t)
5276 (and (memq 'visible optns) t)
5277 (and (memq 'body optns) t))))))
5279 (defun org-export-dispatch-ui (options first-key expertp)
5280 "Handle interface for `org-export-dispatch'.
5282 OPTIONS is a list containing current interactive options set for
5283 export. It can contain any of the following symbols:
5284 `body' toggles a body-only export
5285 `subtree' restricts export to current subtree
5286 `visible' restricts export to visible part of buffer.
5287 `force' force publishing files.
5288 `async' use asynchronous export process
5290 FIRST-KEY is the key pressed to select the first level menu. It
5291 is nil when this menu hasn't been selected yet.
5293 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5294 buffer is provided, but indications about currently active
5295 options are given in the prompt. Moreover, \[?] allows to switch
5296 back to standard interface."
5297 (let* ((fontify-key
5298 (lambda (key &optional access-key)
5299 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5300 ;; non-nil is the required first-level key to activate
5301 ;; KEY. When its value is t, activate KEY independently
5302 ;; on the first key, if any. A nil value means KEY will
5303 ;; only be activated at first level.
5304 (if (or (eq access-key t) (eq access-key first-key))
5305 (org-add-props key nil 'face 'org-warning)
5306 (org-no-properties key))))
5307 ;; Prepare menu entries by extracting them from
5308 ;; `org-export-registered-backends', and sorting them by
5309 ;; access key and by ordinal, if any.
5310 (backends (sort
5311 (sort
5312 (delq nil
5313 (mapcar (lambda (b)
5314 (org-export-backend-menu (car b)))
5315 org-export-registered-backends))
5316 (lambda (a b)
5317 (let ((key-a (nth 1 a))
5318 (key-b (nth 1 b)))
5319 (cond ((and (numberp key-a) (numberp key-b))
5320 (< key-a key-b))
5321 ((numberp key-b) t)))))
5322 (lambda (a b) (< (car a) (car b)))))
5323 ;; Compute a list of allowed keys based on the first key
5324 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4, ?5 and ?q)
5325 ;; are always available.
5326 (allowed-keys
5327 (nconc (list ?1 ?2 ?3 ?4 ?5)
5328 (if (not first-key) (org-uniquify (mapcar 'car backends))
5329 (let (sub-menu)
5330 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5331 (when (eq (car backend) first-key)
5332 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5333 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5334 ((not first-key) (list ?P)))
5335 (list ?&)
5336 (when expertp (list ??))
5337 (list ?q)))
5338 ;; Build the help menu for standard UI.
5339 (help
5340 (unless expertp
5341 (concat
5342 ;; Options are hard-coded.
5343 (format "Options
5344 [%s] Body only: %s [%s] Visible only: %s
5345 [%s] Export scope: %s [%s] Force publishing: %s
5347 (funcall fontify-key "1" t)
5348 (if (memq 'body options) "On " "Off")
5349 (funcall fontify-key "2" t)
5350 (if (memq 'visible options) "On " "Off")
5351 (funcall fontify-key "3" t)
5352 (if (memq 'subtree options) "Subtree" "Buffer ")
5353 (funcall fontify-key "4" t)
5354 (if (memq 'force options) "On " "Off")
5355 (funcall fontify-key "5" t)
5356 (if (memq 'async options) "On " "Off"))
5357 ;; Display registered back-end entries. When a key
5358 ;; appears for the second time, do not create another
5359 ;; entry, but append its sub-menu to existing menu.
5360 (let (last-key)
5361 (mapconcat
5362 (lambda (entry)
5363 (let ((top-key (car entry)))
5364 (concat
5365 (unless (eq top-key last-key)
5366 (setq last-key top-key)
5368 (funcall fontify-key (char-to-string top-key))
5369 (nth 1 entry)))
5370 (let ((sub-menu (nth 2 entry)))
5371 (unless (functionp sub-menu)
5372 ;; Split sub-menu into two columns.
5373 (let ((index -1))
5374 (concat
5375 (mapconcat
5376 (lambda (sub-entry)
5377 (incf index)
5378 (format
5379 (if (zerop (mod index 2)) " [%s] %-24s"
5381 (funcall fontify-key
5382 (char-to-string (car sub-entry))
5383 top-key)
5384 (nth 1 sub-entry)))
5385 sub-menu "")
5387 backends ""))
5388 ;; Publishing menu is hard-coded.
5390 [%s] Current file [%s] Current project
5392 (funcall fontify-key "P")
5393 (funcall fontify-key "f" ?P)
5394 (funcall fontify-key "p" ?P)
5395 (funcall fontify-key "x" ?P)
5396 (funcall fontify-key "a" ?P))
5398 (format "\[%s] %s"
5399 (funcall fontify-key "q" t)
5400 (if first-key "Main menu" "Exit")))))
5401 ;; Build prompts for both standard and expert UI.
5402 (standard-prompt (unless expertp "Export command: "))
5403 (expert-prompt
5404 (when expertp
5405 (format
5406 "Export command (Options: %s%s%s%s%s) [%s]: "
5407 (if (memq 'body options) (funcall fontify-key "b" t) "-")
5408 (if (memq 'visible options) (funcall fontify-key "v" t) "-")
5409 (if (memq 'subtree options) (funcall fontify-key "s" t) "-")
5410 (if (memq 'force options) (funcall fontify-key "f" t) "-")
5411 (if (memq 'async options) (funcall fontify-key "a" t) "-")
5412 (concat allowed-keys)))))
5413 ;; With expert UI, just read key with a fancy prompt. In standard
5414 ;; UI, display an intrusive help buffer.
5415 (if expertp
5416 (org-export-dispatch-action
5417 expert-prompt allowed-keys backends options first-key expertp)
5418 ;; At first call, create frame layout in order to display menu.
5419 (unless (get-buffer "*Org Export Dispatcher*")
5420 (delete-other-windows)
5421 (org-switch-to-buffer-other-window
5422 (get-buffer-create "*Org Export Dispatcher*"))
5423 (setq cursor-type nil))
5424 ;; At this point, the buffer containing the menu exists and is
5425 ;; visible in the current window. So, refresh it.
5426 (with-current-buffer "*Org Export Dispatcher*"
5427 (erase-buffer)
5428 (insert help))
5429 (org-fit-window-to-buffer)
5430 (org-export-dispatch-action
5431 standard-prompt allowed-keys backends options first-key expertp))))
5433 (defun org-export-dispatch-action
5434 (prompt allowed-keys backends options first-key expertp)
5435 "Read a character from command input and act accordingly.
5437 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5438 a list of characters available at a given step in the process.
5439 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5440 EXPERTP are the same as defined in `org-export-dispatch-ui',
5441 which see.
5443 Toggle export options when required. Otherwise, return value is
5444 a list with action as CAR and a list of interactive export
5445 options as CDR."
5446 (let ((key (let ((k (read-char-exclusive prompt)))
5447 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
5448 ;; depending on user's key pressed.
5449 (if (< k 27) (+ k 96) k))))
5450 (cond
5451 ;; Ignore non-standard characters (i.e. "M-a") and
5452 ;; undefined associations.
5453 ((not (memq key allowed-keys))
5454 (ding)
5455 (unless expertp (message "Invalid key") (sit-for 1))
5456 (org-export-dispatch-ui options first-key expertp))
5457 ;; q key at first level aborts export. At second
5458 ;; level, cancel first key instead.
5459 ((eq key ?q) (if (not first-key) (error "Export aborted")
5460 (org-export-dispatch-ui options nil expertp)))
5461 ;; Help key: Switch back to standard interface if
5462 ;; expert UI was active.
5463 ((eq key ??) (org-export-dispatch-ui options first-key nil))
5464 ;; Switch to asynchronous export stack.
5465 ((eq key ?&) '(stack))
5466 ;; Toggle export options.
5467 ((memq key '(?1 ?2 ?3 ?4 ?5))
5468 (org-export-dispatch-ui
5469 (let ((option (case key (?1 'body) (?2 'visible) (?3 'subtree)
5470 (?4 'force) (?5 'async))))
5471 (if (memq option options) (remq option options)
5472 (cons option options)))
5473 first-key expertp))
5474 ;; Action selected: Send key and options back to
5475 ;; `org-export-dispatch'.
5476 ((or first-key (functionp (nth 2 (assq key backends))))
5477 (cons (cond
5478 ((not first-key) (nth 2 (assq key backends)))
5479 ;; Publishing actions are hard-coded. Send a special
5480 ;; signal to `org-export-dispatch'.
5481 ((eq first-key ?P)
5482 (case key
5483 (?f 'publish-current-file)
5484 (?p 'publish-current-project)
5485 (?x 'publish-choose-project)
5486 (?a 'publish-all)))
5487 ;; Return first action associated to FIRST-KEY + KEY
5488 ;; path. Indeed, derived backends can share the same
5489 ;; FIRST-KEY.
5490 (t (catch 'found
5491 (mapc (lambda (backend)
5492 (let ((match (assq key (nth 2 backend))))
5493 (when match (throw 'found (nth 2 match)))))
5494 (member (assq first-key backends) backends)))))
5495 options))
5496 ;; Otherwise, enter sub-menu.
5497 (t (org-export-dispatch-ui options key expertp)))))
5500 (provide 'org-export)
5501 ;;; org-export.el ends here