| blob | 4f93fcdb6baaf6dc2941de8799e27469e4c29530 |
1 ;;; org-export.el --- Generic Export Engine For Org
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.
144 "Alist between export properties and ways to set them.
146 The CAR of the alist is the property name, and the CDR is a list
147 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
149 KEYWORD is a string representing a buffer keyword, or nil. Each
150 property defined this way can also be set, during subtree
151 export, through an headline property named after the keyword
153 property).
154 OPTION is a string that could be found in an #+OPTIONS: line.
155 DEFAULT is the default value for the property.
156 BEHAVIOUR determines how Org should handle multiple keywords for
157 the same property. It is a symbol among:
158 nil Keep old value and discard the new one.
159 t Replace old value with the new one.
160 `space' Concatenate the values, separating them with a space.
161 `newline' Concatenate the values, separating them with
162 a newline.
163 `split' Split values at white spaces, and cons them to the
164 previous list.
166 Values set through KEYWORD and OPTION have precedence over
167 DEFAULT.
169 All these properties should be back-end agnostic. Back-end
170 specific properties are set through `org-export-define-backend'.
174 "List of in-buffer keywords that require special treatment.
175 These keywords are not directly associated to a property. The
176 way they are handled must be hard-coded into
237 "Alist between filters properties and initial values.
239 The key of each association is a property name accessible through
240 the communication channel. Its value is a configurable global
241 variable defining initial filters.
243 This list is meant to install user specified filters. Back-end
244 developers may install their own filters using
245 `org-export-define-backend'. Filters defined there will always
246 be prepended to the current list, so they always get applied
255 "Default rule for link matching an inline image.
256 This rule applies to links with no description. By default, it
257 will be considered as an inline image if it targets a local file
260 See `org-export-inline-image-p' for more information about
264 "Non-nil means asynchronous export process should leave data behind.
268 located in `temporary-file-directory'.
270 When non-nil, it will also set `debug-on-error' to a non-nil
274 "Record asynchronously generated export results and processes.
275 This is an alist: its CAR is the source of the
276 result (destination file or buffer for a finished process,
277 original buffer for a running one) and its CDR is a list
278 containing the back-end used, as a symbol, and either a process
279 or the time at which it finished. It is used to build the menu
283 "List of backends currently available in the exporter.
285 A backend is stored as a list where CAR is its name, as a symbol,
286 and CDR is a plist with the following properties:
287 `:filters-alist', `:menu-entry', `:options-alist' and
288 `:translate-alist'.
290 This variable is set with `org-export-define-backend' and
294 "Last command called from the dispatcher.
295 The value should be a list. Its CAR is the action, as a symbol,
299 \f
300 ;;; User-configurable Variables
301 ;;
302 ;; Configuration for the masses.
303 ;;
304 ;; They should never be accessed directly, as their value is to be
305 ;; stored in a property list (cf. `org-export-options-alist').
306 ;; Back-ends will read their value from there instead.
309 "Options for exporting Org mode files."
314 "General options for export engine."
319 "Whether sub-trees with the ARCHIVE tag should be exported.
321 This can have three different values:
322 nil Do not export, pretend this tree is not present.
323 t Do export the entire tree.
324 `headline' Only export the headline, but skip the tree below it.
326 This option can also be set with the #+OPTIONS line,
335 "Non-nil means insert author name into the exported file.
336 This option can also be set with the #+OPTIONS line,
342 "Non-nil means export CLOCK keywords.
343 This option can also be set with the #+OPTIONS line,
349 "Non-nil means the postamble should contain a creator sentence.
351 The sentence can be set in `org-export-creator-string' and
354 If the value is `comment' insert it as a comment."
362 "Non-nil means insert date in the exported document.
363 This options can also be set with the OPTIONS keyword,
369 emacs-version)
370 "String to insert at the end of the generated document."
375 "Non-nil means export contents of standard drawers.
377 When t, all drawers are exported. This may also be a list of
378 drawer names to export. This variable doesn't apply to
379 properties drawers.
381 This option can also be set with the #+OPTIONS line,
391 "Non-nil means insert author email into the exported file.
392 This option can also be set with the #+OPTIONS line,
398 "Non-nil means interpret *word*, /word/, _word_ and +word+.
400 If the export target supports emphasizing text, the word will be
401 typeset in bold, italic, with an underline or strike-through,
402 respectively.
409 "Tags that exclude a tree from export.
411 All trees carrying any of these tags will be excluded from
412 export. This is without condition, so even subtrees inside that
413 carry one of the `org-export-select-tags' will be removed.
415 This option can also be set with the #+EXCLUDE_TAGS: keyword."
422 This can be used to have pre-formatted text, fragments of code
423 etc. For example:
424 : ;; Some Lisp examples
425 : (while (defc cnt)
426 : (ding))
427 will be looking just like this in also HTML. See also the QUOTE
428 keyword. Not all export backends support this.
435 "Non-nil means Org footnotes should be exported.
436 This option can also be set with the #+OPTIONS line,
442 "The last level which is still exported as a headline.
444 Inferior levels will produce itemize lists when exported.
451 "The default language for export and clocktable translations, as a string.
452 This may have an association in
453 `org-clock-clocktable-language-setup'."
458 "Non-nil means preserve all line breaks when exporting.
460 Normally, in HTML output paragraphs will be reformatted.
462 This option can also be set with the #+OPTIONS line,
468 "Non-nil means interpret entities when exporting.
471 Å.
473 For a list of supported names, see the constant `org-entities'
474 and the user option `org-entities-user'.
476 This option can also be set with the #+OPTIONS line,
482 "Non-nil means inlinetasks should be exported.
483 This option can also be set with the #+OPTIONS line,
489 "Non-nil means include planning info in export.
490 This option can also be set with the #+OPTIONS: line,
496 "Non-nil means include priority cookies in export.
497 This option can also be set with the #+OPTIONS line,
503 "Non-nil means add section numbers to headlines when exporting.
505 When set to an integer n, numbering will only happen for
506 headlines whose relative level is higher or equal to n.
508 This option can also be set with the #+OPTIONS line,
514 "Tags that select a tree for export.
516 If any such tag is found in a buffer, all trees that do not carry
517 one of these tags will be ignored during export. Inside trees
518 that are selected like this, you can still deselect a subtree by
519 tagging it with one of the `org-export-exclude-tags'.
521 This option can also be set with the #+SELECT_TAGS: keyword."
526 "Non-nil means activate smart quotes during export.
527 This option can also be set with the #+OPTIONS: line,
535 When this option is turned on, these strings will be exported as:
537 Org HTML LaTeX UTF-8
538 -----+----------+--------+-------
540 -- – -- –
541 --- — --- —
544 This option can also be set with the #+OPTIONS line,
550 "Non-nil means include statistics cookies in export.
551 This option can also be set with the #+OPTIONS: line,
559 When this option is turned on, you can use TeX-like syntax for
561 will be considered as a single item - so grouping with {} is
562 normally not needed. For example, the following things will be
563 parsed as single sub- or superscripts.
565 10^24 or 10^tau several digits will be considered 1 item.
566 10^-12 or 10^-tau a leading sign with digits or a word
567 x^2-y^3 will be read as x^2 - y^3, because items are
568 terminated by almost any nonword/nondigit char.
569 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
571 Still, ambiguity is possible - so when in doubt use {} to enclose
572 the sub/superscript. If you set this variable to the symbol
573 `{}', the braces are *required* in order to trigger
574 interpretations as sub/superscript. This can be helpful in
577 This option can also be set with the #+OPTIONS line,
586 "Non-nil means create a table of contents in exported files.
588 The TOC contains headlines with levels up
589 to`org-export-headline-levels'. When an integer, include levels
590 up to N in the toc, this may then be different from
591 `org-export-headline-levels', but it will not be allowed to be
592 larger than the number of headline levels. When nil, no table of
593 contents is made.
595 This option can also be set with the #+OPTIONS line,
605 For example:
607 | Name | Address | Birthday |
608 |-------------+----------+-----------|
609 | Arthur Dent | England | 29.2.2100 |
616 "If nil, do not export tags, just remove them from headlines.
618 If this is the symbol `not-in-toc', tags will be removed from
619 table of contents entries, but still be shown in the headlines of
620 the document.
622 This option can also be set with the #+OPTIONS line,
631 "Non-nil means include TODO items for export.
633 This may have the following values:
634 t include tasks independent of state.
635 `todo' include only tasks that are not yet done.
636 `done' include only tasks that are already done.
637 nil ignore all tasks.
638 list of keywords include tasks with these keywords.
640 This option can also be set with the #+OPTIONS line,
652 "Non-nil means insert a time stamp into the exported file.
653 The time stamp shows when the file was created.
655 This option can also be set with the #+OPTIONS line,
661 "Non nil means allow timestamps in export.
663 It can be set to `active', `inactive', t or nil, in order to
664 export, respectively, only active timestamps, only inactive ones,
665 all of them or none.
667 This option can also be set with the #+OPTIONS line, e.g.
677 "Non-nil means include TODO keywords in export.
678 When nil, remove all these keywords from the export."
683 "Non-nil means allow #+BIND to define local variable values for export.
684 This is a potential security risk, which is why the user must
685 confirm the use of these lines."
693 "Alist between export snippets back-ends and exporter back-ends.
695 This variable allows to provide shortcuts for export snippets.
699 HTML code while every other back-end will ignore it."
707 "Coding system for the exported file."
712 "Non-nil means exported stuff will also be pushed onto the kill ring."
717 "The initial scope when exporting with `org-export-dispatch'.
718 This variable can be either set to `buffer' or `subtree'."
725 "Non-nil means show buffer after exporting to temp buffer.
726 When Org exports to a file, the buffer visiting that file is ever
727 shown, but remains buried. However, when exporting to
728 a temporary buffer, that buffer is popped up in a second window.
729 When this variable is nil, the buffer remains buried also in
730 these cases."
735 "Non-nil means export and publishing commands will run in background.
736 Results from an asynchronous export are never displayed. You can
742 "File used to initialize external export process.
743 Value must be an absolute file name. It defaults to user's
744 initialization file. Though, a specific configuration makes the
745 process faster and the export more portable."
750 "Non-nil means using a non-intrusive `org-export-dispatch'.
751 In that case, no help buffer is displayed. Though, an indicator
756 be passed the FORCE argument). Also, \[?] allows to switch back
757 to standard mode."
762 \f
763 ;;; Defining Back-ends
764 ;;
765 ;; `org-export-define-backend' is the standard way to define an export
766 ;; back-end. It allows to specify translators, filters, buffer
767 ;; options and a menu entry. If the new back-end shares translators
768 ;; with another back-end, `org-export-define-derived-backend' may be
769 ;; used instead.
770 ;;
771 ;; Internally, a back-end is stored as a list, of which CAR is the
772 ;; name of the back-end, as a symbol, and CDR a plist. Accessors to
773 ;; properties of a given back-end are: `org-export-backend-filters',
774 ;; `org-export-backend-menu', `org-export-backend-options' and
775 ;; `org-export-backend-translate-table'.
776 ;;
777 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
778 ;; when a given back-end hasn't been registered yet.
781 "Define a new back-end BACKEND.
783 TRANSLATORS is an alist between object or element types and
784 functions handling them.
786 These functions should return a string without any trailing
787 space, or nil. They must accept three arguments: the object or
788 element itself, its contents or nil when it isn't recursive and
789 the property list used as a communication channel.
791 Contents, when not nil, are stripped from any global indentation
792 \(although the relative one is preserved). They also always end
793 with a single newline character.
795 If, for a given type, no function is found, that element or
796 object type will simply be ignored, along with any blank line or
797 white space at its end. The same will happen if the function
798 returns the nil value. If that function returns the empty
799 string, the type will be ignored, but the blank lines or white
800 spaces will be kept.
802 In addition to element and object types, one function can be
803 associated to the `template' symbol and another one to the
804 `plain-text' symbol.
806 The former returns the final transcoded string, and can be used
807 to add a preamble and a postamble to document's body. It must
808 accept two arguments: the transcoded string and the property list
809 containing export options.
811 The latter, when defined, is to be called on every text not
812 recognized as an element or an object. It must accept two
813 arguments: the text string and the information channel. It is an
814 appropriate place to protect special chars relative to the
815 back-end.
817 BODY can start with pre-defined keyword arguments. The following
818 keywords are understood:
820 :export-block
822 String, or list of strings, representing block names that
823 will not be parsed. This is used to specify blocks that will
824 contain raw code specific to the back-end. These blocks
825 still have to be handled by the relative `export-block' type
826 translator.
828 :filters-alist
830 Alist between filters and function, or list of functions,
831 specific to the back-end. See `org-export-filters-alist' for
832 a list of all allowed filters. Filters defined here
833 shouldn't make a back-end test, as it may prevent back-ends
834 derived from this one to behave properly.
836 :menu-entry
838 Menu entry for the export dispatcher. It should be a list
839 like:
841 \(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
843 where :
845 KEY is a free character selecting the back-end.
847 DESCRIPTION-OR-ORDINAL is either a string or a number.
849 If it is a string, is will be used to name the back-end in
850 its menu entry. If it is a number, the following menu will
851 be displayed as a sub-menu of the back-end with the same
852 KEY. Also, the number will be used to determine in which
853 order such sub-menus will appear (lowest first).
855 ACTION-OR-MENU is either a function or an alist.
857 If it is an action, it will be called with four
858 arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
859 BODY-ONLY. See `org-export-as' for further explanations on
860 some of them.
862 If it is an alist, associations should follow the
863 pattern:
865 \(KEY DESCRIPTION ACTION)
867 where KEY, DESCRIPTION and ACTION are described above.
869 Valid values include:
873 or
878 \(lambda (a s v b)
879 \(if a (org-e-latex-export-to-pdf t s v b)
880 \(org-open-file
881 \(org-e-latex-export-to-pdf nil s v b)))))))
883 or the following, which will be added to the previous
884 sub-menu,
886 \(?l 1
890 :options-alist
892 Alist between back-end specific properties introduced in
893 communication channel and how their value are acquired. See
894 `org-export-options-alist' for more information about
895 structure of the values."
914 ;; Register back-end.
918 ;; Tell parser to not parse EXPORT-BLOCK blocks.
925 ;; Splice in the body, if any.
929 "Create a new back-end as a variant of an existing one.
931 CHILD is the name of the derived back-end. PARENT is the name of
932 the parent back-end.
934 BODY can start with pre-defined keyword arguments. The following
935 keywords are understood:
937 :export-block
939 String, or list of strings, representing block names that
940 will not be parsed. This is used to specify blocks that will
941 contain raw code specific to the back-end. These blocks
942 still have to be handled by the relative `export-block' type
943 translator.
945 :filters-alist
947 Alist of filters that will overwrite or complete filters
948 defined in PARENT back-end. See `org-export-filters-alist'
949 for a list of allowed filters.
951 :menu-entry
953 Menu entry for the export dispatcher. See
954 `org-export-define-backend' for more information about the
955 expected value.
957 :options-alist
959 Alist of back-end specific properties that will overwrite or
960 complete those defined in PARENT back-end. Refer to
961 `org-export-options-alist' for more information about
962 structure of the values.
964 :translate-alist
966 Alist of element and object types and transcoders that will
967 overwrite or complete transcode table from PARENT back-end.
968 Refer to `org-export-define-backend' for detailed information
969 about transcoders.
972 as a variant of `e-latex' back-end with a custom template
973 function:
975 \(org-export-define-derived-backend my-latex e-latex
976 :translate-alist ((template . my-latex-template-fun)))
978 The back-end could then be called with, for example:
1006 ;; Register back-end.
1010 ;; Tell parser to not parse EXPORT-BLOCK blocks.
1017 ;; Splice in the body, if any.
1021 "Return filters for BACKEND."
1026 "Return menu entry for BACKEND."
1031 "Return export options for BACKEND."
1036 "Return translate table for BACKEND."
1041 "Signal an error if BACKEND isn't defined."
1046 "Non-nil if BACKEND is derived from one of BACKENDS."
1051 org-export-registered-backends))
1053 parent))
1056 \f
1057 ;;; The Communication Channel
1058 ;;
1059 ;; During export process, every function has access to a number of
1060 ;; properties. They are of two types:
1061 ;;
1062 ;; 1. Environment options are collected once at the very beginning of
1063 ;; the process, out of the original buffer and configuration.
1064 ;; Collecting them is handled by `org-export-get-environment'
1065 ;; function.
1066 ;;
1067 ;; Most environment options are defined through the
1068 ;; `org-export-options-alist' variable.
1069 ;;
1070 ;; 2. Tree properties are extracted directly from the parsed tree,
1071 ;; just before export, by `org-export-collect-tree-properties'.
1072 ;;
1073 ;; Here is the full list of properties available during transcode
1074 ;; process, with their category and their value type.
1075 ;;
1076 ;; + `:author' :: Author's name.
1077 ;; - category :: option
1078 ;; - type :: string
1079 ;;
1080 ;; + `:back-end' :: Current back-end used for transcoding.
1081 ;; - category :: tree
1082 ;; - type :: symbol
1083 ;;
1084 ;; + `:creator' :: String to write as creation information.
1085 ;; - category :: option
1086 ;; - type :: string
1087 ;;
1088 ;; + `:date' :: String to use as date.
1089 ;; - category :: option
1090 ;; - type :: string
1091 ;;
1092 ;; + `:description' :: Description text for the current data.
1093 ;; - category :: option
1094 ;; - type :: string
1095 ;;
1096 ;; + `:email' :: Author's email.
1097 ;; - category :: option
1098 ;; - type :: string
1099 ;;
1100 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1101 ;; process.
1102 ;; - category :: option
1103 ;; - type :: list of strings
1104 ;;
1105 ;; + `:exported-data' :: Hash table used for memoizing
1106 ;; `org-export-data'.
1107 ;; - category :: tree
1108 ;; - type :: hash table
1109 ;;
1110 ;; + `:filetags' :: List of global tags for buffer. Used by
1111 ;; `org-export-get-tags' to get tags with inheritance.
1112 ;; - category :: option
1113 ;; - type :: list of strings
1114 ;;
1115 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1116 ;; their definition, as parsed data. Only non-inlined footnotes
1117 ;; are represented in this alist. Also, every definition isn't
1118 ;; guaranteed to be referenced in the parse tree. The purpose of
1119 ;; this property is to preserve definitions from oblivion
1120 ;; (i.e. when the parse tree comes from a part of the original
1121 ;; buffer), it isn't meant for direct use in a back-end. To
1122 ;; retrieve a definition relative to a reference, use
1123 ;; `org-export-get-footnote-definition' instead.
1124 ;; - category :: option
1125 ;; - type :: alist (STRING . LIST)
1126 ;;
1127 ;; + `:headline-levels' :: Maximum level being exported as an
1128 ;; headline. Comparison is done with the relative level of
1129 ;; headlines in the parse tree, not necessarily with their
1130 ;; actual level.
1131 ;; - category :: option
1132 ;; - type :: integer
1133 ;;
1134 ;; + `:headline-offset' :: Difference between relative and real level
1135 ;; of headlines in the parse tree. For example, a value of -1
1136 ;; means a level 2 headline should be considered as level
1137 ;; 1 (cf. `org-export-get-relative-level').
1138 ;; - category :: tree
1139 ;; - type :: integer
1140 ;;
1141 ;; + `:headline-numbering' :: Alist between headlines and their
1142 ;; numbering, as a list of numbers
1143 ;; (cf. `org-export-get-headline-number').
1144 ;; - category :: tree
1145 ;; - type :: alist (INTEGER . LIST)
1146 ;;
1147 ;; + `:id-alist' :: Alist between ID strings and destination file's
1148 ;; path, relative to current directory. It is used by
1149 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1150 ;; external file.
1151 ;; - category :: option
1152 ;; - type :: alist (STRING . STRING)
1153 ;;
1154 ;; + `:ignore-list' :: List of elements and objects that should be
1155 ;; ignored during export.
1156 ;; - category :: tree
1157 ;; - type :: list of elements and objects
1158 ;;
1159 ;; + `:input-file' :: Full path to input file, if any.
1160 ;; - category :: option
1161 ;; - type :: string or nil
1162 ;;
1163 ;; + `:keywords' :: List of keywords attached to data.
1164 ;; - category :: option
1165 ;; - type :: string
1166 ;;
1167 ;; + `:language' :: Default language used for translations.
1168 ;; - category :: option
1169 ;; - type :: string
1170 ;;
1171 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1172 ;; transcoding.
1173 ;; - category :: option
1174 ;; - type :: list (as returned by `org-element-parse-buffer')
1175 ;;
1176 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1177 ;; all line breaks.
1178 ;; - category :: option
1179 ;; - type :: symbol (nil, t)
1180 ;;
1181 ;; + `:section-numbers' :: Non-nil means transcoding should add
1182 ;; section numbers to headlines.
1183 ;; - category :: option
1184 ;; - type :: symbol (nil, t)
1185 ;;
1186 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1187 ;; in transcoding. When such a tag is present, subtrees without
1188 ;; it are de facto excluded from the process. See
1189 ;; `use-select-tags'.
1190 ;; - category :: option
1191 ;; - type :: list of strings
1192 ;;
1193 ;; + `:target-list' :: List of targets encountered in the parse tree.
1194 ;; This is used to partly resolve "fuzzy" links
1195 ;; (cf. `org-export-resolve-fuzzy-link').
1196 ;; - category :: tree
1197 ;; - type :: list of strings
1198 ;;
1199 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1200 ;; a time stamp in the output.
1201 ;; - category :: option
1202 ;; - type :: symbol (nil, t)
1203 ;;
1204 ;; + `:translate-alist' :: Alist between element and object types and
1205 ;; transcoding functions relative to the current back-end.
1206 ;; Special keys `template' and `plain-text' are also possible.
1207 ;; - category :: option
1208 ;; - type :: alist (SYMBOL . FUNCTION)
1209 ;;
1210 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1211 ;; also be transcoded. If it is set to the `headline' symbol,
1212 ;; only the archived headline's name is retained.
1213 ;; - category :: option
1214 ;; - type :: symbol (nil, t, `headline')
1215 ;;
1216 ;; + `:with-author' :: Non-nil means author's name should be included
1217 ;; in the output.
1218 ;; - category :: option
1219 ;; - type :: symbol (nil, t)
1220 ;;
1221 ;; + `:with-clocks' :: Non-nil means clock keywords should be exported.
1222 ;; - category :: option
1223 ;; - type :: symbol (nil, t)
1224 ;;
1225 ;; + `:with-creator' :: Non-nil means a creation sentence should be
1226 ;; inserted at the end of the transcoded string. If the value
1227 ;; is `comment', it should be commented.
1228 ;; - category :: option
1229 ;; - type :: symbol (`comment', nil, t)
1230 ;;
1231 ;; + `:with-date' :: Non-nil means output should contain a date.
1232 ;; - category :: option
1233 ;; - type :. symbol (nil, t)
1234 ;;
1235 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1236 ;; its value is a list of names, only drawers with such names
1237 ;; will be transcoded.
1238 ;; - category :: option
1239 ;; - type :: symbol (nil, t) or list of strings
1240 ;;
1241 ;; + `:with-email' :: Non-nil means output should contain author's
1242 ;; email.
1243 ;; - category :: option
1244 ;; - type :: symbol (nil, t)
1245 ;;
1246 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1247 ;; interpreted.
1248 ;; - category :: option
1249 ;; - type :: symbol (nil, t)
1250 ;;
1251 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1252 ;; strings starting with a colon as a fixed-with (verbatim) area.
1253 ;; - category :: option
1254 ;; - type :: symbol (nil, t)
1255 ;;
1256 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1257 ;; footnotes.
1258 ;; - category :: option
1259 ;; - type :: symbol (nil, t)
1260 ;;
1261 ;; + `:with-plannings' :: Non-nil means transcoding should include
1262 ;; planning info.
1263 ;; - category :: option
1264 ;; - type :: symbol (nil, t)
1265 ;;
1266 ;; + `:with-priority' :: Non-nil means transcoding should include
1267 ;; priority cookies.
1268 ;; - category :: option
1269 ;; - type :: symbol (nil, t)
1270 ;;
1271 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1272 ;; plain text.
1273 ;; - category :: option
1274 ;; - type :: symbol (nil, t)
1275 ;;
1276 ;; + `:with-special-strings' :: Non-nil means transcoding should
1277 ;; interpret special strings in plain text.
1278 ;; - category :: option
1279 ;; - type :: symbol (nil, t)
1280 ;;
1281 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1282 ;; interpret subscript and superscript. With a value of "{}",
1283 ;; only interpret those using curly brackets.
1284 ;; - category :: option
1285 ;; - type :: symbol (nil, {}, t)
1286 ;;
1287 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1288 ;; tables.
1289 ;; - category :: option
1290 ;; - type :: symbol (nil, t)
1291 ;;
1292 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1293 ;; headlines. A `not-in-toc' value will remove them from the
1294 ;; table of contents, if any, nonetheless.
1295 ;; - category :: option
1296 ;; - type :: symbol (nil, t, `not-in-toc')
1297 ;;
1298 ;; + `:with-tasks' :: Non-nil means transcoding should include
1299 ;; headlines with a TODO keyword. A `todo' value will only
1300 ;; include headlines with a todo type keyword while a `done'
1301 ;; value will do the contrary. If a list of strings is provided,
1302 ;; only tasks with keywords belonging to that list will be kept.
1303 ;; - category :: option
1304 ;; - type :: symbol (t, todo, done, nil) or list of strings
1305 ;;
1306 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1307 ;; time stamps. Special value `active' (resp. `inactive') ask to
1308 ;; export only active (resp. inactive) timestamps. Otherwise,
1309 ;; completely remove them.
1310 ;; - category :: option
1311 ;; - type :: symbol: (`active', `inactive', t, nil)
1312 ;;
1313 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1314 ;; added to the output. An integer value limits its depth.
1315 ;; - category :: option
1316 ;; - type :: symbol (nil, t or integer)
1317 ;;
1318 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1319 ;; include TODO keywords.
1320 ;; - category :: option
1321 ;; - type :: symbol (nil, t)
1324 ;;;; Environment Options
1325 ;;
1326 ;; Environment options encompass all parameters defined outside the
1327 ;; scope of the parsed data. They come from five sources, in
1328 ;; increasing precedence order:
1329 ;;
1330 ;; - Global variables,
1331 ;; - Buffer's attributes,
1332 ;; - Options keyword symbols,
1333 ;; - Buffer keywords,
1334 ;; - Subtree properties.
1335 ;;
1336 ;; The central internal function with regards to environment options
1337 ;; is `org-export-get-environment'. It updates global variables with
1338 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1339 ;; the different sources.
1340 ;;
1341 ;; The internal functions doing the retrieval are:
1342 ;; `org-export--get-global-options',
1343 ;; `org-export--get-buffer-attributes',
1344 ;; `org-export--parse-option-keyword',
1345 ;; `org-export--get-subtree-options' and
1346 ;; `org-export--get-inbuffer-options'
1347 ;;
1348 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1349 ;; take care of the part relative to "#+BIND:" keywords.
1352 "Collect export options from the current buffer.
1354 Optional argument BACKEND is a symbol specifying which back-end
1355 specific options to read, if any.
1357 When optional argument SUBTREEP is non-nil, assume the export is
1358 done against the current sub-tree.
1360 Third optional argument EXT-PLIST is a property list with
1361 external parameters overriding Org default settings, but still
1362 inferior to file-local settings."
1363 ;; First install #+BIND variables.
1365 ;; Get and prioritize export options...
1367 ;; ... from global variables...
1369 ;; ... from an external property list...
1370 ext-plist
1371 ;; ... from in-buffer settings...
1373 backend
1375 ;; ... and from subtree, when appropriate.
1377 ;; Eventually add misc. properties.
1379 :back-end
1380 backend
1381 :translate-alist
1383 :footnote-definition-alist
1384 ;; Footnotes definitions must be collected in the original
1385 ;; buffer, as there's no insurance that they will still be in
1386 ;; the parse tree, due to possible narrowing.
1400 alist))))
1401 alist))
1402 :id-alist
1403 ;; Collect id references.
1414 alist))))
1417 "Parse an OPTIONS line and return values as a plist.
1418 Optional argument BACKEND is a symbol specifying which back-end
1419 specific items to read, if any."
1422 ;; Build an alist between #+OPTION: item and property-name.
1427 all)))
1428 plist)
1433 options)
1438 alist)
1439 plist))
1442 "Get export options in subtree at point.
1443 Optional argument BACKEND is a symbol specifying back-end used
1444 for export. Return options as a plist."
1445 ;; For each buffer keyword, create an headline property setting the
1446 ;; same property in communication channel. The name for the property
1447 ;; is the keyword with "EXPORT_" appended to it.
1450 ;; Make sure point is at an heading.
1452 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1453 ;; title as its fallback value.
1459 plist :title
1462 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1466 ;; Handle other keywords. TITLE keyword is excluded as it has
1467 ;; been handled already.
1474 ;; Export properties are not case-sensitive.
1481 plist
1484 ;; Parse VALUE if required.
1488 ;; If BEHAVIOUR is `split' expected value is
1489 ;; a list of strings, not a string.
1492 ;; Also look for both general keywords and back-end specific
1493 ;; options if BACKEND is provided.
1495 org-export-options-alist)))
1496 ;; Return value.
1497 plist)))
1500 "Return current buffer export options, as a plist.
1502 Optional argument BACKEND, when non-nil, is a symbol specifying
1503 which back-end specific options should also be read in the
1504 process.
1506 Optional argument FILES is a list of setup files names read so
1507 far, used to avoid circular dependencies.
1509 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1513 ;; 1. Special keywords, as in `org-export-special-keywords'.
1527 ;; Avoid circular dependencies.
1542 ;; 2. Standard options, as in `org-export-options-alist'.
1544 ;; Also look for back-end specific options if
1545 ;; BACKEND is defined.
1547 ;; Build ALIST between keyword name and property name.
1551 all)))
1552 ;; Build regexp matching all keywords associated to export
1553 ;; options. Note: the search is case insensitive.
1567 plist prop
1568 ;; Handle value depending on specified BEHAVIOUR.
1581 ;; Parse keywords specified in
1582 ;; `org-element-document-properties'.
1590 plist prop
1593 org-element-document-properties))
1594 ;; 3. Return final value.
1595 plist)))
1598 "Return properties related to buffer attributes, as a plist."
1601 ;; Store full path of input file name, or nil. For internal use.
1602 :input-file visited-file
1609 "Return global export options as a plist.
1611 Optional argument BACKEND, if non-nil, is a symbol specifying
1612 which back-end specific export options should also be read in the
1613 process."
1616 ;; Output value.
1617 plist)
1622 plist
1624 ;; Eval default value provided. If keyword is a member
1625 ;; of `org-element-document-properties', parse it as
1626 ;; a secondary string before storing it.
1631 value
1634 all)
1635 ;; Return value.
1636 plist))
1640 "Can we use #+BIND values during export?
1641 By default this will ask for confirmation by the user, to divert
1642 possible security risks."
1647 org-export--allow-BIND-local)
1652 "Install the values from #+BIND lines as local variables.
1653 Variables must be installed before in-buffer options are
1654 retrieved."
1669 ;;;; Tree Properties
1670 ;;
1671 ;; Tree properties are information extracted from parse tree. They
1672 ;; are initialized at the beginning of the transcoding process by
1673 ;; `org-export-collect-tree-properties'.
1674 ;;
1675 ;; Dedicated functions focus on computing the value of specific tree
1676 ;; properties during initialization. Thus,
1677 ;; `org-export--populate-ignore-list' lists elements and objects that
1678 ;; should be skipped during export, `org-export--get-min-level' gets
1679 ;; the minimal exportable level, used as a basis to compute relative
1680 ;; level for headlines. Eventually
1681 ;; `org-export--collect-headline-numbering' builds an alist between
1682 ;; headlines and their numbering.
1685 "Extract tree properties from parse tree.
1687 DATA is the parse tree from which information is retrieved. INFO
1688 is a list holding export options.
1690 Following tree properties are set or updated:
1692 `:exported-data' Hash table used to memoize results from
1693 `org-export-data'.
1695 `:footnote-definition-alist' List of footnotes definitions in
1696 original buffer and current parse tree.
1698 `:headline-offset' Offset between true level of headlines and
1699 local level. An offset of -1 means an headline
1700 of level 2 should be considered as a level
1701 1 headline in the context.
1703 `:headline-numbering' Alist of all headlines as key an the
1704 associated numbering as value.
1706 `:ignore-list' List of elements that should be ignored during
1707 export.
1709 `:target-list' List of all targets in the parse tree.
1711 Return updated plist."
1712 ;; Install the parse tree in the communication channel, in order to
1713 ;; use `org-export-get-genealogy' and al.
1715 ;; Get the list of elements and objects to ignore, and put it into
1716 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1717 ;; been done during parse tree filtering.
1720 :ignore-list
1723 ;; Compute `:headline-offset' in order to be able to use
1724 ;; `org-export-get-relative-level'.
1727 :headline-offset
1729 ;; Update footnotes definitions list with definitions in parse tree.
1730 ;; This is required since buffer expansion might have modified
1731 ;; boundaries of footnote definitions contained in the parse tree.
1732 ;; This way, definitions in `footnote-definition-alist' are bound to
1733 ;; match those in the parse tree.
1736 data 'footnote-definition
1740 defs)))
1742 ;; Properties order doesn't matter: get the rest of the tree
1743 ;; properties.
1745 `(:target-list
1754 info))
1757 "Return minimum exportable headline's level in DATA.
1758 DATA is parsed tree as returned by `org-element-parse-buffer'.
1759 OPTIONS is a plist holding export options."
1770 ;; If no headline was found, for the sake of consistency, set
1771 ;; minimum level to 1 nonetheless.
1775 "Return numbering of all exportable headlines in a parse tree.
1777 DATA is the parse tree. OPTIONS is the plist holding export
1778 options.
1780 Return an alist whose key is an headline and value is its
1781 associated numbering \(in the shape of a list of numbers\)."
1784 data
1785 'headline
1790 headline
1792 for idx from 0 to org-export-max-depth
1796 options)))
1799 "Return list of elements and objects to ignore during export.
1800 DATA is the parse tree to traverse. OPTIONS is the plist holding
1801 export options."
1803 walk-data
1804 ;; First find trees containing a select tag, if any.
1808 ;; Collect ignored elements or objects into IGNORE-LIST.
1814 ;; If headline is archived but tree below has
1815 ;; to be skipped, add it to ignore list.
1818 ;; Move into secondary string, if any.
1823 ;; Move into recursive objects/elements.
1825 ;; Main call.
1827 ;; Return value.
1828 ignore))
1831 "Return list of headlines containing a select tag in their tree.
1832 DATA is parsed data as returned by `org-element-parse-buffer'.
1833 INFO is a plist holding export options."
1835 walk-data ; for byte-compiler.
1846 ;; When a select tag is found, mark full
1847 ;; genealogy and every headline within the tree
1848 ;; as acceptable.
1851 genealogy
1853 selected-trees))
1854 ;; Else, continue searching in tree, recursively.
1861 "Non-nil when element or object BLOB should be skipped during export.
1862 OPTIONS is the plist holding export options. SELECTED, when
1863 non-nil, is a list of headlines belonging to a tree with a select
1864 tag."
1879 ;; Ignore subtrees with an exclude tag.
1882 ;; When a select tag is present in the buffer, ignore any tree
1883 ;; without it.
1885 ;; Ignore commented sub-trees.
1887 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1889 ;; Ignore tasks, if specified by `:with-tasks' property.
1905 ;; No timestamp allowed.
1907 ;; Only active timestamps allowed and the current one isn't
1908 ;; active.
1912 ;; Only inactive timestamps allowed and the current one isn't
1913 ;; inactive.
1919 \f
1920 ;;; The Transcoder
1921 ;;
1922 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1923 ;; `org-element-parse-buffer') and transcodes it into a specified
1924 ;; back-end output. It takes care of filtering out elements or
1925 ;; objects according to export options and organizing the output blank
1926 ;; lines and white space are preserved. The function memoizes its
1927 ;; results, so it is cheap to call it within translators.
1928 ;;
1929 ;; It is possible to modify locally the back-end used by
1930 ;; `org-export-data' or even use a temporary back-end by using
1931 ;; `org-export-data-with-translations' and
1932 ;; `org-export-data-with-backend'.
1933 ;;
1934 ;; Internally, three functions handle the filtering of objects and
1935 ;; elements during the export. In particular,
1936 ;; `org-export-ignore-element' marks an element or object so future
1937 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1938 ;; elements or objects should be seen as real Org syntax and
1939 ;; `org-export-expand' transforms the others back into their original
1940 ;; shape
1941 ;;
1942 ;; `org-export-transcoder' is an accessor returning appropriate
1943 ;; translator function for a given element or object.
1946 "Return appropriate transcoder for BLOB.
1947 INFO is a plist containing export directives."
1949 ;; Return contents only for complete parse trees.
1955 "Convert DATA into current back-end format.
1957 DATA is a parse tree, an element or an object or a secondary
1958 string. INFO is a plist holding export options.
1960 Return transcoded string."
1966 ;; Ignored element/object.
1968 ;; Plain text.
1974 info))
1975 ;; Uninterpreted element/object: change it back to Org
1976 ;; syntax and export again resulting raw string.
1980 data
1984 info))
1985 ;; Secondary string.
1988 ;; Element/Object without contents or, as a special case,
1989 ;; headline with archive tag and archived trees restricted
1990 ;; to title only.
1998 ;; Element/Object with contents.
2011 ;; Elements directly containing objects
2012 ;; must have their indentation normalized
2013 ;; first.
2015 data
2016 ;; When normalizing contents of the first
2017 ;; paragraph in an item or a footnote
2018 ;; definition, ignore first line's
2019 ;; indentation: there is none and it
2020 ;; might be misleading.
2025 data)
2032 info))))))))
2033 ;; Final result will be memoized before being returned.
2035 data
2039 ;; Append the same white space between elements or objects as in
2040 ;; the original buffer, and call appropriate filters.
2051 info)))
2052 results)))
2056 "Convert DATA into another format using a given translation table.
2057 DATA is an element, an object, a secondary string or a string.
2058 TRANSLATIONS is an alist between element or object types and
2059 a functions handling them. See `org-export-define-backend' for
2060 more information. INFO is a plist used as a communication
2061 channel."
2063 data
2064 ;; Set-up a new communication channel with TRANSLATIONS as the
2065 ;; translate table and a new hash table for memoization.
2067 info
2069 ;; Size of the hash table is reduced since this function
2070 ;; will probably be used on short trees.
2074 "Convert DATA into BACKEND format.
2076 DATA is an element, an object, a secondary string or a string.
2077 BACKEND is a symbol. INFO is a plist used as a communication
2078 channel.
2080 Unlike to `org-export-with-backend', this function will
2081 recursively convert DATA using BACKEND translation table."
2087 "Non-nil if element or object BLOB should be interpreted as Org syntax.
2088 Check is done according to export options INFO, stored as
2089 a plist."
2091 ;; ... entities...
2093 ;; ... emphasis...
2096 ;; ... fixed-width areas.
2098 ;; ... footnotes...
2101 ;; ... sub/superscripts...
2107 ;; ... tables...
2112 "Expand a parsed element or object to its original state.
2113 BLOB is either an element or an object. CONTENTS is its
2114 contents, as a string or nil."
2117 blob contents))
2120 "Add ELEMENT to `:ignore-list' in INFO.
2122 Any element in `:ignore-list' will be skipped when using
2123 `org-element-map'. INFO is modified by side effects."
2127 \f
2128 ;;; The Filter System
2129 ;;
2130 ;; Filters allow end-users to tweak easily the transcoded output.
2131 ;; They are the functional counterpart of hooks, as every filter in
2132 ;; a set is applied to the return value of the previous one.
2133 ;;
2134 ;; Every set is back-end agnostic. Although, a filter is always
2135 ;; called, in addition to the string it applies to, with the back-end
2136 ;; used as argument, so it's easy for the end-user to add back-end
2137 ;; specific filters in the set. The communication channel, as
2138 ;; a plist, is required as the third argument.
2139 ;;
2140 ;; From the developer side, filters sets can be installed in the
2141 ;; process with the help of `org-export-define-backend', which
2142 ;; internally stores filters as an alist. Each association has a key
2143 ;; among the following symbols and a function or a list of functions
2144 ;; as value.
2145 ;;
2146 ;; - `:filter-options' applies to the property list containing export
2147 ;; options. Unlike to other filters, functions in this list accept
2148 ;; two arguments instead of three: the property list containing
2149 ;; export options and the back-end. Users can set its value through
2150 ;; `org-export-filter-options-functions' variable.
2151 ;;
2152 ;; - `:filter-parse-tree' applies directly to the complete parsed
2153 ;; tree. Users can set it through
2154 ;; `org-export-filter-parse-tree-functions' variable.
2155 ;;
2156 ;; - `:filter-final-output' applies to the final transcoded string.
2157 ;; Users can set it with `org-export-filter-final-output-functions'
2158 ;; variable
2159 ;;
2160 ;; - `:filter-plain-text' applies to any string not recognized as Org
2161 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2162 ;; configure it.
2163 ;;
2164 ;; - `:filter-TYPE' applies on the string returned after an element or
2165 ;; object of type TYPE has been transcoded. An user can modify
2166 ;; `org-export-filter-TYPE-functions'
2167 ;;
2168 ;; All filters sets are applied with
2169 ;; `org-export-filter-apply-functions' function. Filters in a set are
2170 ;; applied in a LIFO fashion. It allows developers to be sure that
2171 ;; their filters will be applied first.
2172 ;;
2173 ;; Filters properties are installed in communication channel with
2174 ;; `org-export-install-filters' function.
2175 ;;
2176 ;; Eventually, two hooks (`org-export-before-processing-hook' and
2177 ;; `org-export-before-parsing-hook') are run at the beginning of the
2178 ;; export process and just before parsing to allow for heavy structure
2179 ;; modifications.
2182 ;;;; Hooks
2185 "Hook run at the beginning of the export process.
2187 This is run before include keywords and macros are expanded and
2188 Babel code blocks executed, on a copy of the original buffer
2189 being exported. Visibility and narrowing are preserved. Point
2190 is at the beginning of the buffer.
2192 Every function in this hook will be called with one argument: the
2196 "Hook run before parsing an export buffer.
2198 This is run after include keywords and macros have been expanded
2199 and Babel code blocks executed, on a copy of the original buffer
2200 being exported. Visibility and narrowing are preserved. Point
2201 is at the beginning of the buffer.
2203 Every function in this hook will be called with one argument: the
2207 ;;;; Special Filters
2210 "List of functions applied to the export options.
2211 Each filter is called with two arguments: the export options, as
2212 a plist, and the back-end, as a symbol. It must return
2216 "List of functions applied to the parsed tree.
2217 Each filter is called with three arguments: the parse tree, as
2218 returned by `org-element-parse-buffer', the back-end, as
2219 a symbol, and the communication channel, as a plist. It must
2223 "List of functions applied to plain text.
2224 Each filter is called with three arguments: a string which
2225 contains no Org syntax, the back-end, as a symbol, and the
2226 communication channel, as a plist. It must return a string or
2230 "List of functions applied to the transcoded string.
2231 Each filter is called with three arguments: the full transcoded
2232 string, the back-end, as a symbol, and the communication channel,
2233 as a plist. It must return a string that will be used as the
2237 ;;;; Elements Filters
2240 "List of functions applied to a transcoded babel-call.
2241 Each filter is called with three arguments: the transcoded data,
2242 as a string, the back-end, as a symbol, and the communication
2246 "List of functions applied to a transcoded center block.
2247 Each filter is called with three arguments: the transcoded data,
2248 as a string, the back-end, as a symbol, and the communication
2252 "List of functions applied to a transcoded clock.
2253 Each filter is called with three arguments: the transcoded data,
2254 as a string, the back-end, as a symbol, and the communication
2258 "List of functions applied to a transcoded comment.
2259 Each filter is called with three arguments: the transcoded data,
2260 as a string, the back-end, as a symbol, and the communication
2264 "List of functions applied to a transcoded comment-block.
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 diary-sexp.
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 drawer.
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 dynamic-block.
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 example-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 export-block.
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 fixed-width.
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 footnote-definition.
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 headline.
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 horizontal-rule.
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 inlinetask.
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 item.
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 keyword.
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 latex-environment.
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 node-property.
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 paragraph.
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 plain-list.
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 planning.
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 property-drawer.
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 quote block.
2379 Each filter is called with three arguments: the transcoded quote
2380 data, as a string, the back-end, as a symbol, and the
2381 communication channel, as a plist. It must return a string or
2385 "List of functions applied to a transcoded quote-section.
2386 Each filter is called with three arguments: the transcoded data,
2387 as a string, the back-end, as a symbol, and the communication
2391 "List of functions applied to a transcoded section.
2392 Each filter is called with three arguments: the transcoded data,
2393 as a string, the back-end, as a symbol, and the communication
2397 "List of functions applied to a transcoded special block.
2398 Each filter is called with three arguments: the transcoded data,
2399 as a string, the back-end, as a symbol, and the communication
2403 "List of functions applied to a transcoded src-block.
2404 Each filter is called with three arguments: the transcoded data,
2405 as a string, the back-end, as a symbol, and the communication
2409 "List of functions applied to a transcoded table.
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 table-cell.
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 table-row.
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 verse 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 ;;;; Objects Filters
2436 "List of functions applied to transcoded bold text.
2437 Each filter is called with three arguments: the transcoded data,
2438 as a string, the back-end, as a symbol, and the communication
2442 "List of functions applied to transcoded code text.
2443 Each filter is called with three arguments: the transcoded data,
2444 as a string, the back-end, as a symbol, and the communication
2448 "List of functions applied to a transcoded entity.
2449 Each filter is called with three arguments: the transcoded data,
2450 as a string, the back-end, as a symbol, and the communication
2454 "List of functions applied to a transcoded export-snippet.
2455 Each filter is called with three arguments: the transcoded data,
2456 as a string, the back-end, as a symbol, and the communication
2460 "List of functions applied to a transcoded footnote-reference.
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 a transcoded inline-babel-call.
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 inline-src-block.
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 transcoded italic text.
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 latex-fragment.
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 line-break.
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 link.
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 a transcoded macro.
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 radio-target.
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 statistics-cookie.
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 transcoded strike-through text.
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 subscript.
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 superscript.
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 target.
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 a transcoded timestamp.
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 transcoded underline text.
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 transcoded verbatim text.
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 ;;;; Filters Tools
2563 ;;
2564 ;; Internal function `org-export-install-filters' installs filters
2565 ;; hard-coded in back-ends (developer filters) and filters from global
2566 ;; variables (user filters) in the communication channel.
2567 ;;
2568 ;; Internal function `org-export-filter-apply-functions' takes care
2569 ;; about applying each filter in order to a given data. It ignores
2570 ;; filters returning a nil value but stops whenever a filter returns
2571 ;; an empty string.
2574 "Call every function in FILTERS.
2576 Functions are called with arguments VALUE, current export
2577 back-end and INFO. A function returning a nil value will be
2578 skipped. If it returns the empty string, the process ends and
2579 VALUE is ignored.
2581 Call is done in a LIFO fashion, to be sure that developer
2582 specified filters, if any, are called first."
2591 "Install filters properties in communication channel.
2592 INFO is a plist containing the current communication channel.
2593 Return the updated communication channel."
2595 ;; Install user defined filters with `org-export-filters-alist'.
2598 org-export-filters-alist)
2599 ;; Prepend back-end specific filters to that list.
2601 ;; Single values get consed, lists are prepended.
2606 plist key
2610 ;; Return new communication channel.
2614 \f
2615 ;;; Core functions
2616 ;;
2617 ;; This is the room for the main function, `org-export-as', along with
2618 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2619 ;; They differ only by the way they output the resulting code.
2620 ;;
2621 ;; `org-export-output-file-name' is an auxiliary function meant to be
2622 ;; used with `org-export-to-file'. With a given extension, it tries
2623 ;; to provide a canonical file name to write export output to.
2624 ;;
2625 ;; Note that `org-export-as' doesn't really parse the current buffer,
2626 ;; but a copy of it (with the same buffer-local variables and
2627 ;; visibility), where macros and include keywords are expanded and
2628 ;; Babel blocks are executed, if appropriate.
2629 ;; `org-export-with-buffer-copy' macro prepares that copy.
2630 ;;
2631 ;; File inclusion is taken care of by
2632 ;; `org-export-expand-include-keyword' and
2633 ;; `org-export--prepare-file-contents'. Structure wise, including
2634 ;; a whole Org file in a buffer often makes little sense. For
2635 ;; example, if the file contains an headline and the include keyword
2636 ;; was within an item, the item should contain the headline. That's
2637 ;; why file inclusion should be done before any structure can be
2638 ;; associated to the file, that is before parsing.
2642 "Transcode current Org buffer into BACKEND code.
2644 If narrowing is active in the current buffer, only transcode its
2645 narrowed part.
2647 If a region is active, transcode that region.
2649 When optional argument SUBTREEP is non-nil, transcode the
2650 sub-tree at point, extracting information from the headline
2651 properties first.
2653 When optional argument VISIBLE-ONLY is non-nil, don't export
2654 contents of hidden elements.
2656 When optional argument BODY-ONLY is non-nil, only return body
2657 code, without preamble nor postamble.
2659 Optional argument EXT-PLIST, when provided, is a property list
2660 with external parameters overriding Org default settings, but
2661 still inferior to file-local settings.
2663 Return code as a string."
2664 ;; Barf if BACKEND isn't registered.
2668 ;; Narrow buffer to an appropriate region or subtree for
2669 ;; parsing. If parsing subtree, be sure to remove main headline
2670 ;; too.
2678 ;; Initialize communication channel with original buffer
2679 ;; attributes, unavailable in its copy.
2681 ;; Update communication channel and get parse tree. Buffer
2682 ;; isn't parsed directly. Instead, a temporary copy is
2683 ;; created, where include keywords, macros are expanded and
2684 ;; code blocks are evaluated.
2686 ;; Run first hook with current back-end as argument.
2689 ;; Update macro templates since #+INCLUDE keywords might have
2690 ;; added some new ones.
2694 ;; Update radio targets since keyword inclusion might have
2695 ;; added some more.
2697 ;; Run last hook with current back-end as argument.
2700 ;; Update communication channel with environment. Also
2701 ;; install user's and developer's filters.
2706 ;; Expand export-specific set of macros: {{{author}}},
2707 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2708 ;; once regular macros have been expanded, since document
2709 ;; keywords may contain one of them.
2715 ;; EMAIL is not a parsed keyword: store it as-is.
2719 ;; Call options filters and update export options. We do not
2720 ;; use `org-export-filter-apply-functions' here since the
2721 ;; arity of such filters is different.
2725 ;; Parse buffer and call parse-tree filter on it.
2730 ;; Now tree is complete, compute its properties and add them
2731 ;; to communication channel.
2735 ;; Eventually transcode TREE. Wrap the resulting string into
2736 ;; a template, if required. Finally call final-output filter.
2741 ;; Remove all text properties since they cannot be
2742 ;; retrieved from an external process.
2748 info))))
2749 ;; Maybe add final OUTPUT to kill ring, then return it.
2752 output)))))
2756 "Call `org-export-as' with output to a specified buffer.
2758 BACKEND is the back-end used for transcoding, as a symbol.
2760 BUFFER is the output buffer. If it already exists, it will be
2761 erased first, otherwise, it will be created.
2763 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2764 EXT-PLIST are similar to those used in `org-export-as', which
2765 see.
2767 Return buffer."
2774 buffer))
2778 "Call `org-export-as' with output to a specified file.
2780 BACKEND is the back-end used for transcoding, as a symbol. FILE
2781 is the name of the output file, as a string.
2783 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
2784 EXT-PLIST are similar to those used in `org-export-as', which
2785 see.
2787 Return output file's name."
2788 ;; Checks for FILE permissions. `write-file' would do the same, but
2789 ;; we'd rather avoid needless transcoding of parse tree.
2791 ;; Insert contents to a temporary buffer and write it to FILE.
2797 ;; Return full path.
2798 file)
2801 "Return output file's name according to buffer specifications.
2803 EXTENSION is a string representing the output file extension,
2804 with the leading dot.
2806 With a non-nil optional argument SUBTREEP, try to determine
2808 of subtree at point.
2810 When optional argument PUB-DIR is set, use it as the publishing
2811 directory.
2813 When optional argument VISIBLE-ONLY is non-nil, don't export
2814 contents of hidden elements.
2816 Return file name as a string, or nil if it couldn't be
2817 determined."
2819 ;; File name may come from EXPORT_FILE_NAME subtree property,
2820 ;; assuming point is at beginning of said sub-tree.
2827 ;; File name may be extracted from buffer's associated
2828 ;; file, if any.
2831 ;; Can't determine file name on our own: Ask user.
2835 "Output file: " pub-dir nil nil nil
2838 ;; Build file name. Enforce EXTENSION over whatever user may have
2839 ;; come up with. PUB-DIR, if defined, always has precedence over
2840 ;; any provided path.
2845 extension))
2850 "Return a copy of the current buffer.
2851 The copy preserves Org buffer-local variables, visibility and
2852 narrowing."
2858 new-buf))
2861 "Apply BODY in a copy of the current buffer.
2862 The copy preserves local variables, visibility and contents of
2863 the original buffer. Point is at the beginning of the buffer
2864 when BODY is applied."
2873 ;; Kill copy without confirmation.
2879 "Generate a function duplicating BUFFER.
2881 The copy will preserve local variables, visibility, contents and
2882 narrowing of the original buffer. If a region was active in
2883 BUFFER, contents will be narrowed to that region instead.
2885 The resulting function can be eval'ed at a later time, from
2886 another buffer, effectively cloning the original buffer there."
2890 ;; Buffer local variables.
2900 buffer-file-name outline-level
2901 outline-regexp
2902 buffer-invisibility-spec))
2905 ;; Skip unreadable values, as they cannot be
2906 ;; sent to external process.
2910 local-vars)))))
2912 local-vars)
2913 ;; Whole buffer contents.
2918 ;; Narrowing.
2922 ;; Current position of point.
2924 ;; Overlays with invisible property.
2934 ov-set))))
2936 ov-set)))))
2939 "Expand every include keyword in buffer.
2940 Optional argument INCLUDED is a list of included file names along
2941 with their line restriction, when appropriate. It is used to
2942 avoid infinite recursion. Optional argument DIR is the current
2943 working directory. It is used to properly resolve relative
2944 paths."
2951 ;; Extract arguments from keyword's value.
2965 ;; Minimal level of included file defaults to the child
2966 ;; level of the current headline, if any, or one. It
2967 ;; only applies is the file is meant to be included as
2968 ;; an Org one.
2976 ;; Remove keyword.
2981 ;; Check if files has already been parsed. Look after
2982 ;; inclusion lines too, as different parts of the same file
2983 ;; can be included too.
2995 ind-str contents ind-str))))
3003 ind-str env contents ind-str))))
3016 "Prepare the contents of FILE for inclusion and return them as a string.
3018 When optional argument LINES is a string specifying a range of
3019 lines, include only those lines.
3021 Optional argument IND, when non-nil, is an integer specifying the
3022 global indentation of returned contents. Since its purpose is to
3023 allow an included file to stay in the same environment it was
3024 created \(i.e. a list item), it doesn't apply past the first
3025 headline encountered.
3027 Optional argument MINLEVEL, when non-nil, is an integer
3028 specifying the level that any top-level headline in the included
3029 file should have."
3045 ;; Remove blank lines at beginning and end of contents. The logic
3046 ;; behind that removal is that blank lines around include keyword
3047 ;; override blank lines in included file.
3056 ;; If IND is set, preserve indentation of include keyword until
3057 ;; the first headline encountered.
3063 ;; Do not move footnote definitions out of column 0.
3069 ;; When MINLEVEL is specified, compute minimal level for headlines
3070 ;; in the file (CUR-MIN), and remove stars to each headline so
3071 ;; that headlines with minimal level have a level of MINLEVEL.
3081 ;; Only change stars, don't bother moving whole
3082 ;; sections.
3089 "Execute every Babel code in the visible part of current buffer.
3090 This function will return an error if the current buffer is
3091 visiting a file."
3092 ;; Get a pristine copy of current buffer so Babel references can be
3093 ;; properly resolved.
3100 \f
3101 ;;; Tools For Back-Ends
3102 ;;
3103 ;; A whole set of tools is available to help build new exporters. Any
3104 ;; function general enough to have its use across many back-ends
3105 ;; should be added here.
3107 ;;;; For Affiliated Keywords
3108 ;;
3109 ;; `org-export-read-attribute' reads a property from a given element
3110 ;; as a plist. It can be used to normalize affiliated keywords'
3111 ;; syntax.
3112 ;;
3113 ;; Since captions can span over multiple lines and accept dual values,
3114 ;; their internal representation is a bit tricky. Therefore,
3115 ;; `org-export-get-caption' transparently returns a given element's
3116 ;; caption as a secondary string.
3119 "Turn ATTRIBUTE property from ELEMENT into a plist.
3121 When optional argument PROPERTY is non-nil, return the value of
3122 that property within attributes.
3126 properties."
3134 "Return caption from ELEMENT as a secondary string.
3136 When optional argument SHORTP is non-nil, return short caption,
3137 as a secondary string, instead.
3139 Caption lines are separated by a white space."
3147 ;;;; For Derived Back-ends
3148 ;;
3149 ;; `org-export-with-backend' is a function allowing to locally use
3150 ;; another back-end to transcode some object or element. In a derived
3151 ;; back-end, it may be used as a fall-back function once all specific
3152 ;; cases have been treated.
3155 "Call a transcoder from BACK-END on DATA.
3156 CONTENTS, when non-nil, is the transcoded contents of DATA
3157 element, as a string. INFO, when non-nil, is the communication
3158 channel used for export, as a plist.."
3168 ;;;; For Export Snippets
3169 ;;
3170 ;; Every export snippet is transmitted to the back-end. Though, the
3171 ;; latter will only retain one type of export-snippet, ignoring
3172 ;; others, based on the former's target back-end. The function
3173 ;; `org-export-snippet-backend' returns that back-end for a given
3174 ;; export-snippet.
3177 "Return EXPORT-SNIPPET targeted back-end as a symbol.
3178 Translation, with `org-export-snippet-translation-alist', is
3179 applied."
3183 back-end))))
3186 ;;;; For Footnotes
3187 ;;
3188 ;; `org-export-collect-footnote-definitions' is a tool to list
3189 ;; actually used footnotes definitions in the whole parse tree, or in
3190 ;; an headline, in order to add footnote listings throughout the
3191 ;; transcoded data.
3192 ;;
3193 ;; `org-export-footnote-first-reference-p' is a predicate used by some
3194 ;; back-ends, when they need to attach the footnote definition only to
3195 ;; the first occurrence of the corresponding label.
3196 ;;
3197 ;; `org-export-get-footnote-definition' and
3198 ;; `org-export-get-footnote-number' provide easier access to
3199 ;; additional information relative to a footnote reference.
3202 "Return an alist between footnote numbers, labels and definitions.
3204 DATA is the parse tree from which definitions are collected.
3205 INFO is the plist used as a communication channel.
3207 Definitions are sorted by order of references. They either
3208 appear as Org data or as a secondary string for inlined
3209 footnotes. Unreferenced definitions are ignored."
3211 collect-fn ; for byte-compiler.
3215 ;; Collect footnote number, label and definition in DATA.
3217 data 'footnote-reference
3224 def)
3225 num-alist)
3226 ;; Also search in definition for nested footnotes.
3229 ;; Don't enter footnote definitions since it will happen
3230 ;; when their first reference is found.
3236 "Non-nil when a footnote reference is the first one for its label.
3238 FOOTNOTE-REFERENCE is the footnote reference being considered.
3239 INFO is the plist used as a communication channel."
3241 ;; Anonymous footnotes are always a first reference.
3243 ;; Otherwise, return the first footnote with the same LABEL and
3244 ;; test if it is equal to FOOTNOTE-REFERENCE.
3250 data 'footnote-reference
3255 ;; If FN isn't inlined, be sure to traverse its
3256 ;; definition before resuming search. See
3257 ;; comments in `org-export-get-footnote-number'
3258 ;; for more information.
3262 ;; Don't enter footnote definitions since it will
3263 ;; happen when their first reference is found.
3266 footnote-reference)))))
3269 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3270 INFO is the plist used as a communication channel."
3276 "Return number associated to a footnote.
3278 FOOTNOTE is either a footnote reference or a footnote definition.
3279 INFO is the plist used as a communication channel."
3281 seen-refs
3282 search-ref ; For byte-compiler.
3286 ;; Search footnote references through DATA, filling
3287 ;; SEEN-REFS along the way.
3289 data 'footnote-reference
3293 ;; Anonymous footnote match: return number.
3296 ;; Labels match: return number.
3299 ;; Anonymous footnote: it's always a new one. Also,
3300 ;; be sure to return nil from the `cond' so
3301 ;; `first-match' doesn't get us out of the loop.
3303 ;; Label not seen so far: add it so SEEN-REFS.
3304 ;;
3305 ;; Also search for subsequent references in
3306 ;; footnote definition so numbering follows reading
3307 ;; logic. Note that we don't have to care about
3308 ;; inline definitions, since `org-element-map'
3309 ;; already traverses them at the right time.
3310 ;;
3311 ;; Once again, return nil to stay in the loop.
3316 nil))))
3317 ;; Don't enter footnote definitions since it will happen
3318 ;; when their first reference is found.
3323 ;;;; For Headlines
3324 ;;
3325 ;; `org-export-get-relative-level' is a shortcut to get headline
3326 ;; level, relatively to the lower headline level in the parsed tree.
3327 ;;
3328 ;; `org-export-get-headline-number' returns the section number of an
3329 ;; headline, while `org-export-number-to-roman' allows to convert it
3330 ;; to roman numbers.
3331 ;;
3332 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3333 ;; `org-export-last-sibling-p' are three useful predicates when it
3334 ;; comes to fulfill the `:headline-levels' property.
3335 ;;
3336 ;; `org-export-get-tags', `org-export-get-category' and
3337 ;; `org-export-get-node-property' extract useful information from an
3338 ;; headline or a parent headline. They all handle inheritance.
3341 "Return HEADLINE relative level within current parsed tree.
3342 INFO is a plist holding contextual information."
3347 "Non-nil when HEADLINE is considered as low level.
3349 INFO is a plist used as a communication channel.
3351 A low level headlines has a relative level greater than
3352 `:headline-levels' property value.
3354 Return value is the difference between HEADLINE relative level
3355 and the last level being considered as high enough, or nil."
3362 "Return HEADLINE numbering as a list of numbers.
3363 INFO is a plist holding contextual information."
3367 "Return a non-nil value if HEADLINE element should be numbered.
3368 INFO is a plist used as a communication channel."
3374 "Convert integer N into a roman numeral."
3387 res)))
3390 "Return list of tags associated to ELEMENT.
3392 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3393 is a plist used as a communication channel.
3395 Select tags (see `org-export-select-tags') and exclude tags (see
3396 `org-export-exclude-tags') are removed from the list.
3398 When non-nil, optional argument TAGS should be a list of strings.
3399 Any tag belonging to this list will also be removed.
3401 When optional argument INHERITED is non-nil, tags can also be
3402 inherited from parent headlines and FILETAGS keywords."
3408 ;; Build complete list of inherited tags.
3419 ;; Add FILETAGS keywords and return results.
3423 "Return node PROPERTY value for BLOB.
3425 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3426 element or object.
3428 If optional argument INHERITED is non-nil, the value can be
3429 inherited from a parent headline.
3431 Return value is a string or nil."
3443 "Return category for element or object BLOB.
3445 INFO is a plist used as a communication channel.
3447 CATEGORY is automatically inherited from a parent headline, from
3448 #+CATEGORY: keyword or created out of original file name. If all
3452 ;; Almost like `org-export-node-property', but we cannot trust
3453 ;; `plist-member' as every headline has a `:category'
3454 ;; property, would it be nil or equal to "???" (which has the
3455 ;; same meaning).
3474 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3475 INFO is a plist used as a communication channel."
3480 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3481 INFO is a plist used as a communication channel."
3485 ;;;; For Links
3486 ;;
3487 ;; `org-export-solidify-link-text' turns a string into a safer version
3488 ;; for links, replacing most non-standard characters with hyphens.
3489 ;;
3490 ;; `org-export-get-coderef-format' returns an appropriate format
3491 ;; string for coderefs.
3492 ;;
3493 ;; `org-export-inline-image-p' returns a non-nil value when the link
3494 ;; provided should be considered as an inline image.
3495 ;;
3496 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3497 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3498 ;; returns an appropriate unique identifier when found, or nil.
3499 ;;
3500 ;; `org-export-resolve-id-link' returns the first headline with
3501 ;; specified id or custom-id in parse tree, the path to the external
3502 ;; file with the id or nil when neither was found.
3503 ;;
3504 ;; `org-export-resolve-coderef' associates a reference to a line
3505 ;; number in the element it belongs, or returns the reference itself
3506 ;; when the element isn't numbered.
3509 "Take link text S and make a safe target out of it."
3514 "Return format string for code reference link.
3515 PATH is the link path. DESC is its description."
3523 "Non-nil if LINK object points to an inline image.
3525 Optional argument is a set of RULES defining inline images. It
3526 is an alist where associations have the following shape:
3528 \(TYPE . REGEXP)
3530 Applying a rule means apply REGEXP against LINK's path when its
3531 type is TYPE. The function will return a non-nil value if any of
3532 the provided rules is non-nil. The default rule is
3533 `org-export-default-inline-image-rule'.
3535 This only applies to links without a description."
3546 rules)
3547 ;; Return nil if no rule matched.
3548 nil))))
3551 "Resolve a code reference REF.
3553 INFO is a plist used as a communication channel.
3555 Return associated line number in source code, or REF itself,
3556 depending on src-block or example element's switches."
3564 org-coderef-label-format)))
3568 ;; Element containing REF is found. Resolve it to either
3569 ;; a label or a line number, as needed.
3579 "Return LINK destination.
3581 INFO is a plist holding contextual information.
3583 Return value can be an object, an element, or nil:
3585 - If LINK path matches a target object (i.e. <<path>>) or
3588 - If LINK path exactly matches the name affiliated keyword
3589 \(i.e. #+NAME: path) of an element, return that element.
3591 - If LINK path exactly matches any headline name, return that
3592 element. If more than one headline share that name, priority
3593 will be given to the one with the closest common ancestor, if
3594 any, or the first one in the parse tree otherwise.
3596 - Otherwise, return nil.
3602 ;; First try to find a matching "<<path>>" unless user specified
3603 ;; he was looking for an headline (path starts with a *
3604 ;; character).
3608 return target)))
3609 ;; Then try to find an element with a matching "#+NAME: path"
3610 ;; affiliated keyword.
3617 ;; Last case: link either points to an headline or to
3618 ;; nothingness. Try to find the source, with priority given to
3619 ;; headlines with the closest common ancestor. If such candidate
3620 ;; is found, return it, otherwise return nil.
3624 ;; Return first headline whose `:raw-value' property
3625 ;; is NAME in parse tree DATA, or nil.
3628 data 'headline
3632 name)
3633 headline))
3635 ;; Search among headlines sharing an ancestor with link,
3636 ;; from closest to farthest.
3644 ;; No match with a common ancestor: try the full parse-tree.
3650 "Return headline referenced as LINK destination.
3652 INFO is a plist used as a communication channel.
3654 Return value can be the headline element matched in current parse
3658 ;; First check if id is within the current parse tree.
3664 headline))
3666 ;; Otherwise, look for external files.
3670 "Return radio-target object referenced as LINK destination.
3672 INFO is a plist used as a communication channel.
3674 Return value can be a radio-target object or nil. Assume LINK
3684 ;;;; For References
3685 ;;
3686 ;; `org-export-get-ordinal' associates a sequence number to any object
3687 ;; or element.
3690 "Return ordinal number of an element or object.
3692 ELEMENT is the element or object considered. INFO is the plist
3693 used as a communication channel.
3695 Optional argument TYPES, when non-nil, is a list of element or
3696 object types, as symbols, that should also be counted in.
3697 Otherwise, only provided element's type is considered.
3699 Optional argument PREDICATE is a function returning a non-nil
3700 value if the current element or object should be counted in. It
3701 accepts two arguments: the element or object being considered and
3702 the plist used as a communication channel. This allows to count
3703 only a certain type of objects (i.e. inline images).
3705 Return value is a list of numbers if ELEMENT is an headline or an
3706 item. It is nil for keywords. It represents the footnote number
3707 for footnote definitions and footnote references. If ELEMENT is
3708 a target, return the same value as if ELEMENT was the closest
3709 table, item or headline containing the target. In any other
3710 case, return the sequence number of ELEMENT among elements or
3711 objects of the same type."
3712 ;; A target keyword, representing an invisible target, never has
3713 ;; a sequence number.
3715 ;; Ordinal of a target object refer to the ordinal of the closest
3716 ;; table, item, or headline containing the object.
3720 when
3724 table))
3725 return parent)))
3727 ;; Special case 1: An headline returns its number as a list.
3729 ;; Special case 2: An item returns its number as a list.
3733 struct
3740 ;; Increment counter until ELEMENT is found again.
3751 ;;;; For Src-Blocks
3752 ;;
3753 ;; `org-export-get-loc' counts number of code lines accumulated in
3754 ;; src-block or example-block elements with a "+n" switch until
3755 ;; a given element, excluded. Note: "-n" switches reset that count.
3756 ;;
3757 ;; `org-export-unravel-code' extracts source code (along with a code
3758 ;; references alist) from an `element-block' or `src-block' type
3759 ;; element.
3760 ;;
3761 ;; `org-export-format-code' applies a formatting function to each line
3762 ;; of code, providing relative line number and code reference when
3763 ;; appropriate. Since it doesn't access the original element from
3764 ;; which the source code is coming, it expects from the code calling
3765 ;; it to know if lines should be numbered and if code references
3766 ;; should appear.
3767 ;;
3768 ;; Eventually, `org-export-format-code-default' is a higher-level
3769 ;; function (it makes use of the two previous functions) which handles
3770 ;; line numbering and code references inclusion, and returns source
3771 ;; code in a format suitable for plain text or verbatim output.
3774 "Return accumulated lines of code up to ELEMENT.
3776 INFO is the plist used as a communication channel.
3778 ELEMENT is excluded from count."
3785 ;; ELEMENT is reached: Quit the loop.
3787 ;; Only count lines from src-block and example-block elements
3788 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3792 ;; Accumulate locs or reset them.
3796 ;; Return nil to stay in the loop.
3797 nil)))
3799 ;; Return value.
3800 loc))
3803 "Clean source code and extract references out of it.
3805 ELEMENT has either a `src-block' an `example-block' type.
3807 Return a cons cell whose CAR is the source code, cleaned from any
3808 reference and protective comma and CDR is an alist between
3809 relative line number (integer) and name of code reference on that
3810 line (string)."
3812 ;; Get code and clean it. Remove blank lines at its
3813 ;; beginning and end.
3819 ;; If appropriate, remove global indentation.
3822 c
3824 ;; Get format used for references.
3827 org-coderef-label-format)))
3828 ;; Build a regexp matching a loc with a reference.
3833 ;; Return value.
3835 ;; Code with references removed.
3841 ;; Ref line: remove ref, and signal its position in REFS.
3845 ;; Reference alist.
3846 refs)))
3849 "Format CODE by applying FUN line-wise and return it.
3851 CODE is a string representing the code to format. FUN is
3852 a function. It must accept three arguments: a line of
3853 code (string), the current line number (integer) or nil and the
3854 reference associated to the current line (string) or nil.
3856 Optional argument NUM-LINES can be an integer representing the
3857 number of code lines accumulated until the current code. Line
3858 numbers passed to FUN will take it into account. If it is nil,
3859 FUN's second argument will always be nil. This number can be
3860 obtained with `org-export-get-loc' function.
3862 Optional argument REF-ALIST can be an alist between relative line
3863 number (i.e. ignoring NUM-LINES) and the name of the code
3864 reference on it. If it is nil, FUN's third argument will always
3865 be nil. It can be obtained through the use of
3866 `org-export-unravel-code' function."
3878 "Return source code from ELEMENT, formatted in a standard way.
3880 ELEMENT is either a `src-block' or `example-block' element. INFO
3881 is a plist used as a communication channel.
3883 This function takes care of line numbering and code references
3884 inclusion. Line numbers, when applicable, appear at the
3885 beginning of the line, separated from the code by two white
3886 spaces. Code references, on the other hand, appear flushed to
3887 the right, separated by six white spaces from the widest line of
3888 code."
3889 ;; Extract code and references.
3895 ;; Handle line numbering.
3904 ;; Prepare references display, if required. Any reference
3905 ;; should start six columns after the widest line of code,
3906 ;; wrapped with parenthesis.
3911 code
3915 number-str
3916 loc
3922 num-start refs)))
3925 ;;;; For Tables
3926 ;;
3927 ;; `org-export-table-has-special-column-p' and and
3928 ;; `org-export-table-row-is-special-p' are predicates used to look for
3929 ;; meta-information about the table structure.
3930 ;;
3931 ;; `org-table-has-header-p' tells when the rows before the first rule
3932 ;; should be considered as table's header.
3933 ;;
3934 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3935 ;; and `org-export-table-cell-borders' extract information from
3936 ;; a table-cell element.
3937 ;;
3938 ;; `org-export-table-dimensions' gives the number on rows and columns
3939 ;; in the table, ignoring horizontal rules and special columns.
3940 ;; `org-export-table-cell-address', given a table-cell object, returns
3941 ;; the absolute address of a cell. On the other hand,
3942 ;; `org-export-get-table-cell-at' does the contrary.
3943 ;;
3944 ;; `org-export-table-cell-starts-colgroup-p',
3945 ;; `org-export-table-cell-ends-colgroup-p',
3946 ;; `org-export-table-row-starts-rowgroup-p',
3947 ;; `org-export-table-row-ends-rowgroup-p',
3948 ;; `org-export-table-row-starts-header-p' and
3949 ;; `org-export-table-row-ends-header-p' indicate position of current
3950 ;; row or cell within the table.
3953 "Non-nil when TABLE has a special column.
3954 All special columns will be ignored during export."
3955 ;; The table has a special column when every first cell of every row
3956 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3957 ;; "*" "_" and "^". Though, do not consider a first row containing
3958 ;; only empty cells as special.
3974 "Non-nil when TABLE has an header.
3976 INFO is a plist used as a communication channel.
3978 A table has an header when it contains at least two row groups."
3981 table 'table-row
3989 info)))
3992 "Non-nil if TABLE-ROW is considered special.
3994 INFO is a plist used as the communication channel.
3996 All special rows will be ignored during export."
4000 ;; A row is special either when...
4002 ;; ... it starts with a field only containing "/",
4004 ;; ... the table contains a special column and the row start
4005 ;; with a marking character among, "^", "_", "$" or "!",
4009 ;; ... it contains only alignment cookies and empty cells.
4015 ;; Since VALUE is a secondary string, the following
4016 ;; checks avoid expanding it with `org-export-data'.
4028 "Return TABLE-ROW's group.
4030 INFO is a plist used as the communication channel.
4032 Return value is the group number, as an integer, or nil special
4033 rows and table rules. Group 1 is also table's header."
4050 "Return TABLE-CELL contents width.
4052 INFO is a plist used as the communication channel.
4054 Return value is the width given by the last width cookie in the
4055 same column as TABLE-CELL, or nil."
4060 cookie-width)
4064 ;; In a special row, try to find a width cookie at COLUMN.
4068 ;; The following checks avoid expanding unnecessarily the
4069 ;; cell with `org-export-data'
4077 ;; Ignore table rules.
4080 ;; Return value.
4081 cookie-width))
4084 "Return TABLE-CELL contents alignment.
4086 INFO is a plist used as the communication channel.
4088 Return alignment as specified by the last alignment cookie in the
4089 same column as TABLE-CELL. If no such cookie is found, a default
4090 alignment value will be deduced from fraction of numbers in the
4091 column (see `org-table-number-fraction' for more information).
4092 Possible values are `left', `right' and `center'."
4099 cookie-align)
4103 ;; In a special row, try to find an alignment cookie at
4104 ;; COLUMN.
4108 ;; Since VALUE is a secondary string, the following checks
4109 ;; avoid useless expansion through `org-export-data'.
4117 ;; Ignore table rules.
4119 ;; In a standard row, check if cell's contents are expressing
4120 ;; some kind of number. Increase NUMBER-CELLS accordingly.
4121 ;; Though, don't bother if an alignment cookie has already
4122 ;; defined cell's alignment.
4127 info)))
4132 ;; Return value. Alignment specified by cookies has precedence
4133 ;; over alignment deduced from cells contents.
4142 "Return TABLE-CELL borders.
4144 INFO is a plist used as a communication channel.
4146 Return value is a list of symbols, or nil. Possible values are:
4147 `top', `bottom', `above', `below', `left' and `right'. Note:
4148 `top' (resp. `bottom') only happen for a cell in the first
4149 row (resp. last row) of the table, ignoring table rules, if any.
4151 Returned borders ignore special rows."
4154 borders)
4155 ;; Top/above border? TABLE-CELL has a border above when a rule
4156 ;; used to demarcate row groups can be found above. Hence,
4157 ;; finding a rule isn't sufficient to push `above' in BORDERS:
4158 ;; another regular row has to be found above that rule.
4167 ;; Look at every row before the current one.
4169 ;; No rule above, or rule found starts the table (ignoring any
4170 ;; special row): TABLE-CELL is at the top of the table.
4173 ;; Bottom/below border? TABLE-CELL has a border below when next
4174 ;; non-regular row below is a rule.
4183 ;; Look at every row after the current one.
4185 ;; No rule below, or rule found ends the table (modulo some
4186 ;; special row): TABLE-CELL is at the bottom of the table.
4189 ;; Right/left borders? They can only be specified by column
4190 ;; groups. Column groups are defined in a row starting with "/".
4191 ;; Also a column groups row only contains "<", "<>", ">" or blank
4192 ;; cells.
4209 ;; There's a left border when previous cell, if
4210 ;; any, ends a group, or current one starts one.
4216 ;; There's a right border when next cell, if any,
4217 ;; starts a group, or current one ends one.
4224 ;; Table rows are read in reverse order so last column groups
4225 ;; row has precedence over any previous one.
4227 ;; Return value.
4228 borders))
4231 "Non-nil when TABLE-CELL is at the beginning of a row group.
4232 INFO is a plist used as a communication channel."
4233 ;; A cell starts a column group either when it is at the beginning
4234 ;; of a row (or after the special column, if any) or when it has
4235 ;; a left border.
4239 table-cell)
4243 "Non-nil when TABLE-CELL is at the end of a row group.
4244 INFO is a plist used as a communication channel."
4245 ;; A cell ends a column group either when it is at the end of a row
4246 ;; or when it has a right border.
4249 table-cell)
4253 "Non-nil when TABLE-ROW is at the beginning of a column group.
4254 INFO is a plist used as a communication channel."
4262 "Non-nil when TABLE-ROW is at the end of a column group.
4263 INFO is a plist used as a communication channel."
4271 "Non-nil when TABLE-ROW is the first table header's row.
4272 INFO is a plist used as a communication channel."
4279 "Non-nil when TABLE-ROW is the last table header's row.
4280 INFO is a plist used as a communication channel."
4287 "Return TABLE dimensions.
4289 INFO is a plist used as a communication channel.
4291 Return value is a CONS like (ROWS . COLUMNS) where
4292 ROWS (resp. COLUMNS) is the number of exportable
4293 rows (resp. columns)."
4295 ;; Set number of rows, and extract first one.
4297 table 'table-row
4302 ;; Set number of columns.
4304 ;; Return value.
4308 "Return address of a regular TABLE-CELL object.
4310 TABLE-CELL is the cell considered. INFO is a plist used as
4311 a communication channel.
4313 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4314 zero-based index. Only exportable cells are considered. The
4315 function returns nil for other cells."
4318 ;; Ignore cells in special rows or in special column.
4323 ;; Row number.
4326 table 'table-row
4332 ;; Column number.
4335 table-row 'table-cell
4341 "Return regular table-cell object at ADDRESS in TABLE.
4343 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4344 zero-based index. TABLE is a table type element. INFO is
4345 a plist used as a communication channel.
4347 If no table-cell, among exportable cells, is found at ADDRESS,
4348 return nil."
4351 ;; Row at (car address) or nil.
4354 table 'table-row
4360 'table-cell
4367 ;;;; For Tables Of Contents
4368 ;;
4369 ;; `org-export-collect-headlines' builds a list of all exportable
4370 ;; headline elements, maybe limited to a certain depth. One can then
4371 ;; easily parse it and transcode it.
4372 ;;
4373 ;; Building lists of tables, figures or listings is quite similar.
4374 ;; Once the generic function `org-export-collect-elements' is defined,
4375 ;; `org-export-collect-tables', `org-export-collect-figures' and
4376 ;; `org-export-collect-listings' can be derived from it.
4379 "Collect headlines in order to build a table of contents.
4381 INFO is a plist used as a communication channel.
4383 When optional argument N is an integer, it specifies the depth of
4384 the table of contents. Otherwise, it is set to the value of the
4385 last headline level. See `org-export-headline-levels' for more
4386 information.
4388 Return a list of all exportable headlines as parsed elements."
4392 'headline
4394 ;; Strip contents from HEADLINE.
4397 info))
4400 "Collect referenceable elements of a determined type.
4402 TYPE can be a symbol or a list of symbols specifying element
4403 types to search. Only elements with a caption are collected.
4405 INFO is a plist used as a communication channel.
4407 When non-nil, optional argument PREDICATE is a function accepting
4408 one argument, an element of type TYPE. It returns a non-nil
4409 value when that element should be collected.
4411 Return a list of all elements found, in order of appearance."
4417 element))
4418 info))
4421 "Build a list of tables.
4422 INFO is a plist used as a communication channel.
4424 Return a list of table elements with a caption."
4428 "Build a list of figures.
4430 INFO is a plist used as a communication channel. PREDICATE is
4431 a function which accepts one argument: a paragraph element and
4432 whose return value is non-nil when that element should be
4433 collected.
4435 A figure is a paragraph type element, with a caption, verifying
4437 a vague concept that may depend on back-end.
4439 Return a list of elements recognized as figures."
4443 "Build a list of src blocks.
4445 INFO is a plist used as a communication channel.
4447 Return a list of src-block elements with a caption."
4451 ;;;; Smart Quotes
4452 ;;
4453 ;; The main function for the smart quotes sub-system is
4454 ;; `org-export-activate-smart-quotes', which replaces every quote in
4455 ;; a given string from the parse tree with its "smart" counterpart.
4456 ;;
4457 ;; Dictionary for smart quotes is stored in
4458 ;; `org-export-smart-quotes-alist'.
4459 ;;
4460 ;; Internally, regexps matching potential smart quotes (checks at
4461 ;; string boundaries are also necessary) are defined in
4462 ;; `org-export-smart-quotes-regexps'.
4499 "Smart quotes translations.
4501 Alist whose CAR is a language string and CDR is an alist with
4502 quote type as key and a plist associating various encodings to
4503 their translation as value.
4505 A quote type can be any symbol among `opening-double-quote',
4506 `closing-double-quote', `opening-single-quote',
4507 `closing-single-quote' and `apostrophe'.
4509 Valid encodings include `:utf-8', `:html', `:latex' and
4510 `:texinfo'.
4516 ;; Possible opening quote at beginning of string.
4518 ;; Possible closing quote at beginning of string.
4520 ;; Possible apostrophe at beginning of string.
4522 ;; Opening single and double quotes.
4524 ;; Closing single and double quotes.
4526 ;; Apostrophe.
4528 ;; Possible opening quote at end of string.
4530 ;; Possible closing quote at end of string.
4532 ;; Possible apostrophe at end of string.
4534 "List of regexps matching a quote or an apostrophe.
4540 ENCODING is a symbol among `:html', `:latex', `:texinfo' and
4541 `:utf-8'. INFO is a plist used as a communication channel.
4543 The function has to retrieve information about string
4544 surroundings in parse tree. It can only happen with an
4545 unmodified string. Thus, if S has already been through another
4546 process, a non-nil ORIGINAL optional argument will provide that
4547 original string.
4549 Return the new string."
4556 ;; Return smart quote associated to a give quote Q, as
4557 ;; a string. TYPE is a symbol among `open', `close' and
4558 ;; `apostrophe'.
4568 org-export-smart-quotes-alist))))
4569 encoding)
4570 q)))))
4572 ;; Only a quote: no regexp can match. We have to check both
4573 ;; sides and decide what to do.
4581 ;; 1. Replace quote character at the beginning of S.
4583 ;; Apostrophe?
4589 ;; Closing quote?
4595 ;; Opening quote?
4601 ;; 2. Replace quotes in the middle of the string.
4603 ;; Opening quotes.
4609 ;; Closing quotes.
4615 ;; Apostrophes.
4620 ;; 3. Replace quote character at the end of S.
4622 ;; Apostrophe?
4627 ;; Closing quote?
4633 ;; Opening quote?
4638 ;; Return string with smart quotes.
4639 s))))
4641 ;;;; Topology
4642 ;;
4643 ;; Here are various functions to retrieve information about the
4644 ;; neighbourhood of a given element or object. Neighbours of interest
4645 ;; are direct parent (`org-export-get-parent'), parent headline
4646 ;; (`org-export-get-parent-headline'), first element containing an
4647 ;; object, (`org-export-get-parent-element'), parent table
4648 ;; (`org-export-get-parent-table'), previous element or object
4649 ;; (`org-export-get-previous-element') and next element or object
4650 ;; (`org-export-get-next-element').
4651 ;;
4652 ;; `org-export-get-genealogy' returns the full genealogy of a given
4653 ;; element or object, from closest parent to full parse tree.
4656 "Return BLOB parent or nil.
4657 BLOB is the element or object considered."
4661 "Return full genealogy relative to a given element or object.
4663 BLOB is the element or object being considered.
4665 Ancestors are returned from closest to farthest, the last one
4666 being the full parse tree."
4673 "Return BLOB parent headline or nil.
4674 BLOB is the element or object being considered."
4678 parent))
4681 "Return first element containing OBJECT or nil.
4682 OBJECT is the object to consider."
4686 parent))
4689 "Return OBJECT parent table or nil.
4690 OBJECT is either a `table-cell' or `table-element' type object."
4694 parent))
4697 "Return previous element or object.
4699 BLOB is an element or object. INFO is a plist used as
4700 a communication channel. Return previous exportable element or
4701 object, a string, or nil.
4703 When optional argument N is a positive integer, return a list
4704 containing up to N siblings before BLOB, from closest to
4705 farthest. With any other non-nil value, return a list containing
4706 all of them."
4708 ;; An object can belong to the contents of its parent or
4709 ;; to a secondary string. We check the latter option
4710 ;; first.
4713 org-element-all-elements))
4717 org-element-secondary-value-alist))
4718 parent)))
4721 prev)
4733 "Return next element or object.
4735 BLOB is an element or object. INFO is a plist used as
4736 a communication channel. Return next exportable element or
4737 object, a string, or nil.
4739 When optional argument N is a positive integer, return a list
4740 containing up to N siblings after BLOB, from closest to farthest.
4741 With any other non-nil value, return a list containing all of
4742 them."
4744 ;; An object can belong to the contents of its parent or to
4745 ;; a secondary string. We check the latter option first.
4748 org-element-all-objects))
4752 org-element-secondary-value-alist))
4753 parent)))
4756 next)
4764 siblings)
4768 ;;;; Translation
4769 ;;
4770 ;; `org-export-translate' translates a string according to language
4771 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4772 ;; variable and a specified charset. `org-export-dictionary' contains
4773 ;; the dictionary used for the translation.
4895 "Dictionary for export engine.
4897 Alist whose CAR is the string to translate and CDR is an alist
4898 whose CAR is the language string and CDR is a plist whose
4899 properties are possible charsets and values translated terms.
4901 It is used as a database for `org-export-translate'. Since this
4902 function returns the string as-is if no translation was found,
4903 the variable only needs to record values different from the
4907 "Translate string S according to language specification.
4909 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4910 and `:utf-8'. INFO is a plist used as a communication channel.
4912 Translation depends on `:language' property. Return the
4913 translated string. If no translation is found, try to fall back
4914 to `:default' encoding. If it fails, return S."
4920 s)))
4923 \f
4924 ;;; Asynchronous Export
4925 ;;
4926 ;; `org-export-async-start' is the entry point for asynchronous
4927 ;; export. It recreates current buffer (including visibility,
4928 ;; narrowing and visited file) in an external Emacs process, and
4929 ;; evaluates a command there. It then applies a function on the
4930 ;; returned results in the current process.
4931 ;;
4932 ;; Asynchronously generated results are never displayed directly.
4933 ;; Instead, they are stored in `org-export-stack-contents'. They can
4934 ;; then be retrieved by calling `org-export-stack'.
4935 ;;
4936 ;; Export Stack is viewed through a dedicated major mode
4937 ;;`org-export-stack-mode' and tools: `org-export--stack-refresh',
4938 ;;`org-export--stack-delete', `org-export--stack-view' and
4939 ;;`org-export--stack-clear'.
4940 ;;
4941 ;; For back-ends, `org-export-add-to-stack' add a new source to stack.
4942 ;; It should used whenever `org-export-async-start' is called.
4945 "Call function FUN on the results returned by BODY evaluation.
4947 BODY evaluation happens in an asynchronous process, from a buffer
4948 which is an exact copy of the current one.
4950 Use `org-export-add-to-stack' in FUN in order to register results
4951 in the stack. Examples for, respectively a temporary buffer and
4952 a file are:
4954 \(org-export-async-start
4955 \(lambda (output)
4957 \(erase-buffer)
4958 \(insert output)
4959 \(goto-char (point-min))
4960 \(org-export-add-to-stack (current-buffer) 'backend)))
4961 `(org-export-as 'backend ,subtreep ,visible-only ,body-only ',ext-plist))
4963 and
4965 \(org-export-async-start
4966 \(lambda (f) (org-export-add-to-stack f 'backend))
4967 `(expand-file-name
4968 \(org-export-to-file
4969 'backend ,outfile ,subtreep ,visible-only ,body-only ',ext-plist)))"
4972 ;; Write the full sexp evaluating BODY in a copy of the current
4973 ;; buffer to a temporary file, as it may be too long for program
4974 ;; args in `start-process'.
4981 "%S"
4984 ;; Initialize `org-mode' in the external process.
4986 ;; Re-create current buffer there.
4989 ;; Sexp to evaluate in the buffer.
4991 ;; Start external process.
4994 (,process
4999 "-l" org-export-async-init-file
5001 ;; Register running process in stack.
5003 ;; Set-up sentinel in order to catch results.
5005 ,process
5029 "Add a new result to export stack if not present already.
5031 SOURCE is a buffer or a file name containing export results.
5032 BACKEND is a symbol representing export back-end used to generate
5033 it.
5035 Entries already pointing to SOURCE and unavailable entries are
5036 removed beforehand. Return the new stack."
5042 "Menu for asynchronous export results and running processes."
5052 "Return source from export results at point in stack."
5059 source
5060 ;; SOURCE is not consistent with current line. The stack
5061 ;; view is outdated.
5065 "Remove all entries from export stack."
5070 "Refresh the asynchronous export stack.
5071 DUMMY is ignored. Unavailable sources are removed from the list.
5072 Return the new stack."
5082 ;; Back-end.
5084 ;; Age.
5087 ;; Compute age of the results.
5089 "%4h:%.2m "
5091 ;; Source.
5096 ;; Clear stack from exited processes, dead buffers or
5097 ;; non-existent files.
5109 "Remove export results at point from stack.
5110 If optional argument SOURCE is non-nil, remove it instead."
5115 org-export-stack-contents))))
5118 "View export results at point in stack.
5119 With an optional prefix argument IN-EMACS, force viewing files
5120 within Emacs."
5134 (define-key km "p" 'previous-line)
5135 (define-key km "\C-p" 'previous-line)
5136 (define-key km "\C-?" 'previous-line)
5137 (define-key km [up] 'previous-line)
5138 (define-key km "C" 'org-export--stack-clear)
5139 (define-key km "v" 'org-export--stack-view)
5140 (define-key km (kbd "RET") 'org-export--stack-view)
5141 (define-key km "d" 'org-export--stack-remove)
5142 km)
5143 "Keymap for Org Export Stack.")
5145 (define-derived-mode org-export-stack-mode special-mode "Org-Stack"
5146 "Mode for displaying asynchronous export stack.
5149 stack.
5151 In an Org Export Stack buffer, use \\<org-export-stack-mode-map>\\[org-export--stack-view] to view export output
5152 on current line, \\[org-export--stack-remove] to remove it from the stack and \\[org-export--stack-clear] to clear
5153 stack completely.
5155 Removal entries in an Org Export Stack buffer doesn't affect
5156 files or buffers, only view in the stack.
5159 (abbrev-mode 0)
5160 (auto-fill-mode 0)
5161 (setq buffer-read-only t
5162 buffer-undo-list t
5163 truncate-lines t
5164 header-line-format
5165 '(:eval
5166 (format " %-12s | %6s | %s" "Back-End" "Age" "Source")))
5167 (add-hook 'post-command-hook 'org-export--stack-refresh nil t)
5168 (set (make-local-variable 'revert-buffer-function)
5169 'org-export--stack-refresh))
5172 \f
5173 ;;; The Dispatcher
5174 ;;
5175 ;; `org-export-dispatch' is the standard interactive way to start an
5176 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
5177 ;; for its interface, which, in turn, delegates response to key
5178 ;; pressed to `org-export-dispatch-action'.
5180 ;;;###autoload
5181 (defun org-export-dispatch (&optional arg)
5182 "Export dispatcher for Org mode.
5184 It provides an access to common export related tasks in a buffer.
5185 Its interface comes in two flavours: standard and expert. While
5186 both share the same set of bindings, only the former displays the
5187 valid keys associations. Set `org-export-dispatch-use-expert-ui'
5188 to switch to one or the other.
5190 When called with C-u prefix ARG, repeat the last export action,
5191 with the same set of options used back then, on the current
5192 buffer.
5194 When called with a double universal argument, display the
5195 asynchronous export stack directly."
5196 (interactive "P")
5197 (let* ((input
5198 (cond ((equal arg '(16)) '(stack))
5199 ((and arg org-export-dispatch-last-action))
5200 (t (save-window-excursion
5201 (unwind-protect
5202 ;; Store this export command.
5203 (setq org-export-dispatch-last-action
5204 (org-export-dispatch-ui
5205 (list org-export-initial-scope
5206 (and org-export-in-background 'async))
5207 nil
5208 org-export-dispatch-use-expert-ui))
5209 (and (get-buffer "*Org Export Dispatcher*")
5210 (kill-buffer "*Org Export Dispatcher*")))))))
5211 (action (car input))
5212 (optns (cdr input)))
5213 (case action
5214 ;; First handle special hard-coded actions.
5215 (stack (org-export-stack))
5216 (publish-current-file
5217 (org-e-publish-current-file (memq 'force optns) (memq 'async optns)))
5218 (publish-current-project
5219 (org-e-publish-current-project (memq 'force optns) (memq 'async optns)))
5220 (publish-choose-project
5221 (org-e-publish (assoc (org-icompleting-read
5222 "Publish project: "
5223 org-e-publish-project-alist nil t)
5224 org-e-publish-project-alist)
5225 (memq 'force optns)
5226 (memq 'async optns)))
5227 (publish-all (org-e-publish-all (memq 'force optns) (memq 'async optns)))
5228 (otherwise (funcall action
5229 ;; Return a symbol instead of a list to ease
5230 ;; asynchronous export macro use.
5231 (and (memq 'async optns) t)
5232 (and (memq 'subtree optns) t)
5233 (and (memq 'visible optns) t)
5234 (and (memq 'body optns) t))))))
5236 (defun org-export-dispatch-ui (options first-key expertp)
5237 "Handle interface for `org-export-dispatch'.
5239 OPTIONS is a list containing current interactive options set for
5240 export. It can contain any of the following symbols:
5241 `body' toggles a body-only export
5242 `subtree' restricts export to current subtree
5243 `visible' restricts export to visible part of buffer.
5244 `force' force publishing files.
5245 `async' use asynchronous export process
5247 FIRST-KEY is the key pressed to select the first level menu. It
5248 is nil when this menu hasn't been selected yet.
5250 EXPERTP, when non-nil, triggers expert UI. In that case, no help
5251 buffer is provided, but indications about currently active
5252 options are given in the prompt. Moreover, \[?] allows to switch
5253 back to standard interface."
5254 (let* ((fontify-key
5255 (lambda (key &optional access-key)
5256 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
5257 ;; non-nil is the required first-level key to activate
5258 ;; KEY. When its value is t, activate KEY independently
5259 ;; on the first key, if any. A nil value means KEY will
5260 ;; only be activated at first level.
5261 (if (or (eq access-key t) (eq access-key first-key))
5262 (org-propertize key 'face 'org-warning)
5263 key)))
5264 (fontify-value
5265 (lambda (value)
5266 ;; Fontify VALUE string.
5267 (org-propertize value 'face 'font-lock-variable-name-face)))
5268 ;; Prepare menu entries by extracting them from
5269 ;; `org-export-registered-backends', and sorting them by
5270 ;; access key and by ordinal, if any.
5271 (backends (sort
5272 (sort
5273 (delq nil
5274 (mapcar (lambda (b)
5275 (org-export-backend-menu (car b)))
5276 org-export-registered-backends))
5277 (lambda (a b)
5278 (let ((key-a (nth 1 a))
5279 (key-b (nth 1 b)))
5280 (cond ((and (numberp key-a) (numberp key-b))
5281 (< key-a key-b))
5282 ((numberp key-b) t)))))
5283 (lambda (a b) (< (car a) (car b)))))
5284 ;; Compute a list of allowed keys based on the first key
5285 ;; pressed, if any. Some keys (?^B, ?^V, ?^S, ?^F, ?^A
5286 ;; and ?q) are always available.
5287 (allowed-keys
5288 (nconc (list ?\x02 ?\x16 ?\x13 ?\x06 ?\x01)
5289 (if (not first-key) (org-uniquify (mapcar 'car backends))
5290 (let (sub-menu)
5291 (dolist (backend backends (sort (mapcar 'car sub-menu) '<))
5292 (when (eq (car backend) first-key)
5293 (setq sub-menu (append (nth 2 backend) sub-menu))))))
5294 (cond ((eq first-key ?P) (list ?f ?p ?x ?a))
5295 ((not first-key) (list ?P)))
5296 (list ?&)
5297 (when expertp (list ??))
5298 (list ?q)))
5299 ;; Build the help menu for standard UI.
5300 (help
5301 (unless expertp
5302 (concat
5303 ;; Options are hard-coded.
5304 (format "Options
5305 [%s] Body only: %s [%s] Visible only: %s
5306 [%s] Export scope: %s [%s] Force publishing: %s
5308 (funcall fontify-key "C-b" t)
5309 (funcall fontify-value
5310 (if (memq 'body options) "On " "Off"))
5311 (funcall fontify-key "C-v" t)
5312 (funcall fontify-value
5313 (if (memq 'visible options) "On " "Off"))
5314 (funcall fontify-key "C-s" t)
5315 (funcall fontify-value
5316 (if (memq 'subtree options) "Subtree" "Buffer "))
5317 (funcall fontify-key "C-f" t)
5318 (funcall fontify-value
5319 (if (memq 'force options) "On " "Off"))
5320 (funcall fontify-key "C-a" t)
5321 (funcall fontify-value
5322 (if (memq 'async options) "On " "Off")))
5323 ;; Display registered back-end entries. When a key
5324 ;; appears for the second time, do not create another
5325 ;; entry, but append its sub-menu to existing menu.
5326 (let (last-key)
5327 (mapconcat
5328 (lambda (entry)
5329 (let ((top-key (car entry)))
5330 (concat
5331 (unless (eq top-key last-key)
5332 (setq last-key top-key)
5334 (funcall fontify-key (char-to-string top-key))
5335 (nth 1 entry)))
5336 (let ((sub-menu (nth 2 entry)))
5337 (unless (functionp sub-menu)
5338 ;; Split sub-menu into two columns.
5339 (let ((index -1))
5340 (concat
5341 (mapconcat
5342 (lambda (sub-entry)
5343 (incf index)
5344 (format
5345 (if (zerop (mod index 2)) " [%s] %-24s"
5347 (funcall fontify-key
5348 (char-to-string (car sub-entry))
5349 top-key)
5350 (nth 1 sub-entry)))
5351 sub-menu "")
5353 backends ""))
5354 ;; Publishing menu is hard-coded.
5356 [%s] Current file [%s] Current project
5358 (funcall fontify-key "P")
5359 (funcall fontify-key "f" ?P)
5360 (funcall fontify-key "p" ?P)
5361 (funcall fontify-key "x" ?P)
5362 (funcall fontify-key "a" ?P))
5364 (format "\[%s] %s"
5365 (funcall fontify-key "q" t)
5366 (if first-key "Main menu" "Exit")))))
5367 ;; Build prompts for both standard and expert UI.
5368 (standard-prompt (unless expertp "Export command: "))
5369 (expert-prompt
5370 (when expertp
5371 (format
5372 "Export command (Options: %s%s%s%s%s) [%s]: "
5373 (if (memq 'body options) (funcall fontify-key "b" t) "b")
5374 (if (memq 'visible options) (funcall fontify-key "v" t) "v")
5375 (if (memq 'subtree options) (funcall fontify-key "s" t) "s")
5376 (if (memq 'force options) (funcall fontify-key "f" t) "f")
5377 (if (memq 'async options) (funcall fontify-key "a" t) "a")
5378 (mapconcat (lambda (k)
5379 ;; Strip control characters.
5380 (unless (< k 27) (char-to-string k)))
5381 allowed-keys "")))))
5382 ;; With expert UI, just read key with a fancy prompt. In standard
5383 ;; UI, display an intrusive help buffer.
5384 (if expertp
5385 (org-export-dispatch-action
5386 expert-prompt allowed-keys backends options first-key expertp)
5387 ;; At first call, create frame layout in order to display menu.
5388 (unless (get-buffer "*Org Export Dispatcher*")
5389 (delete-other-windows)
5390 (org-switch-to-buffer-other-window
5391 (get-buffer-create "*Org Export Dispatcher*"))
5392 (setq cursor-type nil))
5393 ;; At this point, the buffer containing the menu exists and is
5394 ;; visible in the current window. So, refresh it.
5395 (with-current-buffer "*Org Export Dispatcher*"
5396 (erase-buffer)
5397 (insert help))
5398 (org-fit-window-to-buffer)
5399 (org-export-dispatch-action
5400 standard-prompt allowed-keys backends options first-key expertp))))
5402 (defun org-export-dispatch-action
5403 (prompt allowed-keys backends options first-key expertp)
5404 "Read a character from command input and act accordingly.
5406 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
5407 a list of characters available at a given step in the process.
5408 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
5409 EXPERTP are the same as defined in `org-export-dispatch-ui',
5410 which see.
5412 Toggle export options when required. Otherwise, return value is
5413 a list with action as CAR and a list of interactive export
5414 options as CDR."
5415 (let ((key (read-char-exclusive prompt)))
5416 (cond
5417 ;; Ignore undefined associations.
5418 ((not (memq key allowed-keys))
5419 (ding)
5420 (unless expertp (message "Invalid key") (sit-for 1))
5421 (org-export-dispatch-ui options first-key expertp))
5422 ;; q key at first level aborts export. At second
5423 ;; level, cancel first key instead.
5424 ((eq key ?q) (if (not first-key) (error "Export aborted")
5425 (org-export-dispatch-ui options nil expertp)))
5426 ;; Help key: Switch back to standard interface if
5427 ;; expert UI was active.
5428 ((eq key ??) (org-export-dispatch-ui options first-key nil))
5429 ;; Switch to asynchronous export stack.
5430 ((eq key ?&) '(stack))
5431 ;; Toggle export options.
5432 ((memq key '(?\x02 ?\x16 ?\x13 ?\x06 ?\x01))
5433 (org-export-dispatch-ui
5434 (let ((option (case key (?\x02 'body) (?\x16 'visible) (?\x13 'subtree)
5435 (?\x06 'force) (?\x01 'async))))
5436 (if (memq option options) (remq option options)
5437 (cons option options)))
5438 first-key expertp))
5439 ;; Action selected: Send key and options back to
5440 ;; `org-export-dispatch'.
5441 ((or first-key (functionp (nth 2 (assq key backends))))
5442 (cons (cond
5443 ((not first-key) (nth 2 (assq key backends)))
5444 ;; Publishing actions are hard-coded. Send a special
5445 ;; signal to `org-export-dispatch'.
5446 ((eq first-key ?P)
5447 (case key
5448 (?f 'publish-current-file)
5449 (?p 'publish-current-project)
5450 (?x 'publish-choose-project)
5451 (?a 'publish-all)))
5452 ;; Return first action associated to FIRST-KEY + KEY
5453 ;; path. Indeed, derived backends can share the same
5454 ;; FIRST-KEY.
5455 (t (catch 'found
5456 (mapc (lambda (backend)
5457 (let ((match (assq key (nth 2 backend))))
5458 (when match (throw 'found (nth 2 match)))))
5459 (member (assq first-key backends) backends)))))
5460 options))
5461 ;; Otherwise, enter sub-menu.
5462 (t (org-export-dispatch-ui options key expertp)))))
5465 (provide 'org-export)
5466 ;;; org-export.el ends here