| blob | dc601d44d67ea28a2fb378fb53e33b53b2e5b90e |
1 ;;; org-export.el --- Generic Export Engine For Org
3 ;; Copyright (C) 2012 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 sets one mandatory variable: his translation table. Its name
52 ;; is always `org-BACKEND-translate-alist' where BACKEND stands for
53 ;; the name chosen for the back-end. Its value is an alist whose keys
54 ;; are elements and objects types and values translator functions.
55 ;; See function's docstring for more information about translators.
56 ;;
57 ;; Optionally, `org-export-define-backend' can also support specific
58 ;; buffer keywords, OPTION keyword's items and filters. Also refer to
59 ;; function documentation for more information.
60 ;;
61 ;; If the new back-end shares most properties with another one,
62 ;; `org-export-define-derived-backend' can be used to simplify the
63 ;; process.
64 ;;
65 ;; Any back-end can define its own variables. Among them, those
66 ;; customizable should belong to the `org-export-BACKEND' group.
67 ;;
68 ;; Tools for common tasks across back-ends are implemented in the
69 ;; penultimate part of this file. A dispatcher for standard back-ends
70 ;; is provided in the last one.
72 ;;; Code:
89 \f
90 ;;; Internal Variables
91 ;;
92 ;; Among internal variables, the most important is
93 ;; `org-export-options-alist'. This variable define the global export
94 ;; options, shared between every exporter, and how they are acquired.
137 "Alist between export properties and ways to set them.
139 The CAR of the alist is the property name, and the CDR is a list
140 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
142 KEYWORD is a string representing a buffer keyword, or nil. Each
143 property defined this way can also be set, during subtree
144 export, through an headline property named after the keyword
146 property).
147 OPTION is a string that could be found in an #+OPTIONS: line.
148 DEFAULT is the default value for the property.
149 BEHAVIOUR determine how Org should handle multiple keywords for
150 the same property. It is a symbol among:
151 nil Keep old value and discard the new one.
152 t Replace old value with the new one.
153 `space' Concatenate the values, separating them with a space.
154 `newline' Concatenate the values, separating them with
155 a newline.
156 `split' Split values at white spaces, and cons them to the
157 previous list.
159 KEYWORD and OPTION have precedence over DEFAULT.
161 All these properties should be back-end agnostic. Back-end
162 specific properties are set through `org-export-define-backend'.
166 "List of in-buffer keywords that require special treatment.
167 These keywords are not directly associated to a property. The
168 way they are handled must be hard-coded into
228 "Alist between filters properties and initial values.
230 The key of each association is a property name accessible through
231 the communication channel. Its value is a configurable global
232 variable defining initial filters.
234 This list is meant to install user specified filters. Back-end
235 developers may install their own filters using
236 `org-export-define-backend'. Filters defined there will always
237 be prepended to the current list, so they always get applied
246 "Default rule for link matching an inline image.
247 This rule applies to links with no description. By default, it
248 will be considered as an inline image if it targets a local file
251 See `org-export-inline-image-p' for more information about
255 \f
256 ;;; User-configurable Variables
257 ;;
258 ;; Configuration for the masses.
259 ;;
260 ;; They should never be accessed directly, as their value is to be
261 ;; stored in a property list (cf. `org-export-options-alist').
262 ;; Back-ends will read their value from there instead.
265 "Options for exporting Org mode files."
270 "General options for export engine."
275 "Whether sub-trees with the ARCHIVE tag should be exported.
277 This can have three different values:
278 nil Do not export, pretend this tree is not present.
279 t Do export the entire tree.
280 `headline' Only export the headline, but skip the tree below it.
282 This option can also be set with the #+OPTIONS line,
291 "Non-nil means insert author name into the exported file.
292 This option can also be set with the #+OPTIONS line,
298 "Non-nil means export CLOCK keywords.
299 This option can also be set with the #+OPTIONS line,
305 "Non-nil means the postamble should contain a creator sentence.
307 The sentence can be set in `org-export-creator-string' and
310 If the value is `comment' insert it as a comment."
320 emacs-version)
321 "String to insert at the end of the generated document."
326 "Non-nil means export contents of standard drawers.
328 When t, all drawers are exported. This may also be a list of
329 drawer names to export. This variable doesn't apply to
330 properties drawers.
332 This option can also be set with the #+OPTIONS line,
342 "Non-nil means insert author email into the exported file.
343 This option can also be set with the #+OPTIONS line,
349 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
351 If the export target supports emphasizing text, the word will be
352 typeset in bold, italic, or underlined, respectively. Not all
353 export backends support this.
360 "Tags that exclude a tree from export.
362 All trees carrying any of these tags will be excluded from
363 export. This is without condition, so even subtrees inside that
364 carry one of the `org-export-select-tags' will be removed.
366 This option can also be set with the #+EXCLUDE_TAGS: keyword."
373 This can be used to have pre-formatted text, fragments of code
374 etc. For example:
375 : ;; Some Lisp examples
376 : (while (defc cnt)
377 : (ding))
378 will be looking just like this in also HTML. See also the QUOTE
379 keyword. Not all export backends support this.
386 "Non-nil means Org footnotes should be exported.
387 This option can also be set with the #+OPTIONS line,
393 "The last level which is still exported as a headline.
395 Inferior levels will produce itemize lists when exported.
402 "The default language for export and clocktable translations, as a string.
403 This may have an association in
404 `org-clock-clocktable-language-setup'."
409 "Non-nil means preserve all line breaks when exporting.
411 Normally, in HTML output paragraphs will be reformatted.
413 This option can also be set with the #+OPTIONS line,
419 "Non-nil means interpret entities when exporting.
422 Å.
424 For a list of supported names, see the constant `org-entities'
425 and the user option `org-entities-user'.
427 This option can also be set with the #+OPTIONS line,
433 "Non-nil means inlinetasks should be exported.
434 This option can also be set with the #+OPTIONS line,
440 "Non-nil means include planning info in export.
441 This option can also be set with the #+OPTIONS: line,
447 "Non-nil means include priority cookies in export.
448 This option can also be set with the #+OPTIONS line,
454 "Non-nil means add section numbers to headlines when exporting.
456 When set to an integer n, numbering will only happen for
457 headlines whose relative level is higher or equal to n.
459 This option can also be set with the #+OPTIONS line,
465 "Tags that select a tree for export.
467 If any such tag is found in a buffer, all trees that do not carry
468 one of these tags will be ignored during export. Inside trees
469 that are selected like this, you can still deselect a subtree by
470 tagging it with one of the `org-export-exclude-tags'.
472 This option can also be set with the #+SELECT_TAGS: keyword."
477 "Non-nil means activate smart quotes during export.
478 This option can also be set with the #+OPTIONS: line,
486 When this option is turned on, these strings will be exported as:
488 Org HTML LaTeX UTF-8
489 -----+----------+--------+-------
491 -- – -- –
492 --- — --- —
495 This option can also be set with the #+OPTIONS line,
501 "Non-nil means include statistics cookies in export.
502 This option can also be set with the #+OPTIONS: line,
510 When this option is turned on, you can use TeX-like syntax for
512 will be considered as a single item - so grouping with {} is
513 normally not needed. For example, the following things will be
514 parsed as single sub- or superscripts.
516 10^24 or 10^tau several digits will be considered 1 item.
517 10^-12 or 10^-tau a leading sign with digits or a word
518 x^2-y^3 will be read as x^2 - y^3, because items are
519 terminated by almost any nonword/nondigit char.
520 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
522 Still, ambiguity is possible - so when in doubt use {} to enclose
523 the sub/superscript. If you set this variable to the symbol
524 `{}', the braces are *required* in order to trigger
525 interpretations as sub/superscript. This can be helpful in
528 This option can also be set with the #+OPTIONS line,
537 "Non-nil means create a table of contents in exported files.
539 The TOC contains headlines with levels up
540 to`org-export-headline-levels'. When an integer, include levels
541 up to N in the toc, this may then be different from
542 `org-export-headline-levels', but it will not be allowed to be
543 larger than the number of headline levels. When nil, no table of
544 contents is made.
546 This option can also be set with the #+OPTIONS line,
556 For example:
558 | Name | Address | Birthday |
559 |-------------+----------+-----------|
560 | Arthur Dent | England | 29.2.2100 |
567 "If nil, do not export tags, just remove them from headlines.
569 If this is the symbol `not-in-toc', tags will be removed from
570 table of contents entries, but still be shown in the headlines of
571 the document.
573 This option can also be set with the #+OPTIONS line,
582 "Non-nil means include TODO items for export.
583 This may have the following values:
584 t include tasks independent of state.
585 todo include only tasks that are not yet done.
586 done include only tasks that are already done.
587 nil remove all tasks before export
588 list of keywords keep only tasks with these keywords"
599 "Non-nil means insert a time stamp into the exported file.
600 The time stamp shows when the file was created.
602 This option can also be set with the #+OPTIONS line,
608 "Non nil means allow timestamps in export.
610 It can be set to `active', `inactive', t or nil, in order to
611 export, respectively, only active timestamps, only inactive ones,
612 all of them or none.
614 This option can also be set with the #+OPTIONS line, e.g.
624 "Non-nil means include TODO keywords in export.
625 When nil, remove all these keywords from the export."
630 "Non-nil means allow #+BIND to define local variable values for export.
631 This is a potential security risk, which is why the user must
632 confirm the use of these lines."
640 "Alist between export snippets back-ends and exporter back-ends.
642 This variable allows to provide shortcuts for export snippets.
646 HTML code while every other back-end will ignore it."
654 "Coding system for the exported file."
659 "Non-nil means exported stuff will also be pushed onto the kill ring."
664 "The initial scope when exporting with `org-export-dispatch'.
665 This variable can be either set to `buffer' or `subtree'."
672 "Non-nil means show buffer after exporting to temp buffer.
673 When Org exports to a file, the buffer visiting that file is ever
674 shown, but remains buried. However, when exporting to
675 a temporary buffer, that buffer is popped up in a second window.
676 When this variable is nil, the buffer remains buried also in
677 these cases."
682 "Non-nil means using a non-intrusive `org-export-dispatch'.
683 In that case, no help buffer is displayed. Though, an indicator
688 be passed the FORCE argument). Also, \[?] allows to switch back
689 to standard mode."
694 \f
695 ;;; Defining New Back-ends
696 ;;
697 ;; `org-export-define-backend' is the standard way to define an export
698 ;; back-end. It allows to specify translators, filters, buffer
699 ;; options and a menu entry. If the new back-end shares translators
700 ;; with another back-end, `org-export-define-derived-backend' may be
701 ;; used instead.
702 ;;
703 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
704 ;; when a given back-end hasn't been registered yet.
707 "Define a new back-end BACKEND.
709 TRANSLATORS is an alist between object or element types and
710 functions handling them.
712 These functions should return a string without any trailing
713 space, or nil. They must accept three arguments: the object or
714 element itself, its contents or nil when it isn't recursive and
715 the property list used as a communication channel.
717 Contents, when not nil, are stripped from any global indentation
718 \(although the relative one is preserved). They also always end
719 with a single newline character.
721 If, for a given type, no function is found, that element or
722 object type will simply be ignored, along with any blank line or
723 white space at its end. The same will happen if the function
724 returns the nil value. If that function returns the empty
725 string, the type will be ignored, but the blank lines or white
726 spaces will be kept.
728 In addition to element and object types, one function can be
729 associated to the `template' symbol and another one to the
730 `plain-text' symbol.
732 The former returns the final transcoded string, and can be used
733 to add a preamble and a postamble to document's body. It must
734 accept two arguments: the transcoded string and the property list
735 containing export options.
737 The latter, when defined, is to be called on every text not
738 recognized as an element or an object. It must accept two
739 arguments: the text string and the information channel. It is an
740 appropriate place to protect special chars relative to the
741 back-end.
743 BODY can start with pre-defined keyword arguments. The following
744 keywords are understood:
746 :export-block
748 String, or list of strings, representing block names that
749 will not be parsed. This is used to specify blocks that will
750 contain raw code specific to the back-end. These blocks
751 still have to be handled by the relative `export-block' type
752 translator.
754 :filters-alist
756 Alist between filters and function, or list of functions,
757 specific to the back-end. See `org-export-filters-alist' for
758 a list of all allowed filters. Filters defined here
759 shouldn't make a back-end test, as it may prevent back-ends
760 derived from this one to behave properly.
762 :menu-entry
764 Menu entry for the export dispatcher. It should be a list
765 like:
767 \(KEY DESCRIPTION ACTION-OR-MENU)
769 where :
771 KEY is a free character selecting the back-end.
772 DESCRIPTION is a string naming the back-end.
773 ACTION-OR-MENU is either a function or an alist.
775 If it is an action, it will be called with three arguments:
776 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
777 for further explanations.
779 If it is an alist, associations should follow the
780 pattern:
782 \(KEY DESCRIPTION ACTION)
784 where KEY, DESCRIPTION and ACTION are described above.
786 Valid values include:
790 or
797 \(lambda (subtree visible body-only)
798 \(org-open-file
799 \(org-e-latex-export-to-pdf subtree visible body-only))))))
801 :options-alist
803 Alist between back-end specific properties introduced in
804 communication channel and how their value are acquired. See
805 `org-export-options-alist' for more information about
806 structure of the values."
821 ;; Define translators.
824 ;; Define options.
828 See `org-export-options-alist' for more information on the
829 structure of the values."
830 backend)))
831 ;; Define filters.
834 "Alist between filters keywords and back-end specific filters.
836 ;; Tell parser to not parse EXPORT-BLOCK blocks.
843 ;; Add an entry for back-end in `org-export-dispatch'.
847 ;; Splice in the body, if any.
851 "Create a new back-end as a variant of an existing one.
853 CHILD is the name of the derived back-end. PARENT is the name of
854 the parent back-end.
856 BODY can start with pre-defined keyword arguments. The following
857 keywords are understood:
859 :export-block
861 String, or list of strings, representing block names that
862 will not be parsed. This is used to specify blocks that will
863 contain raw code specific to the back-end. These blocks
864 still have to be handled by the relative `export-block' type
865 translator.
867 :filters-alist
869 Alist of filters that will overwrite or complete filters
870 defined in PARENT back-end. See `org-export-filters-alist'
871 for a list of allowed filters.
873 :menu-entry
875 Menu entry for the export dispatcher. See
876 `org-export-define-backend' for more information about the
877 expected value.
879 :options-alist
881 Alist of back-end specific properties that will overwrite or
882 complete those defined in PARENT back-end. Refer to
883 `org-export-options-alist' for more information about
884 structure of the values.
886 :sub-menu-entry
888 Append entries to an existing menu in the export dispatcher.
889 The associated value should be a list whose CAR is the
890 character selecting the menu to expand and CDR a list of
891 entries following the pattern:
893 \(KEY DESCRIPTION ACTION)
895 where KEY is a free character triggering the action,
896 DESCRIPTION is a string defining the action, and ACTION is
897 a function that will be called with three arguments:
898 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
899 for further explanations.
901 Valid values include:
905 \(lambda (s v b)
906 \(org-open-file (org-e-beamer-export-to-pdf s v b)))))
908 :translate-alist
910 Alist of element and object types and transcoders that will
911 overwrite or complete transcode table from PARENT back-end.
912 Refer to `org-export-define-backend' for detailed information
913 about transcoders.
916 as a variant of `e-latex' back-end with a custom template
917 function:
919 \(org-export-define-derived-backend my-latex e-latex
920 :translate-alist ((template . my-latex-template-fun)))
922 The back-end could then be called with, for example:
941 ;; Tell parser to not parse EXPORT-BLOCK blocks.
948 ;; Define filters.
955 "Alist between filters keywords and back-end specific filters.
957 ;; Define options.
965 See `org-export-options-alist' for more information on the
966 structure of the values."
967 child))))
968 ;; Define translators.
975 ;; Add an entry for back-end in `org-export-dispatch'.
981 org-export-dispatch-menu-entries))))
985 ;; Splice in the body, if any.
989 "Signal an error if BACKEND isn't defined."
994 \f
995 ;;; The Communication Channel
996 ;;
997 ;; During export process, every function has access to a number of
998 ;; properties. They are of two types:
999 ;;
1000 ;; 1. Environment options are collected once at the very beginning of
1001 ;; the process, out of the original buffer and configuration.
1002 ;; Collecting them is handled by `org-export-get-environment'
1003 ;; function.
1004 ;;
1005 ;; Most environment options are defined through the
1006 ;; `org-export-options-alist' variable.
1007 ;;
1008 ;; 2. Tree properties are extracted directly from the parsed tree,
1009 ;; just before export, by `org-export-collect-tree-properties'.
1010 ;;
1011 ;; Here is the full list of properties available during transcode
1012 ;; process, with their category and their value type.
1013 ;;
1014 ;; + `:author' :: Author's name.
1015 ;; - category :: option
1016 ;; - type :: string
1017 ;;
1018 ;; + `:back-end' :: Current back-end used for transcoding.
1019 ;; - category :: tree
1020 ;; - type :: symbol
1021 ;;
1022 ;; + `:creator' :: String to write as creation information.
1023 ;; - category :: option
1024 ;; - type :: string
1025 ;;
1026 ;; + `:date' :: String to use as date.
1027 ;; - category :: option
1028 ;; - type :: string
1029 ;;
1030 ;; + `:description' :: Description text for the current data.
1031 ;; - category :: option
1032 ;; - type :: string
1033 ;;
1034 ;; + `:email' :: Author's email.
1035 ;; - category :: option
1036 ;; - type :: string
1037 ;;
1038 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1039 ;; process.
1040 ;; - category :: option
1041 ;; - type :: list of strings
1042 ;;
1043 ;; + `:exported-data' :: Hash table used for memoizing
1044 ;; `org-export-data'.
1045 ;; - category :: tree
1046 ;; - type :: hash table
1047 ;;
1048 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1049 ;; their definition, as parsed data. Only non-inlined footnotes
1050 ;; are represented in this alist. Also, every definition isn't
1051 ;; guaranteed to be referenced in the parse tree. The purpose of
1052 ;; this property is to preserve definitions from oblivion
1053 ;; (i.e. when the parse tree comes from a part of the original
1054 ;; buffer), it isn't meant for direct use in a back-end. To
1055 ;; retrieve a definition relative to a reference, use
1056 ;; `org-export-get-footnote-definition' instead.
1057 ;; - category :: option
1058 ;; - type :: alist (STRING . LIST)
1059 ;;
1060 ;; + `:headline-levels' :: Maximum level being exported as an
1061 ;; headline. Comparison is done with the relative level of
1062 ;; headlines in the parse tree, not necessarily with their
1063 ;; actual level.
1064 ;; - category :: option
1065 ;; - type :: integer
1066 ;;
1067 ;; + `:headline-offset' :: Difference between relative and real level
1068 ;; of headlines in the parse tree. For example, a value of -1
1069 ;; means a level 2 headline should be considered as level
1070 ;; 1 (cf. `org-export-get-relative-level').
1071 ;; - category :: tree
1072 ;; - type :: integer
1073 ;;
1074 ;; + `:headline-numbering' :: Alist between headlines and their
1075 ;; numbering, as a list of numbers
1076 ;; (cf. `org-export-get-headline-number').
1077 ;; - category :: tree
1078 ;; - type :: alist (INTEGER . LIST)
1079 ;;
1080 ;; + `:id-alist' :: Alist between ID strings and destination file's
1081 ;; path, relative to current directory. It is used by
1082 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1083 ;; external file.
1084 ;; - category :: option
1085 ;; - type :: alist (STRING . STRING)
1086 ;;
1087 ;; + `:ignore-list' :: List of elements and objects that should be
1088 ;; ignored during export.
1089 ;; - category :: tree
1090 ;; - type :: list of elements and objects
1091 ;;
1092 ;; + `:input-file' :: Full path to input file, if any.
1093 ;; - category :: option
1094 ;; - type :: string or nil
1095 ;;
1096 ;; + `:keywords' :: List of keywords attached to data.
1097 ;; - category :: option
1098 ;; - type :: string
1099 ;;
1100 ;; + `:language' :: Default language used for translations.
1101 ;; - category :: option
1102 ;; - type :: string
1103 ;;
1104 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1105 ;; transcoding.
1106 ;; - category :: option
1107 ;; - type :: list (as returned by `org-element-parse-buffer')
1108 ;;
1109 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1110 ;; all line breaks.
1111 ;; - category :: option
1112 ;; - type :: symbol (nil, t)
1113 ;;
1114 ;; + `:section-numbers' :: Non-nil means transcoding should add
1115 ;; section numbers to headlines.
1116 ;; - category :: option
1117 ;; - type :: symbol (nil, t)
1118 ;;
1119 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1120 ;; in transcoding. When such a tag is present, subtrees without
1121 ;; it are de facto excluded from the process. See
1122 ;; `use-select-tags'.
1123 ;; - category :: option
1124 ;; - type :: list of strings
1125 ;;
1126 ;; + `:target-list' :: List of targets encountered in the parse tree.
1127 ;; This is used to partly resolve "fuzzy" links
1128 ;; (cf. `org-export-resolve-fuzzy-link').
1129 ;; - category :: tree
1130 ;; - type :: list of strings
1131 ;;
1132 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1133 ;; a time stamp in the output.
1134 ;; - category :: option
1135 ;; - type :: symbol (nil, t)
1136 ;;
1137 ;; + `:translate-alist' :: Alist between element and object types and
1138 ;; transcoding functions relative to the current back-end.
1139 ;; Special keys `template' and `plain-text' are also possible.
1140 ;; - category :: option
1141 ;; - type :: alist (SYMBOL . FUNCTION)
1142 ;;
1143 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1144 ;; also be transcoded. If it is set to the `headline' symbol,
1145 ;; only the archived headline's name is retained.
1146 ;; - category :: option
1147 ;; - type :: symbol (nil, t, `headline')
1148 ;;
1149 ;; + `:with-author' :: Non-nil means author's name should be included
1150 ;; in the output.
1151 ;; - category :: option
1152 ;; - type :: symbol (nil, t)
1153 ;;
1154 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
1155 ;; - category :: option
1156 ;; - type :: symbol (nil, t)
1157 ;;
1158 ;; + `:with-creator' :: Non-nild means a creation sentence should be
1159 ;; inserted at the end of the transcoded string. If the value
1160 ;; is `comment', it should be commented.
1161 ;; - category :: option
1162 ;; - type :: symbol (`comment', nil, t)
1163 ;;
1164 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1165 ;; its value is a list of names, only drawers with such names
1166 ;; will be transcoded.
1167 ;; - category :: option
1168 ;; - type :: symbol (nil, t) or list of strings
1169 ;;
1170 ;; + `:with-email' :: Non-nil means output should contain author's
1171 ;; email.
1172 ;; - category :: option
1173 ;; - type :: symbol (nil, t)
1174 ;;
1175 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1176 ;; interpreted.
1177 ;; - category :: option
1178 ;; - type :: symbol (nil, t)
1179 ;;
1180 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1181 ;; strings starting with a colon as a fixed-with (verbatim) area.
1182 ;; - category :: option
1183 ;; - type :: symbol (nil, t)
1184 ;;
1185 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1186 ;; footnotes.
1187 ;; - category :: option
1188 ;; - type :: symbol (nil, t)
1189 ;;
1190 ;; + `:with-plannings' :: Non-nil means transcoding should include
1191 ;; planning info.
1192 ;; - category :: option
1193 ;; - type :: symbol (nil, t)
1194 ;;
1195 ;; + `:with-priority' :: Non-nil means transcoding should include
1196 ;; priority cookies.
1197 ;; - category :: option
1198 ;; - type :: symbol (nil, t)
1199 ;;
1200 ;; + `:with-smart-quotes' :: Non-nil means activate smart quotes in
1201 ;; plain text.
1202 ;; - category :: option
1203 ;; - type :: symbol (nil, t)
1204 ;;
1205 ;; + `:with-special-strings' :: Non-nil means transcoding should
1206 ;; interpret special strings in plain text.
1207 ;; - category :: option
1208 ;; - type :: symbol (nil, t)
1209 ;;
1210 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1211 ;; interpret subscript and superscript. With a value of "{}",
1212 ;; only interpret those using curly brackets.
1213 ;; - category :: option
1214 ;; - type :: symbol (nil, {}, t)
1215 ;;
1216 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1217 ;; tables.
1218 ;; - category :: option
1219 ;; - type :: symbol (nil, t)
1220 ;;
1221 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1222 ;; headlines. A `not-in-toc' value will remove them from the
1223 ;; table of contents, if any, nonetheless.
1224 ;; - category :: option
1225 ;; - type :: symbol (nil, t, `not-in-toc')
1226 ;;
1227 ;; + `:with-tasks' :: Non-nil means transcoding should include
1228 ;; headlines with a TODO keyword. A `todo' value will only
1229 ;; include headlines with a todo type keyword while a `done'
1230 ;; value will do the contrary. If a list of strings is provided,
1231 ;; only tasks with keywords belonging to that list will be kept.
1232 ;; - category :: option
1233 ;; - type :: symbol (t, todo, done, nil) or list of strings
1234 ;;
1235 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1236 ;; time stamps. Special value `active' (resp. `inactive') ask to
1237 ;; export only active (resp. inactive) timestamps. Otherwise,
1238 ;; completely remove them.
1239 ;; - category :: option
1240 ;; - type :: symbol: (`active', `inactive', t, nil)
1241 ;;
1242 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1243 ;; added to the output. An integer value limits its depth.
1244 ;; - category :: option
1245 ;; - type :: symbol (nil, t or integer)
1246 ;;
1247 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1248 ;; include TODO keywords.
1249 ;; - category :: option
1250 ;; - type :: symbol (nil, t)
1253 ;;;; Environment Options
1254 ;;
1255 ;; Environment options encompass all parameters defined outside the
1256 ;; scope of the parsed data. They come from five sources, in
1257 ;; increasing precedence order:
1258 ;;
1259 ;; - Global variables,
1260 ;; - Buffer's attributes,
1261 ;; - Options keyword symbols,
1262 ;; - Buffer keywords,
1263 ;; - Subtree properties.
1264 ;;
1265 ;; The central internal function with regards to environment options
1266 ;; is `org-export-get-environment'. It updates global variables with
1267 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1268 ;; the different sources.
1269 ;;
1270 ;; The internal functions doing the retrieval are:
1271 ;; `org-export--get-global-options',
1272 ;; `org-export--get-buffer-attributes',
1273 ;; `org-export--parse-option-keyword',
1274 ;; `org-export--get-subtree-options' and
1275 ;; `org-export--get-inbuffer-options'
1276 ;;
1277 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1278 ;; take care of the part relative to "#+BIND:" keywords.
1281 "Collect export options from the current buffer.
1283 Optional argument BACKEND is a symbol specifying which back-end
1284 specific options to read, if any.
1286 When optional argument SUBTREEP is non-nil, assume the export is
1287 done against the current sub-tree.
1289 Third optional argument EXT-PLIST is a property list with
1290 external parameters overriding Org default settings, but still
1291 inferior to file-local settings."
1292 ;; First install #+BIND variables.
1294 ;; Get and prioritize export options...
1296 ;; ... from global variables...
1298 ;; ... from buffer's attributes...
1300 ;; ... from an external property list...
1301 ext-plist
1302 ;; ... from in-buffer settings...
1304 backend
1306 ;; ... and from subtree, when appropriate.
1308 ;; Eventually install back-end symbol and its translation table.
1309 `(:back-end
1310 ,backend
1311 :translate-alist
1316 "Parse an OPTIONS line and return values as a plist.
1317 Optional argument BACKEND is a symbol specifying which back-end
1318 specific items to read, if any."
1325 ;; Build an alist between #+OPTION: item and property-name.
1330 all)))
1331 plist)
1336 options)
1341 alist)
1342 plist))
1345 "Get export options in subtree at point.
1346 Optional argument BACKEND is a symbol specifying back-end used
1347 for export. Return options as a plist."
1348 ;; For each buffer keyword, create an headline property setting the
1349 ;; same property in communication channel. The name for the property
1350 ;; is the keyword with "EXPORT_" appended to it.
1353 ;; Make sure point is at an heading.
1355 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1356 ;; title as its fallback value.
1363 plist :title
1366 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1370 ;; Handle other keywords. TITLE keyword is excluded as it has
1371 ;; already been handled already.
1378 ;; Export properties are not case-sensitive.
1385 plist
1387 ;; Parse VALUE if required.
1391 value))))))))
1392 ;; Also look for both general keywords and back-end specific
1393 ;; options if BACKEND is provided.
1398 org-export-options-alist)))
1399 ;; Return value.
1400 plist)))
1403 "Return current buffer export options, as a plist.
1405 Optional argument BACKEND, when non-nil, is a symbol specifying
1406 which back-end specific options should also be read in the
1407 process.
1409 Optional argument FILES is a list of setup files names read so
1410 far, used to avoid circular dependencies.
1412 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1416 ;; 1. Special keywords, as in `org-export-special-keywords'.
1430 ;; Avoid circular dependencies.
1440 ;; 2. Standard options, as in `org-export-options-alist'.
1442 ;; Also look for back-end specific options
1443 ;; if BACKEND is defined.
1449 ;; Build ALIST between keyword name and property name.
1453 all)))
1454 ;; Build regexp matching all keywords associated to export
1455 ;; options. Note: the search is case insensitive.
1469 plist prop
1470 ;; Handle value depending on specified BEHAVIOUR.
1483 ;; Parse keywords specified in
1484 ;; `org-element-document-properties'.
1492 plist prop
1495 org-element-document-properties))
1496 ;; 3. Return final value.
1497 plist)))
1500 "Return properties related to buffer attributes, as a plist."
1503 ;; Store full path of input file name, or nil. For internal use.
1504 :input-file visited-file
1509 :footnote-definition-alist
1510 ;; Footnotes definitions must be collected in the original
1511 ;; buffer, as there's no insurance that they will still be in the
1512 ;; parse tree, due to possible narrowing.
1526 alist))))
1527 alist))
1528 :id-alist
1529 ;; Collect id references.
1540 alist))))
1543 "Return global export options as a plist.
1545 Optional argument BACKEND, if non-nil, is a symbol specifying
1546 which back-end specific export options should also be read in the
1547 process."
1553 ;; Output value.
1554 plist)
1559 plist
1561 ;; Eval default value provided. If keyword is a member
1562 ;; of `org-element-document-properties', parse it as
1563 ;; a secondary string before storing it.
1568 value
1571 all)
1572 ;; Return value.
1573 plist))
1577 "Can we use #+BIND values during export?
1578 By default this will ask for confirmation by the user, to divert
1579 possible security risks."
1584 org-export--allow-BIND-local)
1589 "Install the values from #+BIND lines as local variables.
1590 Variables must be installed before in-buffer options are
1591 retrieved."
1606 ;;;; Tree Properties
1607 ;;
1608 ;; Tree properties are information extracted from parse tree. They
1609 ;; are initialized at the beginning of the transcoding process by
1610 ;; `org-export-collect-tree-properties'.
1611 ;;
1612 ;; Dedicated functions focus on computing the value of specific tree
1613 ;; properties during initialization. Thus,
1614 ;; `org-export--populate-ignore-list' lists elements and objects that
1615 ;; should be skipped during export, `org-export--get-min-level' gets
1616 ;; the minimal exportable level, used as a basis to compute relative
1617 ;; level for headlines. Eventually
1618 ;; `org-export--collect-headline-numbering' builds an alist between
1619 ;; headlines and their numbering.
1622 "Extract tree properties from parse tree.
1624 DATA is the parse tree from which information is retrieved. INFO
1625 is a list holding export options.
1627 Following tree properties are set or updated:
1629 `:exported-data' Hash table used to memoize results from
1630 `org-export-data'.
1632 `:footnote-definition-alist' List of footnotes definitions in
1633 original buffer and current parse tree.
1635 `:headline-offset' Offset between true level of headlines and
1636 local level. An offset of -1 means an headline
1637 of level 2 should be considered as a level
1638 1 headline in the context.
1640 `:headline-numbering' Alist of all headlines as key an the
1641 associated numbering as value.
1643 `:ignore-list' List of elements that should be ignored during
1644 export.
1646 `:target-list' List of all targets in the parse tree.
1648 Return updated plist."
1649 ;; Install the parse tree in the communication channel, in order to
1650 ;; use `org-export-get-genealogy' and al.
1652 ;; Get the list of elements and objects to ignore, and put it into
1653 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1654 ;; been done during parse tree filtering.
1657 :ignore-list
1660 ;; Compute `:headline-offset' in order to be able to use
1661 ;; `org-export-get-relative-level'.
1664 :headline-offset
1666 ;; Update footnotes definitions list with definitions in parse tree.
1667 ;; This is required since buffer expansion might have modified
1668 ;; boundaries of footnote definitions contained in the parse tree.
1669 ;; This way, definitions in `footnote-definition-alist' are bound to
1670 ;; match those in the parse tree.
1673 data 'footnote-definition
1677 defs)))
1679 ;; Properties order doesn't matter: get the rest of the tree
1680 ;; properties.
1682 `(:target-list
1691 info))
1694 "Return minimum exportable headline's level in DATA.
1695 DATA is parsed tree as returned by `org-element-parse-buffer'.
1696 OPTIONS is a plist holding export options."
1707 ;; If no headline was found, for the sake of consistency, set
1708 ;; minimum level to 1 nonetheless.
1712 "Return numbering of all exportable headlines in a parse tree.
1714 DATA is the parse tree. OPTIONS is the plist holding export
1715 options.
1717 Return an alist whose key is an headline and value is its
1718 associated numbering \(in the shape of a list of numbers\)."
1721 data
1722 'headline
1727 headline
1729 for idx from 0 to org-export-max-depth
1733 options)))
1736 "Return list of elements and objects to ignore during export.
1737 DATA is the parse tree to traverse. OPTIONS is the plist holding
1738 export options."
1740 walk-data
1741 ;; First find trees containing a select tag, if any.
1745 ;; Collect ignored elements or objects into IGNORE-LIST.
1751 ;; If headline is archived but tree below has
1752 ;; to be skipped, add it to ignore list.
1755 ;; Move into secondary string, if any.
1760 ;; Move into recursive objects/elements.
1762 ;; Main call.
1764 ;; Return value.
1765 ignore))
1768 "Return list of headlines containing a select tag in their tree.
1769 DATA is parsed data as returned by `org-element-parse-buffer'.
1770 INFO is a plist holding export options."
1772 walk-data ; for byte-compiler.
1783 ;; When a select tag is found, mark full
1784 ;; genealogy and every headline within the tree
1785 ;; as acceptable.
1788 genealogy
1790 selected-trees))
1791 ;; Else, continue searching in tree, recursively.
1798 "Non-nil when element or object BLOB should be skipped during export.
1799 OPTIONS is the plist holding export options. SELECTED, when
1800 non-nil, is a list of headlines belonging to a tree with a select
1801 tag."
1816 ;; Ignore subtrees with an exclude tag.
1819 ;; When a select tag is present in the buffer, ignore any tree
1820 ;; without it.
1822 ;; Ignore commented sub-trees.
1824 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1826 ;; Ignore tasks, if specified by `:with-tasks' property.
1842 ;; No timestamp allowed.
1844 ;; Only active timestamps allowed and the current one isn't
1845 ;; active.
1849 ;; Only inactive timestamps allowed and the current one isn't
1850 ;; inactive.
1856 \f
1857 ;;; The Transcoder
1858 ;;
1859 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1860 ;; `org-element-parse-buffer') and transcodes it into a specified
1861 ;; back-end output. It takes care of filtering out elements or
1862 ;; objects according to export options and organizing the output blank
1863 ;; lines and white space are preserved. The function memoizes its
1864 ;; results, so it is cheap to call it within translators.
1865 ;;
1866 ;; Internally, three functions handle the filtering of objects and
1867 ;; elements during the export. In particular,
1868 ;; `org-export-ignore-element' marks an element or object so future
1869 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1870 ;; elements or objects should be seen as real Org syntax and
1871 ;; `org-export-expand' transforms the others back into their original
1872 ;; shape
1873 ;;
1874 ;; `org-export-transcoder' is an accessor returning appropriate
1875 ;; translator function for a given element or object.
1878 "Return appropriate transcoder for BLOB.
1879 INFO is a plist containing export directives."
1881 ;; Return contents only for complete parse trees.
1887 "Convert DATA into current back-end format.
1889 DATA is a parse tree, an element or an object or a secondary
1890 string. INFO is a plist holding export options.
1892 Return transcoded string."
1898 ;; Ignored element/object.
1900 ;; Plain text. All residual text properties from parse
1901 ;; tree (i.e. `:parent' property) are removed.
1908 info)))
1909 ;; Uninterpreted element/object: change it back to Org
1910 ;; syntax and export again resulting raw string.
1914 data
1918 info))
1919 ;; Secondary string.
1922 ;; Element/Object without contents or, as a special case,
1923 ;; headline with archive tag and archived trees restricted
1924 ;; to title only.
1932 ;; Element/Object with contents.
1945 ;; Elements directly containing objects
1946 ;; must have their indentation normalized
1947 ;; first.
1949 data
1950 ;; When normalizing contents of the first
1951 ;; paragraph in an item or a footnote
1952 ;; definition, ignore first line's
1953 ;; indentation: there is none and it
1954 ;; might be misleading.
1959 data)
1966 info))))))))
1967 ;; Final result will be memoized before being returned.
1969 data
1973 ;; Append the same white space between elements or objects as in
1974 ;; the original buffer, and call appropriate filters.
1985 info)))
1986 results)))
1990 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1991 Check is done according to export options INFO, stored as
1992 a plist."
1994 ;; ... entities...
1996 ;; ... emphasis...
1998 ;; ... fixed-width areas.
2000 ;; ... footnotes...
2003 ;; ... sub/superscripts...
2009 ;; ... tables...
2014 "Expand a parsed element or object to its original state.
2015 BLOB is either an element or an object. CONTENTS is its
2016 contents, as a string or nil."
2019 blob contents))
2022 "Add ELEMENT to `:ignore-list' in INFO.
2024 Any element in `:ignore-list' will be skipped when using
2025 `org-element-map'. INFO is modified by side effects."
2029 \f
2030 ;;; The Filter System
2031 ;;
2032 ;; Filters allow end-users to tweak easily the transcoded output.
2033 ;; They are the functional counterpart of hooks, as every filter in
2034 ;; a set is applied to the return value of the previous one.
2035 ;;
2036 ;; Every set is back-end agnostic. Although, a filter is always
2037 ;; called, in addition to the string it applies to, with the back-end
2038 ;; used as argument, so it's easy for the end-user to add back-end
2039 ;; specific filters in the set. The communication channel, as
2040 ;; a plist, is required as the third argument.
2041 ;;
2042 ;; From the developer side, filters sets can be installed in the
2043 ;; process with the help of `org-export-define-backend', which
2044 ;; internally sets `org-BACKEND-filters-alist' variable. Each
2045 ;; association has a key among the following symbols and a function or
2046 ;; a list of functions as value.
2047 ;;
2048 ;; - `:filter-parse-tree' applies directly on the complete parsed
2049 ;; tree. It's the only filters set that doesn't apply to a string.
2050 ;; Users can set it through `org-export-filter-parse-tree-functions'
2051 ;; variable.
2052 ;;
2053 ;; - `:filter-final-output' applies to the final transcoded string.
2054 ;; Users can set it with `org-export-filter-final-output-functions'
2055 ;; variable
2056 ;;
2057 ;; - `:filter-plain-text' applies to any string not recognized as Org
2058 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2059 ;; configure it.
2060 ;;
2061 ;; - `:filter-TYPE' applies on the string returned after an element or
2062 ;; object of type TYPE has been transcoded. An user can modify
2063 ;; `org-export-filter-TYPE-functions'
2064 ;;
2065 ;; All filters sets are applied with
2066 ;; `org-export-filter-apply-functions' function. Filters in a set are
2067 ;; applied in a LIFO fashion. It allows developers to be sure that
2068 ;; their filters will be applied first.
2069 ;;
2070 ;; Filters properties are installed in communication channel with
2071 ;; `org-export-install-filters' function.
2072 ;;
2073 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
2074 ;; before parsing to allow for heavy structure modifications.
2077 ;;;; Before Parsing Hook
2080 "Hook run before parsing an export buffer.
2082 This is run after include keywords have been expanded and Babel
2083 code executed, on a copy of original buffer's area being
2084 exported. Visibility is the same as in the original one. Point
2085 is left at the beginning of the new one.
2087 Every function in this hook will be called with one argument: the
2091 ;;;; Special Filters
2094 "List of functions applied to the parsed tree.
2095 Each filter is called with three arguments: the parse tree, as
2096 returned by `org-element-parse-buffer', the back-end, as
2097 a symbol, and the communication channel, as a plist. It must
2101 "List of functions applied to the transcoded string.
2102 Each filter is called with three arguments: the full transcoded
2103 string, the back-end, as a symbol, and the communication channel,
2104 as a plist. It must return a string that will be used as the
2108 "List of functions applied to plain text.
2109 Each filter is called with three arguments: a string which
2110 contains no Org syntax, the back-end, as a symbol, and the
2111 communication channel, as a plist. It must return a string or
2115 ;;;; Elements Filters
2118 "List of functions applied to a transcoded babel-call.
2119 Each filter is called with three arguments: the transcoded data,
2120 as a string, the back-end, as a symbol, and the communication
2124 "List of functions applied to a transcoded center block.
2125 Each filter is called with three arguments: the transcoded data,
2126 as a string, the back-end, as a symbol, and the communication
2130 "List of functions applied to a transcoded clock.
2131 Each filter is called with three arguments: the transcoded data,
2132 as a string, the back-end, as a symbol, and the communication
2136 "List of functions applied to a transcoded comment.
2137 Each filter is called with three arguments: the transcoded data,
2138 as a string, the back-end, as a symbol, and the communication
2142 "List of functions applied to a transcoded comment-block.
2143 Each filter is called with three arguments: the transcoded data,
2144 as a string, the back-end, as a symbol, and the communication
2148 "List of functions applied to a transcoded diary-sexp.
2149 Each filter is called with three arguments: the transcoded data,
2150 as a string, the back-end, as a symbol, and the communication
2154 "List of functions applied to a transcoded drawer.
2155 Each filter is called with three arguments: the transcoded data,
2156 as a string, the back-end, as a symbol, and the communication
2160 "List of functions applied to a transcoded dynamic-block.
2161 Each filter is called with three arguments: the transcoded data,
2162 as a string, the back-end, as a symbol, and the communication
2166 "List of functions applied to a transcoded example-block.
2167 Each filter is called with three arguments: the transcoded data,
2168 as a string, the back-end, as a symbol, and the communication
2172 "List of functions applied to a transcoded export-block.
2173 Each filter is called with three arguments: the transcoded data,
2174 as a string, the back-end, as a symbol, and the communication
2178 "List of functions applied to a transcoded fixed-width.
2179 Each filter is called with three arguments: the transcoded data,
2180 as a string, the back-end, as a symbol, and the communication
2184 "List of functions applied to a transcoded footnote-definition.
2185 Each filter is called with three arguments: the transcoded data,
2186 as a string, the back-end, as a symbol, and the communication
2190 "List of functions applied to a transcoded headline.
2191 Each filter is called with three arguments: the transcoded data,
2192 as a string, the back-end, as a symbol, and the communication
2196 "List of functions applied to a transcoded horizontal-rule.
2197 Each filter is called with three arguments: the transcoded data,
2198 as a string, the back-end, as a symbol, and the communication
2202 "List of functions applied to a transcoded inlinetask.
2203 Each filter is called with three arguments: the transcoded data,
2204 as a string, the back-end, as a symbol, and the communication
2208 "List of functions applied to a transcoded item.
2209 Each filter is called with three arguments: the transcoded data,
2210 as a string, the back-end, as a symbol, and the communication
2214 "List of functions applied to a transcoded keyword.
2215 Each filter is called with three arguments: the transcoded data,
2216 as a string, the back-end, as a symbol, and the communication
2220 "List of functions applied to a transcoded latex-environment.
2221 Each filter is called with three arguments: the transcoded data,
2222 as a string, the back-end, as a symbol, and the communication
2226 "List of functions applied to a transcoded node-property.
2227 Each filter is called with three arguments: the transcoded data,
2228 as a string, the back-end, as a symbol, and the communication
2232 "List of functions applied to a transcoded paragraph.
2233 Each filter is called with three arguments: the transcoded data,
2234 as a string, the back-end, as a symbol, and the communication
2238 "List of functions applied to a transcoded plain-list.
2239 Each filter is called with three arguments: the transcoded data,
2240 as a string, the back-end, as a symbol, and the communication
2244 "List of functions applied to a transcoded planning.
2245 Each filter is called with three arguments: the transcoded data,
2246 as a string, the back-end, as a symbol, and the communication
2250 "List of functions applied to a transcoded property-drawer.
2251 Each filter is called with three arguments: the transcoded data,
2252 as a string, the back-end, as a symbol, and the communication
2256 "List of functions applied to a transcoded quote block.
2257 Each filter is called with three arguments: the transcoded quote
2258 data, as a string, the back-end, as a symbol, and the
2259 communication channel, as a plist. It must return a string or
2263 "List of functions applied to a transcoded quote-section.
2264 Each filter is called with three arguments: the transcoded data,
2265 as a string, the back-end, as a symbol, and the communication
2269 "List of functions applied to a transcoded section.
2270 Each filter is called with three arguments: the transcoded data,
2271 as a string, the back-end, as a symbol, and the communication
2275 "List of functions applied to a transcoded special block.
2276 Each filter is called with three arguments: the transcoded data,
2277 as a string, the back-end, as a symbol, and the communication
2281 "List of functions applied to a transcoded src-block.
2282 Each filter is called with three arguments: the transcoded data,
2283 as a string, the back-end, as a symbol, and the communication
2287 "List of functions applied to a transcoded table.
2288 Each filter is called with three arguments: the transcoded data,
2289 as a string, the back-end, as a symbol, and the communication
2293 "List of functions applied to a transcoded table-cell.
2294 Each filter is called with three arguments: the transcoded data,
2295 as a string, the back-end, as a symbol, and the communication
2299 "List of functions applied to a transcoded table-row.
2300 Each filter is called with three arguments: the transcoded data,
2301 as a string, the back-end, as a symbol, and the communication
2305 "List of functions applied to a transcoded verse block.
2306 Each filter is called with three arguments: the transcoded data,
2307 as a string, the back-end, as a symbol, and the communication
2311 ;;;; Objects Filters
2314 "List of functions applied to transcoded bold text.
2315 Each filter is called with three arguments: the transcoded data,
2316 as a string, the back-end, as a symbol, and the communication
2320 "List of functions applied to transcoded code text.
2321 Each filter is called with three arguments: the transcoded data,
2322 as a string, the back-end, as a symbol, and the communication
2326 "List of functions applied to a transcoded entity.
2327 Each filter is called with three arguments: the transcoded data,
2328 as a string, the back-end, as a symbol, and the communication
2332 "List of functions applied to a transcoded export-snippet.
2333 Each filter is called with three arguments: the transcoded data,
2334 as a string, the back-end, as a symbol, and the communication
2338 "List of functions applied to a transcoded footnote-reference.
2339 Each filter is called with three arguments: the transcoded data,
2340 as a string, the back-end, as a symbol, and the communication
2344 "List of functions applied to a transcoded inline-babel-call.
2345 Each filter is called with three arguments: the transcoded data,
2346 as a string, the back-end, as a symbol, and the communication
2350 "List of functions applied to a transcoded inline-src-block.
2351 Each filter is called with three arguments: the transcoded data,
2352 as a string, the back-end, as a symbol, and the communication
2356 "List of functions applied to transcoded italic text.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 "List of functions applied to a transcoded latex-fragment.
2363 Each filter is called with three arguments: the transcoded data,
2364 as a string, the back-end, as a symbol, and the communication
2368 "List of functions applied to a transcoded line-break.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded link.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 "List of functions applied to a transcoded macro.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to a transcoded radio-target.
2387 Each filter is called with three arguments: the transcoded data,
2388 as a string, the back-end, as a symbol, and the communication
2392 "List of functions applied to a transcoded statistics-cookie.
2393 Each filter is called with three arguments: the transcoded data,
2394 as a string, the back-end, as a symbol, and the communication
2398 "List of functions applied to transcoded strike-through text.
2399 Each filter is called with three arguments: the transcoded data,
2400 as a string, the back-end, as a symbol, and the communication
2404 "List of functions applied to a transcoded subscript.
2405 Each filter is called with three arguments: the transcoded data,
2406 as a string, the back-end, as a symbol, and the communication
2410 "List of functions applied to a transcoded superscript.
2411 Each filter is called with three arguments: the transcoded data,
2412 as a string, the back-end, as a symbol, and the communication
2416 "List of functions applied to a transcoded target.
2417 Each filter is called with three arguments: the transcoded data,
2418 as a string, the back-end, as a symbol, and the communication
2422 "List of functions applied to a transcoded timestamp.
2423 Each filter is called with three arguments: the transcoded data,
2424 as a string, the back-end, as a symbol, and the communication
2428 "List of functions applied to transcoded underline text.
2429 Each filter is called with three arguments: the transcoded data,
2430 as a string, the back-end, as a symbol, and the communication
2434 "List of functions applied to transcoded verbatim text.
2435 Each filter is called with three arguments: the transcoded data,
2436 as a string, the back-end, as a symbol, and the communication
2440 ;;;; Filters Tools
2441 ;;
2442 ;; Internal function `org-export-install-filters' installs filters
2443 ;; hard-coded in back-ends (developer filters) and filters from global
2444 ;; variables (user filters) in the communication channel.
2445 ;;
2446 ;; Internal function `org-export-filter-apply-functions' takes care
2447 ;; about applying each filter in order to a given data. It ignores
2448 ;; filters returning a nil value but stops whenever a filter returns
2449 ;; an empty string.
2452 "Call every function in FILTERS.
2454 Functions are called with arguments VALUE, current export
2455 back-end and INFO. A function returning a nil value will be
2456 skipped. If it returns the empty string, the process ends and
2457 VALUE is ignored.
2459 Call is done in a LIFO fashion, to be sure that developer
2460 specified filters, if any, are called first."
2469 "Install filters properties in communication channel.
2471 INFO is a plist containing the current communication channel.
2473 Return the updated communication channel."
2475 ;; Install user defined filters with `org-export-filters-alist'.
2478 org-export-filters-alist)
2479 ;; Prepend back-end specific filters to that list.
2484 ;; Single values get consed, lists are prepended.
2489 plist key
2493 ;; Return new communication channel.
2497 \f
2498 ;;; Core functions
2499 ;;
2500 ;; This is the room for the main function, `org-export-as', along with
2501 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2502 ;; They differ only by the way they output the resulting code.
2503 ;;
2504 ;; `org-export-output-file-name' is an auxiliary function meant to be
2505 ;; used with `org-export-to-file'. With a given extension, it tries
2506 ;; to provide a canonical file name to write export output to.
2507 ;;
2508 ;; Note that `org-export-as' doesn't really parse the current buffer,
2509 ;; but a copy of it (with the same buffer-local variables and
2510 ;; visibility), where macros and include keywords are expanded and
2511 ;; Babel blocks are executed, if appropriate.
2512 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2513 ;;
2514 ;; File inclusion is taken care of by
2515 ;; `org-export-expand-include-keyword' and
2516 ;; `org-export--prepare-file-contents'. Structure wise, including
2517 ;; a whole Org file in a buffer often makes little sense. For
2518 ;; example, if the file contains an headline and the include keyword
2519 ;; was within an item, the item should contain the headline. That's
2520 ;; why file inclusion should be done before any structure can be
2521 ;; associated to the file, that is before parsing.
2522 ;;
2523 ;; Macro are expanded with `org-export-expand-macro'.
2527 "Transcode current Org buffer into BACKEND code.
2529 If narrowing is active in the current buffer, only transcode its
2530 narrowed part.
2532 If a region is active, transcode that region.
2534 When optional argument SUBTREEP is non-nil, transcode the
2535 sub-tree at point, extracting information from the headline
2536 properties first.
2538 When optional argument VISIBLE-ONLY is non-nil, don't export
2539 contents of hidden elements.
2541 When optional argument BODY-ONLY is non-nil, only return body
2542 code, without preamble nor postamble.
2544 Optional argument EXT-PLIST, when provided, is a property list
2545 with external parameters overriding Org default settings, but
2546 still inferior to file-local settings.
2548 Optional argument NOEXPAND, when non-nil, prevents included files
2549 to be expanded and Babel code to be executed.
2551 Return code as a string."
2552 ;; Barf if BACKEND isn't registered.
2556 ;; Narrow buffer to an appropriate region or subtree for
2557 ;; parsing. If parsing subtree, be sure to remove main headline
2558 ;; too.
2566 ;; Install user's and developer's filters in communication
2567 ;; channel.
2570 ;; Update communication channel and get parse tree. Buffer
2571 ;; isn't parsed directly. Instead, a temporary copy is
2572 ;; created, where include keywords, macros are expanded and
2573 ;; code blocks are evaluated.
2576 ;; Update macro templates since #+INCLUDE keywords might
2577 ;; have added some new ones.
2580 ;; TODO: Setting `org-current-export-file' is required by
2581 ;; Org Babel to properly resolve noweb references. Once
2582 ;; "org-exp.el" is removed, modify
2583 ;; `org-export-blocks-preprocess' so it accepts the value
2584 ;; as an argument instead.
2587 ;; Update radio targets since keyword inclusion might have
2588 ;; added some more.
2590 ;; Run hook `org-export-before-parsing-hook'. with current
2591 ;; back-end as argument.
2594 ;; Initialize communication channel.
2598 ;; Expand export-specific set of macros: {{{author}}},
2599 ;; {{{date}}}, {{{email}}} and {{{title}}}. It must be done
2600 ;; once regular macros have been expanded, since document
2601 ;; keywords may contain one of them.
2608 ;; EMAIL is not a parsed keyword: store it as-is.
2612 ;; Eventually parse buffer. Call parse-tree filters to get
2613 ;; the final tree.
2618 ;; Now tree is complete, compute its properties and add them
2619 ;; to communication channel.
2623 ;; Eventually transcode TREE. Wrap the resulting string into
2624 ;; a template, if required. Finally call final-output filter.
2632 info)))
2633 ;; Maybe add final OUTPUT to kill ring, then return it.
2635 output)))))
2639 "Call `org-export-as' with output to a specified buffer.
2641 BACKEND is the back-end used for transcoding, as a symbol.
2643 BUFFER is the output buffer. If it already exists, it will be
2644 erased first, otherwise, it will be created.
2646 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2647 and NOEXPAND are similar to those used in `org-export-as', which
2648 see.
2650 Return buffer."
2652 backend subtreep visible-only body-only ext-plist noexpand))
2658 buffer))
2662 "Call `org-export-as' with output to a specified file.
2664 BACKEND is the back-end used for transcoding, as a symbol. FILE
2665 is the name of the output file, as a string.
2667 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2668 and NOEXPAND are similar to those used in `org-export-as', which
2669 see.
2671 Return output file's name."
2672 ;; Checks for FILE permissions. `write-file' would do the same, but
2673 ;; we'd rather avoid needless transcoding of parse tree.
2675 ;; Insert contents to a temporary buffer and write it to FILE.
2677 backend subtreep visible-only body-only ext-plist noexpand)))
2682 ;; Return full path.
2683 file)
2686 "Return output file's name according to buffer specifications.
2688 EXTENSION is a string representing the output file extension,
2689 with the leading dot.
2691 With a non-nil optional argument SUBTREEP, try to determine
2693 of subtree at point.
2695 When optional argument PUB-DIR is set, use it as the publishing
2696 directory.
2698 When optional argument VISIBLE-ONLY is non-nil, don't export
2699 contents of hidden elements.
2701 Return file name as a string, or nil if it couldn't be
2702 determined."
2704 ;; File name may come from EXPORT_FILE_NAME subtree property,
2705 ;; assuming point is at beginning of said sub-tree.
2712 ;; File name may be extracted from buffer's associated
2713 ;; file, if any.
2716 ;; Can't determine file name on our own: Ask user.
2720 "Output file: " pub-dir nil nil nil
2723 ;; Build file name. Enforce EXTENSION over whatever user may have
2724 ;; come up with. PUB-DIR, if defined, always has precedence over
2725 ;; any provided path.
2730 extension))
2735 "Apply BODY in a copy of the current buffer.
2737 The copy preserves local variables and visibility of the original
2738 buffer.
2740 Point is at buffer's beginning when BODY is applied."
2750 ,original-buffer
2762 "Expand every include keyword in buffer.
2763 Optional argument INCLUDED is a list of included file names along
2764 with their line restriction, when appropriate. It is used to
2765 avoid infinite recursion. Optional argument DIR is the current
2766 working directory. It is used to properly resolve relative
2767 paths."
2774 ;; Extract arguments from keyword's value.
2788 ;; Minimal level of included file defaults to the child
2789 ;; level of the current headline, if any, or one. It
2790 ;; only applies is the file is meant to be included as
2791 ;; an Org one.
2799 ;; Remove keyword.
2804 ;; Check if files has already been parsed. Look after
2805 ;; inclusion lines too, as different parts of the same file
2806 ;; can be included too.
2818 ind-str contents ind-str))))
2826 ind-str env contents ind-str))))
2839 "Prepare the contents of FILE for inclusion and return them as a string.
2841 When optional argument LINES is a string specifying a range of
2842 lines, include only those lines.
2844 Optional argument IND, when non-nil, is an integer specifying the
2845 global indentation of returned contents. Since its purpose is to
2846 allow an included file to stay in the same environment it was
2847 created \(i.e. a list item), it doesn't apply past the first
2848 headline encountered.
2850 Optional argument MINLEVEL, when non-nil, is an integer
2851 specifying the level that any top-level headline in the included
2852 file should have."
2868 ;; Remove blank lines at beginning and end of contents. The logic
2869 ;; behind that removal is that blank lines around include keyword
2870 ;; override blank lines in included file.
2879 ;; If IND is set, preserve indentation of include keyword until
2880 ;; the first headline encountered.
2886 ;; Do not move footnote definitions out of column 0.
2892 ;; When MINLEVEL is specified, compute minimal level for headlines
2893 ;; in the file (CUR-MIN), and remove stars to each headline so
2894 ;; that headlines with minimal level have a level of MINLEVEL.
2904 ;; Only change stars, don't bother moving whole
2905 ;; sections.
2911 \f
2912 ;;; Tools For Back-Ends
2913 ;;
2914 ;; A whole set of tools is available to help build new exporters. Any
2915 ;; function general enough to have its use across many back-ends
2916 ;; should be added here.
2918 ;;;; For Affiliated Keywords
2919 ;;
2920 ;; `org-export-read-attribute' reads a property from a given element
2921 ;; as a plist. It can be used to normalize affiliated keywords'
2922 ;; syntax.
2923 ;;
2924 ;; Since captions can span over multiple lines and accept dual values,
2925 ;; their internal representation is a bit tricky. Therefore,
2926 ;; `org-export-get-caption' transparently returns a given element's
2927 ;; caption as a secondary string.
2930 "Turn ATTRIBUTE property from ELEMENT into a plist.
2932 When optional argument PROPERTY is non-nil, return the value of
2933 that property within attributes.
2937 properties."
2945 "Return caption from ELEMENT as a secondary string.
2947 When optional argument SHORTP is non-nil, return short caption,
2948 as a secondary string, instead.
2950 Caption lines are separated by a white space."
2958 ;;;; For Export Snippets
2959 ;;
2960 ;; Every export snippet is transmitted to the back-end. Though, the
2961 ;; latter will only retain one type of export-snippet, ignoring
2962 ;; others, based on the former's target back-end. The function
2963 ;; `org-export-snippet-backend' returns that back-end for a given
2964 ;; export-snippet.
2967 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2968 Translation, with `org-export-snippet-translation-alist', is
2969 applied."
2973 back-end))))
2976 ;;;; For Footnotes
2977 ;;
2978 ;; `org-export-collect-footnote-definitions' is a tool to list
2979 ;; actually used footnotes definitions in the whole parse tree, or in
2980 ;; an headline, in order to add footnote listings throughout the
2981 ;; transcoded data.
2982 ;;
2983 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2984 ;; back-ends, when they need to attach the footnote definition only to
2985 ;; the first occurrence of the corresponding label.
2986 ;;
2987 ;; `org-export-get-footnote-definition' and
2988 ;; `org-export-get-footnote-number' provide easier access to
2989 ;; additional information relative to a footnote reference.
2992 "Return an alist between footnote numbers, labels and definitions.
2994 DATA is the parse tree from which definitions are collected.
2995 INFO is the plist used as a communication channel.
2997 Definitions are sorted by order of references. They either
2998 appear as Org data or as a secondary string for inlined
2999 footnotes. Unreferenced definitions are ignored."
3001 collect-fn ; for byte-compiler.
3005 ;; Collect footnote number, label and definition in DATA.
3007 data 'footnote-reference
3014 def)
3015 num-alist)
3016 ;; Also search in definition for nested footnotes.
3019 ;; Don't enter footnote definitions since it will happen
3020 ;; when their first reference is found.
3026 "Non-nil when a footnote reference is the first one for its label.
3028 FOOTNOTE-REFERENCE is the footnote reference being considered.
3029 INFO is the plist used as a communication channel."
3031 ;; Anonymous footnotes are always a first reference.
3033 ;; Otherwise, return the first footnote with the same LABEL and
3034 ;; test if it is equal to FOOTNOTE-REFERENCE.
3040 data 'footnote-reference
3045 ;; If FN isn't inlined, be sure to traverse its
3046 ;; definition before resuming search. See
3047 ;; comments in `org-export-get-footnote-number'
3048 ;; for more information.
3052 ;; Don't enter footnote definitions since it will
3053 ;; happen when their first reference is found.
3056 footnote-reference)))))
3059 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3060 INFO is the plist used as a communication channel."
3066 "Return number associated to a footnote.
3068 FOOTNOTE is either a footnote reference or a footnote definition.
3069 INFO is the plist used as a communication channel."
3071 seen-refs
3072 search-ref ; For byte-compiler.
3076 ;; Search footnote references through DATA, filling
3077 ;; SEEN-REFS along the way.
3079 data 'footnote-reference
3083 ;; Anonymous footnote match: return number.
3086 ;; Labels match: return number.
3089 ;; Anonymous footnote: it's always a new one. Also,
3090 ;; be sure to return nil from the `cond' so
3091 ;; `first-match' doesn't get us out of the loop.
3093 ;; Label not seen so far: add it so SEEN-REFS.
3094 ;;
3095 ;; Also search for subsequent references in
3096 ;; footnote definition so numbering follows reading
3097 ;; logic. Note that we don't have to care about
3098 ;; inline definitions, since `org-element-map'
3099 ;; already traverses them at the right time.
3100 ;;
3101 ;; Once again, return nil to stay in the loop.
3106 nil))))
3107 ;; Don't enter footnote definitions since it will happen
3108 ;; when their first reference is found.
3113 ;;;; For Headlines
3114 ;;
3115 ;; `org-export-get-relative-level' is a shortcut to get headline
3116 ;; level, relatively to the lower headline level in the parsed tree.
3117 ;;
3118 ;; `org-export-get-headline-number' returns the section number of an
3119 ;; headline, while `org-export-number-to-roman' allows to convert it
3120 ;; to roman numbers.
3121 ;;
3122 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3123 ;; `org-export-last-sibling-p' are three useful predicates when it
3124 ;; comes to fulfill the `:headline-levels' property.
3127 "Return HEADLINE relative level within current parsed tree.
3128 INFO is a plist holding contextual information."
3133 "Non-nil when HEADLINE is considered as low level.
3135 INFO is a plist used as a communication channel.
3137 A low level headlines has a relative level greater than
3138 `:headline-levels' property value.
3140 Return value is the difference between HEADLINE relative level
3141 and the last level being considered as high enough, or nil."
3148 "Return HEADLINE numbering as a list of numbers.
3149 INFO is a plist holding contextual information."
3153 "Return a non-nil value if HEADLINE element should be numbered.
3154 INFO is a plist used as a communication channel."
3160 "Convert integer N into a roman numeral."
3173 res)))
3176 "Return list of tags associated to ELEMENT.
3178 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3179 is a plist used as a communication channel.
3181 Select tags (see `org-export-select-tags') and exclude tags (see
3182 `org-export-exclude-tags') are removed from the list.
3184 When non-nil, optional argument TAGS should be a list of strings.
3185 Any tag belonging to this list will also be removed.
3187 When optional argument INHERITED is non-nil, tags can also be
3188 inherited from parent headlines.."
3194 ;; Build complete list of inherited tags.
3205 current-tag-list))))
3208 "Return node PROPERTY value for BLOB.
3210 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3211 element or object.
3213 If optional argument INHERITED is non-nil, the value can be
3214 inherited from a parent headline.
3216 Return value is a string or nil."
3228 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3229 INFO is a plist used as a communication channel."
3234 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3235 INFO is a plist used as a communication channel."
3239 ;;;; For Links
3240 ;;
3241 ;; `org-export-solidify-link-text' turns a string into a safer version
3242 ;; for links, replacing most non-standard characters with hyphens.
3243 ;;
3244 ;; `org-export-get-coderef-format' returns an appropriate format
3245 ;; string for coderefs.
3246 ;;
3247 ;; `org-export-inline-image-p' returns a non-nil value when the link
3248 ;; provided should be considered as an inline image.
3249 ;;
3250 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3251 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3252 ;; returns an appropriate unique identifier when found, or nil.
3253 ;;
3254 ;; `org-export-resolve-id-link' returns the first headline with
3255 ;; specified id or custom-id in parse tree, the path to the external
3256 ;; file with the id or nil when neither was found.
3257 ;;
3258 ;; `org-export-resolve-coderef' associates a reference to a line
3259 ;; number in the element it belongs, or returns the reference itself
3260 ;; when the element isn't numbered.
3263 "Take link text S and make a safe target out of it."
3268 "Return format string for code reference link.
3269 PATH is the link path. DESC is its description."
3277 "Non-nil if LINK object points to an inline image.
3279 Optional argument is a set of RULES defining inline images. It
3280 is an alist where associations have the following shape:
3282 \(TYPE . REGEXP)
3284 Applying a rule means apply REGEXP against LINK's path when its
3285 type is TYPE. The function will return a non-nil value if any of
3286 the provided rules is non-nil. The default rule is
3287 `org-export-default-inline-image-rule'.
3289 This only applies to links without a description."
3300 rules)
3301 ;; Return nil if no rule matched.
3302 nil))))
3305 "Resolve a code reference REF.
3307 INFO is a plist used as a communication channel.
3309 Return associated line number in source code, or REF itself,
3310 depending on src-block or example element's switches."
3318 org-coderef-label-format)))
3322 ;; Element containing REF is found. Resolve it to either
3323 ;; a label or a line number, as needed.
3333 "Return LINK destination.
3335 INFO is a plist holding contextual information.
3337 Return value can be an object, an element, or nil:
3339 - If LINK path matches a target object (i.e. <<path>>) or
3342 - If LINK path exactly matches the name affiliated keyword
3343 \(i.e. #+NAME: path) of an element, return that element.
3345 - If LINK path exactly matches any headline name, return that
3346 element. If more than one headline share that name, priority
3347 will be given to the one with the closest common ancestor, if
3348 any, or the first one in the parse tree otherwise.
3350 - Otherwise, return nil.
3356 ;; First try to find a matching "<<path>>" unless user specified
3357 ;; he was looking for an headline (path starts with a *
3358 ;; character).
3362 return target)))
3363 ;; Then try to find an element with a matching "#+NAME: path"
3364 ;; affiliated keyword.
3371 ;; Last case: link either points to an headline or to
3372 ;; nothingness. Try to find the source, with priority given to
3373 ;; headlines with the closest common ancestor. If such candidate
3374 ;; is found, return it, otherwise return nil.
3378 ;; Return first headline whose `:raw-value' property
3379 ;; is NAME in parse tree DATA, or nil.
3382 data 'headline
3386 name)
3387 headline))
3389 ;; Search among headlines sharing an ancestor with link,
3390 ;; from closest to farthest.
3398 ;; No match with a common ancestor: try the full parse-tree.
3404 "Return headline referenced as LINK destination.
3406 INFO is a plist used as a communication channel.
3408 Return value can be the headline element matched in current parse
3412 ;; First check if id is within the current parse tree.
3418 headline))
3420 ;; Otherwise, look for external files.
3424 "Return radio-target object referenced as LINK destination.
3426 INFO is a plist used as a communication channel.
3428 Return value can be a radio-target object or nil. Assume LINK
3438 ;;;; For References
3439 ;;
3440 ;; `org-export-get-ordinal' associates a sequence number to any object
3441 ;; or element.
3444 "Return ordinal number of an element or object.
3446 ELEMENT is the element or object considered. INFO is the plist
3447 used as a communication channel.
3449 Optional argument TYPES, when non-nil, is a list of element or
3450 object types, as symbols, that should also be counted in.
3451 Otherwise, only provided element's type is considered.
3453 Optional argument PREDICATE is a function returning a non-nil
3454 value if the current element or object should be counted in. It
3455 accepts two arguments: the element or object being considered and
3456 the plist used as a communication channel. This allows to count
3457 only a certain type of objects (i.e. inline images).
3459 Return value is a list of numbers if ELEMENT is an headline or an
3460 item. It is nil for keywords. It represents the footnote number
3461 for footnote definitions and footnote references. If ELEMENT is
3462 a target, return the same value as if ELEMENT was the closest
3463 table, item or headline containing the target. In any other
3464 case, return the sequence number of ELEMENT among elements or
3465 objects of the same type."
3466 ;; A target keyword, representing an invisible target, never has
3467 ;; a sequence number.
3469 ;; Ordinal of a target object refer to the ordinal of the closest
3470 ;; table, item, or headline containing the object.
3474 when
3478 table))
3479 return parent)))
3481 ;; Special case 1: An headline returns its number as a list.
3483 ;; Special case 2: An item returns its number as a list.
3487 struct
3494 ;; Increment counter until ELEMENT is found again.
3505 ;;;; For Src-Blocks
3506 ;;
3507 ;; `org-export-get-loc' counts number of code lines accumulated in
3508 ;; src-block or example-block elements with a "+n" switch until
3509 ;; a given element, excluded. Note: "-n" switches reset that count.
3510 ;;
3511 ;; `org-export-unravel-code' extracts source code (along with a code
3512 ;; references alist) from an `element-block' or `src-block' type
3513 ;; element.
3514 ;;
3515 ;; `org-export-format-code' applies a formatting function to each line
3516 ;; of code, providing relative line number and code reference when
3517 ;; appropriate. Since it doesn't access the original element from
3518 ;; which the source code is coming, it expects from the code calling
3519 ;; it to know if lines should be numbered and if code references
3520 ;; should appear.
3521 ;;
3522 ;; Eventually, `org-export-format-code-default' is a higher-level
3523 ;; function (it makes use of the two previous functions) which handles
3524 ;; line numbering and code references inclusion, and returns source
3525 ;; code in a format suitable for plain text or verbatim output.
3528 "Return accumulated lines of code up to ELEMENT.
3530 INFO is the plist used as a communication channel.
3532 ELEMENT is excluded from count."
3539 ;; ELEMENT is reached: Quit the loop.
3541 ;; Only count lines from src-block and example-block elements
3542 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3546 ;; Accumulate locs or reset them.
3550 ;; Return nil to stay in the loop.
3551 nil)))
3553 ;; Return value.
3554 loc))
3557 "Clean source code and extract references out of it.
3559 ELEMENT has either a `src-block' an `example-block' type.
3561 Return a cons cell whose CAR is the source code, cleaned from any
3562 reference and protective comma and CDR is an alist between
3563 relative line number (integer) and name of code reference on that
3564 line (string)."
3566 ;; Get code and clean it. Remove blank lines at its
3567 ;; beginning and end.
3573 ;; If appropriate, remove global indentation.
3576 c
3578 ;; Get format used for references.
3581 org-coderef-label-format)))
3582 ;; Build a regexp matching a loc with a reference.
3587 ;; Return value.
3589 ;; Code with references removed.
3595 ;; Ref line: remove ref, and signal its position in REFS.
3599 ;; Reference alist.
3600 refs)))
3603 "Format CODE by applying FUN line-wise and return it.
3605 CODE is a string representing the code to format. FUN is
3606 a function. It must accept three arguments: a line of
3607 code (string), the current line number (integer) or nil and the
3608 reference associated to the current line (string) or nil.
3610 Optional argument NUM-LINES can be an integer representing the
3611 number of code lines accumulated until the current code. Line
3612 numbers passed to FUN will take it into account. If it is nil,
3613 FUN's second argument will always be nil. This number can be
3614 obtained with `org-export-get-loc' function.
3616 Optional argument REF-ALIST can be an alist between relative line
3617 number (i.e. ignoring NUM-LINES) and the name of the code
3618 reference on it. If it is nil, FUN's third argument will always
3619 be nil. It can be obtained through the use of
3620 `org-export-unravel-code' function."
3632 "Return source code from ELEMENT, formatted in a standard way.
3634 ELEMENT is either a `src-block' or `example-block' element. INFO
3635 is a plist used as a communication channel.
3637 This function takes care of line numbering and code references
3638 inclusion. Line numbers, when applicable, appear at the
3639 beginning of the line, separated from the code by two white
3640 spaces. Code references, on the other hand, appear flushed to
3641 the right, separated by six white spaces from the widest line of
3642 code."
3643 ;; Extract code and references.
3649 ;; Handle line numbering.
3658 ;; Prepare references display, if required. Any reference
3659 ;; should start six columns after the widest line of code,
3660 ;; wrapped with parenthesis.
3665 code
3669 number-str
3670 loc
3676 num-start refs)))
3679 ;;;; For Tables
3680 ;;
3681 ;; `org-export-table-has-special-column-p' and and
3682 ;; `org-export-table-row-is-special-p' are predicates used to look for
3683 ;; meta-information about the table structure.
3684 ;;
3685 ;; `org-table-has-header-p' tells when the rows before the first rule
3686 ;; should be considered as table's header.
3687 ;;
3688 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3689 ;; and `org-export-table-cell-borders' extract information from
3690 ;; a table-cell element.
3691 ;;
3692 ;; `org-export-table-dimensions' gives the number on rows and columns
3693 ;; in the table, ignoring horizontal rules and special columns.
3694 ;; `org-export-table-cell-address', given a table-cell object, returns
3695 ;; the absolute address of a cell. On the other hand,
3696 ;; `org-export-get-table-cell-at' does the contrary.
3697 ;;
3698 ;; `org-export-table-cell-starts-colgroup-p',
3699 ;; `org-export-table-cell-ends-colgroup-p',
3700 ;; `org-export-table-row-starts-rowgroup-p',
3701 ;; `org-export-table-row-ends-rowgroup-p',
3702 ;; `org-export-table-row-starts-header-p' and
3703 ;; `org-export-table-row-ends-header-p' indicate position of current
3704 ;; row or cell within the table.
3707 "Non-nil when TABLE has a special column.
3708 All special columns will be ignored during export."
3709 ;; The table has a special column when every first cell of every row
3710 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3711 ;; "*" "_" and "^". Though, do not consider a first row containing
3712 ;; only empty cells as special.
3728 "Non-nil when TABLE has an header.
3730 INFO is a plist used as a communication channel.
3732 A table has an header when it contains at least two row groups."
3735 table 'table-row
3743 info)))
3746 "Non-nil if TABLE-ROW is considered special.
3748 INFO is a plist used as the communication channel.
3750 All special rows will be ignored during export."
3754 ;; A row is special either when...
3756 ;; ... it starts with a field only containing "/",
3758 ;; ... the table contains a special column and the row start
3759 ;; with a marking character among, "^", "_", "$" or "!",
3763 ;; ... it contains only alignment cookies and empty cells.
3769 ;; Since VALUE is a secondary string, the following
3770 ;; checks avoid expanding it with `org-export-data'.
3782 "Return TABLE-ROW's group.
3784 INFO is a plist used as the communication channel.
3786 Return value is the group number, as an integer, or nil special
3787 rows and table rules. Group 1 is also table's header."
3804 "Return TABLE-CELL contents width.
3806 INFO is a plist used as the communication channel.
3808 Return value is the width given by the last width cookie in the
3809 same column as TABLE-CELL, or nil."
3814 cookie-width)
3818 ;; In a special row, try to find a width cookie at COLUMN.
3822 ;; The following checks avoid expanding unnecessarily the
3823 ;; cell with `org-export-data'
3831 ;; Ignore table rules.
3834 ;; Return value.
3835 cookie-width))
3838 "Return TABLE-CELL contents alignment.
3840 INFO is a plist used as the communication channel.
3842 Return alignment as specified by the last alignment cookie in the
3843 same column as TABLE-CELL. If no such cookie is found, a default
3844 alignment value will be deduced from fraction of numbers in the
3845 column (see `org-table-number-fraction' for more information).
3846 Possible values are `left', `right' and `center'."
3853 cookie-align)
3857 ;; In a special row, try to find an alignment cookie at
3858 ;; COLUMN.
3862 ;; Since VALUE is a secondary string, the following checks
3863 ;; avoid useless expansion through `org-export-data'.
3871 ;; Ignore table rules.
3873 ;; In a standard row, check if cell's contents are expressing
3874 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3875 ;; Though, don't bother if an alignment cookie has already
3876 ;; defined cell's alignment.
3881 info)))
3886 ;; Return value. Alignment specified by cookies has precedence
3887 ;; over alignment deduced from cells contents.
3896 "Return TABLE-CELL borders.
3898 INFO is a plist used as a communication channel.
3900 Return value is a list of symbols, or nil. Possible values are:
3901 `top', `bottom', `above', `below', `left' and `right'. Note:
3902 `top' (resp. `bottom') only happen for a cell in the first
3903 row (resp. last row) of the table, ignoring table rules, if any.
3905 Returned borders ignore special rows."
3908 borders)
3909 ;; Top/above border? TABLE-CELL has a border above when a rule
3910 ;; used to demarcate row groups can be found above. Hence,
3911 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3912 ;; another regular row has to be found above that rule.
3921 ;; Look at every row before the current one.
3923 ;; No rule above, or rule found starts the table (ignoring any
3924 ;; special row): TABLE-CELL is at the top of the table.
3927 ;; Bottom/below border? TABLE-CELL has a border below when next
3928 ;; non-regular row below is a rule.
3937 ;; Look at every row after the current one.
3939 ;; No rule below, or rule found ends the table (modulo some
3940 ;; special row): TABLE-CELL is at the bottom of the table.
3943 ;; Right/left borders? They can only be specified by column
3944 ;; groups. Column groups are defined in a row starting with "/".
3945 ;; Also a column groups row only contains "<", "<>", ">" or blank
3946 ;; cells.
3963 ;; There's a left border when previous cell, if
3964 ;; any, ends a group, or current one starts one.
3970 ;; There's a right border when next cell, if any,
3971 ;; starts a group, or current one ends one.
3978 ;; Table rows are read in reverse order so last column groups
3979 ;; row has precedence over any previous one.
3981 ;; Return value.
3982 borders))
3985 "Non-nil when TABLE-CELL is at the beginning of a row group.
3986 INFO is a plist used as a communication channel."
3987 ;; A cell starts a column group either when it is at the beginning
3988 ;; of a row (or after the special column, if any) or when it has
3989 ;; a left border.
3993 table-cell)
3997 "Non-nil when TABLE-CELL is at the end of a row group.
3998 INFO is a plist used as a communication channel."
3999 ;; A cell ends a column group either when it is at the end of a row
4000 ;; or when it has a right border.
4003 table-cell)
4007 "Non-nil when TABLE-ROW is at the beginning of a column group.
4008 INFO is a plist used as a communication channel."
4016 "Non-nil when TABLE-ROW is at the end of a column group.
4017 INFO is a plist used as a communication channel."
4025 "Non-nil when TABLE-ROW is the first table header's row.
4026 INFO is a plist used as a communication channel."
4033 "Non-nil when TABLE-ROW is the last table header's row.
4034 INFO is a plist used as a communication channel."
4041 "Return TABLE dimensions.
4043 INFO is a plist used as a communication channel.
4045 Return value is a CONS like (ROWS . COLUMNS) where
4046 ROWS (resp. COLUMNS) is the number of exportable
4047 rows (resp. columns)."
4049 ;; Set number of rows, and extract first one.
4051 table 'table-row
4056 ;; Set number of columns.
4058 ;; Return value.
4062 "Return address of a regular TABLE-CELL object.
4064 TABLE-CELL is the cell considered. INFO is a plist used as
4065 a communication channel.
4067 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4068 zero-based index. Only exportable cells are considered. The
4069 function returns nil for other cells."
4072 ;; Ignore cells in special rows or in special column.
4077 ;; Row number.
4080 table 'table-row
4086 ;; Column number.
4089 table-row 'table-cell
4095 "Return regular table-cell object at ADDRESS in TABLE.
4097 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4098 zero-based index. TABLE is a table type element. INFO is
4099 a plist used as a communication channel.
4101 If no table-cell, among exportable cells, is found at ADDRESS,
4102 return nil."
4105 ;; Row at (car address) or nil.
4108 table 'table-row
4114 'table-cell
4121 ;;;; For Tables Of Contents
4122 ;;
4123 ;; `org-export-collect-headlines' builds a list of all exportable
4124 ;; headline elements, maybe limited to a certain depth. One can then
4125 ;; easily parse it and transcode it.
4126 ;;
4127 ;; Building lists of tables, figures or listings is quite similar.
4128 ;; Once the generic function `org-export-collect-elements' is defined,
4129 ;; `org-export-collect-tables', `org-export-collect-figures' and
4130 ;; `org-export-collect-listings' can be derived from it.
4133 "Collect headlines in order to build a table of contents.
4135 INFO is a plist used as a communication channel.
4137 When optional argument N is an integer, it specifies the depth of
4138 the table of contents. Otherwise, it is set to the value of the
4139 last headline level. See `org-export-headline-levels' for more
4140 information.
4142 Return a list of all exportable headlines as parsed elements."
4146 'headline
4148 ;; Strip contents from HEADLINE.
4151 info))
4154 "Collect referenceable elements of a determined type.
4156 TYPE can be a symbol or a list of symbols specifying element
4157 types to search. Only elements with a caption are collected.
4159 INFO is a plist used as a communication channel.
4161 When non-nil, optional argument PREDICATE is a function accepting
4162 one argument, an element of type TYPE. It returns a non-nil
4163 value when that element should be collected.
4165 Return a list of all elements found, in order of appearance."
4171 element))
4172 info))
4175 "Build a list of tables.
4176 INFO is a plist used as a communication channel.
4178 Return a list of table elements with a caption."
4182 "Build a list of figures.
4184 INFO is a plist used as a communication channel. PREDICATE is
4185 a function which accepts one argument: a paragraph element and
4186 whose return value is non-nil when that element should be
4187 collected.
4189 A figure is a paragraph type element, with a caption, verifying
4191 a vague concept that may depend on back-end.
4193 Return a list of elements recognized as figures."
4197 "Build a list of src blocks.
4199 INFO is a plist used as a communication channel.
4201 Return a list of src-block elements with a caption."
4205 ;;;; Smart Quotes
4242 "Smart quotes translations.
4244 Alist whose CAR is a language string and CDR is an alist with
4245 quote type as key and a plist associating various encodings to
4246 their translation as value.
4248 A quote type can be any symbol among `opening-double-quote',
4249 `closing-double-quote', `opening-single-quote',
4250 `closing-single-quote' and `apostrophe'.
4252 Valid encodings include `:utf-8', `:html', `:latex' and
4253 `:texinfo'.
4259 ;; Possible opening quote at beginning of string.
4261 ;; Possible closing quote at beginning of string.
4263 ;; Possible apostrophe at beginning of string.
4265 ;; Opening single and double quotes.
4267 ;; Closing single and double quotes.
4269 ;; Apostrophe.
4271 ;; Possible opening quote at end of string.
4273 ;; Possible closing quote at end of string.
4275 ;; Possible apostrophe at end of string.
4277 "List of regexps matching a quote or an apostrophe.
4283 ENCODING is a symbol among `:html', `:latex' and `:utf-8'. INFO
4284 is a plist used as a communication channel.
4286 The function has to retrieve information about string
4287 surroundings in parse tree. It can only happen with an
4288 unmodified string. Thus, if S has already been through another
4289 process, a non-nil ORIGINAL optional argument will provide that
4290 original string.
4292 Return the new string."
4299 ;; Return smart quote associated to a give quote Q, as
4300 ;; a string. TYPE is a symbol among `open', `close' and
4301 ;; `apostrophe'.
4311 org-export-smart-quotes-alist))))
4312 encoding)
4313 q)))))
4315 ;; Only a quote: no regexp can match. We have to check both
4316 ;; sides and decide what to do.
4324 ;; 1. Replace quote character at the beginning of S.
4326 ;; Apostrophe?
4332 ;; Closing quote?
4338 ;; Opening quote?
4344 ;; 2. Replace quotes in the middle of the string.
4346 ;; Opening quotes.
4352 ;; Closing quotes.
4358 ;; Apostrophes.
4363 ;; 3. Replace quote character at the end of S.
4365 ;; Apostrophe?
4370 ;; Closing quote?
4376 ;; Opening quote?
4381 ;; Return string with smart quotes.
4382 s))))
4384 ;;;; Topology
4385 ;;
4386 ;; Here are various functions to retrieve information about the
4387 ;; neighbourhood of a given element or object. Neighbours of interest
4388 ;; are direct parent (`org-export-get-parent'), parent headline
4389 ;; (`org-export-get-parent-headline'), first element containing an
4390 ;; object, (`org-export-get-parent-element'), parent table
4391 ;; (`org-export-get-parent-table'), previous element or object
4392 ;; (`org-export-get-previous-element') and next element or object
4393 ;; (`org-export-get-next-element').
4394 ;;
4395 ;; `org-export-get-genealogy' returns the full genealogy of a given
4396 ;; element or object, from closest parent to full parse tree.
4399 "Return BLOB parent or nil.
4400 BLOB is the element or object considered."
4404 "Return full genealogy relative to a given element or object.
4406 BLOB is the element or object being considered.
4408 Ancestors are returned from closest to farthest, the last one
4409 being the full parse tree."
4416 "Return BLOB parent headline or nil.
4417 BLOB is the element or object being considered."
4421 parent))
4424 "Return first element containing OBJECT or nil.
4425 OBJECT is the object to consider."
4429 parent))
4432 "Return OBJECT parent table or nil.
4433 OBJECT is either a `table-cell' or `table-element' type object."
4437 parent))
4440 "Return previous element or object.
4441 BLOB is an element or object. INFO is a plist used as
4442 a communication channel. Return previous exportable element or
4443 object, a string, or nil."
4453 "Return next element or object.
4454 BLOB is an element or object. INFO is a plist used as
4455 a communication channel. Return next exportable element or
4456 object, a string, or nil."
4462 nil))
4465 ;;;; Translation
4466 ;;
4467 ;; `org-export-translate' translates a string according to language
4468 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4469 ;; variable and a specified charset. `org-export-dictionary' contains
4470 ;; the dictionary used for the translation.
4592 "Dictionary for export engine.
4594 Alist whose CAR is the string to translate and CDR is an alist
4595 whose CAR is the language string and CDR is a plist whose
4596 properties are possible charsets and values translated terms.
4598 It is used as a database for `org-export-translate'. Since this
4599 function returns the string as-is if no translation was found,
4600 the variable only needs to record values different from the
4604 "Translate string S according to language specification.
4606 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4607 and `:utf-8'. INFO is a plist used as a communication channel.
4609 Translation depends on `:language' property. Return the
4610 translated string. If no translation is found, try to fall back
4611 to `:default' encoding. If it fails, return S."
4617 s)))
4620 \f
4621 ;;; The Dispatcher
4622 ;;
4623 ;; `org-export-dispatch' is the standard interactive way to start an
4624 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4625 ;; for its interface, which, in turn, delegates response to key
4626 ;; pressed to `org-export-dispatch-action'.
4629 "List of menu entries available for `org-export-dispatch'.
4630 This variable shouldn't be set directly. Set-up :menu-entry
4631 keyword in either `org-export-define-backend' or
4634 ;;;###autoload
4636 "Export dispatcher for Org mode.
4638 It provides an access to common export related tasks in a buffer.
4639 Its interface comes in two flavours: standard and expert. While
4640 both share the same set of bindings, only the former displays the
4641 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4642 to switch to one or the other."
4647 nil
4648 org-export-dispatch-use-expert-ui)
4654 ;; First handle special hard-coded actions.
4660 "Publish project: "
4661 org-e-publish-project-alist nil t)
4662 org-e-publish-project-alist)
4672 "Handle interface for `org-export-dispatch'.
4674 OPTIONS is a list containing current interactive options set for
4675 export. It can contain any of the following symbols:
4676 `body' toggles a body-only export
4677 `subtree' restricts export to current subtree
4678 `visible' restricts export to visible part of buffer.
4679 `force' force publishing files.
4681 FIRST-KEY is the key pressed to select the first level menu. It
4682 is nil when this menu hasn't been selected yet.
4684 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4685 buffer is provided, but indications about currently active
4686 options are given in the prompt. Moreover, \[?] allows to switch
4687 back to standard interface."
4690 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4691 ;; non-nil is the required first-level key to activate
4692 ;; KEY. When its value is t, activate KEY independently
4693 ;; on the first key, if any. A nil value means KEY will
4694 ;; only be activated at first level.
4698 ;; Make sure order of menu doesn't depend on the order in
4699 ;; which back-ends are loaded.
4702 ;; Compute a list of allowed keys based on the first key
4703 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4704 ;; always available.
4714 ;; Build the help menu for standard UI.
4718 ;; Options are hard-coded.
4720 [%s] Body only: %s [%s] Visible only: %s
4730 ;; Display registered back-end entries.
4740 ;; Split sub-menu into two columns.
4750 top-key)
4755 ;; Publishing menu is hard-coded.
4757 [%s] Current file [%s] Current project
4767 ;; Build prompts for both standard and expert UI.
4772 "Export command (Options: %s%s%s%s) [%s]: "
4778 ;; With expert UI, just read key with a fancy prompt. In standard
4779 ;; UI, display an intrusive help buffer.
4782 expert-prompt allowed-keys backends options first-key expertp)
4783 ;; At first call, create frame layout in order to display menu.
4789 ;; At this point, the buffer containing the menu exists and is
4790 ;; visible in the current window. So, refresh it.
4796 standard-prompt allowed-keys backends options first-key expertp))))
4800 "Read a character from command input and act accordingly.
4802 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
4803 a list of characters available at a given step in the process.
4804 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
4805 EXPERTP are the same as defined in `org-export-dispatch-ui',
4806 which see.
4808 Toggle export options when required. Otherwise, return value is
4809 a list with action as CAR and a list of interactive export
4810 options as CDR."
4812 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4813 ;; depending on user's key pressed.
4816 ;; Ignore non-standard characters (i.e. "M-a") and
4817 ;; undefined associations.
4822 ;; q key at first level aborts export. At second
4823 ;; level, cancel first key instead.
4826 ;; Help key: Switch back to standard interface if
4827 ;; expert UI was active.
4829 ;; Toggle export options.
4836 first-key expertp))
4837 ;; Action selected: Send key and options back to
4838 ;; `org-export-dispatch'.
4844 ;; Publishing actions are hard-coded. Send a special
4845 ;; signal to `org-export-dispatch'.
4853 options))
4854 ;; Otherwise, enter sub-menu.
4859 ;;; org-export.el ends here