| blob | 4f01b7ee48d0302833bab415c0e10bcfa0d44123 |
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:
106 \f
107 ;;; Internal Variables
108 ;;
109 ;; Among internal variables, the most important is
110 ;; `org-export-options-alist'. This variable define the global export
111 ;; options, shared between every exporter, and how they are acquired.
152 "Alist between export properties and ways to set them.
154 The CAR of the alist is the property name, and the CDR is a list
155 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
157 KEYWORD is a string representing a buffer keyword, or nil. Each
158 property defined this way can also be set, during subtree
159 export, through an headline property named after the keyword
161 property).
162 OPTION is a string that could be found in an #+OPTIONS: line.
163 DEFAULT is the default value for the property.
164 BEHAVIOUR determine how Org should handle multiple keywords for
165 the same property. It is a symbol among:
166 nil Keep old value and discard the new one.
167 t Replace old value with the new one.
168 `space' Concatenate the values, separating them with a space.
169 `newline' Concatenate the values, separating them with
170 a newline.
171 `split' Split values at white spaces, and cons them to the
172 previous list.
174 KEYWORD and OPTION have precedence over DEFAULT.
176 All these properties should be back-end agnostic. Back-end
177 specific properties are set through `org-export-define-backend'.
182 "List of in-buffer keywords that require special treatment.
183 These keywords are not directly associated to a property. The
184 way they are handled must be hard-coded into
242 "Alist between filters properties and initial values.
244 The key of each association is a property name accessible through
245 the communication channel. Its value is a configurable global
246 variable defining initial filters.
248 This list is meant to install user specified filters. Back-end
249 developers may install their own filters using
250 `org-export-define-backend'. Filters defined there will always
251 be prepended to the current list, so they always get applied
260 "Default rule for link matching an inline image.
261 This rule applies to links with no description. By default, it
262 will be considered as an inline image if it targets a local file
265 See `org-export-inline-image-p' for more information about
269 \f
270 ;;; User-configurable Variables
271 ;;
272 ;; Configuration for the masses.
273 ;;
274 ;; They should never be accessed directly, as their value is to be
275 ;; stored in a property list (cf. `org-export-options-alist').
276 ;; Back-ends will read their value from there instead.
279 "Options for exporting Org mode files."
284 "General options for export engine."
289 "Whether sub-trees with the ARCHIVE tag should be exported.
291 This can have three different values:
292 nil Do not export, pretend this tree is not present.
293 t Do export the entire tree.
294 `headline' Only export the headline, but skip the tree below it.
296 This option can also be set with the #+OPTIONS line,
305 "Non-nil means insert author name into the exported file.
306 This option can also be set with the #+OPTIONS line,
312 "Non-nil means export CLOCK keywords.
313 This option can also be set with the #+OPTIONS line,
319 "Non-nil means the postamble should contain a creator sentence.
321 The sentence can be set in `org-export-creator-string' and
324 If the value is `comment' insert it as a comment."
334 emacs-version)
335 "String to insert at the end of the generated document."
340 "Non-nil means export contents of standard drawers.
342 When t, all drawers are exported. This may also be a list of
343 drawer names to export. This variable doesn't apply to
344 properties drawers.
346 This option can also be set with the #+OPTIONS line,
356 "Non-nil means insert author email into the exported file.
357 This option can also be set with the #+OPTIONS line,
363 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
365 If the export target supports emphasizing text, the word will be
366 typeset in bold, italic, or underlined, respectively. Not all
367 export backends support this.
374 "Tags that exclude a tree from export.
376 All trees carrying any of these tags will be excluded from
377 export. This is without condition, so even subtrees inside that
378 carry one of the `org-export-select-tags' will be removed.
380 This option can also be set with the #+EXCLUDE_TAGS: keyword."
387 This can be used to have pre-formatted text, fragments of code
388 etc. For example:
389 : ;; Some Lisp examples
390 : (while (defc cnt)
391 : (ding))
392 will be looking just like this in also HTML. See also the QUOTE
393 keyword. Not all export backends support this.
400 "Non-nil means Org footnotes should be exported.
401 This option can also be set with the #+OPTIONS line,
407 "The last level which is still exported as a headline.
409 Inferior levels will produce itemize lists when exported.
416 "The default language for export and clocktable translations, as a string.
417 This may have an association in
418 `org-clock-clocktable-language-setup'."
423 "Non-nil means preserve all line breaks when exporting.
425 Normally, in HTML output paragraphs will be reformatted.
427 This option can also be set with the #+OPTIONS line,
433 "Non-nil means interpret entities when exporting.
436 Å.
438 For a list of supported names, see the constant `org-entities'
439 and the user option `org-entities-user'.
441 This option can also be set with the #+OPTIONS line,
447 "Non-nil means inlinetasks should be exported.
448 This option can also be set with the #+OPTIONS line,
454 "Non-nil means include planning info in export.
455 This option can also be set with the #+OPTIONS: line,
461 "Non-nil means include priority cookies in export.
462 This option can also be set with the #+OPTIONS line,
468 "Non-nil means add section numbers to headlines when exporting.
470 When set to an integer n, numbering will only happen for
471 headlines whose relative level is higher or equal to n.
473 This option can also be set with the #+OPTIONS line,
479 "Tags that select a tree for export.
481 If any such tag is found in a buffer, all trees that do not carry
482 one of these tags will be ignored during export. Inside trees
483 that are selected like this, you can still deselect a subtree by
484 tagging it with one of the `org-export-exclude-tags'.
486 This option can also be set with the #+SELECT_TAGS: keyword."
493 When this option is turned on, these strings will be exported as:
495 Org HTML LaTeX
496 -----+----------+--------
498 -- – --
499 --- — ---
500 ... … \ldots
502 This option can also be set with the #+OPTIONS line,
510 When this option is turned on, you can use TeX-like syntax for
512 will be considered as a single item - so grouping with {} is
513 normally not needed. For example, the following things will be
514 parsed as single sub- or superscripts.
516 10^24 or 10^tau several digits will be considered 1 item.
517 10^-12 or 10^-tau a leading sign with digits or a word
518 x^2-y^3 will be read as x^2 - y^3, because items are
519 terminated by almost any nonword/nondigit char.
520 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
522 Still, ambiguity is possible - so when in doubt use {} to enclose
523 the sub/superscript. If you set this variable to the symbol
524 `{}', the braces are *required* in order to trigger
525 interpretations as sub/superscript. This can be helpful in
528 This option can also be set with the #+OPTIONS line,
537 "Non-nil means create a table of contents in exported files.
539 The TOC contains headlines with levels up
540 to`org-export-headline-levels'. When an integer, include levels
541 up to N in the toc, this may then be different from
542 `org-export-headline-levels', but it will not be allowed to be
543 larger than the number of headline levels. When nil, no table of
544 contents is made.
546 This option can also be set with the #+OPTIONS line,
556 For example:
558 | Name | Address | Birthday |
559 |-------------+----------+-----------|
560 | Arthur Dent | England | 29.2.2100 |
567 "If nil, do not export tags, just remove them from headlines.
569 If this is the symbol `not-in-toc', tags will be removed from
570 table of contents entries, but still be shown in the headlines of
571 the document.
573 This option can also be set with the #+OPTIONS line,
582 "Non-nil means include TODO items for export.
583 This may have the following values:
584 t include tasks independent of state.
585 todo include only tasks that are not yet done.
586 done include only tasks that are already done.
587 nil remove all tasks before export
588 list of keywords keep only tasks with these keywords"
599 "Non-nil means insert a time stamp into the exported file.
600 The time stamp shows when the file was created.
602 This option can also be set with the #+OPTIONS line,
608 "Non nil means allow timestamps in export.
610 It can be set to `active', `inactive', t or nil, in order to
611 export, respectively, only active timestamps, only inactive ones,
612 all of them or none.
614 This option can also be set with the #+OPTIONS line, e.g.
624 "Non-nil means include TODO keywords in export.
625 When nil, remove all these keywords from the export."
630 "Non-nil means allow #+BIND to define local variable values for export.
631 This is a potential security risk, which is why the user must
632 confirm the use of these lines."
640 "Alist between export snippets back-ends and exporter back-ends.
642 This variable allows to provide shortcuts for export snippets.
646 HTML code while every other back-end will ignore it."
654 "Coding system for the exported file."
659 "Non-nil means exported stuff will also be pushed onto the kill ring."
664 "The initial scope when exporting with `org-export-dispatch'.
665 This variable can be either set to `buffer' or `subtree'."
672 "Non-nil means show buffer after exporting to temp buffer.
673 When Org exports to a file, the buffer visiting that file is ever
674 shown, but remains buried. However, when exporting to
675 a temporary buffer, that buffer is popped up in a second window.
676 When this variable is nil, the buffer remains buried also in
677 these cases."
682 "Non-nil means using a non-intrusive `org-export-dispatch'.
683 In that case, no help buffer is displayed. Though, an indicator
687 considered for export\). Also, \[?] allows to switch back to
688 standard mode."
693 \f
694 ;;; Defining New Back-ends
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 :options-alist
754 Alist between back-end specific properties introduced in
755 communication channel and how their value are acquired. See
756 `org-export-options-alist' for more information about
757 structure of the values.
759 As an example, here is how the `e-ascii' back-end is defined:
761 \(org-export-define-backend e-ascii
762 \((bold . org-e-ascii-bold)
763 \(center-block . org-e-ascii-center-block)
764 \(clock . org-e-ascii-clock)
765 \(code . org-e-ascii-code)
766 \(drawer . org-e-ascii-drawer)
767 \(dynamic-block . org-e-ascii-dynamic-block)
768 \(entity . org-e-ascii-entity)
769 \(example-block . org-e-ascii-example-block)
770 \(export-block . org-e-ascii-export-block)
771 \(export-snippet . org-e-ascii-export-snippet)
772 \(fixed-width . org-e-ascii-fixed-width)
773 \(footnote-definition . org-e-ascii-footnote-definition)
774 \(footnote-reference . org-e-ascii-footnote-reference)
775 \(headline . org-e-ascii-headline)
776 \(horizontal-rule . org-e-ascii-horizontal-rule)
777 \(inline-src-block . org-e-ascii-inline-src-block)
778 \(inlinetask . org-e-ascii-inlinetask)
779 \(italic . org-e-ascii-italic)
780 \(item . org-e-ascii-item)
781 \(keyword . org-e-ascii-keyword)
782 \(latex-environment . org-e-ascii-latex-environment)
783 \(latex-fragment . org-e-ascii-latex-fragment)
784 \(line-break . org-e-ascii-line-break)
785 \(link . org-e-ascii-link)
786 \(macro . org-e-ascii-macro)
787 \(paragraph . org-e-ascii-paragraph)
788 \(plain-list . org-e-ascii-plain-list)
789 \(plain-text . org-e-ascii-plain-text)
790 \(planning . org-e-ascii-planning)
791 \(property-drawer . org-e-ascii-property-drawer)
792 \(quote-block . org-e-ascii-quote-block)
793 \(quote-section . org-e-ascii-quote-section)
794 \(radio-target . org-e-ascii-radio-target)
795 \(section . org-e-ascii-section)
796 \(special-block . org-e-ascii-special-block)
797 \(src-block . org-e-ascii-src-block)
798 \(statistics-cookie . org-e-ascii-statistics-cookie)
799 \(strike-through . org-e-ascii-strike-through)
800 \(subscript . org-e-ascii-subscript)
801 \(superscript . org-e-ascii-superscript)
802 \(table . org-e-ascii-table)
803 \(table-cell . org-e-ascii-table-cell)
804 \(table-row . org-e-ascii-table-row)
805 \(target . org-e-ascii-target)
806 \(template . org-e-ascii-template)
807 \(timestamp . org-e-ascii-timestamp)
808 \(underline . org-e-ascii-underline)
809 \(verbatim . org-e-ascii-verbatim)
810 \(verse-block . org-e-ascii-verse-block))
812 :filters-alist ((:filter-headline . org-e-ascii-filter-headline-blank-lines)
813 \(:filter-section . org-e-ascii-filter-headline-blank-lines))
814 :options-alist ((:ascii-charset nil nil org-e-ascii-charset)))"
828 ;; Define translators.
831 ;; Define options.
835 See `org-export-options-alist' for more information on the
836 structure of the values."
837 backend)))
838 ;; Define filters.
841 "Alist between filters keywords and back-end specific filters.
843 ;; Tell parser to not parse EXPORT-BLOCK blocks.
850 ;; Splice in the body, if any.
854 "Create a new back-end as a variant of an existing one.
856 CHILD is the name of the derived back-end. PARENT is the name of
857 the parent back-end.
859 BODY can start with pre-defined keyword arguments. The following
860 keywords are understood:
862 :export-block
864 String, or list of strings, representing block names that
865 will not be parsed. This is used to specify blocks that will
866 contain raw code specific to the back-end. These blocks
867 still have to be handled by the relative `export-block' type
868 translator.
870 :filters-alist
872 Alist of filters that will overwrite or complete filters
873 defined in PARENT back-end. See `org-export-filters-alist'
874 for more a list of allowed filters.
876 :options-alist
878 Alist of back-end specific properties that will overwrite or
879 complete those defined in PARENT back-end. Refer to
880 `org-export-options-alist' for more information about
881 structure of the values.
883 :translate-alist
885 Alist of element and object types and transcoders that will
886 overwrite or complete transcode table from PARENT back-end.
887 Refer to `org-export-define-backend' for detailed information
888 about transcoders.
891 as a variant of `e-latex' back-end with a custom template
892 function:
894 \(org-export-define-derived-backend my-latex e-latex
895 :translate-alist ((template . my-latex-template-fun)))
897 The back-end could then be called with, for example:
914 ;; Tell parser to not parse EXPORT-BLOCK blocks.
921 ;; Define filters.
928 "Alist between filters keywords and back-end specific filters.
930 ;; Define options.
938 See `org-export-options-alist' for more information on the
939 structure of the values."
940 child))))
941 ;; Define translators.
948 ;; Splice in the body, if any.
952 \f
953 ;;; The Communication Channel
954 ;;
955 ;; During export process, every function has access to a number of
956 ;; properties. They are of two types:
957 ;;
958 ;; 1. Environment options are collected once at the very beginning of
959 ;; the process, out of the original buffer and configuration.
960 ;; Collecting them is handled by `org-export-get-environment'
961 ;; function.
962 ;;
963 ;; Most environment options are defined through the
964 ;; `org-export-options-alist' variable.
965 ;;
966 ;; 2. Tree properties are extracted directly from the parsed tree,
967 ;; just before export, by `org-export-collect-tree-properties'.
968 ;;
969 ;; Here is the full list of properties available during transcode
970 ;; process, with their category (option, tree or local) and their
971 ;; value type.
972 ;;
973 ;; + `:author' :: Author's name.
974 ;; - category :: option
975 ;; - type :: string
976 ;;
977 ;; + `:back-end' :: Current back-end used for transcoding.
978 ;; - category :: tree
979 ;; - type :: symbol
980 ;;
981 ;; + `:creator' :: String to write as creation information.
982 ;; - category :: option
983 ;; - type :: string
984 ;;
985 ;; + `:date' :: String to use as date.
986 ;; - category :: option
987 ;; - type :: string
988 ;;
989 ;; + `:description' :: Description text for the current data.
990 ;; - category :: option
991 ;; - type :: string
992 ;;
993 ;; + `:email' :: Author's email.
994 ;; - category :: option
995 ;; - type :: string
996 ;;
997 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
998 ;; process.
999 ;; - category :: option
1000 ;; - type :: list of strings
1001 ;;
1002 ;; + `:exported-data' :: Hash table used for memoizing
1003 ;; `org-export-data'.
1004 ;; - category :: tree
1005 ;; - type :: hash table
1006 ;;
1007 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1008 ;; their definition, as parsed data. Only non-inlined footnotes
1009 ;; are represented in this alist. Also, every definition isn't
1010 ;; guaranteed to be referenced in the parse tree. The purpose of
1011 ;; this property is to preserve definitions from oblivion
1012 ;; (i.e. when the parse tree comes from a part of the original
1013 ;; buffer), it isn't meant for direct use in a back-end. To
1014 ;; retrieve a definition relative to a reference, use
1015 ;; `org-export-get-footnote-definition' instead.
1016 ;; - category :: option
1017 ;; - type :: alist (STRING . LIST)
1018 ;;
1019 ;; + `:headline-levels' :: Maximum level being exported as an
1020 ;; headline. Comparison is done with the relative level of
1021 ;; headlines in the parse tree, not necessarily with their
1022 ;; actual level.
1023 ;; - category :: option
1024 ;; - type :: integer
1025 ;;
1026 ;; + `:headline-offset' :: Difference between relative and real level
1027 ;; of headlines in the parse tree. For example, a value of -1
1028 ;; means a level 2 headline should be considered as level
1029 ;; 1 (cf. `org-export-get-relative-level').
1030 ;; - category :: tree
1031 ;; - type :: integer
1032 ;;
1033 ;; + `:headline-numbering' :: Alist between headlines and their
1034 ;; numbering, as a list of numbers
1035 ;; (cf. `org-export-get-headline-number').
1036 ;; - category :: tree
1037 ;; - type :: alist (INTEGER . LIST)
1038 ;;
1039 ;; + `:id-alist' :: Alist between ID strings and destination file's
1040 ;; path, relative to current directory. It is used by
1041 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1042 ;; external file.
1043 ;; - category :: option
1044 ;; - type :: alist (STRING . STRING)
1045 ;;
1046 ;; + `:ignore-list' :: List of elements and objects that should be
1047 ;; ignored during export.
1048 ;; - category :: tree
1049 ;; - type :: list of elements and objects
1050 ;;
1051 ;; + `:input-file' :: Full path to input file, if any.
1052 ;; - category :: option
1053 ;; - type :: string or nil
1054 ;;
1055 ;; + `:keywords' :: List of keywords attached to data.
1056 ;; - category :: option
1057 ;; - type :: string
1058 ;;
1059 ;; + `:language' :: Default language used for translations.
1060 ;; - category :: option
1061 ;; - type :: string
1062 ;;
1063 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1064 ;; transcoding.
1065 ;; - category :: option
1066 ;; - type :: list (as returned by `org-element-parse-buffer')
1067 ;;
1068 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1069 ;; all line breaks.
1070 ;; - category :: option
1071 ;; - type :: symbol (nil, t)
1072 ;;
1073 ;; + `:section-numbers' :: Non-nil means transcoding should add
1074 ;; section numbers to headlines.
1075 ;; - category :: option
1076 ;; - type :: symbol (nil, t)
1077 ;;
1078 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1079 ;; in transcoding. When such a tag is present, subtrees without
1080 ;; it are de facto excluded from the process. See
1081 ;; `use-select-tags'.
1082 ;; - category :: option
1083 ;; - type :: list of strings
1084 ;;
1085 ;; + `:target-list' :: List of targets encountered in the parse tree.
1086 ;; This is used to partly resolve "fuzzy" links
1087 ;; (cf. `org-export-resolve-fuzzy-link').
1088 ;; - category :: tree
1089 ;; - type :: list of strings
1090 ;;
1091 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1092 ;; a time stamp in the output.
1093 ;; - category :: option
1094 ;; - type :: symbol (nil, t)
1095 ;;
1096 ;; + `:translate-alist' :: Alist between element and object types and
1097 ;; transcoding functions relative to the current back-end.
1098 ;; Special keys `template' and `plain-text' are also possible.
1099 ;; - category :: option
1100 ;; - type :: alist (SYMBOL . FUNCTION)
1101 ;;
1102 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1103 ;; also be transcoded. If it is set to the `headline' symbol,
1104 ;; only the archived headline's name is retained.
1105 ;; - category :: option
1106 ;; - type :: symbol (nil, t, `headline')
1107 ;;
1108 ;; + `:with-author' :: Non-nil means author's name should be included
1109 ;; in the output.
1110 ;; - category :: option
1111 ;; - type :: symbol (nil, t)
1112 ;;
1113 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
1114 ;; - category :: option
1115 ;; - type :: symbol (nil, t)
1116 ;;
1117 ;; + `:with-creator' :: Non-nild means a creation sentence should be
1118 ;; inserted at the end of the transcoded string. If the value
1119 ;; is `comment', it should be commented.
1120 ;; - category :: option
1121 ;; - type :: symbol (`comment', nil, t)
1122 ;;
1123 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1124 ;; its value is a list of names, only drawers with such names
1125 ;; will be transcoded.
1126 ;; - category :: option
1127 ;; - type :: symbol (nil, t) or list of strings
1128 ;;
1129 ;; + `:with-email' :: Non-nil means output should contain author's
1130 ;; email.
1131 ;; - category :: option
1132 ;; - type :: symbol (nil, t)
1133 ;;
1134 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1135 ;; interpreted.
1136 ;; - category :: option
1137 ;; - type :: symbol (nil, t)
1138 ;;
1139 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1140 ;; strings starting with a colon as a fixed-with (verbatim) area.
1141 ;; - category :: option
1142 ;; - type :: symbol (nil, t)
1143 ;;
1144 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1145 ;; footnotes.
1146 ;; - category :: option
1147 ;; - type :: symbol (nil, t)
1148 ;;
1149 ;; + `:with-plannings' :: Non-nil means transcoding should include
1150 ;; planning info.
1151 ;; - category :: option
1152 ;; - type :: symbol (nil, t)
1153 ;;
1154 ;; + `:with-priority' :: Non-nil means transcoding should include
1155 ;; priority cookies.
1156 ;; - category :: option
1157 ;; - type :: symbol (nil, t)
1158 ;;
1159 ;; + `:with-special-strings' :: Non-nil means transcoding should
1160 ;; interpret special strings in plain text.
1161 ;; - category :: option
1162 ;; - type :: symbol (nil, t)
1163 ;;
1164 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1165 ;; interpret subscript and superscript. With a value of "{}",
1166 ;; only interpret those using curly brackets.
1167 ;; - category :: option
1168 ;; - type :: symbol (nil, {}, t)
1169 ;;
1170 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1171 ;; tables.
1172 ;; - category :: option
1173 ;; - type :: symbol (nil, t)
1174 ;;
1175 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1176 ;; headlines. A `not-in-toc' value will remove them from the
1177 ;; table of contents, if any, nonetheless.
1178 ;; - category :: option
1179 ;; - type :: symbol (nil, t, `not-in-toc')
1180 ;;
1181 ;; + `:with-tasks' :: Non-nil means transcoding should include
1182 ;; headlines with a TODO keyword. A `todo' value will only
1183 ;; include headlines with a todo type keyword while a `done'
1184 ;; value will do the contrary. If a list of strings is provided,
1185 ;; only tasks with keywords belonging to that list will be kept.
1186 ;; - category :: option
1187 ;; - type :: symbol (t, todo, done, nil) or list of strings
1188 ;;
1189 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1190 ;; time stamps. Special value `active' (resp. `inactive') ask to
1191 ;; export only active (resp. inactive) timestamps. Otherwise,
1192 ;; completely remove them.
1193 ;; - category :: option
1194 ;; - type :: symbol: (`active', `inactive', t, nil)
1195 ;;
1196 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1197 ;; added to the output. An integer value limits its depth.
1198 ;; - category :: option
1199 ;; - type :: symbol (nil, t or integer)
1200 ;;
1201 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1202 ;; include TODO keywords.
1203 ;; - category :: option
1204 ;; - type :: symbol (nil, t)
1207 ;;;; Environment Options
1208 ;;
1209 ;; Environment options encompass all parameters defined outside the
1210 ;; scope of the parsed data. They come from five sources, in
1211 ;; increasing precedence order:
1212 ;;
1213 ;; - Global variables,
1214 ;; - Buffer's attributes,
1215 ;; - Options keyword symbols,
1216 ;; - Buffer keywords,
1217 ;; - Subtree properties.
1218 ;;
1219 ;; The central internal function with regards to environment options
1220 ;; is `org-export-get-environment'. It updates global variables with
1221 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1222 ;; the different sources.
1223 ;;
1224 ;; The internal functions doing the retrieval are:
1225 ;; `org-export--get-global-options',
1226 ;; `org-export--get-buffer-attributes',
1227 ;; `org-export--parse-option-keyword',
1228 ;; `org-export--get-subtree-options' and
1229 ;; `org-export--get-inbuffer-options'
1230 ;;
1231 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1232 ;; take care of the part relative to "#+BIND:" keywords.
1235 "Collect export options from the current buffer.
1237 Optional argument BACKEND is a symbol specifying which back-end
1238 specific options to read, if any.
1240 When optional argument SUBTREEP is non-nil, assume the export is
1241 done against the current sub-tree.
1243 Third optional argument EXT-PLIST is a property list with
1244 external parameters overriding Org default settings, but still
1245 inferior to file-local settings."
1246 ;; First install #+BIND variables.
1248 ;; Get and prioritize export options...
1250 ;; ... from global variables...
1252 ;; ... from buffer's attributes...
1254 ;; ... from an external property list...
1255 ext-plist
1256 ;; ... from in-buffer settings...
1258 backend
1260 ;; ... and from subtree, when appropriate.
1262 ;; Eventually install back-end symbol and its translation table.
1263 `(:back-end
1264 ,backend
1265 :translate-alist
1270 "Parse an OPTIONS line and return values as a plist.
1271 Optional argument BACKEND is a symbol specifying which back-end
1272 specific items to read, if any."
1279 ;; Build an alist between #+OPTION: item and property-name.
1284 all)))
1285 plist)
1290 options)
1295 alist)
1296 plist))
1299 "Get export options in subtree at point.
1300 Optional argument BACKEND is a symbol specifying back-end used
1301 for export. Return options as a plist."
1302 ;; For each buffer keyword, create an headline property setting the
1303 ;; same property in communication channel. The name for the property
1304 ;; is the keyword with "EXPORT_" appended to it.
1307 ;; Make sure point is at an heading.
1309 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1310 ;; title as its fallback value.
1317 plist :title
1320 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1324 ;; Handle other keywords.
1331 ;; Export properties are not case-sensitive.
1338 plist
1340 ;; Parse VALUE if required.
1344 value))))))))
1345 ;; Also look for both general keywords and back-end specific
1346 ;; options if BACKEND is provided.
1351 org-export-options-alist)))
1352 ;; Return value.
1353 plist)))
1356 "Return current buffer export options, as a plist.
1358 Optional argument BACKEND, when non-nil, is a symbol specifying
1359 which back-end specific options should also be read in the
1360 process.
1362 Optional argument FILES is a list of setup files names read so
1363 far, used to avoid circular dependencies.
1365 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1369 ;; 1. Special keywords, as in `org-export-special-keywords'.
1382 ;; Avoid circular dependencies.
1394 val)
1402 ;; Value will be evaled: do not parse it.
1405 ;; Value has to be parsed for nested
1406 ;; macros.
1409 key
1412 ;; If user explicitly asks for
1413 ;; a newline, be sure to preserve it
1414 ;; from further filling with
1415 ;; `hard-newline'. Also replace
1416 ;; "\\n" with "\n", "\\\n" with "\\n"
1417 ;; and so on...
1424 restr)))))))))))
1426 ;; 2. Standard options, as in `org-export-options-alist'.
1428 ;; Also look for back-end specific options
1429 ;; if BACKEND is defined.
1435 ;; Build alist between keyword name and property name.
1439 all)))
1440 ;; Build regexp matching all keywords associated to export
1441 ;; options. Note: the search is case insensitive.
1454 plist prop
1455 ;; Handle value depending on specified BEHAVIOUR.
1468 ;; Parse keywords specified in `org-element-parsed-keywords'.
1476 plist prop
1479 org-element-parsed-keywords))
1480 ;; 3. Return final value.
1481 plist)))
1484 "Return properties related to buffer attributes, as a plist."
1487 ;; Store full path of input file name, or nil. For internal use.
1488 :input-file visited-file
1493 :footnote-definition-alist
1494 ;; Footnotes definitions must be collected in the original
1495 ;; buffer, as there's no insurance that they will still be in the
1496 ;; parse tree, due to possible narrowing.
1507 ;; Like `org-element-parse-buffer', but
1508 ;; makes sure the definition doesn't start
1509 ;; with a section element.
1513 alist))))
1514 alist))
1515 :id-alist
1516 ;; Collect id references.
1525 alist)
1526 :macro-modification-time
1532 ;; Store input file name as a macro.
1534 ;; `:macro-date', `:macro-time' and `:macro-property' could as
1535 ;; well be initialized as tree properties, since they don't
1536 ;; depend on buffer properties. Though, it may be more logical
1537 ;; to keep them close to other ":macro-" properties.
1543 "Return global export options as a plist.
1545 Optional argument BACKEND, if non-nil, is a symbol specifying
1546 which back-end specific export options should also be read in the
1547 process."
1553 ;; Output value.
1554 plist)
1559 plist
1561 ;; Eval default value provided. If keyword is a member
1562 ;; of `org-element-parsed-keywords', parse it as
1563 ;; a secondary string before storing it.
1570 all)
1571 ;; Return value.
1572 plist))
1576 "Can we use #+BIND values during export?
1577 By default this will ask for confirmation by the user, to divert
1578 possible security risks."
1583 org-export--allow-BIND-local)
1588 "Install the values from #+BIND lines as local variables.
1589 Variables must be installed before in-buffer options are
1590 retrieved."
1597 letbind))))
1602 ;;;; Tree Properties
1603 ;;
1604 ;; Tree properties are infromation extracted from parse tree. They
1605 ;; are initialized at the beginning of the transcoding process by
1606 ;; `org-export-collect-tree-properties'.
1607 ;;
1608 ;; Dedicated functions focus on computing the value of specific tree
1609 ;; properties during initialization. Thus,
1610 ;; `org-export--populate-ignore-list' lists elements and objects that
1611 ;; should be skipped during export, `org-export--get-min-level' gets
1612 ;; the minimal exportable level, used as a basis to compute relative
1613 ;; level for headlines. Eventually
1614 ;; `org-export--collect-headline-numbering' builds an alist between
1615 ;; headlines and their numbering.
1618 "Extract tree properties from parse tree.
1620 DATA is the parse tree from which information is retrieved. INFO
1621 is a list holding export options.
1623 Following tree properties are set or updated:
1625 `:exported-data' Hash table used to memoize results from
1626 `org-export-data'.
1628 `:footnote-definition-alist' List of footnotes definitions in
1629 original buffer and current parse tree.
1631 `:headline-offset' Offset between true level of headlines and
1632 local level. An offset of -1 means an headline
1633 of level 2 should be considered as a level
1634 1 headline in the context.
1636 `:headline-numbering' Alist of all headlines as key an the
1637 associated numbering as value.
1639 `:ignore-list' List of elements that should be ignored during
1640 export.
1642 `:target-list' List of all targets in the parse tree.
1644 Return updated plist."
1645 ;; Install the parse tree in the communication channel, in order to
1646 ;; use `org-export-get-genealogy' and al.
1648 ;; Get the list of elements and objects to ignore, and put it into
1649 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1650 ;; been done during parse tree filtering.
1653 :ignore-list
1656 ;; Compute `:headline-offset' in order to be able to use
1657 ;; `org-export-get-relative-level'.
1660 :headline-offset
1662 ;; Update footnotes definitions list with definitions in parse tree.
1663 ;; This is required since buffer expansion might have modified
1664 ;; boundaries of footnote definitions contained in the parse tree.
1665 ;; This way, definitions in `footnote-definition-alist' are bound to
1666 ;; match those in the parse tree.
1669 data 'footnote-definition
1673 defs)))
1675 ;; Properties order doesn't matter: get the rest of the tree
1676 ;; properties.
1678 `(:target-list
1687 info))
1690 "Return minimum exportable headline's level in DATA.
1691 DATA is parsed tree as returned by `org-element-parse-buffer'.
1692 OPTIONS is a plist holding export options."
1703 ;; If no headline was found, for the sake of consistency, set
1704 ;; minimum level to 1 nonetheless.
1708 "Return numbering of all exportable headlines in a parse tree.
1710 DATA is the parse tree. OPTIONS is the plist holding export
1711 options.
1713 Return an alist whose key is an headline and value is its
1714 associated numbering \(in the shape of a list of numbers\)."
1717 data
1718 'headline
1723 headline
1725 for idx from 0 to org-export-max-depth
1729 options)))
1732 "Return list of elements and objects to ignore during export.
1733 DATA is the parse tree to traverse. OPTIONS is the plist holding
1734 export options."
1736 walk-data ; for byte-compiler.
1740 ;; Collect ignored elements or objects into IGNORE-LIST.
1749 ;; If headline is archived but tree below has
1750 ;; to be skipped, add it to ignore list.
1753 ;; Move into recursive objects/elements.
1757 ;; Main call. First find trees containing a select tag, if any.
1759 ;; Return value.
1760 ignore))
1763 "Return list of headlines containing a select tag in their tree.
1764 DATA is parsed data as returned by `org-element-parse-buffer'.
1765 INFO is a plist holding export options."
1767 walk-data ; for byte-compiler.
1778 ;; When a select tag is found, mark full
1779 ;; genealogy and every headline within the tree
1780 ;; as acceptable.
1783 genealogy
1785 selected-trees))
1786 ;; Else, continue searching in tree, recursively.
1793 "Non-nil when element or object BLOB should be skipped during export.
1794 OPTIONS is the plist holding export options. SELECTED, when
1795 non-nil, is a list of headlines belonging to a tree with a select
1796 tag."
1798 ;; Check headline.
1806 ;; Ignore subtrees with an exclude tag.
1809 ;; When a select tag is present in the buffer, ignore any tree
1810 ;; without it.
1812 ;; Ignore commented sub-trees.
1814 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1816 ;; Ignore tasks, if specified by `:with-tasks' property.
1822 ;; Check inlinetask.
1824 ;; Check timestamp.
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.
1839 ;; Check drawer.
1845 ;; Check table-row.
1847 ;; Check table-cell.
1852 ;; Check clock.
1854 ;; Check planning.
1858 \f
1859 ;;; The Transcoder
1860 ;;
1861 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1862 ;; `org-element-parse-buffer') and transcodes it into a specified
1863 ;; back-end output. It takes care of filtering out elements or
1864 ;; objects according to export options and organizing the output blank
1865 ;; lines and white space are preserved. The function memoizes its
1866 ;; results, so it is cheap to call it within translators.
1867 ;;
1868 ;; Internally, three functions handle the filtering of objects and
1869 ;; elements during the export. In particular,
1870 ;; `org-export-ignore-element' marks an element or object so future
1871 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1872 ;; elements or objects should be seen as real Org syntax and
1873 ;; `org-export-expand' transforms the others back into their original
1874 ;; shape
1875 ;;
1876 ;; `org-export-transcoder' is an accessor returning appropriate
1877 ;; translator function for a given element or object.
1880 "Return appropriate transcoder for BLOB.
1881 INFO is a plist containing export directives."
1883 ;; Return contents only for complete parse trees.
1889 "Convert DATA into current back-end format.
1891 DATA is a parse tree, an element or an object or a secondary
1892 string. INFO is a plist holding export options.
1894 Return transcoded string."
1900 ;; Ignored element/object.
1902 ;; Plain text.
1908 info))
1909 ;; Uninterpreted element/object: change it back to Org
1910 ;; syntax and export again resulting raw string.
1914 data
1918 info))
1919 ;; Secondary string.
1922 ;; Element/Object without contents or, as a special case,
1923 ;; headline with archive tag and archived trees restricted
1924 ;; to title only.
1932 ;; Element/Object with contents.
1945 ;; Elements directly containing objects
1946 ;; must have their indentation normalized
1947 ;; first.
1949 data
1950 ;; When normalizing contents of the first
1951 ;; paragraph in an item or a footnote
1952 ;; definition, ignore first line's
1953 ;; indentation: there is none and it
1954 ;; might be misleading.
1959 data)
1966 info))))))))
1967 ;; Final result will be memoized before being returned.
1969 data
1973 ;; Append the same white space between elements or objects as in
1974 ;; the original buffer, and call appropriate filters.
1985 info)))
1986 results)))
1990 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1991 Check is done according to export options INFO, stored as
1992 a plist."
1994 ;; ... entities...
1996 ;; ... emphasis...
1998 ;; ... fixed-width areas.
2000 ;; ... footnotes...
2003 ;; ... sub/superscripts...
2009 ;; ... tables...
2014 "Expand a parsed element or object to its original state.
2015 BLOB is either an element or an object. CONTENTS is its
2016 contents, as a string or nil."
2019 blob contents))
2022 "Add ELEMENT to `:ignore-list' in INFO.
2024 Any element in `:ignore-list' will be skipped when using
2025 `org-element-map'. INFO is modified by side effects."
2029 \f
2030 ;;; The Filter System
2031 ;;
2032 ;; Filters allow end-users to tweak easily the transcoded output.
2033 ;; They are the functional counterpart of hooks, as every filter in
2034 ;; a set is applied to the return value of the previous one.
2035 ;;
2036 ;; Every set is back-end agnostic. Although, a filter is always
2037 ;; called, in addition to the string it applies to, with the back-end
2038 ;; used as argument, so it's easy for the end-user to add back-end
2039 ;; specific filters in the set. The communication channel, as
2040 ;; a plist, is required as the third argument.
2041 ;;
2042 ;; From the developer side, filters sets can be installed in the
2043 ;; process with the help of `org-export-define-backend', which
2044 ;; internally sets `org-BACKEND-filters-alist' variable. Each
2045 ;; association has a key among the following symbols and a function or
2046 ;; a list of functions as value.
2047 ;;
2048 ;; - `:filter-parse-tree' applies directly on the complete parsed
2049 ;; tree. It's the only filters set that doesn't apply to a string.
2050 ;; Users can set it through `org-export-filter-parse-tree-functions'
2051 ;; variable.
2052 ;;
2053 ;; - `:filter-final-output' applies to the final transcoded string.
2054 ;; Users can set it with `org-export-filter-final-output-functions'
2055 ;; variable
2056 ;;
2057 ;; - `:filter-plain-text' applies to any string not recognized as Org
2058 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2059 ;; configure it.
2060 ;;
2061 ;; - `:filter-TYPE' applies on the string returned after an element or
2062 ;; object of type TYPE has been transcoded. An user can modify
2063 ;; `org-export-filter-TYPE-functions'
2064 ;;
2065 ;; All filters sets are applied with
2066 ;; `org-export-filter-apply-functions' function. Filters in a set are
2067 ;; applied in a LIFO fashion. It allows developers to be sure that
2068 ;; their filters will be applied first.
2069 ;;
2070 ;; Filters properties are installed in communication channel with
2071 ;; `org-export-install-filters' function.
2072 ;;
2073 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
2074 ;; before parsing to allow for heavy structure modifications.
2077 ;;;; Before Parsing Hook
2080 "Hook run before parsing an export buffer.
2082 This is run after include keywords have been expanded and Babel
2083 code executed, on a copy of original buffer's area being
2084 exported. Visibility is the same as in the original one. Point
2085 is left at the beginning of the new one.
2087 Every function in this hook will be called with one argument: the
2091 ;;;; Special Filters
2094 "List of functions applied to the parsed tree.
2095 Each filter is called with three arguments: the parse tree, as
2096 returned by `org-element-parse-buffer', the back-end, as
2097 a symbol, and the communication channel, as a plist. It must
2101 "List of functions applied to the transcoded string.
2102 Each filter is called with three arguments: the full transcoded
2103 string, the back-end, as a symbol, and the communication channel,
2104 as a plist. It must return a string that will be used as the
2108 "List of functions applied to plain text.
2109 Each filter is called with three arguments: a string which
2110 contains no Org syntax, the back-end, as a symbol, and the
2111 communication channel, as a plist. It must return a string or
2115 ;;;; Elements Filters
2118 "List of functions applied to a transcoded center block.
2119 Each filter is called with three arguments: the transcoded data,
2120 as a string, the back-end, as a symbol, and the communication
2124 "List of functions applied to a transcoded clock.
2125 Each filter is called with three arguments: the transcoded data,
2126 as a string, the back-end, as a symbol, and the communication
2130 "List of functions applied to a transcoded drawer.
2131 Each filter is called with three arguments: the transcoded data,
2132 as a string, the back-end, as a symbol, and the communication
2136 "List of functions applied to a transcoded dynamic-block.
2137 Each filter is called with three arguments: the transcoded data,
2138 as a string, the back-end, as a symbol, and the communication
2142 "List of functions applied to a transcoded headline.
2143 Each filter is called with three arguments: the transcoded data,
2144 as a string, the back-end, as a symbol, and the communication
2148 "List of functions applied to a transcoded inlinetask.
2149 Each filter is called with three arguments: the transcoded data,
2150 as a string, the back-end, as a symbol, and the communication
2154 "List of functions applied to a transcoded plain-list.
2155 Each filter is called with three arguments: the transcoded data,
2156 as a string, the back-end, as a symbol, and the communication
2160 "List of functions applied to a transcoded item.
2161 Each filter is called with three arguments: the transcoded data,
2162 as a string, the back-end, as a symbol, and the communication
2166 "List of functions applied to a transcoded comment.
2167 Each filter is called with three arguments: the transcoded data,
2168 as a string, the back-end, as a symbol, and the communication
2172 "List of functions applied to a transcoded comment-comment.
2173 Each filter is called with three arguments: the transcoded data,
2174 as a string, the back-end, as a symbol, and the communication
2178 "List of functions applied to a transcoded example-block.
2179 Each filter is called with three arguments: the transcoded data,
2180 as a string, the back-end, as a symbol, and the communication
2184 "List of functions applied to a transcoded export-block.
2185 Each filter is called with three arguments: the transcoded data,
2186 as a string, the back-end, as a symbol, and the communication
2190 "List of functions applied to a transcoded fixed-width.
2191 Each filter is called with three arguments: the transcoded data,
2192 as a string, the back-end, as a symbol, and the communication
2196 "List of functions applied to a transcoded footnote-definition.
2197 Each filter is called with three arguments: the transcoded data,
2198 as a string, the back-end, as a symbol, and the communication
2202 "List of functions applied to a transcoded horizontal-rule.
2203 Each filter is called with three arguments: the transcoded data,
2204 as a string, the back-end, as a symbol, and the communication
2208 "List of functions applied to a transcoded keyword.
2209 Each filter is called with three arguments: the transcoded data,
2210 as a string, the back-end, as a symbol, and the communication
2214 "List of functions applied to a transcoded latex-environment.
2215 Each filter is called with three arguments: the transcoded data,
2216 as a string, the back-end, as a symbol, and the communication
2220 "List of functions applied to a transcoded babel-call.
2221 Each filter is called with three arguments: the transcoded data,
2222 as a string, the back-end, as a symbol, and the communication
2226 "List of functions applied to a transcoded paragraph.
2227 Each filter is called with three arguments: the transcoded data,
2228 as a string, the back-end, as a symbol, and the communication
2232 "List of functions applied to a transcoded planning.
2233 Each filter is called with three arguments: the transcoded data,
2234 as a string, the back-end, as a symbol, and the communication
2238 "List of functions applied to a transcoded property-drawer.
2239 Each filter is called with three arguments: the transcoded data,
2240 as a string, the back-end, as a symbol, and the communication
2244 "List of functions applied to a transcoded quote block.
2245 Each filter is called with three arguments: the transcoded quote
2246 data, as a string, the back-end, as a symbol, and the
2247 communication channel, as a plist. It must return a string or
2251 "List of functions applied to a transcoded quote-section.
2252 Each filter is called with three arguments: the transcoded data,
2253 as a string, the back-end, as a symbol, and the communication
2257 "List of functions applied to a transcoded section.
2258 Each filter is called with three arguments: the transcoded data,
2259 as a string, the back-end, as a symbol, and the communication
2263 "List of functions applied to a transcoded special block.
2264 Each filter is called with three arguments: the transcoded data,
2265 as a string, the back-end, as a symbol, and the communication
2269 "List of functions applied to a transcoded src-block.
2270 Each filter is called with three arguments: the transcoded data,
2271 as a string, the back-end, as a symbol, and the communication
2275 "List of functions applied to a transcoded table.
2276 Each filter is called with three arguments: the transcoded data,
2277 as a string, the back-end, as a symbol, and the communication
2281 "List of functions applied to a transcoded table-cell.
2282 Each filter is called with three arguments: the transcoded data,
2283 as a string, the back-end, as a symbol, and the communication
2287 "List of functions applied to a transcoded table-row.
2288 Each filter is called with three arguments: the transcoded data,
2289 as a string, the back-end, as a symbol, and the communication
2293 "List of functions applied to a transcoded verse block.
2294 Each filter is called with three arguments: the transcoded data,
2295 as a string, the back-end, as a symbol, and the communication
2299 ;;;; Objects Filters
2302 "List of functions applied to transcoded bold text.
2303 Each filter is called with three arguments: the transcoded data,
2304 as a string, the back-end, as a symbol, and the communication
2308 "List of functions applied to transcoded code text.
2309 Each filter is called with three arguments: the transcoded data,
2310 as a string, the back-end, as a symbol, and the communication
2314 "List of functions applied to a transcoded entity.
2315 Each filter is called with three arguments: the transcoded data,
2316 as a string, the back-end, as a symbol, and the communication
2320 "List of functions applied to a transcoded export-snippet.
2321 Each filter is called with three arguments: the transcoded data,
2322 as a string, the back-end, as a symbol, and the communication
2326 "List of functions applied to a transcoded footnote-reference.
2327 Each filter is called with three arguments: the transcoded data,
2328 as a string, the back-end, as a symbol, and the communication
2332 "List of functions applied to a transcoded inline-babel-call.
2333 Each filter is called with three arguments: the transcoded data,
2334 as a string, the back-end, as a symbol, and the communication
2338 "List of functions applied to a transcoded inline-src-block.
2339 Each filter is called with three arguments: the transcoded data,
2340 as a string, the back-end, as a symbol, and the communication
2344 "List of functions applied to transcoded italic text.
2345 Each filter is called with three arguments: the transcoded data,
2346 as a string, the back-end, as a symbol, and the communication
2350 "List of functions applied to a transcoded latex-fragment.
2351 Each filter is called with three arguments: the transcoded data,
2352 as a string, the back-end, as a symbol, and the communication
2356 "List of functions applied to a transcoded line-break.
2357 Each filter is called with three arguments: the transcoded data,
2358 as a string, the back-end, as a symbol, and the communication
2362 "List of functions applied to a transcoded link.
2363 Each filter is called with three arguments: the transcoded data,
2364 as a string, the back-end, as a symbol, and the communication
2368 "List of functions applied to a transcoded macro.
2369 Each filter is called with three arguments: the transcoded data,
2370 as a string, the back-end, as a symbol, and the communication
2374 "List of functions applied to a transcoded radio-target.
2375 Each filter is called with three arguments: the transcoded data,
2376 as a string, the back-end, as a symbol, and the communication
2380 "List of functions applied to a transcoded statistics-cookie.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to transcoded strike-through text.
2387 Each filter is called with three arguments: the transcoded data,
2388 as a string, the back-end, as a symbol, and the communication
2392 "List of functions applied to a transcoded subscript.
2393 Each filter is called with three arguments: the transcoded data,
2394 as a string, the back-end, as a symbol, and the communication
2398 "List of functions applied to a transcoded superscript.
2399 Each filter is called with three arguments: the transcoded data,
2400 as a string, the back-end, as a symbol, and the communication
2404 "List of functions applied to a transcoded target.
2405 Each filter is called with three arguments: the transcoded data,
2406 as a string, the back-end, as a symbol, and the communication
2410 "List of functions applied to a transcoded timestamp.
2411 Each filter is called with three arguments: the transcoded data,
2412 as a string, the back-end, as a symbol, and the communication
2416 "List of functions applied to transcoded underline text.
2417 Each filter is called with three arguments: the transcoded data,
2418 as a string, the back-end, as a symbol, and the communication
2422 "List of functions applied to transcoded verbatim text.
2423 Each filter is called with three arguments: the transcoded data,
2424 as a string, the back-end, as a symbol, and the communication
2428 ;;;; Filters Tools
2429 ;;
2430 ;; Internal function `org-export-install-filters' installs filters
2431 ;; hard-coded in back-ends (developer filters) and filters from global
2432 ;; variables (user filters) in the communication channel.
2433 ;;
2434 ;; Internal function `org-export-filter-apply-functions' takes care
2435 ;; about applying each filter in order to a given data. It ignores
2436 ;; filters returning a nil value but stops whenever a filter returns
2437 ;; an empty string.
2440 "Call every function in FILTERS.
2442 Functions are called with arguments VALUE, current export
2443 back-end and INFO. A function returning a nil value will be
2444 skipped. If it returns the empty string, the process ends and
2445 VALUE is ignored.
2447 Call is done in a LIFO fashion, to be sure that developer
2448 specified filters, if any, are called first."
2457 "Install filters properties in communication channel.
2459 INFO is a plist containing the current communication channel.
2461 Return the updated communication channel."
2463 ;; Install user defined filters with `org-export-filters-alist'.
2466 org-export-filters-alist)
2467 ;; Prepend back-end specific filters to that list.
2472 ;; Single values get consed, lists are prepended.
2477 plist key
2481 ;; Return new communication channel.
2485 \f
2486 ;;; Core functions
2487 ;;
2488 ;; This is the room for the main function, `org-export-as', along with
2489 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2490 ;; They differ only by the way they output the resulting code.
2491 ;;
2492 ;; `org-export-output-file-name' is an auxiliary function meant to be
2493 ;; used with `org-export-to-file'. With a given extension, it tries
2494 ;; to provide a canonical file name to write export output to.
2495 ;;
2496 ;; Note that `org-export-as' doesn't really parse the current buffer,
2497 ;; but a copy of it (with the same buffer-local variables and
2498 ;; visibility), where include keywords are expanded and Babel blocks
2499 ;; are executed, if appropriate.
2500 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2501 ;;
2502 ;; File inclusion is taken care of by
2503 ;; `org-export-expand-include-keyword' and
2504 ;; `org-export--prepare-file-contents'. Structure wise, including
2505 ;; a whole Org file in a buffer often makes little sense. For
2506 ;; example, if the file contains an headline and the include keyword
2507 ;; was within an item, the item should contain the headline. That's
2508 ;; why file inclusion should be done before any structure can be
2509 ;; associated to the file, that is before parsing.
2513 "Transcode current Org buffer into BACKEND code.
2515 If narrowing is active in the current buffer, only transcode its
2516 narrowed part.
2518 If a region is active, transcode that region.
2520 When optional argument SUBTREEP is non-nil, transcode the
2521 sub-tree at point, extracting information from the headline
2522 properties first.
2524 When optional argument VISIBLE-ONLY is non-nil, don't export
2525 contents of hidden elements.
2527 When optional argument BODY-ONLY is non-nil, only return body
2528 code, without preamble nor postamble.
2530 Optional argument EXT-PLIST, when provided, is a property list
2531 with external parameters overriding Org default settings, but
2532 still inferior to file-local settings.
2534 Optional argument NOEXPAND, when non-nil, prevents included files
2535 to be expanded and Babel code to be executed.
2537 Return code as a string."
2540 ;; Narrow buffer to an appropriate region or subtree for
2541 ;; parsing. If parsing subtree, be sure to remove main headline
2542 ;; too.
2550 ;; 1. Get export environment from original buffer. Also install
2551 ;; user's and developer's filters.
2554 ;; 2. Get parse tree. Buffer isn't parsed directly.
2555 ;; Instead, a temporary copy is created, where include
2556 ;; keywords are expanded and code blocks are evaluated.
2562 ;; TODO: Setting `org-current-export-file' is
2563 ;; required by Org Babel to properly resolve
2564 ;; noweb references. Once "org-exp.el" is
2565 ;; removed, modify
2566 ;; `org-export-blocks-preprocess' so it accepts
2567 ;; the value as an argument instead.
2571 ;; Run hook
2572 ;; `org-export-before-parsing-hook'. with current
2573 ;; back-end as argument.
2576 ;; Eventually parse buffer.
2578 ;; 3. Call parse-tree filters to get the final tree.
2582 ;; 4. Now tree is complete, compute its properties and add
2583 ;; them to communication channel.
2587 ;; 5. Eventually transcode TREE. Wrap the resulting string
2588 ;; into a template, if required. Eventually call
2589 ;; final-output filter.
2597 info)))
2598 ;; Maybe add final OUTPUT to kill ring, then return it.
2600 output)))))
2604 "Call `org-export-as' with output to a specified buffer.
2606 BACKEND is the back-end used for transcoding, as a symbol.
2608 BUFFER is the output buffer. If it already exists, it will be
2609 erased first, otherwise, it will be created.
2611 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2612 and NOEXPAND are similar to those used in `org-export-as', which
2613 see.
2615 Return buffer."
2617 backend subtreep visible-only body-only ext-plist noexpand))
2623 buffer))
2627 "Call `org-export-as' with output to a specified file.
2629 BACKEND is the back-end used for transcoding, as a symbol. FILE
2630 is the name of the output file, as a string.
2632 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2633 and NOEXPAND are similar to those used in `org-export-as', which
2634 see.
2636 Return output file's name."
2637 ;; Checks for FILE permissions. `write-file' would do the same, but
2638 ;; we'd rather avoid needless transcoding of parse tree.
2640 ;; Insert contents to a temporary buffer and write it to FILE.
2642 backend subtreep visible-only body-only ext-plist noexpand)))
2647 ;; Return full path.
2648 file)
2651 "Return output file's name according to buffer specifications.
2653 EXTENSION is a string representing the output file extension,
2654 with the leading dot.
2656 With a non-nil optional argument SUBTREEP, try to determine
2658 of subtree at point.
2660 When optional argument PUB-DIR is set, use it as the publishing
2661 directory.
2663 When optional argument VISIBLE-ONLY is non-nil, don't export
2664 contents of hidden elements.
2666 Return file name as a string, or nil if it couldn't be
2667 determined."
2669 ;; File name may come from EXPORT_FILE_NAME subtree property,
2670 ;; assuming point is at beginning of said sub-tree.
2677 ;; File name may be extracted from buffer's associated
2678 ;; file, if any.
2680 ;; Can't determine file name on our own: Ask user.
2684 "Output file: " pub-dir nil nil nil
2687 ;; Build file name. Enforce EXTENSION over whatever user may have
2688 ;; come up with. PUB-DIR, if defined, always has precedence over
2689 ;; any provided path.
2694 extension))
2700 "Apply BODY in a copy of the current buffer.
2702 The copy preserves local variables and visibility of the original
2703 buffer.
2705 Point is at buffer's beginning when BODY is applied."
2715 ,original-buffer
2720 ov
2730 "Expand every include keyword in buffer.
2731 Optional argument INCLUDED is a list of included file names along
2732 with their line restriction, when appropriate. It is used to
2733 avoid infinite recursion. Optional argument DIR is the current
2734 working directory. It is used to properly resolve relative
2735 paths."
2742 ;; Extract arguments from keyword's value.
2756 ;; Minimal level of included file defaults to the child
2757 ;; level of the current headline, if any, or one. It
2758 ;; only applies is the file is meant to be included as
2759 ;; an Org one.
2767 ;; Remove keyword.
2771 ;; Check if files has already been parsed. Look after
2772 ;; inclusion lines too, as different parts of the same file
2773 ;; can be included too.
2782 ;; Protect sensitive contents with commas.
2788 ind-str contents ind-str))))
2793 ;; Protect sensitive contents with commas.
2800 ind-str env contents ind-str))))
2813 "Prepare the contents of FILE for inclusion and return them as a string.
2815 When optional argument LINES is a string specifying a range of
2816 lines, include only those lines.
2818 Optional argument IND, when non-nil, is an integer specifying the
2819 global indentation of returned contents. Since its purpose is to
2820 allow an included file to stay in the same environment it was
2821 created \(i.e. a list item), it doesn't apply past the first
2822 headline encountered.
2824 Optional argument MINLEVEL, when non-nil, is an integer
2825 specifying the level that any top-level headline in the included
2826 file should have."
2842 ;; Remove blank lines at beginning and end of contents. The logic
2843 ;; behind that removal is that blank lines around include keyword
2844 ;; override blank lines in included file.
2853 ;; If IND is set, preserve indentation of include keyword until
2854 ;; the first headline encountered.
2860 ;; Do not move footnote definitions out of column 0.
2866 ;; When MINLEVEL is specified, compute minimal level for headlines
2867 ;; in the file (CUR-MIN), and remove stars to each headline so
2868 ;; that headlines with minimal level have a level of MINLEVEL.
2877 ;; Only change stars, don't bother moving whole
2878 ;; sections.
2884 \f
2885 ;;; Tools For Back-Ends
2886 ;;
2887 ;; A whole set of tools is available to help build new exporters. Any
2888 ;; function general enough to have its use across many back-ends
2889 ;; should be added here.
2890 ;;
2891 ;; As of now, functions operating on footnotes, headlines, links,
2892 ;; macros, references, src-blocks, tables and tables of contents are
2893 ;; implemented.
2895 ;;;; For Affiliated Keywords
2896 ;;
2897 ;; `org-export-read-attribute' reads a property from a given element
2898 ;; as a plist. It can be used to normalize affiliated keywords'
2899 ;; syntax.
2902 "Turn ATTRIBUTE property from ELEMENT into a plist.
2904 When optional argument PROPERTY is non-nil, return the value of
2905 that property within attributes.
2909 properties."
2917 ;;;; For Export Snippets
2918 ;;
2919 ;; Every export snippet is transmitted to the back-end. Though, the
2920 ;; latter will only retain one type of export-snippet, ignoring
2921 ;; others, based on the former's target back-end. The function
2922 ;; `org-export-snippet-backend' returns that back-end for a given
2923 ;; export-snippet.
2926 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2927 Translation, with `org-export-snippet-translation-alist', is
2928 applied."
2932 back-end))))
2935 ;;;; For Footnotes
2936 ;;
2937 ;; `org-export-collect-footnote-definitions' is a tool to list
2938 ;; actually used footnotes definitions in the whole parse tree, or in
2939 ;; an headline, in order to add footnote listings throughout the
2940 ;; transcoded data.
2941 ;;
2942 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2943 ;; back-ends, when they need to attach the footnote definition only to
2944 ;; the first occurrence of the corresponding label.
2945 ;;
2946 ;; `org-export-get-footnote-definition' and
2947 ;; `org-export-get-footnote-number' provide easier access to
2948 ;; additional information relative to a footnote reference.
2951 "Return an alist between footnote numbers, labels and definitions.
2953 DATA is the parse tree from which definitions are collected.
2954 INFO is the plist used as a communication channel.
2956 Definitions are sorted by order of references. They either
2957 appear as Org data or as a secondary string for inlined
2958 footnotes. Unreferenced definitions are ignored."
2960 collect-fn ; for byte-compiler.
2964 ;; Collect footnote number, label and definition in DATA.
2966 data 'footnote-reference
2973 def)
2974 num-alist)
2975 ;; Also search in definition for nested footnotes.
2978 ;; Don't enter footnote definitions since it will happen
2979 ;; when their first reference is found.
2985 "Non-nil when a footnote reference is the first one for its label.
2987 FOOTNOTE-REFERENCE is the footnote reference being considered.
2988 INFO is the plist used as a communication channel."
2990 ;; Anonymous footnotes are always a first reference.
2992 ;; Otherwise, return the first footnote with the same LABEL and
2993 ;; test if it is equal to FOOTNOTE-REFERENCE.
2999 data 'footnote-reference
3004 ;; If FN isn't inlined, be sure to traverse its
3005 ;; definition before resuming search. See
3006 ;; comments in `org-export-get-footnote-number'
3007 ;; for more information.
3011 ;; Don't enter footnote definitions since it will
3012 ;; happen when their first reference is found.
3015 footnote-reference)))))
3018 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3019 INFO is the plist used as a communication channel."
3025 "Return number associated to a footnote.
3027 FOOTNOTE is either a footnote reference or a footnote definition.
3028 INFO is the plist used as a communication channel."
3030 seen-refs
3031 search-ref ; For byte-compiler.
3035 ;; Search footnote references through DATA, filling
3036 ;; SEEN-REFS along the way.
3038 data 'footnote-reference
3042 ;; Anonymous footnote match: return number.
3045 ;; Labels match: return number.
3048 ;; Anonymous footnote: it's always a new one. Also,
3049 ;; be sure to return nil from the `cond' so
3050 ;; `first-match' doesn't get us out of the loop.
3052 ;; Label not seen so far: add it so SEEN-REFS.
3053 ;;
3054 ;; Also search for subsequent references in
3055 ;; footnote definition so numbering follows reading
3056 ;; logic. Note that we don't have to care about
3057 ;; inline definitions, since `org-element-map'
3058 ;; already traverses them at the right time.
3059 ;;
3060 ;; Once again, return nil to stay in the loop.
3065 nil))))
3066 ;; Don't enter footnote definitions since it will happen
3067 ;; when their first reference is found.
3072 ;;;; For Headlines
3073 ;;
3074 ;; `org-export-get-relative-level' is a shortcut to get headline
3075 ;; level, relatively to the lower headline level in the parsed tree.
3076 ;;
3077 ;; `org-export-get-headline-number' returns the section number of an
3078 ;; headline, while `org-export-number-to-roman' allows to convert it
3079 ;; to roman numbers.
3080 ;;
3081 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3082 ;; `org-export-last-sibling-p' are three useful predicates when it
3083 ;; comes to fulfill the `:headline-levels' property.
3086 "Return HEADLINE relative level within current parsed tree.
3087 INFO is a plist holding contextual information."
3092 "Non-nil when HEADLINE is considered as low level.
3094 INFO is a plist used as a communication channel.
3096 A low level headlines has a relative level greater than
3097 `:headline-levels' property value.
3099 Return value is the difference between HEADLINE relative level
3100 and the last level being considered as high enough, or nil."
3107 "Return HEADLINE numbering as a list of numbers.
3108 INFO is a plist holding contextual information."
3112 "Return a non-nil value if HEADLINE element should be numbered.
3113 INFO is a plist used as a communication channel."
3119 "Convert integer N into a roman numeral."
3132 res)))
3135 "Return list of tags associated to ELEMENT.
3137 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3138 is a plist used as a communication channel.
3140 Select tags (see `org-export-select-tags') and exclude tags (see
3141 `org-export-exclude-tags') are removed from the list.
3143 When non-nil, optional argument TAGS should be a list of strings.
3144 Any tag belonging to this list will also be removed."
3151 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3152 INFO is a plist used as a communication channel."
3157 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3158 INFO is a plist used as a communication channel."
3162 ;;;; For Links
3163 ;;
3164 ;; `org-export-solidify-link-text' turns a string into a safer version
3165 ;; for links, replacing most non-standard characters with hyphens.
3166 ;;
3167 ;; `org-export-get-coderef-format' returns an appropriate format
3168 ;; string for coderefs.
3169 ;;
3170 ;; `org-export-inline-image-p' returns a non-nil value when the link
3171 ;; provided should be considered as an inline image.
3172 ;;
3173 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3174 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3175 ;; returns an appropriate unique identifier when found, or nil.
3176 ;;
3177 ;; `org-export-resolve-id-link' returns the first headline with
3178 ;; specified id or custom-id in parse tree, the path to the external
3179 ;; file with the id or nil when neither was found.
3180 ;;
3181 ;; `org-export-resolve-coderef' associates a reference to a line
3182 ;; number in the element it belongs, or returns the reference itself
3183 ;; when the element isn't numbered.
3186 "Take link text S and make a safe target out of it."
3191 "Return format string for code reference link.
3192 PATH is the link path. DESC is its description."
3200 "Non-nil if LINK object points to an inline image.
3202 Optional argument is a set of RULES defining inline images. It
3203 is an alist where associations have the following shape:
3205 \(TYPE . REGEXP)
3207 Applying a rule means apply REGEXP against LINK's path when its
3208 type is TYPE. The function will return a non-nil value if any of
3209 the provided rules is non-nil. The default rule is
3210 `org-export-default-inline-image-rule'.
3212 This only applies to links without a description."
3223 rules)
3224 ;; Return nil if no rule matched.
3225 nil))))
3228 "Resolve a code reference REF.
3230 INFO is a plist used as a communication channel.
3232 Return associated line number in source code, or REF itself,
3233 depending on src-block or example element's switches."
3241 org-coderef-label-format)))
3245 ;; Element containing REF is found. Resolve it to either
3246 ;; a label or a line number, as needed.
3256 "Return LINK destination.
3258 INFO is a plist holding contextual information.
3260 Return value can be an object, an element, or nil:
3262 - If LINK path matches a target object (i.e. <<path>>) or
3265 - If LINK path exactly matches the name affiliated keyword
3266 \(i.e. #+NAME: path) of an element, return that element.
3268 - If LINK path exactly matches any headline name, return that
3269 element. If more than one headline share that name, priority
3270 will be given to the one with the closest common ancestor, if
3271 any, or the first one in the parse tree otherwise.
3273 - Otherwise, return nil.
3279 ;; First try to find a matching "<<path>>" unless user specified
3280 ;; he was looking for an headline (path starts with a *
3281 ;; character).
3285 return target)))
3286 ;; Then try to find an element with a matching "#+NAME: path"
3287 ;; affiliated keyword.
3294 ;; Last case: link either points to an headline or to
3295 ;; nothingness. Try to find the source, with priority given to
3296 ;; headlines with the closest common ancestor. If such candidate
3297 ;; is found, return it, otherwise return nil.
3301 ;; Return first headline whose `:raw-value' property
3302 ;; is NAME in parse tree DATA, or nil.
3305 data 'headline
3309 name)
3310 headline))
3312 ;; Search among headlines sharing an ancestor with link,
3313 ;; from closest to farthest.
3321 ;; No match with a common ancestor: try the full parse-tree.
3327 "Return headline referenced as LINK destination.
3329 INFO is a plist used as a communication channel.
3331 Return value can be the headline element matched in current parse
3335 ;; First check if id is within the current parse tree.
3341 headline))
3343 ;; Otherwise, look for external files.
3347 "Return radio-target object referenced as LINK destination.
3349 INFO is a plist used as a communication channel.
3351 Return value can be a radio-target object or nil. Assume LINK
3361 ;;;; For Macros
3362 ;;
3363 ;; `org-export-expand-macro' simply takes care of expanding macros.
3366 "Expand MACRO and return it as a string.
3367 INFO is a plist holding export options."
3370 ;; User's macros are stored in the communication channel with
3371 ;; a ":macro-" prefix. Replace arguments in VALUE. Also
3372 ;; expand recursively macros within.
3381 obj)))
3383 info)))
3384 ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
3386 ;; Return string.
3390 ;;;; For References
3391 ;;
3392 ;; `org-export-get-ordinal' associates a sequence number to any object
3393 ;; or element.
3396 "Return ordinal number of an element or object.
3398 ELEMENT is the element or object considered. INFO is the plist
3399 used as a communication channel.
3401 Optional argument TYPES, when non-nil, is a list of element or
3402 object types, as symbols, that should also be counted in.
3403 Otherwise, only provided element's type is considered.
3405 Optional argument PREDICATE is a function returning a non-nil
3406 value if the current element or object should be counted in. It
3407 accepts two arguments: the element or object being considered and
3408 the plist used as a communication channel. This allows to count
3409 only a certain type of objects (i.e. inline images).
3411 Return value is a list of numbers if ELEMENT is an headline or an
3412 item. It is nil for keywords. It represents the footnote number
3413 for footnote definitions and footnote references. If ELEMENT is
3414 a target, return the same value as if ELEMENT was the closest
3415 table, item or headline containing the target. In any other
3416 case, return the sequence number of ELEMENT among elements or
3417 objects of the same type."
3418 ;; A target keyword, representing an invisible target, never has
3419 ;; a sequence number.
3421 ;; Ordinal of a target object refer to the ordinal of the closest
3422 ;; table, item, or headline containing the object.
3426 when
3430 table))
3431 return parent)))
3433 ;; Special case 1: An headline returns its number as a list.
3435 ;; Special case 2: An item returns its number as a list.
3439 struct
3446 ;; Increment counter until ELEMENT is found again.
3457 ;;;; For Src-Blocks
3458 ;;
3459 ;; `org-export-get-loc' counts number of code lines accumulated in
3460 ;; src-block or example-block elements with a "+n" switch until
3461 ;; a given element, excluded. Note: "-n" switches reset that count.
3462 ;;
3463 ;; `org-export-unravel-code' extracts source code (along with a code
3464 ;; references alist) from an `element-block' or `src-block' type
3465 ;; element.
3466 ;;
3467 ;; `org-export-format-code' applies a formatting function to each line
3468 ;; of code, providing relative line number and code reference when
3469 ;; appropriate. Since it doesn't access the original element from
3470 ;; which the source code is coming, it expects from the code calling
3471 ;; it to know if lines should be numbered and if code references
3472 ;; should appear.
3473 ;;
3474 ;; Eventually, `org-export-format-code-default' is a higher-level
3475 ;; function (it makes use of the two previous functions) which handles
3476 ;; line numbering and code references inclusion, and returns source
3477 ;; code in a format suitable for plain text or verbatim output.
3480 "Return accumulated lines of code up to ELEMENT.
3482 INFO is the plist used as a communication channel.
3484 ELEMENT is excluded from count."
3491 ;; ELEMENT is reached: Quit the loop.
3493 ;; Only count lines from src-block and example-block elements
3494 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3498 ;; Accumulate locs or reset them.
3502 ;; Return nil to stay in the loop.
3503 nil)))
3505 ;; Return value.
3506 loc))
3509 "Clean source code and extract references out of it.
3511 ELEMENT has either a `src-block' an `example-block' type.
3513 Return a cons cell whose CAR is the source code, cleaned from any
3514 reference and protective comma and CDR is an alist between
3515 relative line number (integer) and name of code reference on that
3516 line (string)."
3518 ;; Get code and clean it. Remove blank lines at its
3519 ;; beginning and end. Also remove protective commas.
3525 ;; If appropriate, remove global indentation.
3529 ;; Free up the protected lines. Note: Org blocks
3530 ;; have commas at the beginning or every line.
3535 ;; Get format used for references.
3538 org-coderef-label-format)))
3539 ;; Build a regexp matching a loc with a reference.
3544 ;; Return value.
3546 ;; Code with references removed.
3552 ;; Ref line: remove ref, and signal its position in REFS.
3556 ;; Reference alist.
3557 refs)))
3560 "Format CODE by applying FUN line-wise and return it.
3562 CODE is a string representing the code to format. FUN is
3563 a function. It must accept three arguments: a line of
3564 code (string), the current line number (integer) or nil and the
3565 reference associated to the current line (string) or nil.
3567 Optional argument NUM-LINES can be an integer representing the
3568 number of code lines accumulated until the current code. Line
3569 numbers passed to FUN will take it into account. If it is nil,
3570 FUN's second argument will always be nil. This number can be
3571 obtained with `org-export-get-loc' function.
3573 Optional argument REF-ALIST can be an alist between relative line
3574 number (i.e. ignoring NUM-LINES) and the name of the code
3575 reference on it. If it is nil, FUN's third argument will always
3576 be nil. It can be obtained through the use of
3577 `org-export-unravel-code' function."
3589 "Return source code from ELEMENT, formatted in a standard way.
3591 ELEMENT is either a `src-block' or `example-block' element. INFO
3592 is a plist used as a communication channel.
3594 This function takes care of line numbering and code references
3595 inclusion. Line numbers, when applicable, appear at the
3596 beginning of the line, separated from the code by two white
3597 spaces. Code references, on the other hand, appear flushed to
3598 the right, separated by six white spaces from the widest line of
3599 code."
3600 ;; Extract code and references.
3606 ;; Handle line numbering.
3615 ;; Prepare references display, if required. Any reference
3616 ;; should start six columns after the widest line of code,
3617 ;; wrapped with parenthesis.
3622 code
3626 number-str
3627 loc
3633 num-start refs)))
3636 ;;;; For Tables
3637 ;;
3638 ;; `org-export-table-has-special-column-p' and and
3639 ;; `org-export-table-row-is-special-p' are predicates used to look for
3640 ;; meta-information about the table structure.
3641 ;;
3642 ;; `org-table-has-header-p' tells when the rows before the first rule
3643 ;; should be considered as table's header.
3644 ;;
3645 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3646 ;; and `org-export-table-cell-borders' extract information from
3647 ;; a table-cell element.
3648 ;;
3649 ;; `org-export-table-dimensions' gives the number on rows and columns
3650 ;; in the table, ignoring horizontal rules and special columns.
3651 ;; `org-export-table-cell-address', given a table-cell object, returns
3652 ;; the absolute address of a cell. On the other hand,
3653 ;; `org-export-get-table-cell-at' does the contrary.
3654 ;;
3655 ;; `org-export-table-cell-starts-colgroup-p',
3656 ;; `org-export-table-cell-ends-colgroup-p',
3657 ;; `org-export-table-row-starts-rowgroup-p',
3658 ;; `org-export-table-row-ends-rowgroup-p',
3659 ;; `org-export-table-row-starts-header-p' and
3660 ;; `org-export-table-row-ends-header-p' indicate position of current
3661 ;; row or cell within the table.
3664 "Non-nil when TABLE has a special column.
3665 All special columns will be ignored during export."
3666 ;; The table has a special column when every first cell of every row
3667 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3668 ;; "*" "_" and "^". Though, do not consider a first row containing
3669 ;; only empty cells as special.
3685 "Non-nil when TABLE has an header.
3687 INFO is a plist used as a communication channel.
3689 A table has an header when it contains at least two row groups."
3692 table 'table-row
3700 info)))
3703 "Non-nil if TABLE-ROW is considered special.
3705 INFO is a plist used as the communication channel.
3707 All special rows will be ignored during export."
3711 ;; A row is special either when...
3713 ;; ... it starts with a field only containing "/",
3715 ;; ... the table contains a special column and the row start
3716 ;; with a marking character among, "^", "_", "$" or "!",
3720 ;; ... it contains only alignment cookies and empty cells.
3726 ;; Since VALUE is a secondary string, the following
3727 ;; checks avoid expanding it with `org-export-data'.
3739 "Return TABLE-ROW's group.
3741 INFO is a plist used as the communication channel.
3743 Return value is the group number, as an integer, or nil special
3744 rows and table rules. Group 1 is also table's header."
3761 "Return TABLE-CELL contents width.
3763 INFO is a plist used as the communication channel.
3765 Return value is the width given by the last width cookie in the
3766 same column as TABLE-CELL, or nil."
3771 cookie-width)
3775 ;; In a special row, try to find a width cookie at COLUMN.
3779 ;; The following checks avoid expanding unnecessarily the
3780 ;; cell with `org-export-data'
3788 ;; Ignore table rules.
3791 ;; Return value.
3792 cookie-width))
3795 "Return TABLE-CELL contents alignment.
3797 INFO is a plist used as the communication channel.
3799 Return alignment as specified by the last alignment cookie in the
3800 same column as TABLE-CELL. If no such cookie is found, a default
3801 alignment value will be deduced from fraction of numbers in the
3802 column (see `org-table-number-fraction' for more information).
3803 Possible values are `left', `right' and `center'."
3810 cookie-align)
3814 ;; In a special row, try to find an alignment cookie at
3815 ;; COLUMN.
3819 ;; Since VALUE is a secondary string, the following checks
3820 ;; avoid useless expansion through `org-export-data'.
3828 ;; Ignore table rules.
3830 ;; In a standard row, check if cell's contents are expressing
3831 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3832 ;; Though, don't bother if an alignment cookie has already
3833 ;; defined cell's alignment.
3838 info)))
3843 ;; Return value. Alignment specified by cookies has precedence
3844 ;; over alignment deduced from cells contents.
3853 "Return TABLE-CELL borders.
3855 INFO is a plist used as a communication channel.
3857 Return value is a list of symbols, or nil. Possible values are:
3858 `top', `bottom', `above', `below', `left' and `right'. Note:
3859 `top' (resp. `bottom') only happen for a cell in the first
3860 row (resp. last row) of the table, ignoring table rules, if any.
3862 Returned borders ignore special rows."
3865 borders)
3866 ;; Top/above border? TABLE-CELL has a border above when a rule
3867 ;; used to demarcate row groups can be found above. Hence,
3868 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3869 ;; another regular row has to be found above that rule.
3878 ;; Look at every row before the current one.
3880 ;; No rule above, or rule found starts the table (ignoring any
3881 ;; special row): TABLE-CELL is at the top of the table.
3884 ;; Bottom/below border? TABLE-CELL has a border below when next
3885 ;; non-regular row below is a rule.
3894 ;; Look at every row after the current one.
3896 ;; No rule below, or rule found ends the table (modulo some
3897 ;; special row): TABLE-CELL is at the bottom of the table.
3900 ;; Right/left borders? They can only be specified by column
3901 ;; groups. Column groups are defined in a row starting with "/".
3902 ;; Also a column groups row only contains "<", "<>", ">" or blank
3903 ;; cells.
3920 ;; There's a left border when previous cell, if
3921 ;; any, ends a group, or current one starts one.
3927 ;; There's a right border when next cell, if any,
3928 ;; starts a group, or current one ends one.
3935 ;; Table rows are read in reverse order so last column groups
3936 ;; row has precedence over any previous one.
3938 ;; Return value.
3939 borders))
3942 "Non-nil when TABLE-CELL is at the beginning of a row group.
3943 INFO is a plist used as a communication channel."
3944 ;; A cell starts a column group either when it is at the beginning
3945 ;; of a row (or after the special column, if any) or when it has
3946 ;; a left border.
3950 table-cell)
3954 "Non-nil when TABLE-CELL is at the end of a row group.
3955 INFO is a plist used as a communication channel."
3956 ;; A cell ends a column group either when it is at the end of a row
3957 ;; or when it has a right border.
3960 table-cell)
3964 "Non-nil when TABLE-ROW is at the beginning of a column group.
3965 INFO is a plist used as a communication channel."
3973 "Non-nil when TABLE-ROW is at the end of a column group.
3974 INFO is a plist used as a communication channel."
3982 "Non-nil when TABLE-ROW is the first table header's row.
3983 INFO is a plist used as a communication channel."
3990 "Non-nil when TABLE-ROW is the last table header's row.
3991 INFO is a plist used as a communication channel."
3998 "Return TABLE dimensions.
4000 INFO is a plist used as a communication channel.
4002 Return value is a CONS like (ROWS . COLUMNS) where
4003 ROWS (resp. COLUMNS) is the number of exportable
4004 rows (resp. columns)."
4006 ;; Set number of rows, and extract first one.
4008 table 'table-row
4013 ;; Set number of columns.
4015 ;; Return value.
4019 "Return address of a regular TABLE-CELL object.
4021 TABLE-CELL is the cell considered. INFO is a plist used as
4022 a communication channel.
4024 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4025 zero-based index. Only exportable cells are considered. The
4026 function returns nil for other cells."
4029 ;; Ignore cells in special rows or in special column.
4034 ;; Row number.
4037 table 'table-row
4043 ;; Column number.
4046 table-row 'table-cell
4052 "Return regular table-cell object at ADDRESS in TABLE.
4054 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4055 zero-based index. TABLE is a table type element. INFO is
4056 a plist used as a communication channel.
4058 If no table-cell, among exportable cells, is found at ADDRESS,
4059 return nil."
4062 ;; Row at (car address) or nil.
4065 table 'table-row
4071 'table-cell
4078 ;;;; For Tables Of Contents
4079 ;;
4080 ;; `org-export-collect-headlines' builds a list of all exportable
4081 ;; headline elements, maybe limited to a certain depth. One can then
4082 ;; easily parse it and transcode it.
4083 ;;
4084 ;; Building lists of tables, figures or listings is quite similar.
4085 ;; Once the generic function `org-export-collect-elements' is defined,
4086 ;; `org-export-collect-tables', `org-export-collect-figures' and
4087 ;; `org-export-collect-listings' can be derived from it.
4090 "Collect headlines in order to build a table of contents.
4092 INFO is a plist used as a communication channel.
4094 When optional argument N is an integer, it specifies the depth of
4095 the table of contents. Otherwise, it is set to the value of the
4096 last headline level. See `org-export-headline-levels' for more
4097 information.
4099 Return a list of all exportable headlines as parsed elements."
4103 'headline
4105 ;; Strip contents from HEADLINE.
4108 info))
4111 "Collect referenceable elements of a determined type.
4113 TYPE can be a symbol or a list of symbols specifying element
4114 types to search. Only elements with a caption are collected.
4116 INFO is a plist used as a communication channel.
4118 When non-nil, optional argument PREDICATE is a function accepting
4119 one argument, an element of type TYPE. It returns a non-nil
4120 value when that element should be collected.
4122 Return a list of all elements found, in order of appearance."
4128 element))
4129 info))
4132 "Build a list of tables.
4133 INFO is a plist used as a communication channel.
4135 Return a list of table elements with a caption."
4139 "Build a list of figures.
4141 INFO is a plist used as a communication channel. PREDICATE is
4142 a function which accepts one argument: a paragraph element and
4143 whose return value is non-nil when that element should be
4144 collected.
4146 A figure is a paragraph type element, with a caption, verifying
4148 a vague concept that may depend on back-end.
4150 Return a list of elements recognized as figures."
4154 "Build a list of src blocks.
4156 INFO is a plist used as a communication channel.
4158 Return a list of src-block elements with a caption."
4162 ;;;; Topology
4163 ;;
4164 ;; Here are various functions to retrieve information about the
4165 ;; neighbourhood of a given element or object. Neighbours of interest
4166 ;; are direct parent (`org-export-get-parent'), parent headline
4167 ;; (`org-export-get-parent-headline'), first element containing an
4168 ;; object, (`org-export-get-parent-element'), parent table
4169 ;; (`org-export-get-parent-table'), previous element or object
4170 ;; (`org-export-get-previous-element') and next element or object
4171 ;; (`org-export-get-next-element').
4172 ;;
4173 ;; `org-export-get-genealogy' returns the full genealogy of a given
4174 ;; element or object, from closest parent to full parse tree.
4177 "Return BLOB parent or nil.
4178 BLOB is the element or object considered."
4182 "Return full genealogy relative to a given element or object.
4184 BLOB is the element or object being considered.
4186 Ancestors are returned from closest to farthest, the last one
4187 being the full parse tree."
4194 "Return BLOB parent headline or nil.
4195 BLOB is the element or object being considered."
4199 parent))
4202 "Return first element containing OBJECT or nil.
4203 OBJECT is the object to consider."
4207 parent))
4210 "Return OBJECT parent table or nil.
4211 OBJECT is either a `table-cell' or `table-element' type object."
4215 parent))
4218 "Return previous element or object.
4219 BLOB is an element or object. INFO is a plist used as
4220 a communication channel. Return previous exportable element or
4221 object, a string, or nil."
4231 "Return next element or object.
4232 BLOB is an element or object. INFO is a plist used as
4233 a communication channel. Return next exportable element or
4234 object, a string, or nil."
4240 nil))
4243 ;;;; Translation
4244 ;;
4245 ;; `org-export-translate' translates a string according to language
4246 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4247 ;; variable and a specified charset. `org-export-dictionary' contains
4248 ;; the dictionary used for the translation.
4313 "Dictionary for export engine.
4315 Alist whose CAR is the string to translate and CDR is an alist
4316 whose CAR is the language string and CDR is a plist whose
4317 properties are possible charsets and values translated terms.
4319 It is used as a database for `org-export-translate'. Since this
4320 function returns the string as-is if no translation was found,
4321 the variable only needs to record values different from the
4325 "Translate string S according to language specification.
4327 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4328 and `:utf-8'. INFO is a plist used as a communication channel.
4330 Translation depends on `:language' property. Return the
4331 translated string. If no translation is found return S."
4337 \f
4338 ;;; The Dispatcher
4339 ;;
4340 ;; `org-export-dispatch' is the standard interactive way to start an
4341 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4342 ;; for its interface. Most commons back-ends should have an entry in
4343 ;; it.
4345 ;;;###autoload
4347 "Export dispatcher for Org mode.
4349 It provides an access to common export related tasks in a buffer.
4350 Its interface comes in two flavours: standard and expert. While
4351 both share the same set of bindings, only the former displays the
4352 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4353 to switch to one or the other.
4355 Return an error if key pressed has no associated command."
4360 org-export-dispatch-use-expert-ui))
4363 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4364 ;; depending on user's key pressed.
4366 ;; Allow to quit with "q" key.
4368 ;; Export with `e-ascii' back-end.
4377 ;; Export with `e-latex' back-end.
4380 (?l
4383 (?p
4386 (?d
4390 ;; Export with `e-html' back-end.
4391 (?H
4394 (?h
4397 (?b
4401 ;; Export with `e-odt' back-end.
4402 (?o
4405 (?O
4409 ;; Publishing facilities
4410 (?F
4412 (?P
4414 (?X
4418 org-e-publish-project-alist)))
4420 (?E
4422 ;; Undefined command.
4427 "Handle interface for `org-export-dispatch'.
4429 OPTIONS is a list containing current interactive options set for
4430 export. It can contain any of the following symbols:
4431 `body' toggles a body-only export
4432 `subtree' restricts export to current subtree
4433 `visible' restricts export to visible part of buffer.
4434 `force' force publishing files.
4436 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4437 buffer is provided, but indications about currently active
4438 options are given in the prompt. Moreover, \[?] allows to switch
4439 back to standard interface.
4441 Return value is a list with key pressed as CAR and a list of
4442 final interactive export options as CDR."
4446 \[1] Body only: %s [2] Export scope: %s
4447 \[3] Visible only: %s [4] Force publishing: %s
4450 --- (ASCII/Latin-1/UTF-8 Export) -------------------------
4452 \[a/n/u] to TXT file [A/N/U] to temporary buffer
4454 --- (HTML Export) ----------------------------------------
4456 \[h] to HTML file [b] ... and open it
4457 \[H] to temporary buffer
4459 --- (LaTeX Export) ---------------------------------------
4461 \[l] to TEX file [L] to temporary buffer
4462 \[p] to PDF file [d] ... and open it
4464 --- (ODF Export) -----------------------------------------
4466 \[o] to ODT file [O] ... and open it
4468 --- (Publish) --------------------------------------------
4470 \[F] current file [P] current project
4471 \[X] a project [E] every project"
4484 ;; Read a character from command input, toggling interactive
4485 ;; options when applicable. PROMPT is the displayed prompt,
4486 ;; as a string.
4490 ;; Ignore non-standard characters (i.e. "M-a").
4492 ;; Help key: Switch back to standard interface if
4493 ;; expert UI was active.
4495 ;; Toggle export options.
4502 expertp))
4503 ;; Action selected: Send key and options back to
4504 ;; `org-export-dispatch'.
4506 ;; With expert UI, just read key with a fancy prompt. In standard
4507 ;; UI, display an intrusive help buffer.
4518 ;;; org-export.el ends here