| blob | faea885b7d4d5fe1277657b9e2276c88d8f5bd32 |
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.
136 "Alist between export properties and ways to set them.
138 The CAR of the alist is the property name, and the CDR is a list
139 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
141 KEYWORD is a string representing a buffer keyword, or nil. Each
142 property defined this way can also be set, during subtree
143 export, through an headline property named after the keyword
145 property).
146 OPTION is a string that could be found in an #+OPTIONS: line.
147 DEFAULT is the default value for the property.
148 BEHAVIOUR determine how Org should handle multiple keywords for
149 the same property. It is a symbol among:
150 nil Keep old value and discard the new one.
151 t Replace old value with the new one.
152 `space' Concatenate the values, separating them with a space.
153 `newline' Concatenate the values, separating them with
154 a newline.
155 `split' Split values at white spaces, and cons them to the
156 previous list.
158 KEYWORD and OPTION have precedence over DEFAULT.
160 All these properties should be back-end agnostic. Back-end
161 specific properties are set through `org-export-define-backend'.
165 "List of in-buffer keywords that require special treatment.
166 These keywords are not directly associated to a property. The
167 way they are handled must be hard-coded into
226 "Alist between filters properties and initial values.
228 The key of each association is a property name accessible through
229 the communication channel. Its value is a configurable global
230 variable defining initial filters.
232 This list is meant to install user specified filters. Back-end
233 developers may install their own filters using
234 `org-export-define-backend'. Filters defined there will always
235 be prepended to the current list, so they always get applied
244 "Default rule for link matching an inline image.
245 This rule applies to links with no description. By default, it
246 will be considered as an inline image if it targets a local file
249 See `org-export-inline-image-p' for more information about
253 \f
254 ;;; User-configurable Variables
255 ;;
256 ;; Configuration for the masses.
257 ;;
258 ;; They should never be accessed directly, as their value is to be
259 ;; stored in a property list (cf. `org-export-options-alist').
260 ;; Back-ends will read their value from there instead.
263 "Options for exporting Org mode files."
268 "General options for export engine."
273 "Whether sub-trees with the ARCHIVE tag should be exported.
275 This can have three different values:
276 nil Do not export, pretend this tree is not present.
277 t Do export the entire tree.
278 `headline' Only export the headline, but skip the tree below it.
280 This option can also be set with the #+OPTIONS line,
289 "Non-nil means insert author name into the exported file.
290 This option can also be set with the #+OPTIONS line,
296 "Non-nil means export CLOCK keywords.
297 This option can also be set with the #+OPTIONS line,
303 "Non-nil means the postamble should contain a creator sentence.
305 The sentence can be set in `org-export-creator-string' and
308 If the value is `comment' insert it as a comment."
318 emacs-version)
319 "String to insert at the end of the generated document."
324 "Non-nil means export contents of standard drawers.
326 When t, all drawers are exported. This may also be a list of
327 drawer names to export. This variable doesn't apply to
328 properties drawers.
330 This option can also be set with the #+OPTIONS line,
340 "Non-nil means insert author email into the exported file.
341 This option can also be set with the #+OPTIONS line,
347 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
349 If the export target supports emphasizing text, the word will be
350 typeset in bold, italic, or underlined, respectively. Not all
351 export backends support this.
358 "Tags that exclude a tree from export.
360 All trees carrying any of these tags will be excluded from
361 export. This is without condition, so even subtrees inside that
362 carry one of the `org-export-select-tags' will be removed.
364 This option can also be set with the #+EXCLUDE_TAGS: keyword."
371 This can be used to have pre-formatted text, fragments of code
372 etc. For example:
373 : ;; Some Lisp examples
374 : (while (defc cnt)
375 : (ding))
376 will be looking just like this in also HTML. See also the QUOTE
377 keyword. Not all export backends support this.
384 "Non-nil means Org footnotes should be exported.
385 This option can also be set with the #+OPTIONS line,
391 "The last level which is still exported as a headline.
393 Inferior levels will produce itemize lists when exported.
400 "The default language for export and clocktable translations, as a string.
401 This may have an association in
402 `org-clock-clocktable-language-setup'."
407 "Non-nil means preserve all line breaks when exporting.
409 Normally, in HTML output paragraphs will be reformatted.
411 This option can also be set with the #+OPTIONS line,
417 "Non-nil means interpret entities when exporting.
420 Å.
422 For a list of supported names, see the constant `org-entities'
423 and the user option `org-entities-user'.
425 This option can also be set with the #+OPTIONS line,
431 "Non-nil means inlinetasks should be exported.
432 This option can also be set with the #+OPTIONS line,
438 "Non-nil means include planning info in export.
439 This option can also be set with the #+OPTIONS: line,
445 "Non-nil means include priority cookies in export.
446 This option can also be set with the #+OPTIONS line,
452 "Non-nil means add section numbers to headlines when exporting.
454 When set to an integer n, numbering will only happen for
455 headlines whose relative level is higher or equal to n.
457 This option can also be set with the #+OPTIONS line,
463 "Tags that select a tree for export.
465 If any such tag is found in a buffer, all trees that do not carry
466 one of these tags will be ignored during export. Inside trees
467 that are selected like this, you can still deselect a subtree by
468 tagging it with one of the `org-export-exclude-tags'.
470 This option can also be set with the #+SELECT_TAGS: keyword."
477 When this option is turned on, these strings will be exported as:
479 Org HTML LaTeX UTF-8
480 -----+----------+--------+-------
482 -- – -- –
483 --- — --- —
486 This option can also be set with the #+OPTIONS line,
492 "Non-nil means include statistics cookies in export.
493 This option can also be set with the #+OPTIONS: line,
501 When this option is turned on, you can use TeX-like syntax for
503 will be considered as a single item - so grouping with {} is
504 normally not needed. For example, the following things will be
505 parsed as single sub- or superscripts.
507 10^24 or 10^tau several digits will be considered 1 item.
508 10^-12 or 10^-tau a leading sign with digits or a word
509 x^2-y^3 will be read as x^2 - y^3, because items are
510 terminated by almost any nonword/nondigit char.
511 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
513 Still, ambiguity is possible - so when in doubt use {} to enclose
514 the sub/superscript. If you set this variable to the symbol
515 `{}', the braces are *required* in order to trigger
516 interpretations as sub/superscript. This can be helpful in
519 This option can also be set with the #+OPTIONS line,
528 "Non-nil means create a table of contents in exported files.
530 The TOC contains headlines with levels up
531 to`org-export-headline-levels'. When an integer, include levels
532 up to N in the toc, this may then be different from
533 `org-export-headline-levels', but it will not be allowed to be
534 larger than the number of headline levels. When nil, no table of
535 contents is made.
537 This option can also be set with the #+OPTIONS line,
547 For example:
549 | Name | Address | Birthday |
550 |-------------+----------+-----------|
551 | Arthur Dent | England | 29.2.2100 |
558 "If nil, do not export tags, just remove them from headlines.
560 If this is the symbol `not-in-toc', tags will be removed from
561 table of contents entries, but still be shown in the headlines of
562 the document.
564 This option can also be set with the #+OPTIONS line,
573 "Non-nil means include TODO items for export.
574 This may have the following values:
575 t include tasks independent of state.
576 todo include only tasks that are not yet done.
577 done include only tasks that are already done.
578 nil remove all tasks before export
579 list of keywords keep only tasks with these keywords"
590 "Non-nil means insert a time stamp into the exported file.
591 The time stamp shows when the file was created.
593 This option can also be set with the #+OPTIONS line,
599 "Non nil means allow timestamps in export.
601 It can be set to `active', `inactive', t or nil, in order to
602 export, respectively, only active timestamps, only inactive ones,
603 all of them or none.
605 This option can also be set with the #+OPTIONS line, e.g.
615 "Non-nil means include TODO keywords in export.
616 When nil, remove all these keywords from the export."
621 "Non-nil means allow #+BIND to define local variable values for export.
622 This is a potential security risk, which is why the user must
623 confirm the use of these lines."
631 "Alist between export snippets back-ends and exporter back-ends.
633 This variable allows to provide shortcuts for export snippets.
637 HTML code while every other back-end will ignore it."
645 "Coding system for the exported file."
650 "Non-nil means exported stuff will also be pushed onto the kill ring."
655 "The initial scope when exporting with `org-export-dispatch'.
656 This variable can be either set to `buffer' or `subtree'."
663 "Non-nil means show buffer after exporting to temp buffer.
664 When Org exports to a file, the buffer visiting that file is ever
665 shown, but remains buried. However, when exporting to
666 a temporary buffer, that buffer is popped up in a second window.
667 When this variable is nil, the buffer remains buried also in
668 these cases."
673 "Non-nil means using a non-intrusive `org-export-dispatch'.
674 In that case, no help buffer is displayed. Though, an indicator
678 considered for export\). Also, \[?] allows to switch back to
679 standard mode."
684 \f
685 ;;; Defining New Back-ends
686 ;;
687 ;; `org-export-define-backend' is the standard way to define an export
688 ;; back-end. It allows to specify translators, filters, buffer
689 ;; options and a menu entry. If the new back-end shares translators
690 ;; with another back-end, `org-export-define-derived-backend' may be
691 ;; used instead.
692 ;;
693 ;; Eventually `org-export-barf-if-invalid-backend' returns an error
694 ;; when a given back-end hasn't been registered yet.
697 "Define a new back-end BACKEND.
699 TRANSLATORS is an alist between object or element types and
700 functions handling them.
702 These functions should return a string without any trailing
703 space, or nil. They must accept three arguments: the object or
704 element itself, its contents or nil when it isn't recursive and
705 the property list used as a communication channel.
707 Contents, when not nil, are stripped from any global indentation
708 \(although the relative one is preserved). They also always end
709 with a single newline character.
711 If, for a given type, no function is found, that element or
712 object type will simply be ignored, along with any blank line or
713 white space at its end. The same will happen if the function
714 returns the nil value. If that function returns the empty
715 string, the type will be ignored, but the blank lines or white
716 spaces will be kept.
718 In addition to element and object types, one function can be
719 associated to the `template' symbol and another one to the
720 `plain-text' symbol.
722 The former returns the final transcoded string, and can be used
723 to add a preamble and a postamble to document's body. It must
724 accept two arguments: the transcoded string and the property list
725 containing export options.
727 The latter, when defined, is to be called on every text not
728 recognized as an element or an object. It must accept two
729 arguments: the text string and the information channel. It is an
730 appropriate place to protect special chars relative to the
731 back-end.
733 BODY can start with pre-defined keyword arguments. The following
734 keywords are understood:
736 :export-block
738 String, or list of strings, representing block names that
739 will not be parsed. This is used to specify blocks that will
740 contain raw code specific to the back-end. These blocks
741 still have to be handled by the relative `export-block' type
742 translator.
744 :filters-alist
746 Alist between filters and function, or list of functions,
747 specific to the back-end. See `org-export-filters-alist' for
748 a list of all allowed filters. Filters defined here
749 shouldn't make a back-end test, as it may prevent back-ends
750 derived from this one to behave properly.
752 :menu-entry
754 Menu entry for the export dispatcher. It should be a list
755 like:
757 \(KEY DESCRIPTION ACTION-OR-MENU)
759 where :
761 KEY is a free character selecting the back-end.
762 DESCRIPTION is a string naming the back-end.
763 ACTION-OR-MENU is either a function or an alist.
765 If it is an action, it will be called with three arguments:
766 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
767 for further explanations.
769 If it is an alist, associations should follow the
770 pattern:
772 \(KEY DESCRIPTION ACTION)
774 where KEY, DESCRIPTION and ACTION are described above.
776 Valid values include:
780 or
787 \(lambda (subtree visible body-only)
788 \(org-open-file
789 \(org-e-latex-export-to-pdf subtree visible body-only))))))
791 :options-alist
793 Alist between back-end specific properties introduced in
794 communication channel and how their value are acquired. See
795 `org-export-options-alist' for more information about
796 structure of the values."
811 ;; Define translators.
814 ;; Define options.
818 See `org-export-options-alist' for more information on the
819 structure of the values."
820 backend)))
821 ;; Define filters.
824 "Alist between filters keywords and back-end specific filters.
826 ;; Tell parser to not parse EXPORT-BLOCK blocks.
833 ;; Add an entry for back-end in `org-export-dispatch'.
837 ;; Splice in the body, if any.
841 "Create a new back-end as a variant of an existing one.
843 CHILD is the name of the derived back-end. PARENT is the name of
844 the parent back-end.
846 BODY can start with pre-defined keyword arguments. The following
847 keywords are understood:
849 :export-block
851 String, or list of strings, representing block names that
852 will not be parsed. This is used to specify blocks that will
853 contain raw code specific to the back-end. These blocks
854 still have to be handled by the relative `export-block' type
855 translator.
857 :filters-alist
859 Alist of filters that will overwrite or complete filters
860 defined in PARENT back-end. See `org-export-filters-alist'
861 for a list of allowed filters.
863 :menu-entry
865 Menu entry for the export dispatcher. See
866 `org-export-define-backend' for more information about the
867 expected value.
869 :options-alist
871 Alist of back-end specific properties that will overwrite or
872 complete those defined in PARENT back-end. Refer to
873 `org-export-options-alist' for more information about
874 structure of the values.
876 :sub-menu-entry
878 Append entries to an existing menu in the export dispatcher.
879 The associated value should be a list whose CAR is the
880 character selecting the menu to expand and CDR a list of
881 entries following the pattern:
883 \(KEY DESCRIPTION ACTION)
885 where KEY is a free character triggering the action,
886 DESCRIPTION is a string defining the action, and ACTION is
887 a function that will be called with three arguments:
888 SUBTREEP, VISIBLE-ONLY and BODY-ONLY. See `org-export-as'
889 for further explanations.
891 Valid values include:
895 \(lambda (s v b)
896 \(org-open-file (org-e-beamer-export-to-pdf s v b)))))
898 :translate-alist
900 Alist of element and object types and transcoders that will
901 overwrite or complete transcode table from PARENT back-end.
902 Refer to `org-export-define-backend' for detailed information
903 about transcoders.
906 as a variant of `e-latex' back-end with a custom template
907 function:
909 \(org-export-define-derived-backend my-latex e-latex
910 :translate-alist ((template . my-latex-template-fun)))
912 The back-end could then be called with, for example:
931 ;; Tell parser to not parse EXPORT-BLOCK blocks.
938 ;; Define filters.
945 "Alist between filters keywords and back-end specific filters.
947 ;; Define options.
955 See `org-export-options-alist' for more information on the
956 structure of the values."
957 child))))
958 ;; Define translators.
965 ;; Add an entry for back-end in `org-export-dispatch'.
971 org-export-dispatch-menu-entries))))
975 ;; Splice in the body, if any.
979 "Signal an error if BACKEND isn't defined."
984 \f
985 ;;; The Communication Channel
986 ;;
987 ;; During export process, every function has access to a number of
988 ;; properties. They are of two types:
989 ;;
990 ;; 1. Environment options are collected once at the very beginning of
991 ;; the process, out of the original buffer and configuration.
992 ;; Collecting them is handled by `org-export-get-environment'
993 ;; function.
994 ;;
995 ;; Most environment options are defined through the
996 ;; `org-export-options-alist' variable.
997 ;;
998 ;; 2. Tree properties are extracted directly from the parsed tree,
999 ;; just before export, by `org-export-collect-tree-properties'.
1000 ;;
1001 ;; Here is the full list of properties available during transcode
1002 ;; process, with their category and their value type.
1003 ;;
1004 ;; + `:author' :: Author's name.
1005 ;; - category :: option
1006 ;; - type :: string
1007 ;;
1008 ;; + `:back-end' :: Current back-end used for transcoding.
1009 ;; - category :: tree
1010 ;; - type :: symbol
1011 ;;
1012 ;; + `:creator' :: String to write as creation information.
1013 ;; - category :: option
1014 ;; - type :: string
1015 ;;
1016 ;; + `:date' :: String to use as date.
1017 ;; - category :: option
1018 ;; - type :: string
1019 ;;
1020 ;; + `:description' :: Description text for the current data.
1021 ;; - category :: option
1022 ;; - type :: string
1023 ;;
1024 ;; + `:email' :: Author's email.
1025 ;; - category :: option
1026 ;; - type :: string
1027 ;;
1028 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
1029 ;; process.
1030 ;; - category :: option
1031 ;; - type :: list of strings
1032 ;;
1033 ;; + `:exported-data' :: Hash table used for memoizing
1034 ;; `org-export-data'.
1035 ;; - category :: tree
1036 ;; - type :: hash table
1037 ;;
1038 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1039 ;; their definition, as parsed data. Only non-inlined footnotes
1040 ;; are represented in this alist. Also, every definition isn't
1041 ;; guaranteed to be referenced in the parse tree. The purpose of
1042 ;; this property is to preserve definitions from oblivion
1043 ;; (i.e. when the parse tree comes from a part of the original
1044 ;; buffer), it isn't meant for direct use in a back-end. To
1045 ;; retrieve a definition relative to a reference, use
1046 ;; `org-export-get-footnote-definition' instead.
1047 ;; - category :: option
1048 ;; - type :: alist (STRING . LIST)
1049 ;;
1050 ;; + `:headline-levels' :: Maximum level being exported as an
1051 ;; headline. Comparison is done with the relative level of
1052 ;; headlines in the parse tree, not necessarily with their
1053 ;; actual level.
1054 ;; - category :: option
1055 ;; - type :: integer
1056 ;;
1057 ;; + `:headline-offset' :: Difference between relative and real level
1058 ;; of headlines in the parse tree. For example, a value of -1
1059 ;; means a level 2 headline should be considered as level
1060 ;; 1 (cf. `org-export-get-relative-level').
1061 ;; - category :: tree
1062 ;; - type :: integer
1063 ;;
1064 ;; + `:headline-numbering' :: Alist between headlines and their
1065 ;; numbering, as a list of numbers
1066 ;; (cf. `org-export-get-headline-number').
1067 ;; - category :: tree
1068 ;; - type :: alist (INTEGER . LIST)
1069 ;;
1070 ;; + `:id-alist' :: Alist between ID strings and destination file's
1071 ;; path, relative to current directory. It is used by
1072 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1073 ;; external file.
1074 ;; - category :: option
1075 ;; - type :: alist (STRING . STRING)
1076 ;;
1077 ;; + `:ignore-list' :: List of elements and objects that should be
1078 ;; ignored during export.
1079 ;; - category :: tree
1080 ;; - type :: list of elements and objects
1081 ;;
1082 ;; + `:input-file' :: Full path to input file, if any.
1083 ;; - category :: option
1084 ;; - type :: string or nil
1085 ;;
1086 ;; + `:keywords' :: List of keywords attached to data.
1087 ;; - category :: option
1088 ;; - type :: string
1089 ;;
1090 ;; + `:language' :: Default language used for translations.
1091 ;; - category :: option
1092 ;; - type :: string
1093 ;;
1094 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1095 ;; transcoding.
1096 ;; - category :: option
1097 ;; - type :: list (as returned by `org-element-parse-buffer')
1098 ;;
1099 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1100 ;; all line breaks.
1101 ;; - category :: option
1102 ;; - type :: symbol (nil, t)
1103 ;;
1104 ;; + `:section-numbers' :: Non-nil means transcoding should add
1105 ;; section numbers to headlines.
1106 ;; - category :: option
1107 ;; - type :: symbol (nil, t)
1108 ;;
1109 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1110 ;; in transcoding. When such a tag is present, subtrees without
1111 ;; it are de facto excluded from the process. See
1112 ;; `use-select-tags'.
1113 ;; - category :: option
1114 ;; - type :: list of strings
1115 ;;
1116 ;; + `:target-list' :: List of targets encountered in the parse tree.
1117 ;; This is used to partly resolve "fuzzy" links
1118 ;; (cf. `org-export-resolve-fuzzy-link').
1119 ;; - category :: tree
1120 ;; - type :: list of strings
1121 ;;
1122 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1123 ;; a time stamp in the output.
1124 ;; - category :: option
1125 ;; - type :: symbol (nil, t)
1126 ;;
1127 ;; + `:translate-alist' :: Alist between element and object types and
1128 ;; transcoding functions relative to the current back-end.
1129 ;; Special keys `template' and `plain-text' are also possible.
1130 ;; - category :: option
1131 ;; - type :: alist (SYMBOL . FUNCTION)
1132 ;;
1133 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1134 ;; also be transcoded. If it is set to the `headline' symbol,
1135 ;; only the archived headline's name is retained.
1136 ;; - category :: option
1137 ;; - type :: symbol (nil, t, `headline')
1138 ;;
1139 ;; + `:with-author' :: Non-nil means author's name should be included
1140 ;; in the output.
1141 ;; - category :: option
1142 ;; - type :: symbol (nil, t)
1143 ;;
1144 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
1145 ;; - category :: option
1146 ;; - type :: symbol (nil, t)
1147 ;;
1148 ;; + `:with-creator' :: Non-nild means a creation sentence should be
1149 ;; inserted at the end of the transcoded string. If the value
1150 ;; is `comment', it should be commented.
1151 ;; - category :: option
1152 ;; - type :: symbol (`comment', nil, t)
1153 ;;
1154 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1155 ;; its value is a list of names, only drawers with such names
1156 ;; will be transcoded.
1157 ;; - category :: option
1158 ;; - type :: symbol (nil, t) or list of strings
1159 ;;
1160 ;; + `:with-email' :: Non-nil means output should contain author's
1161 ;; email.
1162 ;; - category :: option
1163 ;; - type :: symbol (nil, t)
1164 ;;
1165 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1166 ;; interpreted.
1167 ;; - category :: option
1168 ;; - type :: symbol (nil, t)
1169 ;;
1170 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1171 ;; strings starting with a colon as a fixed-with (verbatim) area.
1172 ;; - category :: option
1173 ;; - type :: symbol (nil, t)
1174 ;;
1175 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1176 ;; footnotes.
1177 ;; - category :: option
1178 ;; - type :: symbol (nil, t)
1179 ;;
1180 ;; + `:with-plannings' :: Non-nil means transcoding should include
1181 ;; planning info.
1182 ;; - category :: option
1183 ;; - type :: symbol (nil, t)
1184 ;;
1185 ;; + `:with-priority' :: Non-nil means transcoding should include
1186 ;; priority cookies.
1187 ;; - category :: option
1188 ;; - type :: symbol (nil, t)
1189 ;;
1190 ;; + `:with-special-strings' :: Non-nil means transcoding should
1191 ;; interpret special strings in plain text.
1192 ;; - category :: option
1193 ;; - type :: symbol (nil, t)
1194 ;;
1195 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1196 ;; interpret subscript and superscript. With a value of "{}",
1197 ;; only interpret those using curly brackets.
1198 ;; - category :: option
1199 ;; - type :: symbol (nil, {}, t)
1200 ;;
1201 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1202 ;; tables.
1203 ;; - category :: option
1204 ;; - type :: symbol (nil, t)
1205 ;;
1206 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1207 ;; headlines. A `not-in-toc' value will remove them from the
1208 ;; table of contents, if any, nonetheless.
1209 ;; - category :: option
1210 ;; - type :: symbol (nil, t, `not-in-toc')
1211 ;;
1212 ;; + `:with-tasks' :: Non-nil means transcoding should include
1213 ;; headlines with a TODO keyword. A `todo' value will only
1214 ;; include headlines with a todo type keyword while a `done'
1215 ;; value will do the contrary. If a list of strings is provided,
1216 ;; only tasks with keywords belonging to that list will be kept.
1217 ;; - category :: option
1218 ;; - type :: symbol (t, todo, done, nil) or list of strings
1219 ;;
1220 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1221 ;; time stamps. Special value `active' (resp. `inactive') ask to
1222 ;; export only active (resp. inactive) timestamps. Otherwise,
1223 ;; completely remove them.
1224 ;; - category :: option
1225 ;; - type :: symbol: (`active', `inactive', t, nil)
1226 ;;
1227 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1228 ;; added to the output. An integer value limits its depth.
1229 ;; - category :: option
1230 ;; - type :: symbol (nil, t or integer)
1231 ;;
1232 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1233 ;; include TODO keywords.
1234 ;; - category :: option
1235 ;; - type :: symbol (nil, t)
1238 ;;;; Environment Options
1239 ;;
1240 ;; Environment options encompass all parameters defined outside the
1241 ;; scope of the parsed data. They come from five sources, in
1242 ;; increasing precedence order:
1243 ;;
1244 ;; - Global variables,
1245 ;; - Buffer's attributes,
1246 ;; - Options keyword symbols,
1247 ;; - Buffer keywords,
1248 ;; - Subtree properties.
1249 ;;
1250 ;; The central internal function with regards to environment options
1251 ;; is `org-export-get-environment'. It updates global variables with
1252 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1253 ;; the different sources.
1254 ;;
1255 ;; The internal functions doing the retrieval are:
1256 ;; `org-export--get-global-options',
1257 ;; `org-export--get-buffer-attributes',
1258 ;; `org-export--parse-option-keyword',
1259 ;; `org-export--get-subtree-options' and
1260 ;; `org-export--get-inbuffer-options'
1261 ;;
1262 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1263 ;; take care of the part relative to "#+BIND:" keywords.
1266 "Collect export options from the current buffer.
1268 Optional argument BACKEND is a symbol specifying which back-end
1269 specific options to read, if any.
1271 When optional argument SUBTREEP is non-nil, assume the export is
1272 done against the current sub-tree.
1274 Third optional argument EXT-PLIST is a property list with
1275 external parameters overriding Org default settings, but still
1276 inferior to file-local settings."
1277 ;; First install #+BIND variables.
1279 ;; Get and prioritize export options...
1281 ;; ... from global variables...
1283 ;; ... from buffer's attributes...
1285 ;; ... from an external property list...
1286 ext-plist
1287 ;; ... from in-buffer settings...
1289 backend
1291 ;; ... and from subtree, when appropriate.
1293 ;; Eventually install back-end symbol and its translation table.
1294 `(:back-end
1295 ,backend
1296 :translate-alist
1301 "Parse an OPTIONS line and return values as a plist.
1302 Optional argument BACKEND is a symbol specifying which back-end
1303 specific items to read, if any."
1310 ;; Build an alist between #+OPTION: item and property-name.
1315 all)))
1316 plist)
1321 options)
1326 alist)
1327 plist))
1330 "Get export options in subtree at point.
1331 Optional argument BACKEND is a symbol specifying back-end used
1332 for export. Return options as a plist."
1333 ;; For each buffer keyword, create an headline property setting the
1334 ;; same property in communication channel. The name for the property
1335 ;; is the keyword with "EXPORT_" appended to it.
1338 ;; Make sure point is at an heading.
1340 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1341 ;; title as its fallback value.
1348 plist :title
1351 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1355 ;; Handle other keywords. TITLE keyword is excluded as it has
1356 ;; already been handled already.
1363 ;; Export properties are not case-sensitive.
1370 plist
1372 ;; Parse VALUE if required.
1376 value))))))))
1377 ;; Also look for both general keywords and back-end specific
1378 ;; options if BACKEND is provided.
1383 org-export-options-alist)))
1384 ;; Return value.
1385 plist)))
1388 "Return current buffer export options, as a plist.
1390 Optional argument BACKEND, when non-nil, is a symbol specifying
1391 which back-end specific options should also be read in the
1392 process.
1394 Optional argument FILES is a list of setup files names read so
1395 far, used to avoid circular dependencies.
1397 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1401 ;; 1. Special keywords, as in `org-export-special-keywords'.
1415 ;; Avoid circular dependencies.
1425 ;; 2. Standard options, as in `org-export-options-alist'.
1427 ;; Also look for back-end specific options
1428 ;; if BACKEND is defined.
1434 ;; Build ALIST between keyword name and property name.
1438 all)))
1439 ;; Build regexp matching all keywords associated to export
1440 ;; options. Note: the search is case insensitive.
1454 plist prop
1455 ;; Handle value depending on specified BEHAVIOUR.
1468 ;; Parse keywords specified in
1469 ;; `org-element-document-properties'.
1477 plist prop
1480 org-element-document-properties))
1481 ;; 3. Return final value.
1482 plist)))
1485 "Return properties related to buffer attributes, as a plist."
1488 ;; Store full path of input file name, or nil. For internal use.
1489 :input-file visited-file
1494 :footnote-definition-alist
1495 ;; Footnotes definitions must be collected in the original
1496 ;; buffer, as there's no insurance that they will still be in the
1497 ;; parse tree, due to possible narrowing.
1511 alist))))
1512 alist))
1513 :id-alist
1514 ;; Collect id references.
1525 alist))))
1528 "Return global export options as a plist.
1530 Optional argument BACKEND, if non-nil, is a symbol specifying
1531 which back-end specific export options should also be read in the
1532 process."
1538 ;; Output value.
1539 plist)
1544 plist
1546 ;; Eval default value provided. If keyword is a member
1547 ;; of `org-element-document-properties', parse it as
1548 ;; a secondary string before storing it.
1553 value
1556 all)
1557 ;; Return value.
1558 plist))
1562 "Can we use #+BIND values during export?
1563 By default this will ask for confirmation by the user, to divert
1564 possible security risks."
1569 org-export--allow-BIND-local)
1574 "Install the values from #+BIND lines as local variables.
1575 Variables must be installed before in-buffer options are
1576 retrieved."
1591 ;;;; Tree Properties
1592 ;;
1593 ;; Tree properties are information extracted from parse tree. They
1594 ;; are initialized at the beginning of the transcoding process by
1595 ;; `org-export-collect-tree-properties'.
1596 ;;
1597 ;; Dedicated functions focus on computing the value of specific tree
1598 ;; properties during initialization. Thus,
1599 ;; `org-export--populate-ignore-list' lists elements and objects that
1600 ;; should be skipped during export, `org-export--get-min-level' gets
1601 ;; the minimal exportable level, used as a basis to compute relative
1602 ;; level for headlines. Eventually
1603 ;; `org-export--collect-headline-numbering' builds an alist between
1604 ;; headlines and their numbering.
1607 "Extract tree properties from parse tree.
1609 DATA is the parse tree from which information is retrieved. INFO
1610 is a list holding export options.
1612 Following tree properties are set or updated:
1614 `:exported-data' Hash table used to memoize results from
1615 `org-export-data'.
1617 `:footnote-definition-alist' List of footnotes definitions in
1618 original buffer and current parse tree.
1620 `:headline-offset' Offset between true level of headlines and
1621 local level. An offset of -1 means an headline
1622 of level 2 should be considered as a level
1623 1 headline in the context.
1625 `:headline-numbering' Alist of all headlines as key an the
1626 associated numbering as value.
1628 `:ignore-list' List of elements that should be ignored during
1629 export.
1631 `:target-list' List of all targets in the parse tree.
1633 Return updated plist."
1634 ;; Install the parse tree in the communication channel, in order to
1635 ;; use `org-export-get-genealogy' and al.
1637 ;; Get the list of elements and objects to ignore, and put it into
1638 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1639 ;; been done during parse tree filtering.
1642 :ignore-list
1645 ;; Compute `:headline-offset' in order to be able to use
1646 ;; `org-export-get-relative-level'.
1649 :headline-offset
1651 ;; Update footnotes definitions list with definitions in parse tree.
1652 ;; This is required since buffer expansion might have modified
1653 ;; boundaries of footnote definitions contained in the parse tree.
1654 ;; This way, definitions in `footnote-definition-alist' are bound to
1655 ;; match those in the parse tree.
1658 data 'footnote-definition
1662 defs)))
1664 ;; Properties order doesn't matter: get the rest of the tree
1665 ;; properties.
1667 `(:target-list
1676 info))
1679 "Return minimum exportable headline's level in DATA.
1680 DATA is parsed tree as returned by `org-element-parse-buffer'.
1681 OPTIONS is a plist holding export options."
1692 ;; If no headline was found, for the sake of consistency, set
1693 ;; minimum level to 1 nonetheless.
1697 "Return numbering of all exportable headlines in a parse tree.
1699 DATA is the parse tree. OPTIONS is the plist holding export
1700 options.
1702 Return an alist whose key is an headline and value is its
1703 associated numbering \(in the shape of a list of numbers\)."
1706 data
1707 'headline
1712 headline
1714 for idx from 0 to org-export-max-depth
1718 options)))
1721 "Return list of elements and objects to ignore during export.
1722 DATA is the parse tree to traverse. OPTIONS is the plist holding
1723 export options."
1725 walk-data
1726 ;; First find trees containing a select tag, if any.
1730 ;; Collect ignored elements or objects into IGNORE-LIST.
1736 ;; If headline is archived but tree below has
1737 ;; to be skipped, add it to ignore list.
1740 ;; Move into secondary string, if any.
1745 ;; Move into recursive objects/elements.
1747 ;; Main call.
1749 ;; Return value.
1750 ignore))
1753 "Return list of headlines containing a select tag in their tree.
1754 DATA is parsed data as returned by `org-element-parse-buffer'.
1755 INFO is a plist holding export options."
1757 walk-data ; for byte-compiler.
1768 ;; When a select tag is found, mark full
1769 ;; genealogy and every headline within the tree
1770 ;; as acceptable.
1773 genealogy
1775 selected-trees))
1776 ;; Else, continue searching in tree, recursively.
1783 "Non-nil when element or object BLOB should be skipped during export.
1784 OPTIONS is the plist holding export options. SELECTED, when
1785 non-nil, is a list of headlines belonging to a tree with a select
1786 tag."
1801 ;; Ignore subtrees with an exclude tag.
1804 ;; When a select tag is present in the buffer, ignore any tree
1805 ;; without it.
1807 ;; Ignore commented sub-trees.
1809 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1811 ;; Ignore tasks, if specified by `:with-tasks' property.
1827 ;; No timestamp allowed.
1829 ;; Only active timestamps allowed and the current one isn't
1830 ;; active.
1834 ;; Only inactive timestamps allowed and the current one isn't
1835 ;; inactive.
1841 \f
1842 ;;; The Transcoder
1843 ;;
1844 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1845 ;; `org-element-parse-buffer') and transcodes it into a specified
1846 ;; back-end output. It takes care of filtering out elements or
1847 ;; objects according to export options and organizing the output blank
1848 ;; lines and white space are preserved. The function memoizes its
1849 ;; results, so it is cheap to call it within translators.
1850 ;;
1851 ;; Internally, three functions handle the filtering of objects and
1852 ;; elements during the export. In particular,
1853 ;; `org-export-ignore-element' marks an element or object so future
1854 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1855 ;; elements or objects should be seen as real Org syntax and
1856 ;; `org-export-expand' transforms the others back into their original
1857 ;; shape
1858 ;;
1859 ;; `org-export-transcoder' is an accessor returning appropriate
1860 ;; translator function for a given element or object.
1863 "Return appropriate transcoder for BLOB.
1864 INFO is a plist containing export directives."
1866 ;; Return contents only for complete parse trees.
1872 "Convert DATA into current back-end format.
1874 DATA is a parse tree, an element or an object or a secondary
1875 string. INFO is a plist holding export options.
1877 Return transcoded string."
1883 ;; Ignored element/object.
1885 ;; Plain text.
1891 info))
1892 ;; Uninterpreted element/object: change it back to Org
1893 ;; syntax and export again resulting raw string.
1897 data
1901 info))
1902 ;; Secondary string.
1905 ;; Element/Object without contents or, as a special case,
1906 ;; headline with archive tag and archived trees restricted
1907 ;; to title only.
1915 ;; Element/Object with contents.
1928 ;; Elements directly containing objects
1929 ;; must have their indentation normalized
1930 ;; first.
1932 data
1933 ;; When normalizing contents of the first
1934 ;; paragraph in an item or a footnote
1935 ;; definition, ignore first line's
1936 ;; indentation: there is none and it
1937 ;; might be misleading.
1942 data)
1949 info))))))))
1950 ;; Final result will be memoized before being returned.
1952 data
1956 ;; Append the same white space between elements or objects as in
1957 ;; the original buffer, and call appropriate filters.
1968 info)))
1969 results)))
1973 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1974 Check is done according to export options INFO, stored as
1975 a plist."
1977 ;; ... entities...
1979 ;; ... emphasis...
1981 ;; ... fixed-width areas.
1983 ;; ... footnotes...
1986 ;; ... sub/superscripts...
1992 ;; ... tables...
1997 "Expand a parsed element or object to its original state.
1998 BLOB is either an element or an object. CONTENTS is its
1999 contents, as a string or nil."
2002 blob contents))
2005 "Add ELEMENT to `:ignore-list' in INFO.
2007 Any element in `:ignore-list' will be skipped when using
2008 `org-element-map'. INFO is modified by side effects."
2012 \f
2013 ;;; The Filter System
2014 ;;
2015 ;; Filters allow end-users to tweak easily the transcoded output.
2016 ;; They are the functional counterpart of hooks, as every filter in
2017 ;; a set is applied to the return value of the previous one.
2018 ;;
2019 ;; Every set is back-end agnostic. Although, a filter is always
2020 ;; called, in addition to the string it applies to, with the back-end
2021 ;; used as argument, so it's easy for the end-user to add back-end
2022 ;; specific filters in the set. The communication channel, as
2023 ;; a plist, is required as the third argument.
2024 ;;
2025 ;; From the developer side, filters sets can be installed in the
2026 ;; process with the help of `org-export-define-backend', which
2027 ;; internally sets `org-BACKEND-filters-alist' variable. Each
2028 ;; association has a key among the following symbols and a function or
2029 ;; a list of functions as value.
2030 ;;
2031 ;; - `:filter-parse-tree' applies directly on the complete parsed
2032 ;; tree. It's the only filters set that doesn't apply to a string.
2033 ;; Users can set it through `org-export-filter-parse-tree-functions'
2034 ;; variable.
2035 ;;
2036 ;; - `:filter-final-output' applies to the final transcoded string.
2037 ;; Users can set it with `org-export-filter-final-output-functions'
2038 ;; variable
2039 ;;
2040 ;; - `:filter-plain-text' applies to any string not recognized as Org
2041 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2042 ;; configure it.
2043 ;;
2044 ;; - `:filter-TYPE' applies on the string returned after an element or
2045 ;; object of type TYPE has been transcoded. An user can modify
2046 ;; `org-export-filter-TYPE-functions'
2047 ;;
2048 ;; All filters sets are applied with
2049 ;; `org-export-filter-apply-functions' function. Filters in a set are
2050 ;; applied in a LIFO fashion. It allows developers to be sure that
2051 ;; their filters will be applied first.
2052 ;;
2053 ;; Filters properties are installed in communication channel with
2054 ;; `org-export-install-filters' function.
2055 ;;
2056 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
2057 ;; before parsing to allow for heavy structure modifications.
2060 ;;;; Before Parsing Hook
2063 "Hook run before parsing an export buffer.
2065 This is run after include keywords have been expanded and Babel
2066 code executed, on a copy of original buffer's area being
2067 exported. Visibility is the same as in the original one. Point
2068 is left at the beginning of the new one.
2070 Every function in this hook will be called with one argument: the
2074 ;;;; Special Filters
2077 "List of functions applied to the parsed tree.
2078 Each filter is called with three arguments: the parse tree, as
2079 returned by `org-element-parse-buffer', the back-end, as
2080 a symbol, and the communication channel, as a plist. It must
2084 "List of functions applied to the transcoded string.
2085 Each filter is called with three arguments: the full transcoded
2086 string, the back-end, as a symbol, and the communication channel,
2087 as a plist. It must return a string that will be used as the
2091 "List of functions applied to plain text.
2092 Each filter is called with three arguments: a string which
2093 contains no Org syntax, the back-end, as a symbol, and the
2094 communication channel, as a plist. It must return a string or
2098 ;;;; Elements Filters
2101 "List of functions applied to a transcoded babel-call.
2102 Each filter is called with three arguments: the transcoded data,
2103 as a string, the back-end, as a symbol, and the communication
2107 "List of functions applied to a transcoded center block.
2108 Each filter is called with three arguments: the transcoded data,
2109 as a string, the back-end, as a symbol, and the communication
2113 "List of functions applied to a transcoded clock.
2114 Each filter is called with three arguments: the transcoded data,
2115 as a string, the back-end, as a symbol, and the communication
2119 "List of functions applied to a transcoded comment.
2120 Each filter is called with three arguments: the transcoded data,
2121 as a string, the back-end, as a symbol, and the communication
2125 "List of functions applied to a transcoded comment-comment.
2126 Each filter is called with three arguments: the transcoded data,
2127 as a string, the back-end, as a symbol, and the communication
2131 "List of functions applied to a transcoded drawer.
2132 Each filter is called with three arguments: the transcoded data,
2133 as a string, the back-end, as a symbol, and the communication
2137 "List of functions applied to a transcoded dynamic-block.
2138 Each filter is called with three arguments: the transcoded data,
2139 as a string, the back-end, as a symbol, and the communication
2143 "List of functions applied to a transcoded example-block.
2144 Each filter is called with three arguments: the transcoded data,
2145 as a string, the back-end, as a symbol, and the communication
2149 "List of functions applied to a transcoded export-block.
2150 Each filter is called with three arguments: the transcoded data,
2151 as a string, the back-end, as a symbol, and the communication
2155 "List of functions applied to a transcoded fixed-width.
2156 Each filter is called with three arguments: the transcoded data,
2157 as a string, the back-end, as a symbol, and the communication
2161 "List of functions applied to a transcoded footnote-definition.
2162 Each filter is called with three arguments: the transcoded data,
2163 as a string, the back-end, as a symbol, and the communication
2167 "List of functions applied to a transcoded headline.
2168 Each filter is called with three arguments: the transcoded data,
2169 as a string, the back-end, as a symbol, and the communication
2173 "List of functions applied to a transcoded horizontal-rule.
2174 Each filter is called with three arguments: the transcoded data,
2175 as a string, the back-end, as a symbol, and the communication
2179 "List of functions applied to a transcoded inlinetask.
2180 Each filter is called with three arguments: the transcoded data,
2181 as a string, the back-end, as a symbol, and the communication
2185 "List of functions applied to a transcoded item.
2186 Each filter is called with three arguments: the transcoded data,
2187 as a string, the back-end, as a symbol, and the communication
2191 "List of functions applied to a transcoded keyword.
2192 Each filter is called with three arguments: the transcoded data,
2193 as a string, the back-end, as a symbol, and the communication
2197 "List of functions applied to a transcoded latex-environment.
2198 Each filter is called with three arguments: the transcoded data,
2199 as a string, the back-end, as a symbol, and the communication
2203 "List of functions applied to a transcoded node-property.
2204 Each filter is called with three arguments: the transcoded data,
2205 as a string, the back-end, as a symbol, and the communication
2209 "List of functions applied to a transcoded paragraph.
2210 Each filter is called with three arguments: the transcoded data,
2211 as a string, the back-end, as a symbol, and the communication
2215 "List of functions applied to a transcoded plain-list.
2216 Each filter is called with three arguments: the transcoded data,
2217 as a string, the back-end, as a symbol, and the communication
2221 "List of functions applied to a transcoded planning.
2222 Each filter is called with three arguments: the transcoded data,
2223 as a string, the back-end, as a symbol, and the communication
2227 "List of functions applied to a transcoded property-drawer.
2228 Each filter is called with three arguments: the transcoded data,
2229 as a string, the back-end, as a symbol, and the communication
2233 "List of functions applied to a transcoded quote block.
2234 Each filter is called with three arguments: the transcoded quote
2235 data, as a string, the back-end, as a symbol, and the
2236 communication channel, as a plist. It must return a string or
2240 "List of functions applied to a transcoded quote-section.
2241 Each filter is called with three arguments: the transcoded data,
2242 as a string, the back-end, as a symbol, and the communication
2246 "List of functions applied to a transcoded section.
2247 Each filter is called with three arguments: the transcoded data,
2248 as a string, the back-end, as a symbol, and the communication
2252 "List of functions applied to a transcoded special block.
2253 Each filter is called with three arguments: the transcoded data,
2254 as a string, the back-end, as a symbol, and the communication
2258 "List of functions applied to a transcoded src-block.
2259 Each filter is called with three arguments: the transcoded data,
2260 as a string, the back-end, as a symbol, and the communication
2264 "List of functions applied to a transcoded table.
2265 Each filter is called with three arguments: the transcoded data,
2266 as a string, the back-end, as a symbol, and the communication
2270 "List of functions applied to a transcoded table-cell.
2271 Each filter is called with three arguments: the transcoded data,
2272 as a string, the back-end, as a symbol, and the communication
2276 "List of functions applied to a transcoded table-row.
2277 Each filter is called with three arguments: the transcoded data,
2278 as a string, the back-end, as a symbol, and the communication
2282 "List of functions applied to a transcoded verse block.
2283 Each filter is called with three arguments: the transcoded data,
2284 as a string, the back-end, as a symbol, and the communication
2288 ;;;; Objects Filters
2291 "List of functions applied to transcoded bold text.
2292 Each filter is called with three arguments: the transcoded data,
2293 as a string, the back-end, as a symbol, and the communication
2297 "List of functions applied to transcoded code text.
2298 Each filter is called with three arguments: the transcoded data,
2299 as a string, the back-end, as a symbol, and the communication
2303 "List of functions applied to a transcoded entity.
2304 Each filter is called with three arguments: the transcoded data,
2305 as a string, the back-end, as a symbol, and the communication
2309 "List of functions applied to a transcoded export-snippet.
2310 Each filter is called with three arguments: the transcoded data,
2311 as a string, the back-end, as a symbol, and the communication
2315 "List of functions applied to a transcoded footnote-reference.
2316 Each filter is called with three arguments: the transcoded data,
2317 as a string, the back-end, as a symbol, and the communication
2321 "List of functions applied to a transcoded inline-babel-call.
2322 Each filter is called with three arguments: the transcoded data,
2323 as a string, the back-end, as a symbol, and the communication
2327 "List of functions applied to a transcoded inline-src-block.
2328 Each filter is called with three arguments: the transcoded data,
2329 as a string, the back-end, as a symbol, and the communication
2333 "List of functions applied to transcoded italic text.
2334 Each filter is called with three arguments: the transcoded data,
2335 as a string, the back-end, as a symbol, and the communication
2339 "List of functions applied to a transcoded latex-fragment.
2340 Each filter is called with three arguments: the transcoded data,
2341 as a string, the back-end, as a symbol, and the communication
2345 "List of functions applied to a transcoded line-break.
2346 Each filter is called with three arguments: the transcoded data,
2347 as a string, the back-end, as a symbol, and the communication
2351 "List of functions applied to a transcoded link.
2352 Each filter is called with three arguments: the transcoded data,
2353 as a string, the back-end, as a symbol, and the communication
2357 "List of functions applied to a transcoded macro.
2358 Each filter is called with three arguments: the transcoded data,
2359 as a string, the back-end, as a symbol, and the communication
2363 "List of functions applied to a transcoded radio-target.
2364 Each filter is called with three arguments: the transcoded data,
2365 as a string, the back-end, as a symbol, and the communication
2369 "List of functions applied to a transcoded statistics-cookie.
2370 Each filter is called with three arguments: the transcoded data,
2371 as a string, the back-end, as a symbol, and the communication
2375 "List of functions applied to transcoded strike-through text.
2376 Each filter is called with three arguments: the transcoded data,
2377 as a string, the back-end, as a symbol, and the communication
2381 "List of functions applied to a transcoded subscript.
2382 Each filter is called with three arguments: the transcoded data,
2383 as a string, the back-end, as a symbol, and the communication
2387 "List of functions applied to a transcoded superscript.
2388 Each filter is called with three arguments: the transcoded data,
2389 as a string, the back-end, as a symbol, and the communication
2393 "List of functions applied to a transcoded target.
2394 Each filter is called with three arguments: the transcoded data,
2395 as a string, the back-end, as a symbol, and the communication
2399 "List of functions applied to a transcoded timestamp.
2400 Each filter is called with three arguments: the transcoded data,
2401 as a string, the back-end, as a symbol, and the communication
2405 "List of functions applied to transcoded underline text.
2406 Each filter is called with three arguments: the transcoded data,
2407 as a string, the back-end, as a symbol, and the communication
2411 "List of functions applied to transcoded verbatim text.
2412 Each filter is called with three arguments: the transcoded data,
2413 as a string, the back-end, as a symbol, and the communication
2417 ;;;; Filters Tools
2418 ;;
2419 ;; Internal function `org-export-install-filters' installs filters
2420 ;; hard-coded in back-ends (developer filters) and filters from global
2421 ;; variables (user filters) in the communication channel.
2422 ;;
2423 ;; Internal function `org-export-filter-apply-functions' takes care
2424 ;; about applying each filter in order to a given data. It ignores
2425 ;; filters returning a nil value but stops whenever a filter returns
2426 ;; an empty string.
2429 "Call every function in FILTERS.
2431 Functions are called with arguments VALUE, current export
2432 back-end and INFO. A function returning a nil value will be
2433 skipped. If it returns the empty string, the process ends and
2434 VALUE is ignored.
2436 Call is done in a LIFO fashion, to be sure that developer
2437 specified filters, if any, are called first."
2446 "Install filters properties in communication channel.
2448 INFO is a plist containing the current communication channel.
2450 Return the updated communication channel."
2452 ;; Install user defined filters with `org-export-filters-alist'.
2455 org-export-filters-alist)
2456 ;; Prepend back-end specific filters to that list.
2461 ;; Single values get consed, lists are prepended.
2466 plist key
2470 ;; Return new communication channel.
2474 \f
2475 ;;; Core functions
2476 ;;
2477 ;; This is the room for the main function, `org-export-as', along with
2478 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2479 ;; They differ only by the way they output the resulting code.
2480 ;;
2481 ;; `org-export-output-file-name' is an auxiliary function meant to be
2482 ;; used with `org-export-to-file'. With a given extension, it tries
2483 ;; to provide a canonical file name to write export output to.
2484 ;;
2485 ;; Note that `org-export-as' doesn't really parse the current buffer,
2486 ;; but a copy of it (with the same buffer-local variables and
2487 ;; visibility), where macros and include keywords are expanded and
2488 ;; Babel blocks are executed, if appropriate.
2489 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2490 ;;
2491 ;; File inclusion is taken care of by
2492 ;; `org-export-expand-include-keyword' and
2493 ;; `org-export--prepare-file-contents'. Structure wise, including
2494 ;; a whole Org file in a buffer often makes little sense. For
2495 ;; example, if the file contains an headline and the include keyword
2496 ;; was within an item, the item should contain the headline. That's
2497 ;; why file inclusion should be done before any structure can be
2498 ;; associated to the file, that is before parsing.
2499 ;;
2500 ;; Macro are expanded with `org-export-expand-macro'.
2504 "Transcode current Org buffer into BACKEND code.
2506 If narrowing is active in the current buffer, only transcode its
2507 narrowed part.
2509 If a region is active, transcode that region.
2511 When optional argument SUBTREEP is non-nil, transcode the
2512 sub-tree at point, extracting information from the headline
2513 properties first.
2515 When optional argument VISIBLE-ONLY is non-nil, don't export
2516 contents of hidden elements.
2518 When optional argument BODY-ONLY is non-nil, only return body
2519 code, without preamble nor postamble.
2521 Optional argument EXT-PLIST, when provided, is a property list
2522 with external parameters overriding Org default settings, but
2523 still inferior to file-local settings.
2525 Optional argument NOEXPAND, when non-nil, prevents included files
2526 to be expanded and Babel code to be executed.
2528 Return code as a string."
2529 ;; Barf if BACKEND isn't registered.
2533 ;; Narrow buffer to an appropriate region or subtree for
2534 ;; parsing. If parsing subtree, be sure to remove main headline
2535 ;; too.
2543 ;; 1. Get export environment from original buffer. Also install
2544 ;; user's and developer's filters.
2547 ;; 2. Get parse tree. Buffer isn't parsed directly.
2548 ;; Instead, a temporary copy is created, where macros
2549 ;; and include keywords are expanded and code blocks
2550 ;; are evaluated.
2557 ;; TODO: Setting `org-current-export-file' is
2558 ;; required by Org Babel to properly resolve
2559 ;; noweb references. Once "org-exp.el" is
2560 ;; removed, modify
2561 ;; `org-export-blocks-preprocess' so it
2562 ;; accepts the value as an argument instead.
2566 ;; Run hook
2567 ;; `org-export-before-parsing-hook'. with current
2568 ;; back-end as argument.
2571 ;; Eventually parse buffer.
2573 ;; 3. Call parse-tree filters to get the final tree.
2577 ;; 4. Now tree is complete, compute its properties and add
2578 ;; them to communication channel.
2582 ;; 5. Eventually transcode TREE. Wrap the resulting string
2583 ;; into a template, if required. Eventually call
2584 ;; final-output filter.
2592 info)))
2593 ;; Maybe add final OUTPUT to kill ring, then return it.
2595 output)))))
2599 "Call `org-export-as' with output to a specified buffer.
2601 BACKEND is the back-end used for transcoding, as a symbol.
2603 BUFFER is the output buffer. If it already exists, it will be
2604 erased first, otherwise, it will be created.
2606 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2607 and NOEXPAND are similar to those used in `org-export-as', which
2608 see.
2610 Return buffer."
2612 backend subtreep visible-only body-only ext-plist noexpand))
2618 buffer))
2622 "Call `org-export-as' with output to a specified file.
2624 BACKEND is the back-end used for transcoding, as a symbol. FILE
2625 is the name of the output file, as a string.
2627 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2628 and NOEXPAND are similar to those used in `org-export-as', which
2629 see.
2631 Return output file's name."
2632 ;; Checks for FILE permissions. `write-file' would do the same, but
2633 ;; we'd rather avoid needless transcoding of parse tree.
2635 ;; Insert contents to a temporary buffer and write it to FILE.
2637 backend subtreep visible-only body-only ext-plist noexpand)))
2642 ;; Return full path.
2643 file)
2646 "Return output file's name according to buffer specifications.
2648 EXTENSION is a string representing the output file extension,
2649 with the leading dot.
2651 With a non-nil optional argument SUBTREEP, try to determine
2653 of subtree at point.
2655 When optional argument PUB-DIR is set, use it as the publishing
2656 directory.
2658 When optional argument VISIBLE-ONLY is non-nil, don't export
2659 contents of hidden elements.
2661 Return file name as a string, or nil if it couldn't be
2662 determined."
2664 ;; File name may come from EXPORT_FILE_NAME subtree property,
2665 ;; assuming point is at beginning of said sub-tree.
2672 ;; File name may be extracted from buffer's associated
2673 ;; file, if any.
2675 ;; Can't determine file name on our own: Ask user.
2679 "Output file: " pub-dir nil nil nil
2682 ;; Build file name. Enforce EXTENSION over whatever user may have
2683 ;; come up with. PUB-DIR, if defined, always has precedence over
2684 ;; any provided path.
2689 extension))
2695 "Apply BODY in a copy of the current buffer.
2697 The copy preserves local variables and visibility of the original
2698 buffer.
2700 Point is at buffer's beginning when BODY is applied."
2710 ,original-buffer
2715 ov
2725 "Expand every macro in buffer.
2726 INFO is a plist containing export options and buffer properties."
2728 ;; Before expanding macros, install {{{author}}}, {{{date}}},
2729 ;; {{{email}}} and {{{title}}} templates.
2735 ;; EMAIL is not a parsed keyword: store it as-is.
2739 org-macro-templates)))
2742 "Expand every include keyword in buffer.
2743 Optional argument INCLUDED is a list of included file names along
2744 with their line restriction, when appropriate. It is used to
2745 avoid infinite recursion. Optional argument DIR is the current
2746 working directory. It is used to properly resolve relative
2747 paths."
2754 ;; Extract arguments from keyword's value.
2768 ;; Minimal level of included file defaults to the child
2769 ;; level of the current headline, if any, or one. It
2770 ;; only applies is the file is meant to be included as
2771 ;; an Org one.
2779 ;; Remove keyword.
2783 ;; Check if files has already been parsed. Look after
2784 ;; inclusion lines too, as different parts of the same file
2785 ;; can be included too.
2797 ind-str contents ind-str))))
2805 ind-str env contents ind-str))))
2818 "Prepare the contents of FILE for inclusion and return them as a string.
2820 When optional argument LINES is a string specifying a range of
2821 lines, include only those lines.
2823 Optional argument IND, when non-nil, is an integer specifying the
2824 global indentation of returned contents. Since its purpose is to
2825 allow an included file to stay in the same environment it was
2826 created \(i.e. a list item), it doesn't apply past the first
2827 headline encountered.
2829 Optional argument MINLEVEL, when non-nil, is an integer
2830 specifying the level that any top-level headline in the included
2831 file should have."
2847 ;; Remove blank lines at beginning and end of contents. The logic
2848 ;; behind that removal is that blank lines around include keyword
2849 ;; override blank lines in included file.
2858 ;; If IND is set, preserve indentation of include keyword until
2859 ;; the first headline encountered.
2865 ;; Do not move footnote definitions out of column 0.
2871 ;; When MINLEVEL is specified, compute minimal level for headlines
2872 ;; in the file (CUR-MIN), and remove stars to each headline so
2873 ;; that headlines with minimal level have a level of MINLEVEL.
2882 ;; Only change stars, don't bother moving whole
2883 ;; sections.
2889 \f
2890 ;;; Tools For Back-Ends
2891 ;;
2892 ;; A whole set of tools is available to help build new exporters. Any
2893 ;; function general enough to have its use across many back-ends
2894 ;; should be added here.
2896 ;;;; For Affiliated Keywords
2897 ;;
2898 ;; `org-export-read-attribute' reads a property from a given element
2899 ;; as a plist. It can be used to normalize affiliated keywords'
2900 ;; syntax.
2901 ;;
2902 ;; Since captions can span over multiple lines and accept dual values,
2903 ;; their internal representation is a bit tricky. Therefore,
2904 ;; `org-export-get-caption' transparently returns a given element's
2905 ;; caption as a secondary string.
2908 "Turn ATTRIBUTE property from ELEMENT into a plist.
2910 When optional argument PROPERTY is non-nil, return the value of
2911 that property within attributes.
2915 properties."
2923 "Return caption from ELEMENT as a secondary string.
2925 When optional argument SHORTP is non-nil, return short caption,
2926 as a secondary string, instead.
2928 Caption lines are separated by a white space."
2936 ;;;; For Export Snippets
2937 ;;
2938 ;; Every export snippet is transmitted to the back-end. Though, the
2939 ;; latter will only retain one type of export-snippet, ignoring
2940 ;; others, based on the former's target back-end. The function
2941 ;; `org-export-snippet-backend' returns that back-end for a given
2942 ;; export-snippet.
2945 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2946 Translation, with `org-export-snippet-translation-alist', is
2947 applied."
2951 back-end))))
2954 ;;;; For Footnotes
2955 ;;
2956 ;; `org-export-collect-footnote-definitions' is a tool to list
2957 ;; actually used footnotes definitions in the whole parse tree, or in
2958 ;; an headline, in order to add footnote listings throughout the
2959 ;; transcoded data.
2960 ;;
2961 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2962 ;; back-ends, when they need to attach the footnote definition only to
2963 ;; the first occurrence of the corresponding label.
2964 ;;
2965 ;; `org-export-get-footnote-definition' and
2966 ;; `org-export-get-footnote-number' provide easier access to
2967 ;; additional information relative to a footnote reference.
2970 "Return an alist between footnote numbers, labels and definitions.
2972 DATA is the parse tree from which definitions are collected.
2973 INFO is the plist used as a communication channel.
2975 Definitions are sorted by order of references. They either
2976 appear as Org data or as a secondary string for inlined
2977 footnotes. Unreferenced definitions are ignored."
2979 collect-fn ; for byte-compiler.
2983 ;; Collect footnote number, label and definition in DATA.
2985 data 'footnote-reference
2992 def)
2993 num-alist)
2994 ;; Also search in definition for nested footnotes.
2997 ;; Don't enter footnote definitions since it will happen
2998 ;; when their first reference is found.
3004 "Non-nil when a footnote reference is the first one for its label.
3006 FOOTNOTE-REFERENCE is the footnote reference being considered.
3007 INFO is the plist used as a communication channel."
3009 ;; Anonymous footnotes are always a first reference.
3011 ;; Otherwise, return the first footnote with the same LABEL and
3012 ;; test if it is equal to FOOTNOTE-REFERENCE.
3018 data 'footnote-reference
3023 ;; If FN isn't inlined, be sure to traverse its
3024 ;; definition before resuming search. See
3025 ;; comments in `org-export-get-footnote-number'
3026 ;; for more information.
3030 ;; Don't enter footnote definitions since it will
3031 ;; happen when their first reference is found.
3034 footnote-reference)))))
3037 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3038 INFO is the plist used as a communication channel."
3044 "Return number associated to a footnote.
3046 FOOTNOTE is either a footnote reference or a footnote definition.
3047 INFO is the plist used as a communication channel."
3049 seen-refs
3050 search-ref ; For byte-compiler.
3054 ;; Search footnote references through DATA, filling
3055 ;; SEEN-REFS along the way.
3057 data 'footnote-reference
3061 ;; Anonymous footnote match: return number.
3064 ;; Labels match: return number.
3067 ;; Anonymous footnote: it's always a new one. Also,
3068 ;; be sure to return nil from the `cond' so
3069 ;; `first-match' doesn't get us out of the loop.
3071 ;; Label not seen so far: add it so SEEN-REFS.
3072 ;;
3073 ;; Also search for subsequent references in
3074 ;; footnote definition so numbering follows reading
3075 ;; logic. Note that we don't have to care about
3076 ;; inline definitions, since `org-element-map'
3077 ;; already traverses them at the right time.
3078 ;;
3079 ;; Once again, return nil to stay in the loop.
3084 nil))))
3085 ;; Don't enter footnote definitions since it will happen
3086 ;; when their first reference is found.
3091 ;;;; For Headlines
3092 ;;
3093 ;; `org-export-get-relative-level' is a shortcut to get headline
3094 ;; level, relatively to the lower headline level in the parsed tree.
3095 ;;
3096 ;; `org-export-get-headline-number' returns the section number of an
3097 ;; headline, while `org-export-number-to-roman' allows to convert it
3098 ;; to roman numbers.
3099 ;;
3100 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3101 ;; `org-export-last-sibling-p' are three useful predicates when it
3102 ;; comes to fulfill the `:headline-levels' property.
3105 "Return HEADLINE relative level within current parsed tree.
3106 INFO is a plist holding contextual information."
3111 "Non-nil when HEADLINE is considered as low level.
3113 INFO is a plist used as a communication channel.
3115 A low level headlines has a relative level greater than
3116 `:headline-levels' property value.
3118 Return value is the difference between HEADLINE relative level
3119 and the last level being considered as high enough, or nil."
3126 "Return HEADLINE numbering as a list of numbers.
3127 INFO is a plist holding contextual information."
3131 "Return a non-nil value if HEADLINE element should be numbered.
3132 INFO is a plist used as a communication channel."
3138 "Convert integer N into a roman numeral."
3151 res)))
3154 "Return list of tags associated to ELEMENT.
3156 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3157 is a plist used as a communication channel.
3159 Select tags (see `org-export-select-tags') and exclude tags (see
3160 `org-export-exclude-tags') are removed from the list.
3162 When non-nil, optional argument TAGS should be a list of strings.
3163 Any tag belonging to this list will also be removed."
3170 "Return node PROPERTY value for BLOB.
3172 PROPERTY is normalized symbol (i.e. `:cookie-data'). BLOB is an
3173 element or object.
3175 If optional argument INHERITED is non-nil, the value can be
3176 inherited from a parent headline.
3178 Return value is a string or nil."
3190 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3191 INFO is a plist used as a communication channel."
3196 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3197 INFO is a plist used as a communication channel."
3201 ;;;; For Links
3202 ;;
3203 ;; `org-export-solidify-link-text' turns a string into a safer version
3204 ;; for links, replacing most non-standard characters with hyphens.
3205 ;;
3206 ;; `org-export-get-coderef-format' returns an appropriate format
3207 ;; string for coderefs.
3208 ;;
3209 ;; `org-export-inline-image-p' returns a non-nil value when the link
3210 ;; provided should be considered as an inline image.
3211 ;;
3212 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3213 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3214 ;; returns an appropriate unique identifier when found, or nil.
3215 ;;
3216 ;; `org-export-resolve-id-link' returns the first headline with
3217 ;; specified id or custom-id in parse tree, the path to the external
3218 ;; file with the id or nil when neither was found.
3219 ;;
3220 ;; `org-export-resolve-coderef' associates a reference to a line
3221 ;; number in the element it belongs, or returns the reference itself
3222 ;; when the element isn't numbered.
3225 "Take link text S and make a safe target out of it."
3230 "Return format string for code reference link.
3231 PATH is the link path. DESC is its description."
3239 "Non-nil if LINK object points to an inline image.
3241 Optional argument is a set of RULES defining inline images. It
3242 is an alist where associations have the following shape:
3244 \(TYPE . REGEXP)
3246 Applying a rule means apply REGEXP against LINK's path when its
3247 type is TYPE. The function will return a non-nil value if any of
3248 the provided rules is non-nil. The default rule is
3249 `org-export-default-inline-image-rule'.
3251 This only applies to links without a description."
3262 rules)
3263 ;; Return nil if no rule matched.
3264 nil))))
3267 "Resolve a code reference REF.
3269 INFO is a plist used as a communication channel.
3271 Return associated line number in source code, or REF itself,
3272 depending on src-block or example element's switches."
3280 org-coderef-label-format)))
3284 ;; Element containing REF is found. Resolve it to either
3285 ;; a label or a line number, as needed.
3295 "Return LINK destination.
3297 INFO is a plist holding contextual information.
3299 Return value can be an object, an element, or nil:
3301 - If LINK path matches a target object (i.e. <<path>>) or
3304 - If LINK path exactly matches the name affiliated keyword
3305 \(i.e. #+NAME: path) of an element, return that element.
3307 - If LINK path exactly matches any headline name, return that
3308 element. If more than one headline share that name, priority
3309 will be given to the one with the closest common ancestor, if
3310 any, or the first one in the parse tree otherwise.
3312 - Otherwise, return nil.
3318 ;; First try to find a matching "<<path>>" unless user specified
3319 ;; he was looking for an headline (path starts with a *
3320 ;; character).
3324 return target)))
3325 ;; Then try to find an element with a matching "#+NAME: path"
3326 ;; affiliated keyword.
3333 ;; Last case: link either points to an headline or to
3334 ;; nothingness. Try to find the source, with priority given to
3335 ;; headlines with the closest common ancestor. If such candidate
3336 ;; is found, return it, otherwise return nil.
3340 ;; Return first headline whose `:raw-value' property
3341 ;; is NAME in parse tree DATA, or nil.
3344 data 'headline
3348 name)
3349 headline))
3351 ;; Search among headlines sharing an ancestor with link,
3352 ;; from closest to farthest.
3360 ;; No match with a common ancestor: try the full parse-tree.
3366 "Return headline referenced as LINK destination.
3368 INFO is a plist used as a communication channel.
3370 Return value can be the headline element matched in current parse
3374 ;; First check if id is within the current parse tree.
3380 headline))
3382 ;; Otherwise, look for external files.
3386 "Return radio-target object referenced as LINK destination.
3388 INFO is a plist used as a communication channel.
3390 Return value can be a radio-target object or nil. Assume LINK
3400 ;;;; For References
3401 ;;
3402 ;; `org-export-get-ordinal' associates a sequence number to any object
3403 ;; or element.
3406 "Return ordinal number of an element or object.
3408 ELEMENT is the element or object considered. INFO is the plist
3409 used as a communication channel.
3411 Optional argument TYPES, when non-nil, is a list of element or
3412 object types, as symbols, that should also be counted in.
3413 Otherwise, only provided element's type is considered.
3415 Optional argument PREDICATE is a function returning a non-nil
3416 value if the current element or object should be counted in. It
3417 accepts two arguments: the element or object being considered and
3418 the plist used as a communication channel. This allows to count
3419 only a certain type of objects (i.e. inline images).
3421 Return value is a list of numbers if ELEMENT is an headline or an
3422 item. It is nil for keywords. It represents the footnote number
3423 for footnote definitions and footnote references. If ELEMENT is
3424 a target, return the same value as if ELEMENT was the closest
3425 table, item or headline containing the target. In any other
3426 case, return the sequence number of ELEMENT among elements or
3427 objects of the same type."
3428 ;; A target keyword, representing an invisible target, never has
3429 ;; a sequence number.
3431 ;; Ordinal of a target object refer to the ordinal of the closest
3432 ;; table, item, or headline containing the object.
3436 when
3440 table))
3441 return parent)))
3443 ;; Special case 1: An headline returns its number as a list.
3445 ;; Special case 2: An item returns its number as a list.
3449 struct
3456 ;; Increment counter until ELEMENT is found again.
3467 ;;;; For Src-Blocks
3468 ;;
3469 ;; `org-export-get-loc' counts number of code lines accumulated in
3470 ;; src-block or example-block elements with a "+n" switch until
3471 ;; a given element, excluded. Note: "-n" switches reset that count.
3472 ;;
3473 ;; `org-export-unravel-code' extracts source code (along with a code
3474 ;; references alist) from an `element-block' or `src-block' type
3475 ;; element.
3476 ;;
3477 ;; `org-export-format-code' applies a formatting function to each line
3478 ;; of code, providing relative line number and code reference when
3479 ;; appropriate. Since it doesn't access the original element from
3480 ;; which the source code is coming, it expects from the code calling
3481 ;; it to know if lines should be numbered and if code references
3482 ;; should appear.
3483 ;;
3484 ;; Eventually, `org-export-format-code-default' is a higher-level
3485 ;; function (it makes use of the two previous functions) which handles
3486 ;; line numbering and code references inclusion, and returns source
3487 ;; code in a format suitable for plain text or verbatim output.
3490 "Return accumulated lines of code up to ELEMENT.
3492 INFO is the plist used as a communication channel.
3494 ELEMENT is excluded from count."
3501 ;; ELEMENT is reached: Quit the loop.
3503 ;; Only count lines from src-block and example-block elements
3504 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3508 ;; Accumulate locs or reset them.
3512 ;; Return nil to stay in the loop.
3513 nil)))
3515 ;; Return value.
3516 loc))
3519 "Clean source code and extract references out of it.
3521 ELEMENT has either a `src-block' an `example-block' type.
3523 Return a cons cell whose CAR is the source code, cleaned from any
3524 reference and protective comma and CDR is an alist between
3525 relative line number (integer) and name of code reference on that
3526 line (string)."
3528 ;; Get code and clean it. Remove blank lines at its
3529 ;; beginning and end.
3535 ;; If appropriate, remove global indentation.
3538 c
3540 ;; Get format used for references.
3543 org-coderef-label-format)))
3544 ;; Build a regexp matching a loc with a reference.
3549 ;; Return value.
3551 ;; Code with references removed.
3557 ;; Ref line: remove ref, and signal its position in REFS.
3561 ;; Reference alist.
3562 refs)))
3565 "Format CODE by applying FUN line-wise and return it.
3567 CODE is a string representing the code to format. FUN is
3568 a function. It must accept three arguments: a line of
3569 code (string), the current line number (integer) or nil and the
3570 reference associated to the current line (string) or nil.
3572 Optional argument NUM-LINES can be an integer representing the
3573 number of code lines accumulated until the current code. Line
3574 numbers passed to FUN will take it into account. If it is nil,
3575 FUN's second argument will always be nil. This number can be
3576 obtained with `org-export-get-loc' function.
3578 Optional argument REF-ALIST can be an alist between relative line
3579 number (i.e. ignoring NUM-LINES) and the name of the code
3580 reference on it. If it is nil, FUN's third argument will always
3581 be nil. It can be obtained through the use of
3582 `org-export-unravel-code' function."
3594 "Return source code from ELEMENT, formatted in a standard way.
3596 ELEMENT is either a `src-block' or `example-block' element. INFO
3597 is a plist used as a communication channel.
3599 This function takes care of line numbering and code references
3600 inclusion. Line numbers, when applicable, appear at the
3601 beginning of the line, separated from the code by two white
3602 spaces. Code references, on the other hand, appear flushed to
3603 the right, separated by six white spaces from the widest line of
3604 code."
3605 ;; Extract code and references.
3611 ;; Handle line numbering.
3620 ;; Prepare references display, if required. Any reference
3621 ;; should start six columns after the widest line of code,
3622 ;; wrapped with parenthesis.
3627 code
3631 number-str
3632 loc
3638 num-start refs)))
3641 ;;;; For Tables
3642 ;;
3643 ;; `org-export-table-has-special-column-p' and and
3644 ;; `org-export-table-row-is-special-p' are predicates used to look for
3645 ;; meta-information about the table structure.
3646 ;;
3647 ;; `org-table-has-header-p' tells when the rows before the first rule
3648 ;; should be considered as table's header.
3649 ;;
3650 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3651 ;; and `org-export-table-cell-borders' extract information from
3652 ;; a table-cell element.
3653 ;;
3654 ;; `org-export-table-dimensions' gives the number on rows and columns
3655 ;; in the table, ignoring horizontal rules and special columns.
3656 ;; `org-export-table-cell-address', given a table-cell object, returns
3657 ;; the absolute address of a cell. On the other hand,
3658 ;; `org-export-get-table-cell-at' does the contrary.
3659 ;;
3660 ;; `org-export-table-cell-starts-colgroup-p',
3661 ;; `org-export-table-cell-ends-colgroup-p',
3662 ;; `org-export-table-row-starts-rowgroup-p',
3663 ;; `org-export-table-row-ends-rowgroup-p',
3664 ;; `org-export-table-row-starts-header-p' and
3665 ;; `org-export-table-row-ends-header-p' indicate position of current
3666 ;; row or cell within the table.
3669 "Non-nil when TABLE has a special column.
3670 All special columns will be ignored during export."
3671 ;; The table has a special column when every first cell of every row
3672 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3673 ;; "*" "_" and "^". Though, do not consider a first row containing
3674 ;; only empty cells as special.
3690 "Non-nil when TABLE has an header.
3692 INFO is a plist used as a communication channel.
3694 A table has an header when it contains at least two row groups."
3697 table 'table-row
3705 info)))
3708 "Non-nil if TABLE-ROW is considered special.
3710 INFO is a plist used as the communication channel.
3712 All special rows will be ignored during export."
3716 ;; A row is special either when...
3718 ;; ... it starts with a field only containing "/",
3720 ;; ... the table contains a special column and the row start
3721 ;; with a marking character among, "^", "_", "$" or "!",
3725 ;; ... it contains only alignment cookies and empty cells.
3731 ;; Since VALUE is a secondary string, the following
3732 ;; checks avoid expanding it with `org-export-data'.
3744 "Return TABLE-ROW's group.
3746 INFO is a plist used as the communication channel.
3748 Return value is the group number, as an integer, or nil special
3749 rows and table rules. Group 1 is also table's header."
3766 "Return TABLE-CELL contents width.
3768 INFO is a plist used as the communication channel.
3770 Return value is the width given by the last width cookie in the
3771 same column as TABLE-CELL, or nil."
3776 cookie-width)
3780 ;; In a special row, try to find a width cookie at COLUMN.
3784 ;; The following checks avoid expanding unnecessarily the
3785 ;; cell with `org-export-data'
3793 ;; Ignore table rules.
3796 ;; Return value.
3797 cookie-width))
3800 "Return TABLE-CELL contents alignment.
3802 INFO is a plist used as the communication channel.
3804 Return alignment as specified by the last alignment cookie in the
3805 same column as TABLE-CELL. If no such cookie is found, a default
3806 alignment value will be deduced from fraction of numbers in the
3807 column (see `org-table-number-fraction' for more information).
3808 Possible values are `left', `right' and `center'."
3815 cookie-align)
3819 ;; In a special row, try to find an alignment cookie at
3820 ;; COLUMN.
3824 ;; Since VALUE is a secondary string, the following checks
3825 ;; avoid useless expansion through `org-export-data'.
3833 ;; Ignore table rules.
3835 ;; In a standard row, check if cell's contents are expressing
3836 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3837 ;; Though, don't bother if an alignment cookie has already
3838 ;; defined cell's alignment.
3843 info)))
3848 ;; Return value. Alignment specified by cookies has precedence
3849 ;; over alignment deduced from cells contents.
3858 "Return TABLE-CELL borders.
3860 INFO is a plist used as a communication channel.
3862 Return value is a list of symbols, or nil. Possible values are:
3863 `top', `bottom', `above', `below', `left' and `right'. Note:
3864 `top' (resp. `bottom') only happen for a cell in the first
3865 row (resp. last row) of the table, ignoring table rules, if any.
3867 Returned borders ignore special rows."
3870 borders)
3871 ;; Top/above border? TABLE-CELL has a border above when a rule
3872 ;; used to demarcate row groups can be found above. Hence,
3873 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3874 ;; another regular row has to be found above that rule.
3883 ;; Look at every row before the current one.
3885 ;; No rule above, or rule found starts the table (ignoring any
3886 ;; special row): TABLE-CELL is at the top of the table.
3889 ;; Bottom/below border? TABLE-CELL has a border below when next
3890 ;; non-regular row below is a rule.
3899 ;; Look at every row after the current one.
3901 ;; No rule below, or rule found ends the table (modulo some
3902 ;; special row): TABLE-CELL is at the bottom of the table.
3905 ;; Right/left borders? They can only be specified by column
3906 ;; groups. Column groups are defined in a row starting with "/".
3907 ;; Also a column groups row only contains "<", "<>", ">" or blank
3908 ;; cells.
3925 ;; There's a left border when previous cell, if
3926 ;; any, ends a group, or current one starts one.
3932 ;; There's a right border when next cell, if any,
3933 ;; starts a group, or current one ends one.
3940 ;; Table rows are read in reverse order so last column groups
3941 ;; row has precedence over any previous one.
3943 ;; Return value.
3944 borders))
3947 "Non-nil when TABLE-CELL is at the beginning of a row group.
3948 INFO is a plist used as a communication channel."
3949 ;; A cell starts a column group either when it is at the beginning
3950 ;; of a row (or after the special column, if any) or when it has
3951 ;; a left border.
3955 table-cell)
3959 "Non-nil when TABLE-CELL is at the end of a row group.
3960 INFO is a plist used as a communication channel."
3961 ;; A cell ends a column group either when it is at the end of a row
3962 ;; or when it has a right border.
3965 table-cell)
3969 "Non-nil when TABLE-ROW is at the beginning of a column group.
3970 INFO is a plist used as a communication channel."
3978 "Non-nil when TABLE-ROW is at the end of a column group.
3979 INFO is a plist used as a communication channel."
3987 "Non-nil when TABLE-ROW is the first table header's row.
3988 INFO is a plist used as a communication channel."
3995 "Non-nil when TABLE-ROW is the last table header's row.
3996 INFO is a plist used as a communication channel."
4003 "Return TABLE dimensions.
4005 INFO is a plist used as a communication channel.
4007 Return value is a CONS like (ROWS . COLUMNS) where
4008 ROWS (resp. COLUMNS) is the number of exportable
4009 rows (resp. columns)."
4011 ;; Set number of rows, and extract first one.
4013 table 'table-row
4018 ;; Set number of columns.
4020 ;; Return value.
4024 "Return address of a regular TABLE-CELL object.
4026 TABLE-CELL is the cell considered. INFO is a plist used as
4027 a communication channel.
4029 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4030 zero-based index. Only exportable cells are considered. The
4031 function returns nil for other cells."
4034 ;; Ignore cells in special rows or in special column.
4039 ;; Row number.
4042 table 'table-row
4048 ;; Column number.
4051 table-row 'table-cell
4057 "Return regular table-cell object at ADDRESS in TABLE.
4059 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4060 zero-based index. TABLE is a table type element. INFO is
4061 a plist used as a communication channel.
4063 If no table-cell, among exportable cells, is found at ADDRESS,
4064 return nil."
4067 ;; Row at (car address) or nil.
4070 table 'table-row
4076 'table-cell
4083 ;;;; For Tables Of Contents
4084 ;;
4085 ;; `org-export-collect-headlines' builds a list of all exportable
4086 ;; headline elements, maybe limited to a certain depth. One can then
4087 ;; easily parse it and transcode it.
4088 ;;
4089 ;; Building lists of tables, figures or listings is quite similar.
4090 ;; Once the generic function `org-export-collect-elements' is defined,
4091 ;; `org-export-collect-tables', `org-export-collect-figures' and
4092 ;; `org-export-collect-listings' can be derived from it.
4095 "Collect headlines in order to build a table of contents.
4097 INFO is a plist used as a communication channel.
4099 When optional argument N is an integer, it specifies the depth of
4100 the table of contents. Otherwise, it is set to the value of the
4101 last headline level. See `org-export-headline-levels' for more
4102 information.
4104 Return a list of all exportable headlines as parsed elements."
4108 'headline
4110 ;; Strip contents from HEADLINE.
4113 info))
4116 "Collect referenceable elements of a determined type.
4118 TYPE can be a symbol or a list of symbols specifying element
4119 types to search. Only elements with a caption are collected.
4121 INFO is a plist used as a communication channel.
4123 When non-nil, optional argument PREDICATE is a function accepting
4124 one argument, an element of type TYPE. It returns a non-nil
4125 value when that element should be collected.
4127 Return a list of all elements found, in order of appearance."
4133 element))
4134 info))
4137 "Build a list of tables.
4138 INFO is a plist used as a communication channel.
4140 Return a list of table elements with a caption."
4144 "Build a list of figures.
4146 INFO is a plist used as a communication channel. PREDICATE is
4147 a function which accepts one argument: a paragraph element and
4148 whose return value is non-nil when that element should be
4149 collected.
4151 A figure is a paragraph type element, with a caption, verifying
4153 a vague concept that may depend on back-end.
4155 Return a list of elements recognized as figures."
4159 "Build a list of src blocks.
4161 INFO is a plist used as a communication channel.
4163 Return a list of src-block elements with a caption."
4167 ;;;; Topology
4168 ;;
4169 ;; Here are various functions to retrieve information about the
4170 ;; neighbourhood of a given element or object. Neighbours of interest
4171 ;; are direct parent (`org-export-get-parent'), parent headline
4172 ;; (`org-export-get-parent-headline'), first element containing an
4173 ;; object, (`org-export-get-parent-element'), parent table
4174 ;; (`org-export-get-parent-table'), previous element or object
4175 ;; (`org-export-get-previous-element') and next element or object
4176 ;; (`org-export-get-next-element').
4177 ;;
4178 ;; `org-export-get-genealogy' returns the full genealogy of a given
4179 ;; element or object, from closest parent to full parse tree.
4182 "Return BLOB parent or nil.
4183 BLOB is the element or object considered."
4187 "Return full genealogy relative to a given element or object.
4189 BLOB is the element or object being considered.
4191 Ancestors are returned from closest to farthest, the last one
4192 being the full parse tree."
4199 "Return BLOB parent headline or nil.
4200 BLOB is the element or object being considered."
4204 parent))
4207 "Return first element containing OBJECT or nil.
4208 OBJECT is the object to consider."
4212 parent))
4215 "Return OBJECT parent table or nil.
4216 OBJECT is either a `table-cell' or `table-element' type object."
4220 parent))
4223 "Return previous element or object.
4224 BLOB is an element or object. INFO is a plist used as
4225 a communication channel. Return previous exportable element or
4226 object, a string, or nil."
4236 "Return next element or object.
4237 BLOB is an element or object. INFO is a plist used as
4238 a communication channel. Return next exportable element or
4239 object, a string, or nil."
4245 nil))
4248 ;;;; Translation
4249 ;;
4250 ;; `org-export-translate' translates a string according to language
4251 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4252 ;; variable and a specified charset. `org-export-dictionary' contains
4253 ;; the dictionary used for the translation.
4375 "Dictionary for export engine.
4377 Alist whose CAR is the string to translate and CDR is an alist
4378 whose CAR is the language string and CDR is a plist whose
4379 properties are possible charsets and values translated terms.
4381 It is used as a database for `org-export-translate'. Since this
4382 function returns the string as-is if no translation was found,
4383 the variable only needs to record values different from the
4387 "Translate string S according to language specification.
4389 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4390 and `:utf-8'. INFO is a plist used as a communication channel.
4392 Translation depends on `:language' property. Return the
4393 translated string. If no translation is found, try to fall back
4394 to `:default' encoding. If it fails, return S."
4400 s)))
4403 \f
4404 ;;; The Dispatcher
4405 ;;
4406 ;; `org-export-dispatch' is the standard interactive way to start an
4407 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4408 ;; for its interface, which, in turn, delegates response to key
4409 ;; pressed to `org-export-dispatch-action'.
4412 "List of menu entries available for `org-export-dispatch'.
4413 This variable shouldn't be set directly. Set-up :menu-entry
4414 keyword in either `org-export-define-backend' or
4417 ;;;###autoload
4419 "Export dispatcher for Org mode.
4421 It provides an access to common export related tasks in a buffer.
4422 Its interface comes in two flavours: standard and expert. While
4423 both share the same set of bindings, only the former displays the
4424 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4425 to switch to one or the other.
4427 Return an error if key pressed has no associated command."
4430 nil
4431 org-export-dispatch-use-expert-ui))
4435 ;; First handle special hard-coded actions.
4441 "Publish project: "
4442 org-e-publish-project-alist nil t)
4443 org-e-publish-project-alist)
4453 "Handle interface for `org-export-dispatch'.
4455 OPTIONS is a list containing current interactive options set for
4456 export. It can contain any of the following symbols:
4457 `body' toggles a body-only export
4458 `subtree' restricts export to current subtree
4459 `visible' restricts export to visible part of buffer.
4460 `force' force publishing files.
4462 FIRST-KEY is the key pressed to select the first level menu. It
4463 is nil when this menu hasn't been selected yet.
4465 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4466 buffer is provided, but indications about currently active
4467 options are given in the prompt. Moreover, \[?] allows to switch
4468 back to standard interface."
4471 ;; Fontify KEY string. Optional argument ACCESS-KEY, when
4472 ;; non-nil is the required first-level key to activate
4473 ;; KEY. When its value is t, activate KEY independently
4474 ;; on the first key, if any. A nil value means KEY will
4475 ;; only be activated at first level.
4479 ;; Make sure order of menu doesn't depend on the order in
4480 ;; which back-ends are loaded.
4483 ;; Compute a list of allowed keys based on the first key
4484 ;; pressed, if any. Some keys (?1, ?2, ?3, ?4 and ?q) are
4485 ;; always available.
4495 ;; Build the help menu for standard UI.
4499 ;; Options are hard-coded.
4501 [%s] Body only: %s [%s] Visible only: %s
4511 ;; Display registered back-end entries.
4521 ;; Split sub-menu into two columns.
4531 top-key)
4536 ;; Publishing menu is hard-coded.
4538 [%s] Current file [%s] Current project
4548 ;; Build prompts for both standard and expert UI.
4553 "Export command (Options: %s%s%s%s) [%s]: "
4559 ;; With expert UI, just read key with a fancy prompt. In standard
4560 ;; UI, display an intrusive help buffer.
4563 expert-prompt allowed-keys backends options first-key expertp)
4575 standard-prompt allowed-keys backends options first-key expertp))
4581 "Read a character from command input and act accordingly.
4583 PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
4584 a list of characters available at a given step in the process.
4585 BACKENDS is a list of menu entries. OPTIONS, FIRST-KEY and
4586 EXPERTP are the same as defined in `org-export-dispatch-ui',
4587 which see.
4589 Toggle export options when required. Otherwise, return value is
4590 a list with action as CAR and a list of interactive export
4591 options as CDR."
4593 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4594 ;; depending on user's key pressed.
4597 ;; Ignore non-standard characters (i.e. "M-a") and
4598 ;; undefined associations.
4601 ;; q key at first level aborts export. At second
4602 ;; level, cancel first key instead.
4605 ;; Help key: Switch back to standard interface if
4606 ;; expert UI was active.
4608 ;; Toggle export options.
4615 first-key expertp))
4616 ;; Action selected: Send key and options back to
4617 ;; `org-export-dispatch'.
4623 ;; Publishing actions are hard-coded. Send a special
4624 ;; signal to `org-export-dispatch'.
4632 options))
4633 ;; Otherwise, enter sub-menu.
4638 ;;; org-export.el ends here