| blob | f23671836657a0b988e39e1a162d4096e6427a6f |
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 ;; A back-end is defined through one mandatory variable: his
51 ;; translation table. Its name is always
52 ;; `org-BACKEND-translate-alist' where BACKEND stands for the name
53 ;; chosen for the back-end. Its value is an alist whose keys are
54 ;; elements and objects types and values translator functions.
55 ;;
56 ;; These functions should return a string without any trailing space,
57 ;; or nil. They must accept three arguments: the object or element
58 ;; itself, its contents or nil when it isn't recursive and the
59 ;; property list used as a communication channel.
60 ;;
61 ;; Contents, when not nil, are stripped from any global indentation
62 ;; (although the relative one is preserved). They also always end
63 ;; with a single newline character.
64 ;;
65 ;; If, for a given type, no function is found, that element or object
66 ;; type will simply be ignored, along with any blank line or white
67 ;; space at its end. The same will happen if the function returns the
68 ;; nil value. If that function returns the empty string, the type
69 ;; will be ignored, but the blank lines or white spaces will be kept.
70 ;;
71 ;; In addition to element and object types, one function can be
72 ;; associated to the `template' symbol and another one to the
73 ;; `plain-text' symbol.
74 ;;
75 ;; The former returns the final transcoded string, and can be used to
76 ;; add a preamble and a postamble to document's body. It must accept
77 ;; two arguments: the transcoded string and the property list
78 ;; containing export options.
79 ;;
80 ;; The latter, when defined, is to be called on every text not
81 ;; recognized as an element or an object. It must accept two
82 ;; arguments: the text string and the information channel. It is an
83 ;; appropriate place to protect special chars relative to the
84 ;; back-end.
85 ;;
86 ;; Optionally, a back-end can support specific buffer keywords and
87 ;; OPTION keyword's items by setting `org-BACKEND-filters-alist'
88 ;; variable. Refer to `org-export-options-alist' documentation for
89 ;; more information about its value.
90 ;;
91 ;; If the new back-end shares most properties with another one,
92 ;; `org-export-define-derived-backend' can be used to simplify the
93 ;; process.
94 ;;
95 ;; Any back-end can define its own variables. Among them, those
96 ;; customizables should belong to the `org-export-BACKEND' group.
97 ;;
98 ;; Tools for common tasks across back-ends are implemented in the
99 ;; penultimate part of this file. A dispatcher for standard back-ends
100 ;; is provided in the last one.
102 ;;; Code:
129 \f
130 ;;; Internal Variables
131 ;;
132 ;; Among internal variables, the most important is
133 ;; `org-export-options-alist'. This variable define the global export
134 ;; options, shared between every exporter, and how they are acquired.
174 "Alist between export properties and ways to set them.
176 The CAR of the alist is the property name, and the CDR is a list
177 like (KEYWORD OPTION DEFAULT BEHAVIOUR) where:
179 KEYWORD is a string representing a buffer keyword, or nil.
180 OPTION is a string that could be found in an #+OPTIONS: line.
181 DEFAULT is the default value for the property.
182 BEHAVIOUR determine how Org should handle multiple keywords for
183 the same property. It is a symbol among:
184 nil Keep old value and discard the new one.
185 t Replace old value with the new one.
186 `space' Concatenate the values, separating them with a space.
187 `newline' Concatenate the values, separating them with
188 a newline.
189 `split' Split values at white spaces, and cons them to the
190 previous list.
192 KEYWORD and OPTION have precedence over DEFAULT.
194 All these properties should be back-end agnostic. For back-end
195 specific properties, define a similar variable named
196 `org-BACKEND-options-alist', replacing BACKEND with the name of
197 the appropriate back-end. You can also redefine properties
202 "List of in-buffer keywords that require special treatment.
203 These keywords are not directly associated to a property. The
204 way they are handled must be hard-coded into
262 "Alist between filters properties and initial values.
264 The key of each association is a property name accessible through
265 the communication channel its value is a configurable global
266 variable defining initial filters.
268 This list is meant to install user specified filters. Back-end
269 developers may install their own filters using
270 `org-BACKEND-filters-alist', where BACKEND is the name of the
271 considered back-end. Filters defined there will always be
272 prepended to the current list, so they always get applied
281 "Default rule for link matching an inline image.
282 This rule applies to links with no description. By default, it
283 will be considered as an inline image if it targets a local file
286 See `org-export-inline-image-p' for more information about
290 \f
291 ;;; User-configurable Variables
292 ;;
293 ;; Configuration for the masses.
294 ;;
295 ;; They should never be accessed directly, as their value is to be
296 ;; stored in a property list (cf. `org-export-options-alist').
297 ;; Back-ends will read their value from there instead.
300 "Options for exporting Org mode files."
305 "General options for export engine."
310 "Whether sub-trees with the ARCHIVE tag should be exported.
312 This can have three different values:
313 nil Do not export, pretend this tree is not present.
314 t Do export the entire tree.
315 `headline' Only export the headline, but skip the tree below it.
317 This option can also be set with the #+OPTIONS line,
326 "Non-nil means insert author name into the exported file.
327 This option can also be set with the #+OPTIONS line,
333 "Non-nil means export CLOCK keywords.
334 This option can also be set with the #+OPTIONS line,
340 "Non-nil means the postamble should contain a creator sentence.
342 The sentence can be set in `org-export-creator-string' and
345 If the value is `comment' insert it as a comment."
355 emacs-version)
356 "String to insert at the end of the generated document."
361 "Non-nil means export contents of standard drawers.
363 When t, all drawers are exported. This may also be a list of
364 drawer names to export. This variable doesn't apply to
365 properties drawers.
367 This option can also be set with the #+OPTIONS line,
377 "Non-nil means insert author email into the exported file.
378 This option can also be set with the #+OPTIONS line,
384 "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
386 If the export target supports emphasizing text, the word will be
387 typeset in bold, italic, or underlined, respectively. Not all
388 export backends support this.
395 "Tags that exclude a tree from export.
397 All trees carrying any of these tags will be excluded from
398 export. This is without condition, so even subtrees inside that
399 carry one of the `org-export-select-tags' will be removed.
401 This option can also be set with the #+EXPORT_EXCLUDE_TAGS:
402 keyword."
409 This can be used to have pre-formatted text, fragments of code
410 etc. For example:
411 : ;; Some Lisp examples
412 : (while (defc cnt)
413 : (ding))
414 will be looking just like this in also HTML. See also the QUOTE
415 keyword. Not all export backends support this.
422 "Non-nil means Org footnotes should be exported.
423 This option can also be set with the #+OPTIONS line,
429 "The last level which is still exported as a headline.
431 Inferior levels will produce itemize lists when exported. Note
432 that a numeric prefix argument to an exporter function overrides
433 this setting.
440 "The default language for export and clocktable translations, as a string.
441 This may have an association in
442 `org-clock-clocktable-language-setup'."
447 "Non-nil means preserve all line breaks when exporting.
449 Normally, in HTML output paragraphs will be reformatted.
451 This option can also be set with the #+OPTIONS line,
457 "Non-nil means interpret entities when exporting.
460 Å.
462 For a list of supported names, see the constant `org-entities'
463 and the user option `org-entities-user'.
465 This option can also be set with the #+OPTIONS line,
471 "Non-nil means include planning info in export.
472 This option can also be set with the #+OPTIONS: line,
478 "Non-nil means include priority cookies in export.
480 When nil, remove priority cookies for export.
482 This option can also be set with the #+OPTIONS line,
488 "Non-nil means add section numbers to headlines when exporting.
490 When set to an integer n, numbering will only happen for
491 headlines whose relative level is higher or equal to n.
493 This option can also be set with the #+OPTIONS line,
499 "Tags that select a tree for export.
501 If any such tag is found in a buffer, all trees that do not carry
502 one of these tags will be ignored during export. Inside trees
503 that are selected like this, you can still deselect a subtree by
504 tagging it with one of the `org-export-exclude-tags'.
506 This option can also be set with the #+EXPORT_SELECT_TAGS:
507 keyword."
514 When this option is turned on, these strings will be exported as:
516 Org HTML LaTeX
517 -----+----------+--------
519 -- – --
520 --- — ---
521 ... … \ldots
523 This option can also be set with the #+OPTIONS line,
531 When this option is turned on, you can use TeX-like syntax for
533 will be considered as a single item - so grouping with {} is
534 normally not needed. For example, the following things will be
535 parsed as single sub- or superscripts.
537 10^24 or 10^tau several digits will be considered 1 item.
538 10^-12 or 10^-tau a leading sign with digits or a word
539 x^2-y^3 will be read as x^2 - y^3, because items are
540 terminated by almost any nonword/nondigit char.
541 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
543 Still, ambiguity is possible - so when in doubt use {} to enclose
544 the sub/superscript. If you set this variable to the symbol
545 `{}', the braces are *required* in order to trigger
546 interpretations as sub/superscript. This can be helpful in
549 This option can also be set with the #+OPTIONS line,
558 "Non-nil means create a table of contents in exported files.
560 The TOC contains headlines with levels up
561 to`org-export-headline-levels'. When an integer, include levels
562 up to N in the toc, this may then be different from
563 `org-export-headline-levels', but it will not be allowed to be
564 larger than the number of headline levels. When nil, no table of
565 contents is made.
567 This option can also be set with the #+OPTIONS line,
577 For example:
579 | Name | Address | Birthday |
580 |-------------+----------+-----------|
581 | Arthur Dent | England | 29.2.2100 |
588 "If nil, do not export tags, just remove them from headlines.
590 If this is the symbol `not-in-toc', tags will be removed from
591 table of contents entries, but still be shown in the headlines of
592 the document.
594 This option can also be set with the #+OPTIONS line,
603 "Non-nil means include TODO items for export.
604 This may have the following values:
605 t include tasks independent of state.
606 todo include only tasks that are not yet done.
607 done include only tasks that are already done.
608 nil remove all tasks before export
609 list of keywords keep only tasks with these keywords"
620 "Non-nil means insert a time stamp into the exported file.
621 The time stamp shows when the file was created.
623 This option can also be set with the #+OPTIONS line,
629 "Non nil means allow timestamps in export.
631 It can be set to `active', `inactive', t or nil, in order to
632 export, respectively, only active timestamps, only inactive ones,
633 all of them or none.
635 This option can also be set with the #+OPTIONS line, e.g.
645 "Non-nil means include TODO keywords in export.
646 When nil, remove all these keywords from the export."
651 "Non-nil means allow #+BIND to define local variable values for export.
652 This is a potential security risk, which is why the user must
653 confirm the use of these lines."
661 "Alist between export snippets back-ends and exporter back-ends.
663 This variable allows to provide shortcuts for export snippets.
667 HTML code while every other back-end will ignore it."
675 "Coding system for the exported file."
680 "Non-nil means exported stuff will also be pushed onto the kill ring."
685 "The initial scope when exporting with `org-export-dispatch'.
686 This variable can be either set to `buffer' or `subtree'."
693 "Non-nil means show buffer after exporting to temp buffer.
694 When Org exports to a file, the buffer visiting that file is ever
695 shown, but remains buried. However, when exporting to
696 a temporary buffer, that buffer is popped up in a second window.
697 When this variable is nil, the buffer remains buried also in
698 these cases."
703 "Non-nil means using a non-intrusive `org-export-dispatch'.
704 In that case, no help buffer is displayed. Though, an indicator
708 considered for export\). Also, \[?] allows to switch back to
709 standard mode."
714 \f
715 ;;; Defining New Back-ends
718 "Create a new back-end as a variant of an existing one.
720 CHILD is the name of the derived back-end. PARENT is the name of
721 the parent back-end.
723 BODY can start with pre-defined keyword arguments. The following
724 keywords are understood:
726 `:filters-alist'
728 Alist of filters that will overwrite or complete filters
729 defined in PARENT back-end, if any.
731 `:options-alist'
733 Alist of buffer keywords or #+OPTIONS items that will
734 overwrite or complete those defined in PARENT back-end, if
735 any.
737 `:translate-alist'
739 Alist of element and object types and transcoders that will
740 overwrite or complete transcode table from PARENT back-end.
743 as a variant of `e-latex' back-end with a custom template
744 function:
746 \(org-export-define-derived-backend my-latex e-latex
747 :translate-alist ((template . my-latex-template-fun)))
749 The back-end could then be called with, for example:
762 ;; Define filters.
769 "Alist between filters keywords and back-end specific filters.
771 ;; Define options.
778 "Alist between LaTeX export properties and ways to set them.
779 See `org-export-options-alist' for more information on the
781 ;; Define translators.
788 ;; Splice in the body, if any.
792 \f
793 ;;; The Communication Channel
794 ;;
795 ;; During export process, every function has access to a number of
796 ;; properties. They are of two types:
797 ;;
798 ;; 1. Environment options are collected once at the very beginning of
799 ;; the process, out of the original buffer and configuration.
800 ;; Collecting them is handled by `org-export-get-environment'
801 ;; function.
802 ;;
803 ;; Most environment options are defined through the
804 ;; `org-export-options-alist' variable.
805 ;;
806 ;; 2. Tree properties are extracted directly from the parsed tree,
807 ;; just before export, by `org-export-collect-tree-properties'.
808 ;;
809 ;; Here is the full list of properties available during transcode
810 ;; process, with their category (option, tree or local) and their
811 ;; value type.
812 ;;
813 ;; + `:author' :: Author's name.
814 ;; - category :: option
815 ;; - type :: string
816 ;;
817 ;; + `:back-end' :: Current back-end used for transcoding.
818 ;; - category :: tree
819 ;; - type :: symbol
820 ;;
821 ;; + `:creator' :: String to write as creation information.
822 ;; - category :: option
823 ;; - type :: string
824 ;;
825 ;; + `:date' :: String to use as date.
826 ;; - category :: option
827 ;; - type :: string
828 ;;
829 ;; + `:description' :: Description text for the current data.
830 ;; - category :: option
831 ;; - type :: string
832 ;;
833 ;; + `:email' :: Author's email.
834 ;; - category :: option
835 ;; - type :: string
836 ;;
837 ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
838 ;; process.
839 ;; - category :: option
840 ;; - type :: list of strings
841 ;;
842 ;; + `:footnote-definition-alist' :: Alist between footnote labels and
843 ;; their definition, as parsed data. Only non-inlined footnotes
844 ;; are represented in this alist. Also, every definition isn't
845 ;; guaranteed to be referenced in the parse tree. The purpose of
846 ;; this property is to preserve definitions from oblivion
847 ;; (i.e. when the parse tree comes from a part of the original
848 ;; buffer), it isn't meant for direct use in a back-end. To
849 ;; retrieve a definition relative to a reference, use
850 ;; `org-export-get-footnote-definition' instead.
851 ;; - category :: option
852 ;; - type :: alist (STRING . LIST)
853 ;;
854 ;; + `:headline-levels' :: Maximum level being exported as an
855 ;; headline. Comparison is done with the relative level of
856 ;; headlines in the parse tree, not necessarily with their
857 ;; actual level.
858 ;; - category :: option
859 ;; - type :: integer
860 ;;
861 ;; + `:headline-offset' :: Difference between relative and real level
862 ;; of headlines in the parse tree. For example, a value of -1
863 ;; means a level 2 headline should be considered as level
864 ;; 1 (cf. `org-export-get-relative-level').
865 ;; - category :: tree
866 ;; - type :: integer
867 ;;
868 ;; + `:headline-numbering' :: Alist between headlines and their
869 ;; numbering, as a list of numbers
870 ;; (cf. `org-export-get-headline-number').
871 ;; - category :: tree
872 ;; - type :: alist (INTEGER . LIST)
873 ;;
874 ;; + `:id-alist' :: Alist between ID strings and destination file's
875 ;; path, relative to current directory. It is used by
876 ;; `org-export-resolve-id-link' to resolve ID links targeting an
877 ;; external file.
878 ;; - category :: option
879 ;; - type :: alist (STRING . STRING)
880 ;;
881 ;; + `:ignore-list' :: List of elements and objects that should be
882 ;; ignored during export.
883 ;; - category :: tree
884 ;; - type :: list of elements and objects
885 ;;
886 ;; + `:input-file' :: Full path to input file, if any.
887 ;; - category :: option
888 ;; - type :: string or nil
889 ;;
890 ;; + `:keywords' :: List of keywords attached to data.
891 ;; - category :: option
892 ;; - type :: string
893 ;;
894 ;; + `:language' :: Default language used for translations.
895 ;; - category :: option
896 ;; - type :: string
897 ;;
898 ;; + `:parse-tree' :: Whole parse tree, available at any time during
899 ;; transcoding.
900 ;; - category :: option
901 ;; - type :: list (as returned by `org-element-parse-buffer')
902 ;;
903 ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
904 ;; all line breaks.
905 ;; - category :: option
906 ;; - type :: symbol (nil, t)
907 ;;
908 ;; + `:section-numbers' :: Non-nil means transcoding should add
909 ;; section numbers to headlines.
910 ;; - category :: option
911 ;; - type :: symbol (nil, t)
912 ;;
913 ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
914 ;; in transcoding. When such a tag is present, subtrees without
915 ;; it are de facto excluded from the process. See
916 ;; `use-select-tags'.
917 ;; - category :: option
918 ;; - type :: list of strings
919 ;;
920 ;; + `:target-list' :: List of targets encountered in the parse tree.
921 ;; This is used to partly resolve "fuzzy" links
922 ;; (cf. `org-export-resolve-fuzzy-link').
923 ;; - category :: tree
924 ;; - type :: list of strings
925 ;;
926 ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
927 ;; a time stamp in the output.
928 ;; - category :: option
929 ;; - type :: symbol (nil, t)
930 ;;
931 ;; + `:translate-alist' :: Alist between element and object types and
932 ;; transcoding functions relative to the current back-end.
933 ;; Special keys `template' and `plain-text' are also possible.
934 ;; - category :: option
935 ;; - type :: alist (SYMBOL . FUNCTION)
936 ;;
937 ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
938 ;; also be transcoded. If it is set to the `headline' symbol,
939 ;; only the archived headline's name is retained.
940 ;; - category :: option
941 ;; - type :: symbol (nil, t, `headline')
942 ;;
943 ;; + `:with-author' :: Non-nil means author's name should be included
944 ;; in the output.
945 ;; - category :: option
946 ;; - type :: symbol (nil, t)
947 ;;
948 ;; + `:with-clocks' :: Non-nild means clock keywords should be exported.
949 ;; - category :: option
950 ;; - type :: symbol (nil, t)
951 ;;
952 ;; + `:with-creator' :: Non-nild means a creation sentence should be
953 ;; inserted at the end of the transcoded string. If the value
954 ;; is `comment', it should be commented.
955 ;; - category :: option
956 ;; - type :: symbol (`comment', nil, t)
957 ;;
958 ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
959 ;; its value is a list of names, only drawers with such names
960 ;; will be transcoded.
961 ;; - category :: option
962 ;; - type :: symbol (nil, t) or list of strings
963 ;;
964 ;; + `:with-email' :: Non-nil means output should contain author's
965 ;; email.
966 ;; - category :: option
967 ;; - type :: symbol (nil, t)
968 ;;
969 ;; + `:with-emphasize' :: Non-nil means emphasized text should be
970 ;; interpreted.
971 ;; - category :: option
972 ;; - type :: symbol (nil, t)
973 ;;
974 ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
975 ;; strings starting with a colon as a fixed-with (verbatim) area.
976 ;; - category :: option
977 ;; - type :: symbol (nil, t)
978 ;;
979 ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
980 ;; footnotes.
981 ;; - category :: option
982 ;; - type :: symbol (nil, t)
983 ;;
984 ;; + `:with-plannings' :: Non-nil means transcoding should include
985 ;; planning info.
986 ;; - category :: option
987 ;; - type :: symbol (nil, t)
988 ;;
989 ;; + `:with-priority' :: Non-nil means transcoding should include
990 ;; priority cookies.
991 ;; - category :: option
992 ;; - type :: symbol (nil, t)
993 ;;
994 ;; + `:with-special-strings' :: Non-nil means transcoding should
995 ;; interpret special strings in plain text.
996 ;; - category :: option
997 ;; - type :: symbol (nil, t)
998 ;;
999 ;; + `:with-sub-superscript' :: Non-nil means transcoding should
1000 ;; interpret subscript and superscript. With a value of "{}",
1001 ;; only interpret those using curly brackets.
1002 ;; - category :: option
1003 ;; - type :: symbol (nil, {}, t)
1004 ;;
1005 ;; + `:with-tables' :: Non-nil means transcoding should interpret
1006 ;; tables.
1007 ;; - category :: option
1008 ;; - type :: symbol (nil, t)
1009 ;;
1010 ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
1011 ;; headlines. A `not-in-toc' value will remove them from the
1012 ;; table of contents, if any, nonetheless.
1013 ;; - category :: option
1014 ;; - type :: symbol (nil, t, `not-in-toc')
1015 ;;
1016 ;; + `:with-tasks' :: Non-nil means transcoding should include
1017 ;; headlines with a TODO keyword. A `todo' value will only
1018 ;; include headlines with a todo type keyword while a `done'
1019 ;; value will do the contrary. If a list of strings is provided,
1020 ;; only tasks with keywords belonging to that list will be kept.
1021 ;; - category :: option
1022 ;; - type :: symbol (t, todo, done, nil) or list of strings
1023 ;;
1024 ;; + `:with-timestamps' :: Non-nil means transcoding should include
1025 ;; time stamps. Special value `active' (resp. `inactive') ask to
1026 ;; export only active (resp. inactive) timestamps. Otherwise,
1027 ;; completely remove them.
1028 ;; - category :: option
1029 ;; - type :: symbol: (`active', `inactive', t, nil)
1030 ;;
1031 ;; + `:with-toc' :: Non-nil means that a table of contents has to be
1032 ;; added to the output. An integer value limits its depth.
1033 ;; - category :: option
1034 ;; - type :: symbol (nil, t or integer)
1035 ;;
1036 ;; + `:with-todo-keywords' :: Non-nil means transcoding should
1037 ;; include TODO keywords.
1038 ;; - category :: option
1039 ;; - type :: symbol (nil, t)
1042 ;;;; Environment Options
1043 ;;
1044 ;; Environment options encompass all parameters defined outside the
1045 ;; scope of the parsed data. They come from five sources, in
1046 ;; increasing precedence order:
1047 ;;
1048 ;; - Global variables,
1049 ;; - Buffer's attributes,
1050 ;; - Options keyword symbols,
1051 ;; - Buffer keywords,
1052 ;; - Subtree properties.
1053 ;;
1054 ;; The central internal function with regards to environment options
1055 ;; is `org-export-get-environment'. It updates global variables with
1056 ;; "#+BIND:" keywords, then retrieve and prioritize properties from
1057 ;; the different sources.
1058 ;;
1059 ;; The internal functions doing the retrieval are:
1060 ;; `org-export-get-global-options',
1061 ;; `org-export-get-buffer-attributes',
1062 ;; `org-export-parse-option-keyword',
1063 ;; `org-export-get-subtree-options' and
1064 ;; `org-export-get-inbuffer-options'
1065 ;;
1066 ;; Also, `org-export-confirm-letbind' and `org-export-install-letbind'
1067 ;; take care of the part relative to "#+BIND:" keywords.
1070 "Collect export options from the current buffer.
1072 Optional argument BACKEND is a symbol specifying which back-end
1073 specific options to read, if any.
1075 When optional argument SUBTREEP is non-nil, assume the export is
1076 done against the current sub-tree.
1078 Third optional argument EXT-PLIST is a property list with
1079 external parameters overriding Org default settings, but still
1080 inferior to file-local settings."
1081 ;; First install #+BIND variables.
1083 ;; Get and prioritize export options...
1085 ;; ... from global variables...
1087 ;; ... from buffer's attributes...
1089 ;; ... from an external property list...
1090 ext-plist
1091 ;; ... from in-buffer settings...
1093 backend
1095 ;; ... and from subtree, when appropriate.
1097 ;; Eventually install back-end symbol and its translation table.
1098 `(:back-end
1099 ,backend
1100 :translate-alist
1105 "Parse an OPTIONS line and return values as a plist.
1106 Optional argument BACKEND is a symbol specifying which back-end
1107 specific items to read, if any."
1114 ;; Build an alist between #+OPTION: item and property-name.
1119 all)))
1120 plist)
1125 options)
1130 alist)
1131 plist))
1134 "Get export options in subtree at point.
1135 Optional argument BACKEND is a symbol specifying back-end used
1136 for export. Return options as a plist."
1139 ;; Make sure point is at an heading.
1147 plist :title
1159 plist)))
1162 "Return current buffer export options, as a plist.
1164 Optional argument BACKEND, when non-nil, is a symbol specifying
1165 which back-end specific options should also be read in the
1166 process.
1168 Optional argument FILES is a list of setup files names read so
1169 far, used to avoid circular dependencies.
1171 Assume buffer is in Org mode. Narrowing, if any, is ignored."
1175 ;; 1. Special keywords, as in `org-export-special-keywords'.
1188 ;; Avoid circular dependencies.
1200 val)
1208 ;; Value will be evaled: do not parse it.
1211 ;; Value has to be parsed for nested
1212 ;; macros.
1215 key
1218 ;; If user explicitly asks for
1219 ;; a newline, be sure to preserve it
1220 ;; from further filling with
1221 ;; `hard-newline'. Also replace
1222 ;; "\\n" with "\n", "\\\n" with "\\n"
1223 ;; and so on...
1230 restr)))))))))))
1232 ;; 2. Standard options, as in `org-export-options-alist'.
1234 ;; Also look for back-end specific options
1235 ;; if BACKEND is defined.
1241 ;; Build alist between keyword name and property name.
1245 all)))
1246 ;; Build regexp matching all keywords associated to export
1247 ;; options. Note: the search is case insensitive.
1260 plist prop
1261 ;; Handle value depending on specified BEHAVIOUR.
1274 ;; Parse keywords specified in `org-element-parsed-keywords'.
1282 plist prop
1285 org-element-parsed-keywords))
1286 ;; 3. Return final value.
1287 plist)))
1290 "Return properties related to buffer attributes, as a plist."
1293 ;; Store full path of input file name, or nil. For internal use.
1294 :input-file visited-file
1299 :footnote-definition-alist
1300 ;; Footnotes definitions must be collected in the original
1301 ;; buffer, as there's no insurance that they will still be in the
1302 ;; parse tree, due to possible narrowing.
1313 ;; Like `org-element-parse-buffer', but
1314 ;; makes sure the definition doesn't start
1315 ;; with a section element.
1319 alist))))
1320 alist))
1321 :id-alist
1322 ;; Collect id references.
1331 alist)
1332 :macro-modification-time
1338 ;; Store input file name as a macro.
1340 ;; `:macro-date', `:macro-time' and `:macro-property' could as
1341 ;; well be initialized as tree properties, since they don't
1342 ;; depend on buffer properties. Though, it may be more logical
1343 ;; to keep them close to other ":macro-" properties.
1349 "Return global export options as a plist.
1351 Optional argument BACKEND, if non-nil, is a symbol specifying
1352 which back-end specific export options should also be read in the
1353 process."
1359 ;; Output value.
1360 plist)
1365 plist
1367 ;; Eval default value provided. If keyword is a member
1368 ;; of `org-element-parsed-keywords', parse it as
1369 ;; a secondary string before storing it.
1376 all)
1377 ;; Return value.
1378 plist))
1382 "Can we use #+BIND values during export?
1383 By default this will ask for confirmation by the user, to divert
1384 possible security risks."
1393 "Install the values from #+BIND lines as local variables.
1394 Variables must be installed before in-buffer options are
1395 retrieved."
1402 letbind))))
1407 ;;;; Tree Properties
1408 ;;
1409 ;; Tree properties are infromation extracted from parse tree. They
1410 ;; are initialized at the beginning of the transcoding process by
1411 ;; `org-export-collect-tree-properties'.
1412 ;;
1413 ;; Dedicated functions focus on computing the value of specific tree
1414 ;; properties during initialization. Thus,
1415 ;; `org-export-populate-ignore-list' lists elements and objects that
1416 ;; should be skipped during export, `org-export-get-min-level' gets
1417 ;; the minimal exportable level, used as a basis to compute relative
1418 ;; level for headlines. Eventually
1419 ;; `org-export-collect-headline-numbering' builds an alist between
1420 ;; headlines and their numbering.
1423 "Extract tree properties from parse tree.
1425 DATA is the parse tree from which information is retrieved. INFO
1426 is a list holding export options.
1428 Following tree properties are set or updated:
1429 `:footnote-definition-alist' List of footnotes definitions in
1430 original buffer and current parse tree.
1432 `:headline-offset' Offset between true level of headlines and
1433 local level. An offset of -1 means an headline
1434 of level 2 should be considered as a level
1435 1 headline in the context.
1437 `:headline-numbering' Alist of all headlines as key an the
1438 associated numbering as value.
1440 `:ignore-list' List of elements that should be ignored during
1441 export.
1443 `:target-list' List of all targets in the parse tree.
1445 Return updated plist."
1446 ;; Install the parse tree in the communication channel, in order to
1447 ;; use `org-export-get-genealogy' and al.
1449 ;; Get the list of elements and objects to ignore, and put it into
1450 ;; `:ignore-list'. Do not overwrite any user ignore that might have
1451 ;; been done during parse tree filtering.
1454 :ignore-list
1457 ;; Compute `:headline-offset' in order to be able to use
1458 ;; `org-export-get-relative-level'.
1462 ;; Update footnotes definitions list with definitions in parse tree.
1463 ;; This is required since buffer expansion might have modified
1464 ;; boundaries of footnote definitions contained in the parse tree.
1465 ;; This way, definitions in `footnote-definition-alist' are bound to
1466 ;; match those in the parse tree.
1469 data 'footnote-definition
1473 defs)))
1475 ;; Properties order doesn't matter: get the rest of the tree
1476 ;; properties.
1478 `(:target-list
1486 info))
1489 "Return minimum exportable headline's level in DATA.
1490 DATA is parsed tree as returned by `org-element-parse-buffer'.
1491 OPTIONS is a plist holding export options."
1502 ;; If no headline was found, for the sake of consistency, set
1503 ;; minimum level to 1 nonetheless.
1507 "Return numbering of all exportable headlines in a parse tree.
1509 DATA is the parse tree. OPTIONS is the plist holding export
1510 options.
1512 Return an alist whose key is an headline and value is its
1513 associated numbering \(in the shape of a list of numbers\)."
1516 data
1517 'headline
1522 headline
1524 for idx from 0 to org-export-max-depth
1528 options)))
1531 "Return list of elements and objects to ignore during export.
1532 DATA is the parse tree to traverse. OPTIONS is the plist holding
1533 export options."
1535 walk-data ; for byte-compiler.
1539 ;; Collect ignored elements or objects into IGNORE-LIST.
1548 ;; If headline is archived but tree below has
1549 ;; to be skipped, add it to ignore list.
1552 ;; Move into recursive objects/elements.
1556 ;; Main call. First find trees containing a select tag, if any.
1558 ;; Return value.
1559 ignore))
1562 "Return list of headlines containing a select tag in their tree.
1563 DATA is parsed data as returned by `org-element-parse-buffer'.
1564 INFO is a plist holding export options."
1566 walk-data ; for byte-compiler.
1577 ;; When a select tag is found, mark full
1578 ;; genealogy and every headline within the tree
1579 ;; as acceptable.
1582 genealogy
1584 selected-trees))
1585 ;; Else, continue searching in tree, recursively.
1592 "Non-nil when element or object BLOB should be skipped during export.
1593 OPTIONS is the plist holding export options. SELECTED, when
1594 non-nil, is a list of headlines belonging to a tree with a select
1595 tag."
1597 ;; Check headline.
1605 ;; Ignore subtrees with an exclude tag.
1608 ;; When a select tag is present in the buffer, ignore any tree
1609 ;; without it.
1611 ;; Ignore commented sub-trees.
1613 ;; Ignore archived subtrees if `:with-archived-trees' is nil.
1615 ;; Ignore tasks, if specified by `:with-tasks' property.
1621 ;; Check timestamp.
1624 ;; No timestamp allowed.
1626 ;; Only active timestamps allowed and the current one isn't
1627 ;; active.
1631 ;; Only inactive timestamps allowed and the current one isn't
1632 ;; inactive.
1636 ;; Check drawer.
1642 ;; Check table-row.
1644 ;; Check table-cell.
1649 ;; Check clock.
1651 ;; Check planning.
1655 \f
1656 ;;; The Transcoder
1657 ;;
1658 ;; `org-export-data' reads a parse tree (obtained with, i.e.
1659 ;; `org-element-parse-buffer') and transcodes it into a specified
1660 ;; back-end output. It takes care of filtering out elements or
1661 ;; objects according to export options and organizing the output blank
1662 ;; lines and white space are preserved.
1663 ;;
1664 ;; Internally, three functions handle the filtering of objects and
1665 ;; elements during the export. In particular,
1666 ;; `org-export-ignore-element' marks an element or object so future
1667 ;; parse tree traversals skip it, `org-export-interpret-p' tells which
1668 ;; elements or objects should be seen as real Org syntax and
1669 ;; `org-export-expand' transforms the others back into their original
1670 ;; shape
1671 ;;
1672 ;; `org-export-transcoder' is an accessor returning appropriate
1673 ;; translator function for a given element or object.
1676 "Return appropriate transcoder for BLOB.
1677 INFO is a plist containing export directives."
1679 ;; Return contents only for complete parse trees.
1685 "Convert DATA into current back-end format.
1687 DATA is a parse tree, an element or an object or a secondary
1688 string. INFO is a plist holding export options.
1690 Return transcoded string."
1694 ;; Ignored element/object.
1696 ;; Plain text.
1702 info))
1703 ;; Uninterpreted element/object: change it back to Org
1704 ;; syntax and export again resulting raw string.
1708 data
1712 info))
1713 ;; Secondary string.
1716 ;; Element/Object without contents or, as a special case,
1717 ;; headline with archive tag and archived trees restricted
1718 ;; to title only.
1725 ;; Element/Object with contents.
1737 ;; Elements directly containing objects
1738 ;; must have their indentation normalized
1739 ;; first.
1741 data
1742 ;; When normalizing contents of the first
1743 ;; paragraph in an item or a footnote
1744 ;; definition, ignore first line's
1745 ;; indentation: there is none and it
1746 ;; might be misleading.
1750 data)
1756 contents)
1757 info))))))))
1761 ;; Append the same white space between elements or objects as in
1762 ;; the original buffer, and call appropriate filters.
1772 info)))
1773 ;; Eventually return string.
1774 results)))))
1777 "Non-nil if element or object BLOB should be interpreted as Org syntax.
1778 Check is done according to export options INFO, stored as
1779 a plist."
1781 ;; ... entities...
1783 ;; ... emphasis...
1785 ;; ... fixed-width areas.
1787 ;; ... footnotes...
1790 ;; ... sub/superscripts...
1796 ;; ... tables...
1801 "Expand a parsed element or object to its original state.
1802 BLOB is either an element or an object. CONTENTS is its
1803 contents, as a string or nil."
1806 blob contents))
1809 "Add ELEMENT to `:ignore-list' in INFO.
1811 Any element in `:ignore-list' will be skipped when using
1812 `org-element-map'. INFO is modified by side effects."
1816 \f
1817 ;;; The Filter System
1818 ;;
1819 ;; Filters allow end-users to tweak easily the transcoded output.
1820 ;; They are the functional counterpart of hooks, as every filter in
1821 ;; a set is applied to the return value of the previous one.
1822 ;;
1823 ;; Every set is back-end agnostic. Although, a filter is always
1824 ;; called, in addition to the string it applies to, with the back-end
1825 ;; used as argument, so it's easy for the end-user to add back-end
1826 ;; specific filters in the set. The communication channel, as
1827 ;; a plist, is required as the third argument.
1828 ;;
1829 ;; From the developer side, filters sets can be installed in the
1830 ;; process with the help of `org-BACKEND-filters-alist' variable.
1831 ;; Each association has a key among the following symbols and
1832 ;; a function or a list of functions as value.
1833 ;;
1834 ;; - `:filter-parse-tree' applies directly on the complete parsed
1835 ;; tree. It's the only filters set that doesn't apply to a string.
1836 ;; Users can set it through `org-export-filter-parse-tree-functions'
1837 ;; variable.
1838 ;;
1839 ;; - `:filter-final-output' applies to the final transcoded string.
1840 ;; Users can set it with `org-export-filter-final-output-functions'
1841 ;; variable
1842 ;;
1843 ;; - `:filter-plain-text' applies to any string not recognized as Org
1844 ;; syntax. `org-export-filter-plain-text-functions' allows users to
1845 ;; configure it.
1846 ;;
1847 ;; - `:filter-TYPE' applies on the string returned after an element or
1848 ;; object of type TYPE has been transcoded. An user can modify
1849 ;; `org-export-filter-TYPE-functions'
1850 ;;
1851 ;; All filters sets are applied with
1852 ;; `org-export-filter-apply-functions' function. Filters in a set are
1853 ;; applied in a LIFO fashion. It allows developers to be sure that
1854 ;; their filters will be applied first.
1855 ;;
1856 ;; Filters properties are installed in communication channel with
1857 ;; `org-export-install-filters' function.
1858 ;;
1859 ;; Eventually, a hook (`org-export-before-parsing-hook') is run just
1860 ;; before parsing to allow for heavy structure modifications.
1863 ;;;; Before Parsing Hook
1866 "Hook run before parsing an export buffer.
1867 This is run after include keywords have been expanded and Babel
1868 code executed, on a copy of original buffer's area being
1869 exported. Visibility is the same as in the original one. Point
1873 ;;;; Special Filters
1876 "List of functions applied to the parsed tree.
1877 Each filter is called with three arguments: the parse tree, as
1878 returned by `org-element-parse-buffer', the back-end, as
1879 a symbol, and the communication channel, as a plist. It must
1883 "List of functions applied to the transcoded string.
1884 Each filter is called with three arguments: the full transcoded
1885 string, the back-end, as a symbol, and the communication channel,
1886 as a plist. It must return a string that will be used as the
1890 "List of functions applied to plain text.
1891 Each filter is called with three arguments: a string which
1892 contains no Org syntax, the back-end, as a symbol, and the
1893 communication channel, as a plist. It must return a string or
1897 ;;;; Elements Filters
1900 "List of functions applied to a transcoded center block.
1901 Each filter is called with three arguments: the transcoded data,
1902 as a string, the back-end, as a symbol, and the communication
1906 "List of functions applied to a transcoded clock.
1907 Each filter is called with three arguments: the transcoded data,
1908 as a string, the back-end, as a symbol, and the communication
1912 "List of functions applied to a transcoded drawer.
1913 Each filter is called with three arguments: the transcoded data,
1914 as a string, the back-end, as a symbol, and the communication
1918 "List of functions applied to a transcoded dynamic-block.
1919 Each filter is called with three arguments: the transcoded data,
1920 as a string, the back-end, as a symbol, and the communication
1924 "List of functions applied to a transcoded headline.
1925 Each filter is called with three arguments: the transcoded data,
1926 as a string, the back-end, as a symbol, and the communication
1930 "List of functions applied to a transcoded inlinetask.
1931 Each filter is called with three arguments: the transcoded data,
1932 as a string, the back-end, as a symbol, and the communication
1936 "List of functions applied to a transcoded plain-list.
1937 Each filter is called with three arguments: the transcoded data,
1938 as a string, the back-end, as a symbol, and the communication
1942 "List of functions applied to a transcoded item.
1943 Each filter is called with three arguments: the transcoded data,
1944 as a string, the back-end, as a symbol, and the communication
1948 "List of functions applied to a transcoded comment.
1949 Each filter is called with three arguments: the transcoded data,
1950 as a string, the back-end, as a symbol, and the communication
1954 "List of functions applied to a transcoded comment-comment.
1955 Each filter is called with three arguments: the transcoded data,
1956 as a string, the back-end, as a symbol, and the communication
1960 "List of functions applied to a transcoded example-block.
1961 Each filter is called with three arguments: the transcoded data,
1962 as a string, the back-end, as a symbol, and the communication
1966 "List of functions applied to a transcoded export-block.
1967 Each filter is called with three arguments: the transcoded data,
1968 as a string, the back-end, as a symbol, and the communication
1972 "List of functions applied to a transcoded fixed-width.
1973 Each filter is called with three arguments: the transcoded data,
1974 as a string, the back-end, as a symbol, and the communication
1978 "List of functions applied to a transcoded footnote-definition.
1979 Each filter is called with three arguments: the transcoded data,
1980 as a string, the back-end, as a symbol, and the communication
1984 "List of functions applied to a transcoded horizontal-rule.
1985 Each filter is called with three arguments: the transcoded data,
1986 as a string, the back-end, as a symbol, and the communication
1990 "List of functions applied to a transcoded keyword.
1991 Each filter is called with three arguments: the transcoded data,
1992 as a string, the back-end, as a symbol, and the communication
1996 "List of functions applied to a transcoded latex-environment.
1997 Each filter is called with three arguments: the transcoded data,
1998 as a string, the back-end, as a symbol, and the communication
2002 "List of functions applied to a transcoded babel-call.
2003 Each filter is called with three arguments: the transcoded data,
2004 as a string, the back-end, as a symbol, and the communication
2008 "List of functions applied to a transcoded paragraph.
2009 Each filter is called with three arguments: the transcoded data,
2010 as a string, the back-end, as a symbol, and the communication
2014 "List of functions applied to a transcoded planning.
2015 Each filter is called with three arguments: the transcoded data,
2016 as a string, the back-end, as a symbol, and the communication
2020 "List of functions applied to a transcoded property-drawer.
2021 Each filter is called with three arguments: the transcoded data,
2022 as a string, the back-end, as a symbol, and the communication
2026 "List of functions applied to a transcoded quote block.
2027 Each filter is called with three arguments: the transcoded quote
2028 data, as a string, the back-end, as a symbol, and the
2029 communication channel, as a plist. It must return a string or
2033 "List of functions applied to a transcoded quote-section.
2034 Each filter is called with three arguments: the transcoded data,
2035 as a string, the back-end, as a symbol, and the communication
2039 "List of functions applied to a transcoded section.
2040 Each filter is called with three arguments: the transcoded data,
2041 as a string, the back-end, as a symbol, and the communication
2045 "List of functions applied to a transcoded special block.
2046 Each filter is called with three arguments: the transcoded data,
2047 as a string, the back-end, as a symbol, and the communication
2051 "List of functions applied to a transcoded src-block.
2052 Each filter is called with three arguments: the transcoded data,
2053 as a string, the back-end, as a symbol, and the communication
2057 "List of functions applied to a transcoded table.
2058 Each filter is called with three arguments: the transcoded data,
2059 as a string, the back-end, as a symbol, and the communication
2063 "List of functions applied to a transcoded table-cell.
2064 Each filter is called with three arguments: the transcoded data,
2065 as a string, the back-end, as a symbol, and the communication
2069 "List of functions applied to a transcoded table-row.
2070 Each filter is called with three arguments: the transcoded data,
2071 as a string, the back-end, as a symbol, and the communication
2075 "List of functions applied to a transcoded verse block.
2076 Each filter is called with three arguments: the transcoded data,
2077 as a string, the back-end, as a symbol, and the communication
2081 ;;;; Objects Filters
2084 "List of functions applied to transcoded bold text.
2085 Each filter is called with three arguments: the transcoded data,
2086 as a string, the back-end, as a symbol, and the communication
2090 "List of functions applied to transcoded code text.
2091 Each filter is called with three arguments: the transcoded data,
2092 as a string, the back-end, as a symbol, and the communication
2096 "List of functions applied to a transcoded entity.
2097 Each filter is called with three arguments: the transcoded data,
2098 as a string, the back-end, as a symbol, and the communication
2102 "List of functions applied to a transcoded export-snippet.
2103 Each filter is called with three arguments: the transcoded data,
2104 as a string, the back-end, as a symbol, and the communication
2108 "List of functions applied to a transcoded footnote-reference.
2109 Each filter is called with three arguments: the transcoded data,
2110 as a string, the back-end, as a symbol, and the communication
2114 "List of functions applied to a transcoded inline-babel-call.
2115 Each filter is called with three arguments: the transcoded data,
2116 as a string, the back-end, as a symbol, and the communication
2120 "List of functions applied to a transcoded inline-src-block.
2121 Each filter is called with three arguments: the transcoded data,
2122 as a string, the back-end, as a symbol, and the communication
2126 "List of functions applied to transcoded italic text.
2127 Each filter is called with three arguments: the transcoded data,
2128 as a string, the back-end, as a symbol, and the communication
2132 "List of functions applied to a transcoded latex-fragment.
2133 Each filter is called with three arguments: the transcoded data,
2134 as a string, the back-end, as a symbol, and the communication
2138 "List of functions applied to a transcoded line-break.
2139 Each filter is called with three arguments: the transcoded data,
2140 as a string, the back-end, as a symbol, and the communication
2144 "List of functions applied to a transcoded link.
2145 Each filter is called with three arguments: the transcoded data,
2146 as a string, the back-end, as a symbol, and the communication
2150 "List of functions applied to a transcoded macro.
2151 Each filter is called with three arguments: the transcoded data,
2152 as a string, the back-end, as a symbol, and the communication
2156 "List of functions applied to a transcoded radio-target.
2157 Each filter is called with three arguments: the transcoded data,
2158 as a string, the back-end, as a symbol, and the communication
2162 "List of functions applied to a transcoded statistics-cookie.
2163 Each filter is called with three arguments: the transcoded data,
2164 as a string, the back-end, as a symbol, and the communication
2168 "List of functions applied to transcoded strike-through text.
2169 Each filter is called with three arguments: the transcoded data,
2170 as a string, the back-end, as a symbol, and the communication
2174 "List of functions applied to a transcoded subscript.
2175 Each filter is called with three arguments: the transcoded data,
2176 as a string, the back-end, as a symbol, and the communication
2180 "List of functions applied to a transcoded superscript.
2181 Each filter is called with three arguments: the transcoded data,
2182 as a string, the back-end, as a symbol, and the communication
2186 "List of functions applied to a transcoded target.
2187 Each filter is called with three arguments: the transcoded data,
2188 as a string, the back-end, as a symbol, and the communication
2192 "List of functions applied to a transcoded timestamp.
2193 Each filter is called with three arguments: the transcoded data,
2194 as a string, the back-end, as a symbol, and the communication
2198 "List of functions applied to transcoded underline text.
2199 Each filter is called with three arguments: the transcoded data,
2200 as a string, the back-end, as a symbol, and the communication
2204 "List of functions applied to transcoded verbatim text.
2205 Each filter is called with three arguments: the transcoded data,
2206 as a string, the back-end, as a symbol, and the communication
2210 ;;;; Filters Tools
2211 ;;
2212 ;; Internal function `org-export-install-filters' installs filters
2213 ;; hard-coded in back-ends (developer filters) and filters from global
2214 ;; variables (user filters) in the communication channel.
2215 ;;
2216 ;; Internal function `org-export-filter-apply-functions' takes care
2217 ;; about applying each filter in order to a given data. It stops
2218 ;; whenever a filter returns a nil value.
2219 ;;
2220 ;; User-oriented function `org-export-set-element' replaces one
2221 ;; element or object in the parse tree with another one. It is meant
2222 ;; to be used as a tool for parse tree filters.
2225 "Call every function in FILTERS.
2226 Functions are called with arguments VALUE, current export
2227 back-end and INFO. Call is done in a LIFO fashion, to be sure
2228 that developer specified filters, if any, are called first."
2232 value)
2235 "Install filters properties in communication channel.
2237 INFO is a plist containing the current communication channel.
2239 Return the updated communication channel."
2241 ;; Install user defined filters with `org-export-filters-alist'.
2244 org-export-filters-alist)
2245 ;; Prepend back-end specific filters to that list.
2250 ;; Single values get consed, lists are prepended.
2255 plist key
2259 ;; Return new communication channel.
2263 "Replace element or object OLD with element or object NEW.
2264 The function takes care of setting `:parent' property for NEW."
2265 ;; OLD can belong to the contents of PARENT or to its secondary
2266 ;; string.
2269 org-element-secondary-value-alist)))
2272 ;; Ensure NEW has correct parent. Then replace OLD with NEW.
2279 \f
2280 ;;; Core functions
2281 ;;
2282 ;; This is the room for the main function, `org-export-as', along with
2283 ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
2284 ;; They differ only by the way they output the resulting code.
2285 ;;
2286 ;; `org-export-output-file-name' is an auxiliary function meant to be
2287 ;; used with `org-export-to-file'. With a given extension, it tries
2288 ;; to provide a canonical file name to write export output to.
2289 ;;
2290 ;; Note that `org-export-as' doesn't really parse the current buffer,
2291 ;; but a copy of it (with the same buffer-local variables and
2292 ;; visibility), where include keywords are expanded and Babel blocks
2293 ;; are executed, if appropriate.
2294 ;; `org-export-with-current-buffer-copy' macro prepares that copy.
2295 ;;
2296 ;; File inclusion is taken care of by
2297 ;; `org-export-expand-include-keyword' and
2298 ;; `org-export-prepare-file-contents'. Structure wise, including
2299 ;; a whole Org file in a buffer often makes little sense. For
2300 ;; example, if the file contains an headline and the include keyword
2301 ;; was within an item, the item should contain the headline. That's
2302 ;; why file inclusion should be done before any structure can be
2303 ;; associated to the file, that is before parsing.
2309 "Transcode current Org buffer into BACKEND code.
2311 If narrowing is active in the current buffer, only transcode its
2312 narrowed part.
2314 If a region is active, transcode that region.
2316 When optional argument SUBTREEP is non-nil, transcode the
2317 sub-tree at point, extracting information from the headline
2318 properties first.
2320 When optional argument VISIBLE-ONLY is non-nil, don't export
2321 contents of hidden elements.
2323 When optional argument BODY-ONLY is non-nil, only return body
2324 code, without preamble nor postamble.
2326 Optional argument EXT-PLIST, when provided, is a property list
2327 with external parameters overriding Org default settings, but
2328 still inferior to file-local settings.
2330 Optional argument NOEXPAND, when non-nil, prevents included files
2331 to be expanded and Babel code to be executed.
2333 Return code as a string."
2336 ;; Narrow buffer to an appropriate region or subtree for
2337 ;; parsing. If parsing subtree, be sure to remove main headline
2338 ;; too.
2346 ;; 1. Get export environment from original buffer. Also install
2347 ;; user's and developer's filters.
2350 ;; 2. Get parse tree. Buffer isn't parsed directly.
2351 ;; Instead, a temporary copy is created, where include
2352 ;; keywords are expanded and code blocks are evaluated.
2358 ;; Setting `org-current-export-file' is
2359 ;; required by Org Babel to properly resolve
2360 ;; noweb references.
2364 ;; Run hook with `org-export-current-backend' set
2365 ;; to BACKEND.
2368 ;; Eventually parse buffer.
2370 ;; 3. Call parse-tree filters to get the final tree.
2374 ;; 4. Now tree is complete, compute its properties and add
2375 ;; them to communication channel.
2379 ;; 5. Eventually transcode TREE. Wrap the resulting string
2380 ;; into a template, if required. Eventually call
2381 ;; final-output filter.
2389 info)))
2390 ;; Maybe add final OUTPUT to kill ring, then return it.
2392 output)))))
2396 "Call `org-export-as' with output to a specified buffer.
2398 BACKEND is the back-end used for transcoding, as a symbol.
2400 BUFFER is the output buffer. If it already exists, it will be
2401 erased first, otherwise, it will be created.
2403 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2404 and NOEXPAND are similar to those used in `org-export-as', which
2405 see.
2407 Return buffer."
2409 backend subtreep visible-only body-only ext-plist noexpand))
2415 buffer))
2419 "Call `org-export-as' with output to a specified file.
2421 BACKEND is the back-end used for transcoding, as a symbol. FILE
2422 is the name of the output file, as a string.
2424 Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
2425 and NOEXPAND are similar to those used in `org-export-as', which
2426 see.
2428 Return output file's name."
2429 ;; Checks for FILE permissions. `write-file' would do the same, but
2430 ;; we'd rather avoid needless transcoding of parse tree.
2432 ;; Insert contents to a temporary buffer and write it to FILE.
2434 backend subtreep visible-only body-only ext-plist noexpand)))
2439 ;; Return full path.
2440 file)
2443 "Return output file's name according to buffer specifications.
2445 EXTENSION is a string representing the output file extension,
2446 with the leading dot.
2448 With a non-nil optional argument SUBTREEP, try to determine
2450 of subtree at point.
2452 When optional argument PUB-DIR is set, use it as the publishing
2453 directory.
2455 When optional argument VISIBLE-ONLY is non-nil, don't export
2456 contents of hidden elements.
2458 Return file name as a string, or nil if it couldn't be
2459 determined."
2461 ;; File name may come from EXPORT_FILE_NAME subtree property,
2462 ;; assuming point is at beginning of said sub-tree.
2469 ;; File name may be extracted from buffer's associated
2470 ;; file, if any.
2472 ;; Can't determine file name on our own: Ask user.
2476 "Output file: " pub-dir nil nil nil
2479 ;; Build file name. Enforce EXTENSION over whatever user may have
2480 ;; come up with. PUB-DIR, if defined, always has precedence over
2481 ;; any provided path.
2486 extension))
2492 "Apply BODY in a copy of the current buffer.
2494 The copy preserves local variables and visibility of the original
2495 buffer.
2497 Point is at buffer's beginning when BODY is applied."
2507 ,original-buffer
2512 ov
2522 "Expand every include keyword in buffer.
2523 Optional argument INCLUDED is a list of included file names along
2524 with their line restriction, when appropriate. It is used to
2525 avoid infinite recursion. Optional argument DIR is the current
2526 working directory. It is used to properly resolve relative
2527 paths."
2534 ;; Extract arguments from keyword's value.
2548 ;; Minimal level of included file defaults to the child
2549 ;; level of the current headline, if any, or one. It
2550 ;; only applies is the file is meant to be included as
2551 ;; an Org one.
2559 ;; Remove keyword.
2563 ;; Check if files has already been parsed. Look after
2564 ;; inclusion lines too, as different parts of the same file
2565 ;; can be included too.
2574 ;; Protect sensitive contents with commas.
2580 ind-str contents ind-str))))
2585 ;; Protect sensitive contents with commas.
2592 ind-str env contents ind-str))))
2605 "Prepare the contents of FILE for inclusion and return them as a string.
2607 When optional argument LINES is a string specifying a range of
2608 lines, include only those lines.
2610 Optional argument IND, when non-nil, is an integer specifying the
2611 global indentation of returned contents. Since its purpose is to
2612 allow an included file to stay in the same environment it was
2613 created \(i.e. a list item), it doesn't apply past the first
2614 headline encountered.
2616 Optional argument MINLEVEL, when non-nil, is an integer
2617 specifying the level that any top-level headline in the included
2618 file should have."
2634 ;; Remove blank lines at beginning and end of contents. The logic
2635 ;; behind that removal is that blank lines around include keyword
2636 ;; override blank lines in included file.
2645 ;; If IND is set, preserve indentation of include keyword until
2646 ;; the first headline encountered.
2652 ;; Do not move footnote definitions out of column 0.
2658 ;; When MINLEVEL is specified, compute minimal level for headlines
2659 ;; in the file (CUR-MIN), and remove stars to each headline so
2660 ;; that headlines with minimal level have a level of MINLEVEL.
2669 ;; Only change stars, don't bother moving whole
2670 ;; sections.
2676 \f
2677 ;;; Tools For Back-Ends
2678 ;;
2679 ;; A whole set of tools is available to help build new exporters. Any
2680 ;; function general enough to have its use across many back-ends
2681 ;; should be added here.
2682 ;;
2683 ;; As of now, functions operating on footnotes, headlines, links,
2684 ;; macros, references, src-blocks, tables and tables of contents are
2685 ;; implemented.
2687 ;;;; For Affiliated Keywords
2688 ;;
2689 ;; `org-export-read-attribute' reads a property from a given element
2690 ;; as a plist. It can be used to normalize affiliated keywords'
2691 ;; syntax.
2694 "Turn ATTRIBUTE property from ELEMENT into a plist.
2697 properties."
2703 ;;;; For Export Snippets
2704 ;;
2705 ;; Every export snippet is transmitted to the back-end. Though, the
2706 ;; latter will only retain one type of export-snippet, ignoring
2707 ;; others, based on the former's target back-end. The function
2708 ;; `org-export-snippet-backend' returns that back-end for a given
2709 ;; export-snippet.
2712 "Return EXPORT-SNIPPET targeted back-end as a symbol.
2713 Translation, with `org-export-snippet-translation-alist', is
2714 applied."
2718 back-end))))
2721 ;;;; For Footnotes
2722 ;;
2723 ;; `org-export-collect-footnote-definitions' is a tool to list
2724 ;; actually used footnotes definitions in the whole parse tree, or in
2725 ;; an headline, in order to add footnote listings throughout the
2726 ;; transcoded data.
2727 ;;
2728 ;; `org-export-footnote-first-reference-p' is a predicate used by some
2729 ;; back-ends, when they need to attach the footnote definition only to
2730 ;; the first occurrence of the corresponding label.
2731 ;;
2732 ;; `org-export-get-footnote-definition' and
2733 ;; `org-export-get-footnote-number' provide easier access to
2734 ;; additional information relative to a footnote reference.
2737 "Return an alist between footnote numbers, labels and definitions.
2739 DATA is the parse tree from which definitions are collected.
2740 INFO is the plist used as a communication channel.
2742 Definitions are sorted by order of references. They either
2743 appear as Org data or as a secondary string for inlined
2744 footnotes. Unreferenced definitions are ignored."
2746 collect-fn ; for byte-compiler.
2750 ;; Collect footnote number, label and definition in DATA.
2752 data 'footnote-reference
2759 def)
2760 num-alist)
2761 ;; Also search in definition for nested footnotes.
2764 ;; Don't enter footnote definitions since it will happen
2765 ;; when their first reference is found.
2771 "Non-nil when a footnote reference is the first one for its label.
2773 FOOTNOTE-REFERENCE is the footnote reference being considered.
2774 INFO is the plist used as a communication channel."
2776 ;; Anonymous footnotes are always a first reference.
2778 ;; Otherwise, return the first footnote with the same LABEL and
2779 ;; test if it is equal to FOOTNOTE-REFERENCE.
2785 data 'footnote-reference
2790 ;; If FN isn't inlined, be sure to traverse its
2791 ;; definition before resuming search. See
2792 ;; comments in `org-export-get-footnote-number'
2793 ;; for more information.
2797 ;; Don't enter footnote definitions since it will
2798 ;; happen when their first reference is found.
2801 footnote-reference)))))
2804 "Return definition of FOOTNOTE-REFERENCE as parsed data.
2805 INFO is the plist used as a communication channel."
2811 "Return number associated to a footnote.
2813 FOOTNOTE is either a footnote reference or a footnote definition.
2814 INFO is the plist used as a communication channel."
2816 seen-refs
2817 search-ref ; for byte-compiler.
2821 ;; Search footnote references through DATA, filling
2822 ;; SEEN-REFS along the way.
2824 data 'footnote-reference
2828 ;; Anonymous footnote match: return number.
2831 ;; Labels match: return number.
2834 ;; Anonymous footnote: it's always a new one. Also,
2835 ;; be sure to return nil from the `cond' so
2836 ;; `first-match' doesn't get us out of the loop.
2838 ;; Label not seen so far: add it so SEEN-REFS.
2839 ;;
2840 ;; Also search for subsequent references in footnote
2841 ;; definition so numbering following reading logic.
2842 ;; Note that we don't have to care about inline
2843 ;; definitions, since `org-element-map' already
2844 ;; traverse them at the right time.
2845 ;;
2846 ;; Once again, return nil to stay in the loop.
2851 nil))))
2852 ;; Don't enter footnote definitions since it will happen
2853 ;; when their first reference is found.
2858 ;;;; For Headlines
2859 ;;
2860 ;; `org-export-get-relative-level' is a shortcut to get headline
2861 ;; level, relatively to the lower headline level in the parsed tree.
2862 ;;
2863 ;; `org-export-get-headline-number' returns the section number of an
2864 ;; headline, while `org-export-number-to-roman' allows to convert it
2865 ;; to roman numbers.
2866 ;;
2867 ;; `org-export-low-level-p', `org-export-first-sibling-p' and
2868 ;; `org-export-last-sibling-p' are three useful predicates when it
2869 ;; comes to fulfill the `:headline-levels' property.
2872 "Return HEADLINE relative level within current parsed tree.
2873 INFO is a plist holding contextual information."
2878 "Non-nil when HEADLINE is considered as low level.
2880 INFO is a plist used as a communication channel.
2882 A low level headlines has a relative level greater than
2883 `:headline-levels' property value.
2885 Return value is the difference between HEADLINE relative level
2886 and the last level being considered as high enough, or nil."
2893 "Return HEADLINE numbering as a list of numbers.
2894 INFO is a plist holding contextual information."
2898 "Return a non-nil value if HEADLINE element should be numbered.
2899 INFO is a plist used as a communication channel."
2905 "Convert integer N into a roman numeral."
2918 res)))
2921 "Return list of tags associated to ELEMENT.
2923 ELEMENT has either an `headline' or an `inlinetask' type. INFO
2924 is a plist used as a communication channel.
2926 Select tags (see `org-export-select-tags') and exclude tags (see
2927 `org-export-exclude-tags') are removed from the list.
2929 When non-nil, optional argument TAGS should be a list of strings.
2930 Any tag belonging to this list will also be removed."
2937 "Non-nil when HEADLINE is the first sibling in its sub-tree."
2942 "Non-nil when HEADLINE is the last sibling in its sub-tree."
2946 ;;;; For Links
2947 ;;
2948 ;; `org-export-solidify-link-text' turns a string into a safer version
2949 ;; for links, replacing most non-standard characters with hyphens.
2950 ;;
2951 ;; `org-export-get-coderef-format' returns an appropriate format
2952 ;; string for coderefs.
2953 ;;
2954 ;; `org-export-inline-image-p' returns a non-nil value when the link
2955 ;; provided should be considered as an inline image.
2956 ;;
2957 ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
2958 ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
2959 ;; returns an appropriate unique identifier when found, or nil.
2960 ;;
2961 ;; `org-export-resolve-id-link' returns the first headline with
2962 ;; specified id or custom-id in parse tree, the path to the external
2963 ;; file with the id or nil when neither was found.
2964 ;;
2965 ;; `org-export-resolve-coderef' associates a reference to a line
2966 ;; number in the element it belongs, or returns the reference itself
2967 ;; when the element isn't numbered.
2970 "Take link text S and make a safe target out of it."
2975 "Return format string for code reference link.
2976 PATH is the link path. DESC is its description."
2984 "Non-nil if LINK object points to an inline image.
2986 Optional argument is a set of RULES defining inline images. It
2987 is an alist where associations have the following shape:
2989 \(TYPE . REGEXP)
2991 Applying a rule means apply REGEXP against LINK's path when its
2992 type is TYPE. The function will return a non-nil value if any of
2993 the provided rules is non-nil. The default rule is
2994 `org-export-default-inline-image-rule'.
2996 This only applies to links without a description."
3007 rules)
3008 ;; Return nil if no rule matched.
3009 nil))))
3012 "Resolve a code reference REF.
3014 INFO is a plist used as a communication channel.
3016 Return associated line number in source code, or REF itself,
3017 depending on src-block or example element's switches."
3025 org-coderef-label-format)))
3029 ;; Element containing REF is found. Resolve it to either
3030 ;; a label or a line number, as needed.
3040 "Return LINK destination.
3042 INFO is a plist holding contextual information.
3044 Return value can be an object, an element, or nil:
3046 - If LINK path matches a target object (i.e. <<path>>) or
3049 - If LINK path exactly matches the name affiliated keyword
3050 \(i.e. #+NAME: path) of an element, return that element.
3052 - If LINK path exactly matches any headline name, return that
3053 element. If more than one headline share that name, priority
3054 will be given to the one with the closest common ancestor, if
3055 any, or the first one in the parse tree otherwise.
3057 - Otherwise, return nil.
3063 ;; First try to find a matching "<<path>>" unless user specified
3064 ;; he was looking for an headline (path starts with a *
3065 ;; character).
3069 return target)))
3070 ;; Then try to find an element with a matching "#+NAME: path"
3071 ;; affiliated keyword.
3078 ;; Last case: link either points to an headline or to
3079 ;; nothingness. Try to find the source, with priority given to
3080 ;; headlines with the closest common ancestor. If such candidate
3081 ;; is found, return it, otherwise return nil.
3085 ;; Return first headline whose `:raw-value' property
3086 ;; is NAME in parse tree DATA, or nil.
3089 data 'headline
3093 name)
3094 headline))
3096 ;; Search among headlines sharing an ancestor with link,
3097 ;; from closest to farthest.
3105 ;; No match with a common ancestor: try the full parse-tree.
3111 "Return headline referenced as LINK destination.
3113 INFO is a plist used as a communication channel.
3115 Return value can be the headline element matched in current parse
3119 ;; First check if id is within the current parse tree.
3125 headline))
3127 ;; Otherwise, look for external files.
3131 "Return radio-target object referenced as LINK destination.
3133 INFO is a plist used as a communication channel.
3135 Return value can be a radio-target object or nil. Assume LINK
3145 ;;;; For Macros
3146 ;;
3147 ;; `org-export-expand-macro' simply takes care of expanding macros.
3150 "Expand MACRO and return it as a string.
3151 INFO is a plist holding export options."
3154 ;; User's macros are stored in the communication channel with
3155 ;; a ":macro-" prefix. Replace arguments in VALUE. Also
3156 ;; expand recursively macros within.
3165 obj)))
3167 info)))
3168 ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
3170 ;; Return string.
3174 ;;;; For References
3175 ;;
3176 ;; `org-export-get-ordinal' associates a sequence number to any object
3177 ;; or element.
3180 "Return ordinal number of an element or object.
3182 ELEMENT is the element or object considered. INFO is the plist
3183 used as a communication channel.
3185 Optional argument TYPES, when non-nil, is a list of element or
3186 object types, as symbols, that should also be counted in.
3187 Otherwise, only provided element's type is considered.
3189 Optional argument PREDICATE is a function returning a non-nil
3190 value if the current element or object should be counted in. It
3191 accepts two arguments: the element or object being considered and
3192 the plist used as a communication channel. This allows to count
3193 only a certain type of objects (i.e. inline images).
3195 Return value is a list of numbers if ELEMENT is an headline or an
3196 item. It is nil for keywords. It represents the footnote number
3197 for footnote definitions and footnote references. If ELEMENT is
3198 a target, return the same value as if ELEMENT was the closest
3199 table, item or headline containing the target. In any other
3200 case, return the sequence number of ELEMENT among elements or
3201 objects of the same type."
3202 ;; A target keyword, representing an invisible target, never has
3203 ;; a sequence number.
3205 ;; Ordinal of a target object refer to the ordinal of the closest
3206 ;; table, item, or headline containing the object.
3210 when
3214 table))
3215 return parent)))
3217 ;; Special case 1: An headline returns its number as a list.
3219 ;; Special case 2: An item returns its number as a list.
3223 struct
3230 ;; Increment counter until ELEMENT is found again.
3241 ;;;; For Src-Blocks
3242 ;;
3243 ;; `org-export-get-loc' counts number of code lines accumulated in
3244 ;; src-block or example-block elements with a "+n" switch until
3245 ;; a given element, excluded. Note: "-n" switches reset that count.
3246 ;;
3247 ;; `org-export-unravel-code' extracts source code (along with a code
3248 ;; references alist) from an `element-block' or `src-block' type
3249 ;; element.
3250 ;;
3251 ;; `org-export-format-code' applies a formatting function to each line
3252 ;; of code, providing relative line number and code reference when
3253 ;; appropriate. Since it doesn't access the original element from
3254 ;; which the source code is coming, it expects from the code calling
3255 ;; it to know if lines should be numbered and if code references
3256 ;; should appear.
3257 ;;
3258 ;; Eventually, `org-export-format-code-default' is a higher-level
3259 ;; function (it makes use of the two previous functions) which handles
3260 ;; line numbering and code references inclusion, and returns source
3261 ;; code in a format suitable for plain text or verbatim output.
3264 "Return accumulated lines of code up to ELEMENT.
3266 INFO is the plist used as a communication channel.
3268 ELEMENT is excluded from count."
3275 ;; ELEMENT is reached: Quit the loop.
3277 ;; Only count lines from src-block and example-block elements
3278 ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
3282 ;; Accumulate locs or reset them.
3286 ;; Return nil to stay in the loop.
3287 nil)))
3289 ;; Return value.
3290 loc))
3293 "Clean source code and extract references out of it.
3295 ELEMENT has either a `src-block' an `example-block' type.
3297 Return a cons cell whose CAR is the source code, cleaned from any
3298 reference and protective comma and CDR is an alist between
3299 relative line number (integer) and name of code reference on that
3300 line (string)."
3302 ;; Get code and clean it. Remove blank lines at its
3303 ;; beginning and end. Also remove protective commas.
3309 ;; If appropriate, remove global indentation.
3313 ;; Free up the protected lines. Note: Org blocks
3314 ;; have commas at the beginning or every line.
3319 ;; Get format used for references.
3322 org-coderef-label-format)))
3323 ;; Build a regexp matching a loc with a reference.
3328 ;; Return value.
3330 ;; Code with references removed.
3336 ;; Ref line: remove ref, and signal its position in REFS.
3340 ;; Reference alist.
3341 refs)))
3344 "Format CODE by applying FUN line-wise and return it.
3346 CODE is a string representing the code to format. FUN is
3347 a function. It must accept three arguments: a line of
3348 code (string), the current line number (integer) or nil and the
3349 reference associated to the current line (string) or nil.
3351 Optional argument NUM-LINES can be an integer representing the
3352 number of code lines accumulated until the current code. Line
3353 numbers passed to FUN will take it into account. If it is nil,
3354 FUN's second argument will always be nil. This number can be
3355 obtained with `org-export-get-loc' function.
3357 Optional argument REF-ALIST can be an alist between relative line
3358 number (i.e. ignoring NUM-LINES) and the name of the code
3359 reference on it. If it is nil, FUN's third argument will always
3360 be nil. It can be obtained through the use of
3361 `org-export-unravel-code' function."
3373 "Return source code from ELEMENT, formatted in a standard way.
3375 ELEMENT is either a `src-block' or `example-block' element. INFO
3376 is a plist used as a communication channel.
3378 This function takes care of line numbering and code references
3379 inclusion. Line numbers, when applicable, appear at the
3380 beginning of the line, separated from the code by two white
3381 spaces. Code references, on the other hand, appear flushed to
3382 the right, separated by six white spaces from the widest line of
3383 code."
3384 ;; Extract code and references.
3390 ;; Handle line numbering.
3399 ;; Prepare references display, if required. Any reference
3400 ;; should start six columns after the widest line of code,
3401 ;; wrapped with parenthesis.
3406 code
3410 number-str
3411 loc
3417 num-start refs)))
3420 ;;;; For Tables
3421 ;;
3422 ;; `org-export-table-has-special-column-p' and and
3423 ;; `org-export-table-row-is-special-p' are predicates used to look for
3424 ;; meta-information about the table structure.
3425 ;;
3426 ;; `org-table-has-header-p' tells when the rows before the first rule
3427 ;; should be considered as table's header.
3428 ;;
3429 ;; `org-export-table-cell-width', `org-export-table-cell-alignment'
3430 ;; and `org-export-table-cell-borders' extract information from
3431 ;; a table-cell element.
3432 ;;
3433 ;; `org-export-table-dimensions' gives the number on rows and columns
3434 ;; in the table, ignoring horizontal rules and special columns.
3435 ;; `org-export-table-cell-address', given a table-cell object, returns
3436 ;; the absolute address of a cell. On the other hand,
3437 ;; `org-export-get-table-cell-at' does the contrary.
3438 ;;
3439 ;; `org-export-table-cell-starts-colgroup-p',
3440 ;; `org-export-table-cell-ends-colgroup-p',
3441 ;; `org-export-table-row-starts-rowgroup-p',
3442 ;; `org-export-table-row-ends-rowgroup-p',
3443 ;; `org-export-table-row-starts-header-p' and
3444 ;; `org-export-table-row-ends-header-p' indicate position of current
3445 ;; row or cell within the table.
3448 "Non-nil when TABLE has a special column.
3449 All special columns will be ignored during export."
3450 ;; The table has a special column when every first cell of every row
3451 ;; has an empty value or contains a symbol among "/", "#", "!", "$",
3452 ;; "*" "_" and "^". Though, do not consider a first row containing
3453 ;; only empty cells as special.
3469 "Non-nil when TABLE has an header.
3471 INFO is a plist used as a communication channel.
3473 A table has an header when it contains at least two row groups."
3476 table 'table-row
3484 info)))
3487 "Non-nil if TABLE-ROW is considered special.
3489 INFO is a plist used as the communication channel.
3491 All special rows will be ignored during export."
3495 ;; A row is special either when...
3497 ;; ... it starts with a field only containing "/",
3499 ;; ... the table contains a special column and the row start
3500 ;; with a marking character among, "^", "_", "$" or "!",
3504 ;; ... it contains only alignment cookies and empty cells.
3510 ;; Since VALUE is a secondary string, the following
3511 ;; checks avoid expanding it with `org-export-data'.
3523 "Return TABLE-ROW's group.
3525 INFO is a plist used as the communication channel.
3527 Return value is the group number, as an integer, or nil special
3528 rows and table rules. Group 1 is also table's header."
3545 "Return TABLE-CELL contents width.
3547 INFO is a plist used as the communication channel.
3549 Return value is the width given by the last width cookie in the
3550 same column as TABLE-CELL, or nil."
3555 cookie-width)
3559 ;; In a special row, try to find a width cookie at COLUMN.
3563 ;; The following checks avoid expanding unnecessarily the
3564 ;; cell with `org-export-data'
3572 ;; Ignore table rules.
3575 ;; Return value.
3576 cookie-width))
3579 "Return TABLE-CELL contents alignment.
3581 INFO is a plist used as the communication channel.
3583 Return alignment as specified by the last alignment cookie in the
3584 same column as TABLE-CELL. If no such cookie is found, a default
3585 alignment value will be deduced from fraction of numbers in the
3586 column (see `org-table-number-fraction' for more information).
3587 Possible values are `left', `right' and `center'."
3594 cookie-align)
3598 ;; In a special row, try to find an alignment cookie at
3599 ;; COLUMN.
3603 ;; Since VALUE is a secondary string, the following checks
3604 ;; avoid useless expansion through `org-export-data'.
3612 ;; Ignore table rules.
3614 ;; In a standard row, check if cell's contents are expressing
3615 ;; some kind of number. Increase NUMBER-CELLS accordingly.
3616 ;; Though, don't bother if an alignment cookie has already
3617 ;; defined cell's alignment.
3622 info)))
3627 ;; Return value. Alignment specified by cookies has precedence
3628 ;; over alignment deduced from cells contents.
3637 "Return TABLE-CELL borders.
3639 INFO is a plist used as a communication channel.
3641 Return value is a list of symbols, or nil. Possible values are:
3642 `top', `bottom', `above', `below', `left' and `right'. Note:
3643 `top' (resp. `bottom') only happen for a cell in the first
3644 row (resp. last row) of the table, ignoring table rules, if any.
3646 Returned borders ignore special rows."
3649 borders)
3650 ;; Top/above border? TABLE-CELL has a border above when a rule
3651 ;; used to demarcate row groups can be found above. Hence,
3652 ;; finding a rule isn't sufficient to push `above' in BORDERS:
3653 ;; another regular row has to be found above that rule.
3662 ;; Look at every row before the current one.
3664 ;; No rule above, or rule found starts the table (ignoring any
3665 ;; special row): TABLE-CELL is at the top of the table.
3668 ;; Bottom/below border? TABLE-CELL has a border below when next
3669 ;; non-regular row below is a rule.
3678 ;; Look at every row after the current one.
3680 ;; No rule below, or rule found ends the table (modulo some
3681 ;; special row): TABLE-CELL is at the bottom of the table.
3684 ;; Right/left borders? They can only be specified by column
3685 ;; groups. Column groups are defined in a row starting with "/".
3686 ;; Also a column groups row only contains "<", "<>", ">" or blank
3687 ;; cells.
3704 ;; There's a left border when previous cell, if
3705 ;; any, ends a group, or current one starts one.
3711 ;; There's a right border when next cell, if any,
3712 ;; starts a group, or current one ends one.
3719 ;; Table rows are read in reverse order so last column groups
3720 ;; row has precedence over any previous one.
3722 ;; Return value.
3723 borders))
3726 "Non-nil when TABLE-CELL is at the beginning of a row group.
3727 INFO is a plist used as a communication channel."
3728 ;; A cell starts a column group either when it is at the beginning
3729 ;; of a row (or after the special column, if any) or when it has
3730 ;; a left border.
3734 table-cell)
3738 "Non-nil when TABLE-CELL is at the end of a row group.
3739 INFO is a plist used as a communication channel."
3740 ;; A cell ends a column group either when it is at the end of a row
3741 ;; or when it has a right border.
3744 table-cell)
3748 "Non-nil when TABLE-ROW is at the beginning of a column group.
3749 INFO is a plist used as a communication channel."
3757 "Non-nil when TABLE-ROW is at the end of a column group.
3758 INFO is a plist used as a communication channel."
3766 "Non-nil when TABLE-ROW is the first table header's row.
3767 INFO is a plist used as a communication channel."
3774 "Non-nil when TABLE-ROW is the last table header's row.
3775 INFO is a plist used as a communication channel."
3782 "Return TABLE dimensions.
3784 INFO is a plist used as a communication channel.
3786 Return value is a CONS like (ROWS . COLUMNS) where
3787 ROWS (resp. COLUMNS) is the number of exportable
3788 rows (resp. columns)."
3790 ;; Set number of rows, and extract first one.
3792 table 'table-row
3797 ;; Set number of columns.
3799 ;; Return value.
3803 "Return address of a regular TABLE-CELL object.
3805 TABLE-CELL is the cell considered. INFO is a plist used as
3806 a communication channel.
3808 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
3809 zero-based index. Only exportable cells are considered. The
3810 function returns nil for other cells."
3813 ;; Ignore cells in special rows or in special column.
3818 ;; Row number.
3821 table 'table-row
3827 ;; Column number.
3830 table-row 'table-cell
3837 "Return regular table-cell object at ADDRESS in TABLE.
3839 Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
3840 zero-based index. TABLE is a table type element. INFO is
3841 a plist used as a communication channel.
3843 If no table-cell, among exportable cells, is found at ADDRESS,
3844 return nil."
3847 ;; Row at (car address) or nil.
3850 table 'table-row
3856 'table-cell
3863 ;;;; For Tables Of Contents
3864 ;;
3865 ;; `org-export-collect-headlines' builds a list of all exportable
3866 ;; headline elements, maybe limited to a certain depth. One can then
3867 ;; easily parse it and transcode it.
3868 ;;
3869 ;; Building lists of tables, figures or listings is quite similar.
3870 ;; Once the generic function `org-export-collect-elements' is defined,
3871 ;; `org-export-collect-tables', `org-export-collect-figures' and
3872 ;; `org-export-collect-listings' can be derived from it.
3875 "Collect headlines in order to build a table of contents.
3877 INFO is a plist used as a communication channel.
3879 When non-nil, optional argument N must be an integer. It
3880 specifies the depth of the table of contents.
3882 Return a list of all exportable headlines as parsed elements."
3885 'headline
3887 ;; Strip contents from HEADLINE.
3890 info))
3893 "Collect referenceable elements of a determined type.
3895 TYPE can be a symbol or a list of symbols specifying element
3896 types to search. Only elements with a caption are collected.
3898 INFO is a plist used as a communication channel.
3900 When non-nil, optional argument PREDICATE is a function accepting
3901 one argument, an element of type TYPE. It returns a non-nil
3902 value when that element should be collected.
3904 Return a list of all elements found, in order of appearance."
3910 element))
3911 info))
3914 "Build a list of tables.
3915 INFO is a plist used as a communication channel.
3917 Return a list of table elements with a caption."
3921 "Build a list of figures.
3923 INFO is a plist used as a communication channel. PREDICATE is
3924 a function which accepts one argument: a paragraph element and
3925 whose return value is non-nil when that element should be
3926 collected.
3928 A figure is a paragraph type element, with a caption, verifying
3930 a vague concept that may depend on back-end.
3932 Return a list of elements recognized as figures."
3936 "Build a list of src blocks.
3938 INFO is a plist used as a communication channel.
3940 Return a list of src-block elements with a caption."
3944 ;;;; Topology
3945 ;;
3946 ;; Here are various functions to retrieve information about the
3947 ;; neighbourhood of a given element or object. Neighbours of interest
3948 ;; are direct parent (`org-export-get-parent'), parent headline
3949 ;; (`org-export-get-parent-headline'), first element containing an
3950 ;; object, (`org-export-get-parent-element'), parent table
3951 ;; (`org-export-get-parent-table'), previous element or object
3952 ;; (`org-export-get-previous-element') and next element or object
3953 ;; (`org-export-get-next-element').
3954 ;;
3955 ;; `org-export-get-genealogy' returns the full genealogy of a given
3956 ;; element or object, from closest parent to full parse tree.
3959 "Return BLOB parent or nil.
3960 BLOB is the element or object considered."
3964 "Return full genealogy relative to a given element or object.
3965 BLOB is the element or object being considered."
3972 "Return BLOB parent headline or nil.
3973 BLOB is the element or object being considered."
3977 parent))
3980 "Return first element containing OBJECT or nil.
3981 OBJECT is the object to consider."
3985 parent))
3988 "Return OBJECT parent table or nil.
3989 OBJECT is either a `table-cell' or `table-element' type object."
3993 parent))
3996 "Return previous element or object.
3997 BLOB is an element or object. Return previous element or object,
3998 a string, or nil."
4003 "Return next element or object.
4004 BLOB is an element or object. Return next element or object,
4005 a string, or nil."
4010 \f
4011 ;;; The Dispatcher
4012 ;;
4013 ;; `org-export-dispatch' is the standard interactive way to start an
4014 ;; export process. It uses `org-export-dispatch-ui' as a subroutine
4015 ;; for its interface. Most commons back-ends should have an entry in
4016 ;; it.
4019 "Export dispatcher for Org mode.
4021 It provides an access to common export related tasks in a buffer.
4022 Its interface comes in two flavours: standard and expert. While
4023 both share the same set of bindings, only the former displays the
4024 valid keys associations. Set `org-export-dispatch-use-expert-ui'
4025 to switch to one or the other.
4027 Return an error if key pressed has no associated command."
4032 org-export-dispatch-use-expert-ui))
4035 ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
4036 ;; depending on user's key pressed.
4038 ;; Allow to quit with "q" key.
4040 ;; Export with `e-ascii' back-end.
4046 `(:ascii-charset
4055 ;; Export with `e-latex' back-end.
4056 (?L
4064 (?l
4067 (?p
4070 (?d
4074 ;; Export with `e-html' back-end.
4075 (?H
4080 ;; set major mode
4084 (?h
4087 (?b
4091 ;; Export with `e-odt' back-end.
4092 (?o
4095 (?O
4099 ;; Publishing facilities
4100 (?F
4102 (?P
4104 (?X
4108 org-e-publish-project-alist)))
4110 (?E
4112 ;; Undefined command.
4117 "Handle interface for `org-export-dispatch'.
4119 OPTIONS is a list containing current interactive options set for
4120 export. It can contain any of the following symbols:
4121 `body' toggles a body-only export
4122 `subtree' restricts export to current subtree
4123 `visible' restricts export to visible part of buffer.
4124 `force' force publishing files.
4126 EXPERTP, when non-nil, triggers expert UI. In that case, no help
4127 buffer is provided, but indications about currently active
4128 options are given in the prompt. Moreover, \[?] allows to switch
4129 back to standard interface.
4131 Return value is a list with key pressed as CAR and a list of
4132 final interactive export options as CDR."
4136 \[1] Body only: %s [2] Export scope: %s
4137 \[3] Visible only: %s [4] Force publishing: %s
4140 --- (ASCII/Latin-1/UTF-8 Export) -------------------------
4142 \[a/n/u] to TXT file [A/N/U] to temporary buffer
4144 --- (HTML Export) ----------------------------------------
4146 \[h] to HTML file [b] ... and open it
4147 \[H] to temporary buffer
4149 --- (LaTeX Export) ---------------------------------------
4151 \[l] to TEX file [L] to temporary buffer
4152 \[p] to PDF file [d] ... and open it
4154 --- (ODF Export) -----------------------------------------
4156 \[o] to ODT file [O] ... and open it
4158 --- (Publish) --------------------------------------------
4160 \[F] current file [P] current project
4161 \[X] a project [E] every project"
4174 ;; Read a character from command input, toggling interactive
4175 ;; options when applicable. PROMPT is the displayed prompt,
4176 ;; as a string.
4180 ;; Ignore non-standard characters (i.e. "M-a").
4182 ;; Help key: Switch back to standard interface if
4183 ;; expert UI was active.
4185 ;; Toggle export options.
4192 expertp))
4193 ;; Action selected: Send key and options back to
4194 ;; `org-export-dispatch'.
4196 ;; With expert UI, just read key with a fancy prompt. In standard
4197 ;; UI, display an intrusive help buffer.
4208 ;;; org-export.el ends here