| blob | 3ca7b5de7a067b0b0f55d07a6a09542b71b94c16 |
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.
750 :options-alist
752 Alist between back-end specific properties introduced in
753 communication channel and how their value are acquired. See
754 `org-export-options-alist' for more information about
755 structure of the values.
757 As an example, here is how the `e-ascii' back-end is defined:
759 \(org-export-define-backend e-ascii
760 \((bold . org-e-ascii-bold)
761 \(center-block . org-e-ascii-center-block)
762 \(clock . org-e-ascii-clock)
763 \(code . org-e-ascii-code)
764 \(drawer . org-e-ascii-drawer)
765 \(dynamic-block . org-e-ascii-dynamic-block)
766 \(entity . org-e-ascii-entity)
767 \(example-block . org-e-ascii-example-block)
768 \(export-block . org-e-ascii-export-block)
769 \(export-snippet . org-e-ascii-export-snippet)
770 \(fixed-width . org-e-ascii-fixed-width)
771 \(footnote-definition . org-e-ascii-footnote-definition)
772 \(footnote-reference . org-e-ascii-footnote-reference)
773 \(headline . org-e-ascii-headline)
774 \(horizontal-rule . org-e-ascii-horizontal-rule)
775 \(inline-src-block . org-e-ascii-inline-src-block)
776 \(inlinetask . org-e-ascii-inlinetask)
777 \(italic . org-e-ascii-italic)
778 \(item . org-e-ascii-item)
779 \(keyword . org-e-ascii-keyword)
780 \(latex-environment . org-e-ascii-latex-environment)
781 \(latex-fragment . org-e-ascii-latex-fragment)
782 \(line-break . org-e-ascii-line-break)
783 \(link . org-e-ascii-link)
784 \(macro . org-e-ascii-macro)
785 \(paragraph . org-e-ascii-paragraph)
786 \(plain-list . org-e-ascii-plain-list)
787 \(plain-text . org-e-ascii-plain-text)
788 \(planning . org-e-ascii-planning)
789 \(property-drawer . org-e-ascii-property-drawer)
790 \(quote-block . org-e-ascii-quote-block)
791 \(quote-section . org-e-ascii-quote-section)
792 \(radio-target . org-e-ascii-radio-target)
793 \(section . org-e-ascii-section)
794 \(special-block . org-e-ascii-special-block)
795 \(src-block . org-e-ascii-src-block)
796 \(statistics-cookie . org-e-ascii-statistics-cookie)
797 \(strike-through . org-e-ascii-strike-through)
798 \(subscript . org-e-ascii-subscript)
799 \(superscript . org-e-ascii-superscript)
800 \(table . org-e-ascii-table)
801 \(table-cell . org-e-ascii-table-cell)
802 \(table-row . org-e-ascii-table-row)
803 \(target . org-e-ascii-target)
804 \(template . org-e-ascii-template)
805 \(timestamp . org-e-ascii-timestamp)
806 \(underline . org-e-ascii-underline)
807 \(verbatim . org-e-ascii-verbatim)
808 \(verse-block . org-e-ascii-verse-block))
810 :filters-alist ((:filter-headline . org-e-ascii-filter-headline-blank-lines)
811 \(:filter-section . org-e-ascii-filter-headline-blank-lines))
812 :options-alist ((:ascii-charset nil nil org-e-ascii-charset)))"
826 ;; Define translators.
829 ;; Define options.
833 See `org-export-options-alist' for more information on the
834 structure of the values."
835 backend)))
836 ;; Define filters.
839 "Alist between filters keywords and back-end specific filters.
841 ;; Tell parser to not parse EXPORT-BLOCK blocks.
848 ;; Splice in the body, if any.
852 "Create a new back-end as a variant of an existing one.
854 CHILD is the name of the derived back-end. PARENT is the name of
855 the parent back-end.
857 BODY can start with pre-defined keyword arguments. The following
858 keywords are understood:
860 :export-block
862 String, or list of strings, representing block names that
863 will not be parsed. This is used to specify blocks that will
864 contain raw code specific to the back-end. These blocks
865 still have to be handled by the relative `export-block' type
866 translator.
868 :filters-alist
870 Alist of filters that will overwrite or complete filters
871 defined in PARENT back-end. See `org-export-filters-alist'
872 for more a list of allowed filters.
874 :options-alist
876 Alist of back-end specific properties that will overwrite or
877 complete those defined in PARENT back-end. Refer to
878 `org-export-options-alist' for more information about
879 structure of the values.
881 :translate-alist
883 Alist of element and object types and transcoders that will
884 overwrite or complete transcode table from PARENT back-end.
885 Refer to `org-export-define-backend' for detailed information
886 about transcoders.
889 as a variant of `e-latex' back-end with a custom template
890 function:
892 \(org-export-define-derived-backend my-latex e-latex
893 :translate-alist ((template . my-latex-template-fun)))
895 The back-end could then be called with, for example:
912 ;; Tell parser to not parse EXPORT-BLOCK blocks.
919 ;; Define filters.
926 "Alist between filters keywords and back-end specific filters.
928 ;; Define options.
936 See `org-export-options-alist' for more information on the
937 structure of the values."
938 child))))
939 ;; Define translators.
946 ;; Splice in the body, if any.
950 \f
951 ;;; The Communication Channel
952 ;;
953 ;; During export process, every function has access to a number of
954 ;; properties. They are of two types:
955 ;;
956 ;; 1. Environment options are collected once at the very beginning of
957 ;; the process, out of the original buffer and configuration.
958 ;; Collecting them is handled by `org-export-get-environment'
959 ;; function.
960 ;;
961 ;; Most environment options are defined through the
962 ;; `org-export-options-alist' variable.
963 ;;
964 ;; 2. Tree properties are extracted directly from the parsed tree,
965 ;; just before export, by `org-export-collect-tree-properties'.
966 ;;
967 ;; Here is the full list of properties available during transcode
968 ;; process, with their category (option, tree or local) and their
969 ;; value type.
970 ;;
971 ;; + `:author' :: Author's name.
972 ;; - category :: option
973 ;; - type :: string
974 ;;
975 ;; + `:back-end' :: Current back-end used for transcoding.
976 ;; - category :: tree
977 ;; - type :: symbol
978 ;;
979 ;; + `:creator' :: String to write as creation information.
980 ;; - category :: option
981 ;; - type :: string
982 ;;
983 ;; + `:date' :: String to use as date.
984 ;; - category :: option
985 ;; - type :: string
986 ;;
987 ;; + `:description' :: Description text for the current data.
988 ;; - category :: option
989 ;; - type :: string
990 ;;
991 ;; + `:email' :: Author's email.
992 ;; - category :: option
993 ;; - type :: string
994 ;;
995 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
996 ;; process.
997 ;; - category :: option
998 ;; - type :: list of strings
999 ;;
1000 ;; + `:exported-data' :: Hash table used for memoizing
1001 ;; `org-export-data'.
1002 ;; - category :: tree
1003 ;; - type :: hash table
1004 ;;
1005 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
1006 ;; their definition, as parsed data. Only non-inlined footnotes
1007 ;; are represented in this alist. Also, every definition isn't
1008 ;; guaranteed to be referenced in the parse tree. The purpose of
1009 ;; this property is to preserve definitions from oblivion
1010 ;; (i.e. when the parse tree comes from a part of the original
1011 ;; buffer), it isn't meant for direct use in a back-end. To
1012 ;; retrieve a definition relative to a reference, use
1013 ;; `org-export-get-footnote-definition' instead.
1014 ;; - category :: option
1015 ;; - type :: alist (STRING . LIST)
1016 ;;
1017 ;; + `:headline-levels' :: Maximum level being exported as an
1018 ;; headline. Comparison is done with the relative level of
1019 ;; headlines in the parse tree, not necessarily with their
1020 ;; actual level.
1021 ;; - category :: option
1022 ;; - type :: integer
1023 ;;
1024 ;; + `:headline-offset' :: Difference between relative and real level
1025 ;; of headlines in the parse tree. For example, a value of -1
1026 ;; means a level 2 headline should be considered as level
1027 ;; 1 (cf. `org-export-get-relative-level').
1028 ;; - category :: tree
1029 ;; - type :: integer
1030 ;;
1031 ;; + `:headline-numbering' :: Alist between headlines and their
1032 ;; numbering, as a list of numbers
1033 ;; (cf. `org-export-get-headline-number').
1034 ;; - category :: tree
1035 ;; - type :: alist (INTEGER . LIST)
1036 ;;
1037 ;; + `:id-alist' :: Alist between ID strings and destination file's
1038 ;; path, relative to current directory. It is used by
1039 ;; `org-export-resolve-id-link' to resolve ID links targeting an
1040 ;; external file.
1041 ;; - category :: option
1042 ;; - type :: alist (STRING . STRING)
1043 ;;
1044 ;; + `:ignore-list' :: List of elements and objects that should be
1045 ;; ignored during export.
1046 ;; - category :: tree
1047 ;; - type :: list of elements and objects
1048 ;;
1049 ;; + `:input-file' :: Full path to input file, if any.
1050 ;; - category :: option
1051 ;; - type :: string or nil
1052 ;;
1053 ;; + `:keywords' :: List of keywords attached to data.
1054 ;; - category :: option
1055 ;; - type :: string
1056 ;;
1057 ;; + `:language' :: Default language used for translations.
1058 ;; - category :: option
1059 ;; - type :: string
1060 ;;
1061 ;; + `:parse-tree' :: Whole parse tree, available at any time during
1062 ;; transcoding.
1063 ;; - category :: option
1064 ;; - type :: list (as returned by `org-element-parse-buffer')
1065 ;;
1066 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
1067 ;; all line breaks.
1068 ;; - category :: option
1069 ;; - type :: symbol (nil, t)
1070 ;;
1071 ;; + `:section-numbers' :: Non-nil means transcoding should add
1072 ;; section numbers to headlines.
1073 ;; - category :: option
1074 ;; - type :: symbol (nil, t)
1075 ;;
1076 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
1077 ;; in transcoding. When such a tag is present, subtrees without
1078 ;; it are de facto excluded from the process. See
1079 ;; `use-select-tags'.
1080 ;; - category :: option
1081 ;; - type :: list of strings
1082 ;;
1083 ;; + `:target-list' :: List of targets encountered in the parse tree.
1084 ;; This is used to partly resolve "fuzzy" links
1085 ;; (cf. `org-export-resolve-fuzzy-link').
1086 ;; - category :: tree
1087 ;; - type :: list of strings
1088 ;;
1089 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
1090 ;; a time stamp in the output.
1091 ;; - category :: option
1092 ;; - type :: symbol (nil, t)
1093 ;;
1094 ;; + `:translate-alist' :: Alist between element and object types and
1095 ;; transcoding functions relative to the current back-end.
1096 ;; Special keys `template' and `plain-text' are also possible.
1097 ;; - category :: option
1098 ;; - type :: alist (SYMBOL . FUNCTION)
1099 ;;
1100 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
1101 ;; also be transcoded. If it is set to the `headline' symbol,
1102 ;; only the archived headline's name is retained.
1103 ;; - category :: option
1104 ;; - type :: symbol (nil, t, `headline')
1105 ;;
1106 ;; + `:with-author' :: Non-nil means author's name should be included
1107 ;; in the output.
1108 ;; - category :: option
1109 ;; - type :: symbol (nil, t)
1110 ;;
1111 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
1112 ;; - category :: option
1113 ;; - type :: symbol (nil, t)
1114 ;;
1115 ;; + `:with-creator' :: Non-nild means a creation sentence should be
1116 ;; inserted at the end of the transcoded string. If the value
1117 ;; is `comment', it should be commented.
1118 ;; - category :: option
1119 ;; - type :: symbol (`comment', nil, t)
1120 ;;
1121 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
1122 ;; its value is a list of names, only drawers with such names
1123 ;; will be transcoded.
1124 ;; - category :: option
1125 ;; - type :: symbol (nil, t) or list of strings
1126 ;;
1127 ;; + `:with-email' :: Non-nil means output should contain author's
1128 ;; email.
1129 ;; - category :: option
1130 ;; - type :: symbol (nil, t)
1131 ;;
1132 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
1133 ;; interpreted.
1134 ;; - category :: option
1135 ;; - type :: symbol (nil, t)
1136 ;;
1137 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
1138 ;; strings starting with a colon as a fixed-with (verbatim) area.
1139 ;; - category :: option
1140 ;; - type :: symbol (nil, t)
1141 ;;
1142 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
1143 ;; footnotes.
1144 ;; - category :: option
1145 ;; - type :: symbol (nil, t)
1146 ;;
1147 ;; + `:with-plannings' :: Non-nil means transcoding should include
1148 ;; planning info.
1149 ;; - category :: option
1150 ;; - type :: symbol (nil, t)
1151 ;;
1152 ;; + `:with-priority' :: Non-nil means transcoding should include
1153 ;; priority cookies.
1154 ;; - category :: option
1155 ;; - type :: symbol (nil, t)
1156 ;;
1157 ;; + `:with-special-strings' :: Non-nil means transcoding should
1158 ;; interpret special strings in plain text.
1159 ;; - category :: option
1160 ;; - type :: symbol (nil, t)
1161 ;;
1162 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1163 ;; interpret subscript and superscript. With a value of "{}",
1164 ;; only interpret those using curly brackets.
1165 ;; - category :: option
1166 ;; - type :: symbol (nil, {}, t)
1167 ;;
1168 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1169 ;; tables.
1170 ;; - category :: option
1171 ;; - type :: symbol (nil, t)
1172 ;;
1173 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1174 ;; headlines. A `not-in-toc' value will remove them from the
1175 ;; table of contents, if any, nonetheless.
1176 ;; - category :: option
1177 ;; - type :: symbol (nil, t, `not-in-toc')
1178 ;;
1179 ;; + `:with-tasks' :: Non-nil means transcoding should include
1180 ;; headlines with a TODO keyword. A `todo' value will only
1181 ;; include headlines with a todo type keyword while a `done'
1182 ;; value will do the contrary. If a list of strings is provided,
1183 ;; only tasks with keywords belonging to that list will be kept.
1184 ;; - category :: option
1185 ;; - type :: symbol (t, todo, done, nil) or list of strings
1186 ;;
1187 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1188 ;; time stamps. Special value `active' (resp. `inactive') ask to
1189 ;; export only active (resp. inactive) timestamps. Otherwise,
1190 ;; completely remove them.
1191 ;; - category :: option
1192 ;; - type :: symbol: (`active', `inactive', t, nil)
1193 ;;
1194 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1195 ;; added to the output. An integer value limits its depth.
1196 ;; - category :: option
1197 ;; - type :: symbol (nil, t or integer)
1198 ;;
1199 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1200 ;; include TODO keywords.
1201 ;; - category :: option
1202 ;; - type :: symbol (nil, t)
1205 ;;;; Environment Options
1206 ;;
1207 ;; Environment options encompass all parameters defined outside the
1208 ;; scope of the parsed data. They come from five sources, in
1209 ;; increasing precedence order:
1210 ;;
1211 ;; - Global variables,
1212 ;; - Buffer's attributes,
1213 ;; - Options keyword symbols,
1214 ;; - Buffer keywords,
1215 ;; - Subtree properties.
1216 ;;
1217 ;; The central internal function with regards to environment options
1218 ;; is `org-export-get-environment'. It updates global variables with
1219 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1220 ;; the different sources.
1221 ;;
1222 ;; The internal functions doing the retrieval are:
1223 ;; `org-export--get-global-options',
1224 ;; `org-export--get-buffer-attributes',
1225 ;; `org-export--parse-option-keyword',
1226 ;; `org-export--get-subtree-options' and
1227 ;; `org-export--get-inbuffer-options'
1228 ;;
1229 ;; Also, `org-export--confirm-letbind' and `org-export--install-letbind'
1230 ;; take care of the part relative to "#+BIND:" keywords.
1233 "Collect export options from the current buffer.
1235 Optional argument BACKEND is a symbol specifying which back-end
1236 specific options to read, if any.
1238 When optional argument SUBTREEP is non-nil, assume the export is
1239 done against the current sub-tree.
1241 Third optional argument EXT-PLIST is a property list with
1242 external parameters overriding Org default settings, but still
1243 inferior to file-local settings."
1244 ;; First install #+BIND variables.
1246 ;; Get and prioritize export options...
1248 ;; ... from global variables...
1250 ;; ... from buffer's attributes...
1252 ;; ... from an external property list...
1253 ext-plist
1254 ;; ... from in-buffer settings...
1256 backend
1258 ;; ... and from subtree, when appropriate.
1260 ;; Eventually install back-end symbol and its translation table.
1261 `(:back-end
1262 ,backend
1263 :translate-alist
1268 "Parse an OPTIONS line and return values as a plist.
1269 Optional argument BACKEND is a symbol specifying which back-end
1270 specific items to read, if any."
1277 ;; Build an alist between #+OPTION: item and property-name.
1282 all)))
1283 plist)
1288 options)
1293 alist)
1294 plist))
1297 "Get export options in subtree at point.
1298 Optional argument BACKEND is a symbol specifying back-end used
1299 for export. Return options as a plist."
1300 ;; For each buffer keyword, create an headline property setting the
1301 ;; same property in communication channel. The name for the property
1302 ;; is the keyword with "EXPORT_" appended to it.
1305 ;; Make sure point is at an heading.
1307 ;; Take care of EXPORT_TITLE. If it isn't defined, use headline's
1308 ;; title as its fallback value.
1315 plist :title
1318 ;; EXPORT_OPTIONS are parsed in a non-standard way.
1322 ;; Handle other keywords.
1329 ;; Export properties are not case-sensitive.
1336 plist
1338 ;; Parse VALUE if required.
1342 value))))))))
1343 ;; Also look for both general keywords and back-end specific
1344 ;; options if BACKEND is provided.
1349 org-export-options-alist)))
1350 ;; Return value.
1351 plist)))
1354 "Return current buffer export options, as a plist.
1356 Optional argument BACKEND, when non-nil, is a symbol specifying
1357 which back-end specific options should also be read in the
1358 process.
1360 Optional argument FILES is a list of setup files names read so
1361 far, used to avoid circular dependencies.
1363 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1367 ;; 1. Special keywords, as in `org-export-special-keywords'.
1380 ;; Avoid circular dependencies.
1392 val)
1400 ;; Value will be evaled: do not parse it.
1403 ;; Value has to be parsed for nested
1404 ;; macros.
1407 key
1410 ;; If user explicitly asks for
1411 ;; a newline, be sure to preserve it
1412 ;; from further filling with
1413 ;; `hard-newline'. Also replace
1414 ;; "\\n" with "\n", "\\\n" with "\\n"
1415 ;; and so on...
1422 restr)))))))))))
1424 ;; 2. Standard options, as in `org-export-options-alist'.
1426 ;; Also look for back-end specific options
1427 ;; if BACKEND is defined.
1433 ;; Build alist between keyword name and property name.
1437 all)))
1438 ;; Build regexp matching all keywords associated to export
1439 ;; options. Note: the search is case insensitive.
1452 plist prop
1453 ;; Handle value depending on specified BEHAVIOUR.
1466 ;; Parse keywords specified in `org-element-parsed-keywords'.
1474 plist prop
1477 org-element-parsed-keywords))
1478 ;; 3. Return final value.
1479 plist)))
1482 "Return properties related to buffer attributes, as a plist."
1485 ;; Store full path of input file name, or nil. For internal use.
1486 :input-file visited-file
1491 :footnote-definition-alist
1492 ;; Footnotes definitions must be collected in the original
1493 ;; buffer, as there's no insurance that they will still be in the
1494 ;; parse tree, due to possible narrowing.
1505 ;; Like `org-element-parse-buffer', but
1506 ;; makes sure the definition doesn't start
1507 ;; with a section element.
1511 alist))))
1512 alist))
1513 :id-alist
1514 ;; Collect id references.
1523 alist)
1524 :macro-modification-time
1530 ;; Store input file name as a macro.
1532 ;; `:macro-date', `:macro-time' and `:macro-property' could as
1533 ;; well be initialized as tree properties, since they don't
1534 ;; depend on buffer properties. Though, it may be more logical
1535 ;; to keep them close to other ":macro-" properties.
1541 "Return global export options as a plist.
1543 Optional argument BACKEND, if non-nil, is a symbol specifying
1544 which back-end specific export options should also be read in the
1545 process."
1551 ;; Output value.
1552 plist)
1557 plist
1559 ;; Eval default value provided. If keyword is a member
1560 ;; of `org-element-parsed-keywords', parse it as
1561 ;; a secondary string before storing it.
1568 all)
1569 ;; Return value.
1570 plist))
1574 "Can we use #+BIND values during export?
1575 By default this will ask for confirmation by the user, to divert
1576 possible security risks."
1581 org-export--allow-BIND-local)
1586 "Install the values from #+BIND lines as local variables.
1587 Variables must be installed before in-buffer options are
1588 retrieved."
1595 letbind))))
1600 ;;;; Tree Properties
1601 ;;
1602 ;; Tree properties are infromation extracted from parse tree. They
1603 ;; are initialized at the beginning of the transcoding process by
1604 ;; `org-export-collect-tree-properties'.
1605 ;;
1606 ;; Dedicated functions focus on computing the value of specific tree
1607 ;; properties during initialization. Thus,
1608 ;; `org-export--populate-ignore-list' lists elements and objects that
1609 ;; should be skipped during export, `org-export--get-min-level' gets
1610 ;; the minimal exportable level, used as a basis to compute relative
1611 ;; level for headlines. Eventually
1612 ;; `org-export--collect-headline-numbering' builds an alist between
1613 ;; headlines and their numbering.
1616 "Extract tree properties from parse tree.
1618 DATA is the parse tree from which information is retrieved. INFO
1619 is a list holding export options.
1621 Following tree properties are set or updated:
1623 `:exported-data' Hash table used to memoize results from
1624 `org-export-data'.
1626 `:footnote-definition-alist' List of footnotes definitions in
1627 original buffer and current parse tree.
1629 `:headline-offset' Offset between true level of headlines and
1630 local level. An offset of -1 means an headline
1631 of level 2 should be considered as a level
1632 1 headline in the context.
1634 `:headline-numbering' Alist of all headlines as key an the
1635 associated numbering as value.
1637 `:ignore-list' List of elements that should be ignored during
1638 export.
1640 `:target-list' List of all targets in the parse tree.
1642 Return updated plist."
1643 ;; Install the parse tree in the communication channel, in order to
1644 ;; use `org-export-get-genealogy' and al.
1646 ;; Get the list of elements and objects to ignore, and put it into
1647 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1648 ;; been done during parse tree filtering.
1651 :ignore-list
1654 ;; Compute `:headline-offset' in order to be able to use
1655 ;; `org-export-get-relative-level'.
1658 :headline-offset
1660 ;; Update footnotes definitions list with definitions in parse tree.
1661 ;; This is required since buffer expansion might have modified
1662 ;; boundaries of footnote definitions contained in the parse tree.
1663 ;; This way, definitions in `footnote-definition-alist' are bound to
1664 ;; match those in the parse tree.
1667 data 'footnote-definition
1671 defs)))
1673 ;; Properties order doesn't matter: get the rest of the tree
1674 ;; properties.
1676 `(:target-list
1685 info))
1688 "Return minimum exportable headline's level in DATA.
1689 DATA is parsed tree as returned by `org-element-parse-buffer'.
1690 OPTIONS is a plist holding export options."
1701 ;; If no headline was found, for the sake of consistency, set
1702 ;; minimum level to 1 nonetheless.
1706 "Return numbering of all exportable headlines in a parse tree.
1708 DATA is the parse tree. OPTIONS is the plist holding export
1709 options.
1711 Return an alist whose key is an headline and value is its
1712 associated numbering \(in the shape of a list of numbers\)."
1715 data
1716 'headline
1721 headline
1723 for idx from 0 to org-export-max-depth
1727 options)))
1730 "Return list of elements and objects to ignore during export.
1731 DATA is the parse tree to traverse. OPTIONS is the plist holding
1732 export options."
1734 walk-data ; for byte-compiler.
1738 ;; Collect ignored elements or objects into IGNORE-LIST.
1747 ;; If headline is archived but tree below has
1748 ;; to be skipped, add it to ignore list.
1751 ;; Move into recursive objects/elements.
1755 ;; Main call. First find trees containing a select tag, if any.
1757 ;; Return value.
1758 ignore))
1761 "Return list of headlines containing a select tag in their tree.
1762 DATA is parsed data as returned by `org-element-parse-buffer'.
1763 INFO is a plist holding export options."
1765 walk-data ; for byte-compiler.
1776 ;; When a select tag is found, mark full
1777 ;; genealogy and every headline within the tree
1778 ;; as acceptable.
1781 genealogy
1783 selected-trees))
1784 ;; Else, continue searching in tree, recursively.
1791 "Non-nil when element or object BLOB should be skipped during export.
1792 OPTIONS is the plist holding export options. SELECTED, when
1793 non-nil, is a list of headlines belonging to a tree with a select
1794 tag."
1796 ;; Check headline.
1804 ;; Ignore subtrees with an exclude tag.
1807 ;; When a select tag is present in the buffer, ignore any tree
1808 ;; without it.
1810 ;; Ignore commented sub-trees.
1812 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1814 ;; Ignore tasks, if specified by `:with-tasks' property.
1820 ;; Check inlinetask.
1822 ;; Check timestamp.
1825 ;; No timestamp allowed.
1827 ;; Only active timestamps allowed and the current one isn't
1828 ;; active.
1832 ;; Only inactive timestamps allowed and the current one isn't
1833 ;; inactive.
1837 ;; Check drawer.
1843 ;; Check table-row.
1845 ;; Check table-cell.
1850 ;; Check clock.
1852 ;; Check planning.
1856 \f
1857 ;;; The Transcoder
1858 ;;
1859 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1860 ;; `org-element-parse-buffer') and transcodes it into a specified
1861 ;; back-end output. It takes care of filtering out elements or
1862 ;; objects according to export options and organizing the output blank
1863 ;; lines and white space are preserved. The function memoizes its
1864 ;; results, so it is cheap to call it within translators.
1865 ;;
1866 ;; Internally, three functions handle the filtering of objects and
1867 ;; elements during the export. In particular,
1868 ;; `org-export-ignore-element' marks an element or object so future
1869 ;; parse tree traversals skip it, `org-export--interpret-p' tells which
1870 ;; elements or objects should be seen as real Org syntax and
1871 ;; `org-export-expand' transforms the others back into their original
1872 ;; shape
1873 ;;
1874 ;; `org-export-transcoder' is an accessor returning appropriate
1875 ;; translator function for a given element or object.
1878 "Return appropriate transcoder for BLOB.
1879 INFO is a plist containing export directives."
1881 ;; Return contents only for complete parse trees.
1887 "Convert DATA into current back-end format.
1889 DATA is a parse tree, an element or an object or a secondary
1890 string. INFO is a plist holding export options.
1892 Return transcoded string."
1898 ;; Ignored element/object.
1900 ;; Plain text.
1906 info))
1907 ;; Uninterpreted element/object: change it back to Org
1908 ;; syntax and export again resulting raw string.
1912 data
1916 info))
1917 ;; Secondary string.
1920 ;; Element/Object without contents or, as a special case,
1921 ;; headline with archive tag and archived trees restricted
1922 ;; to title only.
1930 ;; Element/Object with contents.
1943 ;; Elements directly containing objects
1944 ;; must have their indentation normalized
1945 ;; first.
1947 data
1948 ;; When normalizing contents of the first
1949 ;; paragraph in an item or a footnote
1950 ;; definition, ignore first line's
1951 ;; indentation: there is none and it
1952 ;; might be misleading.
1957 data)
1964 info))))))))
1965 ;; Final result will be memoized before being returned.
1967 data
1971 ;; Append the same white space between elements or objects as in
1972 ;; the original buffer, and call appropriate filters.
1983 info)))
1984 results)))
1988 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1989 Check is done according to export options INFO, stored as
1990 a plist."
1992 ;; ... entities...
1994 ;; ... emphasis...
1996 ;; ... fixed-width areas.
1998 ;; ... footnotes...
2001 ;; ... sub/superscripts...
2007 ;; ... tables...
2012 "Expand a parsed element or object to its original state.
2013 BLOB is either an element or an object. CONTENTS is its
2014 contents, as a string or nil."
2017 blob contents))
2020 "Add ELEMENT to `:ignore-list' in INFO.
2022 Any element in `:ignore-list' will be skipped when using
2023 `org-element-map'. INFO is modified by side effects."
2027 \f
2028 ;;; The Filter System
2029 ;;
2030 ;; Filters allow end-users to tweak easily the transcoded output.
2031 ;; They are the functional counterpart of hooks, as every filter in
2032 ;; a set is applied to the return value of the previous one.
2033 ;;
2034 ;; Every set is back-end agnostic. Although, a filter is always
2035 ;; called, in addition to the string it applies to, with the back-end
2036 ;; used as argument, so it's easy for the end-user to add back-end
2037 ;; specific filters in the set. The communication channel, as
2038 ;; a plist, is required as the third argument.
2039 ;;
2040 ;; From the developer side, filters sets can be installed in the
2041 ;; process with the help of `org-export-define-backend', which
2042 ;; internally sets `org-BACKEND-filters-alist' variable. Each
2043 ;; association has a key among the following symbols and a function or
2044 ;; a list of functions as value.
2045 ;;
2046 ;; - `:filter-parse-tree' applies directly on the complete parsed
2047 ;; tree. It's the only filters set that doesn't apply to a string.
2048 ;; Users can set it through `org-export-filter-parse-tree-functions'
2049 ;; variable.
2050 ;;
2051 ;; - `:filter-final-output' applies to the final transcoded string.
2052 ;; Users can set it with `org-export-filter-final-output-functions'
2053 ;; variable
2054 ;;
2055 ;; - `:filter-plain-text' applies to any string not recognized as Org
2056 ;; syntax. `org-export-filter-plain-text-functions' allows users to
2057 ;; configure it.
2058 ;;
2059 ;; - `:filter-TYPE' applies on the string returned after an element or
2060 ;; object of type TYPE has been transcoded. An user can modify
2061 ;; `org-export-filter-TYPE-functions'
2062 ;;
2063 ;; All filters sets are applied with
2064 ;; `org-export-filter-apply-functions' function. Filters in a set are
2065 ;; applied in a LIFO fashion. It allows developers to be sure that
2066 ;; their filters will be applied first.
2067 ;;
2068 ;; Filters properties are installed in communication channel with
2069 ;; `org-export-install-filters' function.
2070 ;;
2071 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
2072 ;; before parsing to allow for heavy structure modifications.
2075 ;;;; Before Parsing Hook
2078 "Hook run before parsing an export buffer.
2079 This is run after include keywords have been expanded and Babel
2080 code executed, on a copy of original buffer's area being
2081 exported. Visibility is the same as in the original one. Point
2085 ;;;; Special Filters
2088 "List of functions applied to the parsed tree.
2089 Each filter is called with three arguments: the parse tree, as
2090 returned by `org-element-parse-buffer', the back-end, as
2091 a symbol, and the communication channel, as a plist. It must
2095 "List of functions applied to the transcoded string.
2096 Each filter is called with three arguments: the full transcoded
2097 string, the back-end, as a symbol, and the communication channel,
2098 as a plist. It must return a string that will be used as the
2102 "List of functions applied to plain text.
2103 Each filter is called with three arguments: a string which
2104 contains no Org syntax, the back-end, as a symbol, and the
2105 communication channel, as a plist. It must return a string or
2109 ;;;; Elements Filters
2112 "List of functions applied to a transcoded center block.
2113 Each filter is called with three arguments: the transcoded data,
2114 as a string, the back-end, as a symbol, and the communication
2118 "List of functions applied to a transcoded clock.
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 drawer.
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 dynamic-block.
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 headline.
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 inlinetask.
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 plain-list.
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 item.
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 comment.
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-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 example-block.
2173 Each filter is called with three arguments: the transcoded data,
2174 as a string, the back-end, as a symbol, and the communication
2178 "List of functions applied to a transcoded export-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 fixed-width.
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 footnote-definition.
2191 Each filter is called with three arguments: the transcoded data,
2192 as a string, the back-end, as a symbol, and the communication
2196 "List of functions applied to a transcoded horizontal-rule.
2197 Each filter is called with three arguments: the transcoded data,
2198 as a string, the back-end, as a symbol, and the communication
2202 "List of functions applied to a transcoded keyword.
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 latex-environment.
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 babel-call.
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 paragraph.
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 planning.
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 property-drawer.
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 quote block.
2239 Each filter is called with three arguments: the transcoded quote
2240 data, as a string, the back-end, as a symbol, and the
2241 communication channel, as a plist. It must return a string or
2245 "List of functions applied to a transcoded quote-section.
2246 Each filter is called with three arguments: the transcoded data,
2247 as a string, the back-end, as a symbol, and the communication
2251 "List of functions applied to a transcoded 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 special block.
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 src-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 table.
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-cell.
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-row.
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 verse block.
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 ;;;; Objects Filters
2296 "List of functions applied to transcoded bold text.
2297 Each filter is called with three arguments: the transcoded data,
2298 as a string, the back-end, as a symbol, and the communication
2302 "List of functions applied to transcoded code 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 a transcoded entity.
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 export-snippet.
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 footnote-reference.
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 inline-babel-call.
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-src-block.
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 transcoded italic text.
2339 Each filter is called with three arguments: the transcoded data,
2340 as a string, the back-end, as a symbol, and the communication
2344 "List of functions applied to a transcoded latex-fragment.
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 line-break.
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 link.
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 macro.
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 radio-target.
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 statistics-cookie.
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 transcoded strike-through text.
2381 Each filter is called with three arguments: the transcoded data,
2382 as a string, the back-end, as a symbol, and the communication
2386 "List of functions applied to a transcoded subscript.
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 superscript.
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 target.
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 timestamp.
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 transcoded underline text.
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 verbatim 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 ;;;; Filters Tools
2423 ;;
2424 ;; Internal function `org-export-install-filters' installs filters
2425 ;; hard-coded in back-ends (developer filters) and filters from global
2426 ;; variables (user filters) in the communication channel.
2427 ;;
2428 ;; Internal function `org-export-filter-apply-functions' takes care
2429 ;; about applying each filter in order to a given data. It stops
2430 ;; whenever a filter returns a nil value.
2433 "Call every function in FILTERS.
2434 Functions are called with arguments VALUE, current export
2435 back-end and INFO. Call is done in a LIFO fashion, to be sure
2436 that developer specified filters, if any, are called first."
2440 value)
2443 "Install filters properties in communication channel.
2445 INFO is a plist containing the current communication channel.
2447 Return the updated communication channel."
2449 ;; Install user defined filters with `org-export-filters-alist'.
2452 org-export-filters-alist)
2453 ;; Prepend back-end specific filters to that list.
2458 ;; Single values get consed, lists are prepended.
2463 plist key
2467 ;; Return new communication channel.
2471 \f
2472 ;;; Core functions
2473 ;;
2474 ;; This is the room for the main function, `org-export-as', along with
2475 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2476 ;; They differ only by the way they output the resulting code.
2477 ;;
2478 ;; `org-export-output-file-name' is an auxiliary function meant to be
2479 ;; used with `org-export-to-file'. With a given extension, it tries
2480 ;; to provide a canonical file name to write export output to.
2481 ;;
2482 ;; Note that `org-export-as' doesn't really parse the current buffer,
2483 ;; but a copy of it (with the same buffer-local variables and
2484 ;; visibility), where include keywords are expanded and Babel blocks
2485 ;; are executed, if appropriate.
2486 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2487 ;;
2488 ;; File inclusion is taken care of by
2489 ;; `org-export-expand-include-keyword' and
2490 ;; `org-export--prepare-file-contents'. Structure wise, including
2491 ;; a whole Org file in a buffer often makes little sense. For
2492 ;; example, if the file contains an headline and the include keyword
2493 ;; was within an item, the item should contain the headline. That's
2494 ;; why file inclusion should be done before any structure can be
2495 ;; associated to the file, that is before parsing.
2501 "Transcode current Org buffer into BACKEND code.
2503 If narrowing is active in the current buffer, only transcode its
2504 narrowed part.
2506 If a region is active, transcode that region.
2508 When optional argument SUBTREEP is non-nil, transcode the
2509 sub-tree at point, extracting information from the headline
2510 properties first.
2512 When optional argument VISIBLE-ONLY is non-nil, don't export
2513 contents of hidden elements.
2515 When optional argument BODY-ONLY is non-nil, only return body
2516 code, without preamble nor postamble.
2518 Optional argument EXT-PLIST, when provided, is a property list
2519 with external parameters overriding Org default settings, but
2520 still inferior to file-local settings.
2522 Optional argument NOEXPAND, when non-nil, prevents included files
2523 to be expanded and Babel code to be executed.
2525 Return code as a string."
2528 ;; Narrow buffer to an appropriate region or subtree for
2529 ;; parsing. If parsing subtree, be sure to remove main headline
2530 ;; too.
2538 ;; 1. Get export environment from original buffer. Also install
2539 ;; user's and developer's filters.
2542 ;; 2. Get parse tree. Buffer isn't parsed directly.
2543 ;; Instead, a temporary copy is created, where include
2544 ;; keywords are expanded and code blocks are evaluated.
2550 ;; Setting `org-current-export-file' is
2551 ;; required by Org Babel to properly resolve
2552 ;; noweb references.
2556 ;; Run hook with `org-export-current-backend' set
2557 ;; to BACKEND.
2560 ;; Eventually parse buffer.
2562 ;; 3. Call parse-tree filters to get the final tree.
2566 ;; 4. Now tree is complete, compute its properties and add
2567 ;; them to communication channel.
2571 ;; 5. Eventually transcode TREE. Wrap the resulting string
2572 ;; into a template, if required. Eventually call
2573 ;; final-output filter.
2581 info)))
2582 ;; Maybe add final OUTPUT to kill ring, then return it.
2584 output)))))
2588 "Call `org-export-as' with output to a specified buffer.
2590 BACKEND is the back-end used for transcoding, as a symbol.
2592 BUFFER is the output buffer. If it already exists, it will be
2593 erased first, otherwise, it will be created.
2595 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2596 and NOEXPAND are similar to those used in `org-export-as', which
2597 see.
2599 Return buffer."
2601 backend subtreep visible-only body-only ext-plist noexpand))
2607 buffer))
2611 "Call `org-export-as' with output to a specified file.
2613 BACKEND is the back-end used for transcoding, as a symbol. FILE
2614 is the name of the output file, as a string.
2616 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2617 and NOEXPAND are similar to those used in `org-export-as', which
2618 see.
2620 Return output file's name."
2621 ;; Checks for FILE permissions. `write-file' would do the same, but
2622 ;; we'd rather avoid needless transcoding of parse tree.
2624 ;; Insert contents to a temporary buffer and write it to FILE.
2626 backend subtreep visible-only body-only ext-plist noexpand)))
2631 ;; Return full path.
2632 file)
2635 "Return output file's name according to buffer specifications.
2637 EXTENSION is a string representing the output file extension,
2638 with the leading dot.
2640 With a non-nil optional argument SUBTREEP, try to determine
2642 of subtree at point.
2644 When optional argument PUB-DIR is set, use it as the publishing
2645 directory.
2647 When optional argument VISIBLE-ONLY is non-nil, don't export
2648 contents of hidden elements.
2650 Return file name as a string, or nil if it couldn't be
2651 determined."
2653 ;; File name may come from EXPORT_FILE_NAME subtree property,
2654 ;; assuming point is at beginning of said sub-tree.
2661 ;; File name may be extracted from buffer's associated
2662 ;; file, if any.
2664 ;; Can't determine file name on our own: Ask user.
2668 "Output file: " pub-dir nil nil nil
2671 ;; Build file name. Enforce EXTENSION over whatever user may have
2672 ;; come up with. PUB-DIR, if defined, always has precedence over
2673 ;; any provided path.
2678 extension))
2684 "Apply BODY in a copy of the current buffer.
2686 The copy preserves local variables and visibility of the original
2687 buffer.
2689 Point is at buffer's beginning when BODY is applied."
2699 ,original-buffer
2704 ov
2714 "Expand every include keyword in buffer.
2715 Optional argument INCLUDED is a list of included file names along
2716 with their line restriction, when appropriate. It is used to
2717 avoid infinite recursion. Optional argument DIR is the current
2718 working directory. It is used to properly resolve relative
2719 paths."
2726 ;; Extract arguments from keyword's value.
2740 ;; Minimal level of included file defaults to the child
2741 ;; level of the current headline, if any, or one. It
2742 ;; only applies is the file is meant to be included as
2743 ;; an Org one.
2751 ;; Remove keyword.
2755 ;; Check if files has already been parsed. Look after
2756 ;; inclusion lines too, as different parts of the same file
2757 ;; can be included too.
2766 ;; Protect sensitive contents with commas.
2772 ind-str contents ind-str))))
2777 ;; Protect sensitive contents with commas.
2784 ind-str env contents ind-str))))
2797 "Prepare the contents of FILE for inclusion and return them as a string.
2799 When optional argument LINES is a string specifying a range of
2800 lines, include only those lines.
2802 Optional argument IND, when non-nil, is an integer specifying the
2803 global indentation of returned contents. Since its purpose is to
2804 allow an included file to stay in the same environment it was
2805 created \(i.e. a list item), it doesn't apply past the first
2806 headline encountered.
2808 Optional argument MINLEVEL, when non-nil, is an integer
2809 specifying the level that any top-level headline in the included
2810 file should have."
2826 ;; Remove blank lines at beginning and end of contents. The logic
2827 ;; behind that removal is that blank lines around include keyword
2828 ;; override blank lines in included file.
2837 ;; If IND is set, preserve indentation of include keyword until
2838 ;; the first headline encountered.
2844 ;; Do not move footnote definitions out of column 0.
2850 ;; When MINLEVEL is specified, compute minimal level for headlines
2851 ;; in the file (CUR-MIN), and remove stars to each headline so
2852 ;; that headlines with minimal level have a level of MINLEVEL.
2861 ;; Only change stars, don't bother moving whole
2862 ;; sections.
2868 \f
2869 ;;; Tools For Back-Ends
2870 ;;
2871 ;; A whole set of tools is available to help build new exporters. Any
2872 ;; function general enough to have its use across many back-ends
2873 ;; should be added here.
2874 ;;
2875 ;; As of now, functions operating on footnotes, headlines, links,
2876 ;; macros, references, src-blocks, tables and tables of contents are
2877 ;; implemented.
2879 ;;;; For Affiliated Keywords
2880 ;;
2881 ;; `org-export-read-attribute' reads a property from a given element
2882 ;; as a plist. It can be used to normalize affiliated keywords'
2883 ;; syntax.
2886 "Turn ATTRIBUTE property from ELEMENT into a plist.
2888 When optional argument PROPERTY is non-nil, return the value of
2889 that property within attributes.
2893 properties."
2901 ;;;; For Export Snippets
2902 ;;
2903 ;; Every export snippet is transmitted to the back-end. Though, the
2904 ;; latter will only retain one type of export-snippet, ignoring
2905 ;; others, based on the former's target back-end. The function
2906 ;; `org-export-snippet-backend' returns that back-end for a given
2907 ;; export-snippet.
2910 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2911 Translation, with `org-export-snippet-translation-alist', is
2912 applied."
2916 back-end))))
2919 ;;;; For Footnotes
2920 ;;
2921 ;; `org-export-collect-footnote-definitions' is a tool to list
2922 ;; actually used footnotes definitions in the whole parse tree, or in
2923 ;; an headline, in order to add footnote listings throughout the
2924 ;; transcoded data.
2925 ;;
2926 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2927 ;; back-ends, when they need to attach the footnote definition only to
2928 ;; the first occurrence of the corresponding label.
2929 ;;
2930 ;; `org-export-get-footnote-definition' and
2931 ;; `org-export-get-footnote-number' provide easier access to
2932 ;; additional information relative to a footnote reference.
2935 "Return an alist between footnote numbers, labels and definitions.
2937 DATA is the parse tree from which definitions are collected.
2938 INFO is the plist used as a communication channel.
2940 Definitions are sorted by order of references. They either
2941 appear as Org data or as a secondary string for inlined
2942 footnotes. Unreferenced definitions are ignored."
2944 collect-fn ; for byte-compiler.
2948 ;; Collect footnote number, label and definition in DATA.
2950 data 'footnote-reference
2957 def)
2958 num-alist)
2959 ;; Also search in definition for nested footnotes.
2962 ;; Don't enter footnote definitions since it will happen
2963 ;; when their first reference is found.
2969 "Non-nil when a footnote reference is the first one for its label.
2971 FOOTNOTE-REFERENCE is the footnote reference being considered.
2972 INFO is the plist used as a communication channel."
2974 ;; Anonymous footnotes are always a first reference.
2976 ;; Otherwise, return the first footnote with the same LABEL and
2977 ;; test if it is equal to FOOTNOTE-REFERENCE.
2983 data 'footnote-reference
2988 ;; If FN isn't inlined, be sure to traverse its
2989 ;; definition before resuming search. See
2990 ;; comments in `org-export-get-footnote-number'
2991 ;; for more information.
2995 ;; Don't enter footnote definitions since it will
2996 ;; happen when their first reference is found.
2999 footnote-reference)))))
3002 "Return definition of FOOTNOTE-REFERENCE as parsed data.
3003 INFO is the plist used as a communication channel."
3009 "Return number associated to a footnote.
3011 FOOTNOTE is either a footnote reference or a footnote definition.
3012 INFO is the plist used as a communication channel."
3014 seen-refs
3015 search-ref ; For byte-compiler.
3019 ;; Search footnote references through DATA, filling
3020 ;; SEEN-REFS along the way.
3022 data 'footnote-reference
3026 ;; Anonymous footnote match: return number.
3029 ;; Labels match: return number.
3032 ;; Anonymous footnote: it's always a new one. Also,
3033 ;; be sure to return nil from the `cond' so
3034 ;; `first-match' doesn't get us out of the loop.
3036 ;; Label not seen so far: add it so SEEN-REFS.
3037 ;;
3038 ;; Also search for subsequent references in
3039 ;; footnote definition so numbering follows reading
3040 ;; logic. Note that we don't have to care about
3041 ;; inline definitions, since `org-element-map'
3042 ;; already traverses them at the right time.
3043 ;;
3044 ;; Once again, return nil to stay in the loop.
3049 nil))))
3050 ;; Don't enter footnote definitions since it will happen
3051 ;; when their first reference is found.
3056 ;;;; For Headlines
3057 ;;
3058 ;; `org-export-get-relative-level' is a shortcut to get headline
3059 ;; level, relatively to the lower headline level in the parsed tree.
3060 ;;
3061 ;; `org-export-get-headline-number' returns the section number of an
3062 ;; headline, while `org-export-number-to-roman' allows to convert it
3063 ;; to roman numbers.
3064 ;;
3065 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
3066 ;; `org-export-last-sibling-p' are three useful predicates when it
3067 ;; comes to fulfill the `:headline-levels' property.
3070 "Return HEADLINE relative level within current parsed tree.
3071 INFO is a plist holding contextual information."
3076 "Non-nil when HEADLINE is considered as low level.
3078 INFO is a plist used as a communication channel.
3080 A low level headlines has a relative level greater than
3081 `:headline-levels' property value.
3083 Return value is the difference between HEADLINE relative level
3084 and the last level being considered as high enough, or nil."
3091 "Return HEADLINE numbering as a list of numbers.
3092 INFO is a plist holding contextual information."
3096 "Return a non-nil value if HEADLINE element should be numbered.
3097 INFO is a plist used as a communication channel."
3103 "Convert integer N into a roman numeral."
3116 res)))
3119 "Return list of tags associated to ELEMENT.
3121 ELEMENT has either an `headline' or an `inlinetask' type. INFO
3122 is a plist used as a communication channel.
3124 Select tags (see `org-export-select-tags') and exclude tags (see
3125 `org-export-exclude-tags') are removed from the list.
3127 When non-nil, optional argument TAGS should be a list of strings.
3128 Any tag belonging to this list will also be removed."
3135 "Non-nil when HEADLINE is the first sibling in its sub-tree.
3136 INFO is a plist used as a communication channel."
3141 "Non-nil when HEADLINE is the last sibling in its sub-tree.
3142 INFO is a plist used as a communication channel."
3146 ;;;; For Links
3147 ;;
3148 ;; `org-export-solidify-link-text' turns a string into a safer version
3149 ;; for links, replacing most non-standard characters with hyphens.
3150 ;;
3151 ;; `org-export-get-coderef-format' returns an appropriate format
3152 ;; string for coderefs.
3153 ;;
3154 ;; `org-export-inline-image-p' returns a non-nil value when the link
3155 ;; provided should be considered as an inline image.
3156 ;;
3157 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
3158 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
3159 ;; returns an appropriate unique identifier when found, or nil.
3160 ;;
3161 ;; `org-export-resolve-id-link' returns the first headline with
3162 ;; specified id or custom-id in parse tree, the path to the external
3163 ;; file with the id or nil when neither was found.
3164 ;;
3165 ;; `org-export-resolve-coderef' associates a reference to a line
3166 ;; number in the element it belongs, or returns the reference itself
3167 ;; when the element isn't numbered.
3170 "Take link text S and make a safe target out of it."
3175 "Return format string for code reference link.
3176 PATH is the link path. DESC is its description."
3184 "Non-nil if LINK object points to an inline image.
3186 Optional argument is a set of RULES defining inline images. It
3187 is an alist where associations have the following shape:
3189 \(TYPE . REGEXP)
3191 Applying a rule means apply REGEXP against LINK's path when its
3192 type is TYPE. The function will return a non-nil value if any of
3193 the provided rules is non-nil. The default rule is
3194 `org-export-default-inline-image-rule'.
3196 This only applies to links without a description."
3207 rules)
3208 ;; Return nil if no rule matched.
3209 nil))))
3212 "Resolve a code reference REF.
3214 INFO is a plist used as a communication channel.
3216 Return associated line number in source code, or REF itself,
3217 depending on src-block or example element's switches."
3225 org-coderef-label-format)))
3229 ;; Element containing REF is found. Resolve it to either
3230 ;; a label or a line number, as needed.
3240 "Return LINK destination.
3242 INFO is a plist holding contextual information.
3244 Return value can be an object, an element, or nil:
3246 - If LINK path matches a target object (i.e. <<path>>) or
3249 - If LINK path exactly matches the name affiliated keyword
3250 \(i.e. #+NAME: path) of an element, return that element.
3252 - If LINK path exactly matches any headline name, return that
3253 element. If more than one headline share that name, priority
3254 will be given to the one with the closest common ancestor, if
3255 any, or the first one in the parse tree otherwise.
3257 - Otherwise, return nil.
3263 ;; First try to find a matching "<<path>>" unless user specified
3264 ;; he was looking for an headline (path starts with a *
3265 ;; character).
3269 return target)))
3270 ;; Then try to find an element with a matching "#+NAME: path"
3271 ;; affiliated keyword.
3278 ;; Last case: link either points to an headline or to
3279 ;; nothingness. Try to find the source, with priority given to
3280 ;; headlines with the closest common ancestor. If such candidate
3281 ;; is found, return it, otherwise return nil.
3285 ;; Return first headline whose `:raw-value' property
3286 ;; is NAME in parse tree DATA, or nil.
3289 data 'headline
3293 name)
3294 headline))
3296 ;; Search among headlines sharing an ancestor with link,
3297 ;; from closest to farthest.
3305 ;; No match with a common ancestor: try the full parse-tree.
3311 "Return headline referenced as LINK destination.
3313 INFO is a plist used as a communication channel.
3315 Return value can be the headline element matched in current parse
3319 ;; First check if id is within the current parse tree.
3325 headline))
3327 ;; Otherwise, look for external files.
3331 "Return radio-target object referenced as LINK destination.
3333 INFO is a plist used as a communication channel.
3335 Return value can be a radio-target object or nil. Assume LINK
3345 ;;;; For Macros
3346 ;;
3347 ;; `org-export-expand-macro' simply takes care of expanding macros.
3350 "Expand MACRO and return it as a string.
3351 INFO is a plist holding export options."
3354 ;; User's macros are stored in the communication channel with
3355 ;; a ":macro-" prefix. Replace arguments in VALUE. Also
3356 ;; expand recursively macros within.
3365 obj)))
3367 info)))
3368 ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
3370 ;; Return string.
3374 ;;;; For References
3375 ;;
3376 ;; `org-export-get-ordinal' associates a sequence number to any object
3377 ;; or element.
3380 "Return ordinal number of an element or object.
3382 ELEMENT is the element or object considered. INFO is the plist
3383 used as a communication channel.
3385 Optional argument TYPES, when non-nil, is a list of element or
3386 object types, as symbols, that should also be counted in.
3387 Otherwise, only provided element's type is considered.
3389 Optional argument PREDICATE is a function returning a non-nil
3390 value if the current element or object should be counted in. It
3391 accepts two arguments: the element or object being considered and
3392 the plist used as a communication channel. This allows to count
3393 only a certain type of objects (i.e. inline images).
3395 Return value is a list of numbers if ELEMENT is an headline or an
3396 item. It is nil for keywords. It represents the footnote number
3397 for footnote definitions and footnote references. If ELEMENT is
3398 a target, return the same value as if ELEMENT was the closest
3399 table, item or headline containing the target. In any other
3400 case, return the sequence number of ELEMENT among elements or
3401 objects of the same type."
3402 ;; A target keyword, representing an invisible target, never has
3403 ;; a sequence number.
3405 ;; Ordinal of a target object refer to the ordinal of the closest
3406 ;; table, item, or headline containing the object.
3410 when
3414 table))
3415 return parent)))
3417 ;; Special case 1: An headline returns its number as a list.
3419 ;; Special case 2: An item returns its number as a list.
3423 struct
3430 ;; Increment counter until ELEMENT is found again.
3441 ;;;; For Src-Blocks
3442 ;;
3443 ;; `org-export-get-loc' counts number of code lines accumulated in
3444 ;; src-block or example-block elements with a "+n" switch until
3445 ;; a given element, excluded. Note: "-n" switches reset that count.
3446 ;;
3447 ;; `org-export-unravel-code' extracts source code (along with a code
3448 ;; references alist) from an `element-block' or `src-block' type
3449 ;; element.
3450 ;;
3451 ;; `org-export-format-code' applies a formatting function to each line
3452 ;; of code, providing relative line number and code reference when
3453 ;; appropriate. Since it doesn't access the original element from
3454 ;; which the source code is coming, it expects from the code calling
3455 ;; it to know if lines should be numbered and if code references
3456 ;; should appear.
3457 ;;
3458 ;; Eventually, `org-export-format-code-default' is a higher-level
3459 ;; function (it makes use of the two previous functions) which handles
3460 ;; line numbering and code references inclusion, and returns source
3461 ;; code in a format suitable for plain text or verbatim output.
3464 "Return accumulated lines of code up to ELEMENT.
3466 INFO is the plist used as a communication channel.
3468 ELEMENT is excluded from count."
3475 ;; ELEMENT is reached: Quit the loop.
3477 ;; Only count lines from src-block and example-block elements
3478 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3482 ;; Accumulate locs or reset them.
3486 ;; Return nil to stay in the loop.
3487 nil)))
3489 ;; Return value.
3490 loc))
3493 "Clean source code and extract references out of it.
3495 ELEMENT has either a `src-block' an `example-block' type.
3497 Return a cons cell whose CAR is the source code, cleaned from any
3498 reference and protective comma and CDR is an alist between
3499 relative line number (integer) and name of code reference on that
3500 line (string)."
3502 ;; Get code and clean it. Remove blank lines at its
3503 ;; beginning and end. Also remove protective commas.
3509 ;; If appropriate, remove global indentation.
3513 ;; Free up the protected lines. Note: Org blocks
3514 ;; have commas at the beginning or every line.
3519 ;; Get format used for references.
3522 org-coderef-label-format)))
3523 ;; Build a regexp matching a loc with a reference.
3528 ;; Return value.
3530 ;; Code with references removed.
3536 ;; Ref line: remove ref, and signal its position in REFS.
3540 ;; Reference alist.
3541 refs)))
3544 "Format CODE by applying FUN line-wise and return it.
3546 CODE is a string representing the code to format. FUN is
3547 a function. It must accept three arguments: a line of
3548 code (string), the current line number (integer) or nil and the
3549 reference associated to the current line (string) or nil.
3551 Optional argument NUM-LINES can be an integer representing the
3552 number of code lines accumulated until the current code. Line
3553 numbers passed to FUN will take it into account. If it is nil,
3554 FUN's second argument will always be nil. This number can be
3555 obtained with `org-export-get-loc' function.
3557 Optional argument REF-ALIST can be an alist between relative line
3558 number (i.e. ignoring NUM-LINES) and the name of the code
3559 reference on it. If it is nil, FUN's third argument will always
3560 be nil. It can be obtained through the use of
3561 `org-export-unravel-code' function."
3573 "Return source code from ELEMENT, formatted in a standard way.
3575 ELEMENT is either a `src-block' or `example-block' element. INFO
3576 is a plist used as a communication channel.
3578 This function takes care of line numbering and code references
3579 inclusion. Line numbers, when applicable, appear at the
3580 beginning of the line, separated from the code by two white
3581 spaces. Code references, on the other hand, appear flushed to
3582 the right, separated by six white spaces from the widest line of
3583 code."
3584 ;; Extract code and references.
3590 ;; Handle line numbering.
3599 ;; Prepare references display, if required. Any reference
3600 ;; should start six columns after the widest line of code,
3601 ;; wrapped with parenthesis.
3606 code
3610 number-str
3611 loc
3617 num-start refs)))
3620 ;;;; For Tables
3621 ;;
3622 ;; `org-export-table-has-special-column-p' and and
3623 ;; `org-export-table-row-is-special-p' are predicates used to look for
3624 ;; meta-information about the table structure.
3625 ;;
3626 ;; `org-table-has-header-p' tells when the rows before the first rule
3627 ;; should be considered as table's header.
3628 ;;
3629 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3630 ;; and `org-export-table-cell-borders' extract information from
3631 ;; a table-cell element.
3632 ;;
3633 ;; `org-export-table-dimensions' gives the number on rows and columns
3634 ;; in the table, ignoring horizontal rules and special columns.
3635 ;; `org-export-table-cell-address', given a table-cell object, returns
3636 ;; the absolute address of a cell. On the other hand,
3637 ;; `org-export-get-table-cell-at' does the contrary.
3638 ;;
3639 ;; `org-export-table-cell-starts-colgroup-p',
3640 ;; `org-export-table-cell-ends-colgroup-p',
3641 ;; `org-export-table-row-starts-rowgroup-p',
3642 ;; `org-export-table-row-ends-rowgroup-p',
3643 ;; `org-export-table-row-starts-header-p' and
3644 ;; `org-export-table-row-ends-header-p' indicate position of current
3645 ;; row or cell within the table.
3648 "Non-nil when TABLE has a special column.
3649 All special columns will be ignored during export."
3650 ;; The table has a special column when every first cell of every row
3651 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3652 ;; "*" "_" and "^". Though, do not consider a first row containing
3653 ;; only empty cells as special.
3669 "Non-nil when TABLE has an header.
3671 INFO is a plist used as a communication channel.
3673 A table has an header when it contains at least two row groups."
3676 table 'table-row
3684 info)))
3687 "Non-nil if TABLE-ROW is considered special.
3689 INFO is a plist used as the communication channel.
3691 All special rows will be ignored during export."
3695 ;; A row is special either when...
3697 ;; ... it starts with a field only containing "/",
3699 ;; ... the table contains a special column and the row start
3700 ;; with a marking character among, "^", "_", "$" or "!",
3704 ;; ... it contains only alignment cookies and empty cells.
3710 ;; Since VALUE is a secondary string, the following
3711 ;; checks avoid expanding it with `org-export-data'.
3723 "Return TABLE-ROW's group.
3725 INFO is a plist used as the communication channel.
3727 Return value is the group number, as an integer, or nil special
3728 rows and table rules. Group 1 is also table's header."
3745 "Return TABLE-CELL contents width.
3747 INFO is a plist used as the communication channel.
3749 Return value is the width given by the last width cookie in the
3750 same column as TABLE-CELL, or nil."
3755 cookie-width)
3759 ;; In a special row, try to find a width cookie at COLUMN.
3763 ;; The following checks avoid expanding unnecessarily the
3764 ;; cell with `org-export-data'
3772 ;; Ignore table rules.
3775 ;; Return value.
3776 cookie-width))
3779 "Return TABLE-CELL contents alignment.
3781 INFO is a plist used as the communication channel.
3783 Return alignment as specified by the last alignment cookie in the
3784 same column as TABLE-CELL. If no such cookie is found, a default
3785 alignment value will be deduced from fraction of numbers in the
3786 column (see `org-table-number-fraction' for more information).
3787 Possible values are `left', `right' and `center'."
3794 cookie-align)
3798 ;; In a special row, try to find an alignment cookie at
3799 ;; COLUMN.
3803 ;; Since VALUE is a secondary string, the following checks
3804 ;; avoid useless expansion through `org-export-data'.
3812 ;; Ignore table rules.
3814 ;; In a standard row, check if cell's contents are expressing
3815 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3816 ;; Though, don't bother if an alignment cookie has already
3817 ;; defined cell's alignment.
3822 info)))
3827 ;; Return value. Alignment specified by cookies has precedence
3828 ;; over alignment deduced from cells contents.
3837 "Return TABLE-CELL borders.
3839 INFO is a plist used as a communication channel.
3841 Return value is a list of symbols, or nil. Possible values are:
3842 `top', `bottom', `above', `below', `left' and `right'. Note:
3843 `top' (resp. `bottom') only happen for a cell in the first
3844 row (resp. last row) of the table, ignoring table rules, if any.
3846 Returned borders ignore special rows."
3849 borders)
3850 ;; Top/above border? TABLE-CELL has a border above when a rule
3851 ;; used to demarcate row groups can be found above. Hence,
3852 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3853 ;; another regular row has to be found above that rule.
3862 ;; Look at every row before the current one.
3864 ;; No rule above, or rule found starts the table (ignoring any
3865 ;; special row): TABLE-CELL is at the top of the table.
3868 ;; Bottom/below border? TABLE-CELL has a border below when next
3869 ;; non-regular row below is a rule.
3878 ;; Look at every row after the current one.
3880 ;; No rule below, or rule found ends the table (modulo some
3881 ;; special row): TABLE-CELL is at the bottom of the table.
3884 ;; Right/left borders? They can only be specified by column
3885 ;; groups. Column groups are defined in a row starting with "/".
3886 ;; Also a column groups row only contains "<", "<>", ">" or blank
3887 ;; cells.
3904 ;; There's a left border when previous cell, if
3905 ;; any, ends a group, or current one starts one.
3911 ;; There's a right border when next cell, if any,
3912 ;; starts a group, or current one ends one.
3919 ;; Table rows are read in reverse order so last column groups
3920 ;; row has precedence over any previous one.
3922 ;; Return value.
3923 borders))
3926 "Non-nil when TABLE-CELL is at the beginning of a row group.
3927 INFO is a plist used as a communication channel."
3928 ;; A cell starts a column group either when it is at the beginning
3929 ;; of a row (or after the special column, if any) or when it has
3930 ;; a left border.
3934 table-cell)
3938 "Non-nil when TABLE-CELL is at the end of a row group.
3939 INFO is a plist used as a communication channel."
3940 ;; A cell ends a column group either when it is at the end of a row
3941 ;; or when it has a right border.
3944 table-cell)
3948 "Non-nil when TABLE-ROW is at the beginning of a column group.
3949 INFO is a plist used as a communication channel."
3957 "Non-nil when TABLE-ROW is at the end of a column group.
3958 INFO is a plist used as a communication channel."
3966 "Non-nil when TABLE-ROW is the first table header's row.
3967 INFO is a plist used as a communication channel."
3974 "Non-nil when TABLE-ROW is the last table header's row.
3975 INFO is a plist used as a communication channel."
3982 "Return TABLE dimensions.
3984 INFO is a plist used as a communication channel.
3986 Return value is a CONS like (ROWS . COLUMNS) where
3987 ROWS (resp. COLUMNS) is the number of exportable
3988 rows (resp. columns)."
3990 ;; Set number of rows, and extract first one.
3992 table 'table-row
3997 ;; Set number of columns.
3999 ;; Return value.
4003 "Return address of a regular TABLE-CELL object.
4005 TABLE-CELL is the cell considered. INFO is a plist used as
4006 a communication channel.
4008 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4009 zero-based index. Only exportable cells are considered. The
4010 function returns nil for other cells."
4013 ;; Ignore cells in special rows or in special column.
4018 ;; Row number.
4021 table 'table-row
4027 ;; Column number.
4030 table-row 'table-cell
4036 "Return regular table-cell object at ADDRESS in TABLE.
4038 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
4039 zero-based index. TABLE is a table type element. INFO is
4040 a plist used as a communication channel.
4042 If no table-cell, among exportable cells, is found at ADDRESS,
4043 return nil."
4046 ;; Row at (car address) or nil.
4049 table 'table-row
4055 'table-cell
4062 ;;;; For Tables Of Contents
4063 ;;
4064 ;; `org-export-collect-headlines' builds a list of all exportable
4065 ;; headline elements, maybe limited to a certain depth. One can then
4066 ;; easily parse it and transcode it.
4067 ;;
4068 ;; Building lists of tables, figures or listings is quite similar.
4069 ;; Once the generic function `org-export-collect-elements' is defined,
4070 ;; `org-export-collect-tables', `org-export-collect-figures' and
4071 ;; `org-export-collect-listings' can be derived from it.
4074 "Collect headlines in order to build a table of contents.
4076 INFO is a plist used as a communication channel.
4078 When non-nil, optional argument N must be an integer. It
4079 specifies the depth of the table of contents.
4081 Return a list of all exportable headlines as parsed elements."
4084 'headline
4086 ;; Strip contents from HEADLINE.
4089 info))
4092 "Collect referenceable elements of a determined type.
4094 TYPE can be a symbol or a list of symbols specifying element
4095 types to search. Only elements with a caption are collected.
4097 INFO is a plist used as a communication channel.
4099 When non-nil, optional argument PREDICATE is a function accepting
4100 one argument, an element of type TYPE. It returns a non-nil
4101 value when that element should be collected.
4103 Return a list of all elements found, in order of appearance."
4109 element))
4110 info))
4113 "Build a list of tables.
4114 INFO is a plist used as a communication channel.
4116 Return a list of table elements with a caption."
4120 "Build a list of figures.
4122 INFO is a plist used as a communication channel. PREDICATE is
4123 a function which accepts one argument: a paragraph element and
4124 whose return value is non-nil when that element should be
4125 collected.
4127 A figure is a paragraph type element, with a caption, verifying
4129 a vague concept that may depend on back-end.
4131 Return a list of elements recognized as figures."
4135 "Build a list of src blocks.
4137 INFO is a plist used as a communication channel.
4139 Return a list of src-block elements with a caption."
4143 ;;;; Topology
4144 ;;
4145 ;; Here are various functions to retrieve information about the
4146 ;; neighbourhood of a given element or object. Neighbours of interest
4147 ;; are direct parent (`org-export-get-parent'), parent headline
4148 ;; (`org-export-get-parent-headline'), first element containing an
4149 ;; object, (`org-export-get-parent-element'), parent table
4150 ;; (`org-export-get-parent-table'), previous element or object
4151 ;; (`org-export-get-previous-element') and next element or object
4152 ;; (`org-export-get-next-element').
4153 ;;
4154 ;; `org-export-get-genealogy' returns the full genealogy of a given
4155 ;; element or object, from closest parent to full parse tree.
4158 "Return BLOB parent or nil.
4159 BLOB is the element or object considered."
4163 "Return full genealogy relative to a given element or object.
4165 BLOB is the element or object being considered.
4167 Ancestors are returned from closest to farthest, the last one
4168 being the full parse tree."
4175 "Return BLOB parent headline or nil.
4176 BLOB is the element or object being considered."
4180 parent))
4183 "Return first element containing OBJECT or nil.
4184 OBJECT is the object to consider."
4188 parent))
4191 "Return OBJECT parent table or nil.
4192 OBJECT is either a `table-cell' or `table-element' type object."
4196 parent))
4199 "Return previous element or object.
4200 BLOB is an element or object. INFO is a plist used as
4201 a communication channel. Return previous exportable element or
4202 object, a string, or nil."
4212 "Return next element or object.
4213 BLOB is an element or object. INFO is a plist used as
4214 a communication channel. Return next exportable element or
4215 object, a string, or nil."
4221 nil))
4224 ;;;; Translation
4225 ;;
4226 ;; `org-export-translate' translates a string according to language
4227 ;; specified by LANGUAGE keyword or `org-export-language-setup'
4228 ;; variable and a specified charset. `org-export-dictionary' contains
4229 ;; the dictionary used for the translation.
4294 "Dictionary for export engine.
4296 Alist whose CAR is the string to translate and CDR is an alist
4297 whose CAR is the language string and CDR is a plist whose
4298 properties are possible charsets and values translated terms.
4300 It is used as a database for `org-export-translate'. Since this
4301 function returns the string as-is if no translation was found,
4302 the variable only needs to record values different from the
4306 "Translate string S according to language specification.
4308 ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
4309 and `:utf-8'. INFO is a plist used as a communication channel.
4311 Translation depends on `:language' property. Return the
4312 translated string. If no translation is found return S."
4318 \f
4319 ;;; The Dispatcher
4320 ;;
4321 ;; `org-export-dispatch' is the standard interactive way to start an
4322 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4323 ;; for its interface. Most commons back-ends should have an entry in
4324 ;; it.
4326 ;;;###autoload
4328 "Export dispatcher for Org mode.
4330 It provides an access to common export related tasks in a buffer.
4331 Its interface comes in two flavours: standard and expert. While
4332 both share the same set of bindings, only the former displays the
4333 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4334 to switch to one or the other.
4336 Return an error if key pressed has no associated command."
4341 org-export-dispatch-use-expert-ui))
4344 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4345 ;; depending on user's key pressed.
4347 ;; Allow to quit with "q" key.
4349 ;; Export with `e-ascii' back-end.
4358 ;; Export with `e-latex' back-end.
4361 (?l
4364 (?p
4367 (?d
4371 ;; Export with `e-html' back-end.
4372 (?H
4375 (?h
4378 (?b
4382 ;; Export with `e-odt' back-end.
4383 (?o
4386 (?O
4390 ;; Publishing facilities
4391 (?F
4393 (?P
4395 (?X
4399 org-e-publish-project-alist)))
4401 (?E
4403 ;; Undefined command.
4408 "Handle interface for `org-export-dispatch'.
4410 OPTIONS is a list containing current interactive options set for
4411 export. It can contain any of the following symbols:
4412 `body' toggles a body-only export
4413 `subtree' restricts export to current subtree
4414 `visible' restricts export to visible part of buffer.
4415 `force' force publishing files.
4417 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4418 buffer is provided, but indications about currently active
4419 options are given in the prompt. Moreover, \[?] allows to switch
4420 back to standard interface.
4422 Return value is a list with key pressed as CAR and a list of
4423 final interactive export options as CDR."
4427 \[1] Body only: %s [2] Export scope: %s
4428 \[3] Visible only: %s [4] Force publishing: %s
4431 --- (ASCII/Latin-1/UTF-8 Export) -------------------------
4433 \[a/n/u] to TXT file [A/N/U] to temporary buffer
4435 --- (HTML Export) ----------------------------------------
4437 \[h] to HTML file [b] ... and open it
4438 \[H] to temporary buffer
4440 --- (LaTeX Export) ---------------------------------------
4442 \[l] to TEX file [L] to temporary buffer
4443 \[p] to PDF file [d] ... and open it
4445 --- (ODF Export) -----------------------------------------
4447 \[o] to ODT file [O] ... and open it
4449 --- (Publish) --------------------------------------------
4451 \[F] current file [P] current project
4452 \[X] a project [E] every project"
4465 ;; Read a character from command input, toggling interactive
4466 ;; options when applicable. PROMPT is the displayed prompt,
4467 ;; as a string.
4471 ;; Ignore non-standard characters (i.e. "M-a").
4473 ;; Help key: Switch back to standard interface if
4474 ;; expert UI was active.
4476 ;; Toggle export options.
4483 expertp))
4484 ;; Action selected: Send key and options back to
4485 ;; `org-export-dispatch'.
4487 ;; With expert UI, just read key with a fancy prompt. In standard
4488 ;; UI, display an intrusive help buffer.
4499 ;;; org-export.el ends here