d83c11bd68edaa74cd42d1c1901402bb9a39e7af
| blob | d83c11bd68edaa74cd42d1c1901402bb9a39e7af |
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' symbol and another one to the
834 `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.
841 The latter, when defined, is to be called on every text not
842 recognized as an element or an object. It must accept two
843 arguments: the text string and the information channel. It is an
844 appropriate place to protect special chars relative to the
845 back-end.
847 BODY can start with pre-defined keyword arguments. The following
848 keywords are understood:
850 :export-block
852 String, or list of strings, representing block names that
853 will not be parsed. This is used to specify blocks that will
854 contain raw code specific to the back-end. These blocks
855 still have to be handled by the relative `export-block' type
856 translator.
858 :filters-alist
860 Alist between filters and function, or list of functions,
861 specific to the back-end. See `org-export-filters-alist' for
862 a list of all allowed filters. Filters defined here
863 shouldn't make a back-end test, as it may prevent back-ends
864 derived from this one to behave properly.
866 :menu-entry
868 Menu entry for the export dispatcher. It should be a list
869 like:
871 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
873 where :
875 KEY is a free character selecting the back-end.
877 DESCRIPTION-OR-ORDINAL is either a string or a number.
879 If it is a string, is will be used to name the back-end in
880 its menu entry. If it is a number, the following menu will
881 be displayed as a sub-menu of the back-end with the same
882 KEY. Also, the number will be used to determine in which
883 order such sub-menus will appear (lowest first).
885 ACTION-OR-MENU is either a function or an alist.
887 If it is an action, it will be called with four
888 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
889 BODY-ONLY. See `org-export-as' for further explanations on
890 some of them.
892 If it is an alist, associations should follow the
893 pattern:
895 \(KEY DESCRIPTION ACTION)
897 where KEY, DESCRIPTION and ACTION are described above.
899 Valid values include:
903 or
908 \(lambda (a s v b)
909 \(if a (org-latex-export-to-pdf t s v b)
910 \(org-open-file
911 \(org-latex-export-to-pdf nil s v b)))))))
913 or the following, which will be added to the previous
914 sub-menu,
916 \(?l 1
920 :options-alist
922 Alist between back-end specific properties introduced in
923 communication channel and how their value are acquired. See
924 `org-export-options-alist' for more information about
925 structure of the values."
944 ;; Register back-end.
948 ;; Tell parser to not parse EXPORT-BLOCK blocks.
955 ;; Splice in the body, if any.
959 "Create a new back-end as a variant of an existing one.
961 CHILD is the name of the derived back-end. PARENT is the name of
962 the parent back-end.
964 BODY can start with pre-defined keyword arguments. The following
965 keywords are understood:
967 :export-block
969 String, or list of strings, representing block names that
970 will not be parsed. This is used to specify blocks that will
971 contain raw code specific to the back-end. These blocks
972 still have to be handled by the relative `export-block' type
973 translator.
975 :filters-alist
977 Alist of filters that will overwrite or complete filters
978 defined in PARENT back-end. See `org-export-filters-alist'
979 for a list of allowed filters.
981 :menu-entry
983 Menu entry for the export dispatcher. See
984 `org-export-define-backend' for more information about the
985 expected value.
987 :options-alist
989 Alist of back-end specific properties that will overwrite or
990 complete those defined in PARENT back-end. Refer to
991 `org-export-options-alist' for more information about
992 structure of the values.
994 :translate-alist
996 Alist of element and object types and transcoders that will
997 overwrite or complete transcode table from PARENT back-end.
998 Refer to `org-export-define-backend' for detailed information
999 about transcoders.
1002 as a variant of `latex' back-end with a custom template function:
1004 \(org-export-define-derived-backend my-latex latex
1005 :translate-alist ((template . my-latex-template-fun)))
1007 The back-end could then be called with, for example:
1035 ;; Register back-end.
1039 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1046 ;; Splice in the body, if any.
1050 "Return back-end from which BACKEND is derived, or nil."
1054 "Return filters for BACKEND."
1059 "Return menu entry for BACKEND."
1064 "Return export options for BACKEND."
1069 "Return translate table for BACKEND."
1074 "Signal an error if BACKEND isn't defined."
1079 "Non-nil if BACKEND is derived from one of BACKENDS."
1083 parent))
1086 \f
1087 ;;; The Communication Channel
1088 ;;
1089 ;; During export process, every function has access to a number of
1090 ;; properties. They are of two types:
1091 ;;
1092 ;; 1. Environment options are collected once at the very beginning of
1093 ;; the process, out of the original buffer and configuration.
1094 ;; Collecting them is handled by `org-export-get-environment'
1095 ;; function.
1096 ;;
1097 ;; Most environment options are defined through the
1098 ;; `org-export-options-alist' variable.
1099 ;;
1100 ;; 2. Tree properties are extracted directly from the parsed tree,
1101 ;; just before export, by `org-export-collect-tree-properties'.
1102 ;;
1103 ;; Here is the full list of properties available during transcode
1104 ;; process, with their category and their value type.
1105 ;;
1106 ;; + `:author' :: Author's name.
1107 ;; - category :: option
1108 ;; - type :: string
1109 ;;
1110 ;; + `:back-end' :: Current back-end used for transcoding.
1111 ;; - category :: tree
1112 ;; - type :: symbol
1113 ;;
1114 ;; + `:creator' :: String to write as creation information.
1115 ;; - category :: option
1116 ;; - type :: string
1117 ;;
1118 ;; + `:date' :: String to use as date.
1119 ;; - category :: option
1120 ;; - type :: string
1121 ;;
1122 ;; + `:description' :: Description text for the current data.
1123 ;; - category :: option
1124 ;; - type :: string
1125 ;;
1126 ;; + `:email' :: Author's email.
1127 ;; - category :: option
1128 ;; - type :: string
1129 ;;
1130 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1131 ;; process.
1132 ;; - category :: option
1133 ;; - type :: list of strings
1134 ;;
1135 ;; + `:exported-data' :: Hash table used for memoizing
1136 ;; `org-export-data'.
1137 ;; - category :: tree
1138 ;; - type :: hash table
1139 ;;
1140 ;; + `:filetags' :: List of global tags for buffer. Used by
1141 ;; `org-export-get-tags' to get tags with inheritance.
1142 ;; - category :: option
1143 ;; - type :: list of strings
1144 ;;
1145 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1146 ;; their definition, as parsed data. Only non-inlined footnotes
1147 ;; are represented in this alist. Also, every definition isn't
1148 ;; guaranteed to be referenced in the parse tree. The purpose of
1149 ;; this property is to preserve definitions from oblivion
1150 ;; (i.e. when the parse tree comes from a part of the original
1151 ;; buffer), it isn't meant for direct use in a back-end. To
1152 ;; retrieve a definition relative to a reference, use
1153 ;; `org-export-get-footnote-definition' instead.
1154 ;; - category :: option
1155 ;; - type :: alist (STRING . LIST)
1156 ;;
1157 ;; + `:headline-levels' :: Maximum level being exported as an
1158 ;; headline. Comparison is done with the relative level of
1159 ;; headlines in the parse tree, not necessarily with their
1160 ;; actual level.
1161 ;; - category :: option
1162 ;; - type :: integer
1163 ;;
1164 ;; + `:headline-offset' :: Difference between relative and real level
1165 ;; of headlines in the parse tree. For example, a value of -1
1166 ;; means a level 2 headline should be considered as level
1167 ;; 1 (cf. `org-export-get-relative-level').
1168 ;; - category :: tree
1169 ;; - type :: integer
1170 ;;
1171 ;; + `:headline-numbering' :: Alist between headlines and their
1172 ;; numbering, as a list of numbers
1173 ;; (cf. `org-export-get-headline-number').
1174 ;; - category :: tree
1175 ;; - type :: alist (INTEGER . LIST)
1176 ;;
1177 ;; + `:id-alist' :: Alist between ID strings and destination file's
1178 ;; path, relative to current directory. It is used by
1179 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1180 ;; external file.
1181 ;; - category :: option
1182 ;; - type :: alist (STRING . STRING)
1183 ;;
1184 ;; + `:ignore-list' :: List of elements and objects that should be
1185 ;; ignored during export.
1186 ;; - category :: tree
1187 ;; - type :: list of elements and objects
1188 ;;
1189 ;; + `:input-file' :: Full path to input file, if any.
1190 ;; - category :: option
1191 ;; - type :: string or nil
1192 ;;
1193 ;; + `:keywords' :: List of keywords attached to data.
1194 ;; - category :: option
1195 ;; - type :: string
1196 ;;
1197 ;; + `:language' :: Default language used for translations.
1198 ;; - category :: option
1199 ;; - type :: string
1200 ;;
1201 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1202 ;; transcoding.
1203 ;; - category :: option
1204 ;; - type :: list (as returned by `org-element-parse-buffer')
1205 ;;
1206 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1207 ;; all line breaks.
1208 ;; - category :: option
1209 ;; - type :: symbol (nil, t)
1210 ;;
1211 ;; + `:section-numbers' :: Non-nil means transcoding should add
1212 ;; section numbers to headlines.
1213 ;; - category :: option
1214 ;; - type :: symbol (nil, t)
1215 ;;
1216 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1217 ;; in transcoding. When such a tag is present, subtrees without
1218 ;; it are de facto excluded from the process. See
1219 ;; `use-select-tags'.
1220 ;; - category :: option
1221 ;; - type :: list of strings
1222 ;;
1223 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1224 ;; a time stamp in the output.
1225 ;; - category :: option
1226 ;; - type :: symbol (nil, t)
1227 ;;
1228 ;; + `:translate-alist' :: Alist between element and object types and
1229 ;; transcoding functions relative to the current back-end.
1230 ;; Special keys `template' and `plain-text' are also possible.
1231 ;; - category :: option
1232 ;; - type :: alist (SYMBOL . FUNCTION)
1233 ;;
1234 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1235 ;; also be transcoded. If it is set to the `headline' symbol,
1236 ;; only the archived headline's name is retained.
1237 ;; - category :: option
1238 ;; - type :: symbol (nil, t, `headline')
1239 ;;
1240 ;; + `:with-author' :: Non-nil means author's name should be included
1241 ;; in the output.
1242 ;; - category :: option
1243 ;; - type :: symbol (nil, t)
1244 ;;
1245 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1246 ;; - category :: option
1247 ;; - type :: symbol (nil, t)
1248 ;;
1249 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1250 ;; inserted at the end of the transcoded string. If the value
1251 ;; is `comment', it should be commented.
1252 ;; - category :: option
1253 ;; - type :: symbol (`comment', nil, t)
1254 ;;
1255 ;; + `:with-date' :: Non-nil means output should contain a date.
1256 ;; - category :: option
1257 ;; - type :. symbol (nil, t)
1258 ;;
1259 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1260 ;; its value is a list of names, only drawers with such names
1261 ;; will be transcoded. If that list starts with `not', drawer
1262 ;; with these names will be skipped.
1263 ;; - category :: option
1264 ;; - type :: symbol (nil, t) or list of strings
1265 ;;
1266 ;; + `:with-email' :: Non-nil means output should contain author's
1267 ;; email.
1268 ;; - category :: option
1269 ;; - type :: symbol (nil, t)
1270 ;;
1271 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1272 ;; interpreted.
1273 ;; - category :: option
1274 ;; - type :: symbol (nil, t)
1275 ;;
1276 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1277 ;; strings starting with a colon as a fixed-with (verbatim) area.
1278 ;; - category :: option
1279 ;; - type :: symbol (nil, t)
1280 ;;
1281 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1282 ;; footnotes.
1283 ;; - category :: option
1284 ;; - type :: symbol (nil, t)
1285 ;;
1286 ;; + `:with-latex' :: Non-nil means `latex-environment' elements and
1287 ;; `latex-fragment' objects should appear in export output. When
1288 ;; this property is set to `verbatim', they will be left as-is.
1289 ;; - category :: option
1290 ;; - symbol (`verbatim', nil, t)
1291 ;;
1292 ;; + `:with-plannings' :: Non-nil means transcoding should include
1293 ;; planning info.
1294 ;; - category :: option
1295 ;; - type :: symbol (nil, t)
1296 ;;
1297 ;; + `:with-priority' :: Non-nil means transcoding should include
1298 ;; priority cookies.
1299 ;; - category :: option
1300 ;; - type :: symbol (nil, t)
1301 ;;
1302 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1303 ;; plain text.
1304 ;; - category :: option
1305 ;; - type :: symbol (nil, t)
1306 ;;
1307 ;; + `:with-special-strings' :: Non-nil means transcoding should
1308 ;; interpret special strings in plain text.
1309 ;; - category :: option
1310 ;; - type :: symbol (nil, t)
1311 ;;
1312 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1313 ;; interpret subscript and superscript. With a value of "{}",
1314 ;; only interpret those using curly brackets.
1315 ;; - category :: option
1316 ;; - type :: symbol (nil, {}, t)
1317 ;;
1318 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1319 ;; tables.
1320 ;; - category :: option
1321 ;; - type :: symbol (nil, t)
1322 ;;
1323 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1324 ;; headlines. A `not-in-toc' value will remove them from the
1325 ;; table of contents, if any, nonetheless.
1326 ;; - category :: option
1327 ;; - type :: symbol (nil, t, `not-in-toc')
1328 ;;
1329 ;; + `:with-tasks' :: Non-nil means transcoding should include
1330 ;; headlines with a TODO keyword. A `todo' value will only
1331 ;; include headlines with a todo type keyword while a `done'
1332 ;; value will do the contrary. If a list of strings is provided,
1333 ;; only tasks with keywords belonging to that list will be kept.
1334 ;; - category :: option
1335 ;; - type :: symbol (t, todo, done, nil) or list of strings
1336 ;;
1337 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1338 ;; time stamps. Special value `active' (resp. `inactive') ask to
1339 ;; export only active (resp. inactive) timestamps. Otherwise,
1340 ;; completely remove them.
1341 ;; - category :: option
1342 ;; - type :: symbol: (`active', `inactive', t, nil)
1343 ;;
1344 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1345 ;; added to the output. An integer value limits its depth.
1346 ;; - category :: option
1347 ;; - type :: symbol (nil, t or integer)
1348 ;;
1349 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1350 ;; include TODO keywords.
1351 ;; - category :: option
1352 ;; - type :: symbol (nil, t)
1355 ;;;; Environment Options
1356 ;;
1357 ;; Environment options encompass all parameters defined outside the
1358 ;; scope of the parsed data. They come from five sources, in
1359 ;; increasing precedence order:
1360 ;;
1361 ;; - Global variables,
1362 ;; - Buffer's attributes,
1363 ;; - Options keyword symbols,
1364 ;; - Buffer keywords,
1365 ;; - Subtree properties.
1366 ;;
1367 ;; The central internal function with regards to environment options
1368 ;; is `org-export-get-environment'. It updates global variables with
1369 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1370 ;; the different sources.
1371 ;;
1372 ;; The internal functions doing the retrieval are:
1373 ;; `org-export--get-global-options',
1374 ;; `org-export--get-buffer-attributes',
1375 ;; `org-export--parse-option-keyword',
1376 ;; `org-export--get-subtree-options' and
1377 ;; `org-export--get-inbuffer-options'
1378 ;;
1379 ;; Also, `org-export--install-letbind-maybe' takes care of the part
1380 ;; relative to "#+BIND:" keywords.
1383 "Collect export options from the current buffer.
1385 Optional argument BACKEND is a symbol specifying which back-end
1386 specific options to read, if any.
1388 When optional argument SUBTREEP is non-nil, assume the export is
1389 done against the current sub-tree.
1391 Third optional argument EXT-PLIST is a property list with
1392 external parameters overriding Org default settings, but still
1393 inferior to file-local settings."
1394 ;; First install #+BIND variables.
1396 ;; Get and prioritize export options...
1398 ;; ... from global variables...
1400 ;; ... from an external property list...
1401 ext-plist
1402 ;; ... from in-buffer settings...
1404 backend
1406 ;; ... and from subtree, when appropriate.
1408 ;; Eventually add misc. properties.
1410 :back-end
1411 backend
1412 :translate-alist
1414 :footnote-definition-alist
1415 ;; Footnotes definitions must be collected in the original
1416 ;; buffer, as there's no insurance that they will still be in
1417 ;; the parse tree, due to possible narrowing.
1431 alist))))
1432 alist))
1433 :id-alist
1434 ;; Collect id references.
1445 alist))))
1448 "Parse an OPTIONS line and return values as a plist.
1449 Optional argument BACKEND is a symbol specifying which back-end
1450 specific items to read, if any."
1452 ;; Priority is given to back-end specific options.
1454 org-export-options-alist))
1455 plist)
1464 options))
1466 property
1469 plist))
1472 "Get export options in subtree at point.
1473 Optional argument BACKEND is a symbol specifying back-end used
1474 for export. Return options as a plist."
1475 ;; For each buffer keyword, create an headline property setting the
1476 ;; same property in communication channel. The name for the property
1477 ;; is the keyword with "EXPORT_" appended to it.
1480 ;; Make sure point is at an heading.
1482 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1483 ;; title as its fallback value.
1489 plist :title
1492 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1496 ;; Handle other keywords. TITLE keyword is excluded as it has
1497 ;; been handled already.
1505 ;; Export properties are not case-sensitive.
1512 plist
1513 property
1515 ;; Parse VALUE if required.
1519 ;; If BEHAVIOUR is `split' expected value is
1520 ;; a list of strings, not a string.
1523 ;; Look for both general keywords and back-end specific
1524 ;; options, with priority given to the latter.
1526 org-export-options-alist)))
1527 ;; Return value.
1528 plist)))
1531 "Return current buffer export options, as a plist.
1533 Optional argument BACKEND, when non-nil, is a symbol specifying
1534 which back-end specific options should also be read in the
1535 process.
1537 Optional argument FILES is a list of setup files names read so
1538 far, used to avoid circular dependencies.
1540 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1544 ;; 1. Special keywords, as in `org-export-special-keywords'.
1558 ;; Avoid circular dependencies.
1573 ;; 2. Standard options, as in `org-export-options-alist'.
1575 ;; Priority is given to back-end specific options.
1577 org-export-options-alist)))
1592 ;; Handle value depending on specified
1593 ;; BEHAVIOUR.
1598 " "
1610 ;; Parse keywords specified in
1611 ;; `org-element-document-properties'.
1614 ;; Find the property associated to the keyword.
1619 all)))
1624 plist prop
1627 org-element-document-properties))
1628 ;; 3. Return final value.
1629 plist)))
1632 "Return properties related to buffer attributes, as a plist."
1635 ;; Store full path of input file name, or nil. For internal use.
1636 :input-file visited-file
1643 "Return global export options as a plist.
1645 Optional argument BACKEND, if non-nil, is a symbol specifying
1646 which back-end specific export options should also be read in the
1647 process."
1649 ;; Priority is given to back-end specific options.
1651 org-export-options-alist))
1652 plist)
1659 plist
1660 prop
1661 ;; Eval default value provided. If keyword is a member
1662 ;; of `org-element-document-properties', parse it as
1663 ;; a secondary string before storing it.
1668 value
1671 all)
1672 ;; Return value.
1673 plist))
1676 "Install the values from #+BIND lines as local variables.
1677 Variables must be installed before in-buffer options are
1678 retrieved."
1693 ;;;; Tree Properties
1694 ;;
1695 ;; Tree properties are information extracted from parse tree. They
1696 ;; are initialized at the beginning of the transcoding process by
1697 ;; `org-export-collect-tree-properties'.
1698 ;;
1699 ;; Dedicated functions focus on computing the value of specific tree
1700 ;; properties during initialization. Thus,
1701 ;; `org-export--populate-ignore-list' lists elements and objects that
1702 ;; should be skipped during export, `org-export--get-min-level' gets
1703 ;; the minimal exportable level, used as a basis to compute relative
1704 ;; level for headlines. Eventually
1705 ;; `org-export--collect-headline-numbering' builds an alist between
1706 ;; headlines and their numbering.
1709 "Extract tree properties from parse tree.
1711 DATA is the parse tree from which information is retrieved. INFO
1712 is a list holding export options.
1714 Following tree properties are set or updated:
1716 `:exported-data' Hash table used to memoize results from
1717 `org-export-data'.
1719 `:footnote-definition-alist' List of footnotes definitions in
1720 original buffer and current parse tree.
1722 `:headline-offset' Offset between true level of headlines and
1723 local level. An offset of -1 means an headline
1724 of level 2 should be considered as a level
1725 1 headline in the context.
1727 `:headline-numbering' Alist of all headlines as key an the
1728 associated numbering as value.
1730 `:ignore-list' List of elements that should be ignored during
1731 export.
1733 Return updated plist."
1734 ;; Install the parse tree in the communication channel, in order to
1735 ;; use `org-export-get-genealogy' and al.
1737 ;; Get the list of elements and objects to ignore, and put it into
1738 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1739 ;; been done during parse tree filtering.
1742 :ignore-list
1745 ;; Compute `:headline-offset' in order to be able to use
1746 ;; `org-export-get-relative-level'.
1749 :headline-offset
1751 ;; Update footnotes definitions list with definitions in parse tree.
1752 ;; This is required since buffer expansion might have modified
1753 ;; boundaries of footnote definitions contained in the parse tree.
1754 ;; This way, definitions in `footnote-definition-alist' are bound to
1755 ;; match those in the parse tree.
1761 defs)))
1763 ;; Properties order doesn't matter: get the rest of the tree
1764 ;; properties.
1768 info))
1771 "Return minimum exportable headline's level in DATA.
1772 DATA is parsed tree as returned by `org-element-parse-buffer'.
1773 OPTIONS is a plist holding export options."
1784 ;; If no headline was found, for the sake of consistency, set
1785 ;; minimum level to 1 nonetheless.
1789 "Return numbering of all exportable headlines in a parse tree.
1791 DATA is the parse tree. OPTIONS is the plist holding export
1792 options.
1794 Return an alist whose key is an headline and value is its
1795 associated numbering \(in the shape of a list of numbers\)."
1802 headline
1804 for idx from 0 to org-export-max-depth
1808 options)))
1811 "Return list of elements and objects to ignore during export.
1812 DATA is the parse tree to traverse. OPTIONS is the plist holding
1813 export options."
1815 walk-data
1816 ;; First find trees containing a select tag, if any.
1820 ;; Collect ignored elements or objects into IGNORE-LIST.
1826 ;; If headline is archived but tree below has
1827 ;; to be skipped, add it to ignore list.
1830 ;; Move into secondary string, if any.
1835 ;; Move into recursive objects/elements.
1837 ;; Main call.
1839 ;; Return value.
1840 ignore))
1843 "Return list of headlines containing a select tag in their tree.
1844 DATA is parsed data as returned by `org-element-parse-buffer'.
1845 INFO is a plist holding export options."
1847 walk-data ; for byte-compiler.
1858 ;; When a select tag is found, mark full
1859 ;; genealogy and every headline within the tree
1860 ;; as acceptable.
1863 genealogy
1865 selected-trees))
1866 ;; Else, continue searching in tree, recursively.
1873 "Non-nil when element or object BLOB should be skipped during export.
1874 OPTIONS is the plist holding export options. SELECTED, when
1875 non-nil, is a list of headlines belonging to a tree with a select
1876 tag."
1883 ;; If `:with-drawers' value starts with `not', ignore
1884 ;; every drawer whose name belong to that list.
1885 ;; Otherwise, ignore drawers whose name isn't in that
1886 ;; list.
1898 ;; Ignore subtrees with an exclude tag.
1901 ;; When a select tag is present in the buffer, ignore any tree
1902 ;; without it.
1904 ;; Ignore commented sub-trees.
1906 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1908 ;; Ignore tasks, if specified by `:with-tasks' property.
1925 ;; No timestamp allowed.
1927 ;; Only active timestamps allowed and the current one isn't
1928 ;; active.
1932 ;; Only inactive timestamps allowed and the current one isn't
1933 ;; inactive.
1939 \f
1940 ;;; The Transcoder
1941 ;;
1942 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1943 ;; `org-element-parse-buffer') and transcodes it into a specified
1944 ;; back-end output. It takes care of filtering out elements or
1945 ;; objects according to export options and organizing the output blank
1946 ;; lines and white space are preserved. The function memoizes its
1947 ;; results, so it is cheap to call it within translators.
1948 ;;
1949 ;; It is possible to modify locally the back-end used by
1950 ;; `org-export-data' or even use a temporary back-end by using
1951 ;; `org-export-data-with-translations' and
1952 ;; `org-export-data-with-backend'.
1953 ;;
1954 ;; Internally, three functions handle the filtering of objects and
1955 ;; elements during the export. In particular,
1956 ;; `org-export-ignore-element' marks an element or object so future
1957 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1958 ;; elements or objects should be seen as real Org syntax and
1959 ;; `org-export-expand' transforms the others back into their original
1960 ;; shape
1961 ;;
1962 ;; `org-export-transcoder' is an accessor returning appropriate
1963 ;; translator function for a given element or object.
1966 "Return appropriate transcoder for BLOB.
1967 INFO is a plist containing export directives."
1969 ;; Return contents only for complete parse trees.
1975 "Convert DATA into current back-end format.
1977 DATA is a parse tree, an element or an object or a secondary
1978 string. INFO is a plist holding export options.
1980 Return transcoded string."
1986 ;; Ignored element/object.
1988 ;; Plain text.
1994 info))
1995 ;; Uninterpreted element/object: change it back to Org
1996 ;; syntax and export again resulting raw string.
2000 data
2004 info))
2005 ;; Secondary string.
2008 ;; Element/Object without contents or, as a special case,
2009 ;; headline with archive tag and archived trees restricted
2010 ;; to title only.
2018 ;; Element/Object with contents.
2031 ;; Elements directly containing objects
2032 ;; must have their indentation normalized
2033 ;; first.
2035 data
2036 ;; When normalizing contents of the first
2037 ;; paragraph in an item or a footnote
2038 ;; definition, ignore first line's
2039 ;; indentation: there is none and it
2040 ;; might be misleading.
2045 data)
2052 info))))))))
2053 ;; Final result will be memoized before being returned.
2055 data
2059 ;; Append the same white space between elements or objects as in
2060 ;; the original buffer, and call appropriate filters.
2071 info)))
2072 results)))
2076 "Convert DATA into another format using a given translation table.
2077 DATA is an element, an object, a secondary string or a string.
2078 TRANSLATIONS is an alist between element or object types and
2079 a functions handling them. See `org-export-define-backend' for
2080 more information. INFO is a plist used as a communication
2081 channel."
2083 data
2084 ;; Set-up a new communication channel with TRANSLATIONS as the
2085 ;; translate table and a new hash table for memoization.
2087 info
2089 ;; Size of the hash table is reduced since this function
2090 ;; will probably be used on short trees.
2094 "Convert DATA into BACKEND format.
2096 DATA is an element, an object, a secondary string or a string.
2097 BACKEND is a symbol. INFO is a plist used as a communication
2098 channel.
2100 Unlike to `org-export-with-backend', this function will
2101 recursively convert DATA using BACKEND translation table."
2107 "Non-nil if element or object BLOB should be interpreted during export.
2108 If nil, BLOB will appear as raw Org syntax. Check is done
2109 according to export options INFO, stored as a plist."
2111 ;; ... entities...
2113 ;; ... emphasis...
2116 ;; ... fixed-width areas.
2118 ;; ... footnotes...
2121 ;; ... LaTeX environments and fragments...
2125 ;; ... sub/superscripts...
2131 ;; ... tables...
2136 "Expand a parsed element or object to its original state.
2137 BLOB is either an element or an object. CONTENTS is its
2138 contents, as a string or nil."
2141 blob contents))
2144 "Add ELEMENT to `:ignore-list' in INFO.
2146 Any element in `:ignore-list' will be skipped when using
2147 `org-element-map'. INFO is modified by side effects."
2151 \f
2152 ;;; The Filter System
2153 ;;
2154 ;; Filters allow end-users to tweak easily the transcoded output.
2155 ;; They are the functional counterpart of hooks, as every filter in
2156 ;; a set is applied to the return value of the previous one.
2157 ;;
2158 ;; Every set is back-end agnostic. Although, a filter is always
2159 ;; called, in addition to the string it applies to, with the back-end
2160 ;; used as argument, so it's easy for the end-user to add back-end
2161 ;; specific filters in the set. The communication channel, as
2162 ;; a plist, is required as the third argument.
2163 ;;
2164 ;; From the developer side, filters sets can be installed in the
2165 ;; process with the help of `org-export-define-backend', which
2166 ;; internally stores filters as an alist. Each association has a key
2167 ;; among the following symbols and a function or a list of functions
2168 ;; as value.
2169 ;;
2170 ;; - `:filter-options' applies to the property list containing export
2171 ;; options. Unlike to other filters, functions in this list accept
2172 ;; two arguments instead of three: the property list containing
2173 ;; export options and the back-end. Users can set its value through
2174 ;; `org-export-filter-options-functions' variable.
2175 ;;
2176 ;; - `:filter-parse-tree' applies directly to the complete parsed
2177 ;; tree. Users can set it through
2178 ;; `org-export-filter-parse-tree-functions' variable.
2179 ;;
2180 ;; - `:filter-final-output' applies to the final transcoded string.
2181 ;; Users can set it with `org-export-filter-final-output-functions'
2182 ;; variable
2183 ;;
2184 ;; - `:filter-plain-text' applies to any string not recognized as Org
2185 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2186 ;; configure it.
2187 ;;
2188 ;; - `:filter-TYPE' applies on the string returned after an element or
2189 ;; object of type TYPE has been transcoded. An user can modify
2190 ;; `org-export-filter-TYPE-functions'
2191 ;;
2192 ;; All filters sets are applied with
2193 ;; `org-export-filter-apply-functions' function. Filters in a set are
2194 ;; applied in a LIFO fashion. It allows developers to be sure that
2195 ;; their filters will be applied first.
2196 ;;
2197 ;; Filters properties are installed in communication channel with
2198 ;; `org-export-install-filters' function.
2199 ;;
2200 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2201 ;; `org-export-before-parsing-hook') are run at the beginning of the
2202 ;; export process and just before parsing to allow for heavy structure
2203 ;; modifications.
2206 ;;;; Hooks
2209 "Hook run at the beginning of the export process.
2211 This is run before include keywords and macros are expanded and
2212 Babel code blocks executed, on a copy of the original buffer
2213 being exported. Visibility and narrowing are preserved. Point
2214 is at the beginning of the buffer.
2216 Every function in this hook will be called with one argument: the
2220 "Hook run before parsing an export buffer.
2222 This is run after include keywords and macros have been expanded
2223 and Babel code blocks executed, on a copy of the original buffer
2224 being exported. Visibility and narrowing are preserved. Point
2225 is at the beginning of the buffer.
2227 Every function in this hook will be called with one argument: the
2231 ;;;; Special Filters
2234 "List of functions applied to the export options.
2235 Each filter is called with two arguments: the export options, as
2236 a plist, and the back-end, as a symbol. It must return
2240 "List of functions applied to the parsed tree.
2241 Each filter is called with three arguments: the parse tree, as
2242 returned by `org-element-parse-buffer', the back-end, as
2243 a symbol, and the communication channel, as a plist. It must
2247 "List of functions applied to plain text.
2248 Each filter is called with three arguments: a string which
2249 contains no Org syntax, the back-end, as a symbol, and the
2250 communication channel, as a plist. It must return a string or
2254 "List of functions applied to the transcoded string.
2255 Each filter is called with three arguments: the full transcoded
2256 string, the back-end, as a symbol, and the communication channel,
2257 as a plist. It must return a string that will be used as the
2261 ;;;; Elements Filters
2264 "List of functions applied to a transcoded babel-call.
2265 Each filter is called with three arguments: the transcoded data,
2266 as a string, the back-end, as a symbol, and the communication
2270 "List of functions applied to a transcoded center block.
2271 Each filter is called with three arguments: the transcoded data,
2272 as a string, the back-end, as a symbol, and the communication
2276 "List of functions applied to a transcoded clock.
2277 Each filter is called with three arguments: the transcoded data,
2278 as a string, the back-end, as a symbol, and the communication
2282 "List of functions applied to a transcoded comment.
2283 Each filter is called with three arguments: the transcoded data,
2284 as a string, the back-end, as a symbol, and the communication
2288 "List of functions applied to a transcoded comment-block.
2289 Each filter is called with three arguments: the transcoded data,
2290 as a string, the back-end, as a symbol, and the communication
2294 "List of functions applied to a transcoded diary-sexp.
2295 Each filter is called with three arguments: the transcoded data,
2296 as a string, the back-end, as a symbol, and the communication
2300 "List of functions applied to a transcoded drawer.
2301 Each filter is called with three arguments: the transcoded data,
2302 as a string, the back-end, as a symbol, and the communication
2306 "List of functions applied to a transcoded dynamic-block.
2307 Each filter is called with three arguments: the transcoded data,
2308 as a string, the back-end, as a symbol, and the communication
2312 "List of functions applied to a transcoded example-block.
2313 Each filter is called with three arguments: the transcoded data,
2314 as a string, the back-end, as a symbol, and the communication
2318 "List of functions applied to a transcoded export-block.
2319 Each filter is called with three arguments: the transcoded data,
2320 as a string, the back-end, as a symbol, and the communication
2324 "List of functions applied to a transcoded fixed-width.
2325 Each filter is called with three arguments: the transcoded data,
2326 as a string, the back-end, as a symbol, and the communication
2330 "List of functions applied to a transcoded footnote-definition.
2331 Each filter is called with three arguments: the transcoded data,
2332 as a string, the back-end, as a symbol, and the communication
2336 "List of functions applied to a transcoded headline.
2337 Each filter is called with three arguments: the transcoded data,
2338 as a string, the back-end, as a symbol, and the communication
2342 "List of functions applied to a transcoded horizontal-rule.
2343 Each filter is called with three arguments: the transcoded data,
2344 as a string, the back-end, as a symbol, and the communication
2348 "List of functions applied to a transcoded inlinetask.
2349 Each filter is called with three arguments: the transcoded data,
2350 as a string, the back-end, as a symbol, and the communication
2354 "List of functions applied to a transcoded item.
2355 Each filter is called with three arguments: the transcoded data,
2356 as a string, the back-end, as a symbol, and the communication
2360 "List of functions applied to a transcoded keyword.
2361 Each filter is called with three arguments: the transcoded data,
2362 as a string, the back-end, as a symbol, and the communication
2366 "List of functions applied to a transcoded latex-environment.
2367 Each filter is called with three arguments: the transcoded data,
2368 as a string, the back-end, as a symbol, and the communication
2372 "List of functions applied to a transcoded node-property.
2373 Each filter is called with three arguments: the transcoded data,
2374 as a string, the back-end, as a symbol, and the communication
2378 "List of functions applied to a transcoded paragraph.
2379 Each filter is called with three arguments: the transcoded data,
2380 as a string, the back-end, as a symbol, and the communication
2384 "List of functions applied to a transcoded plain-list.
2385 Each filter is called with three arguments: the transcoded data,
2386 as a string, the back-end, as a symbol, and the communication
2390 "List of functions applied to a transcoded planning.
2391 Each filter is called with three arguments: the transcoded data,
2392 as a string, the back-end, as a symbol, and the communication
2396 "List of functions applied to a transcoded property-drawer.
2397 Each filter is called with three arguments: the transcoded data,
2398 as a string, the back-end, as a symbol, and the communication
2402 "List of functions applied to a transcoded quote block.
2403 Each filter is called with three arguments: the transcoded quote
2404 data, as a string, the back-end, as a symbol, and the
2405 communication channel, as a plist. It must return a string or
2409 "List of functions applied to a transcoded quote-section.
2410 Each filter is called with three arguments: the transcoded data,
2411 as a string, the back-end, as a symbol, and the communication
2415 "List of functions applied to a transcoded section.
2416 Each filter is called with three arguments: the transcoded data,
2417 as a string, the back-end, as a symbol, and the communication
2421 "List of functions applied to a transcoded special block.
2422 Each filter is called with three arguments: the transcoded data,
2423 as a string, the back-end, as a symbol, and the communication
2427 "List of functions applied to a transcoded src-block.
2428 Each filter is called with three arguments: the transcoded data,
2429 as a string, the back-end, as a symbol, and the communication
2433 "List of functions applied to a transcoded table.
2434 Each filter is called with three arguments: the transcoded data,
2435 as a string, the back-end, as a symbol, and the communication
2439 "List of functions applied to a transcoded table-cell.
2440 Each filter is called with three arguments: the transcoded data,
2441 as a string, the back-end, as a symbol, and the communication
2445 "List of functions applied to a transcoded table-row.
2446 Each filter is called with three arguments: the transcoded data,
2447 as a string, the back-end, as a symbol, and the communication
2451 "List of functions applied to a transcoded verse block.
2452 Each filter is called with three arguments: the transcoded data,
2453 as a string, the back-end, as a symbol, and the communication
2457 ;;;; Objects Filters
2460 "List of functions applied to transcoded bold text.
2461 Each filter is called with three arguments: the transcoded data,
2462 as a string, the back-end, as a symbol, and the communication
2466 "List of functions applied to transcoded code text.
2467 Each filter is called with three arguments: the transcoded data,
2468 as a string, the back-end, as a symbol, and the communication
2472 "List of functions applied to a transcoded entity.
2473 Each filter is called with three arguments: the transcoded data,
2474 as a string, the back-end, as a symbol, and the communication
2478 "List of functions applied to a transcoded export-snippet.
2479 Each filter is called with three arguments: the transcoded data,
2480 as a string, the back-end, as a symbol, and the communication
2484 "List of functions applied to a transcoded footnote-reference.
2485 Each filter is called with three arguments: the transcoded data,
2486 as a string, the back-end, as a symbol, and the communication
2490 "List of functions applied to a transcoded inline-babel-call.
2491 Each filter is called with three arguments: the transcoded data,
2492 as a string, the back-end, as a symbol, and the communication
2496 "List of functions applied to a transcoded inline-src-block.
2497 Each filter is called with three arguments: the transcoded data,
2498 as a string, the back-end, as a symbol, and the communication
2502 "List of functions applied to transcoded italic text.
2503 Each filter is called with three arguments: the transcoded data,
2504 as a string, the back-end, as a symbol, and the communication
2508 "List of functions applied to a transcoded latex-fragment.
2509 Each filter is called with three arguments: the transcoded data,
2510 as a string, the back-end, as a symbol, and the communication
2514 "List of functions applied to a transcoded line-break.
2515 Each filter is called with three arguments: the transcoded data,
2516 as a string, the back-end, as a symbol, and the communication
2520 "List of functions applied to a transcoded link.
2521 Each filter is called with three arguments: the transcoded data,
2522 as a string, the back-end, as a symbol, and the communication
2526 "List of functions applied to a transcoded macro.
2527 Each filter is called with three arguments: the transcoded data,
2528 as a string, the back-end, as a symbol, and the communication
2532 "List of functions applied to a transcoded radio-target.
2533 Each filter is called with three arguments: the transcoded data,
2534 as a string, the back-end, as a symbol, and the communication
2538 "List of functions applied to a transcoded statistics-cookie.
2539 Each filter is called with three arguments: the transcoded data,
2540 as a string, the back-end, as a symbol, and the communication
2544 "List of functions applied to transcoded strike-through text.
2545 Each filter is called with three arguments: the transcoded data,
2546 as a string, the back-end, as a symbol, and the communication
2550 "List of functions applied to a transcoded subscript.
2551 Each filter is called with three arguments: the transcoded data,
2552 as a string, the back-end, as a symbol, and the communication
2556 "List of functions applied to a transcoded superscript.
2557 Each filter is called with three arguments: the transcoded data,
2558 as a string, the back-end, as a symbol, and the communication
2562 "List of functions applied to a transcoded target.
2563 Each filter is called with three arguments: the transcoded data,
2564 as a string, the back-end, as a symbol, and the communication
2568 "List of functions applied to a transcoded timestamp.
2569 Each filter is called with three arguments: the transcoded data,
2570 as a string, the back-end, as a symbol, and the communication
2574 "List of functions applied to transcoded underline text.
2575 Each filter is called with three arguments: the transcoded data,
2576 as a string, the back-end, as a symbol, and the communication
2580 "List of functions applied to transcoded verbatim text.
2581 Each filter is called with three arguments: the transcoded data,
2582 as a string, the back-end, as a symbol, and the communication
2586 ;;;; Filters Tools
2587 ;;
2588 ;; Internal function `org-export-install-filters' installs filters
2589 ;; hard-coded in back-ends (developer filters) and filters from global
2590 ;; variables (user filters) in the communication channel.
2591 ;;
2592 ;; Internal function `org-export-filter-apply-functions' takes care
2593 ;; about applying each filter in order to a given data. It ignores
2594 ;; filters returning a nil value but stops whenever a filter returns
2595 ;; an empty string.
2598 "Call every function in FILTERS.
2600 Functions are called with arguments VALUE, current export
2601 back-end and INFO. A function returning a nil value will be
2602 skipped. If it returns the empty string, the process ends and
2603 VALUE is ignored.
2605 Call is done in a LIFO fashion, to be sure that developer
2606 specified filters, if any, are called first."
2615 "Install filters properties in communication channel.
2616 INFO is a plist containing the current communication channel.
2617 Return the updated communication channel."
2619 ;; Install user defined filters with `org-export-filters-alist'.
2622 org-export-filters-alist)
2623 ;; Prepend back-end specific filters to that list.
2625 ;; Single values get consed, lists are prepended.
2630 plist key
2634 ;; Return new communication channel.
2638 \f
2639 ;;; Core functions
2640 ;;
2641 ;; This is the room for the main function, `org-export-as', along with
2642 ;; its derivatives, `org-export-to-buffer', `org-export-to-file' and
2643 ;; `org-export-string-as'. They differ either by the way they output
2644 ;; the resulting code (for the first two) or by the input type (for
2645 ;; the latter).
2646 ;;
2647 ;; `org-export-output-file-name' is an auxiliary function meant to be
2648 ;; used with `org-export-to-file'. With a given extension, it tries
2649 ;; to provide a canonical file name to write export output to.
2650 ;;
2651 ;; Note that `org-export-as' doesn't really parse the current buffer,
2652 ;; but a copy of it (with the same buffer-local variables and
2653 ;; visibility), where macros and include keywords are expanded and
2654 ;; Babel blocks are executed, if appropriate.
2655 ;; `org-export-with-buffer-copy' macro prepares that copy.
2656 ;;
2657 ;; File inclusion is taken care of by
2658 ;; `org-export-expand-include-keyword' and
2659 ;; `org-export--prepare-file-contents'. Structure wise, including
2660 ;; a whole Org file in a buffer often makes little sense. For
2661 ;; example, if the file contains an headline and the include keyword
2662 ;; was within an item, the item should contain the headline. That's
2663 ;; why file inclusion should be done before any structure can be
2664 ;; associated to the file, that is before parsing.
2667 "Return a copy of the current buffer.
2668 The copy preserves Org buffer-local variables, visibility and
2669 narrowing."
2675 new-buf))
2678 "Apply BODY in a copy of the current buffer.
2679 The copy preserves local variables, visibility and contents of
2680 the original buffer. Point is at the beginning of the buffer
2681 when BODY is applied."
2690 ;; Kill copy without confirmation.
2696 "Generate a function duplicating BUFFER.
2698 The copy will preserve local variables, visibility, contents and
2699 narrowing of the original buffer. If a region was active in
2700 BUFFER, contents will be narrowed to that region instead.
2702 The resulting function can be eval'ed at a later time, from
2703 another buffer, effectively cloning the original buffer there."
2707 ;; Buffer local variables.
2717 buffer-file-name outline-level
2718 outline-regexp
2719 buffer-invisibility-spec))
2722 ;; Skip unreadable values, as they cannot be
2723 ;; sent to external process.
2727 local-vars)))))
2729 local-vars)
2730 ;; Whole buffer contents.
2735 ;; Narrowing.
2739 ;; Current position of point.
2741 ;; Overlays with invisible property.
2751 ov-set))))
2753 ov-set)))))
2755 ;;;###autoload
2758 "Transcode current Org buffer into BACKEND code.
2760 If narrowing is active in the current buffer, only transcode its
2761 narrowed part.
2763 If a region is active, transcode that region.
2765 When optional argument SUBTREEP is non-nil, transcode the
2766 sub-tree at point, extracting information from the headline
2767 properties first.
2769 When optional argument VISIBLE-ONLY is non-nil, don't export
2770 contents of hidden elements.
2772 When optional argument BODY-ONLY is non-nil, only return body
2773 code, without surrounding template.
2775 Optional argument EXT-PLIST, when provided, is a property list
2776 with external parameters overriding Org default settings, but
2777 still inferior to file-local settings.
2779 Return code as a string."
2783 ;; Narrow buffer to an appropriate region or subtree for
2784 ;; parsing. If parsing subtree, be sure to remove main headline
2785 ;; too.
2793 ;; Initialize communication channel with original buffer
2794 ;; attributes, unavailable in its copy.
2796 ;; Update communication channel and get parse tree. Buffer
2797 ;; isn't parsed directly. Instead, a temporary copy is
2798 ;; created, where include keywords, macros are expanded and
2799 ;; code blocks are evaluated.
2801 ;; Run first hook with current back-end as argument.
2804 ;; Update macro templates since #+INCLUDE keywords might have
2805 ;; added some new ones.
2809 ;; Update radio targets since keyword inclusion might have
2810 ;; added some more.
2812 ;; Run last hook with current back-end as argument.
2815 ;; Update communication channel with environment. Also
2816 ;; install user's and developer's filters.
2821 ;; Expand export-specific set of macros: {{{author}}},
2822 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2823 ;; once regular macros have been expanded, since document
2824 ;; keywords may contain one of them.
2830 ;; EMAIL is not a parsed keyword: store it as-is.
2834 ;; Call options filters and update export options. We do not
2835 ;; use `org-export-filter-apply-functions' here since the
2836 ;; arity of such filters is different.
2840 ;; Parse buffer and call parse-tree filter on it.
2845 ;; Now tree is complete, compute its properties and add them
2846 ;; to communication channel.
2850 ;; Eventually transcode TREE. Wrap the resulting string into
2851 ;; a template, if needed. Finally call final-output filter.
2856 ;; Remove all text properties since they cannot be
2857 ;; retrieved from an external process, and return result.
2863 info))))))))
2865 ;;;###autoload
2868 "Call `org-export-as' with output to a specified buffer.
2870 BACKEND is the back-end used for transcoding, as a symbol.
2872 BUFFER is the output buffer. If it already exists, it will be
2873 erased first, otherwise, it will be created.
2875 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2876 EXT-PLIST are similar to those used in `org-export-as', which
2877 see.
2879 If `org-export-copy-to-kill-ring' is non-nil, add buffer contents
2880 to kill ring. Return buffer."
2887 ;; Maybe add buffer contents to kill ring.
2890 ;; Return buffer.
2891 buffer))
2893 ;;;###autoload
2896 "Call `org-export-as' with output to a specified file.
2898 BACKEND is the back-end used for transcoding, as a symbol. FILE
2899 is the name of the output file, as a string.
2901 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2902 EXT-PLIST are similar to those used in `org-export-as', which
2903 see.
2905 If `org-export-copy-to-kill-ring' is non-nil, add file contents
2906 to kill ring. Return output file's name."
2907 ;; Checks for FILE permissions. `write-file' would do the same, but
2908 ;; we'd rather avoid needless transcoding of parse tree.
2910 ;; Insert contents to a temporary buffer and write it to FILE.
2916 ;; Maybe add file contents to kill ring.
2919 ;; Return full path.
2920 file)
2922 ;;;###autoload
2924 "Transcode STRING into BACKEND code.
2926 When optional argument BODY-ONLY is non-nil, only return body
2927 code, without preamble nor postamble.
2929 Optional argument EXT-PLIST, when provided, is a property list
2930 with external parameters overriding Org default settings, but
2931 still inferior to file-local settings.
2933 Return code as a string."
2940 "Return output file's name according to buffer specifications.
2942 EXTENSION is a string representing the output file extension,
2943 with the leading dot.
2945 With a non-nil optional argument SUBTREEP, try to determine
2947 of subtree at point.
2949 When optional argument PUB-DIR is set, use it as the publishing
2950 directory.
2952 When optional argument VISIBLE-ONLY is non-nil, don't export
2953 contents of hidden elements.
2955 Return file name as a string, or nil if it couldn't be
2956 determined."
2958 ;; File name may come from EXPORT_FILE_NAME subtree property,
2959 ;; assuming point is at beginning of said sub-tree.
2966 ;; File name may be extracted from buffer's associated
2967 ;; file, if any.
2970 ;; Can't determine file name on our own: Ask user.
2974 "Output file: " pub-dir nil nil nil
2977 ;; Build file name. Enforce EXTENSION over whatever user may have
2978 ;; come up with. PUB-DIR, if defined, always has precedence over
2979 ;; any provided path.
2984 extension))
2989 "Expand every include keyword in buffer.
2990 Optional argument INCLUDED is a list of included file names along
2991 with their line restriction, when appropriate. It is used to
2992 avoid infinite recursion. Optional argument DIR is the current
2993 working directory. It is used to properly resolve relative
2994 paths."
3001 ;; Extract arguments from keyword's value.
3015 ;; Minimal level of included file defaults to the child
3016 ;; level of the current headline, if any, or one. It
3017 ;; only applies is the file is meant to be included as
3018 ;; an Org one.
3026 ;; Remove keyword.
3031 ;; Check if files has already been parsed. Look after
3032 ;; inclusion lines too, as different parts of the same file
3033 ;; can be included too.
3045 ind-str contents ind-str))))
3053 ind-str env contents ind-str))))
3066 "Prepare the contents of FILE for inclusion and return them as a string.
3068 When optional argument LINES is a string specifying a range of
3069 lines, include only those lines.
3071 Optional argument IND, when non-nil, is an integer specifying the
3072 global indentation of returned contents. Since its purpose is to
3073 allow an included file to stay in the same environment it was
3074 created \(i.e. a list item), it doesn't apply past the first
3075 headline encountered.
3077 Optional argument MINLEVEL, when non-nil, is an integer
3078 specifying the level that any top-level headline in the included
3079 file should have."
3095 ;; Remove blank lines at beginning and end of contents. The logic
3096 ;; behind that removal is that blank lines around include keyword
3097 ;; override blank lines in included file.
3106 ;; If IND is set, preserve indentation of include keyword until
3107 ;; the first headline encountered.
3113 ;; Do not move footnote definitions out of column 0.
3119 ;; When MINLEVEL is specified, compute minimal level for headlines
3120 ;; in the file (CUR-MIN), and remove stars to each headline so
3121 ;; that headlines with minimal level have a level of MINLEVEL.
3131 ;; Only change stars, don't bother moving whole
3132 ;; sections.
3139 "Execute every Babel code in the visible part of current buffer."
3140 ;; Get a pristine copy of current buffer so Babel references can be
3141 ;; properly resolved.
3148 \f
3149 ;;; Tools For Back-Ends
3150 ;;
3151 ;; A whole set of tools is available to help build new exporters. Any
3152 ;; function general enough to have its use across many back-ends
3153 ;; should be added here.
3155 ;;;; For Affiliated Keywords
3156 ;;
3157 ;; `org-export-read-attribute' reads a property from a given element
3158 ;; as a plist. It can be used to normalize affiliated keywords'
3159 ;; syntax.
3160 ;;
3161 ;; Since captions can span over multiple lines and accept dual values,
3162 ;; their internal representation is a bit tricky. Therefore,
3163 ;; `org-export-get-caption' transparently returns a given element's
3164 ;; caption as a secondary string.
3167 "Turn ATTRIBUTE property from ELEMENT into a plist.
3169 When optional argument PROPERTY is non-nil, return the value of
3170 that property within attributes.
3174 properties."
3182 "Return caption from ELEMENT as a secondary string.
3184 When optional argument SHORTP is non-nil, return short caption,
3185 as a secondary string, instead.
3187 Caption lines are separated by a white space."
3195 ;;;; For Derived Back-ends
3196 ;;
3197 ;; `org-export-with-backend' is a function allowing to locally use
3198 ;; another back-end to transcode some object or element. In a derived
3199 ;; back-end, it may be used as a fall-back function once all specific
3200 ;; cases have been treated.
3203 "Call a transcoder from BACK-END on DATA.
3204 CONTENTS, when non-nil, is the transcoded contents of DATA
3205 element, as a string. INFO, when non-nil, is the communication
3206 channel used for export, as a plist.."
3216 ;;;; For Export Snippets
3217 ;;
3218 ;; Every export snippet is transmitted to the back-end. Though, the
3219 ;; latter will only retain one type of export-snippet, ignoring
3220 ;; others, based on the former's target back-end. The function
3221 ;; `org-export-snippet-backend' returns that back-end for a given
3222 ;; export-snippet.
3225 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3226 Translation, with `org-export-snippet-translation-alist', is
3227 applied."
3231 back-end))))
3234 ;;;; For Footnotes
3235 ;;
3236 ;; `org-export-collect-footnote-definitions' is a tool to list
3237 ;; actually used footnotes definitions in the whole parse tree, or in
3238 ;; an headline, in order to add footnote listings throughout the
3239 ;; transcoded data.
3240 ;;
3241 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3242 ;; back-ends, when they need to attach the footnote definition only to
3243 ;; the first occurrence of the corresponding label.
3244 ;;
3245 ;; `org-export-get-footnote-definition' and
3246 ;; `org-export-get-footnote-number' provide easier access to
3247 ;; additional information relative to a footnote reference.
3250 "Return an alist between footnote numbers, labels and definitions.
3252 DATA is the parse tree from which definitions are collected.
3253 INFO is the plist used as a communication channel.
3255 Definitions are sorted by order of references. They either
3256 appear as Org data or as a secondary string for inlined
3257 footnotes. Unreferenced definitions are ignored."
3259 collect-fn ; for byte-compiler.
3263 ;; Collect footnote number, label and definition in DATA.
3271 def)
3272 num-alist)
3273 ;; Also search in definition for nested footnotes.
3276 ;; Don't enter footnote definitions since it will happen
3277 ;; when their first reference is found.
3283 "Non-nil when a footnote reference is the first one for its label.
3285 FOOTNOTE-REFERENCE is the footnote reference being considered.
3286 INFO is the plist used as a communication channel."
3288 ;; Anonymous footnotes are always a first reference.
3290 ;; Otherwise, return the first footnote with the same LABEL and
3291 ;; test if it is equal to FOOTNOTE-REFERENCE.
3301 ;; If FN isn't inlined, be sure to traverse its
3302 ;; definition before resuming search. See
3303 ;; comments in `org-export-get-footnote-number'
3304 ;; for more information.
3308 ;; Don't enter footnote definitions since it will
3309 ;; happen when their first reference is found.
3312 footnote-reference)))))
3315 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3316 INFO is the plist used as a communication channel. If no such
3318 string."
3325 "Return number associated to a footnote.
3327 FOOTNOTE is either a footnote reference or a footnote definition.
3328 INFO is the plist used as a communication channel."
3330 seen-refs
3331 search-ref ; For byte-compiler.
3335 ;; Search footnote references through DATA, filling
3336 ;; SEEN-REFS along the way.
3341 ;; Anonymous footnote match: return number.
3344 ;; Labels match: return number.
3347 ;; Anonymous footnote: it's always a new one.
3348 ;; Also, be sure to return nil from the `cond' so
3349 ;; `first-match' doesn't get us out of the loop.
3351 ;; Label not seen so far: add it so SEEN-REFS.
3352 ;;
3353 ;; Also search for subsequent references in
3354 ;; footnote definition so numbering follows
3355 ;; reading logic. Note that we don't have to care
3356 ;; about inline definitions, since
3357 ;; `org-element-map' already traverses them at the
3358 ;; right time.
3359 ;;
3360 ;; Once again, return nil to stay in the loop.
3365 nil))))
3366 ;; Don't enter footnote definitions since it will
3367 ;; happen when their first reference is found.
3372 ;;;; For Headlines
3373 ;;
3374 ;; `org-export-get-relative-level' is a shortcut to get headline
3375 ;; level, relatively to the lower headline level in the parsed tree.
3376 ;;
3377 ;; `org-export-get-headline-number' returns the section number of an
3378 ;; headline, while `org-export-number-to-roman' allows to convert it
3379 ;; to roman numbers.
3380 ;;
3381 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3382 ;; `org-export-last-sibling-p' are three useful predicates when it
3383 ;; comes to fulfill the `:headline-levels' property.
3384 ;;
3385 ;; `org-export-get-tags', `org-export-get-category' and
3386 ;; `org-export-get-node-property' extract useful information from an
3387 ;; headline or a parent headline. They all handle inheritance.
3390 "Return HEADLINE relative level within current parsed tree.
3391 INFO is a plist holding contextual information."
3396 "Non-nil when HEADLINE is considered as low level.
3398 INFO is a plist used as a communication channel.
3400 A low level headlines has a relative level greater than
3401 `:headline-levels' property value.
3403 Return value is the difference between HEADLINE relative level
3404 and the last level being considered as high enough, or nil."
3411 "Return HEADLINE numbering as a list of numbers.
3412 INFO is a plist holding contextual information."
3416 "Return a non-nil value if HEADLINE element should be numbered.
3417 INFO is a plist used as a communication channel."
3423 "Convert integer N into a roman numeral."
3436 res)))
3439 "Return list of tags associated to ELEMENT.
3441 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3442 is a plist used as a communication channel.
3444 Select tags (see `org-export-select-tags') and exclude tags (see
3445 `org-export-exclude-tags') are removed from the list.
3447 When non-nil, optional argument TAGS should be a list of strings.
3448 Any tag belonging to this list will also be removed.
3450 When optional argument INHERITED is non-nil, tags can also be
3451 inherited from parent headlines and FILETAGS keywords."
3457 ;; Build complete list of inherited tags.
3468 ;; Add FILETAGS keywords and return results.
3472 "Return node PROPERTY value for BLOB.
3474 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3475 element or object.
3477 If optional argument INHERITED is non-nil, the value can be
3478 inherited from a parent headline.
3480 Return value is a string or nil."
3492 "Return category for element or object BLOB.
3494 INFO is a plist used as a communication channel.
3496 CATEGORY is automatically inherited from a parent headline, from
3497 #+CATEGORY: keyword or created out of original file name. If all
3501 ;; Almost like `org-export-node-property', but we cannot trust
3502 ;; `plist-member' as every headline has a `:category'
3503 ;; property, would it be nil or equal to "???" (which has the
3504 ;; same meaning).
3522 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3523 INFO is a plist used as a communication channel."
3528 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3529 INFO is a plist used as a communication channel."
3533 ;;;; For Links
3534 ;;
3535 ;; `org-export-solidify-link-text' turns a string into a safer version
3536 ;; for links, replacing most non-standard characters with hyphens.
3537 ;;
3538 ;; `org-export-get-coderef-format' returns an appropriate format
3539 ;; string for coderefs.
3540 ;;
3541 ;; `org-export-inline-image-p' returns a non-nil value when the link
3542 ;; provided should be considered as an inline image.
3543 ;;
3544 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3545 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3546 ;; returns an appropriate unique identifier when found, or nil.
3547 ;;
3548 ;; `org-export-resolve-id-link' returns the first headline with
3549 ;; specified id or custom-id in parse tree, the path to the external
3550 ;; file with the id or nil when neither was found.
3551 ;;
3552 ;; `org-export-resolve-coderef' associates a reference to a line
3553 ;; number in the element it belongs, or returns the reference itself
3554 ;; when the element isn't numbered.
3557 "Take link text S and make a safe target out of it."
3562 "Return format string for code reference link.
3563 PATH is the link path. DESC is its description."
3571 "Non-nil if LINK object points to an inline image.
3573 Optional argument is a set of RULES defining inline images. It
3574 is an alist where associations have the following shape:
3576 \(TYPE . REGEXP)
3578 Applying a rule means apply REGEXP against LINK's path when its
3579 type is TYPE. The function will return a non-nil value if any of
3580 the provided rules is non-nil. The default rule is
3581 `org-export-default-inline-image-rule'.
3583 This only applies to links without a description."
3594 rules)
3595 ;; Return nil if no rule matched.
3596 nil))))
3599 "Resolve a code reference REF.
3601 INFO is a plist used as a communication channel.
3603 Return associated line number in source code, or REF itself,
3604 depending on src-block or example element's switches."
3611 org-coderef-label-format)))
3615 ;; Element containing REF is found. Resolve it to either
3616 ;; a label or a line number, as needed.
3626 "Return LINK destination.
3628 INFO is a plist holding contextual information.
3630 Return value can be an object, an element, or nil:
3632 - If LINK path matches a target object (i.e. <<path>>) or
3635 - If LINK path exactly matches the name affiliated keyword
3636 \(i.e. #+NAME: path) of an element, return that element.
3638 - If LINK path exactly matches any headline name, return that
3639 element. If more than one headline share that name, priority
3640 will be given to the one with the closest common ancestor, if
3641 any, or the first one in the parse tree otherwise.
3643 - Otherwise, return nil.
3649 ;; First try to find a matching "<<path>>" unless user specified
3650 ;; he was looking for an headline (path starts with a *
3651 ;; character).
3658 blob))
3659 info t)))
3660 ;; Then try to find an element with a matching "#+NAME: path"
3661 ;; affiliated keyword.
3664 org-element-all-elements
3668 ;; Last case: link either points to an headline or to
3669 ;; nothingness. Try to find the source, with priority given to
3670 ;; headlines with the closest common ancestor. If such candidate
3671 ;; is found, return it, otherwise return nil.
3675 ;; Return first headline whose `:raw-value' property is
3676 ;; NAME in parse tree DATA, or nil.
3682 name)
3683 headline))
3685 ;; Search among headlines sharing an ancestor with link, from
3686 ;; closest to farthest.
3694 ;; No match with a common ancestor: try full parse-tree.
3700 "Return headline referenced as LINK destination.
3702 INFO is a plist used as a communication channel.
3704 Return value can be the headline element matched in current parse
3708 ;; First check if id is within the current parse tree.
3713 headline))
3715 ;; Otherwise, look for external files.
3719 "Return radio-target object referenced as LINK destination.
3721 INFO is a plist used as a communication channel.
3723 Return value can be a radio-target object or nil. Assume LINK
3732 ;;;; For References
3733 ;;
3734 ;; `org-export-get-ordinal' associates a sequence number to any object
3735 ;; or element.
3738 "Return ordinal number of an element or object.
3740 ELEMENT is the element or object considered. INFO is the plist
3741 used as a communication channel.
3743 Optional argument TYPES, when non-nil, is a list of element or
3744 object types, as symbols, that should also be counted in.
3745 Otherwise, only provided element's type is considered.
3747 Optional argument PREDICATE is a function returning a non-nil
3748 value if the current element or object should be counted in. It
3749 accepts two arguments: the element or object being considered and
3750 the plist used as a communication channel. This allows to count
3751 only a certain type of objects (i.e. inline images).
3753 Return value is a list of numbers if ELEMENT is an headline or an
3754 item. It is nil for keywords. It represents the footnote number
3755 for footnote definitions and footnote references. If ELEMENT is
3756 a target, return the same value as if ELEMENT was the closest
3757 table, item or headline containing the target. In any other
3758 case, return the sequence number of ELEMENT among elements or
3759 objects of the same type."
3760 ;; A target keyword, representing an invisible target, never has
3761 ;; a sequence number.
3763 ;; Ordinal of a target object refer to the ordinal of the closest
3764 ;; table, item, or headline containing the object.
3768 when
3772 table))
3773 return parent)))
3775 ;; Special case 1: An headline returns its number as a list.
3777 ;; Special case 2: An item returns its number as a list.
3781 struct
3788 ;; Increment counter until ELEMENT is found again.
3799 ;;;; For Src-Blocks
3800 ;;
3801 ;; `org-export-get-loc' counts number of code lines accumulated in
3802 ;; src-block or example-block elements with a "+n" switch until
3803 ;; a given element, excluded. Note: "-n" switches reset that count.
3804 ;;
3805 ;; `org-export-unravel-code' extracts source code (along with a code
3806 ;; references alist) from an `element-block' or `src-block' type
3807 ;; element.
3808 ;;
3809 ;; `org-export-format-code' applies a formatting function to each line
3810 ;; of code, providing relative line number and code reference when
3811 ;; appropriate. Since it doesn't access the original element from
3812 ;; which the source code is coming, it expects from the code calling
3813 ;; it to know if lines should be numbered and if code references
3814 ;; should appear.
3815 ;;
3816 ;; Eventually, `org-export-format-code-default' is a higher-level
3817 ;; function (it makes use of the two previous functions) which handles
3818 ;; line numbering and code references inclusion, and returns source
3819 ;; code in a format suitable for plain text or verbatim output.
3822 "Return accumulated lines of code up to ELEMENT.
3824 INFO is the plist used as a communication channel.
3826 ELEMENT is excluded from count."
3832 ;; ELEMENT is reached: Quit the loop.
3834 ;; Only count lines from src-block and example-block elements
3835 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3839 ;; Accumulate locs or reset them.
3843 ;; Return nil to stay in the loop.
3844 nil)))
3846 ;; Return value.
3847 loc))
3850 "Clean source code and extract references out of it.
3852 ELEMENT has either a `src-block' an `example-block' type.
3854 Return a cons cell whose CAR is the source code, cleaned from any
3855 reference and protective comma and CDR is an alist between
3856 relative line number (integer) and name of code reference on that
3857 line (string)."
3859 ;; Get code and clean it. Remove blank lines at its
3860 ;; beginning and end.
3866 ;; If appropriate, remove global indentation.
3869 c
3871 ;; Get format used for references.
3874 org-coderef-label-format)))
3875 ;; Build a regexp matching a loc with a reference.
3880 ;; Return value.
3882 ;; Code with references removed.
3888 ;; Ref line: remove ref, and signal its position in REFS.
3892 ;; Reference alist.
3893 refs)))
3896 "Format CODE by applying FUN line-wise and return it.
3898 CODE is a string representing the code to format. FUN is
3899 a function. It must accept three arguments: a line of
3900 code (string), the current line number (integer) or nil and the
3901 reference associated to the current line (string) or nil.
3903 Optional argument NUM-LINES can be an integer representing the
3904 number of code lines accumulated until the current code. Line
3905 numbers passed to FUN will take it into account. If it is nil,
3906 FUN's second argument will always be nil. This number can be
3907 obtained with `org-export-get-loc' function.
3909 Optional argument REF-ALIST can be an alist between relative line
3910 number (i.e. ignoring NUM-LINES) and the name of the code
3911 reference on it. If it is nil, FUN's third argument will always
3912 be nil. It can be obtained through the use of
3913 `org-export-unravel-code' function."
3925 "Return source code from ELEMENT, formatted in a standard way.
3927 ELEMENT is either a `src-block' or `example-block' element. INFO
3928 is a plist used as a communication channel.
3930 This function takes care of line numbering and code references
3931 inclusion. Line numbers, when applicable, appear at the
3932 beginning of the line, separated from the code by two white
3933 spaces. Code references, on the other hand, appear flushed to
3934 the right, separated by six white spaces from the widest line of
3935 code."
3936 ;; Extract code and references.
3942 ;; Handle line numbering.
3951 ;; Prepare references display, if required. Any reference
3952 ;; should start six columns after the widest line of code,
3953 ;; wrapped with parenthesis.
3958 code
3962 number-str
3963 loc
3969 num-start refs)))
3972 ;;;; For Tables
3973 ;;
3974 ;; `org-export-table-has-special-column-p' and and
3975 ;; `org-export-table-row-is-special-p' are predicates used to look for
3976 ;; meta-information about the table structure.
3977 ;;
3978 ;; `org-table-has-header-p' tells when the rows before the first rule
3979 ;; should be considered as table's header.
3980 ;;
3981 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3982 ;; and `org-export-table-cell-borders' extract information from
3983 ;; a table-cell element.
3984 ;;
3985 ;; `org-export-table-dimensions' gives the number on rows and columns
3986 ;; in the table, ignoring horizontal rules and special columns.
3987 ;; `org-export-table-cell-address', given a table-cell object, returns
3988 ;; the absolute address of a cell. On the other hand,
3989 ;; `org-export-get-table-cell-at' does the contrary.
3990 ;;
3991 ;; `org-export-table-cell-starts-colgroup-p',
3992 ;; `org-export-table-cell-ends-colgroup-p',
3993 ;; `org-export-table-row-starts-rowgroup-p',
3994 ;; `org-export-table-row-ends-rowgroup-p',
3995 ;; `org-export-table-row-starts-header-p' and
3996 ;; `org-export-table-row-ends-header-p' indicate position of current
3997 ;; row or cell within the table.
4000 "Non-nil when TABLE has a special column.
4001 All special columns will be ignored during export."
4002 ;; The table has a special column when every first cell of every row
4003 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
4004 ;; "*" "_" and "^". Though, do not consider a first row containing
4005 ;; only empty cells as special.
4021 "Non-nil when TABLE has an header.
4023 INFO is a plist used as a communication channel.
4025 A table has an header when it contains at least two row groups."
4035 info)))
4038 "Non-nil if TABLE-ROW is considered special.
4040 INFO is a plist used as the communication channel.
4042 All special rows will be ignored during export."
4046 ;; A row is special either when...
4048 ;; ... it starts with a field only containing "/",
4050 ;; ... the table contains a special column and the row start
4051 ;; with a marking character among, "^", "_", "$" or "!",
4055 ;; ... it contains only alignment cookies and empty cells.
4061 ;; Since VALUE is a secondary string, the following
4062 ;; checks avoid expanding it with `org-export-data'.
4074 "Return TABLE-ROW's group.
4076 INFO is a plist used as the communication channel.
4078 Return value is the group number, as an integer, or nil special
4079 rows and table rules. Group 1 is also table's header."
4096 "Return TABLE-CELL contents width.
4098 INFO is a plist used as the communication channel.
4100 Return value is the width given by the last width cookie in the
4101 same column as TABLE-CELL, or nil."
4106 cookie-width)
4110 ;; In a special row, try to find a width cookie at COLUMN.
4114 ;; The following checks avoid expanding unnecessarily the
4115 ;; cell with `org-export-data'
4123 ;; Ignore table rules.
4126 ;; Return value.
4127 cookie-width))
4130 "Return TABLE-CELL contents alignment.
4132 INFO is a plist used as the communication channel.
4134 Return alignment as specified by the last alignment cookie in the
4135 same column as TABLE-CELL. If no such cookie is found, a default
4136 alignment value will be deduced from fraction of numbers in the
4137 column (see `org-table-number-fraction' for more information).
4138 Possible values are `left', `right' and `center'."
4145 cookie-align)
4149 ;; In a special row, try to find an alignment cookie at
4150 ;; COLUMN.
4154 ;; Since VALUE is a secondary string, the following checks
4155 ;; avoid useless expansion through `org-export-data'.
4163 ;; Ignore table rules.
4165 ;; In a standard row, check if cell's contents are expressing
4166 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4167 ;; Though, don't bother if an alignment cookie has already
4168 ;; defined cell's alignment.
4173 info)))
4178 ;; Return value. Alignment specified by cookies has precedence
4179 ;; over alignment deduced from cells contents.
4188 "Return TABLE-CELL borders.
4190 INFO is a plist used as a communication channel.
4192 Return value is a list of symbols, or nil. Possible values are:
4193 `top', `bottom', `above', `below', `left' and `right'. Note:
4194 `top' (resp. `bottom') only happen for a cell in the first
4195 row (resp. last row) of the table, ignoring table rules, if any.
4197 Returned borders ignore special rows."
4200 borders)
4201 ;; Top/above border? TABLE-CELL has a border above when a rule
4202 ;; used to demarcate row groups can be found above. Hence,
4203 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4204 ;; another regular row has to be found above that rule.
4213 ;; Look at every row before the current one.
4215 ;; No rule above, or rule found starts the table (ignoring any
4216 ;; special row): TABLE-CELL is at the top of the table.
4219 ;; Bottom/below border? TABLE-CELL has a border below when next
4220 ;; non-regular row below is a rule.
4229 ;; Look at every row after the current one.
4231 ;; No rule below, or rule found ends the table (modulo some
4232 ;; special row): TABLE-CELL is at the bottom of the table.
4235 ;; Right/left borders? They can only be specified by column
4236 ;; groups. Column groups are defined in a row starting with "/".
4237 ;; Also a column groups row only contains "<", "<>", ">" or blank
4238 ;; cells.
4255 ;; There's a left border when previous cell, if
4256 ;; any, ends a group, or current one starts one.
4262 ;; There's a right border when next cell, if any,
4263 ;; starts a group, or current one ends one.
4270 ;; Table rows are read in reverse order so last column groups
4271 ;; row has precedence over any previous one.
4273 ;; Return value.
4274 borders))
4277 "Non-nil when TABLE-CELL is at the beginning of a row group.
4278 INFO is a plist used as a communication channel."
4279 ;; A cell starts a column group either when it is at the beginning
4280 ;; of a row (or after the special column, if any) or when it has
4281 ;; a left border.
4284 table-cell)
4288 "Non-nil when TABLE-CELL is at the end of a row group.
4289 INFO is a plist used as a communication channel."
4290 ;; A cell ends a column group either when it is at the end of a row
4291 ;; or when it has a right border.
4294 table-cell)
4298 "Non-nil when TABLE-ROW is at the beginning of a column group.
4299 INFO is a plist used as a communication channel."
4307 "Non-nil when TABLE-ROW is at the end of a column group.
4308 INFO is a plist used as a communication channel."
4316 "Non-nil when TABLE-ROW is the first table header's row.
4317 INFO is a plist used as a communication channel."
4324 "Non-nil when TABLE-ROW is the last table header's row.
4325 INFO is a plist used as a communication channel."
4332 "Return TABLE dimensions.
4334 INFO is a plist used as a communication channel.
4336 Return value is a CONS like (ROWS . COLUMNS) where
4337 ROWS (resp. COLUMNS) is the number of exportable
4338 rows (resp. columns)."
4340 ;; Set number of rows, and extract first one.
4346 ;; Set number of columns.
4348 ;; Return value.
4352 "Return address of a regular TABLE-CELL object.
4354 TABLE-CELL is the cell considered. INFO is a plist used as
4355 a communication channel.
4357 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4358 zero-based index. Only exportable cells are considered. The
4359 function returns nil for other cells."
4362 ;; Ignore cells in special rows or in special column.
4367 ;; Row number.
4375 ;; Column number.
4383 "Return regular table-cell object at ADDRESS in TABLE.
4385 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4386 zero-based index. TABLE is a table type element. INFO is
4387 a plist used as a communication channel.
4389 If no table-cell, among exportable cells, is found at ADDRESS,
4390 return nil."
4393 ;; Row at (car address) or nil.
4401 'table-cell
4408 ;;;; For Tables Of Contents
4409 ;;
4410 ;; `org-export-collect-headlines' builds a list of all exportable
4411 ;; headline elements, maybe limited to a certain depth. One can then
4412 ;; easily parse it and transcode it.
4413 ;;
4414 ;; Building lists of tables, figures or listings is quite similar.
4415 ;; Once the generic function `org-export-collect-elements' is defined,
4416 ;; `org-export-collect-tables', `org-export-collect-figures' and
4417 ;; `org-export-collect-listings' can be derived from it.
4420 "Collect headlines in order to build a table of contents.
4422 INFO is a plist used as a communication channel.
4424 When optional argument N is an integer, it specifies the depth of
4425 the table of contents. Otherwise, it is set to the value of the
4426 last headline level. See `org-export-headline-levels' for more
4427 information.
4429 Return a list of all exportable headlines as parsed elements."
4433 ;; Strip contents from HEADLINE.
4436 info))
4439 "Collect referenceable elements of a determined type.
4441 TYPE can be a symbol or a list of symbols specifying element
4442 types to search. Only elements with a caption are collected.
4444 INFO is a plist used as a communication channel.
4446 When non-nil, optional argument PREDICATE is a function accepting
4447 one argument, an element of type TYPE. It returns a non-nil
4448 value when that element should be collected.
4450 Return a list of all elements found, in order of appearance."
4455 element))
4456 info))
4459 "Build a list of tables.
4460 INFO is a plist used as a communication channel.
4462 Return a list of table elements with a caption."
4466 "Build a list of figures.
4468 INFO is a plist used as a communication channel. PREDICATE is
4469 a function which accepts one argument: a paragraph element and
4470 whose return value is non-nil when that element should be
4471 collected.
4473 A figure is a paragraph type element, with a caption, verifying
4475 a vague concept that may depend on back-end.
4477 Return a list of elements recognized as figures."
4481 "Build a list of src blocks.
4483 INFO is a plist used as a communication channel.
4485 Return a list of src-block elements with a caption."
4489 ;;;; Smart Quotes
4490 ;;
4491 ;; The main function for the smart quotes sub-system is
4492 ;; `org-export-activate-smart-quotes', which replaces every quote in
4493 ;; a given string from the parse tree with its "smart" counterpart.
4494 ;;
4495 ;; Dictionary for smart quotes is stored in
4496 ;; `org-export-smart-quotes-alist'.
4497 ;;
4498 ;; Internally, regexps matching potential smart quotes (checks at
4499 ;; string boundaries are also necessary) are defined in
4500 ;; `org-export-smart-quotes-regexps'.
4537 "Smart quotes translations.
4539 Alist whose CAR is a language string and CDR is an alist with
4540 quote type as key and a plist associating various encodings to
4541 their translation as value.
4543 A quote type can be any symbol among `opening-double-quote',
4544 `closing-double-quote', `opening-single-quote',
4545 `closing-single-quote' and `apostrophe'.
4547 Valid encodings include `:utf-8', `:html', `:latex' and
4548 `:texinfo'.
4554 ;; Possible opening quote at beginning of string.
4556 ;; Possible closing quote at beginning of string.
4558 ;; Possible apostrophe at beginning of string.
4560 ;; Opening single and double quotes.
4562 ;; Closing single and double quotes.
4564 ;; Apostrophe.
4566 ;; Possible opening quote at end of string.
4568 ;; Possible closing quote at end of string.
4570 ;; Possible apostrophe at end of string.
4572 "List of regexps matching a quote or an apostrophe.
4578 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4579 `:utf-8'. INFO is a plist used as a communication channel.
4581 The function has to retrieve information about string
4582 surroundings in parse tree. It can only happen with an
4583 unmodified string. Thus, if S has already been through another
4584 process, a non-nil ORIGINAL optional argument will provide that
4585 original string.
4587 Return the new string."
4590 ;; Try to be flexible when computing number of blanks
4591 ;; before object. The previous object may be a string
4592 ;; introduced by the back-end and not completely parsed.
4595 ;; A string with missing `:post-blank'
4596 ;; property.
4600 ;; Fallback value.
4605 ;; Return smart quote associated to a give quote Q, as
4606 ;; a string. TYPE is a symbol among `open', `close' and
4607 ;; `apostrophe'.
4617 org-export-smart-quotes-alist))))
4618 encoding)
4619 q)))))
4621 ;; Only a quote: no regexp can match. We have to check both
4622 ;; sides and decide what to do.
4630 ;; 1. Replace quote character at the beginning of S.
4632 ;; Apostrophe?
4638 ;; Closing quote?
4644 ;; Opening quote?
4650 ;; 2. Replace quotes in the middle of the string.
4652 ;; Opening quotes.
4658 ;; Closing quotes.
4664 ;; Apostrophes.
4669 ;; 3. Replace quote character at the end of S.
4671 ;; Apostrophe?
4676 ;; Closing quote?
4682 ;; Opening quote?
4687 ;; Return string with smart quotes.
4688 s))))
4690 ;;;; Topology
4691 ;;
4692 ;; Here are various functions to retrieve information about the
4693 ;; neighbourhood of a given element or object. Neighbours of interest
4694 ;; are direct parent (`org-export-get-parent'), parent headline
4695 ;; (`org-export-get-parent-headline'), first element containing an
4696 ;; object, (`org-export-get-parent-element'), parent table
4697 ;; (`org-export-get-parent-table'), previous element or object
4698 ;; (`org-export-get-previous-element') and next element or object
4699 ;; (`org-export-get-next-element').
4700 ;;
4701 ;; `org-export-get-genealogy' returns the full genealogy of a given
4702 ;; element or object, from closest parent to full parse tree.
4705 "Return BLOB parent or nil.
4706 BLOB is the element or object considered."
4710 "Return full genealogy relative to a given element or object.
4712 BLOB is the element or object being considered.
4714 Ancestors are returned from closest to farthest, the last one
4715 being the full parse tree."
4722 "Return BLOB parent headline or nil.
4723 BLOB is the element or object being considered."
4727 parent))
4730 "Return first element containing OBJECT or nil.
4731 OBJECT is the object to consider."
4735 parent))
4738 "Return OBJECT parent table or nil.
4739 OBJECT is either a `table-cell' or `table-element' type object."
4743 parent))
4746 "Return previous element or object.
4748 BLOB is an element or object. INFO is a plist used as
4749 a communication channel. Return previous exportable element or
4750 object, a string, or nil.
4752 When optional argument N is a positive integer, return a list
4753 containing up to N siblings before BLOB, from closest to
4754 farthest. With any other non-nil value, return a list containing
4755 all of them."
4757 ;; An object can belong to the contents of its parent or
4758 ;; to a secondary string. We check the latter option
4759 ;; first.
4762 org-element-all-elements))
4766 org-element-secondary-value-alist))
4767 parent)))
4770 prev)
4782 "Return next element or object.
4784 BLOB is an element or object. INFO is a plist used as
4785 a communication channel. Return next exportable element or
4786 object, a string, or nil.
4788 When optional argument N is a positive integer, return a list
4789 containing up to N siblings after BLOB, from closest to farthest.
4790 With any other non-nil value, return a list containing all of
4791 them."
4793 ;; An object can belong to the contents of its parent or to
4794 ;; a secondary string. We check the latter option first.
4797 org-element-all-objects))
4801 org-element-secondary-value-alist))
4802 parent)))
4805 next)
4813 siblings)
4817 ;;;; Translation
4818 ;;
4819 ;; `org-export-translate' translates a string according to language
4820 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4821 ;; variable and a specified charset. `org-export-dictionary' contains
4822 ;; the dictionary used for the translation.
4944 "Dictionary for export engine.
4946 Alist whose CAR is the string to translate and CDR is an alist
4947 whose CAR is the language string and CDR is a plist whose
4948 properties are possible charsets and values translated terms.
4950 It is used as a database for `org-export-translate'. Since this
4951 function returns the string as-is if no translation was found,
4952 the variable only needs to record values different from the
4956 "Translate string S according to language specification.
4958 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4959 and `:utf-8'. INFO is a plist used as a communication channel.
4961 Translation depends on `:language' property. Return the
4962 translated string. If no translation is found, try to fall back
4963 to `:default' encoding. If it fails, return S."
4969 s)))
4972 \f
4973 ;;; Asynchronous Export
4974 ;;
4975 ;; `org-export-async-start' is the entry point for asynchronous
4976 ;; export. It recreates current buffer (including visibility,
4977 ;; narrowing and visited file) in an external Emacs process, and
4978 ;; evaluates a command there. It then applies a function on the
4979 ;; returned results in the current process.
4980 ;;
4981 ;; Asynchronously generated results are never displayed directly.
4982 ;; Instead, they are stored in `org-export-stack-contents'. They can
4983 ;; then be retrieved by calling `org-export-stack'.
4984 ;;
4985 ;; Export Stack is viewed through a dedicated major mode
4986 ;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
4987 ;;`org-export-stack-delete', `org-export-stack-view' and
4988 ;;`org-export-stack-clear'.
4989 ;;
4990 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
4991 ;; It should used whenever `org-export-async-start' is called.
4994 "Call function FUN on the results returned by BODY evaluation.
4996 BODY evaluation happens in an asynchronous process, from a buffer
4997 which is an exact copy of the current one.
4999 Use `org-export-add-to-stack' in FUN in order to register results
5000 in the stack. Examples for, respectively a temporary buffer and
5001 a file are:
5003 \(org-export-async-start
5004 \(lambda (output)
5006 \(erase-buffer)
5007 \(insert output)
5008 \(goto-char (point-min))
5009 \(org-export-add-to-stack (current-buffer) 'backend)))
5010 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
5012 and
5014 \(org-export-async-start
5015 \(lambda (f) (org-export-add-to-stack f 'backend))
5016 `(expand-file-name
5017 \(org-export-to-file
5018 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
5021 ;; Write the full sexp evaluating BODY in a copy of the current
5022 ;; buffer to a temporary file, as it may be too long for program
5023 ;; args in `start-process'.
5030 "%S"
5033 ;; Initialize `org-mode' and export framework in the
5034 ;; external process.
5037 ;; Re-create current buffer there.
5040 ;; Sexp to evaluate in the buffer.
5042 ;; Start external process.
5045 (,process
5050 "-l" org-export-async-init-file
5052 ;; Register running process in stack.
5054 ;; Set-up sentinel in order to catch results.
5056 ,process
5080 "Add a new result to export stack if not present already.
5082 SOURCE is a buffer or a file name containing export results.
5083 BACKEND is a symbol representing export back-end used to generate
5084 it.
5086 Entries already pointing to SOURCE and unavailable entries are
5087 removed beforehand. Return the new stack."
5093 "Menu for asynchronous export results and running processes."
5103 "Return source from export results at point in stack."
5110 source
5111 ;; SOURCE is not consistent with current line. The stack
5112 ;; view is outdated.
5116 "Remove all entries from export stack."
5121 "Refresh the asynchronous export stack.
5122 DUMMY is ignored. Unavailable sources are removed from the list.
5123 Return the new stack."
5133 ;; Back-end.
5135 ;; Age.
5138 ;; Compute age of the results.
5140 "%4h:%.2m "
5142 ;; Source.
5147 ;; Clear stack from exited processes, dead buffers or
5148 ;; non-existent files.
5160 "Remove export results at point from stack.
5161 If optional argument SOURCE is non-nil, remove it instead."
5166 org-export-stack-contents))))
5169 "View export results at point in stack.
5170 With an optional prefix argument IN-EMACS, force viewing files
5171 within Emacs."
5185 (define-key km "p" 'previous-line)
5186 (define-key km "\C-p" 'previous-line)
5187 (define-key km "\C-?" 'previous-line)
5188 (define-key km [up] 'previous-line)
5189 (define-key km "C" 'org-export-stack-clear)
5190 (define-key km "v" 'org-export-stack-view)
5191 (define-key km (kbd "RET") 'org-export-stack-view)
5192 (define-key km "d" 'org-export-stack-remove)
5193 km)
5194 "Keymap for Org Export Stack.")
5196 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5197 "Mode for displaying asynchronous export stack.
5200 stack.
5202 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export-stack-view] to view export output
5203 on current line, \\[org-export-stack-remove] to remove it from the stack and \\[org-export-stack-clear] to clear
5204 stack completely.
5206 Removal entries in an Org Export Stack buffer doesn't affect
5207 files or buffers, only view in the stack.
5210 (abbrev-mode 0)
5211 (auto-fill-mode 0)
5212 (setq buffer-read-only t
5213 buffer-undo-list t
5214 truncate-lines t
5215 header-line-format
5216 '(:eval
5217 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5218 (add-hook 'post-command-hook 'org-export-stack-refresh nil t)
5219 (set (make-local-variable 'revert-buffer-function)
5220 'org-export-stack-refresh))
5223 \f
5224 ;;; The Dispatcher
5225 ;;
5226 ;; `org-export-dispatch' is the standard interactive way to start an
5227 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
5228 ;; for its interface, which, in turn, delegates response to key
5229 ;; pressed to `org-export-dispatch-action'.
5231 ;;;###autoload
5232 (defun org-export-dispatch (&optional arg)
5233 "Export dispatcher for Org mode.
5235 It provides an access to common export related tasks in a buffer.
5236 Its interface comes in two flavours: standard and expert. While
5237 both share the same set of bindings, only the former displays the
5238 valid keys associations in a dedicated buffer. Set
5239 `org-export-dispatch-use-expert-ui' to switch to one flavour or
5240 the other.
5243 of options used back then, on the current buffer.
5245 When ARG is \\[universal-argument] \\[universal-argument], display the asynchronous export stack."
5246 (interactive "P")
5247 (let* ((input
5248 (cond ((equal arg '(16)) '(stack))
5249 ((and arg org-export-dispatch-last-action))
5250 (t (save-window-excursion
5251 (unwind-protect
5252 ;; Store this export command.
5253 (setq org-export-dispatch-last-action
5254 (org-export-dispatch-ui
5255 (list org-export-initial-scope
5256 (and org-export-in-background 'async))
5257 nil
5258 org-export-dispatch-use-expert-ui))
5259 (and (get-buffer "*Org Export Dispatcher*")
5260 (kill-buffer "*Org Export Dispatcher*")))))))
5261 (action (car input))
5262 (optns (cdr input)))
5263 (case action
5264 ;; First handle special hard-coded actions.
5265 (stack (org-export-stack))
5266 (publish-current-file
5267 (org-publish-current-file (memq 'force optns) (memq 'async optns)))
5268 (publish-current-project
5269 (org-publish-current-project (memq 'force optns) (memq 'async optns)))
5270 (publish-choose-project
5271 (org-publish (assoc (org-icompleting-read
5272 "Publish project: "
5273 org-publish-project-alist nil t)
5274 org-publish-project-alist)
5275 (memq 'force optns)
5276 (memq 'async optns)))
5277 (publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
5278 (otherwise (funcall action
5279 ;; Return a symbol instead of a list to ease
5280 ;; asynchronous export macro use.
5281 (and (memq 'async optns) t)
5282 (and (memq 'subtree optns) t)
5283 (and (memq 'visible optns) t)
5284 (and (memq 'body optns) t))))))
5286 (defun org-export-dispatch-ui (options first-key expertp)
5287 "Handle interface for `org-export-dispatch'.
5289 OPTIONS is a list containing current interactive options set for
5290 export. It can contain any of the following symbols:
5291 `body' toggles a body-only export
5292 `subtree' restricts export to current subtree
5293 `visible' restricts export to visible part of buffer.
5294 `force' force publishing files.
5295 `async' use asynchronous export process
5297 FIRST-KEY is the key pressed to select the first level menu. It
5298 is nil when this menu hasn't been selected yet.
5300 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5301 buffer is provided, but indications about currently active
5302 options are given in the prompt. Moreover, \[?] allows to switch
5303 back to standard interface."
5304 (let* ((fontify-key
5305 (lambda (key &optional access-key)
5306 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5307 ;; non-nil is the required first-level key to activate
5308 ;; KEY. When its value is t, activate KEY independently
5309 ;; on the first key, if any. A nil value means KEY will
5310 ;; only be activated at first level.
5311 (if (or (eq access-key t) (eq access-key first-key))
5312 (org-propertize key 'face 'org-warning)
5313 key)))
5314 (fontify-value
5315 (lambda (value)
5316 ;; Fontify VALUE string.
5317 (org-propertize value 'face 'font-lock-variable-name-face)))
5318 ;; Prepare menu entries by extracting them from
5319 ;; `org-export-registered-backends', and sorting them by
5320 ;; access key and by ordinal, if any.
5321 (backends
5322 (sort
5323 (sort
5324 (delq nil
5325 (mapcar
5326 (lambda (b)
5327 (let ((name (car b)))
5328 (catch 'ignored
5329 ;; Ignore any back-end belonging to
5330 ;; `org-export-invisible-backends' or derived
5331 ;; from one of them.
5332 (dolist (ignored org-export-invisible-backends)
5333 (when (org-export-derived-backend-p name ignored)
5334 (throw 'ignored nil)))
5335 (org-export-backend-menu name))))
5336 org-export-registered-backends))
5337 (lambda (a b)
5338 (let ((key-a (nth 1 a))
5339 (key-b (nth 1 b)))
5340 (cond ((and (numberp key-a) (numberp key-b))
5341 (< key-a key-b))
5342 ((numberp key-b) t)))))
5343 (lambda (a b) (< (car a) (car b)))))
5344 ;; Compute a list of allowed keys based on the first key
5345 ;; pressed, if any. Some keys (?^B, ?^V, ?^S, ?^F, ?^A
5346 ;; and ?q) are always available.
5347 (allowed-keys
5348 (nconc (list ?\x02 ?\x16 ?\x13 ?\x06 ?\x01)
5349 (if (not first-key) (org-uniquify (mapcar 'car backends))
5350 (let (sub-menu)
5351 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5352 (when (eq (car backend) first-key)
5353 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5354 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5355 ((not first-key) (list ?P)))
5356 (list ?&)
5357 (when expertp (list ??))
5358 (list ?q)))
5359 ;; Build the help menu for standard UI.
5360 (help
5361 (unless expertp
5362 (concat
5363 ;; Options are hard-coded.
5364 (format "Options
5365 [%s] Body only: %s [%s] Visible only: %s
5366 [%s] Export scope: %s [%s] Force publishing: %s
5368 (funcall fontify-key "C-b" t)
5369 (funcall fontify-value
5370 (if (memq 'body options) "On " "Off"))
5371 (funcall fontify-key "C-v" t)
5372 (funcall fontify-value
5373 (if (memq 'visible options) "On " "Off"))
5374 (funcall fontify-key "C-s" t)
5375 (funcall fontify-value
5376 (if (memq 'subtree options) "Subtree" "Buffer "))
5377 (funcall fontify-key "C-f" t)
5378 (funcall fontify-value
5379 (if (memq 'force options) "On " "Off"))
5380 (funcall fontify-key "C-a" t)
5381 (funcall fontify-value
5382 (if (memq 'async options) "On " "Off")))
5383 ;; Display registered back-end entries. When a key
5384 ;; appears for the second time, do not create another
5385 ;; entry, but append its sub-menu to existing menu.
5386 (let (last-key)
5387 (mapconcat
5388 (lambda (entry)
5389 (let ((top-key (car entry)))
5390 (concat
5391 (unless (eq top-key last-key)
5392 (setq last-key top-key)
5394 (funcall fontify-key (char-to-string top-key))
5395 (nth 1 entry)))
5396 (let ((sub-menu (nth 2 entry)))
5397 (unless (functionp sub-menu)
5398 ;; Split sub-menu into two columns.
5399 (let ((index -1))
5400 (concat
5401 (mapconcat
5402 (lambda (sub-entry)
5403 (incf index)
5404 (format
5405 (if (zerop (mod index 2)) " [%s] %-26s"
5407 (funcall fontify-key
5408 (char-to-string (car sub-entry))
5409 top-key)
5410 (nth 1 sub-entry)))
5411 sub-menu "")
5413 backends ""))
5414 ;; Publishing menu is hard-coded.
5416 [%s] Current file [%s] Current project
5418 (funcall fontify-key "P")
5419 (funcall fontify-key "f" ?P)
5420 (funcall fontify-key "p" ?P)
5421 (funcall fontify-key "x" ?P)
5422 (funcall fontify-key "a" ?P))
5424 (format "\[%s] %s"
5425 (funcall fontify-key "q" t)
5426 (if first-key "Main menu" "Exit")))))
5427 ;; Build prompts for both standard and expert UI.
5428 (standard-prompt (unless expertp "Export command: "))
5429 (expert-prompt
5430 (when expertp
5431 (format
5432 "Export command (C-%s%s%s%s%s) [%s]: "
5433 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5434 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5435 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5436 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5437 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5438 (mapconcat (lambda (k)
5439 ;; Strip control characters.
5440 (unless (< k 27) (char-to-string k)))
5441 allowed-keys "")))))
5442 ;; With expert UI, just read key with a fancy prompt. In standard
5443 ;; UI, display an intrusive help buffer.
5444 (if expertp
5445 (org-export-dispatch-action
5446 expert-prompt allowed-keys backends options first-key expertp)
5447 ;; At first call, create frame layout in order to display menu.
5448 (unless (get-buffer "*Org Export Dispatcher*")
5449 (delete-other-windows)
5450 (org-switch-to-buffer-other-window
5451 (get-buffer-create "*Org Export Dispatcher*"))
5452 (setq cursor-type nil))
5453 ;; At this point, the buffer containing the menu exists and is
5454 ;; visible in the current window. So, refresh it.
5455 (with-current-buffer "*Org Export Dispatcher*"
5456 (erase-buffer)
5457 (insert help))
5458 (org-fit-window-to-buffer)
5459 (org-export-dispatch-action
5460 standard-prompt allowed-keys backends options first-key expertp))))
5462 (defun org-export-dispatch-action
5463 (prompt allowed-keys backends options first-key expertp)
5464 "Read a character from command input and act accordingly.
5466 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5467 a list of characters available at a given step in the process.
5468 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5469 EXPERTP are the same as defined in `org-export-dispatch-ui',
5470 which see.
5472 Toggle export options when required. Otherwise, return value is
5473 a list with action as CAR and a list of interactive export
5474 options as CDR."
5475 (let ((key (read-char-exclusive prompt)))
5476 (cond
5477 ;; Ignore undefined associations.
5478 ((not (memq key allowed-keys))
5479 (ding)
5480 (unless expertp (message "Invalid key") (sit-for 1))
5481 (org-export-dispatch-ui options first-key expertp))
5482 ;; q key at first level aborts export. At second
5483 ;; level, cancel first key instead.
5484 ((eq key ?q) (if (not first-key) (error "Export aborted")
5485 (org-export-dispatch-ui options nil expertp)))
5486 ;; Help key: Switch back to standard interface if
5487 ;; expert UI was active.
5488 ((eq key ??) (org-export-dispatch-ui options first-key nil))
5489 ;; Switch to asynchronous export stack.
5490 ((eq key ?&) '(stack))
5491 ;; Toggle export options.
5492 ((memq key '(?\x02 ?\x16 ?\x13 ?\x06 ?\x01))
5493 (org-export-dispatch-ui
5494 (let ((option (case key (?\x02 'body) (?\x16 'visible) (?\x13 'subtree)
5495 (?\x06 'force) (?\x01 'async))))
5496 (if (memq option options) (remq option options)
5497 (cons option options)))
5498 first-key expertp))
5499 ;; Action selected: Send key and options back to
5500 ;; `org-export-dispatch'.
5501 ((or first-key (functionp (nth 2 (assq key backends))))
5502 (cons (cond
5503 ((not first-key) (nth 2 (assq key backends)))
5504 ;; Publishing actions are hard-coded. Send a special
5505 ;; signal to `org-export-dispatch'.
5506 ((eq first-key ?P)
5507 (case key
5508 (?f 'publish-current-file)
5509 (?p 'publish-current-project)
5510 (?x 'publish-choose-project)
5511 (?a 'publish-all)))
5512 ;; Return first action associated to FIRST-KEY + KEY
5513 ;; path. Indeed, derived backends can share the same
5514 ;; FIRST-KEY.
5515 (t (catch 'found
5516 (mapc (lambda (backend)
5517 (let ((match (assq key (nth 2 backend))))
5518 (when match (throw 'found (nth 2 match)))))
5519 (member (assq first-key backends) backends)))))
5520 options))
5521 ;; Otherwise, enter sub-menu.
5522 (t (org-export-dispatch-ui options key expertp)))))
5526 (provide 'ox)
5528 ;; Local variables:
5529 ;; generated-autoload-file: "org-loaddefs.el"
5530 ;; End:
5532 ;;; ox.el ends here