| blob | 049dcc5ebca40ece59eb9c966345297d67f23132 |
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 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
22 ;;
23 ;; This library implements a generic export engine for Org, built on
24 ;; its syntactical parser: Org Elements.
25 ;;
26 ;; Besides that parser, the generic exporter is made of three distinct
27 ;; parts:
28 ;;
29 ;; - The communication channel consists in a property list, which is
30 ;; created and updated during the process. Its use is to offer
31 ;; every piece of information, would it be about initial environment
32 ;; or contextual data, all in a single place. The exhaustive list
33 ;; of properties is given in "The Communication Channel" section of
34 ;; this file.
35 ;;
36 ;; - The transcoder walks the parse tree, ignores or treat as plain
37 ;; text elements and objects according to export options, and
38 ;; eventually calls back-end specific functions to do the real
39 ;; transcoding, concatenating their return value along the way.
40 ;;
41 ;; - The filter system is activated at the very beginning and the very
42 ;; end of the export process, and each time an element or an object
43 ;; has been converted. It is the entry point to fine-tune standard
44 ;; output from back-end transcoders. See "The Filter System"
45 ;; section for more information.
46 ;;
47 ;; The core function is `org-export-as'. It returns the transcoded
48 ;; buffer as a string.
49 ;;
50 ;; An export back-end is defined with `org-export-define-backend',
51 ;; which defines one mandatory information: his translation table.
52 ;; Its value is an alist whose keys are elements and objects types and
53 ;; values translator functions. See function's docstring for more
54 ;; information about translators.
55 ;;
56 ;; Optionally, `org-export-define-backend' can also support specific
57 ;; buffer keywords, OPTION keyword's items and filters. Also refer to
58 ;; function documentation for more information.
59 ;;
60 ;; If the new back-end shares most properties with another one,
61 ;; `org-export-define-derived-backend' can be used to simplify the
62 ;; process.
63 ;;
64 ;; Any back-end can define its own variables. Among them, those
65 ;; customizable should belong to the `org-export-BACKEND' group.
66 ;;
67 ;; Tools for common tasks across back-ends are implemented in the
68 ;; following part of then file.
69 ;;
70 ;; Then, a wrapper macro for asynchronous export,
71 ;; `org-export-async-start', along with tools to display results. are
72 ;; given in the penultimate part.
73 ;;
74 ;; Eventually, a dispatcher (`org-export-dispatch') for standard
75 ;; back-ends is provided in the last one.
77 ;;; Code:
95 \f
96 ;;; Internal Variables
97 ;;
98 ;; Among internal variables, the most important is
99 ;; `org-export-options-alist'. This variable define the global export
100 ;; options, shared between every exporter, and how they are acquired.
145 "Alist between export properties and ways to set them.
147 The CAR of the alist is the property name, and the CDR is a list
148 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
150 KEYWORD is a string representing a buffer keyword, or nil. Each
151 property defined this way can also be set, during subtree
152 export, through an headline property named after the keyword
154 property).
155 OPTION is a string that could be found in an #+OPTIONS: line.
156 DEFAULT is the default value for the property.
157 BEHAVIOUR determines how Org should handle multiple keywords for
158 the same property. It is a symbol among:
159 nil Keep old value and discard the new one.
160 t Replace old value with the new one.
161 `space' Concatenate the values, separating them with a space.
162 `newline' Concatenate the values, separating them with
163 a newline.
164 `split' Split values at white spaces, and cons them to the
165 previous list.
167 Values set through KEYWORD and OPTION have precedence over
168 DEFAULT.
170 All these properties should be back-end agnostic. Back-end
171 specific properties are set through `org-export-define-backend'.
175 "List of in-buffer keywords that require special treatment.
176 These keywords are not directly associated to a property. The
177 way they are handled must be hard-coded into
238 "Alist between filters properties and initial values.
240 The key of each association is a property name accessible through
241 the communication channel. Its value is a configurable global
242 variable defining initial filters.
244 This list is meant to install user specified filters. Back-end
245 developers may install their own filters using
246 `org-export-define-backend'. Filters defined there will always
247 be prepended to the current list, so they always get applied
256 "Default rule for link matching an inline image.
257 This rule applies to links with no description. By default, it
258 will be considered as an inline image if it targets a local file
261 See `org-export-inline-image-p' for more information about
265 "Non-nil means asynchronous export process should leave data behind.
269 located in `temporary-file-directory'.
271 When non-nil, it will also set `debug-on-error' to a non-nil
275 "Record asynchronously generated export results and processes.
276 This is an alist: its CAR is the source of the
277 result (destination file or buffer for a finished process,
278 original buffer for a running one) and its CDR is a list
279 containing the back-end used, as a symbol, and either a process
280 or the time at which it finished. It is used to build the menu
284 "List of backends currently available in the exporter.
286 A backend is stored as a list where CAR is its name, as a symbol,
287 and CDR is a plist with the following properties:
288 `:filters-alist', `:menu-entry', `:options-alist' and
289 `:translate-alist'.
291 This variable is set with `org-export-define-backend' and
295 "Last command called from the dispatcher.
296 The value should be a list. Its CAR is the action, as a symbol,
300 \f
301 ;;; User-configurable Variables
302 ;;
303 ;; Configuration for the masses.
304 ;;
305 ;; They should never be accessed directly, as their value is to be
306 ;; stored in a property list (cf. `org-export-options-alist').
307 ;; Back-ends will read their value from there instead.
310 "Options for exporting Org mode files."
315 "General options for export engine."
320 "Whether sub-trees with the ARCHIVE tag should be exported.
322 This can have three different values:
323 nil Do not export, pretend this tree is not present.
324 t Do export the entire tree.
325 `headline' Only export the headline, but skip the tree below it.
327 This option can also be set with the #+OPTIONS line,
336 "Non-nil means insert author name into the exported file.
337 This option can also be set with the #+OPTIONS line,
343 "Non-nil means export CLOCK keywords.
344 This option can also be set with the #+OPTIONS line,
350 "Non-nil means the postamble should contain a creator sentence.
352 The sentence can be set in `org-export-creator-string' and
355 If the value is `comment' insert it as a comment."
363 "Non-nil means insert date in the exported document.
364 This options can also be set with the OPTIONS keyword,
370 emacs-version)
371 "String to insert at the end of the generated document."
376 "Non-nil means export contents of standard drawers.
378 When t, all drawers are exported. This may also be a list of
379 drawer names to export. If that list starts with `not', only
380 drawers with such names will be ignored.
382 This variable doesn't apply to properties drawers.
384 This option can also be set with the #+OPTIONS line,
395 :inline t
399 "Non-nil means insert author email into the exported file.
400 This option can also be set with the #+OPTIONS line,
406 "Non-nil means interpret *word*, /word/, _word_ and +word+.
408 If the export target supports emphasizing text, the word will be
409 typeset in bold, italic, with an underline or strike-through,
410 respectively.
417 "Tags that exclude a tree from export.
419 All trees carrying any of these tags will be excluded from
420 export. This is without condition, so even subtrees inside that
421 carry one of the `org-export-select-tags' will be removed.
423 This option can also be set with the #+EXCLUDE_TAGS: keyword."
430 This can be used to have pre-formatted text, fragments of code
431 etc. For example:
432 : ;; Some Lisp examples
433 : (while (defc cnt)
434 : (ding))
435 will be looking just like this in also HTML. See also the QUOTE
436 keyword. Not all export backends support this.
443 "Non-nil means Org footnotes should be exported.
444 This option can also be set with the #+OPTIONS line,
450 "Non-nil means process LaTeX environments and fragments.
452 This option can also be set with the +OPTIONS line,
455 nil Ignore math snippets.
456 `verbatim' Keep everything in verbatim.
457 t Allow export of math snippets."
465 "The last level which is still exported as a headline.
467 Inferior levels will produce itemize or enumerate lists when
468 exported.
475 "The default language for export and clocktable translations, as a string.
476 This may have an association in
477 `org-clock-clocktable-language-setup'."
482 "Non-nil means preserve all line breaks when exporting.
483 This option can also be set with the #+OPTIONS line,
489 "Non-nil means interpret entities when exporting.
492 Å.
494 For a list of supported names, see the constant `org-entities'
495 and the user option `org-entities-user'.
497 This option can also be set with the #+OPTIONS line,
503 "Non-nil means inlinetasks should be exported.
504 This option can also be set with the #+OPTIONS line,
510 "Non-nil means include planning info in export.
511 This option can also be set with the #+OPTIONS: line,
517 "Non-nil means include priority cookies in export.
518 This option can also be set with the #+OPTIONS line,
524 "Non-nil means add section numbers to headlines when exporting.
526 When set to an integer n, numbering will only happen for
527 headlines whose relative level is higher or equal to n.
529 This option can also be set with the #+OPTIONS line,
535 "Tags that select a tree for export.
537 If any such tag is found in a buffer, all trees that do not carry
538 one of these tags will be ignored during export. Inside trees
539 that are selected like this, you can still deselect a subtree by
540 tagging it with one of the `org-export-exclude-tags'.
542 This option can also be set with the #+SELECT_TAGS: keyword."
547 "Non-nil means activate smart quotes during export.
548 This option can also be set with the #+OPTIONS: line,
556 When this option is turned on, these strings will be exported as:
558 Org HTML LaTeX UTF-8
559 -----+----------+--------+-------
561 -- – -- –
562 --- — --- —
565 This option can also be set with the #+OPTIONS line,
571 "Non-nil means include statistics cookies in export.
572 This option can also be set with the #+OPTIONS: line,
580 When this option is turned on, you can use TeX-like syntax for
582 will be considered as a single item - so grouping with {} is
583 normally not needed. For example, the following things will be
584 parsed as single sub- or superscripts.
586 10^24 or 10^tau several digits will be considered 1 item.
587 10^-12 or 10^-tau a leading sign with digits or a word
588 x^2-y^3 will be read as x^2 - y^3, because items are
589 terminated by almost any nonword/nondigit char.
590 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
592 Still, ambiguity is possible - so when in doubt use {} to enclose
593 the sub/superscript. If you set this variable to the symbol
594 `{}', the braces are *required* in order to trigger
595 interpretations as sub/superscript. This can be helpful in
598 This option can also be set with the #+OPTIONS line,
607 "Non-nil means create a table of contents in exported files.
609 The TOC contains headlines with levels up
610 to`org-export-headline-levels'. When an integer, include levels
611 up to N in the toc, this may then be different from
612 `org-export-headline-levels', but it will not be allowed to be
613 larger than the number of headline levels. When nil, no table of
614 contents is made.
616 This option can also be set with the #+OPTIONS line,
626 For example:
628 | Name | Address | Birthday |
629 |-------------+----------+-----------|
630 | Arthur Dent | England | 29.2.2100 |
637 "If nil, do not export tags, just remove them from headlines.
639 If this is the symbol `not-in-toc', tags will be removed from
640 table of contents entries, but still be shown in the headlines of
641 the document.
643 This option can also be set with the #+OPTIONS line,
652 "Non-nil means include TODO items for export.
654 This may have the following values:
655 t include tasks independent of state.
656 `todo' include only tasks that are not yet done.
657 `done' include only tasks that are already done.
658 nil ignore all tasks.
659 list of keywords include tasks with these keywords.
661 This option can also be set with the #+OPTIONS line,
673 "Non-nil means insert a time stamp into the exported file.
674 The time stamp shows when the file was created.
676 This option can also be set with the #+OPTIONS line,
682 "Non nil means allow timestamps in export.
684 It can be set to `active', `inactive', t or nil, in order to
685 export, respectively, only active timestamps, only inactive ones,
686 all of them or none.
688 This option can also be set with the #+OPTIONS line, e.g.
698 "Non-nil means include TODO keywords in export.
699 When nil, remove all these keywords from the export."
704 "Non-nil means BIND keywords can define local variable values.
705 This is a potential security risk, which is why the default value
706 is nil. You can also allow them through local buffer variables."
711 "Alist between export snippets back-ends and exporter back-ends.
713 This variable allows to provide shortcuts for export snippets.
717 HTML code while every other back-end will ignore it."
724 "Coding system for the exported file."
729 "Non-nil means exported stuff will also be pushed onto the kill ring."
734 "The initial scope when exporting with `org-export-dispatch'.
735 This variable can be either set to `buffer' or `subtree'."
742 "Non-nil means show buffer after exporting to temp buffer.
743 When Org exports to a file, the buffer visiting that file is ever
744 shown, but remains buried. However, when exporting to
745 a temporary buffer, that buffer is popped up in a second window.
746 When this variable is nil, the buffer remains buried also in
747 these cases."
752 "Non-nil means export and publishing commands will run in background.
753 Results from an asynchronous export are never displayed
759 "File used to initialize external export process.
760 Value must be an absolute file name. It defaults to user's
761 initialization file. Though, a specific configuration makes the
762 process faster and the export more portable."
767 "List of back-ends that shouldn't appear in the dispatcher.
769 Any back-end belonging to this list or derived from a back-end
770 belonging to it will not appear in the dispatcher menu.
772 Indeed, Org may require some export back-ends without notice. If
773 these modules are never to be used interactively, adding them
774 here will avoid cluttering the dispatcher menu."
779 "Non-nil means using a non-intrusive `org-export-dispatch'.
780 In that case, no help buffer is displayed. Though, an indicator
786 asynchronous). Also, \[?] allows to switch back to standard
787 mode."
792 \f
793 ;;; Defining Back-ends
794 ;;
795 ;; `org-export-define-backend' is the standard way to define an export
796 ;; back-end. It allows to specify translators, filters, buffer
797 ;; options and a menu entry. If the new back-end shares translators
798 ;; with another back-end, `org-export-define-derived-backend' may be
799 ;; used instead.
800 ;;
801 ;; Internally, a back-end is stored as a list, of which CAR is the
802 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
803 ;; properties of a given back-end are: `org-export-backend-filters',
804 ;; `org-export-backend-menu', `org-export-backend-options' and
805 ;; `org-export-backend-translate-table'.
806 ;;
807 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
808 ;; when a given back-end hasn't been registered yet.
811 "Define a new back-end BACKEND.
813 TRANSLATORS is an alist between object or element types and
814 functions handling them.
816 These functions should return a string without any trailing
817 space, or nil. They must accept three arguments: the object or
818 element itself, its contents or nil when it isn't recursive and
819 the property list used as a communication channel.
821 Contents, when not nil, are stripped from any global indentation
822 \(although the relative one is preserved). They also always end
823 with a single newline character.
825 If, for a given type, no function is found, that element or
826 object type will simply be ignored, along with any blank line or
827 white space at its end. The same will happen if the function
828 returns the nil value. If that function returns the empty
829 string, the type will be ignored, but the blank lines or white
830 spaces will be kept.
832 In addition to element and object types, one function can be
833 associated to the `template' (or `inner-template') symbol and
834 another one to the `plain-text' symbol.
836 The former returns the final transcoded string, and can be used
837 to add a preamble and a postamble to document's body. It must
838 accept two arguments: the transcoded string and the property list
839 containing export options. A function associated to `template'
841 A function associated to `inner-template' is always applied.
843 The latter, when defined, is to be called on every text not
844 recognized as an element or an object. It must accept two
845 arguments: the text string and the information channel. It is an
846 appropriate place to protect special chars relative to the
847 back-end.
849 BODY can start with pre-defined keyword arguments. The following
850 keywords are understood:
852 :export-block
854 String, or list of strings, representing block names that
855 will not be parsed. This is used to specify blocks that will
856 contain raw code specific to the back-end. These blocks
857 still have to be handled by the relative `export-block' type
858 translator.
860 :filters-alist
862 Alist between filters and function, or list of functions,
863 specific to the back-end. See `org-export-filters-alist' for
864 a list of all allowed filters. Filters defined here
865 shouldn't make a back-end test, as it may prevent back-ends
866 derived from this one to behave properly.
868 :menu-entry
870 Menu entry for the export dispatcher. It should be a list
871 like:
873 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
875 where :
877 KEY is a free character selecting the back-end.
879 DESCRIPTION-OR-ORDINAL is either a string or a number.
881 If it is a string, is will be used to name the back-end in
882 its menu entry. If it is a number, the following menu will
883 be displayed as a sub-menu of the back-end with the same
884 KEY. Also, the number will be used to determine in which
885 order such sub-menus will appear (lowest first).
887 ACTION-OR-MENU is either a function or an alist.
889 If it is an action, it will be called with four
890 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
891 BODY-ONLY. See `org-export-as' for further explanations on
892 some of them.
894 If it is an alist, associations should follow the
895 pattern:
897 \(KEY DESCRIPTION ACTION)
899 where KEY, DESCRIPTION and ACTION are described above.
901 Valid values include:
905 or
910 \(lambda (a s v b)
911 \(if a (org-latex-export-to-pdf t s v b)
912 \(org-open-file
913 \(org-latex-export-to-pdf nil s v b)))))))
915 or the following, which will be added to the previous
916 sub-menu,
918 \(?l 1
922 :options-alist
924 Alist between back-end specific properties introduced in
925 communication channel and how their value are acquired. See
926 `org-export-options-alist' for more information about
927 structure of the values."
946 ;; Register back-end.
950 ;; Tell parser to not parse EXPORT-BLOCK blocks.
957 ;; Splice in the body, if any.
961 "Create a new back-end as a variant of an existing one.
963 CHILD is the name of the derived back-end. PARENT is the name of
964 the parent back-end.
966 BODY can start with pre-defined keyword arguments. The following
967 keywords are understood:
969 :export-block
971 String, or list of strings, representing block names that
972 will not be parsed. This is used to specify blocks that will
973 contain raw code specific to the back-end. These blocks
974 still have to be handled by the relative `export-block' type
975 translator.
977 :filters-alist
979 Alist of filters that will overwrite or complete filters
980 defined in PARENT back-end. See `org-export-filters-alist'
981 for a list of allowed filters.
983 :menu-entry
985 Menu entry for the export dispatcher. See
986 `org-export-define-backend' for more information about the
987 expected value.
989 :options-alist
991 Alist of back-end specific properties that will overwrite or
992 complete those defined in PARENT back-end. Refer to
993 `org-export-options-alist' for more information about
994 structure of the values.
996 :translate-alist
998 Alist of element and object types and transcoders that will
999 overwrite or complete transcode table from PARENT back-end.
1000 Refer to `org-export-define-backend' for detailed information
1001 about transcoders.
1004 as a variant of `latex' back-end with a custom template function:
1006 \(org-export-define-derived-backend my-latex latex
1007 :translate-alist ((template . my-latex-template-fun)))
1009 The back-end could then be called with, for example:
1037 ;; Register back-end.
1041 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1048 ;; Splice in the body, if any.
1052 "Return back-end from which BACKEND is derived, or nil."
1056 "Return filters for BACKEND."
1061 "Return menu entry for BACKEND."
1066 "Return export options for BACKEND."
1071 "Return translate table for BACKEND."
1076 "Signal an error if BACKEND isn't defined."
1081 "Non-nil if BACKEND is derived from one of BACKENDS."
1085 parent))
1088 \f
1089 ;;; The Communication Channel
1090 ;;
1091 ;; During export process, every function has access to a number of
1092 ;; properties. They are of two types:
1093 ;;
1094 ;; 1. Environment options are collected once at the very beginning of
1095 ;; the process, out of the original buffer and configuration.
1096 ;; Collecting them is handled by `org-export-get-environment'
1097 ;; function.
1098 ;;
1099 ;; Most environment options are defined through the
1100 ;; `org-export-options-alist' variable.
1101 ;;
1102 ;; 2. Tree properties are extracted directly from the parsed tree,
1103 ;; just before export, by `org-export-collect-tree-properties'.
1104 ;;
1105 ;; Here is the full list of properties available during transcode
1106 ;; process, with their category and their value type.
1107 ;;
1108 ;; + `:author' :: Author's name.
1109 ;; - category :: option
1110 ;; - type :: string
1111 ;;
1112 ;; + `:back-end' :: Current back-end used for transcoding.
1113 ;; - category :: tree
1114 ;; - type :: symbol
1115 ;;
1116 ;; + `:creator' :: String to write as creation information.
1117 ;; - category :: option
1118 ;; - type :: string
1119 ;;
1120 ;; + `:date' :: String to use as date.
1121 ;; - category :: option
1122 ;; - type :: string
1123 ;;
1124 ;; + `:description' :: Description text for the current data.
1125 ;; - category :: option
1126 ;; - type :: string
1127 ;;
1128 ;; + `:email' :: Author's email.
1129 ;; - category :: option
1130 ;; - type :: string
1131 ;;
1132 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1133 ;; process.
1134 ;; - category :: option
1135 ;; - type :: list of strings
1136 ;;
1137 ;; + `:exported-data' :: Hash table used for memoizing
1138 ;; `org-export-data'.
1139 ;; - category :: tree
1140 ;; - type :: hash table
1141 ;;
1142 ;; + `:filetags' :: List of global tags for buffer. Used by
1143 ;; `org-export-get-tags' to get tags with inheritance.
1144 ;; - category :: option
1145 ;; - type :: list of strings
1146 ;;
1147 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1148 ;; their definition, as parsed data. Only non-inlined footnotes
1149 ;; are represented in this alist. Also, every definition isn't
1150 ;; guaranteed to be referenced in the parse tree. The purpose of
1151 ;; this property is to preserve definitions from oblivion
1152 ;; (i.e. when the parse tree comes from a part of the original
1153 ;; buffer), it isn't meant for direct use in a back-end. To
1154 ;; retrieve a definition relative to a reference, use
1155 ;; `org-export-get-footnote-definition' instead.
1156 ;; - category :: option
1157 ;; - type :: alist (STRING . LIST)
1158 ;;
1159 ;; + `:headline-levels' :: Maximum level being exported as an
1160 ;; headline. Comparison is done with the relative level of
1161 ;; headlines in the parse tree, not necessarily with their
1162 ;; actual level.
1163 ;; - category :: option
1164 ;; - type :: integer
1165 ;;
1166 ;; + `:headline-offset' :: Difference between relative and real level
1167 ;; of headlines in the parse tree. For example, a value of -1
1168 ;; means a level 2 headline should be considered as level
1169 ;; 1 (cf. `org-export-get-relative-level').
1170 ;; - category :: tree
1171 ;; - type :: integer
1172 ;;
1173 ;; + `:headline-numbering' :: Alist between headlines and their
1174 ;; numbering, as a list of numbers
1175 ;; (cf. `org-export-get-headline-number').
1176 ;; - category :: tree
1177 ;; - type :: alist (INTEGER . LIST)
1178 ;;
1179 ;; + `:id-alist' :: Alist between ID strings and destination file's
1180 ;; path, relative to current directory. It is used by
1181 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1182 ;; external file.
1183 ;; - category :: option
1184 ;; - type :: alist (STRING . STRING)
1185 ;;
1186 ;; + `:ignore-list' :: List of elements and objects that should be
1187 ;; ignored during export.
1188 ;; - category :: tree
1189 ;; - type :: list of elements and objects
1190 ;;
1191 ;; + `:input-file' :: Full path to input file, if any.
1192 ;; - category :: option
1193 ;; - type :: string or nil
1194 ;;
1195 ;; + `:keywords' :: List of keywords attached to data.
1196 ;; - category :: option
1197 ;; - type :: string
1198 ;;
1199 ;; + `:language' :: Default language used for translations.
1200 ;; - category :: option
1201 ;; - type :: string
1202 ;;
1203 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1204 ;; transcoding.
1205 ;; - category :: option
1206 ;; - type :: list (as returned by `org-element-parse-buffer')
1207 ;;
1208 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1209 ;; all line breaks.
1210 ;; - category :: option
1211 ;; - type :: symbol (nil, t)
1212 ;;
1213 ;; + `:section-numbers' :: Non-nil means transcoding should add
1214 ;; section numbers to headlines.
1215 ;; - category :: option
1216 ;; - type :: symbol (nil, t)
1217 ;;
1218 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1219 ;; in transcoding. When such a tag is present, subtrees without
1220 ;; it are de facto excluded from the process. See
1221 ;; `use-select-tags'.
1222 ;; - category :: option
1223 ;; - type :: list of strings
1224 ;;
1225 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1226 ;; a time stamp in the output.
1227 ;; - category :: option
1228 ;; - type :: symbol (nil, t)
1229 ;;
1230 ;; + `:translate-alist' :: Alist between element and object types and
1231 ;; transcoding functions relative to the current back-end.
1232 ;; Special keys `inner-template', `template' and `plain-text' are
1233 ;; also possible.
1234 ;; - category :: option
1235 ;; - type :: alist (SYMBOL . FUNCTION)
1236 ;;
1237 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1238 ;; also be transcoded. If it is set to the `headline' symbol,
1239 ;; only the archived headline's name is retained.
1240 ;; - category :: option
1241 ;; - type :: symbol (nil, t, `headline')
1242 ;;
1243 ;; + `:with-author' :: Non-nil means author's name should be included
1244 ;; in the output.
1245 ;; - category :: option
1246 ;; - type :: symbol (nil, t)
1247 ;;
1248 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1249 ;; - category :: option
1250 ;; - type :: symbol (nil, t)
1251 ;;
1252 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1253 ;; inserted at the end of the transcoded string. If the value
1254 ;; is `comment', it should be commented.
1255 ;; - category :: option
1256 ;; - type :: symbol (`comment', nil, t)
1257 ;;
1258 ;; + `:with-date' :: Non-nil means output should contain a date.
1259 ;; - category :: option
1260 ;; - type :. symbol (nil, t)
1261 ;;
1262 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1263 ;; its value is a list of names, only drawers with such names
1264 ;; will be transcoded. If that list starts with `not', drawer
1265 ;; with these names will be skipped.
1266 ;; - category :: option
1267 ;; - type :: symbol (nil, t) or list of strings
1268 ;;
1269 ;; + `:with-email' :: Non-nil means output should contain author's
1270 ;; email.
1271 ;; - category :: option
1272 ;; - type :: symbol (nil, t)
1273 ;;
1274 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1275 ;; interpreted.
1276 ;; - category :: option
1277 ;; - type :: symbol (nil, t)
1278 ;;
1279 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1280 ;; strings starting with a colon as a fixed-with (verbatim) area.
1281 ;; - category :: option
1282 ;; - type :: symbol (nil, t)
1283 ;;
1284 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1285 ;; footnotes.
1286 ;; - category :: option
1287 ;; - type :: symbol (nil, t)
1288 ;;
1289 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1290 ;; `latex-fragment' objects should appear in export output. When
1291 ;; this property is set to `verbatim', they will be left as-is.
1292 ;; - category :: option
1293 ;; - type :: symbol (`verbatim', nil, t)
1294 ;;
1295 ;; + `:with-plannings' :: Non-nil means transcoding should include
1296 ;; planning info.
1297 ;; - category :: option
1298 ;; - type :: symbol (nil, t)
1299 ;;
1300 ;; + `:with-priority' :: Non-nil means transcoding should include
1301 ;; priority cookies.
1302 ;; - category :: option
1303 ;; - type :: symbol (nil, t)
1304 ;;
1305 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1306 ;; plain text.
1307 ;; - category :: option
1308 ;; - type :: symbol (nil, t)
1309 ;;
1310 ;; + `:with-special-strings' :: Non-nil means transcoding should
1311 ;; interpret special strings in plain text.
1312 ;; - category :: option
1313 ;; - type :: symbol (nil, t)
1314 ;;
1315 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1316 ;; interpret subscript and superscript. With a value of "{}",
1317 ;; only interpret those using curly brackets.
1318 ;; - category :: option
1319 ;; - type :: symbol (nil, {}, t)
1320 ;;
1321 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1322 ;; tables.
1323 ;; - category :: option
1324 ;; - type :: symbol (nil, t)
1325 ;;
1326 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1327 ;; headlines. A `not-in-toc' value will remove them from the
1328 ;; table of contents, if any, nonetheless.
1329 ;; - category :: option
1330 ;; - type :: symbol (nil, t, `not-in-toc')
1331 ;;
1332 ;; + `:with-tasks' :: Non-nil means transcoding should include
1333 ;; headlines with a TODO keyword. A `todo' value will only
1334 ;; include headlines with a todo type keyword while a `done'
1335 ;; value will do the contrary. If a list of strings is provided,
1336 ;; only tasks with keywords belonging to that list will be kept.
1337 ;; - category :: option
1338 ;; - type :: symbol (t, todo, done, nil) or list of strings
1339 ;;
1340 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1341 ;; time stamps. Special value `active' (resp. `inactive') ask to
1342 ;; export only active (resp. inactive) timestamps. Otherwise,
1343 ;; completely remove them.
1344 ;; - category :: option
1345 ;; - type :: symbol: (`active', `inactive', t, nil)
1346 ;;
1347 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1348 ;; added to the output. An integer value limits its depth.
1349 ;; - category :: option
1350 ;; - type :: symbol (nil, t or integer)
1351 ;;
1352 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1353 ;; include TODO keywords.
1354 ;; - category :: option
1355 ;; - type :: symbol (nil, t)
1358 ;;;; Environment Options
1359 ;;
1360 ;; Environment options encompass all parameters defined outside the
1361 ;; scope of the parsed data. They come from five sources, in
1362 ;; increasing precedence order:
1363 ;;
1364 ;; - Global variables,
1365 ;; - Buffer's attributes,
1366 ;; - Options keyword symbols,
1367 ;; - Buffer keywords,
1368 ;; - Subtree properties.
1369 ;;
1370 ;; The central internal function with regards to environment options
1371 ;; is `org-export-get-environment'. It updates global variables with
1372 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1373 ;; the different sources.
1374 ;;
1375 ;; The internal functions doing the retrieval are:
1376 ;; `org-export--get-global-options',
1377 ;; `org-export--get-buffer-attributes',
1378 ;; `org-export--parse-option-keyword',
1379 ;; `org-export--get-subtree-options' and
1380 ;; `org-export--get-inbuffer-options'
1381 ;;
1382 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1383 ;; relative to "#+BIND:" keywords.
1386 "Collect export options from the current buffer.
1388 Optional argument BACKEND is a symbol specifying which back-end
1389 specific options to read, if any.
1391 When optional argument SUBTREEP is non-nil, assume the export is
1392 done against the current sub-tree.
1394 Third optional argument EXT-PLIST is a property list with
1395 external parameters overriding Org default settings, but still
1396 inferior to file-local settings."
1397 ;; First install #+BIND variables.
1399 ;; Get and prioritize export options...
1401 ;; ... from global variables...
1403 ;; ... from an external property list...
1404 ext-plist
1405 ;; ... from in-buffer settings...
1407 backend
1409 ;; ... and from subtree, when appropriate.
1411 ;; Eventually add misc. properties.
1413 :back-end
1414 backend
1415 :translate-alist
1417 :footnote-definition-alist
1418 ;; Footnotes definitions must be collected in the original
1419 ;; buffer, as there's no insurance that they will still be in
1420 ;; the parse tree, due to possible narrowing.
1434 alist))))
1435 alist))
1436 :id-alist
1437 ;; Collect id references.
1448 alist))))
1451 "Parse an OPTIONS line and return values as a plist.
1452 Optional argument BACKEND is a symbol specifying which back-end
1453 specific items to read, if any."
1455 ;; Priority is given to back-end specific options.
1457 org-export-options-alist))
1458 plist)
1467 options))
1469 property
1472 plist))
1475 "Get export options in subtree at point.
1476 Optional argument BACKEND is a symbol specifying back-end used
1477 for export. Return options as a plist."
1478 ;; For each buffer keyword, create an headline property setting the
1479 ;; same property in communication channel. The name for the property
1480 ;; is the keyword with "EXPORT_" appended to it.
1483 ;; Make sure point is at an heading.
1485 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1486 ;; title as its fallback value.
1492 plist :title
1495 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1499 ;; Handle other keywords. TITLE keyword is excluded as it has
1500 ;; been handled already.
1508 ;; Export properties are not case-sensitive.
1515 plist
1516 property
1518 ;; Parse VALUE if required.
1522 ;; If BEHAVIOUR is `split' expected value is
1523 ;; a list of strings, not a string.
1526 ;; Look for both general keywords and back-end specific
1527 ;; options, with priority given to the latter.
1529 org-export-options-alist)))
1530 ;; Return value.
1531 plist)))
1534 "Return current buffer export options, as a plist.
1536 Optional argument BACKEND, when non-nil, is a symbol specifying
1537 which back-end specific options should also be read in the
1538 process.
1540 Optional argument FILES is a list of setup files names read so
1541 far, used to avoid circular dependencies.
1543 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1547 ;; 1. Special keywords, as in `org-export-special-keywords'.
1561 ;; Avoid circular dependencies.
1576 ;; 2. Standard options, as in `org-export-options-alist'.
1578 ;; Priority is given to back-end specific options.
1580 org-export-options-alist)))
1595 ;; Handle value depending on specified
1596 ;; BEHAVIOUR.
1601 " "
1613 ;; Parse keywords specified in
1614 ;; `org-element-document-properties'.
1617 ;; Find the property associated to the keyword.
1622 all)))
1627 plist prop
1630 org-element-document-properties))
1631 ;; 3. Return final value.
1632 plist)))
1635 "Return properties related to buffer attributes, as a plist."
1638 ;; Store full path of input file name, or nil. For internal use.
1639 :input-file visited-file
1646 "Return global export options as a plist.
1648 Optional argument BACKEND, if non-nil, is a symbol specifying
1649 which back-end specific export options should also be read in the
1650 process."
1652 ;; Priority is given to back-end specific options.
1654 org-export-options-alist))
1655 plist)
1662 plist
1663 prop
1664 ;; Eval default value provided. If keyword is a member
1665 ;; of `org-element-document-properties', parse it as
1666 ;; a secondary string before storing it.
1671 value
1674 all)
1675 ;; Return value.
1676 plist))
1679 "Install the values from #+BIND lines as local variables.
1680 Variables must be installed before in-buffer options are
1681 retrieved."
1696 ;;;; Tree Properties
1697 ;;
1698 ;; Tree properties are information extracted from parse tree. They
1699 ;; are initialized at the beginning of the transcoding process by
1700 ;; `org-export-collect-tree-properties'.
1701 ;;
1702 ;; Dedicated functions focus on computing the value of specific tree
1703 ;; properties during initialization. Thus,
1704 ;; `org-export--populate-ignore-list' lists elements and objects that
1705 ;; should be skipped during export, `org-export--get-min-level' gets
1706 ;; the minimal exportable level, used as a basis to compute relative
1707 ;; level for headlines. Eventually
1708 ;; `org-export--collect-headline-numbering' builds an alist between
1709 ;; headlines and their numbering.
1712 "Extract tree properties from parse tree.
1714 DATA is the parse tree from which information is retrieved. INFO
1715 is a list holding export options.
1717 Following tree properties are set or updated:
1719 `:exported-data' Hash table used to memoize results from
1720 `org-export-data'.
1722 `:footnote-definition-alist' List of footnotes definitions in
1723 original buffer and current parse tree.
1725 `:headline-offset' Offset between true level of headlines and
1726 local level. An offset of -1 means an headline
1727 of level 2 should be considered as a level
1728 1 headline in the context.
1730 `:headline-numbering' Alist of all headlines as key an the
1731 associated numbering as value.
1733 `:ignore-list' List of elements that should be ignored during
1734 export.
1736 Return updated plist."
1737 ;; Install the parse tree in the communication channel, in order to
1738 ;; use `org-export-get-genealogy' and al.
1740 ;; Get the list of elements and objects to ignore, and put it into
1741 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1742 ;; been done during parse tree filtering.
1745 :ignore-list
1748 ;; Compute `:headline-offset' in order to be able to use
1749 ;; `org-export-get-relative-level'.
1752 :headline-offset
1754 ;; Update footnotes definitions list with definitions in parse tree.
1755 ;; This is required since buffer expansion might have modified
1756 ;; boundaries of footnote definitions contained in the parse tree.
1757 ;; This way, definitions in `footnote-definition-alist' are bound to
1758 ;; match those in the parse tree.
1764 defs)))
1766 ;; Properties order doesn't matter: get the rest of the tree
1767 ;; properties.
1771 info))
1774 "Return minimum exportable headline's level in DATA.
1775 DATA is parsed tree as returned by `org-element-parse-buffer'.
1776 OPTIONS is a plist holding export options."
1787 ;; If no headline was found, for the sake of consistency, set
1788 ;; minimum level to 1 nonetheless.
1792 "Return numbering of all exportable headlines in a parse tree.
1794 DATA is the parse tree. OPTIONS is the plist holding export
1795 options.
1797 Return an alist whose key is an headline and value is its
1798 associated numbering \(in the shape of a list of numbers\) or nil
1799 for a footnotes section."
1807 headline
1809 for idx from 0 to org-export-max-depth
1813 options)))
1816 "Return list of elements and objects to ignore during export.
1817 DATA is the parse tree to traverse. OPTIONS is the plist holding
1818 export options."
1820 walk-data
1821 ;; First find trees containing a select tag, if any.
1825 ;; Collect ignored elements or objects into IGNORE-LIST.
1831 ;; If headline is archived but tree below has
1832 ;; to be skipped, add it to ignore list.
1835 ;; Move into secondary string, if any.
1840 ;; Move into recursive objects/elements.
1842 ;; Main call.
1844 ;; Return value.
1845 ignore))
1848 "Return list of headlines containing a select tag in their tree.
1849 DATA is parsed data as returned by `org-element-parse-buffer'.
1850 INFO is a plist holding export options."
1852 walk-data ; for byte-compiler.
1863 ;; When a select tag is found, mark full
1864 ;; genealogy and every headline within the tree
1865 ;; as acceptable.
1868 genealogy
1870 selected-trees))
1871 ;; Else, continue searching in tree, recursively.
1878 "Non-nil when element or object BLOB should be skipped during export.
1879 OPTIONS is the plist holding export options. SELECTED, when
1880 non-nil, is a list of headlines belonging to a tree with a select
1881 tag."
1888 ;; If `:with-drawers' value starts with `not', ignore
1889 ;; every drawer whose name belong to that list.
1890 ;; Otherwise, ignore drawers whose name isn't in that
1891 ;; list.
1903 ;; Ignore subtrees with an exclude tag.
1906 ;; When a select tag is present in the buffer, ignore any tree
1907 ;; without it.
1909 ;; Ignore commented sub-trees.
1911 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1913 ;; Ignore tasks, if specified by `:with-tasks' property.
1930 ;; No timestamp allowed.
1932 ;; Only active timestamps allowed and the current one isn't
1933 ;; active.
1937 ;; Only inactive timestamps allowed and the current one isn't
1938 ;; inactive.
1944 \f
1945 ;;; The Transcoder
1946 ;;
1947 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1948 ;; `org-element-parse-buffer') and transcodes it into a specified
1949 ;; back-end output. It takes care of filtering out elements or
1950 ;; objects according to export options and organizing the output blank
1951 ;; lines and white space are preserved. The function memoizes its
1952 ;; results, so it is cheap to call it within translators.
1953 ;;
1954 ;; It is possible to modify locally the back-end used by
1955 ;; `org-export-data' or even use a temporary back-end by using
1956 ;; `org-export-data-with-translations' and
1957 ;; `org-export-data-with-backend'.
1958 ;;
1959 ;; Internally, three functions handle the filtering of objects and
1960 ;; elements during the export. In particular,
1961 ;; `org-export-ignore-element' marks an element or object so future
1962 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1963 ;; elements or objects should be seen as real Org syntax and
1964 ;; `org-export-expand' transforms the others back into their original
1965 ;; shape
1966 ;;
1967 ;; `org-export-transcoder' is an accessor returning appropriate
1968 ;; translator function for a given element or object.
1971 "Return appropriate transcoder for BLOB.
1972 INFO is a plist containing export directives."
1974 ;; Return contents only for complete parse trees.
1980 "Convert DATA into current back-end format.
1982 DATA is a parse tree, an element or an object or a secondary
1983 string. INFO is a plist holding export options.
1985 Return transcoded string."
1991 ;; Ignored element/object.
1993 ;; Plain text.
1999 info))
2000 ;; Uninterpreted element/object: change it back to Org
2001 ;; syntax and export again resulting raw string.
2005 data
2009 info))
2010 ;; Secondary string.
2013 ;; Element/Object without contents or, as a special case,
2014 ;; headline with archive tag and archived trees restricted
2015 ;; to title only.
2023 ;; Element/Object with contents.
2036 ;; Elements directly containing objects
2037 ;; must have their indentation normalized
2038 ;; first.
2040 data
2041 ;; When normalizing contents of the first
2042 ;; paragraph in an item or a footnote
2043 ;; definition, ignore first line's
2044 ;; indentation: there is none and it
2045 ;; might be misleading.
2050 data)
2057 info))))))))
2058 ;; Final result will be memoized before being returned.
2060 data
2064 ;; Append the same white space between elements or objects as in
2065 ;; the original buffer, and call appropriate filters.
2076 info)))
2077 results)))
2081 "Convert DATA into another format using a given translation table.
2082 DATA is an element, an object, a secondary string or a string.
2083 TRANSLATIONS is an alist between element or object types and
2084 a functions handling them. See `org-export-define-backend' for
2085 more information. INFO is a plist used as a communication
2086 channel."
2088 data
2089 ;; Set-up a new communication channel with TRANSLATIONS as the
2090 ;; translate table and a new hash table for memoization.
2092 info
2094 ;; Size of the hash table is reduced since this function
2095 ;; will probably be used on short trees.
2099 "Convert DATA into BACKEND format.
2101 DATA is an element, an object, a secondary string or a string.
2102 BACKEND is a symbol. INFO is a plist used as a communication
2103 channel.
2105 Unlike to `org-export-with-backend', this function will
2106 recursively convert DATA using BACKEND translation table."
2112 "Non-nil if element or object BLOB should be interpreted during export.
2113 If nil, BLOB will appear as raw Org syntax. Check is done
2114 according to export options INFO, stored as a plist."
2116 ;; ... entities...
2118 ;; ... emphasis...
2121 ;; ... fixed-width areas.
2123 ;; ... footnotes...
2126 ;; ... LaTeX environments and fragments...
2130 ;; ... sub/superscripts...
2136 ;; ... tables...
2141 "Expand a parsed element or object to its original state.
2142 BLOB is either an element or an object. CONTENTS is its
2143 contents, as a string or nil."
2146 blob contents))
2149 "Add ELEMENT to `:ignore-list' in INFO.
2151 Any element in `:ignore-list' will be skipped when using
2152 `org-element-map'. INFO is modified by side effects."
2156 \f
2157 ;;; The Filter System
2158 ;;
2159 ;; Filters allow end-users to tweak easily the transcoded output.
2160 ;; They are the functional counterpart of hooks, as every filter in
2161 ;; a set is applied to the return value of the previous one.
2162 ;;
2163 ;; Every set is back-end agnostic. Although, a filter is always
2164 ;; called, in addition to the string it applies to, with the back-end
2165 ;; used as argument, so it's easy for the end-user to add back-end
2166 ;; specific filters in the set. The communication channel, as
2167 ;; a plist, is required as the third argument.
2168 ;;
2169 ;; From the developer side, filters sets can be installed in the
2170 ;; process with the help of `org-export-define-backend', which
2171 ;; internally stores filters as an alist. Each association has a key
2172 ;; among the following symbols and a function or a list of functions
2173 ;; as value.
2174 ;;
2175 ;; - `:filter-options' applies to the property list containing export
2176 ;; options. Unlike to other filters, functions in this list accept
2177 ;; two arguments instead of three: the property list containing
2178 ;; export options and the back-end. Users can set its value through
2179 ;; `org-export-filter-options-functions' variable.
2180 ;;
2181 ;; - `:filter-parse-tree' applies directly to the complete parsed
2182 ;; tree. Users can set it through
2183 ;; `org-export-filter-parse-tree-functions' variable.
2184 ;;
2185 ;; - `:filter-final-output' applies to the final transcoded string.
2186 ;; Users can set it with `org-export-filter-final-output-functions'
2187 ;; variable
2188 ;;
2189 ;; - `:filter-plain-text' applies to any string not recognized as Org
2190 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2191 ;; configure it.
2192 ;;
2193 ;; - `:filter-TYPE' applies on the string returned after an element or
2194 ;; object of type TYPE has been transcoded. An user can modify
2195 ;; `org-export-filter-TYPE-functions'
2196 ;;
2197 ;; All filters sets are applied with
2198 ;; `org-export-filter-apply-functions' function. Filters in a set are
2199 ;; applied in a LIFO fashion. It allows developers to be sure that
2200 ;; their filters will be applied first.
2201 ;;
2202 ;; Filters properties are installed in communication channel with
2203 ;; `org-export-install-filters' function.
2204 ;;
2205 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2206 ;; `org-export-before-parsing-hook') are run at the beginning of the
2207 ;; export process and just before parsing to allow for heavy structure
2208 ;; modifications.
2211 ;;;; Hooks
2214 "Hook run at the beginning of the export process.
2216 This is run before include keywords and macros are expanded and
2217 Babel code blocks executed, on a copy of the original buffer
2218 being exported. Visibility and narrowing are preserved. Point
2219 is at the beginning of the buffer.
2221 Every function in this hook will be called with one argument: the
2225 "Hook run before parsing an export buffer.
2227 This is run after include keywords and macros have been expanded
2228 and Babel code blocks executed, on a copy of the original buffer
2229 being exported. Visibility and narrowing are preserved. Point
2230 is at the beginning of the buffer.
2232 Every function in this hook will be called with one argument: the
2236 ;;;; Special Filters
2239 "List of functions applied to the export options.
2240 Each filter is called with two arguments: the export options, as
2241 a plist, and the back-end, as a symbol. It must return
2245 "List of functions applied to the parsed tree.
2246 Each filter is called with three arguments: the parse tree, as
2247 returned by `org-element-parse-buffer', the back-end, as
2248 a symbol, and the communication channel, as a plist. It must
2252 "List of functions applied to plain text.
2253 Each filter is called with three arguments: a string which
2254 contains no Org syntax, the back-end, as a symbol, and the
2255 communication channel, as a plist. It must return a string or
2259 "List of functions applied to the transcoded string.
2260 Each filter is called with three arguments: the full transcoded
2261 string, the back-end, as a symbol, and the communication channel,
2262 as a plist. It must return a string that will be used as the
2266 ;;;; Elements Filters
2269 "List of functions applied to a transcoded babel-call.
2270 Each filter is called with three arguments: the transcoded data,
2271 as a string, the back-end, as a symbol, and the communication
2275 "List of functions applied to a transcoded center block.
2276 Each filter is called with three arguments: the transcoded data,
2277 as a string, the back-end, as a symbol, and the communication
2281 "List of functions applied to a transcoded clock.
2282 Each filter is called with three arguments: the transcoded data,
2283 as a string, the back-end, as a symbol, and the communication
2287 "List of functions applied to a transcoded comment.
2288 Each filter is called with three arguments: the transcoded data,
2289 as a string, the back-end, as a symbol, and the communication
2293 "List of functions applied to a transcoded comment-block.
2294 Each filter is called with three arguments: the transcoded data,
2295 as a string, the back-end, as a symbol, and the communication
2299 "List of functions applied to a transcoded diary-sexp.
2300 Each filter is called with three arguments: the transcoded data,
2301 as a string, the back-end, as a symbol, and the communication
2305 "List of functions applied to a transcoded drawer.
2306 Each filter is called with three arguments: the transcoded data,
2307 as a string, the back-end, as a symbol, and the communication
2311 "List of functions applied to a transcoded dynamic-block.
2312 Each filter is called with three arguments: the transcoded data,
2313 as a string, the back-end, as a symbol, and the communication
2317 "List of functions applied to a transcoded example-block.
2318 Each filter is called with three arguments: the transcoded data,
2319 as a string, the back-end, as a symbol, and the communication
2323 "List of functions applied to a transcoded export-block.
2324 Each filter is called with three arguments: the transcoded data,
2325 as a string, the back-end, as a symbol, and the communication
2329 "List of functions applied to a transcoded fixed-width.
2330 Each filter is called with three arguments: the transcoded data,
2331 as a string, the back-end, as a symbol, and the communication
2335 "List of functions applied to a transcoded footnote-definition.
2336 Each filter is called with three arguments: the transcoded data,
2337 as a string, the back-end, as a symbol, and the communication
2341 "List of functions applied to a transcoded headline.
2342 Each filter is called with three arguments: the transcoded data,
2343 as a string, the back-end, as a symbol, and the communication
2347 "List of functions applied to a transcoded horizontal-rule.
2348 Each filter is called with three arguments: the transcoded data,
2349 as a string, the back-end, as a symbol, and the communication
2353 "List of functions applied to a transcoded inlinetask.
2354 Each filter is called with three arguments: the transcoded data,
2355 as a string, the back-end, as a symbol, and the communication
2359 "List of functions applied to a transcoded item.
2360 Each filter is called with three arguments: the transcoded data,
2361 as a string, the back-end, as a symbol, and the communication
2365 "List of functions applied to a transcoded keyword.
2366 Each filter is called with three arguments: the transcoded data,
2367 as a string, the back-end, as a symbol, and the communication
2371 "List of functions applied to a transcoded latex-environment.
2372 Each filter is called with three arguments: the transcoded data,
2373 as a string, the back-end, as a symbol, and the communication
2377 "List of functions applied to a transcoded node-property.
2378 Each filter is called with three arguments: the transcoded data,
2379 as a string, the back-end, as a symbol, and the communication
2383 "List of functions applied to a transcoded paragraph.
2384 Each filter is called with three arguments: the transcoded data,
2385 as a string, the back-end, as a symbol, and the communication
2389 "List of functions applied to a transcoded plain-list.
2390 Each filter is called with three arguments: the transcoded data,
2391 as a string, the back-end, as a symbol, and the communication
2395 "List of functions applied to a transcoded planning.
2396 Each filter is called with three arguments: the transcoded data,
2397 as a string, the back-end, as a symbol, and the communication
2401 "List of functions applied to a transcoded property-drawer.
2402 Each filter is called with three arguments: the transcoded data,
2403 as a string, the back-end, as a symbol, and the communication
2407 "List of functions applied to a transcoded quote block.
2408 Each filter is called with three arguments: the transcoded quote
2409 data, as a string, the back-end, as a symbol, and the
2410 communication channel, as a plist. It must return a string or
2414 "List of functions applied to a transcoded quote-section.
2415 Each filter is called with three arguments: the transcoded data,
2416 as a string, the back-end, as a symbol, and the communication
2420 "List of functions applied to a transcoded section.
2421 Each filter is called with three arguments: the transcoded data,
2422 as a string, the back-end, as a symbol, and the communication
2426 "List of functions applied to a transcoded special block.
2427 Each filter is called with three arguments: the transcoded data,
2428 as a string, the back-end, as a symbol, and the communication
2432 "List of functions applied to a transcoded src-block.
2433 Each filter is called with three arguments: the transcoded data,
2434 as a string, the back-end, as a symbol, and the communication
2438 "List of functions applied to a transcoded table.
2439 Each filter is called with three arguments: the transcoded data,
2440 as a string, the back-end, as a symbol, and the communication
2444 "List of functions applied to a transcoded table-cell.
2445 Each filter is called with three arguments: the transcoded data,
2446 as a string, the back-end, as a symbol, and the communication
2450 "List of functions applied to a transcoded table-row.
2451 Each filter is called with three arguments: the transcoded data,
2452 as a string, the back-end, as a symbol, and the communication
2456 "List of functions applied to a transcoded verse block.
2457 Each filter is called with three arguments: the transcoded data,
2458 as a string, the back-end, as a symbol, and the communication
2462 ;;;; Objects Filters
2465 "List of functions applied to transcoded bold text.
2466 Each filter is called with three arguments: the transcoded data,
2467 as a string, the back-end, as a symbol, and the communication
2471 "List of functions applied to transcoded code text.
2472 Each filter is called with three arguments: the transcoded data,
2473 as a string, the back-end, as a symbol, and the communication
2477 "List of functions applied to a transcoded entity.
2478 Each filter is called with three arguments: the transcoded data,
2479 as a string, the back-end, as a symbol, and the communication
2483 "List of functions applied to a transcoded export-snippet.
2484 Each filter is called with three arguments: the transcoded data,
2485 as a string, the back-end, as a symbol, and the communication
2489 "List of functions applied to a transcoded footnote-reference.
2490 Each filter is called with three arguments: the transcoded data,
2491 as a string, the back-end, as a symbol, and the communication
2495 "List of functions applied to a transcoded inline-babel-call.
2496 Each filter is called with three arguments: the transcoded data,
2497 as a string, the back-end, as a symbol, and the communication
2501 "List of functions applied to a transcoded inline-src-block.
2502 Each filter is called with three arguments: the transcoded data,
2503 as a string, the back-end, as a symbol, and the communication
2507 "List of functions applied to transcoded italic text.
2508 Each filter is called with three arguments: the transcoded data,
2509 as a string, the back-end, as a symbol, and the communication
2513 "List of functions applied to a transcoded latex-fragment.
2514 Each filter is called with three arguments: the transcoded data,
2515 as a string, the back-end, as a symbol, and the communication
2519 "List of functions applied to a transcoded line-break.
2520 Each filter is called with three arguments: the transcoded data,
2521 as a string, the back-end, as a symbol, and the communication
2525 "List of functions applied to a transcoded link.
2526 Each filter is called with three arguments: the transcoded data,
2527 as a string, the back-end, as a symbol, and the communication
2531 "List of functions applied to a transcoded macro.
2532 Each filter is called with three arguments: the transcoded data,
2533 as a string, the back-end, as a symbol, and the communication
2537 "List of functions applied to a transcoded radio-target.
2538 Each filter is called with three arguments: the transcoded data,
2539 as a string, the back-end, as a symbol, and the communication
2543 "List of functions applied to a transcoded statistics-cookie.
2544 Each filter is called with three arguments: the transcoded data,
2545 as a string, the back-end, as a symbol, and the communication
2549 "List of functions applied to transcoded strike-through text.
2550 Each filter is called with three arguments: the transcoded data,
2551 as a string, the back-end, as a symbol, and the communication
2555 "List of functions applied to a transcoded subscript.
2556 Each filter is called with three arguments: the transcoded data,
2557 as a string, the back-end, as a symbol, and the communication
2561 "List of functions applied to a transcoded superscript.
2562 Each filter is called with three arguments: the transcoded data,
2563 as a string, the back-end, as a symbol, and the communication
2567 "List of functions applied to a transcoded target.
2568 Each filter is called with three arguments: the transcoded data,
2569 as a string, the back-end, as a symbol, and the communication
2573 "List of functions applied to a transcoded timestamp.
2574 Each filter is called with three arguments: the transcoded data,
2575 as a string, the back-end, as a symbol, and the communication
2579 "List of functions applied to transcoded underline text.
2580 Each filter is called with three arguments: the transcoded data,
2581 as a string, the back-end, as a symbol, and the communication
2585 "List of functions applied to transcoded verbatim text.
2586 Each filter is called with three arguments: the transcoded data,
2587 as a string, the back-end, as a symbol, and the communication
2591 ;;;; Filters Tools
2592 ;;
2593 ;; Internal function `org-export-install-filters' installs filters
2594 ;; hard-coded in back-ends (developer filters) and filters from global
2595 ;; variables (user filters) in the communication channel.
2596 ;;
2597 ;; Internal function `org-export-filter-apply-functions' takes care
2598 ;; about applying each filter in order to a given data. It ignores
2599 ;; filters returning a nil value but stops whenever a filter returns
2600 ;; an empty string.
2603 "Call every function in FILTERS.
2605 Functions are called with arguments VALUE, current export
2606 back-end and INFO. A function returning a nil value will be
2607 skipped. If it returns the empty string, the process ends and
2608 VALUE is ignored.
2610 Call is done in a LIFO fashion, to be sure that developer
2611 specified filters, if any, are called first."
2620 "Install filters properties in communication channel.
2621 INFO is a plist containing the current communication channel.
2622 Return the updated communication channel."
2624 ;; Install user defined filters with `org-export-filters-alist'.
2627 org-export-filters-alist)
2628 ;; Prepend back-end specific filters to that list.
2630 ;; Single values get consed, lists are prepended.
2635 plist key
2639 ;; Return new communication channel.
2643 \f
2644 ;;; Core functions
2645 ;;
2646 ;; This is the room for the main function, `org-export-as', along with
2647 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2648 ;; `org-export-string-as'. They differ either by the way they output
2649 ;; the resulting code (for the first two) or by the input type (for
2650 ;; the latter).
2651 ;;
2652 ;; `org-export-output-file-name' is an auxiliary function meant to be
2653 ;; used with `org-export-to-file'. With a given extension, it tries
2654 ;; to provide a canonical file name to write export output to.
2655 ;;
2656 ;; Note that `org-export-as' doesn't really parse the current buffer,
2657 ;; but a copy of it (with the same buffer-local variables and
2658 ;; visibility), where macros and include keywords are expanded and
2659 ;; Babel blocks are executed, if appropriate.
2660 ;; `org-export-with-buffer-copy' macro prepares that copy.
2661 ;;
2662 ;; File inclusion is taken care of by
2663 ;; `org-export-expand-include-keyword' and
2664 ;; `org-export--prepare-file-contents'. Structure wise, including
2665 ;; a whole Org file in a buffer often makes little sense. For
2666 ;; example, if the file contains an headline and the include keyword
2667 ;; was within an item, the item should contain the headline. That's
2668 ;; why file inclusion should be done before any structure can be
2669 ;; associated to the file, that is before parsing.
2672 "Return a copy of the current buffer.
2673 The copy preserves Org buffer-local variables, visibility and
2674 narrowing."
2680 new-buf))
2683 "Apply BODY in a copy of the current buffer.
2684 The copy preserves local variables, visibility and contents of
2685 the original buffer. Point is at the beginning of the buffer
2686 when BODY is applied."
2695 ;; Kill copy without confirmation.
2701 "Generate a function duplicating BUFFER.
2703 The copy will preserve local variables, visibility, contents and
2704 narrowing of the original buffer. If a region was active in
2705 BUFFER, contents will be narrowed to that region instead.
2707 The resulting function can be eval'ed at a later time, from
2708 another buffer, effectively cloning the original buffer there."
2712 ;; Buffer local variables.
2722 buffer-file-name outline-level
2723 outline-regexp
2724 buffer-invisibility-spec))
2727 ;; Skip unreadable values, as they cannot be
2728 ;; sent to external process.
2732 local-vars)))))
2734 local-vars)
2735 ;; Whole buffer contents.
2740 ;; Narrowing.
2744 ;; Current position of point.
2746 ;; Overlays with invisible property.
2756 ov-set))))
2758 ov-set)))))
2760 ;;;###autoload
2763 "Transcode current Org buffer into BACKEND code.
2765 If narrowing is active in the current buffer, only transcode its
2766 narrowed part.
2768 If a region is active, transcode that region.
2770 When optional argument SUBTREEP is non-nil, transcode the
2771 sub-tree at point, extracting information from the headline
2772 properties first.
2774 When optional argument VISIBLE-ONLY is non-nil, don't export
2775 contents of hidden elements.
2777 When optional argument BODY-ONLY is non-nil, only return body
2778 code, without surrounding template.
2780 Optional argument EXT-PLIST, when provided, is a property list
2781 with external parameters overriding Org default settings, but
2782 still inferior to file-local settings.
2784 Return code as a string."
2788 ;; Narrow buffer to an appropriate region or subtree for
2789 ;; parsing. If parsing subtree, be sure to remove main headline
2790 ;; too.
2798 ;; Initialize communication channel with original buffer
2799 ;; attributes, unavailable in its copy.
2801 ;; Update communication channel and get parse tree. Buffer
2802 ;; isn't parsed directly. Instead, a temporary copy is
2803 ;; created, where include keywords, macros are expanded and
2804 ;; code blocks are evaluated.
2806 ;; Run first hook with current back-end as argument.
2809 ;; Update macro templates since #+INCLUDE keywords might have
2810 ;; added some new ones.
2814 ;; Update radio targets since keyword inclusion might have
2815 ;; added some more.
2817 ;; Run last hook with current back-end as argument.
2820 ;; Update communication channel with environment. Also
2821 ;; install user's and developer's filters.
2826 ;; Expand export-specific set of macros: {{{author}}},
2827 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2828 ;; once regular macros have been expanded, since document
2829 ;; keywords may contain one of them.
2835 ;; EMAIL is not a parsed keyword: store it as-is.
2839 ;; Call options filters and update export options. We do not
2840 ;; use `org-export-filter-apply-functions' here since the
2841 ;; arity of such filters is different.
2845 ;; Parse buffer and call parse-tree filter on it.
2850 ;; Now tree is complete, compute its properties and add them
2851 ;; to communication channel.
2855 ;; Eventually transcode TREE. Wrap the resulting string into
2856 ;; a template.
2865 ;; Remove all text properties since they cannot be
2866 ;; retrieved from an external process. Finally call
2867 ;; final-output filter and return result.
2873 info))))))))
2875 ;;;###autoload
2878 "Call `org-export-as' with output to a specified buffer.
2880 BACKEND is the back-end used for transcoding, as a symbol.
2882 BUFFER is the output buffer. If it already exists, it will be
2883 erased first, otherwise, it will be created.
2885 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2886 EXT-PLIST are similar to those used in `org-export-as', which
2887 see.
2889 If `org-export-copy-to-kill-ring' is non-nil, add buffer contents
2890 to kill ring. Return buffer."
2897 ;; Maybe add buffer contents to kill ring.
2900 ;; Return buffer.
2901 buffer))
2903 ;;;###autoload
2906 "Call `org-export-as' with output to a specified file.
2908 BACKEND is the back-end used for transcoding, as a symbol. FILE
2909 is the name of the output file, as a string.
2911 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2912 EXT-PLIST are similar to those used in `org-export-as', which
2913 see.
2915 If `org-export-copy-to-kill-ring' is non-nil, add file contents
2916 to kill ring. Return output file's name."
2917 ;; Checks for FILE permissions. `write-file' would do the same, but
2918 ;; we'd rather avoid needless transcoding of parse tree.
2920 ;; Insert contents to a temporary buffer and write it to FILE.
2926 ;; Maybe add file contents to kill ring.
2929 ;; Return full path.
2930 file)
2932 ;;;###autoload
2934 "Transcode STRING into BACKEND code.
2936 When optional argument BODY-ONLY is non-nil, only return body
2937 code, without preamble nor postamble.
2939 Optional argument EXT-PLIST, when provided, is a property list
2940 with external parameters overriding Org default settings, but
2941 still inferior to file-local settings.
2943 Return code as a string."
2950 "Return output file's name according to buffer specifications.
2952 EXTENSION is a string representing the output file extension,
2953 with the leading dot.
2955 With a non-nil optional argument SUBTREEP, try to determine
2957 of subtree at point.
2959 When optional argument PUB-DIR is set, use it as the publishing
2960 directory.
2962 When optional argument VISIBLE-ONLY is non-nil, don't export
2963 contents of hidden elements.
2965 Return file name as a string, or nil if it couldn't be
2966 determined."
2968 ;; File name may come from EXPORT_FILE_NAME subtree property,
2969 ;; assuming point is at beginning of said sub-tree.
2976 ;; File name may be extracted from buffer's associated
2977 ;; file, if any.
2980 ;; Can't determine file name on our own: Ask user.
2984 "Output file: " pub-dir nil nil nil
2987 ;; Build file name. Enforce EXTENSION over whatever user may have
2988 ;; come up with. PUB-DIR, if defined, always has precedence over
2989 ;; any provided path.
2994 extension))
2999 "Expand every include keyword in buffer.
3000 Optional argument INCLUDED is a list of included file names along
3001 with their line restriction, when appropriate. It is used to
3002 avoid infinite recursion. Optional argument DIR is the current
3003 working directory. It is used to properly resolve relative
3004 paths."
3011 ;; Extract arguments from keyword's value.
3025 ;; Minimal level of included file defaults to the child
3026 ;; level of the current headline, if any, or one. It
3027 ;; only applies is the file is meant to be included as
3028 ;; an Org one.
3036 ;; Remove keyword.
3041 ;; Check if files has already been parsed. Look after
3042 ;; inclusion lines too, as different parts of the same file
3043 ;; can be included too.
3055 ind-str contents ind-str))))
3063 ind-str env contents ind-str))))
3076 "Prepare the contents of FILE for inclusion and return them as a string.
3078 When optional argument LINES is a string specifying a range of
3079 lines, include only those lines.
3081 Optional argument IND, when non-nil, is an integer specifying the
3082 global indentation of returned contents. Since its purpose is to
3083 allow an included file to stay in the same environment it was
3084 created \(i.e. a list item), it doesn't apply past the first
3085 headline encountered.
3087 Optional argument MINLEVEL, when non-nil, is an integer
3088 specifying the level that any top-level headline in the included
3089 file should have."
3105 ;; Remove blank lines at beginning and end of contents. The logic
3106 ;; behind that removal is that blank lines around include keyword
3107 ;; override blank lines in included file.
3116 ;; If IND is set, preserve indentation of include keyword until
3117 ;; the first headline encountered.
3123 ;; Do not move footnote definitions out of column 0.
3129 ;; When MINLEVEL is specified, compute minimal level for headlines
3130 ;; in the file (CUR-MIN), and remove stars to each headline so
3131 ;; that headlines with minimal level have a level of MINLEVEL.
3141 ;; Only change stars, don't bother moving whole
3142 ;; sections.
3149 "Execute every Babel code in the visible part of current buffer."
3150 ;; Get a pristine copy of current buffer so Babel references can be
3151 ;; properly resolved.
3158 \f
3159 ;;; Tools For Back-Ends
3160 ;;
3161 ;; A whole set of tools is available to help build new exporters. Any
3162 ;; function general enough to have its use across many back-ends
3163 ;; should be added here.
3165 ;;;; For Affiliated Keywords
3166 ;;
3167 ;; `org-export-read-attribute' reads a property from a given element
3168 ;; as a plist. It can be used to normalize affiliated keywords'
3169 ;; syntax.
3170 ;;
3171 ;; Since captions can span over multiple lines and accept dual values,
3172 ;; their internal representation is a bit tricky. Therefore,
3173 ;; `org-export-get-caption' transparently returns a given element's
3174 ;; caption as a secondary string.
3177 "Turn ATTRIBUTE property from ELEMENT into a plist.
3179 When optional argument PROPERTY is non-nil, return the value of
3180 that property within attributes.
3184 properties."
3192 "Return caption from ELEMENT as a secondary string.
3194 When optional argument SHORTP is non-nil, return short caption,
3195 as a secondary string, instead.
3197 Caption lines are separated by a white space."
3205 ;;;; For Derived Back-ends
3206 ;;
3207 ;; `org-export-with-backend' is a function allowing to locally use
3208 ;; another back-end to transcode some object or element. In a derived
3209 ;; back-end, it may be used as a fall-back function once all specific
3210 ;; cases have been treated.
3213 "Call a transcoder from BACK-END on DATA.
3214 CONTENTS, when non-nil, is the transcoded contents of DATA
3215 element, as a string. INFO, when non-nil, is the communication
3216 channel used for export, as a plist.."
3226 ;;;; For Export Snippets
3227 ;;
3228 ;; Every export snippet is transmitted to the back-end. Though, the
3229 ;; latter will only retain one type of export-snippet, ignoring
3230 ;; others, based on the former's target back-end. The function
3231 ;; `org-export-snippet-backend' returns that back-end for a given
3232 ;; export-snippet.
3235 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3236 Translation, with `org-export-snippet-translation-alist', is
3237 applied."
3241 back-end))))
3244 ;;;; For Footnotes
3245 ;;
3246 ;; `org-export-collect-footnote-definitions' is a tool to list
3247 ;; actually used footnotes definitions in the whole parse tree, or in
3248 ;; an headline, in order to add footnote listings throughout the
3249 ;; transcoded data.
3250 ;;
3251 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3252 ;; back-ends, when they need to attach the footnote definition only to
3253 ;; the first occurrence of the corresponding label.
3254 ;;
3255 ;; `org-export-get-footnote-definition' and
3256 ;; `org-export-get-footnote-number' provide easier access to
3257 ;; additional information relative to a footnote reference.
3260 "Return an alist between footnote numbers, labels and definitions.
3262 DATA is the parse tree from which definitions are collected.
3263 INFO is the plist used as a communication channel.
3265 Definitions are sorted by order of references. They either
3266 appear as Org data or as a secondary string for inlined
3267 footnotes. Unreferenced definitions are ignored."
3269 collect-fn ; for byte-compiler.
3273 ;; Collect footnote number, label and definition in DATA.
3281 def)
3282 num-alist)
3283 ;; Also search in definition for nested footnotes.
3286 ;; Don't enter footnote definitions since it will happen
3287 ;; when their first reference is found.
3293 "Non-nil when a footnote reference is the first one for its label.
3295 FOOTNOTE-REFERENCE is the footnote reference being considered.
3296 INFO is the plist used as a communication channel."
3298 ;; Anonymous footnotes are always a first reference.
3300 ;; Otherwise, return the first footnote with the same LABEL and
3301 ;; test if it is equal to FOOTNOTE-REFERENCE.
3311 ;; If FN isn't inlined, be sure to traverse its
3312 ;; definition before resuming search. See
3313 ;; comments in `org-export-get-footnote-number'
3314 ;; for more information.
3318 ;; Don't enter footnote definitions since it will
3319 ;; happen when their first reference is found.
3322 footnote-reference)))))
3325 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3326 INFO is the plist used as a communication channel. If no such
3328 string."
3335 "Return number associated to a footnote.
3337 FOOTNOTE is either a footnote reference or a footnote definition.
3338 INFO is the plist used as a communication channel."
3340 seen-refs
3341 search-ref ; For byte-compiler.
3345 ;; Search footnote references through DATA, filling
3346 ;; SEEN-REFS along the way.
3351 ;; Anonymous footnote match: return number.
3354 ;; Labels match: return number.
3357 ;; Anonymous footnote: it's always a new one.
3358 ;; Also, be sure to return nil from the `cond' so
3359 ;; `first-match' doesn't get us out of the loop.
3361 ;; Label not seen so far: add it so SEEN-REFS.
3362 ;;
3363 ;; Also search for subsequent references in
3364 ;; footnote definition so numbering follows
3365 ;; reading logic. Note that we don't have to care
3366 ;; about inline definitions, since
3367 ;; `org-element-map' already traverses them at the
3368 ;; right time.
3369 ;;
3370 ;; Once again, return nil to stay in the loop.
3375 nil))))
3376 ;; Don't enter footnote definitions since it will
3377 ;; happen when their first reference is found.
3382 ;;;; For Headlines
3383 ;;
3384 ;; `org-export-get-relative-level' is a shortcut to get headline
3385 ;; level, relatively to the lower headline level in the parsed tree.
3386 ;;
3387 ;; `org-export-get-headline-number' returns the section number of an
3388 ;; headline, while `org-export-number-to-roman' allows to convert it
3389 ;; to roman numbers.
3390 ;;
3391 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3392 ;; `org-export-last-sibling-p' are three useful predicates when it
3393 ;; comes to fulfill the `:headline-levels' property.
3394 ;;
3395 ;; `org-export-get-tags', `org-export-get-category' and
3396 ;; `org-export-get-node-property' extract useful information from an
3397 ;; headline or a parent headline. They all handle inheritance.
3400 "Return HEADLINE relative level within current parsed tree.
3401 INFO is a plist holding contextual information."
3406 "Non-nil when HEADLINE is considered as low level.
3408 INFO is a plist used as a communication channel.
3410 A low level headlines has a relative level greater than
3411 `:headline-levels' property value.
3413 Return value is the difference between HEADLINE relative level
3414 and the last level being considered as high enough, or nil."
3421 "Return HEADLINE numbering as a list of numbers.
3422 INFO is a plist holding contextual information."
3426 "Return a non-nil value if HEADLINE element should be numbered.
3427 INFO is a plist used as a communication channel."
3433 "Convert integer N into a roman numeral."
3446 res)))
3449 "Return list of tags associated to ELEMENT.
3451 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3452 is a plist used as a communication channel.
3454 Select tags (see `org-export-select-tags') and exclude tags (see
3455 `org-export-exclude-tags') are removed from the list.
3457 When non-nil, optional argument TAGS should be a list of strings.
3458 Any tag belonging to this list will also be removed.
3460 When optional argument INHERITED is non-nil, tags can also be
3461 inherited from parent headlines and FILETAGS keywords."
3467 ;; Build complete list of inherited tags.
3478 ;; Add FILETAGS keywords and return results.
3482 "Return node PROPERTY value for BLOB.
3484 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3485 element or object.
3487 If optional argument INHERITED is non-nil, the value can be
3488 inherited from a parent headline.
3490 Return value is a string or nil."
3502 "Return category for element or object BLOB.
3504 INFO is a plist used as a communication channel.
3506 CATEGORY is automatically inherited from a parent headline, from
3507 #+CATEGORY: keyword or created out of original file name. If all
3511 ;; Almost like `org-export-node-property', but we cannot trust
3512 ;; `plist-member' as every headline has a `:category'
3513 ;; property, would it be nil or equal to "???" (which has the
3514 ;; same meaning).
3532 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3533 INFO is a plist used as a communication channel."
3538 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3539 INFO is a plist used as a communication channel."
3543 ;;;; For Links
3544 ;;
3545 ;; `org-export-solidify-link-text' turns a string into a safer version
3546 ;; for links, replacing most non-standard characters with hyphens.
3547 ;;
3548 ;; `org-export-get-coderef-format' returns an appropriate format
3549 ;; string for coderefs.
3550 ;;
3551 ;; `org-export-inline-image-p' returns a non-nil value when the link
3552 ;; provided should be considered as an inline image.
3553 ;;
3554 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3555 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3556 ;; returns an appropriate unique identifier when found, or nil.
3557 ;;
3558 ;; `org-export-resolve-id-link' returns the first headline with
3559 ;; specified id or custom-id in parse tree, the path to the external
3560 ;; file with the id or nil when neither was found.
3561 ;;
3562 ;; `org-export-resolve-coderef' associates a reference to a line
3563 ;; number in the element it belongs, or returns the reference itself
3564 ;; when the element isn't numbered.
3567 "Take link text S and make a safe target out of it."
3572 "Return format string for code reference link.
3573 PATH is the link path. DESC is its description."
3581 "Non-nil if LINK object points to an inline image.
3583 Optional argument is a set of RULES defining inline images. It
3584 is an alist where associations have the following shape:
3586 \(TYPE . REGEXP)
3588 Applying a rule means apply REGEXP against LINK's path when its
3589 type is TYPE. The function will return a non-nil value if any of
3590 the provided rules is non-nil. The default rule is
3591 `org-export-default-inline-image-rule'.
3593 This only applies to links without a description."
3604 rules)
3605 ;; Return nil if no rule matched.
3606 nil))))
3609 "Resolve a code reference REF.
3611 INFO is a plist used as a communication channel.
3613 Return associated line number in source code, or REF itself,
3614 depending on src-block or example element's switches."
3621 org-coderef-label-format)))
3625 ;; Element containing REF is found. Resolve it to either
3626 ;; a label or a line number, as needed.
3636 "Return LINK destination.
3638 INFO is a plist holding contextual information.
3640 Return value can be an object, an element, or nil:
3642 - If LINK path matches a target object (i.e. <<path>>) or
3645 - If LINK path exactly matches the name affiliated keyword
3646 \(i.e. #+NAME: path) of an element, return that element.
3648 - If LINK path exactly matches any headline name, return that
3649 element. If more than one headline share that name, priority
3650 will be given to the one with the closest common ancestor, if
3651 any, or the first one in the parse tree otherwise.
3653 - Otherwise, return nil.
3659 ;; First try to find a matching "<<path>>" unless user specified
3660 ;; he was looking for an headline (path starts with a *
3661 ;; character).
3668 blob))
3669 info t)))
3670 ;; Then try to find an element with a matching "#+NAME: path"
3671 ;; affiliated keyword.
3674 org-element-all-elements
3678 ;; Last case: link either points to an headline or to
3679 ;; nothingness. Try to find the source, with priority given to
3680 ;; headlines with the closest common ancestor. If such candidate
3681 ;; is found, return it, otherwise return nil.
3685 ;; Return first headline whose `:raw-value' property is
3686 ;; NAME in parse tree DATA, or nil.
3692 name)
3693 headline))
3695 ;; Search among headlines sharing an ancestor with link, from
3696 ;; closest to farthest.
3704 ;; No match with a common ancestor: try full parse-tree.
3710 "Return headline referenced as LINK destination.
3712 INFO is a plist used as a communication channel.
3714 Return value can be the headline element matched in current parse
3718 ;; First check if id is within the current parse tree.
3723 headline))
3725 ;; Otherwise, look for external files.
3729 "Return radio-target object referenced as LINK destination.
3731 INFO is a plist used as a communication channel.
3733 Return value can be a radio-target object or nil. Assume LINK
3742 ;;;; For References
3743 ;;
3744 ;; `org-export-get-ordinal' associates a sequence number to any object
3745 ;; or element.
3748 "Return ordinal number of an element or object.
3750 ELEMENT is the element or object considered. INFO is the plist
3751 used as a communication channel.
3753 Optional argument TYPES, when non-nil, is a list of element or
3754 object types, as symbols, that should also be counted in.
3755 Otherwise, only provided element's type is considered.
3757 Optional argument PREDICATE is a function returning a non-nil
3758 value if the current element or object should be counted in. It
3759 accepts two arguments: the element or object being considered and
3760 the plist used as a communication channel. This allows to count
3761 only a certain type of objects (i.e. inline images).
3763 Return value is a list of numbers if ELEMENT is an headline or an
3764 item. It is nil for keywords. It represents the footnote number
3765 for footnote definitions and footnote references. If ELEMENT is
3766 a target, return the same value as if ELEMENT was the closest
3767 table, item or headline containing the target. In any other
3768 case, return the sequence number of ELEMENT among elements or
3769 objects of the same type."
3770 ;; A target keyword, representing an invisible target, never has
3771 ;; a sequence number.
3773 ;; Ordinal of a target object refer to the ordinal of the closest
3774 ;; table, item, or headline containing the object.
3778 when
3782 table))
3783 return parent)))
3785 ;; Special case 1: An headline returns its number as a list.
3787 ;; Special case 2: An item returns its number as a list.
3791 struct
3798 ;; Increment counter until ELEMENT is found again.
3809 ;;;; For Src-Blocks
3810 ;;
3811 ;; `org-export-get-loc' counts number of code lines accumulated in
3812 ;; src-block or example-block elements with a "+n" switch until
3813 ;; a given element, excluded. Note: "-n" switches reset that count.
3814 ;;
3815 ;; `org-export-unravel-code' extracts source code (along with a code
3816 ;; references alist) from an `element-block' or `src-block' type
3817 ;; element.
3818 ;;
3819 ;; `org-export-format-code' applies a formatting function to each line
3820 ;; of code, providing relative line number and code reference when
3821 ;; appropriate. Since it doesn't access the original element from
3822 ;; which the source code is coming, it expects from the code calling
3823 ;; it to know if lines should be numbered and if code references
3824 ;; should appear.
3825 ;;
3826 ;; Eventually, `org-export-format-code-default' is a higher-level
3827 ;; function (it makes use of the two previous functions) which handles
3828 ;; line numbering and code references inclusion, and returns source
3829 ;; code in a format suitable for plain text or verbatim output.
3832 "Return accumulated lines of code up to ELEMENT.
3834 INFO is the plist used as a communication channel.
3836 ELEMENT is excluded from count."
3842 ;; ELEMENT is reached: Quit the loop.
3844 ;; Only count lines from src-block and example-block elements
3845 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3849 ;; Accumulate locs or reset them.
3853 ;; Return nil to stay in the loop.
3854 nil)))
3856 ;; Return value.
3857 loc))
3860 "Clean source code and extract references out of it.
3862 ELEMENT has either a `src-block' an `example-block' type.
3864 Return a cons cell whose CAR is the source code, cleaned from any
3865 reference and protective comma and CDR is an alist between
3866 relative line number (integer) and name of code reference on that
3867 line (string)."
3869 ;; Get code and clean it. Remove blank lines at its
3870 ;; beginning and end.
3876 ;; If appropriate, remove global indentation.
3879 c
3881 ;; Get format used for references.
3884 org-coderef-label-format)))
3885 ;; Build a regexp matching a loc with a reference.
3890 ;; Return value.
3892 ;; Code with references removed.
3898 ;; Ref line: remove ref, and signal its position in REFS.
3902 ;; Reference alist.
3903 refs)))
3906 "Format CODE by applying FUN line-wise and return it.
3908 CODE is a string representing the code to format. FUN is
3909 a function. It must accept three arguments: a line of
3910 code (string), the current line number (integer) or nil and the
3911 reference associated to the current line (string) or nil.
3913 Optional argument NUM-LINES can be an integer representing the
3914 number of code lines accumulated until the current code. Line
3915 numbers passed to FUN will take it into account. If it is nil,
3916 FUN's second argument will always be nil. This number can be
3917 obtained with `org-export-get-loc' function.
3919 Optional argument REF-ALIST can be an alist between relative line
3920 number (i.e. ignoring NUM-LINES) and the name of the code
3921 reference on it. If it is nil, FUN's third argument will always
3922 be nil. It can be obtained through the use of
3923 `org-export-unravel-code' function."
3935 "Return source code from ELEMENT, formatted in a standard way.
3937 ELEMENT is either a `src-block' or `example-block' element. INFO
3938 is a plist used as a communication channel.
3940 This function takes care of line numbering and code references
3941 inclusion. Line numbers, when applicable, appear at the
3942 beginning of the line, separated from the code by two white
3943 spaces. Code references, on the other hand, appear flushed to
3944 the right, separated by six white spaces from the widest line of
3945 code."
3946 ;; Extract code and references.
3952 ;; Handle line numbering.
3961 ;; Prepare references display, if required. Any reference
3962 ;; should start six columns after the widest line of code,
3963 ;; wrapped with parenthesis.
3968 code
3972 number-str
3973 loc
3979 num-start refs)))
3982 ;;;; For Tables
3983 ;;
3984 ;; `org-export-table-has-special-column-p' and and
3985 ;; `org-export-table-row-is-special-p' are predicates used to look for
3986 ;; meta-information about the table structure.
3987 ;;
3988 ;; `org-table-has-header-p' tells when the rows before the first rule
3989 ;; should be considered as table's header.
3990 ;;
3991 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3992 ;; and `org-export-table-cell-borders' extract information from
3993 ;; a table-cell element.
3994 ;;
3995 ;; `org-export-table-dimensions' gives the number on rows and columns
3996 ;; in the table, ignoring horizontal rules and special columns.
3997 ;; `org-export-table-cell-address', given a table-cell object, returns
3998 ;; the absolute address of a cell. On the other hand,
3999 ;; `org-export-get-table-cell-at' does the contrary.
4000 ;;
4001 ;; `org-export-table-cell-starts-colgroup-p',
4002 ;; `org-export-table-cell-ends-colgroup-p',
4003 ;; `org-export-table-row-starts-rowgroup-p',
4004 ;; `org-export-table-row-ends-rowgroup-p',
4005 ;; `org-export-table-row-starts-header-p' and
4006 ;; `org-export-table-row-ends-header-p' indicate position of current
4007 ;; row or cell within the table.
4010 "Non-nil when TABLE has a special column.
4011 All special columns will be ignored during export."
4012 ;; The table has a special column when every first cell of every row
4013 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4014 ;; "*" "_" and "^". Though, do not consider a first row containing
4015 ;; only empty cells as special.
4031 "Non-nil when TABLE has an header.
4033 INFO is a plist used as a communication channel.
4035 A table has an header when it contains at least two row groups."
4045 info)))
4048 "Non-nil if TABLE-ROW is considered special.
4050 INFO is a plist used as the communication channel.
4052 All special rows will be ignored during export."
4056 ;; A row is special either when...
4058 ;; ... it starts with a field only containing "/",
4060 ;; ... the table contains a special column and the row start
4061 ;; with a marking character among, "^", "_", "$" or "!",
4065 ;; ... it contains only alignment cookies and empty cells.
4071 ;; Since VALUE is a secondary string, the following
4072 ;; checks avoid expanding it with `org-export-data'.
4084 "Return TABLE-ROW's group.
4086 INFO is a plist used as the communication channel.
4088 Return value is the group number, as an integer, or nil special
4089 rows and table rules. Group 1 is also table's header."
4106 "Return TABLE-CELL contents width.
4108 INFO is a plist used as the communication channel.
4110 Return value is the width given by the last width cookie in the
4111 same column as TABLE-CELL, or nil."
4116 cookie-width)
4120 ;; In a special row, try to find a width cookie at COLUMN.
4124 ;; The following checks avoid expanding unnecessarily the
4125 ;; cell with `org-export-data'
4133 ;; Ignore table rules.
4136 ;; Return value.
4137 cookie-width))
4140 "Return TABLE-CELL contents alignment.
4142 INFO is a plist used as the communication channel.
4144 Return alignment as specified by the last alignment cookie in the
4145 same column as TABLE-CELL. If no such cookie is found, a default
4146 alignment value will be deduced from fraction of numbers in the
4147 column (see `org-table-number-fraction' for more information).
4148 Possible values are `left', `right' and `center'."
4155 cookie-align)
4159 ;; In a special row, try to find an alignment cookie at
4160 ;; COLUMN.
4164 ;; Since VALUE is a secondary string, the following checks
4165 ;; avoid useless expansion through `org-export-data'.
4173 ;; Ignore table rules.
4175 ;; In a standard row, check if cell's contents are expressing
4176 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4177 ;; Though, don't bother if an alignment cookie has already
4178 ;; defined cell's alignment.
4183 info)))
4188 ;; Return value. Alignment specified by cookies has precedence
4189 ;; over alignment deduced from cells contents.
4198 "Return TABLE-CELL borders.
4200 INFO is a plist used as a communication channel.
4202 Return value is a list of symbols, or nil. Possible values are:
4203 `top', `bottom', `above', `below', `left' and `right'. Note:
4204 `top' (resp. `bottom') only happen for a cell in the first
4205 row (resp. last row) of the table, ignoring table rules, if any.
4207 Returned borders ignore special rows."
4210 borders)
4211 ;; Top/above border? TABLE-CELL has a border above when a rule
4212 ;; used to demarcate row groups can be found above. Hence,
4213 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4214 ;; another regular row has to be found above that rule.
4223 ;; Look at every row before the current one.
4225 ;; No rule above, or rule found starts the table (ignoring any
4226 ;; special row): TABLE-CELL is at the top of the table.
4229 ;; Bottom/below border? TABLE-CELL has a border below when next
4230 ;; non-regular row below is a rule.
4239 ;; Look at every row after the current one.
4241 ;; No rule below, or rule found ends the table (modulo some
4242 ;; special row): TABLE-CELL is at the bottom of the table.
4245 ;; Right/left borders? They can only be specified by column
4246 ;; groups. Column groups are defined in a row starting with "/".
4247 ;; Also a column groups row only contains "<", "<>", ">" or blank
4248 ;; cells.
4265 ;; There's a left border when previous cell, if
4266 ;; any, ends a group, or current one starts one.
4272 ;; There's a right border when next cell, if any,
4273 ;; starts a group, or current one ends one.
4280 ;; Table rows are read in reverse order so last column groups
4281 ;; row has precedence over any previous one.
4283 ;; Return value.
4284 borders))
4287 "Non-nil when TABLE-CELL is at the beginning of a row group.
4288 INFO is a plist used as a communication channel."
4289 ;; A cell starts a column group either when it is at the beginning
4290 ;; of a row (or after the special column, if any) or when it has
4291 ;; a left border.
4294 table-cell)
4298 "Non-nil when TABLE-CELL is at the end of a row group.
4299 INFO is a plist used as a communication channel."
4300 ;; A cell ends a column group either when it is at the end of a row
4301 ;; or when it has a right border.
4304 table-cell)
4308 "Non-nil when TABLE-ROW is at the beginning of a column group.
4309 INFO is a plist used as a communication channel."
4317 "Non-nil when TABLE-ROW is at the end of a column group.
4318 INFO is a plist used as a communication channel."
4326 "Non-nil when TABLE-ROW is the first table header's row.
4327 INFO is a plist used as a communication channel."
4334 "Non-nil when TABLE-ROW is the last table header's row.
4335 INFO is a plist used as a communication channel."
4342 "Return TABLE dimensions.
4344 INFO is a plist used as a communication channel.
4346 Return value is a CONS like (ROWS . COLUMNS) where
4347 ROWS (resp. COLUMNS) is the number of exportable
4348 rows (resp. columns)."
4350 ;; Set number of rows, and extract first one.
4356 ;; Set number of columns.
4358 ;; Return value.
4362 "Return address of a regular TABLE-CELL object.
4364 TABLE-CELL is the cell considered. INFO is a plist used as
4365 a communication channel.
4367 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4368 zero-based index. Only exportable cells are considered. The
4369 function returns nil for other cells."
4372 ;; Ignore cells in special rows or in special column.
4377 ;; Row number.
4385 ;; Column number.
4393 "Return regular table-cell object at ADDRESS in TABLE.
4395 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4396 zero-based index. TABLE is a table type element. INFO is
4397 a plist used as a communication channel.
4399 If no table-cell, among exportable cells, is found at ADDRESS,
4400 return nil."
4403 ;; Row at (car address) or nil.
4411 'table-cell
4418 ;;;; For Tables Of Contents
4419 ;;
4420 ;; `org-export-collect-headlines' builds a list of all exportable
4421 ;; headline elements, maybe limited to a certain depth. One can then
4422 ;; easily parse it and transcode it.
4423 ;;
4424 ;; Building lists of tables, figures or listings is quite similar.
4425 ;; Once the generic function `org-export-collect-elements' is defined,
4426 ;; `org-export-collect-tables', `org-export-collect-figures' and
4427 ;; `org-export-collect-listings' can be derived from it.
4430 "Collect headlines in order to build a table of contents.
4432 INFO is a plist used as a communication channel.
4434 When optional argument N is an integer, it specifies the depth of
4435 the table of contents. Otherwise, it is set to the value of the
4436 last headline level. See `org-export-headline-levels' for more
4437 information.
4439 Return a list of all exportable headlines as parsed elements.
4440 Footnote sections, if any, will be ignored."
4445 ;; Strip contents from HEADLINE.
4448 info))
4451 "Collect referenceable elements of a determined type.
4453 TYPE can be a symbol or a list of symbols specifying element
4454 types to search. Only elements with a caption are collected.
4456 INFO is a plist used as a communication channel.
4458 When non-nil, optional argument PREDICATE is a function accepting
4459 one argument, an element of type TYPE. It returns a non-nil
4460 value when that element should be collected.
4462 Return a list of all elements found, in order of appearance."
4467 element))
4468 info))
4471 "Build a list of tables.
4472 INFO is a plist used as a communication channel.
4474 Return a list of table elements with a caption."
4478 "Build a list of figures.
4480 INFO is a plist used as a communication channel. PREDICATE is
4481 a function which accepts one argument: a paragraph element and
4482 whose return value is non-nil when that element should be
4483 collected.
4485 A figure is a paragraph type element, with a caption, verifying
4487 a vague concept that may depend on back-end.
4489 Return a list of elements recognized as figures."
4493 "Build a list of src blocks.
4495 INFO is a plist used as a communication channel.
4497 Return a list of src-block elements with a caption."
4501 ;;;; Smart Quotes
4502 ;;
4503 ;; The main function for the smart quotes sub-system is
4504 ;; `org-export-activate-smart-quotes', which replaces every quote in
4505 ;; a given string from the parse tree with its "smart" counterpart.
4506 ;;
4507 ;; Dictionary for smart quotes is stored in
4508 ;; `org-export-smart-quotes-alist'.
4509 ;;
4510 ;; Internally, regexps matching potential smart quotes (checks at
4511 ;; string boundaries are also necessary) are defined in
4512 ;; `org-export-smart-quotes-regexps'.
4549 "Smart quotes translations.
4551 Alist whose CAR is a language string and CDR is an alist with
4552 quote type as key and a plist associating various encodings to
4553 their translation as value.
4555 A quote type can be any symbol among `opening-double-quote',
4556 `closing-double-quote', `opening-single-quote',
4557 `closing-single-quote' and `apostrophe'.
4559 Valid encodings include `:utf-8', `:html', `:latex' and
4560 `:texinfo'.
4566 ;; Possible opening quote at beginning of string.
4568 ;; Possible closing quote at beginning of string.
4570 ;; Possible apostrophe at beginning of string.
4572 ;; Opening single and double quotes.
4574 ;; Closing single and double quotes.
4576 ;; Apostrophe.
4578 ;; Possible opening quote at end of string.
4580 ;; Possible closing quote at end of string.
4582 ;; Possible apostrophe at end of string.
4584 "List of regexps matching a quote or an apostrophe.
4590 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4591 `:utf-8'. INFO is a plist used as a communication channel.
4593 The function has to retrieve information about string
4594 surroundings in parse tree. It can only happen with an
4595 unmodified string. Thus, if S has already been through another
4596 process, a non-nil ORIGINAL optional argument will provide that
4597 original string.
4599 Return the new string."
4602 ;; Try to be flexible when computing number of blanks
4603 ;; before object. The previous object may be a string
4604 ;; introduced by the back-end and not completely parsed.
4607 ;; A string with missing `:post-blank'
4608 ;; property.
4612 ;; Fallback value.
4617 ;; Return smart quote associated to a give quote Q, as
4618 ;; a string. TYPE is a symbol among `open', `close' and
4619 ;; `apostrophe'.
4629 org-export-smart-quotes-alist))))
4630 encoding)
4631 q)))))
4633 ;; Only a quote: no regexp can match. We have to check both
4634 ;; sides and decide what to do.
4642 ;; 1. Replace quote character at the beginning of S.
4644 ;; Apostrophe?
4650 ;; Closing quote?
4656 ;; Opening quote?
4662 ;; 2. Replace quotes in the middle of the string.
4664 ;; Opening quotes.
4670 ;; Closing quotes.
4676 ;; Apostrophes.
4681 ;; 3. Replace quote character at the end of S.
4683 ;; Apostrophe?
4688 ;; Closing quote?
4694 ;; Opening quote?
4699 ;; Return string with smart quotes.
4700 s))))
4702 ;;;; Topology
4703 ;;
4704 ;; Here are various functions to retrieve information about the
4705 ;; neighbourhood of a given element or object. Neighbours of interest
4706 ;; are direct parent (`org-export-get-parent'), parent headline
4707 ;; (`org-export-get-parent-headline'), first element containing an
4708 ;; object, (`org-export-get-parent-element'), parent table
4709 ;; (`org-export-get-parent-table'), previous element or object
4710 ;; (`org-export-get-previous-element') and next element or object
4711 ;; (`org-export-get-next-element').
4712 ;;
4713 ;; `org-export-get-genealogy' returns the full genealogy of a given
4714 ;; element or object, from closest parent to full parse tree.
4717 "Return BLOB parent or nil.
4718 BLOB is the element or object considered."
4722 "Return full genealogy relative to a given element or object.
4724 BLOB is the element or object being considered.
4726 Ancestors are returned from closest to farthest, the last one
4727 being the full parse tree."
4734 "Return BLOB parent headline or nil.
4735 BLOB is the element or object being considered."
4739 parent))
4742 "Return first element containing OBJECT or nil.
4743 OBJECT is the object to consider."
4747 parent))
4750 "Return OBJECT parent table or nil.
4751 OBJECT is either a `table-cell' or `table-element' type object."
4755 parent))
4758 "Return previous element or object.
4760 BLOB is an element or object. INFO is a plist used as
4761 a communication channel. Return previous exportable element or
4762 object, a string, or nil.
4764 When optional argument N is a positive integer, return a list
4765 containing up to N siblings before BLOB, from closest to
4766 farthest. With any other non-nil value, return a list containing
4767 all of them."
4769 ;; An object can belong to the contents of its parent or
4770 ;; to a secondary string. We check the latter option
4771 ;; first.
4774 org-element-all-elements))
4778 org-element-secondary-value-alist))
4779 parent)))
4782 prev)
4794 "Return next element or object.
4796 BLOB is an element or object. INFO is a plist used as
4797 a communication channel. Return next exportable element or
4798 object, a string, or nil.
4800 When optional argument N is a positive integer, return a list
4801 containing up to N siblings after BLOB, from closest to farthest.
4802 With any other non-nil value, return a list containing all of
4803 them."
4805 ;; An object can belong to the contents of its parent or to
4806 ;; a secondary string. We check the latter option first.
4809 org-element-all-objects))
4813 org-element-secondary-value-alist))
4814 parent)))
4817 next)
4825 siblings)
4829 ;;;; Translation
4830 ;;
4831 ;; `org-export-translate' translates a string according to language
4832 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4833 ;; variable and a specified charset. `org-export-dictionary' contains
4834 ;; the dictionary used for the translation.
4956 "Dictionary for export engine.
4958 Alist whose CAR is the string to translate and CDR is an alist
4959 whose CAR is the language string and CDR is a plist whose
4960 properties are possible charsets and values translated terms.
4962 It is used as a database for `org-export-translate'. Since this
4963 function returns the string as-is if no translation was found,
4964 the variable only needs to record values different from the
4968 "Translate string S according to language specification.
4970 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4971 and `:utf-8'. INFO is a plist used as a communication channel.
4973 Translation depends on `:language' property. Return the
4974 translated string. If no translation is found, try to fall back
4975 to `:default' encoding. If it fails, return S."
4981 s)))
4984 \f
4985 ;;; Asynchronous Export
4986 ;;
4987 ;; `org-export-async-start' is the entry point for asynchronous
4988 ;; export. It recreates current buffer (including visibility,
4989 ;; narrowing and visited file) in an external Emacs process, and
4990 ;; evaluates a command there. It then applies a function on the
4991 ;; returned results in the current process.
4992 ;;
4993 ;; Asynchronously generated results are never displayed directly.
4994 ;; Instead, they are stored in `org-export-stack-contents'. They can
4995 ;; then be retrieved by calling `org-export-stack'.
4996 ;;
4997 ;; Export Stack is viewed through a dedicated major mode
4998 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
4999 ;;`org-export-stack-delete', `org-export-stack-view' and
5000 ;;`org-export-stack-clear'.
5001 ;;
5002 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
5003 ;; It should used whenever `org-export-async-start' is called.
5006 "Call function FUN on the results returned by BODY evaluation.
5008 BODY evaluation happens in an asynchronous process, from a buffer
5009 which is an exact copy of the current one.
5011 Use `org-export-add-to-stack' in FUN in order to register results
5012 in the stack. Examples for, respectively a temporary buffer and
5013 a file are:
5015 \(org-export-async-start
5016 \(lambda (output)
5018 \(erase-buffer)
5019 \(insert output)
5020 \(goto-char (point-min))
5021 \(org-export-add-to-stack (current-buffer) 'backend)))
5022 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5024 and
5026 \(org-export-async-start
5027 \(lambda (f) (org-export-add-to-stack f 'backend))
5028 `(expand-file-name
5029 \(org-export-to-file
5030 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5033 ;; Write the full sexp evaluating BODY in a copy of the current
5034 ;; buffer to a temporary file, as it may be too long for program
5035 ;; args in `start-process'.
5042 "%S"
5045 ;; Initialize `org-mode' and export framework in the
5046 ;; external process.
5049 ;; Re-create current buffer there.
5052 ;; Sexp to evaluate in the buffer.
5054 ;; Start external process.
5057 (,process
5062 "-l" org-export-async-init-file
5064 ;; Register running process in stack.
5066 ;; Set-up sentinel in order to catch results.
5068 ,process
5092 "Add a new result to export stack if not present already.
5094 SOURCE is a buffer or a file name containing export results.
5095 BACKEND is a symbol representing export back-end used to generate
5096 it.
5098 Entries already pointing to SOURCE and unavailable entries are
5099 removed beforehand. Return the new stack."
5105 "Menu for asynchronous export results and running processes."
5115 "Return source from export results at point in stack."
5122 source
5123 ;; SOURCE is not consistent with current line. The stack
5124 ;; view is outdated.
5128 "Remove all entries from export stack."
5133 "Refresh the asynchronous export stack.
5134 DUMMY is ignored. Unavailable sources are removed from the list.
5135 Return the new stack."
5145 ;; Back-end.
5147 ;; Age.
5150 ;; Compute age of the results.
5152 "%4h:%.2m "
5154 ;; Source.
5159 ;; Clear stack from exited processes, dead buffers or
5160 ;; non-existent files.
5172 "Remove export results at point from stack.
5173 If optional argument SOURCE is non-nil, remove it instead."
5178 org-export-stack-contents))))
5181 "View export results at point in stack.
5182 With an optional prefix argument IN-EMACS, force viewing files
5183 within Emacs."
5197 (define-key km "p" 'previous-line)
5198 (define-key km "\C-p" 'previous-line)
5199 (define-key km "\C-?" 'previous-line)
5200 (define-key km [up] 'previous-line)
5201 (define-key km "C" 'org-export-stack-clear)
5202 (define-key km "v" 'org-export-stack-view)
5203 (define-key km (kbd "RET") 'org-export-stack-view)
5204 (define-key km "d" 'org-export-stack-remove)
5205 km)
5206 "Keymap for Org Export Stack.")
5208 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5209 "Mode for displaying asynchronous export stack.
5212 stack.
5214 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5215 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5216 stack completely.
5218 Removal entries in an Org Export Stack buffer doesn't affect
5219 files or buffers, only view in the stack.
5222 (abbrev-mode 0)
5223 (auto-fill-mode 0)
5224 (setq buffer-read-only t
5225 buffer-undo-list t
5226 truncate-lines t
5227 header-line-format
5228 '(:eval
5229 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5230 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5231 (set (make-local-variable 'revert-buffer-function)
5232 'org-export-stack-refresh))
5235 \f
5236 ;;; The Dispatcher
5237 ;;
5238 ;; `org-export-dispatch' is the standard interactive way to start an
5239 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
5240 ;; for its interface, which, in turn, delegates response to key
5241 ;; pressed to `org-export-dispatch-action'.
5243 ;;;###autoload
5244 (defun org-export-dispatch (&optional arg)
5245 "Export dispatcher for Org mode.
5247 It provides an access to common export related tasks in a buffer.
5248 Its interface comes in two flavours: standard and expert. While
5249 both share the same set of bindings, only the former displays the
5250 valid keys associations in a dedicated buffer. Set
5251 `org-export-dispatch-use-expert-ui' to switch to one flavour or
5252 the other.
5255 of options used back then, on the current buffer.
5257 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5258 (interactive "P")
5259 (let* ((input
5260 (cond ((equal arg '(16)) '(stack))
5261 ((and arg org-export-dispatch-last-action))
5262 (t (save-window-excursion
5263 (unwind-protect
5264 ;; Store this export command.
5265 (setq org-export-dispatch-last-action
5266 (org-export-dispatch-ui
5267 (list org-export-initial-scope
5268 (and org-export-in-background 'async))
5269 nil
5270 org-export-dispatch-use-expert-ui))
5271 (and (get-buffer "*Org Export Dispatcher*")
5272 (kill-buffer "*Org Export Dispatcher*")))))))
5273 (action (car input))
5274 (optns (cdr input)))
5275 (case action
5276 ;; First handle special hard-coded actions.
5277 (stack (org-export-stack))
5278 (publish-current-file
5279 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5280 (publish-current-project
5281 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5282 (publish-choose-project
5283 (org-publish (assoc (org-icompleting-read
5284 "Publish project: "
5285 org-publish-project-alist nil t)
5286 org-publish-project-alist)
5287 (memq 'force optns)
5288 (memq 'async optns)))
5289 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5290 (otherwise (funcall action
5291 ;; Return a symbol instead of a list to ease
5292 ;; asynchronous export macro use.
5293 (and (memq 'async optns) t)
5294 (and (memq 'subtree optns) t)
5295 (and (memq 'visible optns) t)
5296 (and (memq 'body optns) t))))))
5298 (defun org-export-dispatch-ui (options first-key expertp)
5299 "Handle interface for `org-export-dispatch'.
5301 OPTIONS is a list containing current interactive options set for
5302 export. It can contain any of the following symbols:
5303 `body' toggles a body-only export
5304 `subtree' restricts export to current subtree
5305 `visible' restricts export to visible part of buffer.
5306 `force' force publishing files.
5307 `async' use asynchronous export process
5309 FIRST-KEY is the key pressed to select the first level menu. It
5310 is nil when this menu hasn't been selected yet.
5312 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5313 buffer is provided, but indications about currently active
5314 options are given in the prompt. Moreover, \[?] allows to switch
5315 back to standard interface."
5316 (let* ((fontify-key
5317 (lambda (key &optional access-key)
5318 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5319 ;; non-nil is the required first-level key to activate
5320 ;; KEY. When its value is t, activate KEY independently
5321 ;; on the first key, if any. A nil value means KEY will
5322 ;; only be activated at first level.
5323 (if (or (eq access-key t) (eq access-key first-key))
5324 (org-propertize key 'face 'org-warning)
5325 key)))
5326 (fontify-value
5327 (lambda (value)
5328 ;; Fontify VALUE string.
5329 (org-propertize value 'face 'font-lock-variable-name-face)))
5330 ;; Prepare menu entries by extracting them from
5331 ;; `org-export-registered-backends', and sorting them by
5332 ;; access key and by ordinal, if any.
5333 (backends
5334 (sort
5335 (sort
5336 (delq nil
5337 (mapcar
5338 (lambda (b)
5339 (let ((name (car b)))
5340 (catch 'ignored
5341 ;; Ignore any back-end belonging to
5342 ;; `org-export-invisible-backends' or derived
5343 ;; from one of them.
5344 (dolist (ignored org-export-invisible-backends)
5345 (when (org-export-derived-backend-p name ignored)
5346 (throw 'ignored nil)))
5347 (org-export-backend-menu name))))
5348 org-export-registered-backends))
5349 (lambda (a b)
5350 (let ((key-a (nth 1 a))
5351 (key-b (nth 1 b)))
5352 (cond ((and (numberp key-a) (numberp key-b))
5353 (< key-a key-b))
5354 ((numberp key-b) t)))))
5355 (lambda (a b) (< (car a) (car b)))))
5356 ;; Compute a list of allowed keys based on the first key
5357 ;; pressed, if any. Some keys (?^B, ?^V, ?^S, ?^F, ?^A
5358 ;; and ?q) are always available.
5359 (allowed-keys
5360 (nconc (list ?\x02 ?\x16 ?\x13 ?\x06 ?\x01)
5361 (if (not first-key) (org-uniquify (mapcar 'car backends))
5362 (let (sub-menu)
5363 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5364 (when (eq (car backend) first-key)
5365 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5366 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5367 ((not first-key) (list ?P)))
5368 (list ?&)
5369 (when expertp (list ??))
5370 (list ?q)))
5371 ;; Build the help menu for standard UI.
5372 (help
5373 (unless expertp
5374 (concat
5375 ;; Options are hard-coded.
5376 (format "Options
5377 [%s] Body only: %s [%s] Visible only: %s
5378 [%s] Export scope: %s [%s] Force publishing: %s
5380 (funcall fontify-key "C-b" t)
5381 (funcall fontify-value
5382 (if (memq 'body options) "On " "Off"))
5383 (funcall fontify-key "C-v" t)
5384 (funcall fontify-value
5385 (if (memq 'visible options) "On " "Off"))
5386 (funcall fontify-key "C-s" t)
5387 (funcall fontify-value
5388 (if (memq 'subtree options) "Subtree" "Buffer "))
5389 (funcall fontify-key "C-f" t)
5390 (funcall fontify-value
5391 (if (memq 'force options) "On " "Off"))
5392 (funcall fontify-key "C-a" t)
5393 (funcall fontify-value
5394 (if (memq 'async options) "On " "Off")))
5395 ;; Display registered back-end entries. When a key
5396 ;; appears for the second time, do not create another
5397 ;; entry, but append its sub-menu to existing menu.
5398 (let (last-key)
5399 (mapconcat
5400 (lambda (entry)
5401 (let ((top-key (car entry)))
5402 (concat
5403 (unless (eq top-key last-key)
5404 (setq last-key top-key)
5406 (funcall fontify-key (char-to-string top-key))
5407 (nth 1 entry)))
5408 (let ((sub-menu (nth 2 entry)))
5409 (unless (functionp sub-menu)
5410 ;; Split sub-menu into two columns.
5411 (let ((index -1))
5412 (concat
5413 (mapconcat
5414 (lambda (sub-entry)
5415 (incf index)
5416 (format
5417 (if (zerop (mod index 2)) " [%s] %-26s"
5419 (funcall fontify-key
5420 (char-to-string (car sub-entry))
5421 top-key)
5422 (nth 1 sub-entry)))
5423 sub-menu "")
5425 backends ""))
5426 ;; Publishing menu is hard-coded.
5428 [%s] Current file [%s] Current project
5430 (funcall fontify-key "P")
5431 (funcall fontify-key "f" ?P)
5432 (funcall fontify-key "p" ?P)
5433 (funcall fontify-key "x" ?P)
5434 (funcall fontify-key "a" ?P))
5436 (format "\[%s] %s"
5437 (funcall fontify-key "q" t)
5438 (if first-key "Main menu" "Exit")))))
5439 ;; Build prompts for both standard and expert UI.
5440 (standard-prompt (unless expertp "Export command: "))
5441 (expert-prompt
5442 (when expertp
5443 (format
5444 "Export command (C-%s%s%s%s%s) [%s]: "
5445 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5446 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5447 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5448 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5449 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5450 (mapconcat (lambda (k)
5451 ;; Strip control characters.
5452 (unless (< k 27) (char-to-string k)))
5453 allowed-keys "")))))
5454 ;; With expert UI, just read key with a fancy prompt. In standard
5455 ;; UI, display an intrusive help buffer.
5456 (if expertp
5457 (org-export-dispatch-action
5458 expert-prompt allowed-keys backends options first-key expertp)
5459 ;; At first call, create frame layout in order to display menu.
5460 (unless (get-buffer "*Org Export Dispatcher*")
5461 (delete-other-windows)
5462 (org-switch-to-buffer-other-window
5463 (get-buffer-create "*Org Export Dispatcher*"))
5464 (setq cursor-type nil))
5465 ;; At this point, the buffer containing the menu exists and is
5466 ;; visible in the current window. So, refresh it.
5467 (with-current-buffer "*Org Export Dispatcher*"
5468 (erase-buffer)
5469 (insert help))
5470 (org-fit-window-to-buffer)
5471 (org-export-dispatch-action
5472 standard-prompt allowed-keys backends options first-key expertp))))
5474 (defun org-export-dispatch-action
5475 (prompt allowed-keys backends options first-key expertp)
5476 "Read a character from command input and act accordingly.
5478 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5479 a list of characters available at a given step in the process.
5480 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5481 EXPERTP are the same as defined in `org-export-dispatch-ui',
5482 which see.
5484 Toggle export options when required. Otherwise, return value is
5485 a list with action as CAR and a list of interactive export
5486 options as CDR."
5487 (let ((key (read-char-exclusive prompt)))
5488 (cond
5489 ;; Ignore undefined associations.
5490 ((not (memq key allowed-keys))
5491 (ding)
5492 (unless expertp (message "Invalid key") (sit-for 1))
5493 (org-export-dispatch-ui options first-key expertp))
5494 ;; q key at first level aborts export. At second
5495 ;; level, cancel first key instead.
5496 ((eq key ?q) (if (not first-key) (error "Export aborted")
5497 (org-export-dispatch-ui options nil expertp)))
5498 ;; Help key: Switch back to standard interface if
5499 ;; expert UI was active.
5500 ((eq key ??) (org-export-dispatch-ui options first-key nil))
5501 ;; Switch to asynchronous export stack.
5502 ((eq key ?&) '(stack))
5503 ;; Toggle export options.
5504 ((memq key '(?\x02 ?\x16 ?\x13 ?\x06 ?\x01))
5505 (org-export-dispatch-ui
5506 (let ((option (case key (?\x02 'body) (?\x16 'visible) (?\x13 'subtree)
5507 (?\x06 'force) (?\x01 'async))))
5508 (if (memq option options) (remq option options)
5509 (cons option options)))
5510 first-key expertp))
5511 ;; Action selected: Send key and options back to
5512 ;; `org-export-dispatch'.
5513 ((or first-key (functionp (nth 2 (assq key backends))))
5514 (cons (cond
5515 ((not first-key) (nth 2 (assq key backends)))
5516 ;; Publishing actions are hard-coded. Send a special
5517 ;; signal to `org-export-dispatch'.
5518 ((eq first-key ?P)
5519 (case key
5520 (?f 'publish-current-file)
5521 (?p 'publish-current-project)
5522 (?x 'publish-choose-project)
5523 (?a 'publish-all)))
5524 ;; Return first action associated to FIRST-KEY + KEY
5525 ;; path. Indeed, derived backends can share the same
5526 ;; FIRST-KEY.
5527 (t (catch 'found
5528 (mapc (lambda (backend)
5529 (let ((match (assq key (nth 2 backend))))
5530 (when match (throw 'found (nth 2 match)))))
5531 (member (assq first-key backends) backends)))))
5532 options))
5533 ;; Otherwise, enter sub-menu.
5534 (t (org-export-dispatch-ui options key expertp)))))
5538 (provide 'ox)
5540 ;; Local variables:
5541 ;; generated-autoload-file: "org-loaddefs.el"
5542 ;; End:
5544 ;;; ox.el ends here