| blob | 74d0d862aed0e096937a9638508375243e8453c7 |
1 ;;; ox.el --- Generic Export Engine for Org Mode
3 ;; Copyright (C) 2012, 2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; GNU Emacs 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 ;; GNU Emacs 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 GNU Emacs. 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:
96 \f
97 ;;; Internal Variables
98 ;;
99 ;; Among internal variables, the most important is
100 ;; `org-export-options-alist'. This variable define the global export
101 ;; options, shared between every exporter, and how they are acquired.
146 "Alist between export properties and ways to set them.
148 The CAR of the alist is the property name, and the CDR is a list
149 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
151 KEYWORD is a string representing a buffer keyword, or nil. Each
152 property defined this way can also be set, during subtree
153 export, through a headline property named after the keyword
155 property).
156 OPTION is a string that could be found in an #+OPTIONS: line.
157 DEFAULT is the default value for the property.
158 BEHAVIOUR determines how Org should handle multiple keywords for
159 the same property. It is a symbol among:
160 nil Keep old value and discard the new one.
161 t Replace old value with the new one.
162 `space' Concatenate the values, separating them with a space.
163 `newline' Concatenate the values, separating them with
164 a newline.
165 `split' Split values at white spaces, and cons them to the
166 previous list.
168 Values set through KEYWORD and OPTION have precedence over
169 DEFAULT.
171 All these properties should be back-end agnostic. Back-end
172 specific properties are set through `org-export-define-backend'.
176 "List of in-buffer keywords that require special treatment.
177 These keywords are not directly associated to a property. The
178 way they are handled must be hard-coded into
239 "Alist between filters properties and initial values.
241 The key of each association is a property name accessible through
242 the communication channel. Its value is a configurable global
243 variable defining initial filters.
245 This list is meant to install user specified filters. Back-end
246 developers may install their own filters using
247 `org-export-define-backend'. Filters defined there will always
248 be prepended to the current list, so they always get applied
257 "Default rule for link matching an inline image.
258 This rule applies to links with no description. By default, it
259 will be considered as an inline image if it targets a local file
262 See `org-export-inline-image-p' for more information about
266 "Non-nil means asynchronous export process should leave data behind.
270 located in `temporary-file-directory'.
272 When non-nil, it will also set `debug-on-error' to a non-nil
276 "Record asynchronously generated export results and processes.
277 This is an alist: its CAR is the source of the
278 result (destination file or buffer for a finished process,
279 original buffer for a running one) and its CDR is a list
280 containing the back-end used, as a symbol, and either a process
281 or the time at which it finished. It is used to build the menu
285 "List of backends currently available in the exporter.
287 A backend is stored as a list where CAR is its name, as a symbol,
288 and CDR is a plist with the following properties:
289 `:filters-alist', `:menu-entry', `:options-alist' and
290 `:translate-alist'.
292 This variable is set with `org-export-define-backend' and
296 "Last command called from the dispatcher.
297 The value should be a list. Its CAR is the action, as a symbol,
301 \f
302 ;;; User-configurable Variables
303 ;;
304 ;; Configuration for the masses.
305 ;;
306 ;; They should never be accessed directly, as their value is to be
307 ;; stored in a property list (cf. `org-export-options-alist').
308 ;; Back-ends will read their value from there instead.
311 "Options for exporting Org mode files."
316 "General options for export engine."
321 "Whether sub-trees with the ARCHIVE tag should be exported.
323 This can have three different values:
324 nil Do not export, pretend this tree is not present.
325 t Do export the entire tree.
326 `headline' Only export the headline, but skip the tree below it.
328 This option can also be set with the #+OPTIONS line,
337 "Non-nil means insert author name into the exported file.
338 This option can also be set with the #+OPTIONS line,
344 "Non-nil means export CLOCK keywords.
345 This option can also be set with the #+OPTIONS line,
351 "Non-nil means the postamble should contain a creator sentence.
353 The sentence can be set in `org-export-creator-string' and
356 If the value is `comment' insert it as a comment."
364 "Non-nil means insert date in the exported document.
365 This options can also be set with the OPTIONS keyword,
371 emacs-version)
372 "String to insert at the end of the generated document."
377 "Non-nil means export contents of standard drawers.
379 When t, all drawers are exported. This may also be a list of
380 drawer names to export. If that list starts with `not', only
381 drawers with such names will be ignored.
383 This variable doesn't apply to properties drawers.
385 This option can also be set with the #+OPTIONS line,
396 :inline t
400 "Non-nil means insert author email into the exported file.
401 This option can also be set with the #+OPTIONS line,
407 "Non-nil means interpret *word*, /word/, _word_ and +word+.
409 If the export target supports emphasizing text, the word will be
410 typeset in bold, italic, with an underline or strike-through,
411 respectively.
418 "Tags that exclude a tree from export.
420 All trees carrying any of these tags will be excluded from
421 export. This is without condition, so even subtrees inside that
422 carry one of the `org-export-select-tags' will be removed.
424 This option can also be set with the #+EXCLUDE_TAGS: keyword."
431 This can be used to have pre-formatted text, fragments of code
432 etc. For example:
433 : ;; Some Lisp examples
434 : (while (defc cnt)
435 : (ding))
436 will be looking just like this in also HTML. See also the QUOTE
437 keyword. Not all export backends support this.
444 "Non-nil means Org footnotes should be exported.
445 This option can also be set with the #+OPTIONS line,
451 "Non-nil means process LaTeX environments and fragments.
453 This option can also be set with the +OPTIONS line,
456 nil Ignore math snippets.
457 `verbatim' Keep everything in verbatim.
458 t Allow export of math snippets."
466 "The last level which is still exported as a headline.
468 Inferior levels will produce itemize or enumerate lists when
469 exported.
476 "The default language for export and clocktable translations, as a string.
477 This may have an association in
478 `org-clock-clocktable-language-setup'."
483 "Non-nil means preserve all line breaks when exporting.
484 This option can also be set with the #+OPTIONS line,
490 "Non-nil means interpret entities when exporting.
493 Å.
495 For a list of supported names, see the constant `org-entities'
496 and the user option `org-entities-user'.
498 This option can also be set with the #+OPTIONS line,
504 "Non-nil means inlinetasks should be exported.
505 This option can also be set with the #+OPTIONS line,
511 "Non-nil means include planning info in export.
512 This option can also be set with the #+OPTIONS: line,
518 "Non-nil means include priority cookies in export.
519 This option can also be set with the #+OPTIONS line,
525 "Non-nil means add section numbers to headlines when exporting.
527 When set to an integer n, numbering will only happen for
528 headlines whose relative level is higher or equal to n.
530 This option can also be set with the #+OPTIONS line,
536 "Tags that select a tree for export.
538 If any such tag is found in a buffer, all trees that do not carry
539 one of these tags will be ignored during export. Inside trees
540 that are selected like this, you can still deselect a subtree by
541 tagging it with one of the `org-export-exclude-tags'.
543 This option can also be set with the #+SELECT_TAGS: keyword."
548 "Non-nil means activate smart quotes during export.
549 This option can also be set with the #+OPTIONS: line,
557 When this option is turned on, these strings will be exported as:
559 Org HTML LaTeX UTF-8
560 -----+----------+--------+-------
562 -- – -- –
563 --- — --- —
566 This option can also be set with the #+OPTIONS line,
572 "Non-nil means include statistics cookies in export.
573 This option can also be set with the #+OPTIONS: line,
581 When this option is turned on, you can use TeX-like syntax for
583 will be considered as a single item - so grouping with {} is
584 normally not needed. For example, the following things will be
585 parsed as single sub- or superscripts.
587 10^24 or 10^tau several digits will be considered 1 item.
588 10^-12 or 10^-tau a leading sign with digits or a word
589 x^2-y^3 will be read as x^2 - y^3, because items are
590 terminated by almost any nonword/nondigit char.
591 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
593 Still, ambiguity is possible - so when in doubt use {} to enclose
594 the sub/superscript. If you set this variable to the symbol
595 `{}', the braces are *required* in order to trigger
596 interpretations as sub/superscript. This can be helpful in
599 This option can also be set with the #+OPTIONS line,
608 "Non-nil means create a table of contents in exported files.
610 The TOC contains headlines with levels up
611 to`org-export-headline-levels'. When an integer, include levels
612 up to N in the toc, this may then be different from
613 `org-export-headline-levels', but it will not be allowed to be
614 larger than the number of headline levels. When nil, no table of
615 contents is made.
617 This option can also be set with the #+OPTIONS line,
627 For example:
629 | Name | Address | Birthday |
630 |-------------+----------+-----------|
631 | Arthur Dent | England | 29.2.2100 |
638 "If nil, do not export tags, just remove them from headlines.
640 If this is the symbol `not-in-toc', tags will be removed from
641 table of contents entries, but still be shown in the headlines of
642 the document.
644 This option can also be set with the #+OPTIONS line,
653 "Non-nil means include TODO items for export.
655 This may have the following values:
656 t include tasks independent of state.
657 `todo' include only tasks that are not yet done.
658 `done' include only tasks that are already done.
659 nil ignore all tasks.
660 list of keywords include tasks with these keywords.
662 This option can also be set with the #+OPTIONS line,
674 "Non-nil means insert a time stamp into the exported file.
675 The time stamp shows when the file was created.
677 This option can also be set with the #+OPTIONS line,
683 "Non nil means allow timestamps in export.
685 It can be set to `active', `inactive', t or nil, in order to
686 export, respectively, only active timestamps, only inactive ones,
687 all of them or none.
689 This option can also be set with the #+OPTIONS line, e.g.
699 "Non-nil means include TODO keywords in export.
700 When nil, remove all these keywords from the export."
705 "Non-nil means BIND keywords can define local variable values.
706 This is a potential security risk, which is why the default value
707 is nil. You can also allow them through local buffer variables."
712 "Alist between export snippets back-ends and exporter back-ends.
714 This variable allows to provide shortcuts for export snippets.
718 HTML code while every other back-end will ignore it."
725 "Coding system for the exported file."
730 "Non-nil means exported stuff will also be pushed onto the kill ring."
735 "The initial scope when exporting with `org-export-dispatch'.
736 This variable can be either set to `buffer' or `subtree'."
743 "Non-nil means show buffer after exporting to temp buffer.
744 When Org exports to a file, the buffer visiting that file is ever
745 shown, but remains buried. However, when exporting to
746 a temporary buffer, that buffer is popped up in a second window.
747 When this variable is nil, the buffer remains buried also in
748 these cases."
753 "Non-nil means export and publishing commands will run in background.
754 Results from an asynchronous export are never displayed
760 "File used to initialize external export process.
761 Value must be an absolute file name. It defaults to user's
762 initialization file. Though, a specific configuration makes the
763 process faster and the export more portable."
768 "List of back-ends that shouldn't appear in the dispatcher.
770 Any back-end belonging to this list or derived from a back-end
771 belonging to it will not appear in the dispatcher menu.
773 Indeed, Org may require some export back-ends without notice. If
774 these modules are never to be used interactively, adding them
775 here will avoid cluttering the dispatcher menu."
780 "Non-nil means using a non-intrusive `org-export-dispatch'.
781 In that case, no help buffer is displayed. Though, an indicator
787 asynchronous). Also, \[?] allows to switch back to standard
788 mode."
793 \f
794 ;;; Defining Back-ends
795 ;;
796 ;; `org-export-define-backend' is the standard way to define an export
797 ;; back-end. It allows to specify translators, filters, buffer
798 ;; options and a menu entry. If the new back-end shares translators
799 ;; with another back-end, `org-export-define-derived-backend' may be
800 ;; used instead.
801 ;;
802 ;; Internally, a back-end is stored as a list, of which CAR is the
803 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
804 ;; properties of a given back-end are: `org-export-backend-filters',
805 ;; `org-export-backend-menu', `org-export-backend-options' and
806 ;; `org-export-backend-translate-table'.
807 ;;
808 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
809 ;; when a given back-end hasn't been registered yet.
812 "Define a new back-end BACKEND.
814 TRANSLATORS is an alist between object or element types and
815 functions handling them.
817 These functions should return a string without any trailing
818 space, or nil. They must accept three arguments: the object or
819 element itself, its contents or nil when it isn't recursive and
820 the property list used as a communication channel.
822 Contents, when not nil, are stripped from any global indentation
823 \(although the relative one is preserved). They also always end
824 with a single newline character.
826 If, for a given type, no function is found, that element or
827 object type will simply be ignored, along with any blank line or
828 white space at its end. The same will happen if the function
829 returns the nil value. If that function returns the empty
830 string, the type will be ignored, but the blank lines or white
831 spaces will be kept.
833 In addition to element and object types, one function can be
834 associated to the `template' (or `inner-template') symbol and
835 another one to the `plain-text' symbol.
837 The former returns the final transcoded string, and can be used
838 to add a preamble and a postamble to document's body. It must
839 accept two arguments: the transcoded string and the property list
840 containing export options. A function associated to `template'
842 A function associated to `inner-template' is always applied.
844 The latter, when defined, is to be called on every text not
845 recognized as an element or an object. It must accept two
846 arguments: the text string and the information channel. It is an
847 appropriate place to protect special chars relative to the
848 back-end.
850 BODY can start with pre-defined keyword arguments. The following
851 keywords are understood:
853 :export-block
855 String, or list of strings, representing block names that
856 will not be parsed. This is used to specify blocks that will
857 contain raw code specific to the back-end. These blocks
858 still have to be handled by the relative `export-block' type
859 translator.
861 :filters-alist
863 Alist between filters and function, or list of functions,
864 specific to the back-end. See `org-export-filters-alist' for
865 a list of all allowed filters. Filters defined here
866 shouldn't make a back-end test, as it may prevent back-ends
867 derived from this one to behave properly.
869 :menu-entry
871 Menu entry for the export dispatcher. It should be a list
872 like:
874 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
876 where :
878 KEY is a free character selecting the back-end.
880 DESCRIPTION-OR-ORDINAL is either a string or a number.
882 If it is a string, is will be used to name the back-end in
883 its menu entry. If it is a number, the following menu will
884 be displayed as a sub-menu of the back-end with the same
885 KEY. Also, the number will be used to determine in which
886 order such sub-menus will appear (lowest first).
888 ACTION-OR-MENU is either a function or an alist.
890 If it is an action, it will be called with four
891 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
892 BODY-ONLY. See `org-export-as' for further explanations on
893 some of them.
895 If it is an alist, associations should follow the
896 pattern:
898 \(KEY DESCRIPTION ACTION)
900 where KEY, DESCRIPTION and ACTION are described above.
902 Valid values include:
906 or
911 \(lambda (a s v b)
912 \(if a (org-latex-export-to-pdf t s v b)
913 \(org-open-file
914 \(org-latex-export-to-pdf nil s v b)))))))
916 or the following, which will be added to the previous
917 sub-menu,
919 \(?l 1
923 :options-alist
925 Alist between back-end specific properties introduced in
926 communication channel and how their value are acquired. See
927 `org-export-options-alist' for more information about
928 structure of the values."
947 ;; Register back-end.
951 ;; Tell parser to not parse EXPORT-BLOCK blocks.
958 ;; Splice in the body, if any.
962 "Create a new back-end as a variant of an existing one.
964 CHILD is the name of the derived back-end. PARENT is the name of
965 the parent back-end.
967 BODY can start with pre-defined keyword arguments. The following
968 keywords are understood:
970 :export-block
972 String, or list of strings, representing block names that
973 will not be parsed. This is used to specify blocks that will
974 contain raw code specific to the back-end. These blocks
975 still have to be handled by the relative `export-block' type
976 translator.
978 :filters-alist
980 Alist of filters that will overwrite or complete filters
981 defined in PARENT back-end. See `org-export-filters-alist'
982 for a list of allowed filters.
984 :menu-entry
986 Menu entry for the export dispatcher. See
987 `org-export-define-backend' for more information about the
988 expected value.
990 :options-alist
992 Alist of back-end specific properties that will overwrite or
993 complete those defined in PARENT back-end. Refer to
994 `org-export-options-alist' for more information about
995 structure of the values.
997 :translate-alist
999 Alist of element and object types and transcoders that will
1000 overwrite or complete transcode table from PARENT back-end.
1001 Refer to `org-export-define-backend' for detailed information
1002 about transcoders.
1005 as a variant of `latex' back-end with a custom template function:
1007 \(org-export-define-derived-backend my-latex latex
1008 :translate-alist ((template . my-latex-template-fun)))
1010 The back-end could then be called with, for example:
1038 ;; Register back-end.
1042 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1049 ;; Splice in the body, if any.
1053 "Return back-end from which BACKEND is derived, or nil."
1057 "Return filters for BACKEND."
1062 "Return menu entry for BACKEND."
1067 "Return export options for BACKEND."
1072 "Return translate table for BACKEND."
1077 "Signal an error if BACKEND isn't defined."
1082 "Non-nil if BACKEND is derived from one of BACKENDS."
1086 parent))
1089 \f
1090 ;;; The Communication Channel
1091 ;;
1092 ;; During export process, every function has access to a number of
1093 ;; properties. They are of two types:
1094 ;;
1095 ;; 1. Environment options are collected once at the very beginning of
1096 ;; the process, out of the original buffer and configuration.
1097 ;; Collecting them is handled by `org-export-get-environment'
1098 ;; function.
1099 ;;
1100 ;; Most environment options are defined through the
1101 ;; `org-export-options-alist' variable.
1102 ;;
1103 ;; 2. Tree properties are extracted directly from the parsed tree,
1104 ;; just before export, by `org-export-collect-tree-properties'.
1105 ;;
1106 ;; Here is the full list of properties available during transcode
1107 ;; process, with their category and their value type.
1108 ;;
1109 ;; + `:author' :: Author's name.
1110 ;; - category :: option
1111 ;; - type :: string
1112 ;;
1113 ;; + `:back-end' :: Current back-end used for transcoding.
1114 ;; - category :: tree
1115 ;; - type :: symbol
1116 ;;
1117 ;; + `:creator' :: String to write as creation information.
1118 ;; - category :: option
1119 ;; - type :: string
1120 ;;
1121 ;; + `:date' :: String to use as date.
1122 ;; - category :: option
1123 ;; - type :: string
1124 ;;
1125 ;; + `:description' :: Description text for the current data.
1126 ;; - category :: option
1127 ;; - type :: string
1128 ;;
1129 ;; + `:email' :: Author's email.
1130 ;; - category :: option
1131 ;; - type :: string
1132 ;;
1133 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1134 ;; process.
1135 ;; - category :: option
1136 ;; - type :: list of strings
1137 ;;
1138 ;; + `:exported-data' :: Hash table used for memoizing
1139 ;; `org-export-data'.
1140 ;; - category :: tree
1141 ;; - type :: hash table
1142 ;;
1143 ;; + `:filetags' :: List of global tags for buffer. Used by
1144 ;; `org-export-get-tags' to get tags with inheritance.
1145 ;; - category :: option
1146 ;; - type :: list of strings
1147 ;;
1148 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1149 ;; their definition, as parsed data. Only non-inlined footnotes
1150 ;; are represented in this alist. Also, every definition isn't
1151 ;; guaranteed to be referenced in the parse tree. The purpose of
1152 ;; this property is to preserve definitions from oblivion
1153 ;; (i.e. when the parse tree comes from a part of the original
1154 ;; buffer), it isn't meant for direct use in a back-end. To
1155 ;; retrieve a definition relative to a reference, use
1156 ;; `org-export-get-footnote-definition' instead.
1157 ;; - category :: option
1158 ;; - type :: alist (STRING . LIST)
1159 ;;
1160 ;; + `:headline-levels' :: Maximum level being exported as an
1161 ;; headline. Comparison is done with the relative level of
1162 ;; headlines in the parse tree, not necessarily with their
1163 ;; actual level.
1164 ;; - category :: option
1165 ;; - type :: integer
1166 ;;
1167 ;; + `:headline-offset' :: Difference between relative and real level
1168 ;; of headlines in the parse tree. For example, a value of -1
1169 ;; means a level 2 headline should be considered as level
1170 ;; 1 (cf. `org-export-get-relative-level').
1171 ;; - category :: tree
1172 ;; - type :: integer
1173 ;;
1174 ;; + `:headline-numbering' :: Alist between headlines and their
1175 ;; numbering, as a list of numbers
1176 ;; (cf. `org-export-get-headline-number').
1177 ;; - category :: tree
1178 ;; - type :: alist (INTEGER . LIST)
1179 ;;
1180 ;; + `:id-alist' :: Alist between ID strings and destination file's
1181 ;; path, relative to current directory. It is used by
1182 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1183 ;; external file.
1184 ;; - category :: option
1185 ;; - type :: alist (STRING . STRING)
1186 ;;
1187 ;; + `:ignore-list' :: List of elements and objects that should be
1188 ;; ignored during export.
1189 ;; - category :: tree
1190 ;; - type :: list of elements and objects
1191 ;;
1192 ;; + `:input-file' :: Full path to input file, if any.
1193 ;; - category :: option
1194 ;; - type :: string or nil
1195 ;;
1196 ;; + `:keywords' :: List of keywords attached to data.
1197 ;; - category :: option
1198 ;; - type :: string
1199 ;;
1200 ;; + `:language' :: Default language used for translations.
1201 ;; - category :: option
1202 ;; - type :: string
1203 ;;
1204 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1205 ;; transcoding.
1206 ;; - category :: option
1207 ;; - type :: list (as returned by `org-element-parse-buffer')
1208 ;;
1209 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1210 ;; all line breaks.
1211 ;; - category :: option
1212 ;; - type :: symbol (nil, t)
1213 ;;
1214 ;; + `:section-numbers' :: Non-nil means transcoding should add
1215 ;; section numbers to headlines.
1216 ;; - category :: option
1217 ;; - type :: symbol (nil, t)
1218 ;;
1219 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1220 ;; in transcoding. When such a tag is present, subtrees without
1221 ;; it are de facto excluded from the process. See
1222 ;; `use-select-tags'.
1223 ;; - category :: option
1224 ;; - type :: list of strings
1225 ;;
1226 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1227 ;; a time stamp in the output.
1228 ;; - category :: option
1229 ;; - type :: symbol (nil, t)
1230 ;;
1231 ;; + `:translate-alist' :: Alist between element and object types and
1232 ;; transcoding functions relative to the current back-end.
1233 ;; Special keys `inner-template', `template' and `plain-text' are
1234 ;; also possible.
1235 ;; - category :: option
1236 ;; - type :: alist (SYMBOL . FUNCTION)
1237 ;;
1238 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1239 ;; also be transcoded. If it is set to the `headline' symbol,
1240 ;; only the archived headline's name is retained.
1241 ;; - category :: option
1242 ;; - type :: symbol (nil, t, `headline')
1243 ;;
1244 ;; + `:with-author' :: Non-nil means author's name should be included
1245 ;; in the output.
1246 ;; - category :: option
1247 ;; - type :: symbol (nil, t)
1248 ;;
1249 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1250 ;; - category :: option
1251 ;; - type :: symbol (nil, t)
1252 ;;
1253 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1254 ;; inserted at the end of the transcoded string. If the value
1255 ;; is `comment', it should be commented.
1256 ;; - category :: option
1257 ;; - type :: symbol (`comment', nil, t)
1258 ;;
1259 ;; + `:with-date' :: Non-nil means output should contain a date.
1260 ;; - category :: option
1261 ;; - type :. symbol (nil, t)
1262 ;;
1263 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1264 ;; its value is a list of names, only drawers with such names
1265 ;; will be transcoded. If that list starts with `not', drawer
1266 ;; with these names will be skipped.
1267 ;; - category :: option
1268 ;; - type :: symbol (nil, t) or list of strings
1269 ;;
1270 ;; + `:with-email' :: Non-nil means output should contain author's
1271 ;; email.
1272 ;; - category :: option
1273 ;; - type :: symbol (nil, t)
1274 ;;
1275 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1276 ;; interpreted.
1277 ;; - category :: option
1278 ;; - type :: symbol (nil, t)
1279 ;;
1280 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1281 ;; strings starting with a colon as a fixed-with (verbatim) area.
1282 ;; - category :: option
1283 ;; - type :: symbol (nil, t)
1284 ;;
1285 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1286 ;; footnotes.
1287 ;; - category :: option
1288 ;; - type :: symbol (nil, t)
1289 ;;
1290 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1291 ;; `latex-fragment' objects should appear in export output. When
1292 ;; this property is set to `verbatim', they will be left as-is.
1293 ;; - category :: option
1294 ;; - type :: symbol (`verbatim', nil, t)
1295 ;;
1296 ;; + `:with-plannings' :: Non-nil means transcoding should include
1297 ;; planning info.
1298 ;; - category :: option
1299 ;; - type :: symbol (nil, t)
1300 ;;
1301 ;; + `:with-priority' :: Non-nil means transcoding should include
1302 ;; priority cookies.
1303 ;; - category :: option
1304 ;; - type :: symbol (nil, t)
1305 ;;
1306 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1307 ;; plain text.
1308 ;; - category :: option
1309 ;; - type :: symbol (nil, t)
1310 ;;
1311 ;; + `:with-special-strings' :: Non-nil means transcoding should
1312 ;; interpret special strings in plain text.
1313 ;; - category :: option
1314 ;; - type :: symbol (nil, t)
1315 ;;
1316 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1317 ;; interpret subscript and superscript. With a value of "{}",
1318 ;; only interpret those using curly brackets.
1319 ;; - category :: option
1320 ;; - type :: symbol (nil, {}, t)
1321 ;;
1322 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1323 ;; tables.
1324 ;; - category :: option
1325 ;; - type :: symbol (nil, t)
1326 ;;
1327 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1328 ;; headlines. A `not-in-toc' value will remove them from the
1329 ;; table of contents, if any, nonetheless.
1330 ;; - category :: option
1331 ;; - type :: symbol (nil, t, `not-in-toc')
1332 ;;
1333 ;; + `:with-tasks' :: Non-nil means transcoding should include
1334 ;; headlines with a TODO keyword. A `todo' value will only
1335 ;; include headlines with a todo type keyword while a `done'
1336 ;; value will do the contrary. If a list of strings is provided,
1337 ;; only tasks with keywords belonging to that list will be kept.
1338 ;; - category :: option
1339 ;; - type :: symbol (t, todo, done, nil) or list of strings
1340 ;;
1341 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1342 ;; time stamps. Special value `active' (resp. `inactive') ask to
1343 ;; export only active (resp. inactive) timestamps. Otherwise,
1344 ;; completely remove them.
1345 ;; - category :: option
1346 ;; - type :: symbol: (`active', `inactive', t, nil)
1347 ;;
1348 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1349 ;; added to the output. An integer value limits its depth.
1350 ;; - category :: option
1351 ;; - type :: symbol (nil, t or integer)
1352 ;;
1353 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1354 ;; include TODO keywords.
1355 ;; - category :: option
1356 ;; - type :: symbol (nil, t)
1359 ;;;; Environment Options
1360 ;;
1361 ;; Environment options encompass all parameters defined outside the
1362 ;; scope of the parsed data. They come from five sources, in
1363 ;; increasing precedence order:
1364 ;;
1365 ;; - Global variables,
1366 ;; - Buffer's attributes,
1367 ;; - Options keyword symbols,
1368 ;; - Buffer keywords,
1369 ;; - Subtree properties.
1370 ;;
1371 ;; The central internal function with regards to environment options
1372 ;; is `org-export-get-environment'. It updates global variables with
1373 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1374 ;; the different sources.
1375 ;;
1376 ;; The internal functions doing the retrieval are:
1377 ;; `org-export--get-global-options',
1378 ;; `org-export--get-buffer-attributes',
1379 ;; `org-export--parse-option-keyword',
1380 ;; `org-export--get-subtree-options' and
1381 ;; `org-export--get-inbuffer-options'
1382 ;;
1383 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1384 ;; relative to "#+BIND:" keywords.
1387 "Collect export options from the current buffer.
1389 Optional argument BACKEND is a symbol specifying which back-end
1390 specific options to read, if any.
1392 When optional argument SUBTREEP is non-nil, assume the export is
1393 done against the current sub-tree.
1395 Third optional argument EXT-PLIST is a property list with
1396 external parameters overriding Org default settings, but still
1397 inferior to file-local settings."
1398 ;; First install #+BIND variables.
1400 ;; Get and prioritize export options...
1402 ;; ... from global variables...
1404 ;; ... from an external property list...
1405 ext-plist
1406 ;; ... from in-buffer settings...
1408 ;; ... and from subtree, when appropriate.
1410 ;; Eventually add misc. properties.
1412 :back-end
1413 backend
1414 :translate-alist
1416 :footnote-definition-alist
1417 ;; Footnotes definitions must be collected in the original
1418 ;; buffer, as there's no insurance that they will still be in
1419 ;; the parse tree, due to possible narrowing.
1433 alist))))
1434 alist))
1435 :id-alist
1436 ;; Collect id references.
1447 alist))))
1450 "Parse an OPTIONS line and return values as a plist.
1451 Optional argument BACKEND is a symbol specifying which back-end
1452 specific items to read, if any."
1454 ;; Priority is given to back-end specific options.
1456 org-export-options-alist))
1457 plist)
1466 options))
1468 property
1471 plist))
1474 "Get export options in subtree at point.
1475 Optional argument BACKEND is a symbol specifying back-end used
1476 for export. Return options as a plist."
1477 ;; For each buffer keyword, create a headline property setting the
1478 ;; same property in communication channel. The name for the property
1479 ;; is the keyword with "EXPORT_" appended to it.
1482 ;; Make sure point is at an heading.
1484 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1485 ;; title as its fallback value.
1491 plist :title
1494 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1498 ;; Handle other keywords. TITLE keyword is excluded as it has
1499 ;; been handled already.
1507 ;; Export properties are not case-sensitive.
1514 plist
1515 property
1517 ;; Parse VALUE if required.
1521 ;; If BEHAVIOUR is `split' expected value is
1522 ;; a list of strings, not a string.
1525 ;; Look for both general keywords and back-end specific
1526 ;; options, with priority given to the latter.
1528 org-export-options-alist)))
1529 ;; Return value.
1530 plist)))
1533 "Return current buffer export options, as a plist.
1535 Optional argument BACKEND, when non-nil, is a symbol specifying
1536 which back-end specific options should also be read in the
1537 process.
1539 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1541 get-options ; For byte-compiler.
1544 ;; Priority is given to back-end specific options.
1546 org-export-options-alist))
1549 org-export-special-keywords))))
1552 ;; Return property name associated to KEYWORD.
1557 options))))
1560 ;; Recursively read keywords in buffer. FILES is a list
1561 ;; of files read so far. PLIST is the current property
1562 ;; list obtained.
1571 ;; Options in `org-export-special-keywords'.
1575 ;; Avoid circular dependencies.
1585 plist
1590 plist
1596 ;; Options in `org-export-options-alist'.
1601 plist prop
1602 ;; Handle value depending on specified
1603 ;; BEHAVIOUR.
1609 " "
1621 ;; Return final value.
1622 plist))))
1623 ;; Read options in the current buffer.
1625 ;; Parse keywords specified in `org-element-document-properties'.
1627 ;; Find the property associated to the keyword.
1635 org-element-document-properties)
1636 ;; Return value.
1637 plist))
1640 "Return properties related to buffer attributes, as a plist."
1643 ;; Store full path of input file name, or nil. For internal use.
1644 :input-file visited-file
1651 "Return global export options as a plist.
1653 Optional argument BACKEND, if non-nil, is a symbol specifying
1654 which back-end specific export options should also be read in the
1655 process."
1657 ;; Priority is given to back-end specific options.
1659 org-export-options-alist))
1660 plist)
1667 plist
1668 prop
1669 ;; Eval default value provided. If keyword is a member
1670 ;; of `org-element-document-properties', parse it as
1671 ;; a secondary string before storing it.
1676 value
1679 all)
1680 ;; Return value.
1681 plist))
1684 "Install the values from #+BIND lines as local variables.
1685 Variables must be installed before in-buffer options are
1686 retrieved."
1701 ;;;; Tree Properties
1702 ;;
1703 ;; Tree properties are information extracted from parse tree. They
1704 ;; are initialized at the beginning of the transcoding process by
1705 ;; `org-export-collect-tree-properties'.
1706 ;;
1707 ;; Dedicated functions focus on computing the value of specific tree
1708 ;; properties during initialization. Thus,
1709 ;; `org-export--populate-ignore-list' lists elements and objects that
1710 ;; should be skipped during export, `org-export--get-min-level' gets
1711 ;; the minimal exportable level, used as a basis to compute relative
1712 ;; level for headlines. Eventually
1713 ;; `org-export--collect-headline-numbering' builds an alist between
1714 ;; headlines and their numbering.
1717 "Extract tree properties from parse tree.
1719 DATA is the parse tree from which information is retrieved. INFO
1720 is a list holding export options.
1722 Following tree properties are set or updated:
1724 `:exported-data' Hash table used to memoize results from
1725 `org-export-data'.
1727 `:footnote-definition-alist' List of footnotes definitions in
1728 original buffer and current parse tree.
1730 `:headline-offset' Offset between true level of headlines and
1731 local level. An offset of -1 means a headline
1732 of level 2 should be considered as a level
1733 1 headline in the context.
1735 `:headline-numbering' Alist of all headlines as key an the
1736 associated numbering as value.
1738 `:ignore-list' List of elements that should be ignored during
1739 export.
1741 Return updated plist."
1742 ;; Install the parse tree in the communication channel, in order to
1743 ;; use `org-export-get-genealogy' and al.
1745 ;; Get the list of elements and objects to ignore, and put it into
1746 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1747 ;; been done during parse tree filtering.
1750 :ignore-list
1753 ;; Compute `:headline-offset' in order to be able to use
1754 ;; `org-export-get-relative-level'.
1757 :headline-offset
1759 ;; Update footnotes definitions list with definitions in parse tree.
1760 ;; This is required since buffer expansion might have modified
1761 ;; boundaries of footnote definitions contained in the parse tree.
1762 ;; This way, definitions in `footnote-definition-alist' are bound to
1763 ;; match those in the parse tree.
1769 defs)))
1771 ;; Properties order doesn't matter: get the rest of the tree
1772 ;; properties.
1776 info))
1779 "Return minimum exportable headline's level in DATA.
1780 DATA is parsed tree as returned by `org-element-parse-buffer'.
1781 OPTIONS is a plist holding export options."
1792 ;; If no headline was found, for the sake of consistency, set
1793 ;; minimum level to 1 nonetheless.
1797 "Return numbering of all exportable headlines in a parse tree.
1799 DATA is the parse tree. OPTIONS is the plist holding export
1800 options.
1802 Return an alist whose key is a headline and value is its
1803 associated numbering \(in the shape of a list of numbers\) or nil
1804 for a footnotes section."
1812 headline
1814 for idx from 0 to org-export-max-depth
1818 options)))
1821 "Return list of elements and objects to ignore during export.
1822 DATA is the parse tree to traverse. OPTIONS is the plist holding
1823 export options."
1825 walk-data
1826 ;; First find trees containing a select tag, if any.
1830 ;; Collect ignored elements or objects into IGNORE-LIST.
1836 ;; If headline is archived but tree below has
1837 ;; to be skipped, add it to ignore list.
1840 ;; Move into secondary string, if any.
1845 ;; Move into recursive objects/elements.
1847 ;; Main call.
1849 ;; Return value.
1850 ignore))
1853 "Return list of headlines containing a select tag in their tree.
1854 DATA is parsed data as returned by `org-element-parse-buffer'.
1855 INFO is a plist holding export options."
1857 walk-data ; for byte-compiler.
1868 ;; When a select tag is found, mark full
1869 ;; genealogy and every headline within the tree
1870 ;; as acceptable.
1873 genealogy
1875 selected-trees))
1876 ;; Else, continue searching in tree, recursively.
1883 "Non-nil when element or object BLOB should be skipped during export.
1884 OPTIONS is the plist holding export options. SELECTED, when
1885 non-nil, is a list of headlines belonging to a tree with a select
1886 tag."
1893 ;; If `:with-drawers' value starts with `not', ignore
1894 ;; every drawer whose name belong to that list.
1895 ;; Otherwise, ignore drawers whose name isn't in that
1896 ;; list.
1908 ;; Ignore subtrees with an exclude tag.
1911 ;; When a select tag is present in the buffer, ignore any tree
1912 ;; without it.
1914 ;; Ignore commented sub-trees.
1916 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1918 ;; Ignore tasks, if specified by `:with-tasks' property.
1935 ;; No timestamp allowed.
1937 ;; Only active timestamps allowed and the current one isn't
1938 ;; active.
1942 ;; Only inactive timestamps allowed and the current one isn't
1943 ;; inactive.
1949 \f
1950 ;;; The Transcoder
1951 ;;
1952 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1953 ;; `org-element-parse-buffer') and transcodes it into a specified
1954 ;; back-end output. It takes care of filtering out elements or
1955 ;; objects according to export options and organizing the output blank
1956 ;; lines and white space are preserved. The function memoizes its
1957 ;; results, so it is cheap to call it within translators.
1958 ;;
1959 ;; It is possible to modify locally the back-end used by
1960 ;; `org-export-data' or even use a temporary back-end by using
1961 ;; `org-export-data-with-translations' and
1962 ;; `org-export-data-with-backend'.
1963 ;;
1964 ;; Internally, three functions handle the filtering of objects and
1965 ;; elements during the export. In particular,
1966 ;; `org-export-ignore-element' marks an element or object so future
1967 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1968 ;; elements or objects should be seen as real Org syntax and
1969 ;; `org-export-expand' transforms the others back into their original
1970 ;; shape
1971 ;;
1972 ;; `org-export-transcoder' is an accessor returning appropriate
1973 ;; translator function for a given element or object.
1976 "Return appropriate transcoder for BLOB.
1977 INFO is a plist containing export directives."
1979 ;; Return contents only for complete parse trees.
1985 "Convert DATA into current back-end format.
1987 DATA is a parse tree, an element or an object or a secondary
1988 string. INFO is a plist holding export options.
1990 Return transcoded string."
1996 ;; Ignored element/object.
1998 ;; Plain text.
2004 info))
2005 ;; Uninterpreted element/object: change it back to Org
2006 ;; syntax and export again resulting raw string.
2010 data
2014 info))
2015 ;; Secondary string.
2018 ;; Element/Object without contents or, as a special case,
2019 ;; headline with archive tag and archived trees restricted
2020 ;; to title only.
2028 ;; Element/Object with contents.
2041 ;; Elements directly containing objects
2042 ;; must have their indentation normalized
2043 ;; first.
2045 data
2046 ;; When normalizing contents of the first
2047 ;; paragraph in an item or a footnote
2048 ;; definition, ignore first line's
2049 ;; indentation: there is none and it
2050 ;; might be misleading.
2055 data)
2062 info))))))))
2063 ;; Final result will be memoized before being returned.
2065 data
2069 ;; Append the same white space between elements or objects as in
2070 ;; the original buffer, and call appropriate filters.
2081 info)))
2082 results)))
2086 "Convert DATA into another format using a given translation table.
2087 DATA is an element, an object, a secondary string or a string.
2088 TRANSLATIONS is an alist between element or object types and
2089 a functions handling them. See `org-export-define-backend' for
2090 more information. INFO is a plist used as a communication
2091 channel."
2093 data
2094 ;; Set-up a new communication channel with TRANSLATIONS as the
2095 ;; translate table and a new hash table for memoization.
2097 info
2099 ;; Size of the hash table is reduced since this function
2100 ;; will probably be used on short trees.
2104 "Convert DATA into BACKEND format.
2106 DATA is an element, an object, a secondary string or a string.
2107 BACKEND is a symbol. INFO is a plist used as a communication
2108 channel.
2110 Unlike to `org-export-with-backend', this function will
2111 recursively convert DATA using BACKEND translation table."
2117 "Non-nil if element or object BLOB should be interpreted during export.
2118 If nil, BLOB will appear as raw Org syntax. Check is done
2119 according to export options INFO, stored as a plist."
2121 ;; ... entities...
2123 ;; ... emphasis...
2126 ;; ... fixed-width areas.
2128 ;; ... footnotes...
2131 ;; ... LaTeX environments and fragments...
2135 ;; ... sub/superscripts...
2141 ;; ... tables...
2146 "Expand a parsed element or object to its original state.
2147 BLOB is either an element or an object. CONTENTS is its
2148 contents, as a string or nil."
2151 blob contents))
2154 "Add ELEMENT to `:ignore-list' in INFO.
2156 Any element in `:ignore-list' will be skipped when using
2157 `org-element-map'. INFO is modified by side effects."
2161 \f
2162 ;;; The Filter System
2163 ;;
2164 ;; Filters allow end-users to tweak easily the transcoded output.
2165 ;; They are the functional counterpart of hooks, as every filter in
2166 ;; a set is applied to the return value of the previous one.
2167 ;;
2168 ;; Every set is back-end agnostic. Although, a filter is always
2169 ;; called, in addition to the string it applies to, with the back-end
2170 ;; used as argument, so it's easy for the end-user to add back-end
2171 ;; specific filters in the set. The communication channel, as
2172 ;; a plist, is required as the third argument.
2173 ;;
2174 ;; From the developer side, filters sets can be installed in the
2175 ;; process with the help of `org-export-define-backend', which
2176 ;; internally stores filters as an alist. Each association has a key
2177 ;; among the following symbols and a function or a list of functions
2178 ;; as value.
2179 ;;
2180 ;; - `:filter-options' applies to the property list containing export
2181 ;; options. Unlike to other filters, functions in this list accept
2182 ;; two arguments instead of three: the property list containing
2183 ;; export options and the back-end. Users can set its value through
2184 ;; `org-export-filter-options-functions' variable.
2185 ;;
2186 ;; - `:filter-parse-tree' applies directly to the complete parsed
2187 ;; tree. Users can set it through
2188 ;; `org-export-filter-parse-tree-functions' variable.
2189 ;;
2190 ;; - `:filter-final-output' applies to the final transcoded string.
2191 ;; Users can set it with `org-export-filter-final-output-functions'
2192 ;; variable
2193 ;;
2194 ;; - `:filter-plain-text' applies to any string not recognized as Org
2195 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2196 ;; configure it.
2197 ;;
2198 ;; - `:filter-TYPE' applies on the string returned after an element or
2199 ;; object of type TYPE has been transcoded. An user can modify
2200 ;; `org-export-filter-TYPE-functions'
2201 ;;
2202 ;; All filters sets are applied with
2203 ;; `org-export-filter-apply-functions' function. Filters in a set are
2204 ;; applied in a LIFO fashion. It allows developers to be sure that
2205 ;; their filters will be applied first.
2206 ;;
2207 ;; Filters properties are installed in communication channel with
2208 ;; `org-export-install-filters' function.
2209 ;;
2210 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2211 ;; `org-export-before-parsing-hook') are run at the beginning of the
2212 ;; export process and just before parsing to allow for heavy structure
2213 ;; modifications.
2216 ;;;; Hooks
2219 "Hook run at the beginning of the export process.
2221 This is run before include keywords and macros are expanded and
2222 Babel code blocks executed, on a copy of the original buffer
2223 being exported. Visibility and narrowing are preserved. Point
2224 is at the beginning of the buffer.
2226 Every function in this hook will be called with one argument: the
2230 "Hook run before parsing an export buffer.
2232 This is run after include keywords and macros have been expanded
2233 and Babel code blocks executed, on a copy of the original buffer
2234 being exported. Visibility and narrowing are preserved. Point
2235 is at the beginning of the buffer.
2237 Every function in this hook will be called with one argument: the
2241 ;;;; Special Filters
2244 "List of functions applied to the export options.
2245 Each filter is called with two arguments: the export options, as
2246 a plist, and the back-end, as a symbol. It must return
2250 "List of functions applied to the parsed tree.
2251 Each filter is called with three arguments: the parse tree, as
2252 returned by `org-element-parse-buffer', the back-end, as
2253 a symbol, and the communication channel, as a plist. It must
2257 "List of functions applied to plain text.
2258 Each filter is called with three arguments: a string which
2259 contains no Org syntax, the back-end, as a symbol, and the
2260 communication channel, as a plist. It must return a string or
2264 "List of functions applied to the transcoded string.
2265 Each filter is called with three arguments: the full transcoded
2266 string, the back-end, as a symbol, and the communication channel,
2267 as a plist. It must return a string that will be used as the
2271 ;;;; Elements Filters
2274 "List of functions applied to a transcoded babel-call.
2275 Each filter is called with three arguments: the transcoded data,
2276 as a string, the back-end, as a symbol, and the communication
2280 "List of functions applied to a transcoded center block.
2281 Each filter is called with three arguments: the transcoded data,
2282 as a string, the back-end, as a symbol, and the communication
2286 "List of functions applied to a transcoded clock.
2287 Each filter is called with three arguments: the transcoded data,
2288 as a string, the back-end, as a symbol, and the communication
2292 "List of functions applied to a transcoded comment.
2293 Each filter is called with three arguments: the transcoded data,
2294 as a string, the back-end, as a symbol, and the communication
2298 "List of functions applied to a transcoded comment-block.
2299 Each filter is called with three arguments: the transcoded data,
2300 as a string, the back-end, as a symbol, and the communication
2304 "List of functions applied to a transcoded diary-sexp.
2305 Each filter is called with three arguments: the transcoded data,
2306 as a string, the back-end, as a symbol, and the communication
2310 "List of functions applied to a transcoded drawer.
2311 Each filter is called with three arguments: the transcoded data,
2312 as a string, the back-end, as a symbol, and the communication
2316 "List of functions applied to a transcoded dynamic-block.
2317 Each filter is called with three arguments: the transcoded data,
2318 as a string, the back-end, as a symbol, and the communication
2322 "List of functions applied to a transcoded example-block.
2323 Each filter is called with three arguments: the transcoded data,
2324 as a string, the back-end, as a symbol, and the communication
2328 "List of functions applied to a transcoded export-block.
2329 Each filter is called with three arguments: the transcoded data,
2330 as a string, the back-end, as a symbol, and the communication
2334 "List of functions applied to a transcoded fixed-width.
2335 Each filter is called with three arguments: the transcoded data,
2336 as a string, the back-end, as a symbol, and the communication
2340 "List of functions applied to a transcoded footnote-definition.
2341 Each filter is called with three arguments: the transcoded data,
2342 as a string, the back-end, as a symbol, and the communication
2346 "List of functions applied to a transcoded headline.
2347 Each filter is called with three arguments: the transcoded data,
2348 as a string, the back-end, as a symbol, and the communication
2352 "List of functions applied to a transcoded horizontal-rule.
2353 Each filter is called with three arguments: the transcoded data,
2354 as a string, the back-end, as a symbol, and the communication
2358 "List of functions applied to a transcoded inlinetask.
2359 Each filter is called with three arguments: the transcoded data,
2360 as a string, the back-end, as a symbol, and the communication
2364 "List of functions applied to a transcoded item.
2365 Each filter is called with three arguments: the transcoded data,
2366 as a string, the back-end, as a symbol, and the communication
2370 "List of functions applied to a transcoded keyword.
2371 Each filter is called with three arguments: the transcoded data,
2372 as a string, the back-end, as a symbol, and the communication
2376 "List of functions applied to a transcoded latex-environment.
2377 Each filter is called with three arguments: the transcoded data,
2378 as a string, the back-end, as a symbol, and the communication
2382 "List of functions applied to a transcoded node-property.
2383 Each filter is called with three arguments: the transcoded data,
2384 as a string, the back-end, as a symbol, and the communication
2388 "List of functions applied to a transcoded paragraph.
2389 Each filter is called with three arguments: the transcoded data,
2390 as a string, the back-end, as a symbol, and the communication
2394 "List of functions applied to a transcoded plain-list.
2395 Each filter is called with three arguments: the transcoded data,
2396 as a string, the back-end, as a symbol, and the communication
2400 "List of functions applied to a transcoded planning.
2401 Each filter is called with three arguments: the transcoded data,
2402 as a string, the back-end, as a symbol, and the communication
2406 "List of functions applied to a transcoded property-drawer.
2407 Each filter is called with three arguments: the transcoded data,
2408 as a string, the back-end, as a symbol, and the communication
2412 "List of functions applied to a transcoded quote block.
2413 Each filter is called with three arguments: the transcoded quote
2414 data, as a string, the back-end, as a symbol, and the
2415 communication channel, as a plist. It must return a string or
2419 "List of functions applied to a transcoded quote-section.
2420 Each filter is called with three arguments: the transcoded data,
2421 as a string, the back-end, as a symbol, and the communication
2425 "List of functions applied to a transcoded section.
2426 Each filter is called with three arguments: the transcoded data,
2427 as a string, the back-end, as a symbol, and the communication
2431 "List of functions applied to a transcoded special block.
2432 Each filter is called with three arguments: the transcoded data,
2433 as a string, the back-end, as a symbol, and the communication
2437 "List of functions applied to a transcoded src-block.
2438 Each filter is called with three arguments: the transcoded data,
2439 as a string, the back-end, as a symbol, and the communication
2443 "List of functions applied to a transcoded table.
2444 Each filter is called with three arguments: the transcoded data,
2445 as a string, the back-end, as a symbol, and the communication
2449 "List of functions applied to a transcoded table-cell.
2450 Each filter is called with three arguments: the transcoded data,
2451 as a string, the back-end, as a symbol, and the communication
2455 "List of functions applied to a transcoded table-row.
2456 Each filter is called with three arguments: the transcoded data,
2457 as a string, the back-end, as a symbol, and the communication
2461 "List of functions applied to a transcoded verse block.
2462 Each filter is called with three arguments: the transcoded data,
2463 as a string, the back-end, as a symbol, and the communication
2467 ;;;; Objects Filters
2470 "List of functions applied to transcoded bold text.
2471 Each filter is called with three arguments: the transcoded data,
2472 as a string, the back-end, as a symbol, and the communication
2476 "List of functions applied to transcoded code text.
2477 Each filter is called with three arguments: the transcoded data,
2478 as a string, the back-end, as a symbol, and the communication
2482 "List of functions applied to a transcoded entity.
2483 Each filter is called with three arguments: the transcoded data,
2484 as a string, the back-end, as a symbol, and the communication
2488 "List of functions applied to a transcoded export-snippet.
2489 Each filter is called with three arguments: the transcoded data,
2490 as a string, the back-end, as a symbol, and the communication
2494 "List of functions applied to a transcoded footnote-reference.
2495 Each filter is called with three arguments: the transcoded data,
2496 as a string, the back-end, as a symbol, and the communication
2500 "List of functions applied to a transcoded inline-babel-call.
2501 Each filter is called with three arguments: the transcoded data,
2502 as a string, the back-end, as a symbol, and the communication
2506 "List of functions applied to a transcoded inline-src-block.
2507 Each filter is called with three arguments: the transcoded data,
2508 as a string, the back-end, as a symbol, and the communication
2512 "List of functions applied to transcoded italic text.
2513 Each filter is called with three arguments: the transcoded data,
2514 as a string, the back-end, as a symbol, and the communication
2518 "List of functions applied to a transcoded latex-fragment.
2519 Each filter is called with three arguments: the transcoded data,
2520 as a string, the back-end, as a symbol, and the communication
2524 "List of functions applied to a transcoded line-break.
2525 Each filter is called with three arguments: the transcoded data,
2526 as a string, the back-end, as a symbol, and the communication
2530 "List of functions applied to a transcoded link.
2531 Each filter is called with three arguments: the transcoded data,
2532 as a string, the back-end, as a symbol, and the communication
2536 "List of functions applied to a transcoded macro.
2537 Each filter is called with three arguments: the transcoded data,
2538 as a string, the back-end, as a symbol, and the communication
2542 "List of functions applied to a transcoded radio-target.
2543 Each filter is called with three arguments: the transcoded data,
2544 as a string, the back-end, as a symbol, and the communication
2548 "List of functions applied to a transcoded statistics-cookie.
2549 Each filter is called with three arguments: the transcoded data,
2550 as a string, the back-end, as a symbol, and the communication
2554 "List of functions applied to transcoded strike-through text.
2555 Each filter is called with three arguments: the transcoded data,
2556 as a string, the back-end, as a symbol, and the communication
2560 "List of functions applied to a transcoded subscript.
2561 Each filter is called with three arguments: the transcoded data,
2562 as a string, the back-end, as a symbol, and the communication
2566 "List of functions applied to a transcoded superscript.
2567 Each filter is called with three arguments: the transcoded data,
2568 as a string, the back-end, as a symbol, and the communication
2572 "List of functions applied to a transcoded target.
2573 Each filter is called with three arguments: the transcoded data,
2574 as a string, the back-end, as a symbol, and the communication
2578 "List of functions applied to a transcoded timestamp.
2579 Each filter is called with three arguments: the transcoded data,
2580 as a string, the back-end, as a symbol, and the communication
2584 "List of functions applied to transcoded underline text.
2585 Each filter is called with three arguments: the transcoded data,
2586 as a string, the back-end, as a symbol, and the communication
2590 "List of functions applied to transcoded verbatim text.
2591 Each filter is called with three arguments: the transcoded data,
2592 as a string, the back-end, as a symbol, and the communication
2596 ;;;; Filters Tools
2597 ;;
2598 ;; Internal function `org-export-install-filters' installs filters
2599 ;; hard-coded in back-ends (developer filters) and filters from global
2600 ;; variables (user filters) in the communication channel.
2601 ;;
2602 ;; Internal function `org-export-filter-apply-functions' takes care
2603 ;; about applying each filter in order to a given data. It ignores
2604 ;; filters returning a nil value but stops whenever a filter returns
2605 ;; an empty string.
2608 "Call every function in FILTERS.
2610 Functions are called with arguments VALUE, current export
2611 back-end and INFO. A function returning a nil value will be
2612 skipped. If it returns the empty string, the process ends and
2613 VALUE is ignored.
2615 Call is done in a LIFO fashion, to be sure that developer
2616 specified filters, if any, are called first."
2625 "Install filters properties in communication channel.
2626 INFO is a plist containing the current communication channel.
2627 Return the updated communication channel."
2629 ;; Install user-defined filters with `org-export-filters-alist'
2630 ;; and filters already in INFO (through ext-plist mechanism).
2637 ;; Filters in INFO will be called
2638 ;; before those user provided.
2641 default-value)))))
2642 org-export-filters-alist)
2643 ;; Prepend back-end specific filters to that list.
2645 ;; Single values get consed, lists are appended.
2650 plist key
2654 ;; Return new communication channel.
2658 \f
2659 ;;; Core functions
2660 ;;
2661 ;; This is the room for the main function, `org-export-as', along with
2662 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2663 ;; `org-export-string-as'. They differ either by the way they output
2664 ;; the resulting code (for the first two) or by the input type (for
2665 ;; the latter).
2666 ;;
2667 ;; `org-export-output-file-name' is an auxiliary function meant to be
2668 ;; used with `org-export-to-file'. With a given extension, it tries
2669 ;; to provide a canonical file name to write export output to.
2670 ;;
2671 ;; Note that `org-export-as' doesn't really parse the current buffer,
2672 ;; but a copy of it (with the same buffer-local variables and
2673 ;; visibility), where macros and include keywords are expanded and
2674 ;; Babel blocks are executed, if appropriate.
2675 ;; `org-export-with-buffer-copy' macro prepares that copy.
2676 ;;
2677 ;; File inclusion is taken care of by
2678 ;; `org-export-expand-include-keyword' and
2679 ;; `org-export--prepare-file-contents'. Structure wise, including
2680 ;; a whole Org file in a buffer often makes little sense. For
2681 ;; example, if the file contains a headline and the include keyword
2682 ;; was within an item, the item should contain the headline. That's
2683 ;; why file inclusion should be done before any structure can be
2684 ;; associated to the file, that is before parsing.
2687 "Return a copy of the current buffer.
2688 The copy preserves Org buffer-local variables, visibility and
2689 narrowing."
2695 new-buf))
2698 "Apply BODY in a copy of the current buffer.
2699 The copy preserves local variables, visibility and contents of
2700 the original buffer. Point is at the beginning of the buffer
2701 when BODY is applied."
2710 ;; Kill copy without confirmation.
2716 "Generate a function duplicating BUFFER.
2718 The copy will preserve local variables, visibility, contents and
2719 narrowing of the original buffer. If a region was active in
2720 BUFFER, contents will be narrowed to that region instead.
2722 The resulting function can be eval'ed at a later time, from
2723 another buffer, effectively cloning the original buffer there."
2727 ;; Buffer local variables.
2737 default-directory
2738 buffer-file-name
2739 buffer-file-coding-system
2740 outline-level
2741 outline-regexp
2742 buffer-invisibility-spec))
2745 ;; Skip unreadable values, as they cannot be
2746 ;; sent to external process.
2750 local-vars)))))
2752 local-vars)
2753 ;; Whole buffer contents.
2758 ;; Narrowing.
2762 ;; Current position of point.
2764 ;; Overlays with invisible property.
2774 ov-set))))
2776 ov-set)))))
2778 ;;;###autoload
2781 "Transcode current Org buffer into BACKEND code.
2783 If narrowing is active in the current buffer, only transcode its
2784 narrowed part.
2786 If a region is active, transcode that region.
2788 When optional argument SUBTREEP is non-nil, transcode the
2789 sub-tree at point, extracting information from the headline
2790 properties first.
2792 When optional argument VISIBLE-ONLY is non-nil, don't export
2793 contents of hidden elements.
2795 When optional argument BODY-ONLY is non-nil, only return body
2796 code, without surrounding template.
2798 Optional argument EXT-PLIST, when provided, is a property list
2799 with external parameters overriding Org default settings, but
2800 still inferior to file-local settings.
2802 Return code as a string."
2806 ;; Narrow buffer to an appropriate region or subtree for
2807 ;; parsing. If parsing subtree, be sure to remove main headline
2808 ;; too.
2816 ;; Initialize communication channel with original buffer
2817 ;; attributes, unavailable in its copy.
2819 ;; Update communication channel and get parse tree. Buffer
2820 ;; isn't parsed directly. Instead, a temporary copy is
2821 ;; created, where include keywords, macros are expanded and
2822 ;; code blocks are evaluated.
2824 ;; Run first hook with current back-end as argument.
2827 ;; Update macro templates since #+INCLUDE keywords might have
2828 ;; added some new ones.
2832 ;; Update radio targets since keyword inclusion might have
2833 ;; added some more.
2835 ;; Run last hook with current back-end as argument.
2838 ;; Update communication channel with environment. Also
2839 ;; install user's and developer's filters.
2844 ;; Expand export-specific set of macros: {{{author}}},
2845 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2846 ;; once regular macros have been expanded, since document
2847 ;; keywords may contain one of them.
2853 ;; EMAIL is not a parsed keyword: store it as-is.
2857 ;; Call options filters and update export options. We do not
2858 ;; use `org-export-filter-apply-functions' here since the
2859 ;; arity of such filters is different.
2863 ;; Parse buffer and call parse-tree filter on it.
2868 ;; Now tree is complete, compute its properties and add them
2869 ;; to communication channel.
2873 ;; Eventually transcode TREE. Wrap the resulting string into
2874 ;; a template.
2883 ;; Remove all text properties since they cannot be
2884 ;; retrieved from an external process. Finally call
2885 ;; final-output filter and return result.
2891 info))))))))
2893 ;;;###autoload
2896 "Call `org-export-as' with output to a specified buffer.
2898 BACKEND is the back-end used for transcoding, as a symbol.
2900 BUFFER is the output buffer. If it already exists, it will be
2901 erased first, otherwise, it will be created.
2903 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2904 EXT-PLIST are similar to those used in `org-export-as', which
2905 see.
2907 If `org-export-copy-to-kill-ring' is non-nil, add buffer contents
2908 to kill ring. Return buffer."
2915 ;; Maybe add buffer contents to kill ring.
2918 ;; Return buffer.
2919 buffer))
2921 ;;;###autoload
2924 "Call `org-export-as' with output to a specified file.
2926 BACKEND is the back-end used for transcoding, as a symbol. FILE
2927 is the name of the output file, as a string.
2929 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2930 EXT-PLIST are similar to those used in `org-export-as', which
2931 see.
2933 If `org-export-copy-to-kill-ring' is non-nil, add file contents
2934 to kill ring. Return output file's name."
2935 ;; Checks for FILE permissions. `write-file' would do the same, but
2936 ;; we'd rather avoid needless transcoding of parse tree.
2938 ;; Insert contents to a temporary buffer and write it to FILE.
2944 ;; Maybe add file contents to kill ring.
2947 ;; Return full path.
2948 file)
2950 ;;;###autoload
2952 "Transcode STRING into BACKEND code.
2954 When optional argument BODY-ONLY is non-nil, only return body
2955 code, without preamble nor postamble.
2957 Optional argument EXT-PLIST, when provided, is a property list
2958 with external parameters overriding Org default settings, but
2959 still inferior to file-local settings.
2961 Return code as a string."
2968 "Return output file's name according to buffer specifications.
2970 EXTENSION is a string representing the output file extension,
2971 with the leading dot.
2973 With a non-nil optional argument SUBTREEP, try to determine
2975 of subtree at point.
2977 When optional argument PUB-DIR is set, use it as the publishing
2978 directory.
2980 When optional argument VISIBLE-ONLY is non-nil, don't export
2981 contents of hidden elements.
2983 Return file name as a string."
2986 ;; File name may come from EXPORT_FILE_NAME subtree
2987 ;; property, assuming point is at beginning of said
2988 ;; sub-tree.
2995 ;; File name may be extracted from buffer's associated
2996 ;; file, if any.
2998 ;; Can't determine file name on our own: Ask user.
3002 "Output file: " pub-dir nil nil nil
3006 ;; Build file name. Enforce EXTENSION over whatever user
3007 ;; may have come up with. PUB-DIR, if defined, always has
3008 ;; precedence over any provided path.
3013 extension))
3016 ;; If writing to OUTPUT-FILE would overwrite original file, append
3017 ;; EXTENSION another time to final name.
3020 output-file)))
3023 "Expand every include keyword in buffer.
3024 Optional argument INCLUDED is a list of included file names along
3025 with their line restriction, when appropriate. It is used to
3026 avoid infinite recursion. Optional argument DIR is the current
3027 working directory. It is used to properly resolve relative
3028 paths."
3035 ;; Extract arguments from keyword's value.
3049 ;; Minimal level of included file defaults to the child
3050 ;; level of the current headline, if any, or one. It
3051 ;; only applies is the file is meant to be included as
3052 ;; an Org one.
3060 ;; Remove keyword.
3065 ;; Check if files has already been parsed. Look after
3066 ;; inclusion lines too, as different parts of the same file
3067 ;; can be included too.
3079 ind-str contents ind-str))))
3087 ind-str env contents ind-str))))
3100 "Prepare the contents of FILE for inclusion and return them as a string.
3102 When optional argument LINES is a string specifying a range of
3103 lines, include only those lines.
3105 Optional argument IND, when non-nil, is an integer specifying the
3106 global indentation of returned contents. Since its purpose is to
3107 allow an included file to stay in the same environment it was
3108 created \(i.e. a list item), it doesn't apply past the first
3109 headline encountered.
3111 Optional argument MINLEVEL, when non-nil, is an integer
3112 specifying the level that any top-level headline in the included
3113 file should have."
3129 ;; Remove blank lines at beginning and end of contents. The logic
3130 ;; behind that removal is that blank lines around include keyword
3131 ;; override blank lines in included file.
3140 ;; If IND is set, preserve indentation of include keyword until
3141 ;; the first headline encountered.
3147 ;; Do not move footnote definitions out of column 0.
3153 ;; When MINLEVEL is specified, compute minimal level for headlines
3154 ;; in the file (CUR-MIN), and remove stars to each headline so
3155 ;; that headlines with minimal level have a level of MINLEVEL.
3165 ;; Only change stars, don't bother moving whole
3166 ;; sections.
3173 "Execute every Babel code in the visible part of current buffer."
3174 ;; Get a pristine copy of current buffer so Babel references can be
3175 ;; properly resolved.
3182 \f
3183 ;;; Tools For Back-Ends
3184 ;;
3185 ;; A whole set of tools is available to help build new exporters. Any
3186 ;; function general enough to have its use across many back-ends
3187 ;; should be added here.
3189 ;;;; For Affiliated Keywords
3190 ;;
3191 ;; `org-export-read-attribute' reads a property from a given element
3192 ;; as a plist. It can be used to normalize affiliated keywords'
3193 ;; syntax.
3194 ;;
3195 ;; Since captions can span over multiple lines and accept dual values,
3196 ;; their internal representation is a bit tricky. Therefore,
3197 ;; `org-export-get-caption' transparently returns a given element's
3198 ;; caption as a secondary string.
3201 "Turn ATTRIBUTE property from ELEMENT into a plist.
3203 When optional argument PROPERTY is non-nil, return the value of
3204 that property within attributes.
3208 properties."
3216 "Return caption from ELEMENT as a secondary string.
3218 When optional argument SHORTP is non-nil, return short caption,
3219 as a secondary string, instead.
3221 Caption lines are separated by a white space."
3229 ;;;; For Derived Back-ends
3230 ;;
3231 ;; `org-export-with-backend' is a function allowing to locally use
3232 ;; another back-end to transcode some object or element. In a derived
3233 ;; back-end, it may be used as a fall-back function once all specific
3234 ;; cases have been treated.
3237 "Call a transcoder from BACK-END on DATA.
3238 CONTENTS, when non-nil, is the transcoded contents of DATA
3239 element, as a string. INFO, when non-nil, is the communication
3240 channel used for export, as a plist.."
3250 ;;;; For Export Snippets
3251 ;;
3252 ;; Every export snippet is transmitted to the back-end. Though, the
3253 ;; latter will only retain one type of export-snippet, ignoring
3254 ;; others, based on the former's target back-end. The function
3255 ;; `org-export-snippet-backend' returns that back-end for a given
3256 ;; export-snippet.
3259 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3260 Translation, with `org-export-snippet-translation-alist', is
3261 applied."
3265 back-end))))
3268 ;;;; For Footnotes
3269 ;;
3270 ;; `org-export-collect-footnote-definitions' is a tool to list
3271 ;; actually used footnotes definitions in the whole parse tree, or in
3272 ;; a headline, in order to add footnote listings throughout the
3273 ;; transcoded data.
3274 ;;
3275 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3276 ;; back-ends, when they need to attach the footnote definition only to
3277 ;; the first occurrence of the corresponding label.
3278 ;;
3279 ;; `org-export-get-footnote-definition' and
3280 ;; `org-export-get-footnote-number' provide easier access to
3281 ;; additional information relative to a footnote reference.
3284 "Return an alist between footnote numbers, labels and definitions.
3286 DATA is the parse tree from which definitions are collected.
3287 INFO is the plist used as a communication channel.
3289 Definitions are sorted by order of references. They either
3290 appear as Org data or as a secondary string for inlined
3291 footnotes. Unreferenced definitions are ignored."
3293 collect-fn ; for byte-compiler.
3297 ;; Collect footnote number, label and definition in DATA.
3305 def)
3306 num-alist)
3307 ;; Also search in definition for nested footnotes.
3310 ;; Don't enter footnote definitions since it will happen
3311 ;; when their first reference is found.
3317 "Non-nil when a footnote reference is the first one for its label.
3319 FOOTNOTE-REFERENCE is the footnote reference being considered.
3320 INFO is the plist used as a communication channel."
3322 ;; Anonymous footnotes are always a first reference.
3324 ;; Otherwise, return the first footnote with the same LABEL and
3325 ;; test if it is equal to FOOTNOTE-REFERENCE.
3335 ;; If FN isn't inlined, be sure to traverse its
3336 ;; definition before resuming search. See
3337 ;; comments in `org-export-get-footnote-number'
3338 ;; for more information.
3342 ;; Don't enter footnote definitions since it will
3343 ;; happen when their first reference is found.
3346 footnote-reference)))))
3349 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3350 INFO is the plist used as a communication channel. If no such
3352 string."
3359 "Return number associated to a footnote.
3361 FOOTNOTE is either a footnote reference or a footnote definition.
3362 INFO is the plist used as a communication channel."
3364 seen-refs
3365 search-ref ; For byte-compiler.
3369 ;; Search footnote references through DATA, filling
3370 ;; SEEN-REFS along the way.
3375 ;; Anonymous footnote match: return number.
3378 ;; Labels match: return number.
3381 ;; Anonymous footnote: it's always a new one.
3382 ;; Also, be sure to return nil from the `cond' so
3383 ;; `first-match' doesn't get us out of the loop.
3385 ;; Label not seen so far: add it so SEEN-REFS.
3386 ;;
3387 ;; Also search for subsequent references in
3388 ;; footnote definition so numbering follows
3389 ;; reading logic. Note that we don't have to care
3390 ;; about inline definitions, since
3391 ;; `org-element-map' already traverses them at the
3392 ;; right time.
3393 ;;
3394 ;; Once again, return nil to stay in the loop.
3399 nil))))
3400 ;; Don't enter footnote definitions since it will
3401 ;; happen when their first reference is found.
3406 ;;;; For Headlines
3407 ;;
3408 ;; `org-export-get-relative-level' is a shortcut to get headline
3409 ;; level, relatively to the lower headline level in the parsed tree.
3410 ;;
3411 ;; `org-export-get-headline-number' returns the section number of an
3412 ;; headline, while `org-export-number-to-roman' allows to convert it
3413 ;; to roman numbers.
3414 ;;
3415 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3416 ;; `org-export-last-sibling-p' are three useful predicates when it
3417 ;; comes to fulfill the `:headline-levels' property.
3418 ;;
3419 ;; `org-export-get-tags', `org-export-get-category' and
3420 ;; `org-export-get-node-property' extract useful information from an
3421 ;; headline or a parent headline. They all handle inheritance.
3422 ;;
3423 ;; `org-export-get-alt-title' tries to retrieve an alternative title,
3424 ;; as a secondary string, suitable for table of contents. It falls
3425 ;; back onto default title.
3428 "Return HEADLINE relative level within current parsed tree.
3429 INFO is a plist holding contextual information."
3434 "Non-nil when HEADLINE is considered as low level.
3436 INFO is a plist used as a communication channel.
3438 A low level headlines has a relative level greater than
3439 `:headline-levels' property value.
3441 Return value is the difference between HEADLINE relative level
3442 and the last level being considered as high enough, or nil."
3449 "Return HEADLINE numbering as a list of numbers.
3450 INFO is a plist holding contextual information."
3454 "Return a non-nil value if HEADLINE element should be numbered.
3455 INFO is a plist used as a communication channel."
3461 "Convert integer N into a roman numeral."
3474 res)))
3477 "Return list of tags associated to ELEMENT.
3479 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3480 is a plist used as a communication channel.
3482 Select tags (see `org-export-select-tags') and exclude tags (see
3483 `org-export-exclude-tags') are removed from the list.
3485 When non-nil, optional argument TAGS should be a list of strings.
3486 Any tag belonging to this list will also be removed.
3488 When optional argument INHERITED is non-nil, tags can also be
3489 inherited from parent headlines and FILETAGS keywords."
3495 ;; Build complete list of inherited tags.
3506 ;; Add FILETAGS keywords and return results.
3510 "Return node PROPERTY value for BLOB.
3512 PROPERTY is an upcase symbol (i.e. `:COOKIE_DATA'). BLOB is an
3513 element or object.
3515 If optional argument INHERITED is non-nil, the value can be
3516 inherited from a parent headline.
3518 Return value is a string or nil."
3530 "Return category for element or object BLOB.
3532 INFO is a plist used as a communication channel.
3534 CATEGORY is automatically inherited from a parent headline, from
3535 #+CATEGORY: keyword or created out of original file name. If all
3539 ;; Almost like `org-export-node-property', but we cannot trust
3540 ;; `plist-member' as every headline has a `:CATEGORY'
3541 ;; property, would it be nil or equal to "???" (which has the
3542 ;; same meaning).
3560 "Return alternative title for HEADLINE, as a secondary string.
3561 INFO is a plist used as a communication channel. If no optional
3562 title is defined, fall-back to the regular title."
3567 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3568 INFO is a plist used as a communication channel."
3573 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3574 INFO is a plist used as a communication channel."
3578 ;;;; For Links
3579 ;;
3580 ;; `org-export-solidify-link-text' turns a string into a safer version
3581 ;; for links, replacing most non-standard characters with hyphens.
3582 ;;
3583 ;; `org-export-get-coderef-format' returns an appropriate format
3584 ;; string for coderefs.
3585 ;;
3586 ;; `org-export-inline-image-p' returns a non-nil value when the link
3587 ;; provided should be considered as an inline image.
3588 ;;
3589 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3590 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3591 ;; returns an appropriate unique identifier when found, or nil.
3592 ;;
3593 ;; `org-export-resolve-id-link' returns the first headline with
3594 ;; specified id or custom-id in parse tree, the path to the external
3595 ;; file with the id or nil when neither was found.
3596 ;;
3597 ;; `org-export-resolve-coderef' associates a reference to a line
3598 ;; number in the element it belongs, or returns the reference itself
3599 ;; when the element isn't numbered.
3602 "Take link text S and make a safe target out of it."
3607 "Return format string for code reference link.
3608 PATH is the link path. DESC is its description."
3616 "Non-nil if LINK object points to an inline image.
3618 Optional argument is a set of RULES defining inline images. It
3619 is an alist where associations have the following shape:
3621 \(TYPE . REGEXP)
3623 Applying a rule means apply REGEXP against LINK's path when its
3624 type is TYPE. The function will return a non-nil value if any of
3625 the provided rules is non-nil. The default rule is
3626 `org-export-default-inline-image-rule'.
3628 This only applies to links without a description."
3639 rules)
3640 ;; Return nil if no rule matched.
3641 nil))))
3644 "Resolve a code reference REF.
3646 INFO is a plist used as a communication channel.
3648 Return associated line number in source code, or REF itself,
3649 depending on src-block or example element's switches."
3656 org-coderef-label-format)))
3660 ;; Element containing REF is found. Resolve it to either
3661 ;; a label or a line number, as needed.
3671 "Return LINK destination.
3673 INFO is a plist holding contextual information.
3675 Return value can be an object, an element, or nil:
3677 - If LINK path matches a target object (i.e. <<path>>) or
3680 - If LINK path exactly matches the name affiliated keyword
3681 \(i.e. #+NAME: path) of an element, return that element.
3683 - If LINK path exactly matches any headline name, return that
3684 element. If more than one headline share that name, priority
3685 will be given to the one with the closest common ancestor, if
3686 any, or the first one in the parse tree otherwise.
3688 - Otherwise, return nil.
3691 significant."
3694 ;; Split PATH at white spaces so matches are space
3695 ;; insensitive.
3699 ;; First try to find a matching "<<path>>" unless user specified
3700 ;; he was looking for a headline (path starts with a *
3701 ;; character).
3708 path)
3709 blob))
3710 info t)))
3711 ;; Then try to find an element with a matching "#+NAME: path"
3712 ;; affiliated keyword.
3715 org-element-all-elements
3720 ;; Last case: link either points to a headline or to
3721 ;; nothingness. Try to find the source, with priority given to
3722 ;; headlines with the closest common ancestor. If such candidate
3723 ;; is found, return it, otherwise return nil.
3727 ;; Return first headline whose `:raw-value' property is
3728 ;; NAME in parse tree DATA, or nil. Statistics cookies
3729 ;; are ignored.
3737 name)
3738 headline))
3740 ;; Search among headlines sharing an ancestor with link, from
3741 ;; closest to farthest.
3749 ;; No match with a common ancestor: try full parse-tree.
3753 "Return headline referenced as LINK destination.
3755 INFO is a plist used as a communication channel.
3757 Return value can be the headline element matched in current parse
3761 ;; First check if id is within the current parse tree.
3766 headline))
3768 ;; Otherwise, look for external files.
3772 "Return radio-target object referenced as LINK destination.
3774 INFO is a plist used as a communication channel.
3776 Return value can be a radio-target object or nil. Assume LINK
3783 radio))
3787 ;;;; For References
3788 ;;
3789 ;; `org-export-get-ordinal' associates a sequence number to any object
3790 ;; or element.
3793 "Return ordinal number of an element or object.
3795 ELEMENT is the element or object considered. INFO is the plist
3796 used as a communication channel.
3798 Optional argument TYPES, when non-nil, is a list of element or
3799 object types, as symbols, that should also be counted in.
3800 Otherwise, only provided element's type is considered.
3802 Optional argument PREDICATE is a function returning a non-nil
3803 value if the current element or object should be counted in. It
3804 accepts two arguments: the element or object being considered and
3805 the plist used as a communication channel. This allows to count
3806 only a certain type of objects (i.e. inline images).
3808 Return value is a list of numbers if ELEMENT is a headline or an
3809 item. It is nil for keywords. It represents the footnote number
3810 for footnote definitions and footnote references. If ELEMENT is
3811 a target, return the same value as if ELEMENT was the closest
3812 table, item or headline containing the target. In any other
3813 case, return the sequence number of ELEMENT among elements or
3814 objects of the same type."
3815 ;; A target keyword, representing an invisible target, never has
3816 ;; a sequence number.
3818 ;; Ordinal of a target object refer to the ordinal of the closest
3819 ;; table, item, or headline containing the object.
3823 when
3827 table))
3828 return parent)))
3830 ;; Special case 1: A headline returns its number as a list.
3832 ;; Special case 2: An item returns its number as a list.
3836 struct
3843 ;; Increment counter until ELEMENT is found again.
3854 ;;;; For Src-Blocks
3855 ;;
3856 ;; `org-export-get-loc' counts number of code lines accumulated in
3857 ;; src-block or example-block elements with a "+n" switch until
3858 ;; a given element, excluded. Note: "-n" switches reset that count.
3859 ;;
3860 ;; `org-export-unravel-code' extracts source code (along with a code
3861 ;; references alist) from an `element-block' or `src-block' type
3862 ;; element.
3863 ;;
3864 ;; `org-export-format-code' applies a formatting function to each line
3865 ;; of code, providing relative line number and code reference when
3866 ;; appropriate. Since it doesn't access the original element from
3867 ;; which the source code is coming, it expects from the code calling
3868 ;; it to know if lines should be numbered and if code references
3869 ;; should appear.
3870 ;;
3871 ;; Eventually, `org-export-format-code-default' is a higher-level
3872 ;; function (it makes use of the two previous functions) which handles
3873 ;; line numbering and code references inclusion, and returns source
3874 ;; code in a format suitable for plain text or verbatim output.
3877 "Return accumulated lines of code up to ELEMENT.
3879 INFO is the plist used as a communication channel.
3881 ELEMENT is excluded from count."
3887 ;; ELEMENT is reached: Quit the loop.
3889 ;; Only count lines from src-block and example-block elements
3890 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3894 ;; Accumulate locs or reset them.
3898 ;; Return nil to stay in the loop.
3899 nil)))
3901 ;; Return value.
3902 loc))
3905 "Clean source code and extract references out of it.
3907 ELEMENT has either a `src-block' an `example-block' type.
3909 Return a cons cell whose CAR is the source code, cleaned from any
3910 reference and protective comma and CDR is an alist between
3911 relative line number (integer) and name of code reference on that
3912 line (string)."
3914 ;; Get code and clean it. Remove blank lines at its
3915 ;; beginning and end.
3921 ;; If appropriate, remove global indentation.
3924 c
3926 ;; Get format used for references.
3929 org-coderef-label-format)))
3930 ;; Build a regexp matching a loc with a reference.
3935 ;; Return value.
3937 ;; Code with references removed.
3943 ;; Ref line: remove ref, and signal its position in REFS.
3947 ;; Reference alist.
3948 refs)))
3951 "Format CODE by applying FUN line-wise and return it.
3953 CODE is a string representing the code to format. FUN is
3954 a function. It must accept three arguments: a line of
3955 code (string), the current line number (integer) or nil and the
3956 reference associated to the current line (string) or nil.
3958 Optional argument NUM-LINES can be an integer representing the
3959 number of code lines accumulated until the current code. Line
3960 numbers passed to FUN will take it into account. If it is nil,
3961 FUN's second argument will always be nil. This number can be
3962 obtained with `org-export-get-loc' function.
3964 Optional argument REF-ALIST can be an alist between relative line
3965 number (i.e. ignoring NUM-LINES) and the name of the code
3966 reference on it. If it is nil, FUN's third argument will always
3967 be nil. It can be obtained through the use of
3968 `org-export-unravel-code' function."
3980 "Return source code from ELEMENT, formatted in a standard way.
3982 ELEMENT is either a `src-block' or `example-block' element. INFO
3983 is a plist used as a communication channel.
3985 This function takes care of line numbering and code references
3986 inclusion. Line numbers, when applicable, appear at the
3987 beginning of the line, separated from the code by two white
3988 spaces. Code references, on the other hand, appear flushed to
3989 the right, separated by six white spaces from the widest line of
3990 code."
3991 ;; Extract code and references.
3997 ;; Handle line numbering.
4006 ;; Prepare references display, if required. Any reference
4007 ;; should start six columns after the widest line of code,
4008 ;; wrapped with parenthesis.
4013 code
4017 number-str
4018 loc
4024 num-start refs)))
4027 ;;;; For Tables
4028 ;;
4029 ;; `org-export-table-has-special-column-p' and and
4030 ;; `org-export-table-row-is-special-p' are predicates used to look for
4031 ;; meta-information about the table structure.
4032 ;;
4033 ;; `org-table-has-header-p' tells when the rows before the first rule
4034 ;; should be considered as table's header.
4035 ;;
4036 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
4037 ;; and `org-export-table-cell-borders' extract information from
4038 ;; a table-cell element.
4039 ;;
4040 ;; `org-export-table-dimensions' gives the number on rows and columns
4041 ;; in the table, ignoring horizontal rules and special columns.
4042 ;; `org-export-table-cell-address', given a table-cell object, returns
4043 ;; the absolute address of a cell. On the other hand,
4044 ;; `org-export-get-table-cell-at' does the contrary.
4045 ;;
4046 ;; `org-export-table-cell-starts-colgroup-p',
4047 ;; `org-export-table-cell-ends-colgroup-p',
4048 ;; `org-export-table-row-starts-rowgroup-p',
4049 ;; `org-export-table-row-ends-rowgroup-p',
4050 ;; `org-export-table-row-starts-header-p' and
4051 ;; `org-export-table-row-ends-header-p' indicate position of current
4052 ;; row or cell within the table.
4055 "Non-nil when TABLE has a special column.
4056 All special columns will be ignored during export."
4057 ;; The table has a special column when every first cell of every row
4058 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4059 ;; "*" "_" and "^". Though, do not consider a first row containing
4060 ;; only empty cells as special.
4076 "Non-nil when TABLE has an header.
4078 INFO is a plist used as a communication channel.
4080 A table has an header when it contains at least two row groups."
4090 info)))
4093 "Non-nil if TABLE-ROW is considered special.
4095 INFO is a plist used as the communication channel.
4097 All special rows will be ignored during export."
4101 ;; A row is special either when...
4103 ;; ... it starts with a field only containing "/",
4105 ;; ... the table contains a special column and the row start
4106 ;; with a marking character among, "^", "_", "$" or "!",
4110 ;; ... it contains only alignment cookies and empty cells.
4116 ;; Since VALUE is a secondary string, the following
4117 ;; checks avoid expanding it with `org-export-data'.
4129 "Return TABLE-ROW's group.
4131 INFO is a plist used as the communication channel.
4133 Return value is the group number, as an integer, or nil special
4134 rows and table rules. Group 1 is also table's header."
4151 "Return TABLE-CELL contents width.
4153 INFO is a plist used as the communication channel.
4155 Return value is the width given by the last width cookie in the
4156 same column as TABLE-CELL, or nil."
4161 cookie-width)
4165 ;; In a special row, try to find a width cookie at COLUMN.
4169 ;; The following checks avoid expanding unnecessarily the
4170 ;; cell with `org-export-data'
4178 ;; Ignore table rules.
4181 ;; Return value.
4182 cookie-width))
4185 "Return TABLE-CELL contents alignment.
4187 INFO is a plist used as the communication channel.
4189 Return alignment as specified by the last alignment cookie in the
4190 same column as TABLE-CELL. If no such cookie is found, a default
4191 alignment value will be deduced from fraction of numbers in the
4192 column (see `org-table-number-fraction' for more information).
4193 Possible values are `left', `right' and `center'."
4200 cookie-align)
4204 ;; In a special row, try to find an alignment cookie at
4205 ;; COLUMN.
4209 ;; Since VALUE is a secondary string, the following checks
4210 ;; avoid useless expansion through `org-export-data'.
4218 ;; Ignore table rules.
4220 ;; In a standard row, check if cell's contents are expressing
4221 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4222 ;; Though, don't bother if an alignment cookie has already
4223 ;; defined cell's alignment.
4228 info)))
4233 ;; Return value. Alignment specified by cookies has precedence
4234 ;; over alignment deduced from cells contents.
4243 "Return TABLE-CELL borders.
4245 INFO is a plist used as a communication channel.
4247 Return value is a list of symbols, or nil. Possible values are:
4248 `top', `bottom', `above', `below', `left' and `right'. Note:
4249 `top' (resp. `bottom') only happen for a cell in the first
4250 row (resp. last row) of the table, ignoring table rules, if any.
4252 Returned borders ignore special rows."
4255 borders)
4256 ;; Top/above border? TABLE-CELL has a border above when a rule
4257 ;; used to demarcate row groups can be found above. Hence,
4258 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4259 ;; another regular row has to be found above that rule.
4268 ;; Look at every row before the current one.
4270 ;; No rule above, or rule found starts the table (ignoring any
4271 ;; special row): TABLE-CELL is at the top of the table.
4274 ;; Bottom/below border? TABLE-CELL has a border below when next
4275 ;; non-regular row below is a rule.
4284 ;; Look at every row after the current one.
4286 ;; No rule below, or rule found ends the table (modulo some
4287 ;; special row): TABLE-CELL is at the bottom of the table.
4290 ;; Right/left borders? They can only be specified by column
4291 ;; groups. Column groups are defined in a row starting with "/".
4292 ;; Also a column groups row only contains "<", "<>", ">" or blank
4293 ;; cells.
4310 ;; There's a left border when previous cell, if
4311 ;; any, ends a group, or current one starts one.
4317 ;; There's a right border when next cell, if any,
4318 ;; starts a group, or current one ends one.
4325 ;; Table rows are read in reverse order so last column groups
4326 ;; row has precedence over any previous one.
4328 ;; Return value.
4329 borders))
4332 "Non-nil when TABLE-CELL is at the beginning of a row group.
4333 INFO is a plist used as a communication channel."
4334 ;; A cell starts a column group either when it is at the beginning
4335 ;; of a row (or after the special column, if any) or when it has
4336 ;; a left border.
4339 table-cell)
4343 "Non-nil when TABLE-CELL is at the end of a row group.
4344 INFO is a plist used as a communication channel."
4345 ;; A cell ends a column group either when it is at the end of a row
4346 ;; or when it has a right border.
4349 table-cell)
4353 "Non-nil when TABLE-ROW is at the beginning of a column group.
4354 INFO is a plist used as a communication channel."
4362 "Non-nil when TABLE-ROW is at the end of a column group.
4363 INFO is a plist used as a communication channel."
4371 "Non-nil when TABLE-ROW is the first table header's row.
4372 INFO is a plist used as a communication channel."
4379 "Non-nil when TABLE-ROW is the last table header's row.
4380 INFO is a plist used as a communication channel."
4387 "Return TABLE dimensions.
4389 INFO is a plist used as a communication channel.
4391 Return value is a CONS like (ROWS . COLUMNS) where
4392 ROWS (resp. COLUMNS) is the number of exportable
4393 rows (resp. columns)."
4395 ;; Set number of rows, and extract first one.
4401 ;; Set number of columns.
4403 ;; Return value.
4407 "Return address of a regular TABLE-CELL object.
4409 TABLE-CELL is the cell considered. INFO is a plist used as
4410 a communication channel.
4412 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4413 zero-based index. Only exportable cells are considered. The
4414 function returns nil for other cells."
4417 ;; Ignore cells in special rows or in special column.
4422 ;; Row number.
4430 ;; Column number.
4438 "Return regular table-cell object at ADDRESS in TABLE.
4440 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4441 zero-based index. TABLE is a table type element. INFO is
4442 a plist used as a communication channel.
4444 If no table-cell, among exportable cells, is found at ADDRESS,
4445 return nil."
4448 ;; Row at (car address) or nil.
4456 'table-cell
4463 ;;;; For Tables Of Contents
4464 ;;
4465 ;; `org-export-collect-headlines' builds a list of all exportable
4466 ;; headline elements, maybe limited to a certain depth. One can then
4467 ;; easily parse it and transcode it.
4468 ;;
4469 ;; Building lists of tables, figures or listings is quite similar.
4470 ;; Once the generic function `org-export-collect-elements' is defined,
4471 ;; `org-export-collect-tables', `org-export-collect-figures' and
4472 ;; `org-export-collect-listings' can be derived from it.
4475 "Collect headlines in order to build a table of contents.
4477 INFO is a plist used as a communication channel.
4479 When optional argument N is an integer, it specifies the depth of
4480 the table of contents. Otherwise, it is set to the value of the
4481 last headline level. See `org-export-headline-levels' for more
4482 information.
4484 Return a list of all exportable headlines as parsed elements.
4485 Footnote sections, if any, will be ignored."
4490 ;; Strip contents from HEADLINE.
4493 info))
4496 "Collect referenceable elements of a determined type.
4498 TYPE can be a symbol or a list of symbols specifying element
4499 types to search. Only elements with a caption are collected.
4501 INFO is a plist used as a communication channel.
4503 When non-nil, optional argument PREDICATE is a function accepting
4504 one argument, an element of type TYPE. It returns a non-nil
4505 value when that element should be collected.
4507 Return a list of all elements found, in order of appearance."
4512 element))
4513 info))
4516 "Build a list of tables.
4517 INFO is a plist used as a communication channel.
4519 Return a list of table elements with a caption."
4523 "Build a list of figures.
4525 INFO is a plist used as a communication channel. PREDICATE is
4526 a function which accepts one argument: a paragraph element and
4527 whose return value is non-nil when that element should be
4528 collected.
4530 A figure is a paragraph type element, with a caption, verifying
4532 a vague concept that may depend on back-end.
4534 Return a list of elements recognized as figures."
4538 "Build a list of src blocks.
4540 INFO is a plist used as a communication channel.
4542 Return a list of src-block elements with a caption."
4546 ;;;; Smart Quotes
4547 ;;
4548 ;; The main function for the smart quotes sub-system is
4549 ;; `org-export-activate-smart-quotes', which replaces every quote in
4550 ;; a given string from the parse tree with its "smart" counterpart.
4551 ;;
4552 ;; Dictionary for smart quotes is stored in
4553 ;; `org-export-smart-quotes-alist'.
4554 ;;
4555 ;; Internally, regexps matching potential smart quotes (checks at
4556 ;; string boundaries are also necessary) are defined in
4557 ;; `org-export-smart-quotes-regexps'.
4594 "Smart quotes translations.
4596 Alist whose CAR is a language string and CDR is an alist with
4597 quote type as key and a plist associating various encodings to
4598 their translation as value.
4600 A quote type can be any symbol among `opening-double-quote',
4601 `closing-double-quote', `opening-single-quote',
4602 `closing-single-quote' and `apostrophe'.
4604 Valid encodings include `:utf-8', `:html', `:latex' and
4605 `:texinfo'.
4611 ;; Possible opening quote at beginning of string.
4613 ;; Possible closing quote at beginning of string.
4615 ;; Possible apostrophe at beginning of string.
4617 ;; Opening single and double quotes.
4619 ;; Closing single and double quotes.
4621 ;; Apostrophe.
4623 ;; Possible opening quote at end of string.
4625 ;; Possible closing quote at end of string.
4627 ;; Possible apostrophe at end of string.
4629 "List of regexps matching a quote or an apostrophe.
4635 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4636 `:utf-8'. INFO is a plist used as a communication channel.
4638 The function has to retrieve information about string
4639 surroundings in parse tree. It can only happen with an
4640 unmodified string. Thus, if S has already been through another
4641 process, a non-nil ORIGINAL optional argument will provide that
4642 original string.
4644 Return the new string."
4647 ;; Try to be flexible when computing number of blanks
4648 ;; before object. The previous object may be a string
4649 ;; introduced by the back-end and not completely parsed.
4652 ;; A string with missing `:post-blank'
4653 ;; property.
4657 ;; Fallback value.
4662 ;; Return smart quote associated to a give quote Q, as
4663 ;; a string. TYPE is a symbol among `open', `close' and
4664 ;; `apostrophe'.
4674 org-export-smart-quotes-alist))))
4675 encoding)
4676 q)))))
4678 ;; Only a quote: no regexp can match. We have to check both
4679 ;; sides and decide what to do.
4687 ;; 1. Replace quote character at the beginning of S.
4689 ;; Apostrophe?
4695 ;; Closing quote?
4701 ;; Opening quote?
4707 ;; 2. Replace quotes in the middle of the string.
4709 ;; Opening quotes.
4715 ;; Closing quotes.
4721 ;; Apostrophes.
4726 ;; 3. Replace quote character at the end of S.
4728 ;; Apostrophe?
4733 ;; Closing quote?
4739 ;; Opening quote?
4744 ;; Return string with smart quotes.
4745 s))))
4747 ;;;; Topology
4748 ;;
4749 ;; Here are various functions to retrieve information about the
4750 ;; neighbourhood of a given element or object. Neighbours of interest
4751 ;; are direct parent (`org-export-get-parent'), parent headline
4752 ;; (`org-export-get-parent-headline'), first element containing an
4753 ;; object, (`org-export-get-parent-element'), parent table
4754 ;; (`org-export-get-parent-table'), previous element or object
4755 ;; (`org-export-get-previous-element') and next element or object
4756 ;; (`org-export-get-next-element').
4757 ;;
4758 ;; `org-export-get-genealogy' returns the full genealogy of a given
4759 ;; element or object, from closest parent to full parse tree.
4762 "Return BLOB parent or nil.
4763 BLOB is the element or object considered."
4767 "Return full genealogy relative to a given element or object.
4769 BLOB is the element or object being considered.
4771 Ancestors are returned from closest to farthest, the last one
4772 being the full parse tree."
4779 "Return BLOB parent headline or nil.
4780 BLOB is the element or object being considered."
4784 parent))
4787 "Return first element containing OBJECT or nil.
4788 OBJECT is the object to consider."
4792 parent))
4795 "Return OBJECT parent table or nil.
4796 OBJECT is either a `table-cell' or `table-element' type object."
4800 parent))
4803 "Return previous element or object.
4805 BLOB is an element or object. INFO is a plist used as
4806 a communication channel. Return previous exportable element or
4807 object, a string, or nil.
4809 When optional argument N is a positive integer, return a list
4810 containing up to N siblings before BLOB, from farthest to
4811 closest. With any other non-nil value, return a list containing
4812 all of them."
4814 ;; An object can belong to the contents of its parent or
4815 ;; to a secondary string. We check the latter option
4816 ;; first.
4819 org-element-all-elements))
4823 org-element-secondary-value-alist))
4824 parent)))
4827 prev)
4836 prev)))
4839 "Return next element or object.
4841 BLOB is an element or object. INFO is a plist used as
4842 a communication channel. Return next exportable element or
4843 object, a string, or nil.
4845 When optional argument N is a positive integer, return a list
4846 containing up to N siblings after BLOB, from closest to farthest.
4847 With any other non-nil value, return a list containing all of
4848 them."
4850 ;; An object can belong to the contents of its parent or to
4851 ;; a secondary string. We check the latter option first.
4854 org-element-all-objects))
4858 org-element-secondary-value-alist))
4859 parent)))
4862 next)
4870 siblings)
4874 ;;;; Translation
4875 ;;
4876 ;; `org-export-translate' translates a string according to language
4877 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4878 ;; variable and a specified charset. `org-export-dictionary' contains
4879 ;; the dictionary used for the translation.
5001 "Dictionary for export engine.
5003 Alist whose CAR is the string to translate and CDR is an alist
5004 whose CAR is the language string and CDR is a plist whose
5005 properties are possible charsets and values translated terms.
5007 It is used as a database for `org-export-translate'. Since this
5008 function returns the string as-is if no translation was found,
5009 the variable only needs to record values different from the
5013 "Translate string S according to language specification.
5015 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
5016 and `:utf-8'. INFO is a plist used as a communication channel.
5018 Translation depends on `:language' property. Return the
5019 translated string. If no translation is found, try to fall back
5020 to `:default' encoding. If it fails, return S."
5026 s)))
5029 \f
5030 ;;; Asynchronous Export
5031 ;;
5032 ;; `org-export-async-start' is the entry point for asynchronous
5033 ;; export. It recreates current buffer (including visibility,
5034 ;; narrowing and visited file) in an external Emacs process, and
5035 ;; evaluates a command there. It then applies a function on the
5036 ;; returned results in the current process.
5037 ;;
5038 ;; Asynchronously generated results are never displayed directly.
5039 ;; Instead, they are stored in `org-export-stack-contents'. They can
5040 ;; then be retrieved by calling `org-export-stack'.
5041 ;;
5042 ;; Export Stack is viewed through a dedicated major mode
5043 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
5044 ;;`org-export-stack-delete', `org-export-stack-view' and
5045 ;;`org-export-stack-clear'.
5046 ;;
5047 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5048 ;; It should used whenever `org-export-async-start' is called.
5051 "Call function FUN on the results returned by BODY evaluation.
5053 BODY evaluation happens in an asynchronous process, from a buffer
5054 which is an exact copy of the current one.
5056 Use `org-export-add-to-stack' in FUN in order to register results
5057 in the stack. Examples for, respectively a temporary buffer and
5058 a file are:
5060 \(org-export-async-start
5061 \(lambda (output)
5063 \(erase-buffer)
5064 \(insert output)
5065 \(goto-char (point-min))
5066 \(org-export-add-to-stack (current-buffer) 'backend)))
5067 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5069 and
5071 \(org-export-async-start
5072 \(lambda (f) (org-export-add-to-stack f 'backend))
5073 `(expand-file-name
5074 \(org-export-to-file
5075 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5078 ;; Write the full sexp evaluating BODY in a copy of the current
5079 ;; buffer to a temporary file, as it may be too long for program
5080 ;; args in `start-process'.
5087 "%S"
5090 ;; Initialize `org-mode' and export framework in the
5091 ;; external process.
5094 ;; Re-create current buffer there.
5097 ;; Sexp to evaluate in the buffer.
5099 ;; Start external process.
5102 (,process
5107 "-l" org-export-async-init-file
5109 ;; Register running process in stack.
5111 ;; Set-up sentinel in order to catch results.
5113 ,process
5137 "Add a new result to export stack if not present already.
5139 SOURCE is a buffer or a file name containing export results.
5140 BACKEND is a symbol representing export back-end used to generate
5141 it.
5143 Entries already pointing to SOURCE and unavailable entries are
5144 removed beforehand. Return the new stack."
5150 "Menu for asynchronous export results and running processes."
5160 "Return source from export results at point in stack."
5167 source
5168 ;; SOURCE is not consistent with current line. The stack
5169 ;; view is outdated.
5173 "Remove all entries from export stack."
5178 "Refresh the asynchronous export stack.
5179 DUMMY is ignored. Unavailable sources are removed from the list.
5180 Return the new stack."
5190 ;; Back-end.
5192 ;; Age.
5195 ;; Compute age of the results.
5197 "%4h:%.2m "
5199 ;; Source.
5204 ;; Clear stack from exited processes, dead buffers or
5205 ;; non-existent files.
5217 "Remove export results at point from stack.
5218 If optional argument SOURCE is non-nil, remove it instead."
5223 org-export-stack-contents))))
5226 "View export results at point in stack.
5227 With an optional prefix argument IN-EMACS, force viewing files
5228 within Emacs."
5242 (define-key km "p" 'previous-line)
5243 (define-key km "\C-p" 'previous-line)
5244 (define-key km "\C-?" 'previous-line)
5245 (define-key km [up] 'previous-line)
5246 (define-key km "C" 'org-export-stack-clear)
5247 (define-key km "v" 'org-export-stack-view)
5248 (define-key km (kbd "RET") 'org-export-stack-view)
5249 (define-key km "d" 'org-export-stack-remove)
5250 km)
5251 "Keymap for Org Export Stack.")
5253 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5254 "Mode for displaying asynchronous export stack.
5257 stack.
5259 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5260 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5261 stack completely.
5263 Removing entries in an Org Export Stack buffer doesn't affect
5264 files or buffers, only the display.
5267 (abbrev-mode 0)
5268 (auto-fill-mode 0)
5269 (setq buffer-read-only t
5270 buffer-undo-list t
5271 truncate-lines t
5272 header-line-format
5273 '(:eval
5274 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5275 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5276 (set (make-local-variable 'revert-buffer-function)
5277 'org-export-stack-refresh))
5280 \f
5281 ;;; The Dispatcher
5282 ;;
5283 ;; `org-export-dispatch' is the standard interactive way to start an
5284 ;; export process. It uses `org-export--dispatch-ui' as a subroutine
5285 ;; for its interface, which, in turn, delegates response to key
5286 ;; pressed to `org-export--dispatch-action'.
5288 ;;;###autoload
5289 (defun org-export-dispatch (&optional arg)
5290 "Export dispatcher for Org mode.
5292 It provides an access to common export related tasks in a buffer.
5293 Its interface comes in two flavours: standard and expert.
5295 While both share the same set of bindings, only the former
5296 displays the valid keys associations in a dedicated buffer.
5297 Scrolling (resp. line-wise motion) in this buffer is done with
5298 SPC and DEL (resp. C-n and C-p) keys.
5300 Set variable `org-export-dispatch-use-expert-ui' to switch to one
5301 flavour or the other.
5304 of options used back then, on the current buffer.
5306 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5307 (interactive "P")
5308 (let* ((input
5309 (cond ((equal arg '(16)) '(stack))
5310 ((and arg org-export-dispatch-last-action))
5311 (t (save-window-excursion
5312 (unwind-protect
5313 ;; Store this export command.
5314 (setq org-export-dispatch-last-action
5315 (org-export--dispatch-ui
5316 (list org-export-initial-scope
5317 (and org-export-in-background 'async))
5318 nil
5319 org-export-dispatch-use-expert-ui))
5320 (and (get-buffer "*Org Export Dispatcher*")
5321 (kill-buffer "*Org Export Dispatcher*")))))))
5322 (action (car input))
5323 (optns (cdr input)))
5324 (case action
5325 ;; First handle special hard-coded actions.
5326 (stack (org-export-stack))
5327 (publish-current-file
5328 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5329 (publish-current-project
5330 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5331 (publish-choose-project
5332 (org-publish (assoc (org-icompleting-read
5333 "Publish project: "
5334 org-publish-project-alist nil t)
5335 org-publish-project-alist)
5336 (memq 'force optns)
5337 (memq 'async optns)))
5338 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5339 (otherwise (funcall action
5340 ;; Return a symbol instead of a list to ease
5341 ;; asynchronous export macro use.
5342 (and (memq 'async optns) t)
5343 (and (memq 'subtree optns) t)
5344 (and (memq 'visible optns) t)
5345 (and (memq 'body optns) t))))))
5347 (defun org-export--dispatch-ui (options first-key expertp)
5348 "Handle interface for `org-export-dispatch'.
5350 OPTIONS is a list containing current interactive options set for
5351 export. It can contain any of the following symbols:
5352 `body' toggles a body-only export
5353 `subtree' restricts export to current subtree
5354 `visible' restricts export to visible part of buffer.
5355 `force' force publishing files.
5356 `async' use asynchronous export process
5358 FIRST-KEY is the key pressed to select the first level menu. It
5359 is nil when this menu hasn't been selected yet.
5361 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5362 buffer is provided, but indications about currently active
5363 options are given in the prompt. Moreover, \[?] allows to switch
5364 back to standard interface."
5365 (let* ((fontify-key
5366 (lambda (key &optional access-key)
5367 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5368 ;; non-nil is the required first-level key to activate
5369 ;; KEY. When its value is t, activate KEY independently
5370 ;; on the first key, if any. A nil value means KEY will
5371 ;; only be activated at first level.
5372 (if (or (eq access-key t) (eq access-key first-key))
5373 (org-propertize key 'face 'org-warning)
5374 key)))
5375 (fontify-value
5376 (lambda (value)
5377 ;; Fontify VALUE string.
5378 (org-propertize value 'face 'font-lock-variable-name-face)))
5379 ;; Prepare menu entries by extracting them from
5380 ;; `org-export-registered-backends', and sorting them by
5381 ;; access key and by ordinal, if any.
5382 (backends
5383 (sort
5384 (sort
5385 (delq nil
5386 (mapcar
5387 (lambda (b)
5388 (let ((name (car b)))
5389 (catch 'ignored
5390 ;; Ignore any back-end belonging to
5391 ;; `org-export-invisible-backends' or derived
5392 ;; from one of them.
5393 (dolist (ignored org-export-invisible-backends)
5394 (when (org-export-derived-backend-p name ignored)
5395 (throw 'ignored nil)))
5396 (org-export-backend-menu name))))
5397 org-export-registered-backends))
5398 (lambda (a b)
5399 (let ((key-a (nth 1 a))
5400 (key-b (nth 1 b)))
5401 (cond ((and (numberp key-a) (numberp key-b))
5402 (< key-a key-b))
5403 ((numberp key-b) t)))))
5404 (lambda (a b) (< (car a) (car b)))))
5405 ;; Compute a list of allowed keys based on the first key
5406 ;; pressed, if any. Some keys (?^B, ?^V, ?^S, ?^F, ?^A
5407 ;; and ?q) are always available.
5408 (allowed-keys
5409 (nconc (list 2 22 19 6 1)
5410 (if (not first-key) (org-uniquify (mapcar 'car backends))
5411 (let (sub-menu)
5412 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5413 (when (eq (car backend) first-key)
5414 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5415 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5416 ((not first-key) (list ?P)))
5417 (list ?&)
5418 (when expertp (list ??))
5419 (list ?q)))
5420 ;; Build the help menu for standard UI.
5421 (help
5422 (unless expertp
5423 (concat
5424 ;; Options are hard-coded.
5425 (format "Options
5426 [%s] Body only: %s [%s] Visible only: %s
5427 [%s] Export scope: %s [%s] Force publishing: %s
5429 (funcall fontify-key "C-b" t)
5430 (funcall fontify-value
5431 (if (memq 'body options) "On " "Off"))
5432 (funcall fontify-key "C-v" t)
5433 (funcall fontify-value
5434 (if (memq 'visible options) "On " "Off"))
5435 (funcall fontify-key "C-s" t)
5436 (funcall fontify-value
5437 (if (memq 'subtree options) "Subtree" "Buffer "))
5438 (funcall fontify-key "C-f" t)
5439 (funcall fontify-value
5440 (if (memq 'force options) "On " "Off"))
5441 (funcall fontify-key "C-a" t)
5442 (funcall fontify-value
5443 (if (memq 'async options) "On " "Off")))
5444 ;; Display registered back-end entries. When a key
5445 ;; appears for the second time, do not create another
5446 ;; entry, but append its sub-menu to existing menu.
5447 (let (last-key)
5448 (mapconcat
5449 (lambda (entry)
5450 (let ((top-key (car entry)))
5451 (concat
5452 (unless (eq top-key last-key)
5453 (setq last-key top-key)
5455 (funcall fontify-key (char-to-string top-key))
5456 (nth 1 entry)))
5457 (let ((sub-menu (nth 2 entry)))
5458 (unless (functionp sub-menu)
5459 ;; Split sub-menu into two columns.
5460 (let ((index -1))
5461 (concat
5462 (mapconcat
5463 (lambda (sub-entry)
5464 (incf index)
5465 (format
5466 (if (zerop (mod index 2)) " [%s] %-26s"
5468 (funcall fontify-key
5469 (char-to-string (car sub-entry))
5470 top-key)
5471 (nth 1 sub-entry)))
5472 sub-menu "")
5474 backends ""))
5475 ;; Publishing menu is hard-coded.
5477 [%s] Current file [%s] Current project
5479 (funcall fontify-key "P")
5480 (funcall fontify-key "f" ?P)
5481 (funcall fontify-key "p" ?P)
5482 (funcall fontify-key "x" ?P)
5483 (funcall fontify-key "a" ?P))
5485 (format "\[%s] %s"
5486 (funcall fontify-key "q" t)
5487 (if first-key "Main menu" "Exit")))))
5488 ;; Build prompts for both standard and expert UI.
5489 (standard-prompt (unless expertp "Export command: "))
5490 (expert-prompt
5491 (when expertp
5492 (format
5493 "Export command (C-%s%s%s%s%s) [%s]: "
5494 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5495 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5496 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5497 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5498 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5499 (mapconcat (lambda (k)
5500 ;; Strip control characters.
5501 (unless (< k 27) (char-to-string k)))
5502 allowed-keys "")))))
5503 ;; With expert UI, just read key with a fancy prompt. In standard
5504 ;; UI, display an intrusive help buffer.
5505 (if expertp
5506 (org-export--dispatch-action
5507 expert-prompt allowed-keys backends options first-key expertp)
5508 ;; At first call, create frame layout in order to display menu.
5509 (unless (get-buffer "*Org Export Dispatcher*")
5510 (delete-other-windows)
5511 (org-switch-to-buffer-other-window
5512 (get-buffer-create "*Org Export Dispatcher*"))
5513 (setq cursor-type nil
5514 header-line-format "Use SPC, DEL, C-n or C-p to navigate.")
5515 ;; Make sure that invisible cursor will not highlight square
5516 ;; brackets.
5517 (set-syntax-table (copy-syntax-table))
5518 (modify-syntax-entry ?\[ "w"))
5519 ;; At this point, the buffer containing the menu exists and is
5520 ;; visible in the current window. So, refresh it.
5521 (with-current-buffer "*Org Export Dispatcher*"
5522 ;; Refresh help. Maintain display continuity by re-visiting
5523 ;; previous window position.
5524 (let ((pos (window-start)))
5525 (erase-buffer)
5526 (insert help)
5527 (set-window-start nil pos)))
5528 (org-fit-window-to-buffer)
5529 (org-export--dispatch-action
5530 standard-prompt allowed-keys backends options first-key expertp))))
5532 (defun org-export--dispatch-action
5533 (prompt allowed-keys backends options first-key expertp)
5534 "Read a character from command input and act accordingly.
5536 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5537 a list of characters available at a given step in the process.
5538 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5539 EXPERTP are the same as defined in `org-export--dispatch-ui',
5540 which see.
5542 Toggle export options when required. Otherwise, return value is
5543 a list with action as CAR and a list of interactive export
5544 options as CDR."
5545 (let (key)
5546 ;; Scrolling: when in non-expert mode, act on motion keys (C-n,
5547 ;; C-p, SPC, DEL).
5548 (while (and (setq key (read-char-exclusive prompt))
5549 (not expertp)
5550 (memq key '(14 16 ?\s ?\d)))
5551 (case key
5552 (14 (if (not (pos-visible-in-window-p (point-max)))
5553 (ignore-errors (scroll-up-line))
5554 (message "End of buffer")
5555 (sit-for 1)))
5556 (16 (if (not (pos-visible-in-window-p (point-min)))
5557 (ignore-errors (scroll-down-line))
5558 (message "Beginning of buffer")
5559 (sit-for 1)))
5560 (?\s (if (not (pos-visible-in-window-p (point-max)))
5561 (scroll-up nil)
5562 (message "End of buffer")
5563 (sit-for 1)))
5564 (?\d (if (not (pos-visible-in-window-p (point-min)))
5565 (scroll-down nil)
5566 (message "Beginning of buffer")
5567 (sit-for 1)))))
5568 (cond
5569 ;; Ignore undefined associations.
5570 ((not (memq key allowed-keys))
5571 (ding)
5572 (unless expertp (message "Invalid key") (sit-for 1))
5573 (org-export--dispatch-ui options first-key expertp))
5574 ;; q key at first level aborts export. At second
5575 ;; level, cancel first key instead.
5576 ((eq key ?q) (if (not first-key) (error "Export aborted")
5577 (org-export--dispatch-ui options nil expertp)))
5578 ;; Help key: Switch back to standard interface if
5579 ;; expert UI was active.
5580 ((eq key ??) (org-export--dispatch-ui options first-key nil))
5581 ;; Switch to asynchronous export stack.
5582 ((eq key ?&) '(stack))
5583 ;; Toggle export options
5584 ;; C-b (2) C-v (22) C-s (19) C-f (6) C-a (1)
5585 ((memq key '(2 22 19 6 1))
5586 (org-export--dispatch-ui
5587 (let ((option (case key (2 'body) (22 'visible) (19 'subtree)
5588 (6 'force) (1 'async))))
5589 (if (memq option options) (remq option options)
5590 (cons option options)))
5591 first-key expertp))
5592 ;; Action selected: Send key and options back to
5593 ;; `org-export-dispatch'.
5594 ((or first-key (functionp (nth 2 (assq key backends))))
5595 (cons (cond
5596 ((not first-key) (nth 2 (assq key backends)))
5597 ;; Publishing actions are hard-coded. Send a special
5598 ;; signal to `org-export-dispatch'.
5599 ((eq first-key ?P)
5600 (case key
5601 (?f 'publish-current-file)
5602 (?p 'publish-current-project)
5603 (?x 'publish-choose-project)
5604 (?a 'publish-all)))
5605 ;; Return first action associated to FIRST-KEY + KEY
5606 ;; path. Indeed, derived backends can share the same
5607 ;; FIRST-KEY.
5608 (t (catch 'found
5609 (mapc (lambda (backend)
5610 (let ((match (assq key (nth 2 backend))))
5611 (when match (throw 'found (nth 2 match)))))
5612 (member (assq first-key backends) backends)))))
5613 options))
5614 ;; Otherwise, enter sub-menu.
5615 (t (org-export--dispatch-ui options key expertp)))))
5619 (provide 'ox)
5621 ;; Local variables:
5622 ;; generated-autoload-file: "org-loaddefs.el"
5623 ;; End:
5625 ;;; ox.el ends here