| blob | 09e0c82995c4f8f7089022867bb4638bf6999297 |
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
878 \(lambda (subtree visible body-only)
879 \(org-open-file
880 \(org-e-latex-export-to-pdf subtree visible body-only))))))
882 :options-alist
884 Alist between back-end specific properties introduced in
885 communication channel and how their value are acquired. See
886 `org-export-options-alist' for more information about
887 structure of the values."
906 ;; Register back-end.
910 ;; Tell parser to not parse EXPORT-BLOCK blocks.
917 ;; Splice in the body, if any.
921 "Create a new back-end as a variant of an existing one.
923 CHILD is the name of the derived back-end. PARENT is the name of
924 the parent back-end.
926 BODY can start with pre-defined keyword arguments. The following
927 keywords are understood:
929 :export-block
931 String, or list of strings, representing block names that
932 will not be parsed. This is used to specify blocks that will
933 contain raw code specific to the back-end. These blocks
934 still have to be handled by the relative `export-block' type
935 translator.
937 :filters-alist
939 Alist of filters that will overwrite or complete filters
940 defined in PARENT back-end. See `org-export-filters-alist'
941 for a list of allowed filters.
943 :menu-entry
945 Menu entry for the export dispatcher. See
946 `org-export-define-backend' for more information about the
947 expected value.
949 :options-alist
951 Alist of back-end specific properties that will overwrite or
952 complete those defined in PARENT back-end. Refer to
953 `org-export-options-alist' for more information about
954 structure of the values.
956 :translate-alist
958 Alist of element and object types and transcoders that will
959 overwrite or complete transcode table from PARENT back-end.
960 Refer to `org-export-define-backend' for detailed information
961 about transcoders.
964 as a variant of `e-latex' back-end with a custom template
965 function:
967 \(org-export-define-derived-backend my-latex e-latex
968 :translate-alist ((template . my-latex-template-fun)))
970 The back-end could then be called with, for example:
998 ;; Register back-end.
1002 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1009 ;; Splice in the body, if any.
1013 "Return filters for BACKEND."
1018 "Return menu entry for BACKEND."
1023 "Return export options for BACKEND."
1028 "Return translate table for BACKEND."
1033 "Signal an error if BACKEND isn't defined."
1038 "Non-nil if BACKEND is derived from one of BACKENDS."
1043 org-export-registered-backends))
1045 parent))
1048 \f
1049 ;;; The Communication Channel
1050 ;;
1051 ;; During export process, every function has access to a number of
1052 ;; properties. They are of two types:
1053 ;;
1054 ;; 1. Environment options are collected once at the very beginning of
1055 ;; the process, out of the original buffer and configuration.
1056 ;; Collecting them is handled by `org-export-get-environment'
1057 ;; function.
1058 ;;
1059 ;; Most environment options are defined through the
1060 ;; `org-export-options-alist' variable.
1061 ;;
1062 ;; 2. Tree properties are extracted directly from the parsed tree,
1063 ;; just before export, by `org-export-collect-tree-properties'.
1064 ;;
1065 ;; Here is the full list of properties available during transcode
1066 ;; process, with their category and their value type.
1067 ;;
1068 ;; + `:author' :: Author's name.
1069 ;; - category :: option
1070 ;; - type :: string
1071 ;;
1072 ;; + `:back-end' :: Current back-end used for transcoding.
1073 ;; - category :: tree
1074 ;; - type :: symbol
1075 ;;
1076 ;; + `:creator' :: String to write as creation information.
1077 ;; - category :: option
1078 ;; - type :: string
1079 ;;
1080 ;; + `:date' :: String to use as date.
1081 ;; - category :: option
1082 ;; - type :: string
1083 ;;
1084 ;; + `:description' :: Description text for the current data.
1085 ;; - category :: option
1086 ;; - type :: string
1087 ;;
1088 ;; + `:email' :: Author's email.
1089 ;; - category :: option
1090 ;; - type :: string
1091 ;;
1092 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1093 ;; process.
1094 ;; - category :: option
1095 ;; - type :: list of strings
1096 ;;
1097 ;; + `:exported-data' :: Hash table used for memoizing
1098 ;; `org-export-data'.
1099 ;; - category :: tree
1100 ;; - type :: hash table
1101 ;;
1102 ;; + `:filetags' :: List of global tags for buffer. Used by
1103 ;; `org-export-get-tags' to get tags with inheritance.
1104 ;; - category :: option
1105 ;; - type :: list of strings
1106 ;;
1107 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1108 ;; their definition, as parsed data. Only non-inlined footnotes
1109 ;; are represented in this alist. Also, every definition isn't
1110 ;; guaranteed to be referenced in the parse tree. The purpose of
1111 ;; this property is to preserve definitions from oblivion
1112 ;; (i.e. when the parse tree comes from a part of the original
1113 ;; buffer), it isn't meant for direct use in a back-end. To
1114 ;; retrieve a definition relative to a reference, use
1115 ;; `org-export-get-footnote-definition' instead.
1116 ;; - category :: option
1117 ;; - type :: alist (STRING . LIST)
1118 ;;
1119 ;; + `:headline-levels' :: Maximum level being exported as an
1120 ;; headline. Comparison is done with the relative level of
1121 ;; headlines in the parse tree, not necessarily with their
1122 ;; actual level.
1123 ;; - category :: option
1124 ;; - type :: integer
1125 ;;
1126 ;; + `:headline-offset' :: Difference between relative and real level
1127 ;; of headlines in the parse tree. For example, a value of -1
1128 ;; means a level 2 headline should be considered as level
1129 ;; 1 (cf. `org-export-get-relative-level').
1130 ;; - category :: tree
1131 ;; - type :: integer
1132 ;;
1133 ;; + `:headline-numbering' :: Alist between headlines and their
1134 ;; numbering, as a list of numbers
1135 ;; (cf. `org-export-get-headline-number').
1136 ;; - category :: tree
1137 ;; - type :: alist (INTEGER . LIST)
1138 ;;
1139 ;; + `:id-alist' :: Alist between ID strings and destination file's
1140 ;; path, relative to current directory. It is used by
1141 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1142 ;; external file.
1143 ;; - category :: option
1144 ;; - type :: alist (STRING . STRING)
1145 ;;
1146 ;; + `:ignore-list' :: List of elements and objects that should be
1147 ;; ignored during export.
1148 ;; - category :: tree
1149 ;; - type :: list of elements and objects
1150 ;;
1151 ;; + `:input-file' :: Full path to input file, if any.
1152 ;; - category :: option
1153 ;; - type :: string or nil
1154 ;;
1155 ;; + `:keywords' :: List of keywords attached to data.
1156 ;; - category :: option
1157 ;; - type :: string
1158 ;;
1159 ;; + `:language' :: Default language used for translations.
1160 ;; - category :: option
1161 ;; - type :: string
1162 ;;
1163 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1164 ;; transcoding.
1165 ;; - category :: option
1166 ;; - type :: list (as returned by `org-element-parse-buffer')
1167 ;;
1168 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1169 ;; all line breaks.
1170 ;; - category :: option
1171 ;; - type :: symbol (nil, t)
1172 ;;
1173 ;; + `:section-numbers' :: Non-nil means transcoding should add
1174 ;; section numbers to headlines.
1175 ;; - category :: option
1176 ;; - type :: symbol (nil, t)
1177 ;;
1178 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1179 ;; in transcoding. When such a tag is present, subtrees without
1180 ;; it are de facto excluded from the process. See
1181 ;; `use-select-tags'.
1182 ;; - category :: option
1183 ;; - type :: list of strings
1184 ;;
1185 ;; + `:target-list' :: List of targets encountered in the parse tree.
1186 ;; This is used to partly resolve "fuzzy" links
1187 ;; (cf. `org-export-resolve-fuzzy-link').
1188 ;; - category :: tree
1189 ;; - type :: list of strings
1190 ;;
1191 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1192 ;; a time stamp in the output.
1193 ;; - category :: option
1194 ;; - type :: symbol (nil, t)
1195 ;;
1196 ;; + `:translate-alist' :: Alist between element and object types and
1197 ;; transcoding functions relative to the current back-end.
1198 ;; Special keys `template' and `plain-text' are also possible.
1199 ;; - category :: option
1200 ;; - type :: alist (SYMBOL . FUNCTION)
1201 ;;
1202 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1203 ;; also be transcoded. If it is set to the `headline' symbol,
1204 ;; only the archived headline's name is retained.
1205 ;; - category :: option
1206 ;; - type :: symbol (nil, t, `headline')
1207 ;;
1208 ;; + `:with-author' :: Non-nil means author's name should be included
1209 ;; in the output.
1210 ;; - category :: option
1211 ;; - type :: symbol (nil, t)
1212 ;;
1213 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1214 ;; - category :: option
1215 ;; - type :: symbol (nil, t)
1216 ;;
1217 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1218 ;; inserted at the end of the transcoded string. If the value
1219 ;; is `comment', it should be commented.
1220 ;; - category :: option
1221 ;; - type :: symbol (`comment', nil, t)
1222 ;;
1223 ;; + `:with-date' :: Non-nil means output should contain a date.
1224 ;; - category :: option
1225 ;; - type :. symbol (nil, t)
1226 ;;
1227 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1228 ;; its value is a list of names, only drawers with such names
1229 ;; will be transcoded.
1230 ;; - category :: option
1231 ;; - type :: symbol (nil, t) or list of strings
1232 ;;
1233 ;; + `:with-email' :: Non-nil means output should contain author's
1234 ;; email.
1235 ;; - category :: option
1236 ;; - type :: symbol (nil, t)
1237 ;;
1238 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1239 ;; interpreted.
1240 ;; - category :: option
1241 ;; - type :: symbol (nil, t)
1242 ;;
1243 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1244 ;; strings starting with a colon as a fixed-with (verbatim) area.
1245 ;; - category :: option
1246 ;; - type :: symbol (nil, t)
1247 ;;
1248 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1249 ;; footnotes.
1250 ;; - category :: option
1251 ;; - type :: symbol (nil, t)
1252 ;;
1253 ;; + `:with-plannings' :: Non-nil means transcoding should include
1254 ;; planning info.
1255 ;; - category :: option
1256 ;; - type :: symbol (nil, t)
1257 ;;
1258 ;; + `:with-priority' :: Non-nil means transcoding should include
1259 ;; priority cookies.
1260 ;; - category :: option
1261 ;; - type :: symbol (nil, t)
1262 ;;
1263 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1264 ;; plain text.
1265 ;; - category :: option
1266 ;; - type :: symbol (nil, t)
1267 ;;
1268 ;; + `:with-special-strings' :: Non-nil means transcoding should
1269 ;; interpret special strings in plain text.
1270 ;; - category :: option
1271 ;; - type :: symbol (nil, t)
1272 ;;
1273 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1274 ;; interpret subscript and superscript. With a value of "{}",
1275 ;; only interpret those using curly brackets.
1276 ;; - category :: option
1277 ;; - type :: symbol (nil, {}, t)
1278 ;;
1279 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1280 ;; tables.
1281 ;; - category :: option
1282 ;; - type :: symbol (nil, t)
1283 ;;
1284 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1285 ;; headlines. A `not-in-toc' value will remove them from the
1286 ;; table of contents, if any, nonetheless.
1287 ;; - category :: option
1288 ;; - type :: symbol (nil, t, `not-in-toc')
1289 ;;
1290 ;; + `:with-tasks' :: Non-nil means transcoding should include
1291 ;; headlines with a TODO keyword. A `todo' value will only
1292 ;; include headlines with a todo type keyword while a `done'
1293 ;; value will do the contrary. If a list of strings is provided,
1294 ;; only tasks with keywords belonging to that list will be kept.
1295 ;; - category :: option
1296 ;; - type :: symbol (t, todo, done, nil) or list of strings
1297 ;;
1298 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1299 ;; time stamps. Special value `active' (resp. `inactive') ask to
1300 ;; export only active (resp. inactive) timestamps. Otherwise,
1301 ;; completely remove them.
1302 ;; - category :: option
1303 ;; - type :: symbol: (`active', `inactive', t, nil)
1304 ;;
1305 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1306 ;; added to the output. An integer value limits its depth.
1307 ;; - category :: option
1308 ;; - type :: symbol (nil, t or integer)
1309 ;;
1310 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1311 ;; include TODO keywords.
1312 ;; - category :: option
1313 ;; - type :: symbol (nil, t)
1316 ;;;; Environment Options
1317 ;;
1318 ;; Environment options encompass all parameters defined outside the
1319 ;; scope of the parsed data. They come from five sources, in
1320 ;; increasing precedence order:
1321 ;;
1322 ;; - Global variables,
1323 ;; - Buffer's attributes,
1324 ;; - Options keyword symbols,
1325 ;; - Buffer keywords,
1326 ;; - Subtree properties.
1327 ;;
1328 ;; The central internal function with regards to environment options
1329 ;; is `org-export-get-environment'. It updates global variables with
1330 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1331 ;; the different sources.
1332 ;;
1333 ;; The internal functions doing the retrieval are:
1334 ;; `org-export--get-global-options',
1335 ;; `org-export--get-buffer-attributes',
1336 ;; `org-export--parse-option-keyword',
1337 ;; `org-export--get-subtree-options' and
1338 ;; `org-export--get-inbuffer-options'
1339 ;;
1340 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1341 ;; take care of the part relative to "#+BIND:" keywords.
1344 "Collect export options from the current buffer.
1346 Optional argument BACKEND is a symbol specifying which back-end
1347 specific options to read, if any.
1349 When optional argument SUBTREEP is non-nil, assume the export is
1350 done against the current sub-tree.
1352 Third optional argument EXT-PLIST is a property list with
1353 external parameters overriding Org default settings, but still
1354 inferior to file-local settings."
1355 ;; First install #+BIND variables.
1357 ;; Get and prioritize export options...
1359 ;; ... from global variables...
1361 ;; ... from an external property list...
1362 ext-plist
1363 ;; ... from in-buffer settings...
1365 backend
1367 ;; ... and from subtree, when appropriate.
1369 ;; Eventually add misc. properties.
1371 :back-end
1372 backend
1373 :translate-alist
1375 :footnote-definition-alist
1376 ;; Footnotes definitions must be collected in the original
1377 ;; buffer, as there's no insurance that they will still be in
1378 ;; the parse tree, due to possible narrowing.
1392 alist))))
1393 alist))
1394 :id-alist
1395 ;; Collect id references.
1406 alist))))
1409 "Parse an OPTIONS line and return values as a plist.
1410 Optional argument BACKEND is a symbol specifying which back-end
1411 specific items to read, if any."
1414 ;; Build an alist between #+OPTION: item and property-name.
1419 all)))
1420 plist)
1425 options)
1430 alist)
1431 plist))
1434 "Get export options in subtree at point.
1435 Optional argument BACKEND is a symbol specifying back-end used
1436 for export. Return options as a plist."
1437 ;; For each buffer keyword, create an headline property setting the
1438 ;; same property in communication channel. The name for the property
1439 ;; is the keyword with "EXPORT_" appended to it.
1442 ;; Make sure point is at an heading.
1444 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1445 ;; title as its fallback value.
1451 plist :title
1454 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1458 ;; Handle other keywords. TITLE keyword is excluded as it has
1459 ;; been handled already.
1466 ;; Export properties are not case-sensitive.
1473 plist
1476 ;; Parse VALUE if required.
1480 ;; If BEHAVIOUR is `split' expected value is
1481 ;; a list of strings, not a string.
1484 ;; Also look for both general keywords and back-end specific
1485 ;; options if BACKEND is provided.
1487 org-export-options-alist)))
1488 ;; Return value.
1489 plist)))
1492 "Return current buffer export options, as a plist.
1494 Optional argument BACKEND, when non-nil, is a symbol specifying
1495 which back-end specific options should also be read in the
1496 process.
1498 Optional argument FILES is a list of setup files names read so
1499 far, used to avoid circular dependencies.
1501 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1505 ;; 1. Special keywords, as in `org-export-special-keywords'.
1519 ;; Avoid circular dependencies.
1534 ;; 2. Standard options, as in `org-export-options-alist'.
1536 ;; Also look for back-end specific options if
1537 ;; BACKEND is defined.
1539 ;; Build ALIST between keyword name and property name.
1543 all)))
1544 ;; Build regexp matching all keywords associated to export
1545 ;; options. Note: the search is case insensitive.
1559 plist prop
1560 ;; Handle value depending on specified BEHAVIOUR.
1573 ;; Parse keywords specified in
1574 ;; `org-element-document-properties'.
1582 plist prop
1585 org-element-document-properties))
1586 ;; 3. Return final value.
1587 plist)))
1590 "Return properties related to buffer attributes, as a plist."
1593 ;; Store full path of input file name, or nil. For internal use.
1594 :input-file visited-file
1601 "Return global export options as a plist.
1603 Optional argument BACKEND, if non-nil, is a symbol specifying
1604 which back-end specific export options should also be read in the
1605 process."
1608 ;; Output value.
1609 plist)
1614 plist
1616 ;; Eval default value provided. If keyword is a member
1617 ;; of `org-element-document-properties', parse it as
1618 ;; a secondary string before storing it.
1623 value
1626 all)
1627 ;; Return value.
1628 plist))
1632 "Can we use #+BIND values during export?
1633 By default this will ask for confirmation by the user, to divert
1634 possible security risks."
1639 org-export--allow-BIND-local)
1644 "Install the values from #+BIND lines as local variables.
1645 Variables must be installed before in-buffer options are
1646 retrieved."
1661 ;;;; Tree Properties
1662 ;;
1663 ;; Tree properties are information extracted from parse tree. They
1664 ;; are initialized at the beginning of the transcoding process by
1665 ;; `org-export-collect-tree-properties'.
1666 ;;
1667 ;; Dedicated functions focus on computing the value of specific tree
1668 ;; properties during initialization. Thus,
1669 ;; `org-export--populate-ignore-list' lists elements and objects that
1670 ;; should be skipped during export, `org-export--get-min-level' gets
1671 ;; the minimal exportable level, used as a basis to compute relative
1672 ;; level for headlines. Eventually
1673 ;; `org-export--collect-headline-numbering' builds an alist between
1674 ;; headlines and their numbering.
1677 "Extract tree properties from parse tree.
1679 DATA is the parse tree from which information is retrieved. INFO
1680 is a list holding export options.
1682 Following tree properties are set or updated:
1684 `:exported-data' Hash table used to memoize results from
1685 `org-export-data'.
1687 `:footnote-definition-alist' List of footnotes definitions in
1688 original buffer and current parse tree.
1690 `:headline-offset' Offset between true level of headlines and
1691 local level. An offset of -1 means an headline
1692 of level 2 should be considered as a level
1693 1 headline in the context.
1695 `:headline-numbering' Alist of all headlines as key an the
1696 associated numbering as value.
1698 `:ignore-list' List of elements that should be ignored during
1699 export.
1701 `:target-list' List of all targets in the parse tree.
1703 Return updated plist."
1704 ;; Install the parse tree in the communication channel, in order to
1705 ;; use `org-export-get-genealogy' and al.
1707 ;; Get the list of elements and objects to ignore, and put it into
1708 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1709 ;; been done during parse tree filtering.
1712 :ignore-list
1715 ;; Compute `:headline-offset' in order to be able to use
1716 ;; `org-export-get-relative-level'.
1719 :headline-offset
1721 ;; Update footnotes definitions list with definitions in parse tree.
1722 ;; This is required since buffer expansion might have modified
1723 ;; boundaries of footnote definitions contained in the parse tree.
1724 ;; This way, definitions in `footnote-definition-alist' are bound to
1725 ;; match those in the parse tree.
1728 data 'footnote-definition
1732 defs)))
1734 ;; Properties order doesn't matter: get the rest of the tree
1735 ;; properties.
1737 `(:target-list
1746 info))
1749 "Return minimum exportable headline's level in DATA.
1750 DATA is parsed tree as returned by `org-element-parse-buffer'.
1751 OPTIONS is a plist holding export options."
1762 ;; If no headline was found, for the sake of consistency, set
1763 ;; minimum level to 1 nonetheless.
1767 "Return numbering of all exportable headlines in a parse tree.
1769 DATA is the parse tree. OPTIONS is the plist holding export
1770 options.
1772 Return an alist whose key is an headline and value is its
1773 associated numbering \(in the shape of a list of numbers\)."
1776 data
1777 'headline
1782 headline
1784 for idx from 0 to org-export-max-depth
1788 options)))
1791 "Return list of elements and objects to ignore during export.
1792 DATA is the parse tree to traverse. OPTIONS is the plist holding
1793 export options."
1795 walk-data
1796 ;; First find trees containing a select tag, if any.
1800 ;; Collect ignored elements or objects into IGNORE-LIST.
1806 ;; If headline is archived but tree below has
1807 ;; to be skipped, add it to ignore list.
1810 ;; Move into secondary string, if any.
1815 ;; Move into recursive objects/elements.
1817 ;; Main call.
1819 ;; Return value.
1820 ignore))
1823 "Return list of headlines containing a select tag in their tree.
1824 DATA is parsed data as returned by `org-element-parse-buffer'.
1825 INFO is a plist holding export options."
1827 walk-data ; for byte-compiler.
1838 ;; When a select tag is found, mark full
1839 ;; genealogy and every headline within the tree
1840 ;; as acceptable.
1843 genealogy
1845 selected-trees))
1846 ;; Else, continue searching in tree, recursively.
1853 "Non-nil when element or object BLOB should be skipped during export.
1854 OPTIONS is the plist holding export options. SELECTED, when
1855 non-nil, is a list of headlines belonging to a tree with a select
1856 tag."
1871 ;; Ignore subtrees with an exclude tag.
1874 ;; When a select tag is present in the buffer, ignore any tree
1875 ;; without it.
1877 ;; Ignore commented sub-trees.
1879 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1881 ;; Ignore tasks, if specified by `:with-tasks' property.
1897 ;; No timestamp allowed.
1899 ;; Only active timestamps allowed and the current one isn't
1900 ;; active.
1904 ;; Only inactive timestamps allowed and the current one isn't
1905 ;; inactive.
1911 \f
1912 ;;; The Transcoder
1913 ;;
1914 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1915 ;; `org-element-parse-buffer') and transcodes it into a specified
1916 ;; back-end output. It takes care of filtering out elements or
1917 ;; objects according to export options and organizing the output blank
1918 ;; lines and white space are preserved. The function memoizes its
1919 ;; results, so it is cheap to call it within translators.
1920 ;;
1921 ;; Internally, three functions handle the filtering of objects and
1922 ;; elements during the export. In particular,
1923 ;; `org-export-ignore-element' marks an element or object so future
1924 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1925 ;; elements or objects should be seen as real Org syntax and
1926 ;; `org-export-expand' transforms the others back into their original
1927 ;; shape
1928 ;;
1929 ;; `org-export-transcoder' is an accessor returning appropriate
1930 ;; translator function for a given element or object.
1933 "Return appropriate transcoder for BLOB.
1934 INFO is a plist containing export directives."
1936 ;; Return contents only for complete parse trees.
1942 "Convert DATA into current back-end format.
1944 DATA is a parse tree, an element or an object or a secondary
1945 string. INFO is a plist holding export options.
1947 Return transcoded string."
1953 ;; Ignored element/object.
1955 ;; Plain text.
1961 info))
1962 ;; Uninterpreted element/object: change it back to Org
1963 ;; syntax and export again resulting raw string.
1967 data
1971 info))
1972 ;; Secondary string.
1975 ;; Element/Object without contents or, as a special case,
1976 ;; headline with archive tag and archived trees restricted
1977 ;; to title only.
1985 ;; Element/Object with contents.
1998 ;; Elements directly containing objects
1999 ;; must have their indentation normalized
2000 ;; first.
2002 data
2003 ;; When normalizing contents of the first
2004 ;; paragraph in an item or a footnote
2005 ;; definition, ignore first line's
2006 ;; indentation: there is none and it
2007 ;; might be misleading.
2012 data)
2019 info))))))))
2020 ;; Final result will be memoized before being returned.
2022 data
2026 ;; Append the same white space between elements or objects as in
2027 ;; the original buffer, and call appropriate filters.
2038 info)))
2039 results)))
2043 "Non-nil if element or object BLOB should be interpreted as Org syntax.
2044 Check is done according to export options INFO, stored as
2045 a plist."
2047 ;; ... entities...
2049 ;; ... emphasis...
2052 ;; ... fixed-width areas.
2054 ;; ... footnotes...
2057 ;; ... sub/superscripts...
2063 ;; ... tables...
2068 "Expand a parsed element or object to its original state.
2069 BLOB is either an element or an object. CONTENTS is its
2070 contents, as a string or nil."
2073 blob contents))
2076 "Add ELEMENT to `:ignore-list' in INFO.
2078 Any element in `:ignore-list' will be skipped when using
2079 `org-element-map'. INFO is modified by side effects."
2083 \f
2084 ;;; The Filter System
2085 ;;
2086 ;; Filters allow end-users to tweak easily the transcoded output.
2087 ;; They are the functional counterpart of hooks, as every filter in
2088 ;; a set is applied to the return value of the previous one.
2089 ;;
2090 ;; Every set is back-end agnostic. Although, a filter is always
2091 ;; called, in addition to the string it applies to, with the back-end
2092 ;; used as argument, so it's easy for the end-user to add back-end
2093 ;; specific filters in the set. The communication channel, as
2094 ;; a plist, is required as the third argument.
2095 ;;
2096 ;; From the developer side, filters sets can be installed in the
2097 ;; process with the help of `org-export-define-backend', which
2098 ;; internally stores filters as an alist. Each association has a key
2099 ;; among the following symbols and a function or a list of functions
2100 ;; as value.
2101 ;;
2102 ;; - `:filter-parse-tree' applies directly on the complete parsed
2103 ;; tree. It's the only filters set that doesn't apply to a string.
2104 ;; Users can set it through `org-export-filter-parse-tree-functions'
2105 ;; variable.
2106 ;;
2107 ;; - `:filter-final-output' applies to the final transcoded string.
2108 ;; Users can set it with `org-export-filter-final-output-functions'
2109 ;; variable
2110 ;;
2111 ;; - `:filter-plain-text' applies to any string not recognized as Org
2112 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2113 ;; configure it.
2114 ;;
2115 ;; - `:filter-TYPE' applies on the string returned after an element or
2116 ;; object of type TYPE has been transcoded. An user can modify
2117 ;; `org-export-filter-TYPE-functions'
2118 ;;
2119 ;; All filters sets are applied with
2120 ;; `org-export-filter-apply-functions' function. Filters in a set are
2121 ;; applied in a LIFO fashion. It allows developers to be sure that
2122 ;; their filters will be applied first.
2123 ;;
2124 ;; Filters properties are installed in communication channel with
2125 ;; `org-export-install-filters' function.
2126 ;;
2127 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2128 ;; `org-export-before-parsing-hook') are run at the beginning of the
2129 ;; export process and just before parsing to allow for heavy structure
2130 ;; modifications.
2133 ;;;; Hooks
2136 "Hook run at the beginning of the export process.
2138 This is run before include keywords and macros are expanded and
2139 Babel code blocks executed, on a copy of the original buffer
2140 being exported. Visibility and narrowing are preserved. Point
2141 is at the beginning of the buffer.
2143 Every function in this hook will be called with one argument: the
2147 "Hook run before parsing an export buffer.
2149 This is run after include keywords and macros have been expanded
2150 and Babel code blocks executed, on a copy of the original buffer
2151 being exported. Visibility and narrowing are preserved. Point
2152 is at the beginning of the buffer.
2154 Every function in this hook will be called with one argument: the
2158 ;;;; Special Filters
2161 "List of functions applied to the parsed tree.
2162 Each filter is called with three arguments: the parse tree, as
2163 returned by `org-element-parse-buffer', the back-end, as
2164 a symbol, and the communication channel, as a plist. It must
2168 "List of functions applied to the transcoded string.
2169 Each filter is called with three arguments: the full transcoded
2170 string, the back-end, as a symbol, and the communication channel,
2171 as a plist. It must return a string that will be used as the
2175 "List of functions applied to plain text.
2176 Each filter is called with three arguments: a string which
2177 contains no Org syntax, the back-end, as a symbol, and the
2178 communication channel, as a plist. It must return a string or
2182 ;;;; Elements Filters
2185 "List of functions applied to a transcoded babel-call.
2186 Each filter is called with three arguments: the transcoded data,
2187 as a string, the back-end, as a symbol, and the communication
2191 "List of functions applied to a transcoded center block.
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 clock.
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 comment.
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-block.
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 diary-sexp.
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 drawer.
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 dynamic-block.
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 example-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 export-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 fixed-width.
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 footnote-definition.
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 headline.
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 horizontal-rule.
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 inlinetask.
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 item.
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 keyword.
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 latex-environment.
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 node-property.
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 paragraph.
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 plain-list.
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 planning.
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 property-drawer.
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 quote block.
2324 Each filter is called with three arguments: the transcoded quote
2325 data, as a string, the back-end, as a symbol, and the
2326 communication channel, as a plist. It must return a string or
2330 "List of functions applied to a transcoded quote-section.
2331 Each filter is called with three arguments: the transcoded data,
2332 as a string, the back-end, as a symbol, and the communication
2336 "List of functions applied to a transcoded 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 special block.
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 src-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 table.
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-cell.
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-row.
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 verse block.
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 ;;;; Objects Filters
2381 "List of functions applied to transcoded bold text.
2382 Each filter is called with three arguments: the transcoded data,
2383 as a string, the back-end, as a symbol, and the communication
2387 "List of functions applied to transcoded code 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 a transcoded entity.
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 export-snippet.
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 footnote-reference.
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 inline-babel-call.
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-src-block.
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 transcoded italic text.
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 a transcoded latex-fragment.
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 line-break.
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 link.
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 macro.
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 radio-target.
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 statistics-cookie.
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 transcoded strike-through text.
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 a transcoded subscript.
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 superscript.
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 target.
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 timestamp.
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 transcoded underline text.
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 verbatim 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 ;;;; Filters Tools
2508 ;;
2509 ;; Internal function `org-export-install-filters' installs filters
2510 ;; hard-coded in back-ends (developer filters) and filters from global
2511 ;; variables (user filters) in the communication channel.
2512 ;;
2513 ;; Internal function `org-export-filter-apply-functions' takes care
2514 ;; about applying each filter in order to a given data. It ignores
2515 ;; filters returning a nil value but stops whenever a filter returns
2516 ;; an empty string.
2519 "Call every function in FILTERS.
2521 Functions are called with arguments VALUE, current export
2522 back-end and INFO. A function returning a nil value will be
2523 skipped. If it returns the empty string, the process ends and
2524 VALUE is ignored.
2526 Call is done in a LIFO fashion, to be sure that developer
2527 specified filters, if any, are called first."
2536 "Install filters properties in communication channel.
2538 INFO is a plist containing the current communication channel.
2540 Return the updated communication channel."
2542 ;; Install user defined filters with `org-export-filters-alist'.
2545 org-export-filters-alist)
2546 ;; Prepend back-end specific filters to that list.
2548 ;; Single values get consed, lists are prepended.
2553 plist key
2557 ;; Return new communication channel.
2561 \f
2562 ;;; Core functions
2563 ;;
2564 ;; This is the room for the main function, `org-export-as', along with
2565 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2566 ;; They differ only by the way they output the resulting code.
2567 ;;
2568 ;; `org-export-output-file-name' is an auxiliary function meant to be
2569 ;; used with `org-export-to-file'. With a given extension, it tries
2570 ;; to provide a canonical file name to write export output to.
2571 ;;
2572 ;; Note that `org-export-as' doesn't really parse the current buffer,
2573 ;; but a copy of it (with the same buffer-local variables and
2574 ;; visibility), where macros and include keywords are expanded and
2575 ;; Babel blocks are executed, if appropriate.
2576 ;; `org-export-with-buffer-copy' macro prepares that copy.
2577 ;;
2578 ;; File inclusion is taken care of by
2579 ;; `org-export-expand-include-keyword' and
2580 ;; `org-export--prepare-file-contents'. Structure wise, including
2581 ;; a whole Org file in a buffer often makes little sense. For
2582 ;; example, if the file contains an headline and the include keyword
2583 ;; was within an item, the item should contain the headline. That's
2584 ;; why file inclusion should be done before any structure can be
2585 ;; associated to the file, that is before parsing.
2589 "Transcode current Org buffer into BACKEND code.
2591 If narrowing is active in the current buffer, only transcode its
2592 narrowed part.
2594 If a region is active, transcode that region.
2596 When optional argument SUBTREEP is non-nil, transcode the
2597 sub-tree at point, extracting information from the headline
2598 properties first.
2600 When optional argument VISIBLE-ONLY is non-nil, don't export
2601 contents of hidden elements.
2603 When optional argument BODY-ONLY is non-nil, only return body
2604 code, without preamble nor postamble.
2606 Optional argument EXT-PLIST, when provided, is a property list
2607 with external parameters overriding Org default settings, but
2608 still inferior to file-local settings.
2610 Optional argument NOEXPAND, when non-nil, prevents included files
2611 to be expanded and Babel code to be executed.
2613 Return code as a string."
2614 ;; Barf if BACKEND isn't registered.
2618 ;; Narrow buffer to an appropriate region or subtree for
2619 ;; parsing. If parsing subtree, be sure to remove main headline
2620 ;; too.
2628 ;; Initialize communication channel with original buffer
2629 ;; attributes, unavailable in its copy.
2632 ;; Run first hook with current back-end as argument.
2634 ;; Update communication channel and get parse tree. Buffer
2635 ;; isn't parsed directly. Instead, a temporary copy is
2636 ;; created, where include keywords, macros are expanded and
2637 ;; code blocks are evaluated.
2640 ;; Update macro templates since #+INCLUDE keywords might
2641 ;; have added some new ones.
2645 ;; Update radio targets since keyword inclusion might have
2646 ;; added some more.
2648 ;; Run last hook with current back-end as argument.
2651 ;; Update communication channel with environment. Also
2652 ;; install user's and developer's filters.
2657 ;; Expand export-specific set of macros: {{{author}}},
2658 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2659 ;; once regular macros have been expanded, since document
2660 ;; keywords may contain one of them.
2667 ;; EMAIL is not a parsed keyword: store it as-is.
2671 ;; Eventually parse buffer. Call parse-tree filters to get
2672 ;; the final tree.
2677 ;; Now tree is complete, compute its properties and add them
2678 ;; to communication channel.
2682 ;; Eventually transcode TREE. Wrap the resulting string into
2683 ;; a template, if required. Finally call final-output filter.
2688 ;; Remove all text properties since they cannot be
2689 ;; retrieved from an external process.
2695 info))))
2696 ;; Maybe add final OUTPUT to kill ring, then return it.
2699 output)))))
2703 "Call `org-export-as' with output to a specified buffer.
2705 BACKEND is the back-end used for transcoding, as a symbol.
2707 BUFFER is the output buffer. If it already exists, it will be
2708 erased first, otherwise, it will be created.
2710 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2711 and NOEXPAND are similar to those used in `org-export-as', which
2712 see.
2714 Return buffer."
2716 backend subtreep visible-only body-only ext-plist noexpand))
2722 buffer))
2726 "Call `org-export-as' with output to a specified file.
2728 BACKEND is the back-end used for transcoding, as a symbol. FILE
2729 is the name of the output file, as a string.
2731 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2732 and NOEXPAND are similar to those used in `org-export-as', which
2733 see.
2735 Return output file's name."
2736 ;; Checks for FILE permissions. `write-file' would do the same, but
2737 ;; we'd rather avoid needless transcoding of parse tree.
2739 ;; Insert contents to a temporary buffer and write it to FILE.
2741 backend subtreep visible-only body-only ext-plist noexpand)))
2746 ;; Return full path.
2747 file)
2750 "Return output file's name according to buffer specifications.
2752 EXTENSION is a string representing the output file extension,
2753 with the leading dot.
2755 With a non-nil optional argument SUBTREEP, try to determine
2757 of subtree at point.
2759 When optional argument PUB-DIR is set, use it as the publishing
2760 directory.
2762 When optional argument VISIBLE-ONLY is non-nil, don't export
2763 contents of hidden elements.
2765 Return file name as a string, or nil if it couldn't be
2766 determined."
2768 ;; File name may come from EXPORT_FILE_NAME subtree property,
2769 ;; assuming point is at beginning of said sub-tree.
2776 ;; File name may be extracted from buffer's associated
2777 ;; file, if any.
2780 ;; Can't determine file name on our own: Ask user.
2784 "Output file: " pub-dir nil nil nil
2787 ;; Build file name. Enforce EXTENSION over whatever user may have
2788 ;; come up with. PUB-DIR, if defined, always has precedence over
2789 ;; any provided path.
2794 extension))
2799 "Return a copy of the current buffer.
2800 The copy preserves Org buffer-local variables, visibility and
2801 narrowing."
2807 new-buf))
2810 "Apply BODY in a copy of the current buffer.
2811 The copy preserves local variables, visibility and contents of
2812 the original buffer. Point is at the beginning of the buffer
2813 when BODY is applied."
2822 ;; Kill copy without confirmation.
2828 "Generate a function duplicating BUFFER.
2830 The copy will preserve local variables, visibility, contents and
2831 narrowing of the original buffer. If a region was active in
2832 BUFFER, contents will be narrowed to that region instead.
2834 The resulting function can be eval'ed at a later time, from
2835 another buffer, effectively cloning the original buffer there."
2839 ;; Buffer local variables.
2849 buffer-file-name outline-level
2850 outline-regexp
2851 buffer-invisibility-spec))
2854 ;; Skip unreadable values, as they cannot be
2855 ;; sent to external process.
2859 local-vars)))))
2861 local-vars)
2862 ;; Whole buffer contents.
2867 ;; Narrowing.
2871 ;; Current position of point.
2873 ;; Overlays with invisible property.
2883 ov-set))))
2885 ov-set)))))
2888 "Expand every include keyword in buffer.
2889 Optional argument INCLUDED is a list of included file names along
2890 with their line restriction, when appropriate. It is used to
2891 avoid infinite recursion. Optional argument DIR is the current
2892 working directory. It is used to properly resolve relative
2893 paths."
2900 ;; Extract arguments from keyword's value.
2914 ;; Minimal level of included file defaults to the child
2915 ;; level of the current headline, if any, or one. It
2916 ;; only applies is the file is meant to be included as
2917 ;; an Org one.
2925 ;; Remove keyword.
2930 ;; Check if files has already been parsed. Look after
2931 ;; inclusion lines too, as different parts of the same file
2932 ;; can be included too.
2944 ind-str contents ind-str))))
2952 ind-str env contents ind-str))))
2965 "Prepare the contents of FILE for inclusion and return them as a string.
2967 When optional argument LINES is a string specifying a range of
2968 lines, include only those lines.
2970 Optional argument IND, when non-nil, is an integer specifying the
2971 global indentation of returned contents. Since its purpose is to
2972 allow an included file to stay in the same environment it was
2973 created \(i.e. a list item), it doesn't apply past the first
2974 headline encountered.
2976 Optional argument MINLEVEL, when non-nil, is an integer
2977 specifying the level that any top-level headline in the included
2978 file should have."
2994 ;; Remove blank lines at beginning and end of contents. The logic
2995 ;; behind that removal is that blank lines around include keyword
2996 ;; override blank lines in included file.
3005 ;; If IND is set, preserve indentation of include keyword until
3006 ;; the first headline encountered.
3012 ;; Do not move footnote definitions out of column 0.
3018 ;; When MINLEVEL is specified, compute minimal level for headlines
3019 ;; in the file (CUR-MIN), and remove stars to each headline so
3020 ;; that headlines with minimal level have a level of MINLEVEL.
3030 ;; Only change stars, don't bother moving whole
3031 ;; sections.
3038 "Execute every Babel code in the visible part of current buffer.
3039 This function will return an error if the current buffer is
3040 visiting a file."
3041 ;; Get a pristine copy of current buffer so Babel references can be
3042 ;; properly resolved.
3049 \f
3050 ;;; Tools For Back-Ends
3051 ;;
3052 ;; A whole set of tools is available to help build new exporters. Any
3053 ;; function general enough to have its use across many back-ends
3054 ;; should be added here.
3056 ;;;; For Affiliated Keywords
3057 ;;
3058 ;; `org-export-read-attribute' reads a property from a given element
3059 ;; as a plist. It can be used to normalize affiliated keywords'
3060 ;; syntax.
3061 ;;
3062 ;; Since captions can span over multiple lines and accept dual values,
3063 ;; their internal representation is a bit tricky. Therefore,
3064 ;; `org-export-get-caption' transparently returns a given element's
3065 ;; caption as a secondary string.
3068 "Turn ATTRIBUTE property from ELEMENT into a plist.
3070 When optional argument PROPERTY is non-nil, return the value of
3071 that property within attributes.
3075 properties."
3083 "Return caption from ELEMENT as a secondary string.
3085 When optional argument SHORTP is non-nil, return short caption,
3086 as a secondary string, instead.
3088 Caption lines are separated by a white space."
3096 ;;;; For Derived Back-ends
3097 ;;
3098 ;; `org-export-with-backend' is a function allowing to locally use
3099 ;; another back-end to transcode some object or element. In a derived
3100 ;; back-end, it may be used as a fall-back function once all specific
3101 ;; cases have been treated.
3104 "Call a transcoder from BACK-END on DATA.
3105 CONTENTS, when non-nil, is the transcoded contents of DATA
3106 element, as a string. INFO, when non-nil, is the communication
3107 channel used for export, as a plist.."
3117 ;;;; For Export Snippets
3118 ;;
3119 ;; Every export snippet is transmitted to the back-end. Though, the
3120 ;; latter will only retain one type of export-snippet, ignoring
3121 ;; others, based on the former's target back-end. The function
3122 ;; `org-export-snippet-backend' returns that back-end for a given
3123 ;; export-snippet.
3126 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3127 Translation, with `org-export-snippet-translation-alist', is
3128 applied."
3132 back-end))))
3135 ;;;; For Footnotes
3136 ;;
3137 ;; `org-export-collect-footnote-definitions' is a tool to list
3138 ;; actually used footnotes definitions in the whole parse tree, or in
3139 ;; an headline, in order to add footnote listings throughout the
3140 ;; transcoded data.
3141 ;;
3142 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3143 ;; back-ends, when they need to attach the footnote definition only to
3144 ;; the first occurrence of the corresponding label.
3145 ;;
3146 ;; `org-export-get-footnote-definition' and
3147 ;; `org-export-get-footnote-number' provide easier access to
3148 ;; additional information relative to a footnote reference.
3151 "Return an alist between footnote numbers, labels and definitions.
3153 DATA is the parse tree from which definitions are collected.
3154 INFO is the plist used as a communication channel.
3156 Definitions are sorted by order of references. They either
3157 appear as Org data or as a secondary string for inlined
3158 footnotes. Unreferenced definitions are ignored."
3160 collect-fn ; for byte-compiler.
3164 ;; Collect footnote number, label and definition in DATA.
3166 data 'footnote-reference
3173 def)
3174 num-alist)
3175 ;; Also search in definition for nested footnotes.
3178 ;; Don't enter footnote definitions since it will happen
3179 ;; when their first reference is found.
3185 "Non-nil when a footnote reference is the first one for its label.
3187 FOOTNOTE-REFERENCE is the footnote reference being considered.
3188 INFO is the plist used as a communication channel."
3190 ;; Anonymous footnotes are always a first reference.
3192 ;; Otherwise, return the first footnote with the same LABEL and
3193 ;; test if it is equal to FOOTNOTE-REFERENCE.
3199 data 'footnote-reference
3204 ;; If FN isn't inlined, be sure to traverse its
3205 ;; definition before resuming search. See
3206 ;; comments in `org-export-get-footnote-number'
3207 ;; for more information.
3211 ;; Don't enter footnote definitions since it will
3212 ;; happen when their first reference is found.
3215 footnote-reference)))))
3218 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3219 INFO is the plist used as a communication channel."
3225 "Return number associated to a footnote.
3227 FOOTNOTE is either a footnote reference or a footnote definition.
3228 INFO is the plist used as a communication channel."
3230 seen-refs
3231 search-ref ; For byte-compiler.
3235 ;; Search footnote references through DATA, filling
3236 ;; SEEN-REFS along the way.
3238 data 'footnote-reference
3242 ;; Anonymous footnote match: return number.
3245 ;; Labels match: return number.
3248 ;; Anonymous footnote: it's always a new one. Also,
3249 ;; be sure to return nil from the `cond' so
3250 ;; `first-match' doesn't get us out of the loop.
3252 ;; Label not seen so far: add it so SEEN-REFS.
3253 ;;
3254 ;; Also search for subsequent references in
3255 ;; footnote definition so numbering follows reading
3256 ;; logic. Note that we don't have to care about
3257 ;; inline definitions, since `org-element-map'
3258 ;; already traverses them at the right time.
3259 ;;
3260 ;; Once again, return nil to stay in the loop.
3265 nil))))
3266 ;; Don't enter footnote definitions since it will happen
3267 ;; when their first reference is found.
3272 ;;;; For Headlines
3273 ;;
3274 ;; `org-export-get-relative-level' is a shortcut to get headline
3275 ;; level, relatively to the lower headline level in the parsed tree.
3276 ;;
3277 ;; `org-export-get-headline-number' returns the section number of an
3278 ;; headline, while `org-export-number-to-roman' allows to convert it
3279 ;; to roman numbers.
3280 ;;
3281 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3282 ;; `org-export-last-sibling-p' are three useful predicates when it
3283 ;; comes to fulfill the `:headline-levels' property.
3284 ;;
3285 ;; `org-export-get-tags', `org-export-get-category' and
3286 ;; `org-export-get-node-property' extract useful information from an
3287 ;; headline or a parent headline. They all handle inheritance.
3290 "Return HEADLINE relative level within current parsed tree.
3291 INFO is a plist holding contextual information."
3296 "Non-nil when HEADLINE is considered as low level.
3298 INFO is a plist used as a communication channel.
3300 A low level headlines has a relative level greater than
3301 `:headline-levels' property value.
3303 Return value is the difference between HEADLINE relative level
3304 and the last level being considered as high enough, or nil."
3311 "Return HEADLINE numbering as a list of numbers.
3312 INFO is a plist holding contextual information."
3316 "Return a non-nil value if HEADLINE element should be numbered.
3317 INFO is a plist used as a communication channel."
3323 "Convert integer N into a roman numeral."
3336 res)))
3339 "Return list of tags associated to ELEMENT.
3341 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3342 is a plist used as a communication channel.
3344 Select tags (see `org-export-select-tags') and exclude tags (see
3345 `org-export-exclude-tags') are removed from the list.
3347 When non-nil, optional argument TAGS should be a list of strings.
3348 Any tag belonging to this list will also be removed.
3350 When optional argument INHERITED is non-nil, tags can also be
3351 inherited from parent headlines and FILETAGS keywords."
3357 ;; Build complete list of inherited tags.
3368 ;; Add FILETAGS keywords and return results.
3372 "Return node PROPERTY value for BLOB.
3374 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3375 element or object.
3377 If optional argument INHERITED is non-nil, the value can be
3378 inherited from a parent headline.
3380 Return value is a string or nil."
3392 "Return category for element or object BLOB.
3394 INFO is a plist used as a communication channel.
3396 CATEGORY is automatically inherited from a parent headline, from
3397 #+CATEGORY: keyword or created out of original file name. If all
3401 ;; Almost like `org-export-node-property', but we cannot trust
3402 ;; `plist-member' as every headline has a `:category'
3403 ;; property, would it be nil or equal to "???" (which has the
3404 ;; same meaning).
3423 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3424 INFO is a plist used as a communication channel."
3429 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3430 INFO is a plist used as a communication channel."
3434 ;;;; For Links
3435 ;;
3436 ;; `org-export-solidify-link-text' turns a string into a safer version
3437 ;; for links, replacing most non-standard characters with hyphens.
3438 ;;
3439 ;; `org-export-get-coderef-format' returns an appropriate format
3440 ;; string for coderefs.
3441 ;;
3442 ;; `org-export-inline-image-p' returns a non-nil value when the link
3443 ;; provided should be considered as an inline image.
3444 ;;
3445 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3446 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3447 ;; returns an appropriate unique identifier when found, or nil.
3448 ;;
3449 ;; `org-export-resolve-id-link' returns the first headline with
3450 ;; specified id or custom-id in parse tree, the path to the external
3451 ;; file with the id or nil when neither was found.
3452 ;;
3453 ;; `org-export-resolve-coderef' associates a reference to a line
3454 ;; number in the element it belongs, or returns the reference itself
3455 ;; when the element isn't numbered.
3458 "Take link text S and make a safe target out of it."
3463 "Return format string for code reference link.
3464 PATH is the link path. DESC is its description."
3472 "Non-nil if LINK object points to an inline image.
3474 Optional argument is a set of RULES defining inline images. It
3475 is an alist where associations have the following shape:
3477 \(TYPE . REGEXP)
3479 Applying a rule means apply REGEXP against LINK's path when its
3480 type is TYPE. The function will return a non-nil value if any of
3481 the provided rules is non-nil. The default rule is
3482 `org-export-default-inline-image-rule'.
3484 This only applies to links without a description."
3495 rules)
3496 ;; Return nil if no rule matched.
3497 nil))))
3500 "Resolve a code reference REF.
3502 INFO is a plist used as a communication channel.
3504 Return associated line number in source code, or REF itself,
3505 depending on src-block or example element's switches."
3513 org-coderef-label-format)))
3517 ;; Element containing REF is found. Resolve it to either
3518 ;; a label or a line number, as needed.
3528 "Return LINK destination.
3530 INFO is a plist holding contextual information.
3532 Return value can be an object, an element, or nil:
3534 - If LINK path matches a target object (i.e. <<path>>) or
3537 - If LINK path exactly matches the name affiliated keyword
3538 \(i.e. #+NAME: path) of an element, return that element.
3540 - If LINK path exactly matches any headline name, return that
3541 element. If more than one headline share that name, priority
3542 will be given to the one with the closest common ancestor, if
3543 any, or the first one in the parse tree otherwise.
3545 - Otherwise, return nil.
3551 ;; First try to find a matching "<<path>>" unless user specified
3552 ;; he was looking for an headline (path starts with a *
3553 ;; character).
3557 return target)))
3558 ;; Then try to find an element with a matching "#+NAME: path"
3559 ;; affiliated keyword.
3566 ;; Last case: link either points to an headline or to
3567 ;; nothingness. Try to find the source, with priority given to
3568 ;; headlines with the closest common ancestor. If such candidate
3569 ;; is found, return it, otherwise return nil.
3573 ;; Return first headline whose `:raw-value' property
3574 ;; is NAME in parse tree DATA, or nil.
3577 data 'headline
3581 name)
3582 headline))
3584 ;; Search among headlines sharing an ancestor with link,
3585 ;; from closest to farthest.
3593 ;; No match with a common ancestor: try the full parse-tree.
3599 "Return headline referenced as LINK destination.
3601 INFO is a plist used as a communication channel.
3603 Return value can be the headline element matched in current parse
3607 ;; First check if id is within the current parse tree.
3613 headline))
3615 ;; Otherwise, look for external files.
3619 "Return radio-target object referenced as LINK destination.
3621 INFO is a plist used as a communication channel.
3623 Return value can be a radio-target object or nil. Assume LINK
3633 ;;;; For References
3634 ;;
3635 ;; `org-export-get-ordinal' associates a sequence number to any object
3636 ;; or element.
3639 "Return ordinal number of an element or object.
3641 ELEMENT is the element or object considered. INFO is the plist
3642 used as a communication channel.
3644 Optional argument TYPES, when non-nil, is a list of element or
3645 object types, as symbols, that should also be counted in.
3646 Otherwise, only provided element's type is considered.
3648 Optional argument PREDICATE is a function returning a non-nil
3649 value if the current element or object should be counted in. It
3650 accepts two arguments: the element or object being considered and
3651 the plist used as a communication channel. This allows to count
3652 only a certain type of objects (i.e. inline images).
3654 Return value is a list of numbers if ELEMENT is an headline or an
3655 item. It is nil for keywords. It represents the footnote number
3656 for footnote definitions and footnote references. If ELEMENT is
3657 a target, return the same value as if ELEMENT was the closest
3658 table, item or headline containing the target. In any other
3659 case, return the sequence number of ELEMENT among elements or
3660 objects of the same type."
3661 ;; A target keyword, representing an invisible target, never has
3662 ;; a sequence number.
3664 ;; Ordinal of a target object refer to the ordinal of the closest
3665 ;; table, item, or headline containing the object.
3669 when
3673 table))
3674 return parent)))
3676 ;; Special case 1: An headline returns its number as a list.
3678 ;; Special case 2: An item returns its number as a list.
3682 struct
3689 ;; Increment counter until ELEMENT is found again.
3700 ;;;; For Src-Blocks
3701 ;;
3702 ;; `org-export-get-loc' counts number of code lines accumulated in
3703 ;; src-block or example-block elements with a "+n" switch until
3704 ;; a given element, excluded. Note: "-n" switches reset that count.
3705 ;;
3706 ;; `org-export-unravel-code' extracts source code (along with a code
3707 ;; references alist) from an `element-block' or `src-block' type
3708 ;; element.
3709 ;;
3710 ;; `org-export-format-code' applies a formatting function to each line
3711 ;; of code, providing relative line number and code reference when
3712 ;; appropriate. Since it doesn't access the original element from
3713 ;; which the source code is coming, it expects from the code calling
3714 ;; it to know if lines should be numbered and if code references
3715 ;; should appear.
3716 ;;
3717 ;; Eventually, `org-export-format-code-default' is a higher-level
3718 ;; function (it makes use of the two previous functions) which handles
3719 ;; line numbering and code references inclusion, and returns source
3720 ;; code in a format suitable for plain text or verbatim output.
3723 "Return accumulated lines of code up to ELEMENT.
3725 INFO is the plist used as a communication channel.
3727 ELEMENT is excluded from count."
3734 ;; ELEMENT is reached: Quit the loop.
3736 ;; Only count lines from src-block and example-block elements
3737 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3741 ;; Accumulate locs or reset them.
3745 ;; Return nil to stay in the loop.
3746 nil)))
3748 ;; Return value.
3749 loc))
3752 "Clean source code and extract references out of it.
3754 ELEMENT has either a `src-block' an `example-block' type.
3756 Return a cons cell whose CAR is the source code, cleaned from any
3757 reference and protective comma and CDR is an alist between
3758 relative line number (integer) and name of code reference on that
3759 line (string)."
3761 ;; Get code and clean it. Remove blank lines at its
3762 ;; beginning and end.
3768 ;; If appropriate, remove global indentation.
3771 c
3773 ;; Get format used for references.
3776 org-coderef-label-format)))
3777 ;; Build a regexp matching a loc with a reference.
3782 ;; Return value.
3784 ;; Code with references removed.
3790 ;; Ref line: remove ref, and signal its position in REFS.
3794 ;; Reference alist.
3795 refs)))
3798 "Format CODE by applying FUN line-wise and return it.
3800 CODE is a string representing the code to format. FUN is
3801 a function. It must accept three arguments: a line of
3802 code (string), the current line number (integer) or nil and the
3803 reference associated to the current line (string) or nil.
3805 Optional argument NUM-LINES can be an integer representing the
3806 number of code lines accumulated until the current code. Line
3807 numbers passed to FUN will take it into account. If it is nil,
3808 FUN's second argument will always be nil. This number can be
3809 obtained with `org-export-get-loc' function.
3811 Optional argument REF-ALIST can be an alist between relative line
3812 number (i.e. ignoring NUM-LINES) and the name of the code
3813 reference on it. If it is nil, FUN's third argument will always
3814 be nil. It can be obtained through the use of
3815 `org-export-unravel-code' function."
3827 "Return source code from ELEMENT, formatted in a standard way.
3829 ELEMENT is either a `src-block' or `example-block' element. INFO
3830 is a plist used as a communication channel.
3832 This function takes care of line numbering and code references
3833 inclusion. Line numbers, when applicable, appear at the
3834 beginning of the line, separated from the code by two white
3835 spaces. Code references, on the other hand, appear flushed to
3836 the right, separated by six white spaces from the widest line of
3837 code."
3838 ;; Extract code and references.
3844 ;; Handle line numbering.
3853 ;; Prepare references display, if required. Any reference
3854 ;; should start six columns after the widest line of code,
3855 ;; wrapped with parenthesis.
3860 code
3864 number-str
3865 loc
3871 num-start refs)))
3874 ;;;; For Tables
3875 ;;
3876 ;; `org-export-table-has-special-column-p' and and
3877 ;; `org-export-table-row-is-special-p' are predicates used to look for
3878 ;; meta-information about the table structure.
3879 ;;
3880 ;; `org-table-has-header-p' tells when the rows before the first rule
3881 ;; should be considered as table's header.
3882 ;;
3883 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3884 ;; and `org-export-table-cell-borders' extract information from
3885 ;; a table-cell element.
3886 ;;
3887 ;; `org-export-table-dimensions' gives the number on rows and columns
3888 ;; in the table, ignoring horizontal rules and special columns.
3889 ;; `org-export-table-cell-address', given a table-cell object, returns
3890 ;; the absolute address of a cell. On the other hand,
3891 ;; `org-export-get-table-cell-at' does the contrary.
3892 ;;
3893 ;; `org-export-table-cell-starts-colgroup-p',
3894 ;; `org-export-table-cell-ends-colgroup-p',
3895 ;; `org-export-table-row-starts-rowgroup-p',
3896 ;; `org-export-table-row-ends-rowgroup-p',
3897 ;; `org-export-table-row-starts-header-p' and
3898 ;; `org-export-table-row-ends-header-p' indicate position of current
3899 ;; row or cell within the table.
3902 "Non-nil when TABLE has a special column.
3903 All special columns will be ignored during export."
3904 ;; The table has a special column when every first cell of every row
3905 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3906 ;; "*" "_" and "^". Though, do not consider a first row containing
3907 ;; only empty cells as special.
3923 "Non-nil when TABLE has an header.
3925 INFO is a plist used as a communication channel.
3927 A table has an header when it contains at least two row groups."
3930 table 'table-row
3938 info)))
3941 "Non-nil if TABLE-ROW is considered special.
3943 INFO is a plist used as the communication channel.
3945 All special rows will be ignored during export."
3949 ;; A row is special either when...
3951 ;; ... it starts with a field only containing "/",
3953 ;; ... the table contains a special column and the row start
3954 ;; with a marking character among, "^", "_", "$" or "!",
3958 ;; ... it contains only alignment cookies and empty cells.
3964 ;; Since VALUE is a secondary string, the following
3965 ;; checks avoid expanding it with `org-export-data'.
3977 "Return TABLE-ROW's group.
3979 INFO is a plist used as the communication channel.
3981 Return value is the group number, as an integer, or nil special
3982 rows and table rules. Group 1 is also table's header."
3999 "Return TABLE-CELL contents width.
4001 INFO is a plist used as the communication channel.
4003 Return value is the width given by the last width cookie in the
4004 same column as TABLE-CELL, or nil."
4009 cookie-width)
4013 ;; In a special row, try to find a width cookie at COLUMN.
4017 ;; The following checks avoid expanding unnecessarily the
4018 ;; cell with `org-export-data'
4026 ;; Ignore table rules.
4029 ;; Return value.
4030 cookie-width))
4033 "Return TABLE-CELL contents alignment.
4035 INFO is a plist used as the communication channel.
4037 Return alignment as specified by the last alignment cookie in the
4038 same column as TABLE-CELL. If no such cookie is found, a default
4039 alignment value will be deduced from fraction of numbers in the
4040 column (see `org-table-number-fraction' for more information).
4041 Possible values are `left', `right' and `center'."
4048 cookie-align)
4052 ;; In a special row, try to find an alignment cookie at
4053 ;; COLUMN.
4057 ;; Since VALUE is a secondary string, the following checks
4058 ;; avoid useless expansion through `org-export-data'.
4066 ;; Ignore table rules.
4068 ;; In a standard row, check if cell's contents are expressing
4069 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4070 ;; Though, don't bother if an alignment cookie has already
4071 ;; defined cell's alignment.
4076 info)))
4081 ;; Return value. Alignment specified by cookies has precedence
4082 ;; over alignment deduced from cells contents.
4091 "Return TABLE-CELL borders.
4093 INFO is a plist used as a communication channel.
4095 Return value is a list of symbols, or nil. Possible values are:
4096 `top', `bottom', `above', `below', `left' and `right'. Note:
4097 `top' (resp. `bottom') only happen for a cell in the first
4098 row (resp. last row) of the table, ignoring table rules, if any.
4100 Returned borders ignore special rows."
4103 borders)
4104 ;; Top/above border? TABLE-CELL has a border above when a rule
4105 ;; used to demarcate row groups can be found above. Hence,
4106 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4107 ;; another regular row has to be found above that rule.
4116 ;; Look at every row before the current one.
4118 ;; No rule above, or rule found starts the table (ignoring any
4119 ;; special row): TABLE-CELL is at the top of the table.
4122 ;; Bottom/below border? TABLE-CELL has a border below when next
4123 ;; non-regular row below is a rule.
4132 ;; Look at every row after the current one.
4134 ;; No rule below, or rule found ends the table (modulo some
4135 ;; special row): TABLE-CELL is at the bottom of the table.
4138 ;; Right/left borders? They can only be specified by column
4139 ;; groups. Column groups are defined in a row starting with "/".
4140 ;; Also a column groups row only contains "<", "<>", ">" or blank
4141 ;; cells.
4158 ;; There's a left border when previous cell, if
4159 ;; any, ends a group, or current one starts one.
4165 ;; There's a right border when next cell, if any,
4166 ;; starts a group, or current one ends one.
4173 ;; Table rows are read in reverse order so last column groups
4174 ;; row has precedence over any previous one.
4176 ;; Return value.
4177 borders))
4180 "Non-nil when TABLE-CELL is at the beginning of a row group.
4181 INFO is a plist used as a communication channel."
4182 ;; A cell starts a column group either when it is at the beginning
4183 ;; of a row (or after the special column, if any) or when it has
4184 ;; a left border.
4188 table-cell)
4192 "Non-nil when TABLE-CELL is at the end of a row group.
4193 INFO is a plist used as a communication channel."
4194 ;; A cell ends a column group either when it is at the end of a row
4195 ;; or when it has a right border.
4198 table-cell)
4202 "Non-nil when TABLE-ROW is at the beginning of a column group.
4203 INFO is a plist used as a communication channel."
4211 "Non-nil when TABLE-ROW is at the end of a column group.
4212 INFO is a plist used as a communication channel."
4220 "Non-nil when TABLE-ROW is the first table header's row.
4221 INFO is a plist used as a communication channel."
4228 "Non-nil when TABLE-ROW is the last table header's row.
4229 INFO is a plist used as a communication channel."
4236 "Return TABLE dimensions.
4238 INFO is a plist used as a communication channel.
4240 Return value is a CONS like (ROWS . COLUMNS) where
4241 ROWS (resp. COLUMNS) is the number of exportable
4242 rows (resp. columns)."
4244 ;; Set number of rows, and extract first one.
4246 table 'table-row
4251 ;; Set number of columns.
4253 ;; Return value.
4257 "Return address of a regular TABLE-CELL object.
4259 TABLE-CELL is the cell considered. INFO is a plist used as
4260 a communication channel.
4262 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4263 zero-based index. Only exportable cells are considered. The
4264 function returns nil for other cells."
4267 ;; Ignore cells in special rows or in special column.
4272 ;; Row number.
4275 table 'table-row
4281 ;; Column number.
4284 table-row 'table-cell
4290 "Return regular table-cell object at ADDRESS in TABLE.
4292 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4293 zero-based index. TABLE is a table type element. INFO is
4294 a plist used as a communication channel.
4296 If no table-cell, among exportable cells, is found at ADDRESS,
4297 return nil."
4300 ;; Row at (car address) or nil.
4303 table 'table-row
4309 'table-cell
4316 ;;;; For Tables Of Contents
4317 ;;
4318 ;; `org-export-collect-headlines' builds a list of all exportable
4319 ;; headline elements, maybe limited to a certain depth. One can then
4320 ;; easily parse it and transcode it.
4321 ;;
4322 ;; Building lists of tables, figures or listings is quite similar.
4323 ;; Once the generic function `org-export-collect-elements' is defined,
4324 ;; `org-export-collect-tables', `org-export-collect-figures' and
4325 ;; `org-export-collect-listings' can be derived from it.
4328 "Collect headlines in order to build a table of contents.
4330 INFO is a plist used as a communication channel.
4332 When optional argument N is an integer, it specifies the depth of
4333 the table of contents. Otherwise, it is set to the value of the
4334 last headline level. See `org-export-headline-levels' for more
4335 information.
4337 Return a list of all exportable headlines as parsed elements."
4341 'headline
4343 ;; Strip contents from HEADLINE.
4346 info))
4349 "Collect referenceable elements of a determined type.
4351 TYPE can be a symbol or a list of symbols specifying element
4352 types to search. Only elements with a caption are collected.
4354 INFO is a plist used as a communication channel.
4356 When non-nil, optional argument PREDICATE is a function accepting
4357 one argument, an element of type TYPE. It returns a non-nil
4358 value when that element should be collected.
4360 Return a list of all elements found, in order of appearance."
4366 element))
4367 info))
4370 "Build a list of tables.
4371 INFO is a plist used as a communication channel.
4373 Return a list of table elements with a caption."
4377 "Build a list of figures.
4379 INFO is a plist used as a communication channel. PREDICATE is
4380 a function which accepts one argument: a paragraph element and
4381 whose return value is non-nil when that element should be
4382 collected.
4384 A figure is a paragraph type element, with a caption, verifying
4386 a vague concept that may depend on back-end.
4388 Return a list of elements recognized as figures."
4392 "Build a list of src blocks.
4394 INFO is a plist used as a communication channel.
4396 Return a list of src-block elements with a caption."
4400 ;;;; For Timestamps
4401 ;;
4402 ;; `org-export-timestamp-has-time-p' is a predicate to know if hours
4403 ;; and minutes are defined in a given timestamp.
4404 ;;
4405 ;; `org-export-format-timestamp' allows to format a timestamp object
4406 ;; with an arbitrary format string.
4409 "Non-nil when TIMESTAMP has a time specified."
4413 "Format a TIMESTAMP element into a string.
4415 FORMAT is a format specifier to be passed to
4416 `format-time-string'.
4418 When optional argument END is non-nil, use end of date-range or
4419 time-range, if possible.
4421 When optional argument UTC is non-nil, time will be expressed as
4422 Universal Time."
4424 format
4432 utc))
4435 "Extract a timestamp object from a date or time range.
4437 TIMESTAMP is a timestamp object. END, when non-nil, means extract
4438 the end of the range. Otherwise, extract its start.
4440 Return a new timestamp object sharing the same parent as
4441 TIMESTAMP."
4445 ;; Set new type.
4448 ;; Copy start properties over end properties if END is
4449 ;; non-nil. Otherwise, copy end properties over `start' ones.
4457 split-ts
4461 ;; Eventually refresh `:raw-value'.
4467 "Apply `org-translate-time' on a TIMESTAMP object.
4468 When optional argument BOUNDARY is non-nil, it is either the
4469 symbol `start' or `end'. In this case, only translate the
4470 starting or ending part of TIMESTAMP if it is a date or time
4471 range. Otherwise, translate both parts."
4479 "--"
4485 :raw-value
4490 ;;;; Smart Quotes
4491 ;;
4492 ;; The main function for the smart quotes sub-system is
4493 ;; `org-export-activate-smart-quotes', which replaces every quote in
4494 ;; a given string from the parse tree with its "smart" counterpart.
4495 ;;
4496 ;; Dictionary for smart quotes is stored in
4497 ;; `org-export-smart-quotes-alist'.
4498 ;;
4499 ;; Internally, regexps matching potential smart quotes (checks at
4500 ;; string boundaries are also necessary) are defined in
4501 ;; `org-export-smart-quotes-regexps'.
4538 "Smart quotes translations.
4540 Alist whose CAR is a language string and CDR is an alist with
4541 quote type as key and a plist associating various encodings to
4542 their translation as value.
4544 A quote type can be any symbol among `opening-double-quote',
4545 `closing-double-quote', `opening-single-quote',
4546 `closing-single-quote' and `apostrophe'.
4548 Valid encodings include `:utf-8', `:html', `:latex' and
4549 `:texinfo'.
4555 ;; Possible opening quote at beginning of string.
4557 ;; Possible closing quote at beginning of string.
4559 ;; Possible apostrophe at beginning of string.
4561 ;; Opening single and double quotes.
4563 ;; Closing single and double quotes.
4565 ;; Apostrophe.
4567 ;; Possible opening quote at end of string.
4569 ;; Possible closing quote at end of string.
4571 ;; Possible apostrophe at end of string.
4573 "List of regexps matching a quote or an apostrophe.
4579 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4580 `:utf-8'. INFO is a plist used as a communication channel.
4582 The function has to retrieve information about string
4583 surroundings in parse tree. It can only happen with an
4584 unmodified string. Thus, if S has already been through another
4585 process, a non-nil ORIGINAL optional argument will provide that
4586 original string.
4588 Return the new string."
4595 ;; Return smart quote associated to a give quote Q, as
4596 ;; a string. TYPE is a symbol among `open', `close' and
4597 ;; `apostrophe'.
4607 org-export-smart-quotes-alist))))
4608 encoding)
4609 q)))))
4611 ;; Only a quote: no regexp can match. We have to check both
4612 ;; sides and decide what to do.
4620 ;; 1. Replace quote character at the beginning of S.
4622 ;; Apostrophe?
4628 ;; Closing quote?
4634 ;; Opening quote?
4640 ;; 2. Replace quotes in the middle of the string.
4642 ;; Opening quotes.
4648 ;; Closing quotes.
4654 ;; Apostrophes.
4659 ;; 3. Replace quote character at the end of S.
4661 ;; Apostrophe?
4666 ;; Closing quote?
4672 ;; Opening quote?
4677 ;; Return string with smart quotes.
4678 s))))
4680 ;;;; Topology
4681 ;;
4682 ;; Here are various functions to retrieve information about the
4683 ;; neighbourhood of a given element or object. Neighbours of interest
4684 ;; are direct parent (`org-export-get-parent'), parent headline
4685 ;; (`org-export-get-parent-headline'), first element containing an
4686 ;; object, (`org-export-get-parent-element'), parent table
4687 ;; (`org-export-get-parent-table'), previous element or object
4688 ;; (`org-export-get-previous-element') and next element or object
4689 ;; (`org-export-get-next-element').
4690 ;;
4691 ;; `org-export-get-genealogy' returns the full genealogy of a given
4692 ;; element or object, from closest parent to full parse tree.
4695 "Return BLOB parent or nil.
4696 BLOB is the element or object considered."
4700 "Return full genealogy relative to a given element or object.
4702 BLOB is the element or object being considered.
4704 Ancestors are returned from closest to farthest, the last one
4705 being the full parse tree."
4712 "Return BLOB parent headline or nil.
4713 BLOB is the element or object being considered."
4717 parent))
4720 "Return first element containing OBJECT or nil.
4721 OBJECT is the object to consider."
4725 parent))
4728 "Return OBJECT parent table or nil.
4729 OBJECT is either a `table-cell' or `table-element' type object."
4733 parent))
4736 "Return previous element or object.
4738 BLOB is an element or object. INFO is a plist used as
4739 a communication channel. Return previous exportable element or
4740 object, a string, or nil.
4742 When optional argument N is a positive integer, return a list
4743 containing up to N siblings before BLOB, from closest to
4744 farthest. With any other non-nil value, return a list containing
4745 all of them."
4747 ;; An object can belong to the contents of its parent or
4748 ;; to a secondary string. We check the latter option
4749 ;; first.
4752 org-element-all-elements))
4756 org-element-secondary-value-alist))
4757 parent)))
4760 prev)
4772 "Return next element or object.
4774 BLOB is an element or object. INFO is a plist used as
4775 a communication channel. Return next exportable element or
4776 object, a string, or nil.
4778 When optional argument N is a positive integer, return a list
4779 containing up to N siblings after BLOB, from closest to farthest.
4780 With any other non-nil value, return a list containing all of
4781 them."
4783 ;; An object can belong to the contents of its parent or to
4784 ;; a secondary string. We check the latter option first.
4787 org-element-all-objects))
4791 org-element-secondary-value-alist))
4792 parent)))
4795 next)
4803 siblings)
4807 ;;;; Translation
4808 ;;
4809 ;; `org-export-translate' translates a string according to language
4810 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4811 ;; variable and a specified charset. `org-export-dictionary' contains
4812 ;; the dictionary used for the translation.
4934 "Dictionary for export engine.
4936 Alist whose CAR is the string to translate and CDR is an alist
4937 whose CAR is the language string and CDR is a plist whose
4938 properties are possible charsets and values translated terms.
4940 It is used as a database for `org-export-translate'. Since this
4941 function returns the string as-is if no translation was found,
4942 the variable only needs to record values different from the
4946 "Translate string S according to language specification.
4948 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4949 and `:utf-8'. INFO is a plist used as a communication channel.
4951 Translation depends on `:language' property. Return the
4952 translated string. If no translation is found, try to fall back
4953 to `:default' encoding. If it fails, return S."
4959 s)))
4962 \f
4963 ;;; Asynchronous Export
4964 ;;
4965 ;; `org-export-async-start' is the entry point for asynchronous
4966 ;; export. It recreates current buffer (including visibility,
4967 ;; narrowing and visited file) in an external Emacs process, and
4968 ;; evaluates a command there. It then applies a function on the
4969 ;; returned results in the current process.
4970 ;;
4971 ;; Asynchronously generated results are never displayed directly.
4972 ;; Instead, they are stored in `org-export-stack-contents'. They can
4973 ;; then be retrieved by calling `org-export-stack'.
4974 ;;
4975 ;; Export Stack is viewed through a dedicated major mode
4976 ;;`org-export-stack-mode' and tools: `org-export--stack-refresh',
4977 ;;`org-export--stack-delete', `org-export--stack-view' and
4978 ;;`org-export--stack-clear'.
4979 ;;
4980 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
4981 ;; It should used whenever `org-export-async-start' is called.
4984 "Call function FUN on the results returned by BODY evaluation.
4986 BODY evaluation happens in an asynchronous process, from a buffer
4987 which is an exact copy of the current one.
4989 Use `org-export-add-to-stack' in FUN in order to register results
4990 in the stack. Examples for, respectively a temporary buffer and
4991 a file are:
4993 \(org-export-async-start
4994 \(lambda (output)
4996 \(erase-buffer)
4997 \(insert output)
4998 \(goto-char (point-min))
4999 \(org-export-add-to-stack (current-buffer) 'backend)))
5000 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5002 and
5004 \(org-export-async-start
5005 \(lambda (f) (org-export-add-to-stack f 'backend))
5006 `(expand-file-name
5007 \(org-export-to-file
5008 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5011 ;; Write the full sexp evaluating BODY in a copy of the current
5012 ;; buffer to a temporary file, as it may be too long for program
5013 ;; args in `start-process'.
5020 "%S"
5023 ;; Initialize `org-mode' in the external process.
5025 ;; Re-create current buffer there.
5028 ;; Sexp to evaluate in the buffer.
5030 ;; Start external process.
5033 (,process
5038 "-l" org-export-async-init-file
5040 ;; Register running process in stack.
5042 ;; Set-up sentinel in order to catch results.
5044 ,process
5068 "Add a new result to export stack if not present already.
5070 SOURCE is a buffer or a file name containing export results.
5071 BACKEND is a symbol representing export back-end used to generate
5072 it.
5074 Entries already pointing to SOURCE and unavailable entries are
5075 removed beforehand. Return the new stack."
5081 "Menu for asynchronous export results and running processes."
5091 "Return source from export results at point in stack."
5098 source
5099 ;; SOURCE is not consistent with current line. The stack
5100 ;; view is outdated.
5104 "Remove all entries from export stack."
5109 "Refresh the asynchronous export stack.
5110 DUMMY is ignored. Unavailable sources are removed from the list.
5111 Return the new stack."
5121 ;; Back-end.
5123 ;; Age.
5126 ;; Compute age of the results.
5128 "%4h:%.2m "
5130 ;; Source.
5135 ;; Clear stack from exited processes, dead buffers or
5136 ;; non-existent files.
5148 "Remove export results at point from stack.
5149 If optional argument SOURCE is non-nil, remove it instead."
5154 org-export-stack-contents))))
5157 "View export results at point in stack."
5171 (define-key km "p" 'previous-line)
5172 (define-key km "\C-p" 'previous-line)
5173 (define-key km "\C-?" 'previous-line)
5174 (define-key km [up] 'previous-line)
5175 (define-key km "C" 'org-export--stack-clear)
5176 (define-key km "v" 'org-export--stack-view)
5177 (define-key km (kbd "RET") 'org-export--stack-view)
5178 (define-key km "d" 'org-export--stack-remove)
5179 km)
5180 "Keymap for Org Export Stack.")
5182 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5183 "Mode for displaying asynchronous export stack.
5186 stack.
5188 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export--stack-view] to view export output
5189 on current line, \\[org-export--stack-remove] to remove it from the stack and \\[org-export--stack-clear] to clear
5190 stack completely.
5192 Removal entries in an Org Export Stack buffer doesn't affect
5193 files or buffers, only view in the stack.
5196 (abbrev-mode 0)
5197 (auto-fill-mode 0)
5198 (setq buffer-read-only t
5199 buffer-undo-list t
5200 truncate-lines t
5201 header-line-format
5202 '(:eval
5203 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5204 (add-hook 'post-command-hook 'org-export--stack-refresh nil t)
5205 (set (make-local-variable 'revert-buffer-function)
5206 'org-export--stack-refresh))
5209 \f
5210 ;;; The Dispatcher
5211 ;;
5212 ;; `org-export-dispatch' is the standard interactive way to start an
5213 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
5214 ;; for its interface, which, in turn, delegates response to key
5215 ;; pressed to `org-export-dispatch-action'.
5217 ;;;###autoload
5218 (defun org-export-dispatch (&optional arg)
5219 "Export dispatcher for Org mode.
5221 It provides an access to common export related tasks in a buffer.
5222 Its interface comes in two flavours: standard and expert. While
5223 both share the same set of bindings, only the former displays the
5224 valid keys associations. Set `org-export-dispatch-use-expert-ui'
5225 to switch to one or the other.
5227 When called with C-u prefix ARG, repeat the last export action,
5228 with the same set of options used back then, on the current
5229 buffer.
5231 When called with a double universal argument, display the
5232 asynchronous export stack directly."
5233 (interactive "P")
5234 (let* ((input
5235 (cond ((equal arg '(16)) '(stack))
5236 ((and arg org-export-dispatch-last-action))
5237 (t (save-window-excursion
5238 (unwind-protect
5239 ;; Store this export command.
5240 (setq org-export-dispatch-last-action
5241 (org-export-dispatch-ui
5242 (list org-export-initial-scope
5243 (and org-export-in-background 'async))
5244 nil
5245 org-export-dispatch-use-expert-ui))
5246 (and (get-buffer "*Org Export Dispatcher*")
5247 (kill-buffer "*Org Export Dispatcher*")))))))
5248 (action (car input))
5249 (optns (cdr input)))
5250 (case action
5251 ;; First handle special hard-coded actions.
5252 (stack (org-export-stack))
5253 (publish-current-file
5254 (org-e-publish-current-file (memq 'force optns) (memq 'async optns)))
5255 (publish-current-project
5256 (org-e-publish-current-project (memq 'force optns) (memq 'async optns)))
5257 (publish-choose-project
5258 (org-e-publish (assoc (org-icompleting-read
5259 "Publish project: "
5260 org-e-publish-project-alist nil t)
5261 org-e-publish-project-alist)
5262 (memq 'force optns)
5263 (memq 'async optns)))
5264 (publish-all (org-e-publish-all (memq 'force optns) (memq 'async optns)))
5265 (otherwise (funcall action
5266 ;; Return a symbol instead of a list to ease
5267 ;; asynchronous export macro use.
5268 (and (memq 'async optns) t)
5269 (and (memq 'subtree optns) t)
5270 (and (memq 'visible optns) t)
5271 (and (memq 'body optns) t))))))
5273 (defun org-export-dispatch-ui (options first-key expertp)
5274 "Handle interface for `org-export-dispatch'.
5276 OPTIONS is a list containing current interactive options set for
5277 export. It can contain any of the following symbols:
5278 `body' toggles a body-only export
5279 `subtree' restricts export to current subtree
5280 `visible' restricts export to visible part of buffer.
5281 `force' force publishing files.
5282 `async' use asynchronous export process
5284 FIRST-KEY is the key pressed to select the first level menu. It
5285 is nil when this menu hasn't been selected yet.
5287 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5288 buffer is provided, but indications about currently active
5289 options are given in the prompt. Moreover, \[?] allows to switch
5290 back to standard interface."
5291 (let* ((fontify-key
5292 (lambda (key &optional access-key)
5293 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5294 ;; non-nil is the required first-level key to activate
5295 ;; KEY. When its value is t, activate KEY independently
5296 ;; on the first key, if any. A nil value means KEY will
5297 ;; only be activated at first level.
5298 (if (or (eq access-key t) (eq access-key first-key))
5299 (org-add-props key nil 'face 'org-warning)
5300 (org-no-properties key))))
5301 ;; Prepare menu entries by extracting them from
5302 ;; `org-export-registered-backends', and sorting them by
5303 ;; access key and by ordinal, if any.
5304 (backends (sort
5305 (sort
5306 (delq nil
5307 (mapcar (lambda (b)
5308 (org-export-backend-menu (car b)))
5309 org-export-registered-backends))
5310 (lambda (a b)
5311 (let ((key-a (nth 1 a))
5312 (key-b (nth 1 b)))
5313 (cond ((and (numberp key-a) (numberp key-b))
5314 (< key-a key-b))
5315 ((numberp key-b) t)))))
5316 (lambda (a b) (< (car a) (car b)))))
5317 ;; Compute a list of allowed keys based on the first key
5318 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4, ?5 and ?q)
5319 ;; are always available.
5320 (allowed-keys
5321 (nconc (list ?1 ?2 ?3 ?4 ?5)
5322 (if (not first-key) (org-uniquify (mapcar 'car backends))
5323 (let (sub-menu)
5324 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5325 (when (eq (car backend) first-key)
5326 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5327 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5328 ((not first-key) (list ?P)))
5329 (list ?&)
5330 (when expertp (list ??))
5331 (list ?q)))
5332 ;; Build the help menu for standard UI.
5333 (help
5334 (unless expertp
5335 (concat
5336 ;; Options are hard-coded.
5337 (format "Options
5338 [%s] Body only: %s [%s] Visible only: %s
5339 [%s] Export scope: %s [%s] Force publishing: %s
5341 (funcall fontify-key "1" t)
5342 (if (memq 'body options) "On " "Off")
5343 (funcall fontify-key "2" t)
5344 (if (memq 'visible options) "On " "Off")
5345 (funcall fontify-key "3" t)
5346 (if (memq 'subtree options) "Subtree" "Buffer ")
5347 (funcall fontify-key "4" t)
5348 (if (memq 'force options) "On " "Off")
5349 (funcall fontify-key "5" t)
5350 (if (memq 'async options) "On " "Off"))
5351 ;; Display registered back-end entries. When a key
5352 ;; appears for the second time, do not create another
5353 ;; entry, but append its sub-menu to existing menu.
5354 (let (last-key)
5355 (mapconcat
5356 (lambda (entry)
5357 (let ((top-key (car entry)))
5358 (concat
5359 (unless (eq top-key last-key)
5360 (setq last-key top-key)
5362 (funcall fontify-key (char-to-string top-key))
5363 (nth 1 entry)))
5364 (let ((sub-menu (nth 2 entry)))
5365 (unless (functionp sub-menu)
5366 ;; Split sub-menu into two columns.
5367 (let ((index -1))
5368 (concat
5369 (mapconcat
5370 (lambda (sub-entry)
5371 (incf index)
5372 (format
5373 (if (zerop (mod index 2)) " [%s] %-24s"
5375 (funcall fontify-key
5376 (char-to-string (car sub-entry))
5377 top-key)
5378 (nth 1 sub-entry)))
5379 sub-menu "")
5381 backends ""))
5382 ;; Publishing menu is hard-coded.
5384 [%s] Current file [%s] Current project
5386 (funcall fontify-key "P")
5387 (funcall fontify-key "f" ?P)
5388 (funcall fontify-key "p" ?P)
5389 (funcall fontify-key "x" ?P)
5390 (funcall fontify-key "a" ?P))
5392 (format "\[%s] %s"
5393 (funcall fontify-key "q" t)
5394 (if first-key "Main menu" "Exit")))))
5395 ;; Build prompts for both standard and expert UI.
5396 (standard-prompt (unless expertp "Export command: "))
5397 (expert-prompt
5398 (when expertp
5399 (format
5400 "Export command (Options: %s%s%s%s%s) [%s]: "
5401 (if (memq 'body options) (funcall fontify-key "b" t) "-")
5402 (if (memq 'visible options) (funcall fontify-key "v" t) "-")
5403 (if (memq 'subtree options) (funcall fontify-key "s" t) "-")
5404 (if (memq 'force options) (funcall fontify-key "f" t) "-")
5405 (if (memq 'async options) (funcall fontify-key "a" t) "-")
5406 (concat allowed-keys)))))
5407 ;; With expert UI, just read key with a fancy prompt. In standard
5408 ;; UI, display an intrusive help buffer.
5409 (if expertp
5410 (org-export-dispatch-action
5411 expert-prompt allowed-keys backends options first-key expertp)
5412 ;; At first call, create frame layout in order to display menu.
5413 (unless (get-buffer "*Org Export Dispatcher*")
5414 (delete-other-windows)
5415 (org-switch-to-buffer-other-window
5416 (get-buffer-create "*Org Export Dispatcher*"))
5417 (setq cursor-type nil))
5418 ;; At this point, the buffer containing the menu exists and is
5419 ;; visible in the current window. So, refresh it.
5420 (with-current-buffer "*Org Export Dispatcher*"
5421 (erase-buffer)
5422 (insert help))
5423 (org-fit-window-to-buffer)
5424 (org-export-dispatch-action
5425 standard-prompt allowed-keys backends options first-key expertp))))
5427 (defun org-export-dispatch-action
5428 (prompt allowed-keys backends options first-key expertp)
5429 "Read a character from command input and act accordingly.
5431 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5432 a list of characters available at a given step in the process.
5433 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5434 EXPERTP are the same as defined in `org-export-dispatch-ui',
5435 which see.
5437 Toggle export options when required. Otherwise, return value is
5438 a list with action as CAR and a list of interactive export
5439 options as CDR."
5440 (let ((key (let ((k (read-char-exclusive prompt)))
5441 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
5442 ;; depending on user's key pressed.
5443 (if (< k 27) (+ k 96) k))))
5444 (cond
5445 ;; Ignore non-standard characters (i.e. "M-a") and
5446 ;; undefined associations.
5447 ((not (memq key allowed-keys))
5448 (ding)
5449 (unless expertp (message "Invalid key") (sit-for 1))
5450 (org-export-dispatch-ui options first-key expertp))
5451 ;; q key at first level aborts export. At second
5452 ;; level, cancel first key instead.
5453 ((eq key ?q) (if (not first-key) (error "Export aborted")
5454 (org-export-dispatch-ui options nil expertp)))
5455 ;; Help key: Switch back to standard interface if
5456 ;; expert UI was active.
5457 ((eq key ??) (org-export-dispatch-ui options first-key nil))
5458 ;; Switch to asynchronous export stack.
5459 ((eq key ?&) '(stack))
5460 ;; Toggle export options.
5461 ((memq key '(?1 ?2 ?3 ?4 ?5))
5462 (org-export-dispatch-ui
5463 (let ((option (case key (?1 'body) (?2 'visible) (?3 'subtree)
5464 (?4 'force) (?5 'async))))
5465 (if (memq option options) (remq option options)
5466 (cons option options)))
5467 first-key expertp))
5468 ;; Action selected: Send key and options back to
5469 ;; `org-export-dispatch'.
5470 ((or first-key (functionp (nth 2 (assq key backends))))
5471 (cons (cond
5472 ((not first-key) (nth 2 (assq key backends)))
5473 ;; Publishing actions are hard-coded. Send a special
5474 ;; signal to `org-export-dispatch'.
5475 ((eq first-key ?P)
5476 (case key
5477 (?f 'publish-current-file)
5478 (?p 'publish-current-project)
5479 (?x 'publish-choose-project)
5480 (?a 'publish-all)))
5481 ;; Return first action associated to FIRST-KEY + KEY
5482 ;; path. Indeed, derived backends can share the same
5483 ;; FIRST-KEY.
5484 (t (catch 'found
5485 (mapc (lambda (backend)
5486 (let ((match (assq key (nth 2 backend))))
5487 (when match (throw 'found (nth 2 match)))))
5488 (member (assq first-key backends) backends)))))
5489 options))
5490 ;; Otherwise, enter sub-menu.
5491 (t (org-export-dispatch-ui options key expertp)))))
5494 (provide 'org-export)
5495 ;;; org-export.el ends here