| blob | 0b32842e6f5a73422ee841cf2caf917005cddf87 |
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\)."
1805 headline
1807 for idx from 0 to org-export-max-depth
1811 options)))
1814 "Return list of elements and objects to ignore during export.
1815 DATA is the parse tree to traverse. OPTIONS is the plist holding
1816 export options."
1818 walk-data
1819 ;; First find trees containing a select tag, if any.
1823 ;; Collect ignored elements or objects into IGNORE-LIST.
1829 ;; If headline is archived but tree below has
1830 ;; to be skipped, add it to ignore list.
1833 ;; Move into secondary string, if any.
1838 ;; Move into recursive objects/elements.
1840 ;; Main call.
1842 ;; Return value.
1843 ignore))
1846 "Return list of headlines containing a select tag in their tree.
1847 DATA is parsed data as returned by `org-element-parse-buffer'.
1848 INFO is a plist holding export options."
1850 walk-data ; for byte-compiler.
1861 ;; When a select tag is found, mark full
1862 ;; genealogy and every headline within the tree
1863 ;; as acceptable.
1866 genealogy
1868 selected-trees))
1869 ;; Else, continue searching in tree, recursively.
1876 "Non-nil when element or object BLOB should be skipped during export.
1877 OPTIONS is the plist holding export options. SELECTED, when
1878 non-nil, is a list of headlines belonging to a tree with a select
1879 tag."
1886 ;; If `:with-drawers' value starts with `not', ignore
1887 ;; every drawer whose name belong to that list.
1888 ;; Otherwise, ignore drawers whose name isn't in that
1889 ;; list.
1901 ;; Ignore subtrees with an exclude tag.
1904 ;; When a select tag is present in the buffer, ignore any tree
1905 ;; without it.
1907 ;; Ignore commented sub-trees.
1909 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1911 ;; Ignore tasks, if specified by `:with-tasks' property.
1928 ;; No timestamp allowed.
1930 ;; Only active timestamps allowed and the current one isn't
1931 ;; active.
1935 ;; Only inactive timestamps allowed and the current one isn't
1936 ;; inactive.
1942 \f
1943 ;;; The Transcoder
1944 ;;
1945 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1946 ;; `org-element-parse-buffer') and transcodes it into a specified
1947 ;; back-end output. It takes care of filtering out elements or
1948 ;; objects according to export options and organizing the output blank
1949 ;; lines and white space are preserved. The function memoizes its
1950 ;; results, so it is cheap to call it within translators.
1951 ;;
1952 ;; It is possible to modify locally the back-end used by
1953 ;; `org-export-data' or even use a temporary back-end by using
1954 ;; `org-export-data-with-translations' and
1955 ;; `org-export-data-with-backend'.
1956 ;;
1957 ;; Internally, three functions handle the filtering of objects and
1958 ;; elements during the export. In particular,
1959 ;; `org-export-ignore-element' marks an element or object so future
1960 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1961 ;; elements or objects should be seen as real Org syntax and
1962 ;; `org-export-expand' transforms the others back into their original
1963 ;; shape
1964 ;;
1965 ;; `org-export-transcoder' is an accessor returning appropriate
1966 ;; translator function for a given element or object.
1969 "Return appropriate transcoder for BLOB.
1970 INFO is a plist containing export directives."
1972 ;; Return contents only for complete parse trees.
1978 "Convert DATA into current back-end format.
1980 DATA is a parse tree, an element or an object or a secondary
1981 string. INFO is a plist holding export options.
1983 Return transcoded string."
1989 ;; Ignored element/object.
1991 ;; Plain text.
1997 info))
1998 ;; Uninterpreted element/object: change it back to Org
1999 ;; syntax and export again resulting raw string.
2003 data
2007 info))
2008 ;; Secondary string.
2011 ;; Element/Object without contents or, as a special case,
2012 ;; headline with archive tag and archived trees restricted
2013 ;; to title only.
2021 ;; Element/Object with contents.
2034 ;; Elements directly containing objects
2035 ;; must have their indentation normalized
2036 ;; first.
2038 data
2039 ;; When normalizing contents of the first
2040 ;; paragraph in an item or a footnote
2041 ;; definition, ignore first line's
2042 ;; indentation: there is none and it
2043 ;; might be misleading.
2048 data)
2055 info))))))))
2056 ;; Final result will be memoized before being returned.
2058 data
2062 ;; Append the same white space between elements or objects as in
2063 ;; the original buffer, and call appropriate filters.
2074 info)))
2075 results)))
2079 "Convert DATA into another format using a given translation table.
2080 DATA is an element, an object, a secondary string or a string.
2081 TRANSLATIONS is an alist between element or object types and
2082 a functions handling them. See `org-export-define-backend' for
2083 more information. INFO is a plist used as a communication
2084 channel."
2086 data
2087 ;; Set-up a new communication channel with TRANSLATIONS as the
2088 ;; translate table and a new hash table for memoization.
2090 info
2092 ;; Size of the hash table is reduced since this function
2093 ;; will probably be used on short trees.
2097 "Convert DATA into BACKEND format.
2099 DATA is an element, an object, a secondary string or a string.
2100 BACKEND is a symbol. INFO is a plist used as a communication
2101 channel.
2103 Unlike to `org-export-with-backend', this function will
2104 recursively convert DATA using BACKEND translation table."
2110 "Non-nil if element or object BLOB should be interpreted during export.
2111 If nil, BLOB will appear as raw Org syntax. Check is done
2112 according to export options INFO, stored as a plist."
2114 ;; ... entities...
2116 ;; ... emphasis...
2119 ;; ... fixed-width areas.
2121 ;; ... footnotes...
2124 ;; ... LaTeX environments and fragments...
2128 ;; ... sub/superscripts...
2134 ;; ... tables...
2139 "Expand a parsed element or object to its original state.
2140 BLOB is either an element or an object. CONTENTS is its
2141 contents, as a string or nil."
2144 blob contents))
2147 "Add ELEMENT to `:ignore-list' in INFO.
2149 Any element in `:ignore-list' will be skipped when using
2150 `org-element-map'. INFO is modified by side effects."
2154 \f
2155 ;;; The Filter System
2156 ;;
2157 ;; Filters allow end-users to tweak easily the transcoded output.
2158 ;; They are the functional counterpart of hooks, as every filter in
2159 ;; a set is applied to the return value of the previous one.
2160 ;;
2161 ;; Every set is back-end agnostic. Although, a filter is always
2162 ;; called, in addition to the string it applies to, with the back-end
2163 ;; used as argument, so it's easy for the end-user to add back-end
2164 ;; specific filters in the set. The communication channel, as
2165 ;; a plist, is required as the third argument.
2166 ;;
2167 ;; From the developer side, filters sets can be installed in the
2168 ;; process with the help of `org-export-define-backend', which
2169 ;; internally stores filters as an alist. Each association has a key
2170 ;; among the following symbols and a function or a list of functions
2171 ;; as value.
2172 ;;
2173 ;; - `:filter-options' applies to the property list containing export
2174 ;; options. Unlike to other filters, functions in this list accept
2175 ;; two arguments instead of three: the property list containing
2176 ;; export options and the back-end. Users can set its value through
2177 ;; `org-export-filter-options-functions' variable.
2178 ;;
2179 ;; - `:filter-parse-tree' applies directly to the complete parsed
2180 ;; tree. Users can set it through
2181 ;; `org-export-filter-parse-tree-functions' variable.
2182 ;;
2183 ;; - `:filter-final-output' applies to the final transcoded string.
2184 ;; Users can set it with `org-export-filter-final-output-functions'
2185 ;; variable
2186 ;;
2187 ;; - `:filter-plain-text' applies to any string not recognized as Org
2188 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2189 ;; configure it.
2190 ;;
2191 ;; - `:filter-TYPE' applies on the string returned after an element or
2192 ;; object of type TYPE has been transcoded. An user can modify
2193 ;; `org-export-filter-TYPE-functions'
2194 ;;
2195 ;; All filters sets are applied with
2196 ;; `org-export-filter-apply-functions' function. Filters in a set are
2197 ;; applied in a LIFO fashion. It allows developers to be sure that
2198 ;; their filters will be applied first.
2199 ;;
2200 ;; Filters properties are installed in communication channel with
2201 ;; `org-export-install-filters' function.
2202 ;;
2203 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2204 ;; `org-export-before-parsing-hook') are run at the beginning of the
2205 ;; export process and just before parsing to allow for heavy structure
2206 ;; modifications.
2209 ;;;; Hooks
2212 "Hook run at the beginning of the export process.
2214 This is run before include keywords and macros are expanded and
2215 Babel code blocks executed, on a copy of the original buffer
2216 being exported. Visibility and narrowing are preserved. Point
2217 is at the beginning of the buffer.
2219 Every function in this hook will be called with one argument: the
2223 "Hook run before parsing an export buffer.
2225 This is run after include keywords and macros have been expanded
2226 and Babel code blocks executed, on a copy of the original buffer
2227 being exported. Visibility and narrowing are preserved. Point
2228 is at the beginning of the buffer.
2230 Every function in this hook will be called with one argument: the
2234 ;;;; Special Filters
2237 "List of functions applied to the export options.
2238 Each filter is called with two arguments: the export options, as
2239 a plist, and the back-end, as a symbol. It must return
2243 "List of functions applied to the parsed tree.
2244 Each filter is called with three arguments: the parse tree, as
2245 returned by `org-element-parse-buffer', the back-end, as
2246 a symbol, and the communication channel, as a plist. It must
2250 "List of functions applied to plain text.
2251 Each filter is called with three arguments: a string which
2252 contains no Org syntax, the back-end, as a symbol, and the
2253 communication channel, as a plist. It must return a string or
2257 "List of functions applied to the transcoded string.
2258 Each filter is called with three arguments: the full transcoded
2259 string, the back-end, as a symbol, and the communication channel,
2260 as a plist. It must return a string that will be used as the
2264 ;;;; Elements Filters
2267 "List of functions applied to a transcoded babel-call.
2268 Each filter is called with three arguments: the transcoded data,
2269 as a string, the back-end, as a symbol, and the communication
2273 "List of functions applied to a transcoded center block.
2274 Each filter is called with three arguments: the transcoded data,
2275 as a string, the back-end, as a symbol, and the communication
2279 "List of functions applied to a transcoded clock.
2280 Each filter is called with three arguments: the transcoded data,
2281 as a string, the back-end, as a symbol, and the communication
2285 "List of functions applied to a transcoded comment.
2286 Each filter is called with three arguments: the transcoded data,
2287 as a string, the back-end, as a symbol, and the communication
2291 "List of functions applied to a transcoded comment-block.
2292 Each filter is called with three arguments: the transcoded data,
2293 as a string, the back-end, as a symbol, and the communication
2297 "List of functions applied to a transcoded diary-sexp.
2298 Each filter is called with three arguments: the transcoded data,
2299 as a string, the back-end, as a symbol, and the communication
2303 "List of functions applied to a transcoded drawer.
2304 Each filter is called with three arguments: the transcoded data,
2305 as a string, the back-end, as a symbol, and the communication
2309 "List of functions applied to a transcoded dynamic-block.
2310 Each filter is called with three arguments: the transcoded data,
2311 as a string, the back-end, as a symbol, and the communication
2315 "List of functions applied to a transcoded example-block.
2316 Each filter is called with three arguments: the transcoded data,
2317 as a string, the back-end, as a symbol, and the communication
2321 "List of functions applied to a transcoded export-block.
2322 Each filter is called with three arguments: the transcoded data,
2323 as a string, the back-end, as a symbol, and the communication
2327 "List of functions applied to a transcoded fixed-width.
2328 Each filter is called with three arguments: the transcoded data,
2329 as a string, the back-end, as a symbol, and the communication
2333 "List of functions applied to a transcoded footnote-definition.
2334 Each filter is called with three arguments: the transcoded data,
2335 as a string, the back-end, as a symbol, and the communication
2339 "List of functions applied to a transcoded headline.
2340 Each filter is called with three arguments: the transcoded data,
2341 as a string, the back-end, as a symbol, and the communication
2345 "List of functions applied to a transcoded horizontal-rule.
2346 Each filter is called with three arguments: the transcoded data,
2347 as a string, the back-end, as a symbol, and the communication
2351 "List of functions applied to a transcoded inlinetask.
2352 Each filter is called with three arguments: the transcoded data,
2353 as a string, the back-end, as a symbol, and the communication
2357 "List of functions applied to a transcoded item.
2358 Each filter is called with three arguments: the transcoded data,
2359 as a string, the back-end, as a symbol, and the communication
2363 "List of functions applied to a transcoded keyword.
2364 Each filter is called with three arguments: the transcoded data,
2365 as a string, the back-end, as a symbol, and the communication
2369 "List of functions applied to a transcoded latex-environment.
2370 Each filter is called with three arguments: the transcoded data,
2371 as a string, the back-end, as a symbol, and the communication
2375 "List of functions applied to a transcoded node-property.
2376 Each filter is called with three arguments: the transcoded data,
2377 as a string, the back-end, as a symbol, and the communication
2381 "List of functions applied to a transcoded paragraph.
2382 Each filter is called with three arguments: the transcoded data,
2383 as a string, the back-end, as a symbol, and the communication
2387 "List of functions applied to a transcoded plain-list.
2388 Each filter is called with three arguments: the transcoded data,
2389 as a string, the back-end, as a symbol, and the communication
2393 "List of functions applied to a transcoded planning.
2394 Each filter is called with three arguments: the transcoded data,
2395 as a string, the back-end, as a symbol, and the communication
2399 "List of functions applied to a transcoded property-drawer.
2400 Each filter is called with three arguments: the transcoded data,
2401 as a string, the back-end, as a symbol, and the communication
2405 "List of functions applied to a transcoded quote block.
2406 Each filter is called with three arguments: the transcoded quote
2407 data, as a string, the back-end, as a symbol, and the
2408 communication channel, as a plist. It must return a string or
2412 "List of functions applied to a transcoded quote-section.
2413 Each filter is called with three arguments: the transcoded data,
2414 as a string, the back-end, as a symbol, and the communication
2418 "List of functions applied to a transcoded section.
2419 Each filter is called with three arguments: the transcoded data,
2420 as a string, the back-end, as a symbol, and the communication
2424 "List of functions applied to a transcoded special block.
2425 Each filter is called with three arguments: the transcoded data,
2426 as a string, the back-end, as a symbol, and the communication
2430 "List of functions applied to a transcoded src-block.
2431 Each filter is called with three arguments: the transcoded data,
2432 as a string, the back-end, as a symbol, and the communication
2436 "List of functions applied to a transcoded table.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2442 "List of functions applied to a transcoded table-cell.
2443 Each filter is called with three arguments: the transcoded data,
2444 as a string, the back-end, as a symbol, and the communication
2448 "List of functions applied to a transcoded table-row.
2449 Each filter is called with three arguments: the transcoded data,
2450 as a string, the back-end, as a symbol, and the communication
2454 "List of functions applied to a transcoded verse block.
2455 Each filter is called with three arguments: the transcoded data,
2456 as a string, the back-end, as a symbol, and the communication
2460 ;;;; Objects Filters
2463 "List of functions applied to transcoded bold text.
2464 Each filter is called with three arguments: the transcoded data,
2465 as a string, the back-end, as a symbol, and the communication
2469 "List of functions applied to transcoded code text.
2470 Each filter is called with three arguments: the transcoded data,
2471 as a string, the back-end, as a symbol, and the communication
2475 "List of functions applied to a transcoded entity.
2476 Each filter is called with three arguments: the transcoded data,
2477 as a string, the back-end, as a symbol, and the communication
2481 "List of functions applied to a transcoded export-snippet.
2482 Each filter is called with three arguments: the transcoded data,
2483 as a string, the back-end, as a symbol, and the communication
2487 "List of functions applied to a transcoded footnote-reference.
2488 Each filter is called with three arguments: the transcoded data,
2489 as a string, the back-end, as a symbol, and the communication
2493 "List of functions applied to a transcoded inline-babel-call.
2494 Each filter is called with three arguments: the transcoded data,
2495 as a string, the back-end, as a symbol, and the communication
2499 "List of functions applied to a transcoded inline-src-block.
2500 Each filter is called with three arguments: the transcoded data,
2501 as a string, the back-end, as a symbol, and the communication
2505 "List of functions applied to transcoded italic text.
2506 Each filter is called with three arguments: the transcoded data,
2507 as a string, the back-end, as a symbol, and the communication
2511 "List of functions applied to a transcoded latex-fragment.
2512 Each filter is called with three arguments: the transcoded data,
2513 as a string, the back-end, as a symbol, and the communication
2517 "List of functions applied to a transcoded line-break.
2518 Each filter is called with three arguments: the transcoded data,
2519 as a string, the back-end, as a symbol, and the communication
2523 "List of functions applied to a transcoded link.
2524 Each filter is called with three arguments: the transcoded data,
2525 as a string, the back-end, as a symbol, and the communication
2529 "List of functions applied to a transcoded macro.
2530 Each filter is called with three arguments: the transcoded data,
2531 as a string, the back-end, as a symbol, and the communication
2535 "List of functions applied to a transcoded radio-target.
2536 Each filter is called with three arguments: the transcoded data,
2537 as a string, the back-end, as a symbol, and the communication
2541 "List of functions applied to a transcoded statistics-cookie.
2542 Each filter is called with three arguments: the transcoded data,
2543 as a string, the back-end, as a symbol, and the communication
2547 "List of functions applied to transcoded strike-through text.
2548 Each filter is called with three arguments: the transcoded data,
2549 as a string, the back-end, as a symbol, and the communication
2553 "List of functions applied to a transcoded subscript.
2554 Each filter is called with three arguments: the transcoded data,
2555 as a string, the back-end, as a symbol, and the communication
2559 "List of functions applied to a transcoded superscript.
2560 Each filter is called with three arguments: the transcoded data,
2561 as a string, the back-end, as a symbol, and the communication
2565 "List of functions applied to a transcoded target.
2566 Each filter is called with three arguments: the transcoded data,
2567 as a string, the back-end, as a symbol, and the communication
2571 "List of functions applied to a transcoded timestamp.
2572 Each filter is called with three arguments: the transcoded data,
2573 as a string, the back-end, as a symbol, and the communication
2577 "List of functions applied to transcoded underline text.
2578 Each filter is called with three arguments: the transcoded data,
2579 as a string, the back-end, as a symbol, and the communication
2583 "List of functions applied to transcoded verbatim text.
2584 Each filter is called with three arguments: the transcoded data,
2585 as a string, the back-end, as a symbol, and the communication
2589 ;;;; Filters Tools
2590 ;;
2591 ;; Internal function `org-export-install-filters' installs filters
2592 ;; hard-coded in back-ends (developer filters) and filters from global
2593 ;; variables (user filters) in the communication channel.
2594 ;;
2595 ;; Internal function `org-export-filter-apply-functions' takes care
2596 ;; about applying each filter in order to a given data. It ignores
2597 ;; filters returning a nil value but stops whenever a filter returns
2598 ;; an empty string.
2601 "Call every function in FILTERS.
2603 Functions are called with arguments VALUE, current export
2604 back-end and INFO. A function returning a nil value will be
2605 skipped. If it returns the empty string, the process ends and
2606 VALUE is ignored.
2608 Call is done in a LIFO fashion, to be sure that developer
2609 specified filters, if any, are called first."
2618 "Install filters properties in communication channel.
2619 INFO is a plist containing the current communication channel.
2620 Return the updated communication channel."
2622 ;; Install user defined filters with `org-export-filters-alist'.
2625 org-export-filters-alist)
2626 ;; Prepend back-end specific filters to that list.
2628 ;; Single values get consed, lists are prepended.
2633 plist key
2637 ;; Return new communication channel.
2641 \f
2642 ;;; Core functions
2643 ;;
2644 ;; This is the room for the main function, `org-export-as', along with
2645 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2646 ;; `org-export-string-as'. They differ either by the way they output
2647 ;; the resulting code (for the first two) or by the input type (for
2648 ;; the latter).
2649 ;;
2650 ;; `org-export-output-file-name' is an auxiliary function meant to be
2651 ;; used with `org-export-to-file'. With a given extension, it tries
2652 ;; to provide a canonical file name to write export output to.
2653 ;;
2654 ;; Note that `org-export-as' doesn't really parse the current buffer,
2655 ;; but a copy of it (with the same buffer-local variables and
2656 ;; visibility), where macros and include keywords are expanded and
2657 ;; Babel blocks are executed, if appropriate.
2658 ;; `org-export-with-buffer-copy' macro prepares that copy.
2659 ;;
2660 ;; File inclusion is taken care of by
2661 ;; `org-export-expand-include-keyword' and
2662 ;; `org-export--prepare-file-contents'. Structure wise, including
2663 ;; a whole Org file in a buffer often makes little sense. For
2664 ;; example, if the file contains an headline and the include keyword
2665 ;; was within an item, the item should contain the headline. That's
2666 ;; why file inclusion should be done before any structure can be
2667 ;; associated to the file, that is before parsing.
2670 "Return a copy of the current buffer.
2671 The copy preserves Org buffer-local variables, visibility and
2672 narrowing."
2678 new-buf))
2681 "Apply BODY in a copy of the current buffer.
2682 The copy preserves local variables, visibility and contents of
2683 the original buffer. Point is at the beginning of the buffer
2684 when BODY is applied."
2693 ;; Kill copy without confirmation.
2699 "Generate a function duplicating BUFFER.
2701 The copy will preserve local variables, visibility, contents and
2702 narrowing of the original buffer. If a region was active in
2703 BUFFER, contents will be narrowed to that region instead.
2705 The resulting function can be eval'ed at a later time, from
2706 another buffer, effectively cloning the original buffer there."
2710 ;; Buffer local variables.
2720 buffer-file-name outline-level
2721 outline-regexp
2722 buffer-invisibility-spec))
2725 ;; Skip unreadable values, as they cannot be
2726 ;; sent to external process.
2730 local-vars)))))
2732 local-vars)
2733 ;; Whole buffer contents.
2738 ;; Narrowing.
2742 ;; Current position of point.
2744 ;; Overlays with invisible property.
2754 ov-set))))
2756 ov-set)))))
2758 ;;;###autoload
2761 "Transcode current Org buffer into BACKEND code.
2763 If narrowing is active in the current buffer, only transcode its
2764 narrowed part.
2766 If a region is active, transcode that region.
2768 When optional argument SUBTREEP is non-nil, transcode the
2769 sub-tree at point, extracting information from the headline
2770 properties first.
2772 When optional argument VISIBLE-ONLY is non-nil, don't export
2773 contents of hidden elements.
2775 When optional argument BODY-ONLY is non-nil, only return body
2776 code, without surrounding template.
2778 Optional argument EXT-PLIST, when provided, is a property list
2779 with external parameters overriding Org default settings, but
2780 still inferior to file-local settings.
2782 Return code as a string."
2786 ;; Narrow buffer to an appropriate region or subtree for
2787 ;; parsing. If parsing subtree, be sure to remove main headline
2788 ;; too.
2796 ;; Initialize communication channel with original buffer
2797 ;; attributes, unavailable in its copy.
2799 ;; Update communication channel and get parse tree. Buffer
2800 ;; isn't parsed directly. Instead, a temporary copy is
2801 ;; created, where include keywords, macros are expanded and
2802 ;; code blocks are evaluated.
2804 ;; Run first hook with current back-end as argument.
2807 ;; Update macro templates since #+INCLUDE keywords might have
2808 ;; added some new ones.
2812 ;; Update radio targets since keyword inclusion might have
2813 ;; added some more.
2815 ;; Run last hook with current back-end as argument.
2818 ;; Update communication channel with environment. Also
2819 ;; install user's and developer's filters.
2824 ;; Expand export-specific set of macros: {{{author}}},
2825 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2826 ;; once regular macros have been expanded, since document
2827 ;; keywords may contain one of them.
2833 ;; EMAIL is not a parsed keyword: store it as-is.
2837 ;; Call options filters and update export options. We do not
2838 ;; use `org-export-filter-apply-functions' here since the
2839 ;; arity of such filters is different.
2843 ;; Parse buffer and call parse-tree filter on it.
2848 ;; Now tree is complete, compute its properties and add them
2849 ;; to communication channel.
2853 ;; Eventually transcode TREE. Wrap the resulting string into
2854 ;; a template.
2863 ;; Remove all text properties since they cannot be
2864 ;; retrieved from an external process. Finally call
2865 ;; final-output filter and return result.
2871 info))))))))
2873 ;;;###autoload
2876 "Call `org-export-as' with output to a specified buffer.
2878 BACKEND is the back-end used for transcoding, as a symbol.
2880 BUFFER is the output buffer. If it already exists, it will be
2881 erased first, otherwise, it will be created.
2883 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2884 EXT-PLIST are similar to those used in `org-export-as', which
2885 see.
2887 If `org-export-copy-to-kill-ring' is non-nil, add buffer contents
2888 to kill ring. Return buffer."
2895 ;; Maybe add buffer contents to kill ring.
2898 ;; Return buffer.
2899 buffer))
2901 ;;;###autoload
2904 "Call `org-export-as' with output to a specified file.
2906 BACKEND is the back-end used for transcoding, as a symbol. FILE
2907 is the name of the output file, as a string.
2909 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2910 EXT-PLIST are similar to those used in `org-export-as', which
2911 see.
2913 If `org-export-copy-to-kill-ring' is non-nil, add file contents
2914 to kill ring. Return output file's name."
2915 ;; Checks for FILE permissions. `write-file' would do the same, but
2916 ;; we'd rather avoid needless transcoding of parse tree.
2918 ;; Insert contents to a temporary buffer and write it to FILE.
2924 ;; Maybe add file contents to kill ring.
2927 ;; Return full path.
2928 file)
2930 ;;;###autoload
2932 "Transcode STRING into BACKEND code.
2934 When optional argument BODY-ONLY is non-nil, only return body
2935 code, without preamble nor postamble.
2937 Optional argument EXT-PLIST, when provided, is a property list
2938 with external parameters overriding Org default settings, but
2939 still inferior to file-local settings.
2941 Return code as a string."
2948 "Return output file's name according to buffer specifications.
2950 EXTENSION is a string representing the output file extension,
2951 with the leading dot.
2953 With a non-nil optional argument SUBTREEP, try to determine
2955 of subtree at point.
2957 When optional argument PUB-DIR is set, use it as the publishing
2958 directory.
2960 When optional argument VISIBLE-ONLY is non-nil, don't export
2961 contents of hidden elements.
2963 Return file name as a string, or nil if it couldn't be
2964 determined."
2966 ;; File name may come from EXPORT_FILE_NAME subtree property,
2967 ;; assuming point is at beginning of said sub-tree.
2974 ;; File name may be extracted from buffer's associated
2975 ;; file, if any.
2978 ;; Can't determine file name on our own: Ask user.
2982 "Output file: " pub-dir nil nil nil
2985 ;; Build file name. Enforce EXTENSION over whatever user may have
2986 ;; come up with. PUB-DIR, if defined, always has precedence over
2987 ;; any provided path.
2992 extension))
2997 "Expand every include keyword in buffer.
2998 Optional argument INCLUDED is a list of included file names along
2999 with their line restriction, when appropriate. It is used to
3000 avoid infinite recursion. Optional argument DIR is the current
3001 working directory. It is used to properly resolve relative
3002 paths."
3009 ;; Extract arguments from keyword's value.
3023 ;; Minimal level of included file defaults to the child
3024 ;; level of the current headline, if any, or one. It
3025 ;; only applies is the file is meant to be included as
3026 ;; an Org one.
3034 ;; Remove keyword.
3039 ;; Check if files has already been parsed. Look after
3040 ;; inclusion lines too, as different parts of the same file
3041 ;; can be included too.
3053 ind-str contents ind-str))))
3061 ind-str env contents ind-str))))
3074 "Prepare the contents of FILE for inclusion and return them as a string.
3076 When optional argument LINES is a string specifying a range of
3077 lines, include only those lines.
3079 Optional argument IND, when non-nil, is an integer specifying the
3080 global indentation of returned contents. Since its purpose is to
3081 allow an included file to stay in the same environment it was
3082 created \(i.e. a list item), it doesn't apply past the first
3083 headline encountered.
3085 Optional argument MINLEVEL, when non-nil, is an integer
3086 specifying the level that any top-level headline in the included
3087 file should have."
3103 ;; Remove blank lines at beginning and end of contents. The logic
3104 ;; behind that removal is that blank lines around include keyword
3105 ;; override blank lines in included file.
3114 ;; If IND is set, preserve indentation of include keyword until
3115 ;; the first headline encountered.
3121 ;; Do not move footnote definitions out of column 0.
3127 ;; When MINLEVEL is specified, compute minimal level for headlines
3128 ;; in the file (CUR-MIN), and remove stars to each headline so
3129 ;; that headlines with minimal level have a level of MINLEVEL.
3139 ;; Only change stars, don't bother moving whole
3140 ;; sections.
3147 "Execute every Babel code in the visible part of current buffer."
3148 ;; Get a pristine copy of current buffer so Babel references can be
3149 ;; properly resolved.
3156 \f
3157 ;;; Tools For Back-Ends
3158 ;;
3159 ;; A whole set of tools is available to help build new exporters. Any
3160 ;; function general enough to have its use across many back-ends
3161 ;; should be added here.
3163 ;;;; For Affiliated Keywords
3164 ;;
3165 ;; `org-export-read-attribute' reads a property from a given element
3166 ;; as a plist. It can be used to normalize affiliated keywords'
3167 ;; syntax.
3168 ;;
3169 ;; Since captions can span over multiple lines and accept dual values,
3170 ;; their internal representation is a bit tricky. Therefore,
3171 ;; `org-export-get-caption' transparently returns a given element's
3172 ;; caption as a secondary string.
3175 "Turn ATTRIBUTE property from ELEMENT into a plist.
3177 When optional argument PROPERTY is non-nil, return the value of
3178 that property within attributes.
3182 properties."
3190 "Return caption from ELEMENT as a secondary string.
3192 When optional argument SHORTP is non-nil, return short caption,
3193 as a secondary string, instead.
3195 Caption lines are separated by a white space."
3203 ;;;; For Derived Back-ends
3204 ;;
3205 ;; `org-export-with-backend' is a function allowing to locally use
3206 ;; another back-end to transcode some object or element. In a derived
3207 ;; back-end, it may be used as a fall-back function once all specific
3208 ;; cases have been treated.
3211 "Call a transcoder from BACK-END on DATA.
3212 CONTENTS, when non-nil, is the transcoded contents of DATA
3213 element, as a string. INFO, when non-nil, is the communication
3214 channel used for export, as a plist.."
3224 ;;;; For Export Snippets
3225 ;;
3226 ;; Every export snippet is transmitted to the back-end. Though, the
3227 ;; latter will only retain one type of export-snippet, ignoring
3228 ;; others, based on the former's target back-end. The function
3229 ;; `org-export-snippet-backend' returns that back-end for a given
3230 ;; export-snippet.
3233 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3234 Translation, with `org-export-snippet-translation-alist', is
3235 applied."
3239 back-end))))
3242 ;;;; For Footnotes
3243 ;;
3244 ;; `org-export-collect-footnote-definitions' is a tool to list
3245 ;; actually used footnotes definitions in the whole parse tree, or in
3246 ;; an headline, in order to add footnote listings throughout the
3247 ;; transcoded data.
3248 ;;
3249 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3250 ;; back-ends, when they need to attach the footnote definition only to
3251 ;; the first occurrence of the corresponding label.
3252 ;;
3253 ;; `org-export-get-footnote-definition' and
3254 ;; `org-export-get-footnote-number' provide easier access to
3255 ;; additional information relative to a footnote reference.
3258 "Return an alist between footnote numbers, labels and definitions.
3260 DATA is the parse tree from which definitions are collected.
3261 INFO is the plist used as a communication channel.
3263 Definitions are sorted by order of references. They either
3264 appear as Org data or as a secondary string for inlined
3265 footnotes. Unreferenced definitions are ignored."
3267 collect-fn ; for byte-compiler.
3271 ;; Collect footnote number, label and definition in DATA.
3279 def)
3280 num-alist)
3281 ;; Also search in definition for nested footnotes.
3284 ;; Don't enter footnote definitions since it will happen
3285 ;; when their first reference is found.
3291 "Non-nil when a footnote reference is the first one for its label.
3293 FOOTNOTE-REFERENCE is the footnote reference being considered.
3294 INFO is the plist used as a communication channel."
3296 ;; Anonymous footnotes are always a first reference.
3298 ;; Otherwise, return the first footnote with the same LABEL and
3299 ;; test if it is equal to FOOTNOTE-REFERENCE.
3309 ;; If FN isn't inlined, be sure to traverse its
3310 ;; definition before resuming search. See
3311 ;; comments in `org-export-get-footnote-number'
3312 ;; for more information.
3316 ;; Don't enter footnote definitions since it will
3317 ;; happen when their first reference is found.
3320 footnote-reference)))))
3323 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3324 INFO is the plist used as a communication channel. If no such
3326 string."
3333 "Return number associated to a footnote.
3335 FOOTNOTE is either a footnote reference or a footnote definition.
3336 INFO is the plist used as a communication channel."
3338 seen-refs
3339 search-ref ; For byte-compiler.
3343 ;; Search footnote references through DATA, filling
3344 ;; SEEN-REFS along the way.
3349 ;; Anonymous footnote match: return number.
3352 ;; Labels match: return number.
3355 ;; Anonymous footnote: it's always a new one.
3356 ;; Also, be sure to return nil from the `cond' so
3357 ;; `first-match' doesn't get us out of the loop.
3359 ;; Label not seen so far: add it so SEEN-REFS.
3360 ;;
3361 ;; Also search for subsequent references in
3362 ;; footnote definition so numbering follows
3363 ;; reading logic. Note that we don't have to care
3364 ;; about inline definitions, since
3365 ;; `org-element-map' already traverses them at the
3366 ;; right time.
3367 ;;
3368 ;; Once again, return nil to stay in the loop.
3373 nil))))
3374 ;; Don't enter footnote definitions since it will
3375 ;; happen when their first reference is found.
3380 ;;;; For Headlines
3381 ;;
3382 ;; `org-export-get-relative-level' is a shortcut to get headline
3383 ;; level, relatively to the lower headline level in the parsed tree.
3384 ;;
3385 ;; `org-export-get-headline-number' returns the section number of an
3386 ;; headline, while `org-export-number-to-roman' allows to convert it
3387 ;; to roman numbers.
3388 ;;
3389 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3390 ;; `org-export-last-sibling-p' are three useful predicates when it
3391 ;; comes to fulfill the `:headline-levels' property.
3392 ;;
3393 ;; `org-export-get-tags', `org-export-get-category' and
3394 ;; `org-export-get-node-property' extract useful information from an
3395 ;; headline or a parent headline. They all handle inheritance.
3398 "Return HEADLINE relative level within current parsed tree.
3399 INFO is a plist holding contextual information."
3404 "Non-nil when HEADLINE is considered as low level.
3406 INFO is a plist used as a communication channel.
3408 A low level headlines has a relative level greater than
3409 `:headline-levels' property value.
3411 Return value is the difference between HEADLINE relative level
3412 and the last level being considered as high enough, or nil."
3419 "Return HEADLINE numbering as a list of numbers.
3420 INFO is a plist holding contextual information."
3424 "Return a non-nil value if HEADLINE element should be numbered.
3425 INFO is a plist used as a communication channel."
3431 "Convert integer N into a roman numeral."
3444 res)))
3447 "Return list of tags associated to ELEMENT.
3449 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3450 is a plist used as a communication channel.
3452 Select tags (see `org-export-select-tags') and exclude tags (see
3453 `org-export-exclude-tags') are removed from the list.
3455 When non-nil, optional argument TAGS should be a list of strings.
3456 Any tag belonging to this list will also be removed.
3458 When optional argument INHERITED is non-nil, tags can also be
3459 inherited from parent headlines and FILETAGS keywords."
3465 ;; Build complete list of inherited tags.
3476 ;; Add FILETAGS keywords and return results.
3480 "Return node PROPERTY value for BLOB.
3482 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3483 element or object.
3485 If optional argument INHERITED is non-nil, the value can be
3486 inherited from a parent headline.
3488 Return value is a string or nil."
3500 "Return category for element or object BLOB.
3502 INFO is a plist used as a communication channel.
3504 CATEGORY is automatically inherited from a parent headline, from
3505 #+CATEGORY: keyword or created out of original file name. If all
3509 ;; Almost like `org-export-node-property', but we cannot trust
3510 ;; `plist-member' as every headline has a `:category'
3511 ;; property, would it be nil or equal to "???" (which has the
3512 ;; same meaning).
3530 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3531 INFO is a plist used as a communication channel."
3536 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3537 INFO is a plist used as a communication channel."
3541 ;;;; For Links
3542 ;;
3543 ;; `org-export-solidify-link-text' turns a string into a safer version
3544 ;; for links, replacing most non-standard characters with hyphens.
3545 ;;
3546 ;; `org-export-get-coderef-format' returns an appropriate format
3547 ;; string for coderefs.
3548 ;;
3549 ;; `org-export-inline-image-p' returns a non-nil value when the link
3550 ;; provided should be considered as an inline image.
3551 ;;
3552 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3553 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3554 ;; returns an appropriate unique identifier when found, or nil.
3555 ;;
3556 ;; `org-export-resolve-id-link' returns the first headline with
3557 ;; specified id or custom-id in parse tree, the path to the external
3558 ;; file with the id or nil when neither was found.
3559 ;;
3560 ;; `org-export-resolve-coderef' associates a reference to a line
3561 ;; number in the element it belongs, or returns the reference itself
3562 ;; when the element isn't numbered.
3565 "Take link text S and make a safe target out of it."
3570 "Return format string for code reference link.
3571 PATH is the link path. DESC is its description."
3579 "Non-nil if LINK object points to an inline image.
3581 Optional argument is a set of RULES defining inline images. It
3582 is an alist where associations have the following shape:
3584 \(TYPE . REGEXP)
3586 Applying a rule means apply REGEXP against LINK's path when its
3587 type is TYPE. The function will return a non-nil value if any of
3588 the provided rules is non-nil. The default rule is
3589 `org-export-default-inline-image-rule'.
3591 This only applies to links without a description."
3602 rules)
3603 ;; Return nil if no rule matched.
3604 nil))))
3607 "Resolve a code reference REF.
3609 INFO is a plist used as a communication channel.
3611 Return associated line number in source code, or REF itself,
3612 depending on src-block or example element's switches."
3619 org-coderef-label-format)))
3623 ;; Element containing REF is found. Resolve it to either
3624 ;; a label or a line number, as needed.
3634 "Return LINK destination.
3636 INFO is a plist holding contextual information.
3638 Return value can be an object, an element, or nil:
3640 - If LINK path matches a target object (i.e. <<path>>) or
3643 - If LINK path exactly matches the name affiliated keyword
3644 \(i.e. #+NAME: path) of an element, return that element.
3646 - If LINK path exactly matches any headline name, return that
3647 element. If more than one headline share that name, priority
3648 will be given to the one with the closest common ancestor, if
3649 any, or the first one in the parse tree otherwise.
3651 - Otherwise, return nil.
3657 ;; First try to find a matching "<<path>>" unless user specified
3658 ;; he was looking for an headline (path starts with a *
3659 ;; character).
3666 blob))
3667 info t)))
3668 ;; Then try to find an element with a matching "#+NAME: path"
3669 ;; affiliated keyword.
3672 org-element-all-elements
3676 ;; Last case: link either points to an headline or to
3677 ;; nothingness. Try to find the source, with priority given to
3678 ;; headlines with the closest common ancestor. If such candidate
3679 ;; is found, return it, otherwise return nil.
3683 ;; Return first headline whose `:raw-value' property is
3684 ;; NAME in parse tree DATA, or nil.
3690 name)
3691 headline))
3693 ;; Search among headlines sharing an ancestor with link, from
3694 ;; closest to farthest.
3702 ;; No match with a common ancestor: try full parse-tree.
3708 "Return headline referenced as LINK destination.
3710 INFO is a plist used as a communication channel.
3712 Return value can be the headline element matched in current parse
3716 ;; First check if id is within the current parse tree.
3721 headline))
3723 ;; Otherwise, look for external files.
3727 "Return radio-target object referenced as LINK destination.
3729 INFO is a plist used as a communication channel.
3731 Return value can be a radio-target object or nil. Assume LINK
3740 ;;;; For References
3741 ;;
3742 ;; `org-export-get-ordinal' associates a sequence number to any object
3743 ;; or element.
3746 "Return ordinal number of an element or object.
3748 ELEMENT is the element or object considered. INFO is the plist
3749 used as a communication channel.
3751 Optional argument TYPES, when non-nil, is a list of element or
3752 object types, as symbols, that should also be counted in.
3753 Otherwise, only provided element's type is considered.
3755 Optional argument PREDICATE is a function returning a non-nil
3756 value if the current element or object should be counted in. It
3757 accepts two arguments: the element or object being considered and
3758 the plist used as a communication channel. This allows to count
3759 only a certain type of objects (i.e. inline images).
3761 Return value is a list of numbers if ELEMENT is an headline or an
3762 item. It is nil for keywords. It represents the footnote number
3763 for footnote definitions and footnote references. If ELEMENT is
3764 a target, return the same value as if ELEMENT was the closest
3765 table, item or headline containing the target. In any other
3766 case, return the sequence number of ELEMENT among elements or
3767 objects of the same type."
3768 ;; A target keyword, representing an invisible target, never has
3769 ;; a sequence number.
3771 ;; Ordinal of a target object refer to the ordinal of the closest
3772 ;; table, item, or headline containing the object.
3776 when
3780 table))
3781 return parent)))
3783 ;; Special case 1: An headline returns its number as a list.
3785 ;; Special case 2: An item returns its number as a list.
3789 struct
3796 ;; Increment counter until ELEMENT is found again.
3807 ;;;; For Src-Blocks
3808 ;;
3809 ;; `org-export-get-loc' counts number of code lines accumulated in
3810 ;; src-block or example-block elements with a "+n" switch until
3811 ;; a given element, excluded. Note: "-n" switches reset that count.
3812 ;;
3813 ;; `org-export-unravel-code' extracts source code (along with a code
3814 ;; references alist) from an `element-block' or `src-block' type
3815 ;; element.
3816 ;;
3817 ;; `org-export-format-code' applies a formatting function to each line
3818 ;; of code, providing relative line number and code reference when
3819 ;; appropriate. Since it doesn't access the original element from
3820 ;; which the source code is coming, it expects from the code calling
3821 ;; it to know if lines should be numbered and if code references
3822 ;; should appear.
3823 ;;
3824 ;; Eventually, `org-export-format-code-default' is a higher-level
3825 ;; function (it makes use of the two previous functions) which handles
3826 ;; line numbering and code references inclusion, and returns source
3827 ;; code in a format suitable for plain text or verbatim output.
3830 "Return accumulated lines of code up to ELEMENT.
3832 INFO is the plist used as a communication channel.
3834 ELEMENT is excluded from count."
3840 ;; ELEMENT is reached: Quit the loop.
3842 ;; Only count lines from src-block and example-block elements
3843 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3847 ;; Accumulate locs or reset them.
3851 ;; Return nil to stay in the loop.
3852 nil)))
3854 ;; Return value.
3855 loc))
3858 "Clean source code and extract references out of it.
3860 ELEMENT has either a `src-block' an `example-block' type.
3862 Return a cons cell whose CAR is the source code, cleaned from any
3863 reference and protective comma and CDR is an alist between
3864 relative line number (integer) and name of code reference on that
3865 line (string)."
3867 ;; Get code and clean it. Remove blank lines at its
3868 ;; beginning and end.
3874 ;; If appropriate, remove global indentation.
3877 c
3879 ;; Get format used for references.
3882 org-coderef-label-format)))
3883 ;; Build a regexp matching a loc with a reference.
3888 ;; Return value.
3890 ;; Code with references removed.
3896 ;; Ref line: remove ref, and signal its position in REFS.
3900 ;; Reference alist.
3901 refs)))
3904 "Format CODE by applying FUN line-wise and return it.
3906 CODE is a string representing the code to format. FUN is
3907 a function. It must accept three arguments: a line of
3908 code (string), the current line number (integer) or nil and the
3909 reference associated to the current line (string) or nil.
3911 Optional argument NUM-LINES can be an integer representing the
3912 number of code lines accumulated until the current code. Line
3913 numbers passed to FUN will take it into account. If it is nil,
3914 FUN's second argument will always be nil. This number can be
3915 obtained with `org-export-get-loc' function.
3917 Optional argument REF-ALIST can be an alist between relative line
3918 number (i.e. ignoring NUM-LINES) and the name of the code
3919 reference on it. If it is nil, FUN's third argument will always
3920 be nil. It can be obtained through the use of
3921 `org-export-unravel-code' function."
3933 "Return source code from ELEMENT, formatted in a standard way.
3935 ELEMENT is either a `src-block' or `example-block' element. INFO
3936 is a plist used as a communication channel.
3938 This function takes care of line numbering and code references
3939 inclusion. Line numbers, when applicable, appear at the
3940 beginning of the line, separated from the code by two white
3941 spaces. Code references, on the other hand, appear flushed to
3942 the right, separated by six white spaces from the widest line of
3943 code."
3944 ;; Extract code and references.
3950 ;; Handle line numbering.
3959 ;; Prepare references display, if required. Any reference
3960 ;; should start six columns after the widest line of code,
3961 ;; wrapped with parenthesis.
3966 code
3970 number-str
3971 loc
3977 num-start refs)))
3980 ;;;; For Tables
3981 ;;
3982 ;; `org-export-table-has-special-column-p' and and
3983 ;; `org-export-table-row-is-special-p' are predicates used to look for
3984 ;; meta-information about the table structure.
3985 ;;
3986 ;; `org-table-has-header-p' tells when the rows before the first rule
3987 ;; should be considered as table's header.
3988 ;;
3989 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3990 ;; and `org-export-table-cell-borders' extract information from
3991 ;; a table-cell element.
3992 ;;
3993 ;; `org-export-table-dimensions' gives the number on rows and columns
3994 ;; in the table, ignoring horizontal rules and special columns.
3995 ;; `org-export-table-cell-address', given a table-cell object, returns
3996 ;; the absolute address of a cell. On the other hand,
3997 ;; `org-export-get-table-cell-at' does the contrary.
3998 ;;
3999 ;; `org-export-table-cell-starts-colgroup-p',
4000 ;; `org-export-table-cell-ends-colgroup-p',
4001 ;; `org-export-table-row-starts-rowgroup-p',
4002 ;; `org-export-table-row-ends-rowgroup-p',
4003 ;; `org-export-table-row-starts-header-p' and
4004 ;; `org-export-table-row-ends-header-p' indicate position of current
4005 ;; row or cell within the table.
4008 "Non-nil when TABLE has a special column.
4009 All special columns will be ignored during export."
4010 ;; The table has a special column when every first cell of every row
4011 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4012 ;; "*" "_" and "^". Though, do not consider a first row containing
4013 ;; only empty cells as special.
4029 "Non-nil when TABLE has an header.
4031 INFO is a plist used as a communication channel.
4033 A table has an header when it contains at least two row groups."
4043 info)))
4046 "Non-nil if TABLE-ROW is considered special.
4048 INFO is a plist used as the communication channel.
4050 All special rows will be ignored during export."
4054 ;; A row is special either when...
4056 ;; ... it starts with a field only containing "/",
4058 ;; ... the table contains a special column and the row start
4059 ;; with a marking character among, "^", "_", "$" or "!",
4063 ;; ... it contains only alignment cookies and empty cells.
4069 ;; Since VALUE is a secondary string, the following
4070 ;; checks avoid expanding it with `org-export-data'.
4082 "Return TABLE-ROW's group.
4084 INFO is a plist used as the communication channel.
4086 Return value is the group number, as an integer, or nil special
4087 rows and table rules. Group 1 is also table's header."
4104 "Return TABLE-CELL contents width.
4106 INFO is a plist used as the communication channel.
4108 Return value is the width given by the last width cookie in the
4109 same column as TABLE-CELL, or nil."
4114 cookie-width)
4118 ;; In a special row, try to find a width cookie at COLUMN.
4122 ;; The following checks avoid expanding unnecessarily the
4123 ;; cell with `org-export-data'
4131 ;; Ignore table rules.
4134 ;; Return value.
4135 cookie-width))
4138 "Return TABLE-CELL contents alignment.
4140 INFO is a plist used as the communication channel.
4142 Return alignment as specified by the last alignment cookie in the
4143 same column as TABLE-CELL. If no such cookie is found, a default
4144 alignment value will be deduced from fraction of numbers in the
4145 column (see `org-table-number-fraction' for more information).
4146 Possible values are `left', `right' and `center'."
4153 cookie-align)
4157 ;; In a special row, try to find an alignment cookie at
4158 ;; COLUMN.
4162 ;; Since VALUE is a secondary string, the following checks
4163 ;; avoid useless expansion through `org-export-data'.
4171 ;; Ignore table rules.
4173 ;; In a standard row, check if cell's contents are expressing
4174 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4175 ;; Though, don't bother if an alignment cookie has already
4176 ;; defined cell's alignment.
4181 info)))
4186 ;; Return value. Alignment specified by cookies has precedence
4187 ;; over alignment deduced from cells contents.
4196 "Return TABLE-CELL borders.
4198 INFO is a plist used as a communication channel.
4200 Return value is a list of symbols, or nil. Possible values are:
4201 `top', `bottom', `above', `below', `left' and `right'. Note:
4202 `top' (resp. `bottom') only happen for a cell in the first
4203 row (resp. last row) of the table, ignoring table rules, if any.
4205 Returned borders ignore special rows."
4208 borders)
4209 ;; Top/above border? TABLE-CELL has a border above when a rule
4210 ;; used to demarcate row groups can be found above. Hence,
4211 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4212 ;; another regular row has to be found above that rule.
4221 ;; Look at every row before the current one.
4223 ;; No rule above, or rule found starts the table (ignoring any
4224 ;; special row): TABLE-CELL is at the top of the table.
4227 ;; Bottom/below border? TABLE-CELL has a border below when next
4228 ;; non-regular row below is a rule.
4237 ;; Look at every row after the current one.
4239 ;; No rule below, or rule found ends the table (modulo some
4240 ;; special row): TABLE-CELL is at the bottom of the table.
4243 ;; Right/left borders? They can only be specified by column
4244 ;; groups. Column groups are defined in a row starting with "/".
4245 ;; Also a column groups row only contains "<", "<>", ">" or blank
4246 ;; cells.
4263 ;; There's a left border when previous cell, if
4264 ;; any, ends a group, or current one starts one.
4270 ;; There's a right border when next cell, if any,
4271 ;; starts a group, or current one ends one.
4278 ;; Table rows are read in reverse order so last column groups
4279 ;; row has precedence over any previous one.
4281 ;; Return value.
4282 borders))
4285 "Non-nil when TABLE-CELL is at the beginning of a row group.
4286 INFO is a plist used as a communication channel."
4287 ;; A cell starts a column group either when it is at the beginning
4288 ;; of a row (or after the special column, if any) or when it has
4289 ;; a left border.
4292 table-cell)
4296 "Non-nil when TABLE-CELL is at the end of a row group.
4297 INFO is a plist used as a communication channel."
4298 ;; A cell ends a column group either when it is at the end of a row
4299 ;; or when it has a right border.
4302 table-cell)
4306 "Non-nil when TABLE-ROW is at the beginning of a column group.
4307 INFO is a plist used as a communication channel."
4315 "Non-nil when TABLE-ROW is at the end of a column group.
4316 INFO is a plist used as a communication channel."
4324 "Non-nil when TABLE-ROW is the first table header's row.
4325 INFO is a plist used as a communication channel."
4332 "Non-nil when TABLE-ROW is the last table header's row.
4333 INFO is a plist used as a communication channel."
4340 "Return TABLE dimensions.
4342 INFO is a plist used as a communication channel.
4344 Return value is a CONS like (ROWS . COLUMNS) where
4345 ROWS (resp. COLUMNS) is the number of exportable
4346 rows (resp. columns)."
4348 ;; Set number of rows, and extract first one.
4354 ;; Set number of columns.
4356 ;; Return value.
4360 "Return address of a regular TABLE-CELL object.
4362 TABLE-CELL is the cell considered. INFO is a plist used as
4363 a communication channel.
4365 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4366 zero-based index. Only exportable cells are considered. The
4367 function returns nil for other cells."
4370 ;; Ignore cells in special rows or in special column.
4375 ;; Row number.
4383 ;; Column number.
4391 "Return regular table-cell object at ADDRESS in TABLE.
4393 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4394 zero-based index. TABLE is a table type element. INFO is
4395 a plist used as a communication channel.
4397 If no table-cell, among exportable cells, is found at ADDRESS,
4398 return nil."
4401 ;; Row at (car address) or nil.
4409 'table-cell
4416 ;;;; For Tables Of Contents
4417 ;;
4418 ;; `org-export-collect-headlines' builds a list of all exportable
4419 ;; headline elements, maybe limited to a certain depth. One can then
4420 ;; easily parse it and transcode it.
4421 ;;
4422 ;; Building lists of tables, figures or listings is quite similar.
4423 ;; Once the generic function `org-export-collect-elements' is defined,
4424 ;; `org-export-collect-tables', `org-export-collect-figures' and
4425 ;; `org-export-collect-listings' can be derived from it.
4428 "Collect headlines in order to build a table of contents.
4430 INFO is a plist used as a communication channel.
4432 When optional argument N is an integer, it specifies the depth of
4433 the table of contents. Otherwise, it is set to the value of the
4434 last headline level. See `org-export-headline-levels' for more
4435 information.
4437 Return a list of all exportable headlines as parsed elements."
4441 ;; Strip contents from HEADLINE.
4444 info))
4447 "Collect referenceable elements of a determined type.
4449 TYPE can be a symbol or a list of symbols specifying element
4450 types to search. Only elements with a caption are collected.
4452 INFO is a plist used as a communication channel.
4454 When non-nil, optional argument PREDICATE is a function accepting
4455 one argument, an element of type TYPE. It returns a non-nil
4456 value when that element should be collected.
4458 Return a list of all elements found, in order of appearance."
4463 element))
4464 info))
4467 "Build a list of tables.
4468 INFO is a plist used as a communication channel.
4470 Return a list of table elements with a caption."
4474 "Build a list of figures.
4476 INFO is a plist used as a communication channel. PREDICATE is
4477 a function which accepts one argument: a paragraph element and
4478 whose return value is non-nil when that element should be
4479 collected.
4481 A figure is a paragraph type element, with a caption, verifying
4483 a vague concept that may depend on back-end.
4485 Return a list of elements recognized as figures."
4489 "Build a list of src blocks.
4491 INFO is a plist used as a communication channel.
4493 Return a list of src-block elements with a caption."
4497 ;;;; Smart Quotes
4498 ;;
4499 ;; The main function for the smart quotes sub-system is
4500 ;; `org-export-activate-smart-quotes', which replaces every quote in
4501 ;; a given string from the parse tree with its "smart" counterpart.
4502 ;;
4503 ;; Dictionary for smart quotes is stored in
4504 ;; `org-export-smart-quotes-alist'.
4505 ;;
4506 ;; Internally, regexps matching potential smart quotes (checks at
4507 ;; string boundaries are also necessary) are defined in
4508 ;; `org-export-smart-quotes-regexps'.
4545 "Smart quotes translations.
4547 Alist whose CAR is a language string and CDR is an alist with
4548 quote type as key and a plist associating various encodings to
4549 their translation as value.
4551 A quote type can be any symbol among `opening-double-quote',
4552 `closing-double-quote', `opening-single-quote',
4553 `closing-single-quote' and `apostrophe'.
4555 Valid encodings include `:utf-8', `:html', `:latex' and
4556 `:texinfo'.
4562 ;; Possible opening quote at beginning of string.
4564 ;; Possible closing quote at beginning of string.
4566 ;; Possible apostrophe at beginning of string.
4568 ;; Opening single and double quotes.
4570 ;; Closing single and double quotes.
4572 ;; Apostrophe.
4574 ;; Possible opening quote at end of string.
4576 ;; Possible closing quote at end of string.
4578 ;; Possible apostrophe at end of string.
4580 "List of regexps matching a quote or an apostrophe.
4586 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4587 `:utf-8'. INFO is a plist used as a communication channel.
4589 The function has to retrieve information about string
4590 surroundings in parse tree. It can only happen with an
4591 unmodified string. Thus, if S has already been through another
4592 process, a non-nil ORIGINAL optional argument will provide that
4593 original string.
4595 Return the new string."
4598 ;; Try to be flexible when computing number of blanks
4599 ;; before object. The previous object may be a string
4600 ;; introduced by the back-end and not completely parsed.
4603 ;; A string with missing `:post-blank'
4604 ;; property.
4608 ;; Fallback value.
4613 ;; Return smart quote associated to a give quote Q, as
4614 ;; a string. TYPE is a symbol among `open', `close' and
4615 ;; `apostrophe'.
4625 org-export-smart-quotes-alist))))
4626 encoding)
4627 q)))))
4629 ;; Only a quote: no regexp can match. We have to check both
4630 ;; sides and decide what to do.
4638 ;; 1. Replace quote character at the beginning of S.
4640 ;; Apostrophe?
4646 ;; Closing quote?
4652 ;; Opening quote?
4658 ;; 2. Replace quotes in the middle of the string.
4660 ;; Opening quotes.
4666 ;; Closing quotes.
4672 ;; Apostrophes.
4677 ;; 3. Replace quote character at the end of S.
4679 ;; Apostrophe?
4684 ;; Closing quote?
4690 ;; Opening quote?
4695 ;; Return string with smart quotes.
4696 s))))
4698 ;;;; Topology
4699 ;;
4700 ;; Here are various functions to retrieve information about the
4701 ;; neighbourhood of a given element or object. Neighbours of interest
4702 ;; are direct parent (`org-export-get-parent'), parent headline
4703 ;; (`org-export-get-parent-headline'), first element containing an
4704 ;; object, (`org-export-get-parent-element'), parent table
4705 ;; (`org-export-get-parent-table'), previous element or object
4706 ;; (`org-export-get-previous-element') and next element or object
4707 ;; (`org-export-get-next-element').
4708 ;;
4709 ;; `org-export-get-genealogy' returns the full genealogy of a given
4710 ;; element or object, from closest parent to full parse tree.
4713 "Return BLOB parent or nil.
4714 BLOB is the element or object considered."
4718 "Return full genealogy relative to a given element or object.
4720 BLOB is the element or object being considered.
4722 Ancestors are returned from closest to farthest, the last one
4723 being the full parse tree."
4730 "Return BLOB parent headline or nil.
4731 BLOB is the element or object being considered."
4735 parent))
4738 "Return first element containing OBJECT or nil.
4739 OBJECT is the object to consider."
4743 parent))
4746 "Return OBJECT parent table or nil.
4747 OBJECT is either a `table-cell' or `table-element' type object."
4751 parent))
4754 "Return previous element or object.
4756 BLOB is an element or object. INFO is a plist used as
4757 a communication channel. Return previous exportable element or
4758 object, a string, or nil.
4760 When optional argument N is a positive integer, return a list
4761 containing up to N siblings before BLOB, from closest to
4762 farthest. With any other non-nil value, return a list containing
4763 all of them."
4765 ;; An object can belong to the contents of its parent or
4766 ;; to a secondary string. We check the latter option
4767 ;; first.
4770 org-element-all-elements))
4774 org-element-secondary-value-alist))
4775 parent)))
4778 prev)
4790 "Return next element or object.
4792 BLOB is an element or object. INFO is a plist used as
4793 a communication channel. Return next exportable element or
4794 object, a string, or nil.
4796 When optional argument N is a positive integer, return a list
4797 containing up to N siblings after BLOB, from closest to farthest.
4798 With any other non-nil value, return a list containing all of
4799 them."
4801 ;; An object can belong to the contents of its parent or to
4802 ;; a secondary string. We check the latter option first.
4805 org-element-all-objects))
4809 org-element-secondary-value-alist))
4810 parent)))
4813 next)
4821 siblings)
4825 ;;;; Translation
4826 ;;
4827 ;; `org-export-translate' translates a string according to language
4828 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4829 ;; variable and a specified charset. `org-export-dictionary' contains
4830 ;; the dictionary used for the translation.
4952 "Dictionary for export engine.
4954 Alist whose CAR is the string to translate and CDR is an alist
4955 whose CAR is the language string and CDR is a plist whose
4956 properties are possible charsets and values translated terms.
4958 It is used as a database for `org-export-translate'. Since this
4959 function returns the string as-is if no translation was found,
4960 the variable only needs to record values different from the
4964 "Translate string S according to language specification.
4966 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4967 and `:utf-8'. INFO is a plist used as a communication channel.
4969 Translation depends on `:language' property. Return the
4970 translated string. If no translation is found, try to fall back
4971 to `:default' encoding. If it fails, return S."
4977 s)))
4980 \f
4981 ;;; Asynchronous Export
4982 ;;
4983 ;; `org-export-async-start' is the entry point for asynchronous
4984 ;; export. It recreates current buffer (including visibility,
4985 ;; narrowing and visited file) in an external Emacs process, and
4986 ;; evaluates a command there. It then applies a function on the
4987 ;; returned results in the current process.
4988 ;;
4989 ;; Asynchronously generated results are never displayed directly.
4990 ;; Instead, they are stored in `org-export-stack-contents'. They can
4991 ;; then be retrieved by calling `org-export-stack'.
4992 ;;
4993 ;; Export Stack is viewed through a dedicated major mode
4994 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
4995 ;;`org-export-stack-delete', `org-export-stack-view' and
4996 ;;`org-export-stack-clear'.
4997 ;;
4998 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
4999 ;; It should used whenever `org-export-async-start' is called.
5002 "Call function FUN on the results returned by BODY evaluation.
5004 BODY evaluation happens in an asynchronous process, from a buffer
5005 which is an exact copy of the current one.
5007 Use `org-export-add-to-stack' in FUN in order to register results
5008 in the stack. Examples for, respectively a temporary buffer and
5009 a file are:
5011 \(org-export-async-start
5012 \(lambda (output)
5014 \(erase-buffer)
5015 \(insert output)
5016 \(goto-char (point-min))
5017 \(org-export-add-to-stack (current-buffer) 'backend)))
5018 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5020 and
5022 \(org-export-async-start
5023 \(lambda (f) (org-export-add-to-stack f 'backend))
5024 `(expand-file-name
5025 \(org-export-to-file
5026 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5029 ;; Write the full sexp evaluating BODY in a copy of the current
5030 ;; buffer to a temporary file, as it may be too long for program
5031 ;; args in `start-process'.
5038 "%S"
5041 ;; Initialize `org-mode' and export framework in the
5042 ;; external process.
5045 ;; Re-create current buffer there.
5048 ;; Sexp to evaluate in the buffer.
5050 ;; Start external process.
5053 (,process
5058 "-l" org-export-async-init-file
5060 ;; Register running process in stack.
5062 ;; Set-up sentinel in order to catch results.
5064 ,process
5088 "Add a new result to export stack if not present already.
5090 SOURCE is a buffer or a file name containing export results.
5091 BACKEND is a symbol representing export back-end used to generate
5092 it.
5094 Entries already pointing to SOURCE and unavailable entries are
5095 removed beforehand. Return the new stack."
5101 "Menu for asynchronous export results and running processes."
5111 "Return source from export results at point in stack."
5118 source
5119 ;; SOURCE is not consistent with current line. The stack
5120 ;; view is outdated.
5124 "Remove all entries from export stack."
5129 "Refresh the asynchronous export stack.
5130 DUMMY is ignored. Unavailable sources are removed from the list.
5131 Return the new stack."
5141 ;; Back-end.
5143 ;; Age.
5146 ;; Compute age of the results.
5148 "%4h:%.2m "
5150 ;; Source.
5155 ;; Clear stack from exited processes, dead buffers or
5156 ;; non-existent files.
5168 "Remove export results at point from stack.
5169 If optional argument SOURCE is non-nil, remove it instead."
5174 org-export-stack-contents))))
5177 "View export results at point in stack.
5178 With an optional prefix argument IN-EMACS, force viewing files
5179 within Emacs."
5193 (define-key km "p" 'previous-line)
5194 (define-key km "\C-p" 'previous-line)
5195 (define-key km "\C-?" 'previous-line)
5196 (define-key km [up] 'previous-line)
5197 (define-key km "C" 'org-export-stack-clear)
5198 (define-key km "v" 'org-export-stack-view)
5199 (define-key km (kbd "RET") 'org-export-stack-view)
5200 (define-key km "d" 'org-export-stack-remove)
5201 km)
5202 "Keymap for Org Export Stack.")
5204 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5205 "Mode for displaying asynchronous export stack.
5208 stack.
5210 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5211 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5212 stack completely.
5214 Removal entries in an Org Export Stack buffer doesn't affect
5215 files or buffers, only view in the stack.
5218 (abbrev-mode 0)
5219 (auto-fill-mode 0)
5220 (setq buffer-read-only t
5221 buffer-undo-list t
5222 truncate-lines t
5223 header-line-format
5224 '(:eval
5225 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5226 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5227 (set (make-local-variable 'revert-buffer-function)
5228 'org-export-stack-refresh))
5231 \f
5232 ;;; The Dispatcher
5233 ;;
5234 ;; `org-export-dispatch' is the standard interactive way to start an
5235 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
5236 ;; for its interface, which, in turn, delegates response to key
5237 ;; pressed to `org-export-dispatch-action'.
5239 ;;;###autoload
5240 (defun org-export-dispatch (&optional arg)
5241 "Export dispatcher for Org mode.
5243 It provides an access to common export related tasks in a buffer.
5244 Its interface comes in two flavours: standard and expert. While
5245 both share the same set of bindings, only the former displays the
5246 valid keys associations in a dedicated buffer. Set
5247 `org-export-dispatch-use-expert-ui' to switch to one flavour or
5248 the other.
5251 of options used back then, on the current buffer.
5253 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5254 (interactive "P")
5255 (let* ((input
5256 (cond ((equal arg '(16)) '(stack))
5257 ((and arg org-export-dispatch-last-action))
5258 (t (save-window-excursion
5259 (unwind-protect
5260 ;; Store this export command.
5261 (setq org-export-dispatch-last-action
5262 (org-export-dispatch-ui
5263 (list org-export-initial-scope
5264 (and org-export-in-background 'async))
5265 nil
5266 org-export-dispatch-use-expert-ui))
5267 (and (get-buffer "*Org Export Dispatcher*")
5268 (kill-buffer "*Org Export Dispatcher*")))))))
5269 (action (car input))
5270 (optns (cdr input)))
5271 (case action
5272 ;; First handle special hard-coded actions.
5273 (stack (org-export-stack))
5274 (publish-current-file
5275 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5276 (publish-current-project
5277 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5278 (publish-choose-project
5279 (org-publish (assoc (org-icompleting-read
5280 "Publish project: "
5281 org-publish-project-alist nil t)
5282 org-publish-project-alist)
5283 (memq 'force optns)
5284 (memq 'async optns)))
5285 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5286 (otherwise (funcall action
5287 ;; Return a symbol instead of a list to ease
5288 ;; asynchronous export macro use.
5289 (and (memq 'async optns) t)
5290 (and (memq 'subtree optns) t)
5291 (and (memq 'visible optns) t)
5292 (and (memq 'body optns) t))))))
5294 (defun org-export-dispatch-ui (options first-key expertp)
5295 "Handle interface for `org-export-dispatch'.
5297 OPTIONS is a list containing current interactive options set for
5298 export. It can contain any of the following symbols:
5299 `body' toggles a body-only export
5300 `subtree' restricts export to current subtree
5301 `visible' restricts export to visible part of buffer.
5302 `force' force publishing files.
5303 `async' use asynchronous export process
5305 FIRST-KEY is the key pressed to select the first level menu. It
5306 is nil when this menu hasn't been selected yet.
5308 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5309 buffer is provided, but indications about currently active
5310 options are given in the prompt. Moreover, \[?] allows to switch
5311 back to standard interface."
5312 (let* ((fontify-key
5313 (lambda (key &optional access-key)
5314 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5315 ;; non-nil is the required first-level key to activate
5316 ;; KEY. When its value is t, activate KEY independently
5317 ;; on the first key, if any. A nil value means KEY will
5318 ;; only be activated at first level.
5319 (if (or (eq access-key t) (eq access-key first-key))
5320 (org-propertize key 'face 'org-warning)
5321 key)))
5322 (fontify-value
5323 (lambda (value)
5324 ;; Fontify VALUE string.
5325 (org-propertize value 'face 'font-lock-variable-name-face)))
5326 ;; Prepare menu entries by extracting them from
5327 ;; `org-export-registered-backends', and sorting them by
5328 ;; access key and by ordinal, if any.
5329 (backends
5330 (sort
5331 (sort
5332 (delq nil
5333 (mapcar
5334 (lambda (b)
5335 (let ((name (car b)))
5336 (catch 'ignored
5337 ;; Ignore any back-end belonging to
5338 ;; `org-export-invisible-backends' or derived
5339 ;; from one of them.
5340 (dolist (ignored org-export-invisible-backends)
5341 (when (org-export-derived-backend-p name ignored)
5342 (throw 'ignored nil)))
5343 (org-export-backend-menu name))))
5344 org-export-registered-backends))
5345 (lambda (a b)
5346 (let ((key-a (nth 1 a))
5347 (key-b (nth 1 b)))
5348 (cond ((and (numberp key-a) (numberp key-b))
5349 (< key-a key-b))
5350 ((numberp key-b) t)))))
5351 (lambda (a b) (< (car a) (car b)))))
5352 ;; Compute a list of allowed keys based on the first key
5353 ;; pressed, if any. Some keys (?^B, ?^V, ?^S, ?^F, ?^A
5354 ;; and ?q) are always available.
5355 (allowed-keys
5356 (nconc (list ?\x02 ?\x16 ?\x13 ?\x06 ?\x01)
5357 (if (not first-key) (org-uniquify (mapcar 'car backends))
5358 (let (sub-menu)
5359 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5360 (when (eq (car backend) first-key)
5361 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5362 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5363 ((not first-key) (list ?P)))
5364 (list ?&)
5365 (when expertp (list ??))
5366 (list ?q)))
5367 ;; Build the help menu for standard UI.
5368 (help
5369 (unless expertp
5370 (concat
5371 ;; Options are hard-coded.
5372 (format "Options
5373 [%s] Body only: %s [%s] Visible only: %s
5374 [%s] Export scope: %s [%s] Force publishing: %s
5376 (funcall fontify-key "C-b" t)
5377 (funcall fontify-value
5378 (if (memq 'body options) "On " "Off"))
5379 (funcall fontify-key "C-v" t)
5380 (funcall fontify-value
5381 (if (memq 'visible options) "On " "Off"))
5382 (funcall fontify-key "C-s" t)
5383 (funcall fontify-value
5384 (if (memq 'subtree options) "Subtree" "Buffer "))
5385 (funcall fontify-key "C-f" t)
5386 (funcall fontify-value
5387 (if (memq 'force options) "On " "Off"))
5388 (funcall fontify-key "C-a" t)
5389 (funcall fontify-value
5390 (if (memq 'async options) "On " "Off")))
5391 ;; Display registered back-end entries. When a key
5392 ;; appears for the second time, do not create another
5393 ;; entry, but append its sub-menu to existing menu.
5394 (let (last-key)
5395 (mapconcat
5396 (lambda (entry)
5397 (let ((top-key (car entry)))
5398 (concat
5399 (unless (eq top-key last-key)
5400 (setq last-key top-key)
5402 (funcall fontify-key (char-to-string top-key))
5403 (nth 1 entry)))
5404 (let ((sub-menu (nth 2 entry)))
5405 (unless (functionp sub-menu)
5406 ;; Split sub-menu into two columns.
5407 (let ((index -1))
5408 (concat
5409 (mapconcat
5410 (lambda (sub-entry)
5411 (incf index)
5412 (format
5413 (if (zerop (mod index 2)) " [%s] %-26s"
5415 (funcall fontify-key
5416 (char-to-string (car sub-entry))
5417 top-key)
5418 (nth 1 sub-entry)))
5419 sub-menu "")
5421 backends ""))
5422 ;; Publishing menu is hard-coded.
5424 [%s] Current file [%s] Current project
5426 (funcall fontify-key "P")
5427 (funcall fontify-key "f" ?P)
5428 (funcall fontify-key "p" ?P)
5429 (funcall fontify-key "x" ?P)
5430 (funcall fontify-key "a" ?P))
5432 (format "\[%s] %s"
5433 (funcall fontify-key "q" t)
5434 (if first-key "Main menu" "Exit")))))
5435 ;; Build prompts for both standard and expert UI.
5436 (standard-prompt (unless expertp "Export command: "))
5437 (expert-prompt
5438 (when expertp
5439 (format
5440 "Export command (C-%s%s%s%s%s) [%s]: "
5441 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5442 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5443 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5444 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5445 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5446 (mapconcat (lambda (k)
5447 ;; Strip control characters.
5448 (unless (< k 27) (char-to-string k)))
5449 allowed-keys "")))))
5450 ;; With expert UI, just read key with a fancy prompt. In standard
5451 ;; UI, display an intrusive help buffer.
5452 (if expertp
5453 (org-export-dispatch-action
5454 expert-prompt allowed-keys backends options first-key expertp)
5455 ;; At first call, create frame layout in order to display menu.
5456 (unless (get-buffer "*Org Export Dispatcher*")
5457 (delete-other-windows)
5458 (org-switch-to-buffer-other-window
5459 (get-buffer-create "*Org Export Dispatcher*"))
5460 (setq cursor-type nil))
5461 ;; At this point, the buffer containing the menu exists and is
5462 ;; visible in the current window. So, refresh it.
5463 (with-current-buffer "*Org Export Dispatcher*"
5464 (erase-buffer)
5465 (insert help))
5466 (org-fit-window-to-buffer)
5467 (org-export-dispatch-action
5468 standard-prompt allowed-keys backends options first-key expertp))))
5470 (defun org-export-dispatch-action
5471 (prompt allowed-keys backends options first-key expertp)
5472 "Read a character from command input and act accordingly.
5474 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5475 a list of characters available at a given step in the process.
5476 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5477 EXPERTP are the same as defined in `org-export-dispatch-ui',
5478 which see.
5480 Toggle export options when required. Otherwise, return value is
5481 a list with action as CAR and a list of interactive export
5482 options as CDR."
5483 (let ((key (read-char-exclusive prompt)))
5484 (cond
5485 ;; Ignore undefined associations.
5486 ((not (memq key allowed-keys))
5487 (ding)
5488 (unless expertp (message "Invalid key") (sit-for 1))
5489 (org-export-dispatch-ui options first-key expertp))
5490 ;; q key at first level aborts export. At second
5491 ;; level, cancel first key instead.
5492 ((eq key ?q) (if (not first-key) (error "Export aborted")
5493 (org-export-dispatch-ui options nil expertp)))
5494 ;; Help key: Switch back to standard interface if
5495 ;; expert UI was active.
5496 ((eq key ??) (org-export-dispatch-ui options first-key nil))
5497 ;; Switch to asynchronous export stack.
5498 ((eq key ?&) '(stack))
5499 ;; Toggle export options.
5500 ((memq key '(?\x02 ?\x16 ?\x13 ?\x06 ?\x01))
5501 (org-export-dispatch-ui
5502 (let ((option (case key (?\x02 'body) (?\x16 'visible) (?\x13 'subtree)
5503 (?\x06 'force) (?\x01 'async))))
5504 (if (memq option options) (remq option options)
5505 (cons option options)))
5506 first-key expertp))
5507 ;; Action selected: Send key and options back to
5508 ;; `org-export-dispatch'.
5509 ((or first-key (functionp (nth 2 (assq key backends))))
5510 (cons (cond
5511 ((not first-key) (nth 2 (assq key backends)))
5512 ;; Publishing actions are hard-coded. Send a special
5513 ;; signal to `org-export-dispatch'.
5514 ((eq first-key ?P)
5515 (case key
5516 (?f 'publish-current-file)
5517 (?p 'publish-current-project)
5518 (?x 'publish-choose-project)
5519 (?a 'publish-all)))
5520 ;; Return first action associated to FIRST-KEY + KEY
5521 ;; path. Indeed, derived backends can share the same
5522 ;; FIRST-KEY.
5523 (t (catch 'found
5524 (mapc (lambda (backend)
5525 (let ((match (assq key (nth 2 backend))))
5526 (when match (throw 'found (nth 2 match)))))
5527 (member (assq first-key backends) backends)))))
5528 options))
5529 ;; Otherwise, enter sub-menu.
5530 (t (org-export-dispatch-ui options key expertp)))))
5534 (provide 'ox)
5536 ;; Local variables:
5537 ;; generated-autoload-file: "org-loaddefs.el"
5538 ;; End:
5540 ;;; ox.el ends here